Page History

Integração TOTVS Educacional x BackOffice Protheus

Contexto de negócio (Introdução)

   TOTVS Educacional

O TOTVS Educacional

permite que a instituição de ensino

inicie seus trabalhos depois da captação de alunos, sendo

montada uma estrutura curricular

para

ser oferecida aos alunos e professores.

São cadastrados cursos, disciplinas

e matrizes curriculares para posteriormente oferecer aos alunos nos períodos letivos, turmas etc.

Depois da estrutura curricular montada e ofertada, a instituição de ensino poderá realizar a matrícula de seus alunos e dar permissão aos seus professores para registrarem as notas e faltas dos alunos.

Iniciado o período letivo de uma instituição de ensino, algumas rotinas

são utilizadas com frequência,

como: Transferência de alunos, atividades extra-curriculares, avaliação institucional, emissão de certificados/diplomas, solicitação de recursos/instalações, alocação de salas e etc. Para essas rotinas relacionadas a estrutura acadêmica, damos o nome de

Movimentação Acadêmica.

Outro ponto de movimentação na instituição de ensino, são os processos que acontecem na tesouraria e/ou financeiro. Nessa etapa

são cadastrados os planos de pagamentos, parcelas, bolsas, geração de lançamentos, boletos de pagamentos e etc. Faz parte do fluxo processual do TOTVS Educacional as integrações com outros sistemas/módulos como Gestão de Relacionamento com Clientes, Folha de pagamento, Gestão Bibliotecária, Gestão Financeira entre outros.

BackOffice Protheus (Contabilidade Gerencial) 

Entre os diversos instrumentos

utilizados pela administração, é importante destacar o papel da Contabilidade como meio especialmente concebido para captar, registrar, acumular, resumir, medir e interpretar os fenômenos que afetam a situação patrimonial, financeira e econômica de qualquer empresa, seja qual

for o ramo de atividade

ou a forma jurídica.

A Contabilidade

assim como qualquer outra atividade, tem um elenco de regras e princípios que orienta e disciplina a atividade contábil.

Baseado nestes princípios, o ambiente Contabilidade Gerencial (SIGACTB) proporciona automação completa no controle dos lançamentos contábeis, tendo total integração com os demais ambientes que compõem o sistema Protheus.

TOTVS Educacional x BackOffice Protheus

Este documento

reúne as informações relevantes sobre a Integração do

TOTVS Educacional RM com BackOffice Protheus (Contabilidade Gerencial).

Esta integração está de acordo com as boas práticas recomendadas pelo Comitê de Integração TOTVS e utiliza a arquitetura Mensagem Única e comunicação via WebService.

Sistemas Envolvidos

• TOTVS Educacional – Módulo Educacional que gerencia escolas e faculdades (ensino básico e superior), por meio de ferramentas que permitem maior agilidade nos processos que envolvem os alunos, responsáveis, professores e os funcionários.

• BackOffice Protheus (Contabilidade Gerencial).
  
  

Integração

O objetivo principal é Integrar a contabilização por competência do TOTVS Educacional com o BackOffice Protheus (Contabilidade Gerencial):

• • Envio de Centro de Custo do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional. 
  • Envio de Plano de Contas do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de Período Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de Moeda Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de Classe de Valor do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de Item Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de Lançamentos Contábeis do TOTVS Folha de Pagamento Educacional para o BackOffice Protheus, módulo Contabilidade Gerencial.

Definição de Mensagem Única – TotvsMessage 

Durante Com o processo de consolidação de marcas, iniciado pela TOTVS, várias empresas diferentes forma adquiridas e com elas vários produtos passaram a compor o portfólio de ofertas disponível 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 Educacional + 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-se de produtos de diferentes fornecedores. Uma vez que estes produtos passam a fazer parte de uma mesma oferta, os clientes TOTVS passam a demandar que estes produtos sejam naturalmente integrados. 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, foi definido uma nova diretriz para os projetos de integração: A de que todos os produtos TOTVS devam trabalhar com uma mensagem XML única, evitando desta forma, o processo de transformação de mensagens. Neste cenário, teríamos o seguinte quadro:

Image Removed 

Neste cenário, qualquer produto TOTVS trabalhará com o mesmo XML para uma mesma entidade, ou seja, supondo que tenhamos um XML correspondente à mensagem de clientes, ela poderá ser enviada para qualquer um dos produtos que suporte o recebimento desta entidade. 

Uma vez que os vários produtos TOTVS terão um “idioma” comum (o XML único), as integrações entre estes produtos não exigirão mais que as mensagens sejam transformadas de um formato para outro. Com isso, será possível conectar diretamente dois produtos, como no diagrama abaixo:

Image Removed 

Além de questões referentes ao formato das mensagens, a mensagem única também torna uniforme o tratamento destas mensagens XML pelos aplicativos, principalmente no que diz respeito à capacidade de rastreamento. 

Todos os processos devem respeitar o fluxo normal de troca de mensagens no padrão de Mensagem Única TOTVS. Este fluxo poderá ocorrer nos seguintes sentidos: 

• • TOTVS (Educacional, Processo Seletivo, Biblioteca, Financeiro) -> PROTHEUS: Os dados serão trafegados pelo fluxo normal até a fila de integração TBC, onde o mesmo irá consumir o WebService do EAI do PROTHEUS para envio da(s) mensagem(s). Após a resposta do PROTHEUS, o TOTVS Conector atualizará o registro, com o status de processamento e demais dados, no monitor da fila de Mensagem Única. 

• • PROTHEUS -> TOTVS (Educacional, Processo Seletivo, Biblioteca, Financeiro): O PROTHEUS irá consumir o WebService TOTVS Conector para recebimento de mensagens únicas. O mesmo também será responsável por encaminhar as mensagens para o TOTVS Conector, que processará a mesma e encaminhará o retorno de acordo com o tipo de comunicação definida (síncrona ou assíncrona).

Para mais informações sobre o fluxo dos dados internos ao TBC, vide documentação:

TOTVS Business Connect: http://tdn.totvs.com.br/display/public/rm/TBC

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.

 Ao término do processamento da mensagem por parte do sistema de destino, o mesmo envia outra mensagem de retorno ao sistema de origem com status do processamento. Lembrando que as mensagens assíncronas podem ser processadas (status pendente) ou reprocessadas (status erro) manualmente através do monitor da fila de integração.

Escopo

Essa integração visa a utilização do BackOffice Protheus para fazer a contabilização e o TOTVS Educacional para os lançamentos contábeis da gestão educacional. Para tal fim, os seguintes itens fazem parte do escopo:

• • Envio de inclusão, alteração e exclusão de Centro de Custo do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de inclusão, alteração e exclusão de Plano de Contas do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de inclusão, alteração e exclusão de Período Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de inclusão, alteração e exclusão de Classe de Valor do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional. 
  • Envio de inclusão, alteração e exclusão de Item Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional. 
  • Envio de inclusão, alteração e exclusão de Moeda Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional. 
  • Envio de inclusão, alteração e exclusão de Lançamento Contábil do TOTVS Educacional para o BackOffice Protheus, módulo Contabilidade Gerencial.

Os seguintes itens NÃO fazem parte do escopo dessa integração: 

• • Envio de Moeda Contábil do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Centro de Custo do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Plano de Contas do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Período Contábil do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Classe de Valor do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Item Contábil do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Lançamento Contábil do BackOffice Protheus para o TOTVS Educacional.

objetivo de padronizar as integrações com os produtos foi definida a utilização da diretriz para os projetos de integração que todos os produtos devem trabalhar com a mensagem XML única, evitando desta forma, o processo de transformação de mensagens.

Neste cenário, temos o seguinte quadro:

Image Added 

Qualquer dos produtos são executados com o mesmo XML para uma mesma entidade, ou seja, caso um arquivo XML corresponde a mensagem de clientes, pode ser enviado para qualquer um dos produtos que suporte o recebimento desta entidade, como no diagrama abaixo:

Image Added 

A mensagem única torna uniforme a execução destes arquivos XML pelos aplicativos, principalmente para a capacidade de rastreamento.

Todos os processos devem respeitar o fluxo normal de troca de mensagens no padrão de Mensagem Única TOTVS.

Este fluxo pode ocorrer nos seguintes sentidos: 

• • TOTVS (Educacional, Processo Seletivo, Biblioteca) -> PROTHEUS: Os dados são trafegados pelo fluxo normal até a fila de integração TBC, em que este irá consumir o WebService do EAI do Protheus para envio da(s) mensagem(s). Após a resposta do Protheus, o TOTVS Conector atualiza o registro, com o status de processamento e demais dados, no monitor da fila de Mensagem Única. 

• • PROTHEUS -> TOTVS (Educacional, Processo Seletivo, Biblioteca): O Protheus consume o WebService TOTVS Conector para recebimento de mensagens únicas. Sendo também responsável por encaminhar as mensagens para o TOTVS Conector, que processa  e encaminha o retorno de acordo com o tipo de comunicação definida (síncrona ou assíncrona).

Para mais informações sobre o fluxo dos dados internos ao TBC, vide documentação: TOTVS Business Connect

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 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 na 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.

 Ao término do processamento da mensagem por parte do sistema de destino, este envia outra mensagem de retorno ao sistema de origem com status do processamento. Lembrando que as mensagens assíncronas podem ser processadas (status pendente) ou reprocessadas (status erro) manualmente por meio do monitor da fila de integração.

Escopo

Essa integração visa a utilização do BackOffice Protheus para fazer a contabilização e o TOTVS Educacional para os lançamentos contábeis da gestão educacional.

Para isto, os seguintes itens fazem parte deste processo:

• • Envio de inclusão, alteração e exclusão de Centro de Custo do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de inclusão, alteração e exclusão de Plano de Contas do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de inclusão, alteração e exclusão de Período Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional.
  • Envio de inclusão, alteração e exclusão de Classe de Valor do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional. 
  • Envio de inclusão, alteração e exclusão de Item Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional. 
  • Envio de inclusão, alteração e exclusão de Moeda Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o TOTVS Educacional. 
  • Envio de inclusão, alteração e exclusão de Lançamento Contábil do TOTVS Educacional para o BackOffice Protheus, módulo Contabilidade Gerencial.

Os seguintes itens Não fazem parte do escopo dessa integração: 

• • Envio de Moeda Contábil do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Centro de Custo do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Plano de Contas do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Período Contábil do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Classe de Valor do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Item Contábil do TOTVS Educacional para o BackOffice Protheus. 
  • Envio de Lançamento Contábil do BackOffice Protheus para o TOTVS Educacional.

Pré-requisitos instalação/implantação/utilização

Atenção: Para instalar qualquer módulo da linha RM, é necessário instalar da Biblioteca RM o pacote que contém a maioria dos arquivos necessários para o funcionamento de todos os módulos, inclusive do TBC.

(Mais detalhes acesso o documento Orientações para instalar BibliotecaRM)

Para que a integração possa funcionar, deve-se verificar se a tag DefaultDB, que informa o Alias que será utilizado para acesso a base de dados, existe no arquivo de configuração do Host (RM.Host.Service.exe.config ou RM.Host.exe.config): 

<add key=”DefaultDB” value=”<ALIAS_DO_BANCO_RM>”

em que a variável “<ALIAS_DO_BANCO_RM>” será o nome do alias cadastrado para acesso ao banco de dados.

Exemplo:

Image Added 

Para verificar se o webservice está no ar, deve-se abrir o endereço abaixo, em um navegador web:

                               Endereço: http:// localhost:8051/EAIService/

Image Added

A porta 8051 é padrão no sistema e caso seja alterada na tag HttpPort no arquivo de configuração do Host, precisa ser alterada no link acima.

Caso o serviço

Pré-requisitos instalação/implantação/utilização

Atenção: Não é escopo desse documento descrever a instalação do ERP RM e nem sua configuração.

Para instalar qualquer módulo da linha RM, o primeiro passo é realizar a instalação da Biblioteca RM, pacote que contém a maioria dos arquivos necessários para o funcionamento de todos os módulos, inclusive do TBC.

(Mais detalhes no anexo: COMO FAZER – TBC – Instalar BibliotecaRM.pdf).

Para que a integração possa funcionar corretamente, deve-se verificar se a tag “DefaultDB”, que informa o Alias que será utilizado para acesso a base de dados, existe no arquivo de configuração do Host (RM.Host.Service.exe .config ou RM.Host.exe.config): 

<add key=”DefaultDB” value=”<ALIAS_DO_BANCO_RM>”

onde a variável “<ALIAS_DO_BANCO_RM>” será o nome do alias cadastrado para acesso ao banco de dados.

Exemplo:

Image Removed 

Para verificar se o webservice está no ar, deve-se abrir o endereço, abaixo, em um navegador web:

) não esteja rodando e/ou a porta não esteja correta, a mensagem abaixo poderá ser exibida:

Image Added

Com a utilização do webservice pelo Host, o endereço que será utilizado pelo EAI do Protheus precisará conter a informação de PortName:

http:// localhost:8051/EAIService/IConWSEAIService

Image Removed

A porta "8051" é padrão no sistema e caso seja alterada na tag "HttpPort" no arquivo de configuração do Host, precisa ser alterada no link acima.

Caso o serviço do Host (RM.Host.Service.exe ou RM.Host.exe) não esteja rodando e/ou a porta não esteja correta, a mensagem abaixo poderá ser exibida:

Image Removed

Com a utilização do webservice pelo Host, o endereço que será utilizado pelo EAI do Protheus precisará conter a informação de PortName:

http:// localhost:8051/EAIService/IConWSEAIService

Uma segunda opção, como alternativa, de configuração, para utilização do EAI será o conjunto de ferramentas denominada TBC – TOTVS Business Connect, que possui esse mesmo webservice em seu instalador e necessitará de uma configuração no IIS do Windows.

Protheus

RM

Utilizar a versão 11.83.55 ou superior.

Instalação/Atualização

Atualização de sistema não necessariamente quer dizer atualização de versão de mensagem. Cada integração tem suas

versões de mensagens já definidas. Uma alteração na versão da mensagem pode impactar em toda a integração, pois é desenvolvida uma lógica para cada versão. 

Quando houver uma atualização, do TOTVS Educacional, para correções relacionadas à integração, será necessário a exclusão da integração, referente, e a sua reinstalação pelo Configurador. É importante verificar antes das exclusão as informações dos parâmetros de integração e as configurações do webservice de destino, pois seus valores, também, serão apagados.

Uma segunda opção, como alternativa de configuração para utilização do EAI é o conjunto de ferramentas denominada TBC – TOTVS Business Connect, que possui esse mesmo webservice em seu instalador e necessita de uma configuração no IIS do Windows.

Para mais informações da instalação do TBC, consulte os documentos de apoio abaixo: 

• • Para instalação do TBC através do host acesse o documento Como Expor os Web Services do RM através do Host
  • Para Instalação do TBC através do IIS acesse o documento Instalação do TBC no IIS
    
  
  
  

Protheus

• Versão minima do Protheus: 11.80.
• Possuir um licenciamento (License Server) adequado do sistema Protheus.
• Necessária a utilização da ferramenta EAI.
• Necessária configuração de um WebService.
• Módulos necessários: Contabilidade Gerencial (SIGACTB).
• Programa CTBA060 com data mínima de 24/10/2014.
• Programa CTBA180 com data mínima de 24/10/2014.
• Programa CTBI020 com  data mínima de 24/10/2014.
• Programa CTBI030 com data mínima de 24/10/2014.
• Programa CTBI040 com data mínima de 10/11/2014.
• Programa CTBI060 com data mínima de 10/11/2014.
• Programa CTBI140 com data mínima de 24/10/2014.
  
  

RM

Utilizar a versão 11.83.55 ou superior.

Instalação/Atualização

Atualização de sistema não necessariamente quer dizer atualização de versão de mensagem. Cada integração tem suas versões de mensagens já definidas. Uma alteração na versão da mensagem pode impactar em toda a integração, pois é desenvolvida uma lógica para cada versão. 

Caso exista alguma atualização do TOTVS Educacional, para correções relacionadas à integração, é necessária a exclusão da integração e a reinstalação deve ser realizada pelo Configurador. É importante verificar antes de excluir as informações dos parâmetros de integração e as configurações do webservice de destino, pois os valores são apagados também. 

Protheus

Instalação do Protheus V12 e configuração do AppServer e Dbaccess

Acesse os documentos de apoio abaixo para instalação e configuração.

• • Guia de instalação Protheus 12 e Dbaccess 
  • Configuração do AppServer e Dbaccess

Configurações do EAI

Para a configuração do EAI no Protheus, siga os procedimentos abaixo:

• • No Configurador (SIGACFG) acesse Ambiente / Cadastros / Parâmetros 
  • Configure o parâmetro MV_EAIURL2 com o endereço do serviço de EAI do ambiente em que o Protheus será integrado.

Exemplo: http://12.50.90.211:81/MensagemUnicaWS.

• • Configure o parâmetro MV_EAIWS com o nome do cliente WebService do EAI para envio a outro EAI. (WSEAISERVICE).
  • Configure o parâmetro MV_ EAIUSER com o nome de usuário.

  • Caso o servidor necessite de autenticação, configure o parâmetro MV_ EAIPASS com a senha de usuário.

  • No Configurador (SIGACFG) acesse Ambiente / Schedule / Adapter E.A.I. e realize o cadastro das rotinas de integração, conforme:

Protheus

Configurações do EAI

• Acessar SigaCFG > Ambiente >  Cadastros > Parâmetros e configurar o parâmetro MV_EAIURL2 com o endereço do serviço de EAI do ambiente ao qual o Protheus será integrado.

Exemplo: http://12.50.90.211:81/MensagemUnicaWS.

• Acessar SigaCFG > Ambiente >  Cadastros > Parâmetros e configurar o parâmetro MV_EAIWS com o nome do cliente WebService do EAI para envio a outro EAI. (WSEAISERVICE).
• Caso o servidor necessite de autenticação, acessar SigaCFG > Ambiente >  Cadastros > Parâmetros e configurar o parâmetro MV_ EAIUSER com o nome de usuário.

• Caso o servidor necessite de autenticação, acessar SigaCFG > Ambiente >  Cadastros > Parâmetros e configurar o parâmetro MV_ EAIPASS com a senha de usuário.

• Acessar SigaCFG > Ambiente > Schedule > Adapter E.A.I. e realizar o cadastro das rotinas de integração, conforme segue:

Agendamentos

FWEAI - Processamento de mensagens assíncronas

• • • Cadastrar agente.

 Clicar  Clique no símbolo destacado no canto superior direito da tela, para o cadastro automático dos agentes:

• • • Cadastrar agendamento.

Clicar Clique no símbolo destacado na parte inferior para adicionar um novo agendamento:

Preencher Preencha o campo “Rotina” Rotina com a rotina FWEAI e informar informe as empresas para as quais o agendamento será válido:

Definir Defina a data e horário para a execução do agendamento e definir a recorrência (clicando no símbolo destacado na parte superior), conforme as necessidades existentes:

Confirmar Confirme a inclusão do agendamento:

• • • Iniciar Inicie os serviços de agendamento: 

• • • Iniciar Inicie os agentes: 

Carga Inicial

Para uso Para utilização da integração em ambientes onde já ambientes em que já existam dados na base do backoffice Protheus e que sejam pertinentes ao escopo da regra da integração, será utilizada a ferramenta de carga inicial disponibilizada no framework do Protheus. A ferramenta efetua o envio dos dados cadastrados na base utilizando a própria mensagem única correspondente ao cadastro em questão.

Somente as mensagens de cadastro poderão podem ser utilizadas com o sincronizador de carga inicial. 

Segue a relação das mensagens que devem estar cadastradas para uso na utilização na carga de dados:

Todos os registros que forem sincronizados na carga inicial possuirão os devidos de/para registrados e as chaves de internalId armazenadas, conforme a configuração do ambiente de integração onde a funcionalidade será executada, ou seja, todas as filiais configuradas no de/para de empresa e filial receberão os dados sincronizados caso existam dados para as filiais em questão.

Não será possível fazer possível realizar a carga inicial do cadastro de calendário contábil, visto que o mesmo pois não possuí as características necessárias para ser compatível com essa a ferramenta. Contudo Contudo, trata-se de um cadastro simples e sem grande volume de registros, portanto o mesmo deverá ser cadastrado manualmente em ambas as ferramentas.

Para utilizar a ferramenta de Carga Inicial no Protheus, acesse : SIgaCFG | Ambiente | Schedule | o Configurador (SIGACFG) em Ambiente / Schedule / Sinc. Carga Inicial EAI.

RM

Insira aqui as informações pertinentes ao RM.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

Observação: Este modelo de suporte está sendo revisado pela TOTVS.

Transações/Entidades/Mensagens únicas

Apresente quais as transações/entidades que são trocadas e quem envia a informação para quem. Pode (e recomenda-se) ter um diagrama, uma tabela ou afins que apresente este fluxo.

Relacione quais são as mensagem únicas (TOTVSMessage) utilizadas e qual o seu relacionamento com as entidades já existentes do ERPs envolvidos.

Exemplos:

 Image Removed

Image Removed

Fluxo das Informações

Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.

Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.

Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.

Cadastros

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

<Transação/Entidade>

Identificador da Mensagem: <mensagem>

Versão: <versão>

Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>

Módulo <marca 2>: <SIGAXXX>

Tipo de Envio: <Assíncrona/Síncrona>

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita.

Processos

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

<Transação/Processo>

Tipo de Fluxo: Protheus -> RM

Mensagem: Request_1_000

Versão: 1.000

Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.

Acrescentar um diagrama do processo.

A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita. 

Limitações / Restrições Gerais

Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:

• ERP1 envia ITEM cadastrado para o ERP2

ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.

Se o tipo de valorização do estoque for FIFO.

• ERP2 envia PEDIDO cadastrado para o ERP1

O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.

Como fazer (opcional)

Descreva os passos que viabilizem a integração.

Exemplo:

Os passos para viabilizar a integração são:

• No Logix ou no Protheus efetue o cadastro das seguintes informações: Clientes, fornecedores, transportadores, cidades, cotação de moeda e unidades de medida.
• No Logix cadastrar um novo depositante e efetuar toda a parametrização necessária para a operação de WMS.
• No Logix cadastrar um novo produto que seja controlado pelo WMS, para o depositante cadastrado anteriormente.
• No Logix efetuar um processo de recebimento para o produto cadastrado anteriormente, utilizando uma nota fiscal provisória (tipo “A”).
• No Protheus consultar a nota fiscal de recebimento que foi registrada no Logix, validando as informações recebidas.
• No Logix efetuar um processamento de regularização fiscal, efetuando a cobertura dos produtos recebidos anteriormente.
• No Protheus verificar se foi efetuado corretamente o relacionamento entre os dois documentos.
• No Logix efetuar um processo de expedição para o novo produto cadastrado, até o momento do envio da mensagem de integração de pedido de venda.
• No Protheus efetuar o faturamento do pedido de venda recebido.
• No Protheus verificar se a nota fiscal gerada contém todas as informações necessárias para o segmento de operador logístico (armazém geral).
• No Protheus efetuar a escrituração fiscal das notas fiscais, verificando se as regras da legislação deste segmento foram respeitadas.
• No Logix é possível consultar o número do pedido de venda gerado para as notas fiscais de retorno simbólico e conta/ordem no programa WMS6333 (Consulta de Documentos). Para os processos de faturamento de serviço o número do pedido está disponível no programa WMS6411 (Movimentos a Faturar).

Situações comuns (opcional)

Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.

Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.

Exemplo 1:

Tratamento de erros de integração (Produto A)

Tratamento de erros de integração (Produto B)

Exemplo 2:

Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:

Exemplo:

Erro ao enviar a mensagem de Cidade via Integração

Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:

-------------------------------------------------------------------------------

WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw

ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51

-------------------------------------------------------------------------------

Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService. 

Checklist de suporte da aplicação

Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

Instalação/Configuração

Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

Checklist de Verificações:

Relacione itens de verificações para que o atendente possa:

• Identificar o funcionamento da integração;
• Identificar a ocorrências de problemas;
• Coletar evidências do mau funcionamento relatado pelo cliente;
• Realizar possíveis ajustes na integração quanto à configuração ou negócio.

(Mais detalhes sobre configuração acesso o documento Configuração EAI Protheus)

RM

Para a configuração e instalação da integração do TOTVS Educacional x SIGACTB Protheus, siga os passos abaixo:

1º Passo: 

Carregue o Assistente de Configuração do TBC (Módulo Integração / Ferramentas / Configurar); 

Neste passo, deve-se informar o usuário e senha do banco de dados com permissão para executar os scripts de configuração da integração.

2º Passo: 

([v]) Marque a integração do TOTVS Educacional x SIGACTB Protheus, por meio do processo; 

3º Passo: 

Execute o processo para realizar a instalação da integração;

4º Passo: 

Após a execução da instalação, deve-se configurar o endereço do WebService do EAI do TOTVS Protheus para a integração

TOTVS Educacional x SIGACTB Protheus, disponível em Módulo TBC (Integração) / Mensagem Única / Integrações;          

5º Passo: 

Ative a integração TOTVS Educacional x SIGACTB Protheus, disponível em Módulo TBC (Integração) / Mensagem Única / Integrações;

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 o endereço 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.

Controle de Versão

O grupo TOTVS representado por suas marcas irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos TOTVS Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e quando necessário, repassar para a equipe mais adequada em cada caso.

Observação: Este modelo de suporte está sendo revisado pela TOTVS.

Transações/Entidades/Mensagens únicas  

Tabelas De-Para

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 dos sistema que estão trocando informações.

Considerando as mensagens envolvidas nessas integração, seguem os registros De-Para que são registrados ao enviar ou receber uma mesagem, como exemplo:

Mensagem AccountAntAccount (Plano de Contas)

Mensagem CostCenter (Centro de Custo)

Mensagem AccountingEntry (Lançamento Contábil)

Mensagem AccountingCalendar (Período Contábil)

Não há registro na tabela De-Para para essa mensagem.

Mensagem AccountAntDefaultHistory (Histórico Contábil)

Essa mensagem não é utilizada para essa integração. 

Sincronizador De/Para

A integração TOTVS Educacional x Backoffice Protheus utilizando Stored Procedure foi descontinuada a partir da versão 12.1.4 e portanto, nas migrações da versão 11 para a versão 12, caso o cliente já utilize a integração via Stored Procedure, será necessário efetuar a sincronização dos dados existentes nas duas bases de dados (RM e Protheus).

Como o mecanismo da integração via stored procedure realiza a amarração dos dados de forma diferente do de/para da mensagem única, é necessário a utilização de rotina que seja efetuada a sincronização das bases, criando e alimentando o de/para com os InternalIds correspondentes a cada registro e suas respectivas empresas e filiais.

Para isso, foi criada a mensagem específica InternalIdLoad, que trafega os dados de cada registro gravado na base RM, junto com a contrapartida na base Protheus e o InternalId gravado no de/para do ambiente RM. Uma vez recebidos esses dados, é verificado se o registro enviado pelo RM existe de fato na base Protheus e caso exista, o InternalId recebido é gravado no de/para Protheus como ExternalId.
Desta maneira o registro do Protheus é gerado e enviado para o RM registrar no de/para. Neste processo a base histórica gerada por meio das stored procedures são portadas para o padrão utilizada na mensagem única.

As seguintes entidades da integração com o contábil estão incluídas no processo de Sincronizador De/Para:

• • COSTCENTER - Centro de Custo
  • CURRENCY – Moeda
  • CLASSVALUE - Classe de Valor
  • ACCOUNTINGITEM – Item Contábil

A mensagem InternalIdLoad está atualmente na versão 1.000, e sua estrutura está definida da seguinte forma:

O padrão de chave a ser trafegado na tag IntegrationId varia de acordo com a entidade a ser sincronizada. Abaixo a relação de formatos de chaves esperadas no recebimento no Protheus, conforme cada entidade:

Fluxo das Informações

Mensagens Únicas relacionadas a esta integração:

Cadastros

Cadastros Especiais

É necessário cadastrar manualmente no Protheus e no RM e posteriormente configurar o de/para de integração correspondente (RM e Protheus possuem interfaces específicas para este fim).

Integrações / Aba Integração / Mensagem Única / De-Para

Empresa e Filial

O primeiro cadastro que deve ser realizado para operação dos sistemas é o de Empresa (Coligada) e as Filiais. No RM estas entidades são cadastros comuns, mas no Protheus a Empresa e as Filias são definidas em arquivos de configuração de ambientes sendo parte da implantação do Protheus padrão. 

A maioria das mensagens de integração fará referências ao cadastro de Empresa/Coligada.

Exemplo:

Cadastros comuns

Plano de Contas 

Identificador da Mensagem: AccountAntAccount

Versão: 2.000

Módulo Gestão Contábil: RM

Módulo Protheus: Protheus

Tipo de Envio:

Caminho para acesso ao cadastro do Plano de contas, no sistema:               

Acesse: BackOffice / Contabilidade Gerencial / Cadastros / Contábil

Caminho para acesso ao parâmetro para não utilizar máscara:                                              

Acesse: BackOffice / Contabilidade Gerencial / Ambiente / Parâmetros 

01.01 – Plano de Contas / 01.01.01 – Plano de Contas contábil / Plano de Contas Contábil / Não utilizar máscara nas contas

No cenário em que o Protheus possua um compartilhamento por Empresa e por Filial para o Plano de Contas, o TOTVS Contabilidade Gerencial deve ser parametrizado para utilizar contas globais por padrão:                              

Caminho para acesso ao parâmetro para utilizar conta global: 

Acesse: BackOffice / Contabilidade Gerencial / Ambiente / Parâmetros  

01.01 – Plano de Contas / 01.01.01 – Plano de Contas contábil / Plano Contas / Acessa conta globais                                                             

01.01 – Plano de Contas / 01.01.01 – Plano de Contas contábil / Plano Contas / Cadastrar como global por padrão

(Mais detalhes do cadastro de Plano de Conta acesse Principais Cadastros da Integração)

Centro de custo

Identificador da Mensagem: CostCenter

Versão: 2.000

Módulo Gestão Financeira: RM

Módulo Protheus: Protheus

Tipo de Envio:

Informações importantes sobre a mensagem de Centro de Custo:

O código do centro de custo no TOTVS Gestão Financeira pode ser criado de forma sequencial ou por meio de máscara. Essa definição pode ser por meio do parâmetro EDUCTBCCUSTOAUTOINC criado nos parâmetros de integração.

Caso o parâmetro esteja com valor True (marcado)  o código enviado é ignorado e um código de auto incremento é gerado. Se o parâmetro estiver com valor False (desmarcado) é utilizado o código enviado pelo sistema de origem de acordo com a máscara utilizada.

Acesse: Módulo Integração / Integração / Mensagem Única / Integrações / Anexo Parâmetros de Integração

A máscara de centro de custo deve ser removida para que o sistema financeiro TOTVS Gestão Financeira aceite os código enviado pelo Protheus, na integração.

No sistema, o parâmetro pode ser acessado pelo caminho:

               Acesse: MóduloBackOffice / Gestão Financeira / Ambiente / Parâmetros / TOTVS Gestão Financeira

02.02 – Contas a receber / 02.02.01 – Manutenção de Lançamentos / 02.02.01.01 – Lançamento / Centro de Custo / Máscara do Centro de Custo

Caminho para acesso ao cadastro do Centro de Custo, no sistema:

Acesse: BackOffice / Gestão Financeira / Cadastros / Centro de Custo

(Mais detalhes do cadastro de Centro de Custo acesse Principais Cadastros da Integração)

Histórico Padrão

Identificador da Mensagem: AccountAntDefaultHistory

Versão: 1.000

Módulo Educacional: RM

Módulo Protheus: Protheus

Tipo de Envio:

Período Contábil

Identificador da Mensagem: AccountingCalendar

Versão: 1.000

Módulo Educacional: RM

Módulo Protheus: Protheus

Tipo de Envio:

No processo de integração, o RM atualiza as datas do período contábil sempre de acordo com a menor data inicial e a maior data final enviada pelo Protheus. No Protheus, essas informações são armazenadas em um cadastro e no RM essas informações são armazenadas nos parâmetros, sendo assim, apenas há espaço para armazenar somente uma dataIncial e uma dataFinal.

                Caminhos para a parametrização do período contábil:

Acesse: BackOffice / Contabilidade Gerencial / Ambiente / Parâmetros / TOTVS Contabilidade Gerencial 

01.04 – Fechamento / 01.04.01 – Fechamento Mensal

(Mais detalhes do cadastro de Período Contábil acesse Principais Cadastros da Integração)

Lançamentos Contábeis

Identificador da Mensagem: AccountingEntry

Versão: 2.000

Módulo Gestão de Estoque, Compras e Faturamento: RM

Módulo Protheus: Protheus

Tipo de Envio:

Informações importantes sobre a geração de lançamentos contábeis:

A informação do Código do Lote [BatchNumber] será utilizada como identificador do lote contábil enviado para o Protheus.

Durante a geração de contabilização por competência do Educacional (Aba Financeiro / Contabilidade / Processo de Contabilidade), é enviado uma mensagem com todos os lançamentos contábeis processados para o Protheus.

Caso seja executado o processo de estorno (Aba Financeiro / Contabilidade / Processo de Contabilidade), deverá ser enviada uma mensagem com os lançamentos de estorno como se estissem incorporados ao lote 0, que neste caso nunca serão excluídos.

Caminhos para acesso a geração da contabilização:

Educacional / Educacional / Financeiro / Contábil / Contabilidade 

Educacional / Educacional / Financeiro / Contábil / Contratos            

Processos / Gerar contabilização

Importante:

As informações de Item Contábil e Classe de Valor são obtidas por meio da Matriz Aplicada do Educacional. Caso seja necessário enviar na mensagem de lançamentos contábeis será necessário a configuração do Evento Contábil para buscá-las.

É exibida a aba Integração Protheus, no cadastro de Evento Contábil, quando a integração estiver ativa. Após a configuração de busca para Matriz Aplicada, na aba Integração Protheus, ao enviar a mensagem de lançamentos contábeis e as informações de Item Contábil e Classe de Valor vinculadas, estas são enviadas para a integração.

A mesma configuração pode ser realizada no Módulo de Gestão de Estoque, Compras e Faturamento para envio dessas informações na contabilização do movimento.

A aba Integração Protheus é exibida para todos os eventos do tipo: Contrato Educacional, Parcela Educacional e Movimento.

Situações comuns (opcional)

Algumas situações de erro e/ou validações podem ocorrer durante o processamento de mensagens da integração. Nas duas situações, as mensagens que foram processadas podem ser verificadas no módulo Integração, menu Integração / Mensagem Única / Fila de mensagens únicas.

Ao abrir o cadastro de Fila de mensagem, podemos perceber a fila de mensagem processada e no anexo Informação de execução de mensagem, contém as informações do processamento da mensagem.

Caso ocorra algum erro ou validação durante uma integração que utilize uma mensagem síncrona, o texto do erro, ou validação, aparecerá também no momento da operação.

As integrações que utilizam mensagens assíncronas podem processar ou agendar o processamento na tela de Fila de mensagens, no menu Processos / Execução manual de mensagens únicas.

Casos de erros em que a mensagem informada refere-se ao WebService do EAI, conforme mostra a figura abaixo:

Image Added

Para resolver é necessário verificar as configurações do sistema de destino, analisar o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService. 

Checklist de suporte da aplicação