Histórico da Página
Integração - Emissão de Cheques - Protheus - Logix TRB
Características do Requisito
Linha de Produto: Informe a linha de produto. | Microsiga Protheus | ||||||||||||
Segmento: | Informe o segmento.Serviços | ||||||||||||
Módulo: Informe o módulo. | SIGAGPE - Gestão de Pessoal | ||||||||||||
Rotina: |
| ||||||||||||
Cadastros Iniciais: | Relacione os cadastros necessários que precisam ser preenchidos antes da utilização desse requisito. | ||||||||||||
Parâmetro(s): | Informe os parâmetros utilizados. | ||||||||||||
Ponto de Entrada: | Informe o ponto de entrada relacionado (link). | ||||||||||||
Chamados relacionados | Informe o(s) chamado(s) relacionado(s). | ||||||||||||
Requisito (ISSUE): | Informe o requisito relacionado (Issue). | ||||||||||||
País(es): | Informe o(s) Pais(es). | ||||||||||||
Banco(s) de Dados: | Informe o(s) Banco(s) de Dados utilizado(s). | ||||||||||||
Tabelas utilizadas: | Informe as tabelas utilizadas. | ||||||||||||
Sistema(s) operacional(is): | Informe o(s) sistema(s) operacional(is) utilizados. | ||||||||||||
Versões/Release: | Informe as versões. |
Descrição
Escreva aqui a descrição da nova implementação ou melhoria.
| ||||
Chamados relacionados | TRPNAS | |||
Tabelas utilizadas: | SEF; SM3 | |||
Versões/Release: | 11.80 |
Descrição da Implementação
A implementação consiste em uma melhoria que será disponibilizada, principalmente, para os clientes que utilizam a Folha do Protheus (SIGAGPE) e desejam integrar a Emissão de Cheques (GPER280), que é realizada pelo RH, com o módulo TRB do Logix. Essa integração será realizada via "Mensagem Única", sendo que a mensagem utilizada é a "BankTransaction" (versão 1.000).
A rotina de integração será ativada junto à emissão de cheques, gerando um arquivo (XML) que será enviado para o Logix, que por sua vez encaminhará um outro arquivo, de retorno, do mesmo formato, informando ao Protheus, além do "status" da mensagem, os dados de "Número do Documento", "Número do Lote" e "Sequência do Lote". O Protheus armazenará esses dados (na tabela de De-Para, XXF) para que, necessitando de um futuro cancelamento ou alteração, os cheques possam ser identificados no Logix.
Adapter EAI
- Ao configurar o "Adapter EAI" da rotina GPEA281, sempre que houver emissão de cheques pelo módulo SIGAGPE, os cheques serão integrados com o módulo TRB, ou seja, para não utilizar a integração basta não configurar o "Adapter" da rotina;
Rotina de Manutenção de Cheques (GPEA281)
- Os cheques emitidos pela rotina de Emissão de Cheques (GPER280) poderão ser visualizados pela rotina de Manutenção de Cheques (GPEA281);
- Essa é uma rotina independente da integração, portanto possui uma documentação a parte;
- A rotina não permitirá a alteração dos dados dos cheques, na medida em que os cheques já foram emitidos, com exceção da Conta Contábil de Débito e do Item Contábil (AEN). Além disso, a rotina permitirá o cancelamento dos cheques;
- O cancelamento dos cheques poderá ser "solicitado" pelo Protheus, porém o tratamento que verificará se o cheque pode ser cancelado ou não será realizado pelo Logix;
- Essa rotina poderá ser acessada através da rotina de Emissão de Cheques (GPER280), no módulo "Gestão de Pessoal" (SIGAGPE) do Protheus;
Contabilização
- Ao implementar a integração da emissão de cheques entre o Protheus e o Logix, a contabilização da folha continuará sendo feita como anteriormente nos produtos padrões, ou seja, caso haja alguma customização na contabilização de ambos os produtos, essa é de responsabilidade do cliente;
Parâmetros da Rotina
- Além dos parâmetros já existentes na rotina de "Emissão de Cheques", serão apresentadas três novas perguntas de caráter obrigatório: "Conta Contábil de Débito", "Item Contábil (AEN Logix)" e "Código do Histórico Contábil";
- Esses três parâmetros referem-se, respectivamente, a conta contábil de débito, cujo TRB utilizará no momento da conciliação bancária, ao código do Item Contábil, que no Logix é denominado "Área Estratégica de Negócio" (AEN) e ao código do histórico contábil, que é um cadastro existente no Logix;
- Essas perguntas serão apresentadas apenas para quem possuir essa integração entre a Emissão de Cheques e o módulo TRB.
Importante:
A troca de informações bancárias entre as marcas (Protheus e Logix) será garantida pela mensagem única Bank, que deve estar funcionando corretamente para que a integração entre Emissão de Cheques (Protheus) e móldulo TRB (Logix), seja implementada corretamente.
Procedimento para Implantação
Aplicar o patch do chamado;
- Executar o Compatibilizador para que as alterações que constam no item "Atualizações do Compatibilizador" sejam realizadas (conforme orientações abaixo);
Configurar a rotina GPEA281 no Schedule, conforme orientações do item "Procedimento para Configuração";
Para executar o compatibilizador RHUPDMOD:
Em ByYou Smart Client, informe "RHUPDMOD" no campo Programa Inicial.
Importante
(Apenas para Microsiga Protheus, versões anteriores à versão 12)
Antes de executar o compatibilizador informe o nome do compatibilizador é imprescindível:
- Realizar o backup da base de dados do produto que será executado o compatibilizador (diretório PROTHEUS_DATA\DATA, se versão 10, ou \PROTHEUS11_DATA\DATA, se versão 11) e dos dicionários de dados SXs (diretório PROTHEUS_DATA_SYSTEM, se versão 10, ou \PROTHEUS11_DATA\SYSTEM, se versão 11).
- Os diretórios acima mencionados correspondem à instalação padrão do Protheus, portanto, devem ser alterados conforme o produto instalado na empresa.
- Essa rotina deve ser executada em modo exclusivo, ou seja, nenhum usuário deve estar utilizando o sistema.
- Se os dicionários de dados possuírem índices personalizados (criados pelo usuário), antes de executar o compatibilizador, certifique-se de que estão identificados pelo nickname. Caso o compatibilizador necessite criar índices, irá adicioná-los a partir da ordem original instalada pelo Protheus, o que poderá sobrescrever índices personalizados, caso não estejam identificados pelo nickname.
- O compatibilizador deve ser executado com a Integridade Referencial desativada*.
Atenção O procedimento a seguir deve ser realizado por um profissional qualificado como Administrador de Banco de Dados (DBA) ou equivalente! A ativação indevida da Integridade Referencial pode alterar drasticamente o relacionamento entre tabelas no banco de dados. Portanto, antes de utilizá-la, observe atentamente os procedimentos a seguir:
Contate o Help Desk Framework EM CASO DE DÚVIDAS! |
---|
- Em Microsiga Protheus TOTVS Smart Client (se versão 10) ou ByYou Smart Client (se versão 11), digite informe o nome do compatibilizador no campo Programa Inicial. Descreva se o compatibilizador deve ter uma data específica ou superior para que a atualização nos dicionários seja efetuada corretamente. Importante: Para a correta atualização do dicionário de dados, certifique-se que a data do compatibilizador seja igual ou superior a ___/___/____18/09/2015.
- Clique em OK para continuar.
- Após a confirmação é exibida uma tela para a seleção da empresa em que o dicionário de dados será modificado modificado ou é apresentada a janela para seleção do compatibilizador. Selecione o programa xxxxSIGAGPE().
- Ao confirmar é exibida uma mensagem de advertência sobre o o backup e a necessidade de sua execução em modo exclusivo.
- Selecione as opções 298 e 299 referentes a criação da tabela SM3 e a do parâmetro MV_INTGTRB juntamente com o grupo de perguntas GPEA281, respectivamente.
- Clique em Processar para iniciar o processamento. O primeiro passo da execução é a preparação dos arquivos.
É apresentada uma mensagem explicativa na tela. - Em seguida, é exibida a janela
- janela Atualização concluída com o histórico (log) de todas as atualizações processadas. Nesse
- Nesse log de atualização são apresentados somente os campos atualizados pelo programa. O compatibilizador cria os campos que ainda não existem no dicionário de dados.
- Clique em Gravar para salvar o histórico (log) apresentado.
- Clique em OK para encerrar o processamento.
Atenção:
A integração da emissão de cheques deve ser utilizada somente após a execução dos procedimentos citados acimaDescreva se há algum procedimento necessário após a aplicação do compatibilizador.
Procedimento para
ImplantaçãoO sistema é atualizado logo após a aplicação do pacote de atualizações (Patch) deste chamado.
- Aplique o patch do chamado e execute uma vez a rotina Informe o nome da rotina.
- No módulo informe o nome do módulo acesse informe o caminho e verifique que o parâmetro informe o nome do parâmetro é criado conforme especificações abaixo:
Nome da Variável: | Informe o Nome da Variável |
Tipo: | Informe o Tipo |
Descrição: | Informe a Descrição |
Valor Padrão: | Informe o Valor Padrão |
Utilização
- Em "Gestão de Pessoal" (SIGAGPE) acesse, "Relatórios > Recibos/Cheques > Emissão de Cheques";
- Selecione a rotina de "Emissão de Cheques" ou a de "Manutenção de Cheques";
- Selecionando a opção de "Manutenção de Cheques" será aberta uma tela com os cheques que já foram emitidos, permitindo o cancelamento ou alteração dos mesmos;
- Escolha a operação a ser realizada e confirme;
- Selecionando a opção de "Emissão de Cheques", a rotina para emissão seguirá seu curso normalmente (assim como era antes), com exceção das duas novas perguntas que serão apresentadas;
- Informe os parâmetros solicitados;
- Emita os cheques;
- Selecionando a opção de "Manutenção de Cheques" será aberta uma tela com os cheques que já foram emitidos, permitindo o cancelamento ou alteração dos mesmos;
- As informações serão enviadas ao Logix;
Procedimento para Configuração
1. No Configurador (SIGACFG), acesse Ambientes/Cadastros/Parâmetros (CFGX017). Configure o parâmetro a seguir:
Nome: | MV_INTGTRB |
Tipo: | Lógico |
Cont. Por.: | .F. |
Descrição: | Integra Emissão de Cheques com o TRB? .T. = Integra, .F. = Não integra |
2. No Configurador (SIGACFG), acesse Ambientes/Schedule/Adapter E.A.I (CFGX017) e inclua a rotina conforme os campos abaixo.
OBS: Os campos que não estão informados abaixo podem ser configurados conforme preferência do cliente.
Campo | Conteúdo |
Mensagem Única | Sim |
Rotina | GPEA281 |
Mensagem | BankTransactions |
Canal de Envio | EAI |
Atualizações do Compatibilizador
1. Criação
Atualizações do Compatibilizador
(Apenas para Microsiga Protheus, versões anteriores à versão 12)
Criaçãoou Alteração de Perguntas no arquivo SX1 – Cadastro de Perguntes:
- Grupo GPEA281 - Integração Logix - Emissão de Cheques
Pergunte | Conta Contábil Débito? |
Grupo | GPEA281 |
Ordem | 01 |
Tipo | Caracter |
Tamanho | 20 |
Pergunte | Item Contábil? |
Grupo | GPEA281 |
Ordem | 02 |
Tipo | Caracter |
Tamanho | 9 |
Pergunte | Codigo Histórico Contábil? |
Grupo | GPEA281 |
Ordem | 03 |
Tipo | Caracter |
Tamanho | 3 |
Pergunte | (X1_PERGUNT) |
Nome |
|
Grupo | (X1_GRUPO) |
Ordem | (X1_ORDEM) |
Tipo | (X1_TIPO) |
Tamanho | (X1_TAMANHO) |
2.
Criação
ou Alteraçãode tabela no arquivo
SX2–SX2 – Tabelas:
Chave | Nome | Modo | PYMEPyme | B04 (X2_CHAVE) | Dente/Região (X2_NOME) | C (X2_MODO) |
SM3 | Cheques RH | C | S |
3.
Criação ou Alteração de Tabelas GenéricasCriação de Campos no arquivo
SX5SX3 –
Tabelas Genéricas:Chave | Ex.: AR |
Descrição | Ex.: Tabela de IR de Aplicações Financeiras |
4. Criação ou Alteração (mantenha somente a instrução correspondente) de Campos no arquivo SX3 – Campos:
- Tabela BGD - Prod x Cob x Proc x Co-Part:
Campo | (X3_CAMPO) |
Tipo | (X3_TIPO) |
Tamanho | (X3_TAMANHO) |
Decimal | (X3_DECIMAL) |
Formato | (X3_PICTURE) |
Título | (X3_TITULO) |
Descrição | (X3_DESCRIC) |
Nível | (X3_NÍVEL) |
Usado | (X3_USADO) Informe Sim ou Não |
Obrigatório | (X3_OBRIGAT) Informe Sim ou Não |
Browse | (X3_BROWSE) Informe Sim ou Não |
Opções | (X3_CBOX) |
When | (X3_WHEN) |
Relação | (X3_RELACAO) |
Val. Sistema | (X3_VALID) |
Help | Descreva o conteúdo informado para Help de Campo no ATUSX |
Importante:
O tamanho dos campos que possuem grupo pode variar conforme ambiente em uso.
5. Criação ou Alteração de Consulta Padrão no arquivo SXB – Consulta Padrão:
- Pesquisa B05PLS:
Alias | (XB_ALIAS) |
Tipo | (XB_TIPO) |
Sequência | (XB_SEQ) |
Coluna | (XB_COLUNA) |
Descrição | (XB_DESCRI) |
Contém | (XB_CONTEM) |
6. Criação ou Alteração de Índices no arquivo SIX – Índices:
Índice | AA1 |
Ordem | 6 |
Chave | AA1_FILIAL+AA1_CODVEN |
Descrição | Cod. Vendedor |
Proprietário | S |
7. Criação ou Alteração de Parâmetros no arquivo SX6 – Parâmetros:
Nome da Variável | (X6_VAR) |
Tipo | (X6_TIPO) |
Descrição | (X6_DESCRIC + X6_DESC1 + X6_DESC2) |
Valor Padrão | (X6_CONTEUD) |
8. Criação ou Alteração (mantenha somente a instrução correspondente) de Gatilhos no arquivo SX7 – Gatilhos:
- Tabela BD5 – Contas Médicas:
Campo | Informe o conteúdo do (X7_CAMPO) |
Sequência | Informe o conteúdo do (X7_SEQUENC) |
Campo Domínio | Informe o conteúdo do (X7_CDOMIN) |
Tipo | Informe o conteúdo do (X7_TIPO) |
Regra | Informe o conteúdo do (X7_REGRA) |
Posiciona? | Informe o conteúdo do (X7_SEEK) |
Chave | Informe o conteúdo do (X7_CHAVE) |
Condição | Informe o conteúdo do (X7_CONDIC) |
Proprietário | Informe o conteúdo do (X7_PROPRI) |
Procedimento para Configuração
(Estes procedimentos devem ser feitos quando for necessário configurar parâmetros e/ou rotinas no menu).
CONFIGURAÇÃO DE PARÂMETROS
- No Configurador (SIGACFG), acesse Ambientes/Cadastros/Parâmetros (CFGX017). Crie/configure (mantenha somente a instrução correspondente) o(s) parâmetro(s) a seguir:
(É necessário criar uma tabela para cada parâmetro descrito no item Parâmetro(s), da tabela Características do Requisito)
Itens/Pastas | Descrição |
Nome: |
|
Tipo: | Informe o Tipo do parâmetro |
Cont. Por.: | Informe o Conteúdo padrão |
Descrição: |
|
CONFIGURAÇÃO DE MENUS
2. No Configurador (SIGACFG), acesse Ambientes/Cadastro/Menu (CFGX013). Informe a nova opção de menu do informe o nome do módulo, conforme instruções a seguir:
Menu | Informe o Menu em que estará localizada a rotina |
Submenu | Informe o Submenu em que estará localizada a rotina |
Nome da Rotina | Informe o Título da rotina |
Programa | Informe o Fonte da rotina |
Módulo | Informe o Nome do(s) produto(s) a ser utilizado ou “Todos” |
Tipo | Informe a Função |
Procedimento para Utilização
- Descreva os procedimentos, passo a passo (caso de uso), que serão realizados pelos usuários para que a melhoria seja visualizada identificando as seguintes informações:
- Localização da rotina no menu;
- Localização dos novos campos e/ou perguntas e respectivas pastas de cadastro que são visualizadas pelo usuário;
- Caso seja necessário ter algum cadastro feito previamente, faça uma observação.
Exemplo:
1. No Plano de Saúde (SIGAPLS), acesse Atualizações / Produto Saúde / Produto Saúde (PLSA800).
O sistema apresenta a janela de produtos cadastrados.
2. Posicione o cursor em um produto e clique em Alterar.
3. Na pasta Cobertura/Carências selecione a subpasta Tipo de Prestador.
4. Dê duplo clique no campo TP Prestador (BCW_TIPPRE).
O sistema apresenta a janela Tipo de Prestador – Coparticipação – Alterar.
5. Informe os dados conforme orientação do help de campo e observe o preenchimento do novo campo:
Som. p/Compra (BCW_SOMCOM): selecione Sim para indicar se a coparticipação cadastrada será válida somente para efeito de compra de procedimentos ou Não, caso contrário.
6. Confira os dados e confirme.
Ponto de Entrada
Descrição: | Informe o Menu em que estará localizada a rotina | ||||||||||||||||
Localização: | Informe o Submenu em que estará localizada a rotina | ||||||||||||||||
Eventos: | Informe o Título da rotina | ||||||||||||||||
Programa Fonte: | Informe o Fonte da rotina | ||||||||||||||||
Função: | Informe o Nome do(s) produto(s) a ser utilizado ou “Todos” | ||||||||||||||||
Retorno: |
|
Exemplo:
#Include 'Protheus.ch'
User Function CN120ALT()
Local aCab:= PARAMIXB[1]
Local cTipo:= PARAMIXB[2]
If cTipo == '1'
aCab[4][2]:= 'NF' //Validações do usuário
EndIf
Return aCabCampos:
- Tabela SM3 - Cheques RH
Campo | M3_FILIAL |
Tipo | Caracter |
Tamanho | 2 |
Decimal | 0 |
Formato | |
Título | Filial |
Descrição | Filial |
Usado | Não |
Obrigatório | Não |
Val. Sistema | |
Help | Filial do Sistema. |
Campo | M3_BANCO |
Tipo | Caracter |
Tamanho | 3 |
Decimal | 0 |
Formato | @! |
Título | Banco |
Descrição | Código do Banco |
Usado | Sim |
Obrigatório | Sim |
Val. Sistema | |
Help | Informe o código do Banco. |
Campo | M3_AGENCIA |
Tipo | Caracter |
Tamanho | 5 |
Decimal | 0 |
Formato | @! |
Título | Agência |
Descrição | Código da Agência |
Usado | Sim |
Obrigatório | Sim |
Val. Sistema | |
Help | Informe o código da Agência. |
Campo | M3_CONTA |
Tipo | Caracter |
Tamanho | 11 |
Decimal | 0 |
Formato | @! |
Título | Conta |
Descrição | Conta Corrente |
Usado | Sim |
Obrigatório | Sim |
Val. Sistema | |
Help | Informe o número da conta bancária. |
Campo | M3_NUMCHEQ |
Tipo | Caracter |
Tamanho | 15 |
Decimal | 0 |
Formato | @! |
Título | Núm. Cheque |
Descrição | Número do Cheque |
Usado | Sim |
Obrigatório | Sim |
Val. Sistema | |
Help | Número do cheque emitido. |
Campo | M3_DTEMISS |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Formato | |
Título | Data Em. Chq |
Descrição | Data Emissão Cheque |
Usado | Sim |
Obrigatório | Sim |
Val. Sistema | M->M3_DTEMISS <= dDataBase |
Help | Data de Emissão do Cheque. |
Campo | M3_VALOR |
Tipo | Numérico |
Tamanho | 16 |
Decimal | 2 |
Formato | @E 9,999,999,999,999.99 |
Título | Valor Cheque |
Descrição | Valor do Cheque |
Usado | Sim |
Obrigatório | Sim |
Val. Sistema | Positivo() .And. (M->M3_VALOR > 0) |
Help | Valor do cheque emitido. |
Campo | M3_TIPO |
Tipo | Caracter |
Tamanho | 3 |
Decimal | 0 |
Formato | |
Título | Tipo Título |
Descrição | Tipo do Título |
Usado | Sim |
Obrigatório | Sim |
Val. Sistema | |
Help | Tipo do Título. |
Campo | M3_BENEF |
Tipo | Caracter |
Tamanho | 40 |
Decimal | 0 |
Formato | @!S40 |
Título | Nome Benef. |
Descrição | Nome do Beneficiário |
Usado | Sim |
Obrigatório | Não |
Val. Sistema | |
Help | Nome do beneficiário. |
Campo | M3_MAT |
Tipo | Caracter |
Tamanho | 6 |
Decimal | 0 |
Formato | @! |
Título | Cod. Fun. |
Descrição | Código do Funcionário |
Usado | Sim |
Obrigatório | Não |
Val. Sistema | |
Help | Código do Funcionário que representa o Fornecedor. |
Campo | M3_DEBITO |
Tipo | Caracter |
Tamanho | 20 |
Decimal | 0 |
Formato | @! |
Título | Conta Deb. |
Descrição | Conta Contábil de Débito |
Usado | Sim |
Obrigatório | Não |
Val. Sistema | CTB105CTA(M->M3_DEBITO) |
Help | Conta contábil de débito que será utilizada na conciliação bancária do módulo TRB. |
Campo | M3_CREDITO |
Tipo | Caracter |
Tamanho | 20 |
Decimal | 0 |
Formato | @! |
Título | Conta Cred. |
Descrição | Conta Contábil de Crédito |
Usado | Sim |
Obrigatório | Não |
Val. Sistema | CTB105CTA(M->M3_CREDITO) |
Help | Conta contábil de crédito que será utilizada na conciliação bancária do módulo TRB. |
Campo | M3_IMPRESS |
Tipo | Caracter |
Tamanho | 1 |
Decimal | 0 |
Formato | @! |
Título | Status Impr. |
Descrição | Status da Impressão |
Usado | Sim |
Obrigatório | Não |
Val. Sistema | Pertence("SC") .And. NaoVazio() |
Help | Status da impressão do cheque, sendo que: S = Impresso; e C = Cancelado. |
Campo | M3_ITEMC |
Tipo | Caracter |
Tamanho | 9 |
Decimal | 0 |
Formato | @! |
Título | Item Cont. |
Descrição | Item Contábil (AEN) |
Usado | Sim |
Obrigatório | Não |
Val. Sistema | CTB105ITEM() |
Help | Item contábil (AEN Logix) que será utilizado na conciliação bancária do módulo TRB. Obs: O Item Contábil do Protheus equivale, no Logix, a Área Estratégica de Negócio (AEN). |
Campo | M3_CODHIST |
Tipo | Caracter |
Tamanho | 3 |
Decimal | 0 |
Formato | @! |
Título | Cod. Hist. |
Descrição | Codigo Histórico Logix |
Usado | Sim |
Obrigatório | Não |
Val. Sistema |
|
Help | Código do Histórico Contábil no Logix. |
4. Criação de Parâmetros no arquivo SX6 – Parâmetros:
Nome da Variável | MV_INTGTRB |
Tipo | Lógico |
Descrição | Integra Emissão de Cheques com o TRB? .T. = Integra, .F. = Não integra |
Valor Padrão | .F. |
5. Criação de Índices no arquivo SIX – Índices:
Índice | SM3 |
Ordem | 1 |
Chave | M3_FILIAL+M3_BANCO+M3_AGENCIA+M3_CONTA+M3_NUMCHEQ |
Proprietário | S |
Índice | SM3 |
Ordem | 2 |
Chave | M3_FILIAL+M3_NUMCHEQ |
Proprietário | S |
Índice | SM3 |
Ordem | 3 |
Chave | M3_FILIAL+DTOS(M3_DTEMISS)+STR(M3_VALOR) |
Proprietário | S |