Histórico da Página
Integração Backoffice Saldos Contábeis x Datasul/Contabilidade
Contexto de negócio
O objetivo dessa funcionalidade é automatizar a integração de saldos contábeis entre empresas com participações societárias, que não tenham seus ERPs no mesmo banco de dados. Sendo assim a empresa consolidadora poderá solicitar os saldos contábeis de determinado período, a uma ou mais de suas empresas controladas.
Atualmente, para empresas que estão no mesmo banco de dados do ERP Totvs 11, a consolidação é feita automaticamente. Mas para empresas que estão em bases diferentes ou que utilizam o Protheus, essa consolidação requer etapas de importação e exportação de saldos contábeis, as quais não são efetuadas de forma automática.
Essa integração visa atender clientes que desejam que estas informações sejam buscadas automaticamente e importadas para dentro do ERP de sua empresa matriz, a fim de executar a consolidação. Atualmente, para cada base externa, seja ela Datasul, Protheus ou até outro fornecedor, deve ser gerado um arquivo texto com as informações necessárias para carga no ERP Datasul.
Sistemas Envolvidos
Esta integração contempla o ERP TOTVS Datasul, por meio da qual o mesmo conseguirá obter dados para que seja efetuada a consolidação de saldos contábeis, em uma empresa matriz (controladora).
Essas informações serão provenientes de outros ERP´s que não estejam na mesma base de dados da empresa controladora, podendo os mesmos ser da linha Datasul, Protheus, ou de outros fornecedores de software.
Integração
Essa integração foi criada para facilitar o trabalho necessário para que ocorra a consolidação de saldos contábeis, em um cenário onde a empresa consolidadora (Matriz) utilize o ERP TOTVS Datasul, e o ERP da(s) empresa(s) consolidada(s) esteja(m) em outra base de dados, podendo ser Datasul, Protheus ou até de outro fornecedor.
Dessa forma a matriz irá solicitar, via mensagem XML, os saldos contábeis das filiais que estão em bases remotas. A filial recebe a solicitação, grava os saldos em um arquivo texto e disponibiliza o mesmo em um servidor de FTP.
Após disponibilizar o arquivo texto com os saldos, a filial envia uma mensagem XML avisando a matriz que o arquivo está disponível. Na matriz é então disparado um processo que faz o download do arquivo que está no servidor de FTP, efetuando em seguida a importação do mesmo para o ERP Datasul.
Escopo
O escopo dessa integração é disponibilizar os saldos contábeis de empresas controladas (filiais) no ERP TOTVS Datasul da empresa controladora (matriz), a fim de possibilitar a consolidação dos mesmos no módulo de contabilidade do Datasul EMS.
O processo de integração inicia com a requisição dos saldos contábeis de determinada empresa. Nessa requisição será indicada a data dos saldos desejados, indicando também um servidor de FTP, onde deverá ser disponibilizado o arquivo gerado. A requisição de saldos normalmente será efetuada pela área de controladoria da empresa, responsável pelas consolidações dos dados contábeis das empresas que compõem o grupo empresarial.
A requisição dos saldos será enviada em forma de mensagem XML, via EAI2, para todas as filiais cadastradas como rota dessa transação.
Cabe a cada filial, ao receber a mensagem XML, identificar se a empresa para a qual os saldos foram solicitados está na base de dados do ERP utilizado pela mesma. Se a empresa não estiver na base, a mensagem de solicitação deverá ser ignorada, sem que seja enviada nenhuma mensagem de retorno. Caso contrário, a filial deverá proceder a exportação de saldos de acordo com os parâmetros recebidos, gravando os mesmo em um arquivo texto, o qual deverá ser disponibilizado, via upload, no servidor de FTP indicado na mensagem XML recebida.
Após a geração e disponibilização do arquivo texto, a filial deverá enviar uma mensagem de retorno, indicando o caminho e o nome no arquivo gerado.
Ao receber a mensagem de confirmação da geração do arquivo texto de saldo, será executado um processo na matriz solicitante, que irá efetuar o download do arquivo disponibilizado no servidor de FTP, e na sequência tentará importar as informações do arquivo para o ERP TOTVS Datasul.
O processo de importação deverá gerar um lote contábil dentro do módulo de contabilidade. O valor dos movimentos no lote gerado será a diferença entre o saldo atual da conta, no ERP da empresa consolidadora (matriz) e o saldo recebido no arquivo gerado pela empresa consolidada (filial). Caso necessário, esse lote poderá ser eliminado na matriz, após a importação do arquivo.
A integração dos saldos é apenas uma das etapas do processo de consolidação, as demais etapas devem ser efetuadas posteriormente pela área de controladoria, dentro dos módulos de contabilidade fiscal e contabilidade gerencial do ERP TOTVS Datasul-EMS.
Pré-requisitos instalação/implantação/utilização
EAI2 instalado e configurado.
Datasul TOTVS 11, versão 11.5.10 ou superior, instalado e configurado.
Datasul
Para a extração dos saldos, serão necessárias algumas informações adicionais, como: Faixa de contas contábeis, faixa de centro de custos, entre outras. Essas informações serão então obtidas de um cadastro de Demonstrativo Contábil pré-determinado pela empresa filial que irá exportar os saldos.
O código desse demonstrativo, utilizado para exportação, deverá estar parametrizado no cadastro de Parâmetros Gerais da Contabilidade, onde será incluído um novo campo para essa finalidade.
Quando a empresa filial que estiver exportando os saldos, estiver utilizando o ERP Protheus, o filtro das informações exportadas será efetuado a partir de uma Visão Gerencial, configurada no Protheus para esse fim. O código dessa visão gerencial deverá ser informado no cadastro de Parâmetros de Integração de Saldos Consolidados, no ERP Datasul-EMS, pois o mesmo será enviado no arquivo XML de solicitação de saldos.
Para maior eficácia dessa funcionalidade, algumas boas práticas são recomendadas em relação às parametrizações de Matriz de Tradução, Cenários e Períodos contábeis, no ERP TOTVS Datasul-EMS dos clientes:
Cenários Contábeis > Nas empresas implantadas na planta matriz, que representam as filiais que estão em outras plantas, cadastrar somente o cenário para o qual desejar controlar os saldos, pois no processo de importação serão criados saldos para todo o cenário que a empresa controla.
Períodos Contábeis > Nas empresas implantadas na planta matriz, que representam a filial que estão em outras plantas, definir a configuração de períodos contábeis idêntica à da empresa correspondente que está cadastrada na planta da filial.
Matriz de Tradução > Quando as contas contábeis cadastradas na empresa implantada na planta matriz, forem idênticas às contas implantadas na respectiva empresa na planta da filial, não deverá ser informada matriz de tradução de contas. Nesse caso a tradução será efetuada por composição, evitando a necessidade de se cadastrar um de-para de contas.
No arquivo XML de parâmetros de solicitação de saldos, será enviado o código da empresa cadastrada no ERP Datasul-EMS da empresa que está efetuando a solicitação. O De-Para do código da empresa, para processamento no ERP das empresas que estiverem recebendo a solicitação, será efetuado pelo EAI2, o qual já possui essa funcionalidade tanto no Protheus quanto no Datasul.
Para efetuar o UPLOAD e o DOWNLOAD do arquivo TXT de saldos gerado, serão utilizados os utilitários wput e wget, que são ferramentas freeware para transferência de arquivos, sendo que as mesmas possuem versões para SO Windows e Unix (http://sourceforge.net/).
Logix
Não existem informações pertinentes ao Logix.
Protheus
O ambiente Contabilidade Gerencial possui a funcionalidade “Visão Gerencial” onde o usuário pode montar um plano de contas gerencial, especificar a composição dessas contas e utilizar esse plano nos relatórios gerenciais do ambiente.
Quando no arquivo XML dos parâmetros de exportação, for recebido um código de Visão Gerencial na TAG ‘SetOfBooks’, a mesma será utilizada para realizar o filtro das informações a serem exportadas.
Portanto, para integração de saldos com o ERP Datasul-EMS, é necessário a configuração dessa Visão Gerencial, de acordo com as informações que a área de controladoria da empresa, julgar necessário que sejam enviadas à sua matriz.
O código da visão configurada para a exportação de saldos deverá ser informado no cadastro de Parâmetros de Integração de Saldos Consolidados, no ERP TOTVS Datasul-EMS da empresa consolidadora (matriz).
RM
Não existem informações pertinentes ao RM.
Instalação/Atualização
Configuração necessária:
O EAI2 permite que o Datasul 11 se comunique com outros sistemas, recebendo ou enviando mensagens, por intermédio de WebService. No caso de recebimento de uma mensagem, é necessário que seja feita autenticação no servidor WebService EAI 2 do Datasul 11. Este documento esclarece itens importantes para o acesso ao WebService EAI 2.
Para acessar o WSDL do EAI 2 do Datasul 11, deve-se utilizar a seguinte URL: http://<servidor-datasul-11>:<porta-datasul-11>/eai2-ws/EAIService?wsdl
Segurança:
Para realizar integração com o Datasul 11, é necessário autenticar no EAI 2 (autenticação HTTP Basic). Para configurar um usuário que permita integração, é necessário alterar os seguintes arquivos:
[diretório-arquivos-datasul11]/jboss/server/[alias-produto]/conf/props/jbossws-users.properties
[diretório-arquivos-datasul11]/jboss/server/[alias-produto]/conf/props/jbossws-roles.properties
Arquivo de Usuários WebService:
O arquivo jbossws-users.properties armazena os nomes de usuários e suas respectivas senhas (usuário=senha).
Exemplo:
eai=eai@123
sistemaX=sysXPTO
Os usuários listados aqui, não necessariamente têm permissão para realizar integração com o Datasul 11, apenas cadastra usuário e senha. A permissão será concedida no Arquivo de Permissões WebService.
Arquivo de Permissões WebService:
Para que seja possível realizar integração com o Datasul 11, os usuários cadastrados no Arquivo de Usuários WebService devem estar cadastrados no arquivo de permissões WebService (jbossws-roles.properties) com a propriedade eai2allowed (usuário=eai2allowed).
Exemplo:
eai=eai2allowed
sistemaX=eai2allowed
Configuração do WebService EAI2
Abaixo segue um exemplo de onde as informações mencionadas acima devem estar cadastradas:
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
Processo | Direção | XSD |
---|---|---|
Solicitação de Saldos | Datasul > Protheus / Datasul / Outros | ExportOfAccountMovements_1_001.xsd |
Exportação de Saldos | Protheus / Datasul / Outros > Datasul | ExportOfAccountMovements_1_001.xsd |
Fluxo das Informações
O propósito deste desenvolvimento é utilizar o framework EAI2 para enviar uma solicitação de Saldos Contábeis, e receber a confirmação de que esses saldos foram gerados e disponibilizados em um servidor de FTP, no formato de arquivo texto, utilizando mensagens XML.
Para isso, foi necessário o desenvolvimento de Adapters SENDER e RECEIVER para as Mensagens. A função deste programa será montar e enviar as mensagens XML, extrair as informações contidas na Base de Dados conforme filtros estabelecidos e efetivar a transação das mensagens com os WebServices destinos.
As mensagens enviadas e recebidas, deverão estar nos padrões definidos no schema ExportOfAccountMovements_1_001.xsd. Para essas mensagens deverão ser atualizadas as seguintes TAGs:
Parâmetros de Solicitação
TAG SUPERIOR | TAG | Obrigatório | Informação Enviada |
---|---|---|---|
MessageInformationType | CompanyId | Sim | Empresa |
BusinessContentType | FTPAdress | Sim | Endereço FTP |
BusinessContentType | FTPUser | Sim | Usuário FTP |
BusinessContentType | FTPPassWord | Sim | Senha Usuário FTP |
BusinessContentType | FileName | Sim | Nome do Arquivo TXT |
BusinessContentType | InitialDate | Sim | Data Inicial Exportação |
BusinessContentType | FinalDate | Sim | Data Final Exportação |
BusinessContentType | ExpoType | Sim | Tipo de Exportação |
BusinessContentType | SldType | Sim | Tipo de Saldo |
BusinessContentType | SetOfBooks | Sim | Visão Gerencial do Protheus |
O layout do arquivo texto gerado, irá variar de acordo com o ERP que estiver exportando os saldos. Quando a exportação for efetuada pelo ERP TOTVS Datasul-EMS, as informações devem ser geradas no seguinte layout:
Sequência | Descrição | Posição Inicial | Tamanho | Formato |
---|---|---|---|---|
01 | Empresa | 01 | 03 | X(03) |
02 | Estabelecimento | 04 | 05 | X(05) |
03 | Data Lançamento | 09 | 10 | 99/99/9999 |
04 | Conta Contábil | 19 | 20 | X(20) |
05 | Centro de Custo | 39 | 20 | X(20) |
07 | Moeda Lancto | 59 | 08 | X(08) |
08 | Valor Lançamento | 67 | 17 | >>>>>,>>>,>>9.99 |
09 | Natureza (DB/CR) | 84 | 02 | X(02) |
Quando a exportação for efetuada a partir do ERP TOTVS Protheus, ou ainda de um ERP de outro fornecedor, as informações devem ser geradas no seguinte layout:
Sequência | Descrição | Posição Inicial | Tamanho | Formato |
---|---|---|---|---|
01 | Empresa | 001 | 02 | |
02 | Filial | 003 | 12 | |
03 | Data Lançamento | 015 | 10 | 99/99/9999 |
04 | Número Lote | 025 | 06 | |
05 | Sub Lote | 031 | 03 | |
06 | Numero Doc | 034 | 06 | |
07 | Moeda Lancto | 040 | 02 | |
08 | Tipo Lcto (DB/CR) | 042 | 02 | |
09 | Tipo de Saldo | 044 | 01 | |
10 | Conta Contábil | 045 | 70 | |
11 | Centro de Custo | 115 | 20 | |
12 | Item Contábil | 135 | 20 | |
13 | Classe de Valor | 155 | 20 | |
14 | Valor Lançamento | 175 | 17 | 99999999999999,99 |
15 | Entidade Contábil 05 | 192 | 20 | |
16 | Entidade Contábil 06 | 212 | 20 | |
17 | Entidade Contábil 07 | 232 | 20 | |
18 | Entidade Contábil 08 | 252 | 20 | |
19 | Entidade Contábil 09 | 272 | 20 | |
20 | Histórico | 292 | 250 |
Cadastros
Integração de Saldos Consolidados
Identificador da Mensagem: ExportOfAccountMovements
Versão: 1.001
Módulo Datasul: FGL – Contabilidade Fiscal
Módulo Protheus: SIGACTB – Contabilidade Gerencial
Tipo de Envio: Assíncrona
Mensagem Padrão | DATASUL | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | empresa | cod_empresa | ct2 | filial |
FTPAdress | int_sdo_consolid_param | des_ender_ftp | --- | --- |
FTPUser | int_sdo_consolid_param | cod_usuar_ftp | --- | --- |
FTPPassWord | int_sdo_consolid_param | cod_senha_usuar_ftp | --- | --- |
FileName | --- | --- | --- | --- |
InitialDate | period_ctbl | dat_inic_period_ctbl | ct2 | data |
FinalDate | period_ctbl | dat_ifim_period_ctbl | ct2 | data |
ExpoType | --- | --- | --- | --- |
SldType | --- | --- | ct2 | tpsald |
SetOfBooks | int_sdo_consolid_param | cod_visao_gerenc_ext | cts | codpla |
File | --- | --- | --- | --- |
Arquivo texto ERP TOTVS Datasul-EMS:
Linha Arquivo Texto | DATASUL | |
Tabela | Campo | |
Empresa | empresa | cod_empresa |
Estabelecimento | estabelecimento | cod_estab |
Data Lançamento | lancto_ctbl | dat_lancto_ctb |
Conta Contábil | Item_lancto_ctbl | cod_cta_ctbl |
Centro de Custo | Item_lancto_ctbl | cod_ccusto |
Moeda Lancto | Item_lancto_ctbl | cod_indic_econ |
Vlr Lançamento | Item_lancto_ctbl | val_lancto_ctbl |
Natureza | Item_lancto_ctbl | ind_natur_lancto_ctbl |
Arquivo texto ERP TOTVS Protheus ou ERP de outro Fornecedor:
Mensagem Padrão | DATASUL | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
Empresa | empresa | cod_empresa | Grupo de empresa corrente | Variável: cEmpAnt |
Filial | estabelecimento | cod_estab | CT2 | FILIAL |
Data Lançamento | lancto_ctbl | dat_lancto_ctbl | CT2 | DATA |
Número Lote | lancto_ctbl | num_lote_ctbl | CT2 | LOTE |
Sub Lote | --- | --- | CT2 | SUBLOTE |
Número Doc | --- | --- | CT2 | DOC |
Moeda Lancto | Item_lancto_ctbl | cod_indic_econ | CT2 | MOEDLC |
Tipo Lcto | Item_lancto_ctbl | ind_natur_lancto_ctbl | CT2 | DC |
Tipo de Saldo | lancto_ctbl | cod_cenar_ctbl | CT2 | TPSALD |
Conta Contábil | Item_lancto_ctbl | cod_cta_ctbl | CT2 | DEBITO ou CREDITO |
Centro de Custo | Item_lancto_ctbl | cod_ccusto | CT2 | CCD ou CCC |
Item Contábil | --- | --- | CT2 | ITEMD ou ITMC |
Classe de Valor | --- | --- | CT2 | CLVDB ou CLVCR |
Valor Lancto | Item_lancto_ctbl | val_lancto_ctbl | CT2 | VALOR |
Entidade Ctbl 05 | --- | --- | CT2 | EC05DB ou EC05CR |
Entidade Ctbl 06 | --- | --- | CT2 | EC06DB ou EC06CR |
Entidade Ctbl 07 | --- | --- | CT2 | EC07DB ou EC07CR |
Entidade Ctbl 08 | --- | --- | CT2 | EC08DB ou EC08CR |
Entidade Ctbl 00 | --- | --- | CT2 | EC09DB ou EC09CR |
Histórico | Item_lancto_ctbl | des_histor_lancto_ctbl | CT2 | HISTOR |
Processos
As mensagens serão geradas e validadas pelo mapa “XDS”. O EAI2 é responsável pelo envio e retorno das informações.
Limitações / Restrições Gerais
- O ERP TOTVS Datasul-EMS deverá estar na versão 11.5.10 ou superior;
- As mensagens (XML) devem respeitar o modelo de integração entre produtos da marca TOTVS “mensagem única”;
- Os nomes das TAGS devem ser em inglês;
- As mensagens devem ser submetidas para aprovação do comitê de integração por intermédio das reuniões de consenso, deve ser entregue o XSD e exemplo XML da mensagem;
- As mensagens devem respeitar o envelope definido pelo comitê de integração;
- Na definição da mensagem, o sistema que tiver a maior restrição (Tipo, tamanho de campo, entre outros) terá que se adaptar ao outro sistema, exemplos:
- O sistema A possui um campo do tipo Alfanumérico e no sistema B este campo é do tipo numérico, neste caso, o sistema B tem que se adaptar ao sistema A.
- O sistema A possui um campo do tipo Caractere com tamanho 40 e no sistema B este campo é do tipo Caractere com tamanho 30, neste caso, o sistema A tem que se adaptar ao sistema B. - As transações definidas para esta Integração serão do tipo “Assíncrona”.
Como fazer
No ERP da Datasul, efetue os cadastros das seguintes informações:
- Parâmetros de Integração de Saldos Consolidados
Código da Empresa: Código da empresa destino dentro do ERP Origem.
Endereço FTP: Endereço do servidor de FTP onde será gravado o arquivo TXT gerado.
Usuário FTP: Usuário que terá permissão de acessar o servidor de FTP destino.
Senha FTP: Senha do usuário que terá permissão de acessar o servidor de FTP destino.
Diretório Download: Diretório onde o arquivo TXT será gravado, quando for realizado o download do servidor de FTP.
Visão Gerencial Externa: Código da Visão Gerencial utilizada pelo Protheus para exportação de saldos.
Exportação ERP Datasul: Indica se a empresa que irá gerar os saldos contábeis utiliza ou não o ERP Datasul. - Parâmetros Gerais da Contabilidade
Demonstrativo Contábil: Deve ser parametrizado na empresa destino, quando a mesma utiliza o ERP Datasul. Esse código indica o Demonstrativo Contábil que será utilizado na seleção de registros para a exportação de saldos.
Efetuar a solicitação de Saldos no ERP Datasul, informando a Empresa destino, o Exercício/Período dos saldos e a Matriz de Tradução que será utilizada para a importação das informações recebidas no retorno.