Objetivo 

Criar a rotina que permita o registro dos mnemônicos que serão utilizados no processo de elaboração dos Lançamentos Padrão.
Definição de mnemônico, é um código associado, um campo, uma função, uma fórmula, uma tabela ou um valor fixo.

Definição da Regra de Negócio 

Será desenvolvida uma rotina onde será apresentado um browse com os mnemônicos (tabela CWJ) e com as opções Incluir, Alterar, Excluir e as outras opções padrão (ver protótipo 01).

Botão Incluir
Será apresentada a janela com os seguintes campos (ver protótipo 02):
Mnemônico (CWJ_codmne) .- Código atribuído ao mnemônico. Obrigatório. (Associar a função CWJMnemoPvar ao campo x3_pictvar, para que obrigue a que a variável seja iniciada com o prefixo M_ ).
Regra de Integridade
O código de mnemônico é único, confira que não se repita.
Descrição (CWJ_descri) .- Descrição curta do mnemônico. Obrigatório.
Grupo (CWJ_grupo).- Código de módulo ou grupo ao que pertence a fórmula, pode ser selecionado da consulta padrão da tabela da sx5, tabela CZ. Obrigatório.
Tipo (CWJ_tipdat) .- Descreve o tipo de mnemônico, poderá ser selecionado entre Campo de BD/Tabela/Fórmula/Função/Função de usuário, Valor. Obrigatório. Quando salga desse dado devem ser habilitados e desabilitados (e limpar o conteúdo) os campos como segue:
Se Campo de BD – Será habilitada a seção de Tabelas e Campos e serão desabilitados Dado associado, Função de RPO e valor.
Se Tabela – Será habilitada a seção de Tabelas e serão desabilitadas as seções de Campos, Dado associado, Função de usuário e valor.
Se Fórmula ou Função – Será desabilitada a seção de Tabelas e Campos, Função de RPO e valor. Será habilitado o Dado associado.
Se Função de usuário – Será desabilitada a seção de Tabelas e Campos, Dado associado e valor. Será habilitada a Função de Usuário.
Se Valor – Será deshabilitada a seção de Tabelas e Campo, Dado associado e função de RPO.
Dado associado (CWJ_datvin) .- Código do dado associado, só será habilitado e será obrigatório, se o tipo de dado for Fórmula ou Função. E poderá selecionar a informação desde as consultas especiais (CTB911 Prototipo 06), según sea el caso.
Se for selecionada a Função será validado que esta exista no catálogo de funções (CWN), se for selecionada a Fórmula será validado que exista no catálogo de fórmulas (CWK). Esta validação será realizada com a rotina CTB91VLDVIN().

Função em RPO (CWJ_funrpo) .- Nome da função de usuário. Só será habilitada e será obrigatória, se o tipo de dado for Função de Usuário e será validado que a função cadastrada exista no repositório (irá permitir funções do sistema o de usuario).
Valor (CWJ_valor) .- Dado alfanumérico. Só será habilitado e será obrigatório se o tipo de dado for Valor. E pode selecionar a informação na consulta especifica CTB911 Protótipo 07.

----___
Esses 2 campos só serão habilitados se o tipo de dado é Tabelas ou Campos de BD.
Todas (CWJ_todas1).- Se for selecionado Sim, ao sair do campo será atualizado o conteúdo do seguinte campo com o conteúdo da tabela SX2. Se for selecionado NÃO, irá carregar unicamente as tabelas para formulação (conteúdo da tabela CWH). Se for selecionado Sim, será enviado uma mensagem para o usuário antes de sair da seleção com a pergunta "Serão visualizadas todas as tabelas do sistema, prosseguir?", em caso afirmativo será atualizado o seguinte campo. Por padrão este campo deve ser NÃO.
Tabela (CWJ_tabla).- Serão apresentadas as tabelas que estiverem disponíveis para o uso de mnemônicos (CWH) ou os registros da tabela SX2 conforme foram solicitados no campo anterior ( deve apresentar alias e descrição da tabela Protótipo 03). Ao sair desse campo será inicializado o seguinte campo com Não, e será atualizado o campo Campos com os campos que conformam a tabela selecionada, somente com os que são utilizados para formulação (CWI).

Estes campos só serão habilitados se o tipo de dado é Tabelas ou Campos de BD.
Todos (CWJ_todas2).- Se for selecionado Sim, ao sair do campo será atualizado o conteúdo do seguinte campo com os campos da tabela SX3 (só aqueles que pertencem à tabela selecionada). Se for selecionado NÃO, serão carregados somente os campos que utilizados para formulação (CWI) da tabela selecionada.
Campos (CWJ_campo).- Serão apresentados os campos que estão disponíveis para o uso de mnemônicos (CWI) ou os registros da tabela SX3, conforme foi solicitado no campo anterior ( deve ser apresentada a descrição do campo Protótipo 04). Ao sair deste campo, será atualizada a informação do campo help que será explicado a seguir.
Help Ayuda (CWJ_help) .- Só será visualizado. Obter esta informação do help e as características do campo (tipo, tamanho, usado e validações da sx3, para extrair o help de campo utilize a função Ap5GetHelp('cCampo')). Esta será atualizada toda vez que sair do campo anterior, e após selecionar uma tabela (deixando este vazio).

Ao selecionar Confirmar, será validado como segue, se o tipo de dados (cwj_tipdat) for:

• Campo de BD ou Tabela, os campos da seção de campos e tabelas devem ter informação obrigatoriamente.
• Fórmula ou Função, o campo Dados associados (cwj_datvin) deve ter informação obrigatoriamente.
• Valor, o campo Valor Fixo (cwj_valor) deve ter informação obrigatoriamente.
• Função de usuário, o campo de função do RPO (cwj_funrpo) deve ter informação obrigatoriamente.

Se alguma destas condições não for cumprida, será enviado para o usuário o aviso correspondente e não será possível salvar, até que o usuário efetue a correção.
Se tudo estiver conforme, será salvada a informação na tabela CWJ marcando o registro com o tipo usuario (CWJ_TIPO="U").

Botão Alterar
Nos mnemônicos do sistema (CWJ_TIPO='S') só é possível alterar a descrição, naqueles que são de usuários é possível alterar todos os campos, salvo o código (CWJ_codmne).
Ao Confirmar para salvar a informação, deve ser validado igual à validação da opção Incluir.

Regra de Integridade
Verifique que o mnemônico não esteja sendo utilizado por uma formula (verifique na tabela CWl que não exista o código de mnemônico em questão como operando, campos cwl_oper1, cwl_oper2), e que também não esteja sendo utilizado como parâmetro em alguma função (cwn, en cwn_par1.. cwn_par5). Se for assim, só será permitida a alteração da Descrição e do grupo.
Se o mnemônico é de sistema, antes de permitir a alteração, será enviado para o usuário o aviso "O mnemônico selecionado é do tipo Sistema e só será permitido alterar a descrição".
Se o mnemônico estiver sendo utilizado por uma fórmula ou Função e não é de sistema, será enviado para o usuário o aviso "O mnemônico está sendo utilizado por alguma fórmula ou função, só será possível efetuar alterações na Descrição e no grupo".
Botão Excluir 
Quando for selecionado um registro, este será aberto e serão apresentados todos os dados, logo, ao selecionar Confirmar, irá perguntar Tem certeza que deseja Excluir o registro?, se a resposta for afirmativa, o registro será excluído.
Regra de Integridade
Antes de excluir verifique que outras tabelas não estejam utilizando o mnemônico para excluir (verifique na tabela CWL que não exista o código de mnemônico em questão como operando, campos cwl_oper1, cwl_oper2); ou como parâmetro em alguma função (cwn, en cwn_par1.. cwn_par5).
O registro que tenta excluir é do tipo sistema (CWJ_TIPO<>'U'), ao Confirmar, em lugar de perguntar será enviado um aviso para o usuário "Este registro é de sistema e não pode ser eliminado".
Se o mnemônico está sendo utilizado por uma formula e não é de sistema, será enviado o seguinte aviso para o usuário "Mnemônico está em uso em alguma fórmula ou função e não pode ser eliminado".

Botão Legenda
Serão apresentados os tipos de Mnemônicos tela Protótipo 05.
Entrando por primeira vez na rotina
A primeira vez que for executada a rotina de manutenção de mnemônicos, devem ser carregados os mnemônicos de sistema (CWJ), as tabelas (CWH) e os campos usados (CWI). Para que estes executem o chamado da rotina CTB91CARGA(), que conterá este processo, desenvolvido no Requisito 151106 .

Consultas especiais 
Seleção de Funções (Consulta especial, função CTB91FUN)
Ao entrar nesta consulta será apresentada a tela (ver Protótipo 07), com a seguinte informação:
Tipo.- Permitirá selecionar entre Conversão de Moedas (AxMoeda) e Apontador (Posicione) (fazer uso da função CTB92LBOX, para gerar este conteúdo). Ao sair deste campo será filtrado o catálogo de funções (CWN) com os que forem do tipo selecionado (CWN_tipo) para preencher com esta informação o listbox seguinte. Também limpar o campo Help.
Funções.- Código e descrição da função (CWN_codfun y CWN_descri). Ao sair deste campo será preenchido o campo help (CWN_help).
Help.- Texto de ajuda conforme a função selecionada no campo anterior (CWN_help).
Ao selecionar Ok, irá retornar o código da função selecionada (CWN_codfun), se cancelar, não retorna nenhum valor.
Seleção de Fórmulas (Consulta especial , função CTB91FOR)
Ao entrar nesta consulta será apresentada a tela (ver Protótipo 08), com a seguinte informação:
Grupo.- O usuário poderá digitar o código do grupo ou selecionar na tabela cz das tabelas genéricas (sx5). Será confirmado que este seja um código válido. Ao sair deste campo será filtrada a informação das fórmulas (CWK), que são do grupo selecionado (CWK_grupo). Também limpar o campo Help.
Descrição.- Nome do grupo, só é visualizado (x5_descri).
Fórmula.- Código e descrição (CWK_codfor, CWK_desc) da fórmula segundo o grupo selecionado. Ao sair deste campo, serão preenchidos os dados correspondentes no campo Help (CWK_help).
Help.- Texto da ajuda segundo a fórmula selecionada no campo anterior (CWK_help). Após a ajuda, incluir a informação da instrução de ADVPL da fórmula (CWK_advpl).
Ao selecionar Ok, será devolvido o código da fórmula selecionada (CWK_codfor), se cancelar, não será devolvido nenhum valor.
Seleção de Valor Fixo (Consulta especial , função CTB91VAL)
Esta consulta permitirá ao usuário selecionar valores dos catálogos de Contas contáveis, Centros de custo, item contábil e Classe valor.
Ao entrar será apresentada a tela (ver Protótipo 09), com a seguinte informação:
Tipo.- Poderá ser selecionado entre as opções Contas contáveis, Centros de custo, item contábil e classe de valor.
Conta contábil.- Este campo será ativado se o tipo for de Conta contábil, será possível digitar diretamente uma conta contábil válida ou selecionar no catálogo (ct1). Ao selecionar a conta válida será apresentada a descrição da conta no seguinte campo.
Descrição.- Descrição da conta (ct1_desc01). Não editável.
C. de Custo.- Este campo será ativado se o tipo for C. de Custo, será possível digitar diretamente um Centro de custo válido ou efetuar a seleção no catálogo (ctt). Ao selecionar o centro de custo válido será apresentada a descrição no seguinte campo.
Descrição.- Descrição da conta (ctt_desc01). Não editável.
Item Contábil.- Este campo será ativado se o tipo for Item contábil, será possível digital diretamente um código válido ou efetuar a seleção no catálogo (ctd). Ao selecionar o código válido será apresentada a descrição no seguinte campo.
Descrição.- Descrição da conta (ctd_desc01). Não editável.
Cl. Valor.- Este campo será ativado se o tipo for Classe Valor, será possível digitar diretamente um código válido ou efetuar a seleção no catálogo (cth). Ao selecionar o código válido será apresentada a descrição no seguinte campo.
Descrição.- Descrição da conta (cth_desc01). Não editável.
Ao selecionar Ok, irá retornar o conteúdo do campo ativado, se cancelar, não retorna nenhum valor.
CTB911 .- Consulta dinâmica
Será criada a consulta específica CTB911 já que quando sai do campo Tipo de dado, a consulta do campo de Dado associado (CWJ_datvin) irá mudar dependendo do dado selecionado:

• Se o Tipo de dado for 3-Fórmula, será executada a consulta CTB91FOR.
• Se o Tipo de dado for 4-Função, será executada a consulta CTB91FUN.
• Se o Tipo de dado for 6-Valor, será executada a consulta CTB91VAL.

Para conseguir isso, deve ser criada uma consulta específica chamada CTB911, a qual irá chamar a função CTB91CESP() e esta função será programada para desdobrar uma consulta ou outra. Também deve ser criada a função CTB91CRET () para programar o retorno do dado desejado.

Tabelas Utilizadas

• CWL – Items de Fórmulas
• CWH – Tabelas para Uso de Mnemônicos
• CWI – Campos para Uso de Mnemônicos
• CWJ – Manutenção de Mnemônicos
• SX2 – Tabelas do Sistema
• SX3 – Campos do Sistema
• CWK - Fórmulas
• CWN - Funções
• CTT - Centros de custo
• CTD.- Item Contábil
• CTH.- Classe de Valor
• CT1.- Plano de Contas
• SX5 .- Tabela CZ

Protótipo de Telas 

Protótipo 1: Browse de mnemônicos Retorno

 Protótipo 2: Captura de mnemônicos Retorno

Protótipo 3: Lista de tabelas Retorno

Protótipo 4: Lista de campos Retorno

Protótipo 5: Legenda Retorno

Protótipo 6: Consultas especiais Retorno

Consulta CTB91FUN

Retorno

Consulta CTB91FOR

Retorno

Protótipo 7.- Consulta de valores Voltar

Consulta CTB91VAL

Retorno

Regras de Integridade 

• São citadas na seção de Regra de Negócio.

Release Notes 

Fluxo de Processo 

Diagrama de Entidade e Relacionamento

Dicionário de Dados     

Índice: CWH_FILIAL+CWH_TABLA

Índice: CWI_FILIAL+CWI_TABLA+CWI_CAMPO

Índice: CWJ_FILIAL+CWJ_codMNE

Nota:

As funções CWJAliasBox() devem apresentar as tabelas disponíveis para os mnemônicos (CWH), tomando como base a função fTablesBox()                                                                                                                                                                                                                                   

As funções CWJAliasVld() devem validar as tabelas disponíveis para os mnemônicos (CWH), tomando como base a função RcaAliasVld().       

A consulta CWJCPO deve apresentar os campos disponíveis para a tabela selecionada (CWH) filtrando somente os campos, segundo a tabela selecionada. Tomar como base a consulta RCAFIE  que contém a função fListaField().

Índice: CWN_FILIAL+CWN_CODFUN

Índice: CWK_FILIAL+CWK_CODFOR

Tabelas genéricas (sx5)

Consultas Especiais (sxb)

Estrutura de Menu

No módulo Configurador (SIGACFG) informe a rota Ambiente/Arquivos/Menu (CFGX013). Informe a nova opção de menú do SIGACTB (Contabilidade de Gestão) segundo as seguintes instruções: