Integração Sigajuri x RM Abril/2015
Sumário 1. Contexto de negócio (Introdução)... 3 2. Sistemas Envolvidos... 3 3. Integração... 3 4. Escopo... 6 5. Pré-requisitos instalação/implantação/utilização... 6 5.1.Microsiga Protheus... 6 6. Instalação/Atualização... 7 6.1.Protheus... 7 6.2.RM... 8 7. Controle de Versão... 8 8. Suporte... 8 9. Transações/Entidades/Mensagens únicas... 9 10. Fluxo das Informações... 9 11. Como fazer (opcional)... 9 12. Situações comuns (opcional)... 9 13. Checklist de suporte da aplicação... 9 2 Versão 4.1
1. Contexto de negócio (Introdução) Gestão Jurídica (SIGAJURI) Desenvolvemos o Gestão Jurídica para atender os departamentos jurídicos de empresas e tem como principais objetivos, a Administração das Contingências, Gestão de Procurações e Documentos Societários, Facilitar o Relacionamento com Escritórios Parceiros e Fornecer maior Sinergia com as áreas Contábil e de Recursos Humanos. Para esta sinergia com a área Contábil, existe uma integração de valores entre o Gestão Jurídica (SIGAJURI) e o módulo Financeiro (SIGAFIN) pela qual integramos os Valores de Garantias, Levantamentos e Despesas Jurídicas, gerando títulos a pagar. TOTVS Gestão Financeira O TOTVS Gestão Financeira permite às instituições realizar / manter as operações financeiras da instituição, tais como: Controle de Contas a Pagar e Contas a Receber, Fluxo de Caixa, Pagamentos e Cobrança Eletrônica, Aplicação Financeira e outros Controles Financeiros. Backoffice PROTHEUS (Financeiro) O Controle de Títulos e Valores, Posição de Caixa, de Clientes e de Fornecedores, além de Contas a Pagar e a Receber, são controles básicos oferecidos pelo módulo Financeiro (SIGAFIN) e além disso permite administrar os registros de Títulos a Pagar e a Receber, facilidades nos cadastros, consultas, relatórios e comunicação bancária, além dos processos referentes à contabilização. TOTVS Gestão Financeira x Backoffice PROTHEUS Este documento tem por objetivo reunir as informações relevantes sobre a Integração do TOTVS Gestão Financeira RM com Backoffice Protheus (Financeiro). Esta integração está de acordo com as boas práticas recomendadas pelo Comitê de Integração TOTVS e utiliza a arquitetura de Mensagem Única e comunicação via Webservice. 2. Sistemas Envolvidos TOTVS Gestão Financeira O módulo Financeiro gerencia as operações financeiras por meio de ferramentas que permitem maior agilidade nos processos que envolvem o Contas a Pagar / Receber, Fluxo de Caixa entre outros; Microsiga Protheus, SIGAJURI Gestão Jurídica; Backoffice Protheus (Financeiro); 3. Integração Os objetivos principais são: Realizar a integração entre os sistemas Backoffice do Microsiga Protheus, (Financeiro) e o TOTVS Gestão Financeira, integrando a geração de títulos a pagar, utilizando mensagem única. Os valores integrados são aqueles gerados na integração de valores entre o módulo SIGAJURI e o Backoffice Microsiga Protheus indicado no contexto de negócio. Versão 4.1 3
Com isso são integradas as seguintes informações: Envio da Natureza Financeira do Backoffice Microsiga Protheus do módulo Financeiro, para o TOTVS Gestão Financeira. Envio de Fornecedor do Backoffice Microsiga Protheus do módulo Financeiro, para o TOTVS Gestão Financeira. Envio de Moeda Contábil do Backoffice Microsiga Protheus do módulo Contabilidade Gerencial, para o TOTVS Gestão Contábil. Envio de Contas a Pagar do Backoffice Microsiga Protheus do módulo Financeiro para o TOTVS Gestão Financeira. A integração é necessária para que a linha RM possa consumir informações na base do Microsiga Protheus. Sendo assim, considerando o cenário atual, podemos ter diversas situações onde utilizamos sistemas de linhas diferentes em nossos clientes. Para facilitar e agilizar a utilização desta integração, descrevemos a utilização da mensageria única. Definição de Mensagem Única TotvsMessage Durante o processo de consolidação de marcas, iniciado pela TOTVS, várias empresas diferentes foram adquiridas e com elas vários produtos passaram a compor o portfólio de ofertas disponíveis aos clientes. Esta expansão de ofertas permitiu que clientes de uma marca, antes limitados pelas opções com aquela etiqueta, pudessem agora compor o seu ambiente de TI, utilizando produtos de origens diferentes (Ex.: TOTVS Gestão Financeira + Backoffice Protheus). Esta mesma iniciativa já era uma prática comum nos clientes, porém todo custo envolvido na integração entre estes aplicativos, era visto pelo cliente como parte da escolha de utilizar produtos de diferentes fornecedores. Uma vez que estes produtos passam a fazer parte de uma mesma oferta, os clientes TOTVS demandam a integração natural entre estes produtos. Isto significa que se antes o cliente arcava com o custo e o risco envolvido em uma integração, ele agora entende que a TOTVS deve prover soluções já integradas, independente da origem dos produtos oferecidos. Com o objetivo de padronizar as integrações com os produtos TOTVS, definiu-se uma nova diretriz para os projetos de integração: A de que todos os produtos TOTVS trabalhem com uma mensagem XML única, evitando desta forma, o processo de transformação de mensagens. Neste cenário, temos o seguinte quadro: 4 Versão 4.1
Neste cenário, qualquer produto TOTVS trabalha com o mesmo XML para uma mesma entidade, ou seja, supondo que tenhamos um XML correspondente à mensagem de clientes, esta pode ser enviada a qualquer um dos produtos que suportem o recebimento desta entidade. Uma vez que os vários produtos TOTVS tem um idioma comum (o XML único), as integrações entre estes produtos deixam de exigir que as mensagens sejam transformadas de um formato a outro. Com isso, podemos conectar diretamente dois produtos, como no diagrama abaixo: Além de questões referentes ao formato das mensagens, a mensagem única também dá uniformidade e tratamento a estas mensagens XML pelos aplicativos, principalmente no que diz respeito à capacidade de rastreamento. Todos os processos respeitam o fluxo normal de troca de mensagens no padrão de Mensagem Única TOTVS. Este fluxo pode ocorrer nos seguintes sentidos: RM (Educacional, Processo Seletivo, Biblioteca, Financeiro) PROTHEUS: Os dados trafegam pelo fluxo normal até a fila de integração TBC. Consome-se o Webservice do EAI do PROTHEUS para envio da (s) mensagem (s). Após a resposta do PROTHEUS o RM atualiza o registro, com o status de processamento e demais dados, no monitor da fila de Mensagem Única. PROTHEUS RM (Educacional, Processo Seletivo, Biblioteca, Financeiro): O PROTHEUS consome o Webservice da linha RM para recebimento de mensagens únicas. Também é responsável por encaminhar as mensagens para o EAI RM, que o processa e encaminha o retorno, de acordo com o tipo de comunicação definida (síncrona ou assíncrona). Assim como definido no protocolo de comunicação de mensagens únicas, a comunicação pode ser efetuada de duas formas: Síncrona: O sistema de origem gera uma mensagem de integração na sua fila e envia ao Webservice de destino. O processo na origem aguarda o processamento da mensagem no destino e ao receber o retorno, atualiza o status do processamento na fila de integração. Assíncrona: O sistema de origem gera uma mensagem de integração em sua fila, envia ao Webservice de destino e aguarda somente a confirmação de recebimento da mensagem. O processo na origem não fica parado aguardando o processamento da mensagem de destino. Pela parte do sistema de destino, ao término do processamento da mensagem, envia outra mensagem de retorno ao sistema de origem com o status do processamento. Lembrando que as mensagens assíncronas podem ser processadas (status pendente) ou reprocessadas (status erro) manualmente pelo monitor da fila de integração. Versão 4.1 5
Cada linha de produto pode programar a fila de integração de uma maneira, mas sempre respeitando o protocolo definido para mensagem padrão e armazenando o log de processamento de todas mensagens recebidas e/ou enviadas. 4. Escopo A proposta da integração viabiliza aos usuários de outros sistemas TOTVS a consulta de lançamentos contábeis e títulos a pagar gerados no Backoffice Protheus, pela integração de valores, disponível no SIGAJURI. As entidades e os pontos de integração que fazem parte desta integração são: ENTIDADES Fornecedores Financeiro (PROTHEUS) Natureza Financeira Financeiro (PROTHEUS) Moeda Contábil Contabilidade Gerencial (PROTHEUS) Contas a pagar Financeiro (PROTHEUS) PONTOS DE INTEGRAÇÃO Criação / Alteração de um fornecedor. Criação / Alteração de uma natureza financeira. Criação / Alteração de uma moeda contábil. Geração de um título a pagar: Ao criar uma Garantia (SIGAJURI), com a integração de valores habilitada. Se há controle de alçada, a integração é feita após a liberação do documento. Ao criar um Alvará /Levantamento (SIGAJURI) que possua valor de correção e juros, com a integração de valores habilitada. Ao criar uma Despesa (SIGAJURI), com a integração de valores habilitada. Se há controle de alçada, a integração é feita após a liberação do documento e geração de nota. 5. Pré-requisitos instalação / implantação / utilização Abaixo a lista de requisitos para utilização da integração tratada neste documento: Servidor de Webservice habilitado; 5.1. Microsiga Protheus Protheus 12; Possuir um licenciamento (License Server) adequado do sistema Microsiga Protheus ; Necessário o uso da ferramenta EAI; Necessária configuração de um Webservice; Módulos necessários: Gestão Jurídica (SIGAJURI) e Financeiro (SIGAFIN); 6 Versão 4.1
6. Instalação / Atualização É preciso habilitar Webservices na application Server do Microsiga Protheus para que os sistemas possam se conectar. Para habilitar os Webservices dentro do Microsiga Protheus, altere o arquivo de configuração appserver.ini com o conteúdo que informamos, e solicitamos atenção às portas de comunicação usadas, para evitar inconsistências: [HTTP] ENABLE=1 PORT=1299 PATH=C:\TOTVS\P12\Protheus_DATA\web\WS ENVIRONMENT=P12 RESPONSEJOB= WS [WSEAI] TYPE=WEBEX ENVIRONMENT=P12 INSTANCES=1,10 SIGAWEB=WS INSTANCENAME=WS ONSTART= WSSTART ONCONNECT= WSCONNECT [ONSTART] JOBS= WSEAI RefreshRate=120 Esta configuração segue os padrões de Webservices do Microsiga Protheus, assim, caso o recurso já esteja habilitado não é necessário fazer nenhuma alteração. 6.1. Protheus Acesse SigaCFG / Ambiente / Cadastros / Parâmetros e configure o parâmetro MV_EAIURL2 com o endereço do serviço de EAI do ambiente ao qual o Protheus está integrado. Exemplo: http://12.50.90.211:81/mensagemunicaws Acesse SigaCFG > Ambiente / Cadastros / Parâmetros e configure o parâmetro MV_EAIWS com o nome do cliente Webservice do EAI para envio ao outro EAI (WSEAISERVICE); Se o servidor precisa de autenticação, acesse SSIGACFG / Ambiente / Cadastros / Parâmetros e configure o parâmetro MV_ EAIUSER com o nome de usuário; Se o servidor precisa de autenticação, acesse SIGACFG / Ambiente / Cadastros / Parâmetros e configure o parâmetro MV_ EAIPASS com a senha de usuário; Acesse SIGACFG / Ambiente / Schedule / Adapter E.A.I. e cadastre as rotinas de integração, conforme segue: Versão 4.1 7
Mensag em Única Rotina Mensagem Envia Recebe Método Opera ção Sim CTBA140 CURRENCY Sim Sim Síncrono Todas EAI Sim FINA010 FINANCIALNATURE Sim Sim Síncrono Todas EAI Sim MATA020 CUSTOMERVENDOR Sim Sim Síncrono Todas EAI Sim FINA050 ACCOUNTPAYABLED OCUMENT Canal Sim Sim Síncrono Todas EAI Se alguma mensagem estiver configurada com o método Assíncrono, acesse SIGACFG / Ambiente / Schedule / Schedule e configure um agente e um agendamento; Se for necessário indicar uma empresa e filial diferente para a integração, acesse SIGACFG / Ambiente / Schedule / Emp. Filial Mensagem Única e configure a referência para envio; 6.2. RM Execute o processo para realizar a instalação da integração; Configure o endereço do Webservice do EAI do TOTVS Protheus para a integração; Informe os campos, abaixo, para configuração da integração: URL WEB SERVICE: Informe o endereço do Webservice Protheus para envio de mensagens. Utilize o formato http://[servidor]:[porta]/eaiservice.apw Para verificar se o WS Protheus está disponível digite esta URL em seu navegador (no formato http://[servidor]:[porta]). Na página apresentada procure pelo texto EAISERVICE); USUÁRIO AUTENTICAÇÃO: Informe o nome do usuário para autenticação pelo Webservice. SENHA AUTENTICAÇÃO: Informe a senha para autenticação pelo Webservice. 7. Controle de Versão O grupo TOTVS representado por suas marcas, administra as demandas de evolução dos layouts e demais ajustes, acordando com os solicitantes o prazo de liberação de release. Todas as evoluções programadas devem ser discutidas e aprovadas pelas marcas, antes de iniciar o desenvolvimento e somente serão desenvolvidas havendo a concordância das marcas e o alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS. 8. Suporte O suporte aos recursos da Integração é de responsabilidade de todas as linhas, sendo assim, as equipes de suporte aos produtos TOTVS Conector e Backoffice Microsiga Protheus estão aptas a fazer a primeira análise e quando necessário, repassar à equipe mais adequada em cada caso. Observação: Este modelo de suporte está sendo revisado pela TOTVS. 8 Versão 4.1
9. Transações/Entidades/Mensagens únicas Abaixo descrevemos as informações trocadas entre os sistemas: ID Descrição Origem Destino XSD Cadastros 01 Moeda Contábil Protheus RM 02 Natureza Financeira Protheus RM 03 Fornecedor Protheus RM 04 Contas a pagar Protheus RM 10. Fluxo das Informações Todas as movimentações de mensagens, com algumas exceções, tanto para envio quanto para recebimento, resultam em um registro na tabela De-Para para relacionamento entre os códigos do sistema que estão trocando informações. Para acessar essas informações acesse SIGACFG / Ambiente / Schedule / De/Para Mensagem Única. 11. Como fazer (opcional) Não se aplica. 12. Situações comuns (opcional) Não se aplica. 13. Checklist de suporte da aplicação Checklist de Verificações: Validar se estão informados os parâmetros de comunicação com o EAI; Validar se está habilitado o Webservice do Microsiga Protheus ; Validar se estão configurados os Adapters do EAI; Validar se o cadastro de Empresa/Filial está configurado caso necessário; Versão 4.1 9