Histórico da Página
INTEGRAÇÃO PROTHEUS SIGATMS X DATASUL - CONTAS A RECEBER
Introdução
Cada vez mais as empresas necessitam gerenciar e otimizar sua logística e conforme legislação, necessitam do papel de uma Transportadora. Por isto, há uma busca por softwares de Gestão de Transportes que controlem os processos e operações de uma Transportadora. O módulo SIGATMS da linha Microsiga Protheus é a solução TOTVS para este cenário de mercado. Em relação aos clientes desta linha, o módulo já possui integração nativa com os módulos de BackOffice como, Faturamento (SIGAFAT), Fiscal (SIGAFIS), Financeiro (SIGAFIN) e Contábil (SIGACTB). Já em relação aos clientes da linha Datasul, o módulo SIGATMS não possuía integração.
Sistemas Envolvidos
Linha Microsiga Protheus
- SIGATMS (Transportation Management System): Sistema de gerenciamento de transportes que tem como objetivo principal controlar todos os processos fiscais e gerenciais envolvidos na operação de transportes, bem como, controlar os veículos, motoristas, fretes e viagens da empresa e de terceiros. Entre as atividades mais importantes, destacam-se controle das despesas dos veículos, viagens, fretes, emissão de CTRC (Conhecimento de Transporte Rodoviário de Cargas), nota fiscal de serviço, manifesto entre outros. O SIGATMS controla todos os processos de um transportador, abrangendo as áreas: Operacional, Comercial, Seguros, Faturamento, Logística e SAC. Solução totalmente integrada com a área administrativa (Financeiro, Fiscal e Contábil).
Linha Datasul (BackOffice)
- Financeiro:
- Contas a Receber (ACR): O Módulo de Contas a Receber visa auxiliar o gerenciamento administrativo, controlando movimentações de títulos e outros. Maiores detalhes, consultar: ACR - Contas a Receber
Integração
O módulo SIGATMS da linha Microsiga Protheus, possui integração nativa com os módulos de BackOffice de mesma linha como, Faturamento (SIGAFAT), Fiscal (SIGAFIS), Financeiro (SIGAFIN) e Contábil (SIGACTB).
Existem clientes da linha Datasul que demandam a necessidade de utilização de um módulo de Gestão de Transportes como o SIGATMS, porém mantendo os módulos de BackOffice da linha Datasul.
Para que seja possível atender esta demanda e possibilitar uma nova oferta de mercado TOTVS, por meio desta integração será possível a utilização do módulo SIGATMS da linha Microsiga Protheus, integrado aos módulos de BackOffice da linha Datasul (Faturamento, Fiscal, Financeiro e Contábil).
Este documento especificamente apresenta os detalhes da integração do SIGATMS com o módulo Datasul: Contas a Receber.
- Premissas
- Integrar o módulo SIGATMS da linha Protheus com o módulo Financeiro do BackOffice Datasul: Contas a Receber;
- Arquitetura (Tecnologia)
- Integração por intermédio do EAI - Enterprise Application Integration com o padrão de Mensagem Única;
Escopo
Pré-requisitos instalação/implantação/utilização
Datasul
Versão mínima | 12.1.18 |
---|---|
Módulo implantado | ACR - Contas a Receber |
Ferramentas necessárias | Configuração do WebService EAI2 |
Protheus
Versão mínima | 12.1.18 |
---|---|
Módulo implantado | SIGATMS - Gestão de Transportes |
Funcionalidades implantadas | Conhecimento de Transporte Eletrônico (Ct-e) |
Ferramentas necessárias | ¹ Servidor WebServices Protheus iniciado |
Schedule Protheus configurado |
Aviso |
---|
¹ Ajuste o timeout do servidor HTTP na qual o WebService Protheus estará para acima de 15 minutos (900 segundos).
|
Instalação/Atualização
Datasul
Configurações Iniciais
Realizar as configurações descritas para o o Datasul no documento: DI_SIGATMS_x_Datasul_Cadastros_restore
Configurações EAI
Toda a configuração do EAI Datasul será feita através do TOTVS Monitor, que é acessado através do caminho: http://<HOST-DATASUL>:<PORTA>/totvs-monitor
- Realizar o cadastro do Aplicativo Externo que irá representar Configurar no EAI do Datasul as mensagens de Transação do Contas a Receber que serão trocas com o Protheus:
A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação
ExternaInterna / Transações Disponíveis;
- Deve ser incluída uma Aplicação Externa através do Botão "Adicionar Aplicação Externa";
- Deverá ser informado o caminho WSDL de instação do Protheus, bem com a Porta de Acesso e o Usuário/Senha.
As mensagens deverão ser configuradas conforme tabela abaixo:
Transação Versão Modo Habilitado TransportInvoice 2.000 Recebimento TransportInvoiceStatus 2.000 Envio
Configurar as Rotas de Envio para as Transações que serão enviadas ao Protheus.Configurar no EAI do Datasul as mensagens de Cadastro que serão trocas com o Protheus:
A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Interna / Transações DisponíveisRotas de Envio;
As mensagens deverão ser configuradas conforme tabela abaixo:
TransaçãoVersãoModo HabilitadoCustomerShippingAddress 1.001 Ambos CustomerVendor 1.000 Ambos CustomerVendorReserveID 1.000 Recebimento ElectronicTransportDocument 1.000 Recebimento Item 3.006 Recebimento
Configurar as Rotas de Envio para as Transações que serão enviadas ao Protheus.
A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Interna / Rotas de Envio;
- Importante: para que seja possível realizar este procedimento, é necessário que previamente as transações estejam atualizadas do lado do Protheus, conforme descrito neste manual;
Deverá ser selecionado no combo-box "Aplicação Externa" a aplicação que representa o Protheus;
Para cada uma das transações "CustomerShippingAddress" e "CustomerVendor", deve ser selecionada e marcada a opção "Habilitado".
- Configurar o De-Para de Empresa e Estabelecimento entre a Aplicação Externa (Protheus) e o Datasul.
- A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Externa;
- Selecionar a Aplicação Externa que representa o Protheus;
- Clicar no botão "De-Para";
- Para Empresa:
- Selecionar a estrutura "CompanyInternalId - fnd_empres";
- Informar os campo "Valor Externo" com o Código da Empresa do Protheus e o "cod_empresa" com o Código da Empresa correspondente no Datasul;
- Repetir este Processo para todas a Empresas.
- Para Estabelecimento:
- Selecionar a estrutura "BranchInternalId - estabelec";
- Informar os campo "Valor Externo" com o Código do Estabelecimento (ou Filial) do Protheus e o "cod-estabel" com o Código do Estabelecimento correspondente no Datasul;
- Repetir este Processo para todos os Estabelecimento.
Configurações Gerais
- No Menu do Datasul®, através do programa "Parâmetros Funções do Produto" (HUB), deverão ser habilitadas as seguintes funções:
- TMS Transportador - Para empresas que irão utilizar o TMS Protheus integrado com o BackOffice Datasul;
- WMS Operador Logistico - Para empresas que irão utilizar o WMS Logix integrado com o BackOffice Datasul; Grupos utilizados para Replicação
- Codigo Unico Cliente Fornecedor Transportador - Para empresas que optarem por realizar o controle de Código Único de Cliente/Fornecedor/Transportador nas integrações TMS Protheus/WMS Logix x BackOffice Datasul.
- No Menu do Datasul, através do programa "Módulos Produto Datasul", deverá ser incluído um novo módulo conforme abaixo (caso ele não exista):
- Módulo: TMS
- Descrição: TMS Transportador
- Sistema: CAD
- No Menu do Datasul, através do programa "Matriz Tradução Finalidade Externa", deverá ser criada uma nova matriz conforme abaixo:
- Código Matriz Trad Finalid: Qualquer código, de preferência "TMS";
- Finalid Econ Externa: "1" (este código corresponde a moeda Corrente no TMS Protheus);
- Tipo Cotação: Valor
- Finalidade: "Corrente"
- No Menu do Datasul, através do programa "Matriz Tradução Organização Externa", realizar o seguinte procedimento:
- Selecionar a Matriz chamada "EMS2" e realizar uma cópia dela através do botão "Duplicar Matriz UO";
- No campo "Matriz UO Destino" informar um código qualquer, de preferência "TMS";
- Na nova Matriz criada, alterar os De-Para já existentes, modificando o campo "Matriz Trad Finalid" para o código da Nova Matriz de Tradução de Finalidade Externa criada no item anterior (3).
- No Menu do Datasul, através do programa "Parâmetros do Operador Logístico", incluir um novo parâmetro para cada Estabelecimento utilizado, conforme abaixo:
- Estabelecimento: Código do Estabelecimento que irá utilizar os Parâmetros;
- Matriz Trad Organização Extern: Informar o código da nova Matriz criada no item anterior (4);
- Grupo Padrão - Grupo Cliente: Código do Grupo de Cliente padrão, que será utilizado para criação de novos Clientes cadastrados a partir do Protheus;
- Grupo Padrão - Grupo Fornecedor: Código do Grupo de Fornecedor padrão, que será utilizado para criação de novos Fornecedores cadastrados a partir do Protheus;
- Grupos utilizados para Replicação - Grupos Cliente: Lista de Grupos de Clientes que serão replicados para o Protheus, toda vez que um Cliente for incluído, alterado ou excluído, se ele pertencer a um grupo contido nesta lista, ele será replicado para o Protheus;
- Grupos utilizados para Replicação - Grupos Fornecedor: Lista de Grupos de Fornecedores que serão replicados para o Protheus, toda vez que um Fornecedor for incluído, alterado ou excluído, se ele pertencer a um grupo contido nesta lista, ele será replicado para o Protheus;
- No Menu do Datasul, através do programa "Grupo Fornecedor (Financeiro)", realizar o seguinte procedimento:
- Selecionar o Grupo de Fornecedor informado anteriormente, no item 5 - Parâmetros do Operador Logístico, no campo "Grupo Padrão - Grupo Fornecedor";
- Alterar o campo "Receita/Despesa", informar o código da Despesa que será utilizada na criação de novos Fornecedores cadastrados a partir do Protheus;
- Alterar o campo "Portador", informar o Código do Portador que será utilizado na criação de novos Fornecedores cadastrados a partir do Protheus.
- Para mais detalhes sobre as configurações, acessar a FAQ: http://tdn.totvs.com/x/sCocEQ
Protheus
Parâmetros de Integração
- Acessar o ambiente Protheus / Programa inicial: SIGACFG.
- Ambiente / Cadastros / Parâmetros.
Busque e altere os parâmetros:
Parâmetro Descrição Valor MV_TMSERP ERP que está integrado ao SIGATMS. 0 - Protheus, 1 - Datasul. 1 MV_TMSMFAT Modo de Faturamento do TMS. 1- Faturamento a partir do SE1; 2- Faturamento a partir do DT6 2
Configurações EAI
Cadastre um agendamento no Schedule para a rotina FWEAI, de forma que fique sempre ativo (Este serviço é necessário para processamento das mensagens).
Configure a rota para o ambiente Datasul que será integrado, por meio da alteração dos parâmetros ou do cadastro de rotas:
(Lib inferior a label 20170208)
Parâmetro | Descrição | Valor |
---|---|---|
MV_EAIWS | Nome do Client WS do EAI para envio a outro EAI. | WSEAIDATASUL |
MV_EAIURL2 | Nome do canal configurado no EAI para envio a outro EAI. | http://<HOST>:<PORTA>/eai2-ws/EAIService * Ambiente Datasul |
MV_EAIMETH | Método de envio do EAI para envio a outro EAI | receiveMessage |
MV_EAIXSD | Diretórios dos XSD usados na validação | <DIRETÓRIO XSD> |
MV_EAIUSER | Usuário para autenticação | <USUÁRIO> |
MV_EAIPASS | Senha para autenticação | <SENHA> |
(Lib igual ou superior label 20170208)
Por intermédio do cadastro de rotas:
- Acessar o ambiente Protheus / Programa inicial: SIGACFG.
Ambiente / Schedule / Cadastro Rotas Eai.
Produto Aplicação URL Client WS Método Usuário Senha DATASUL <Aplicação Datasul> http://<HOST>:<PORTA>/eai2-ws/EAIService * Ambiente Datasul WSEAIDATASUL receiveMessage <USUÁRIO> <SENHA>
- Realize o cadastro de De/Para de Empresas Mensagem Única:
- Acessar o ambiente Protheus / Programa inicial: SIGACFG.
Ambiente / Schedule / Emp.filial Mensagem Única.
Referência Company Branch Emp.Protheus Fil.Protheus DATASUL <EMPRESA DATASUL> <EMPRESA PROTHEUS> <FILIAL PRINCIPAL> Informações Cadastre o De/Para, para todas as empresas que possuírem integração.
- Devem ser realizados os seguintes cadastros de adapters EAI:
- Acessar o ambiente Protheus / Programa inicial: SIGACFG.
- Ambiente / Schedule / Adapter E.a.i.
Cadastre os seguintes registros:
Mensagem única? Rotina Mensagem Descrição Envia? Recebe? Método Operação Canal Envio XSD Versão Envio 1 - Sim TMSA851 TRANSPORTINVOICE FATURA DE TRANSPORTE A RECEBER 1 - Sim 2 - Não 1 - Síncrono 1 - Todas 2 - EAI 2.000 1 - Sim TMSI852 TRANSPORTINVOICESTATUS STATUS DA FATURA DE TRANSPORTE 2 - Não 1 - Sim 2 - Assíncrono 1 - Todas 2 - EAI 2.000 Aviso title Observação (Lib igual ou superior label 20170208) Vincule a rota criada do produto Datasul e indique o campo Envia como Sim, para todos os adapters que enviam mensagem (Envia? 1 - Sim).
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 SIGATMS Protheus e BackOffice Datasul, estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Transações/Entidades/Mensagens únicas
Método | ID | Descrição | Origem | Destino | XSD (versões podem variar) |
Processos | 01 | Fatura de Transporte a Receber | Protheus | Datasul | TransportInvoice_2_000.xsd |
02 | Status da Fatura de Transporte | Datasul | Protheus | TransportInvoiceStatus_2_000.xsd |
Fluxo das Informações
Processos
Fatura por Documento e Fatura AutomáticaTipo de Fluxo: Protheus > Datasul
Mensagem: TransportInvoice_2_000
Versão: 2.000
Modo: Síncrono
O processo de geração de Fatura por Documento e Fatura Automática no SIGATMS, quando ativada a integração com o ERP Datasul, não realizará a criação da tabela financeira do Contas a Receber do módulo Protheus SIGAFIN e sim uma nota tabela intermediária do módulo SIGATMS (DRT - Fatura de Transporte a Receber). O processo de geração de fatura permanece o mesmo já existente no produto para ambas as rotinas de Fatura por Documento e Fatura Automática, porém, na efetivação será criado um registro na nova tabela e será disparada a integração com o módulo de Contas a Receber Datasul, onde será criado o título para cobrança. Em relação ao processo de cancelamento da fatura, será acionado também pelas rotinas de faturamento do SIGATMS Protheus e integrado ao BackOffice para cancelamento do título gerado.
Nota | |||||
---|---|---|---|---|---|
| |||||
Integração no modo Assíncrono: Ao ser disparada, a mensagem será enviada ao EAI Protheus para que seja processada pela agenda do programa FWEAI no Schedule. Ao processar a mensagem, será enviada ao EAI Datasul que por sua vez irá processar a mensagem conforme agenda do programa Registrar Fila do EAI2 no RPW (BTB948AA).
Integração no modo Síncrono: Ao ser disparada, a mensagem será enviada pelo EAI Protheus diretamente ao EAI Datasul, que irá processar e retornar a resposta. O processo que disparou a mensagem fica aguardando até o retorno da resposta do ambiente destino para dar continuidade em sua execução. |
- Importante: para que seja possível realizar este procedimento, é necessário que previamente as transações estejam atualizadas do lado do Protheus, conforme descrito neste manual;
Deverá ser selecionado no combo-box "Aplicação Externa" a aplicação que representa o Protheus;
Para a transação "TransportInvoiceStatus", deve ser selecionada e marcada a opção "Habilitado".
Configurações Gerais
- No Menu do Datasul, através do programa "Recebimento Padrão", deverá ser incluído um novo registro conforme abaixo:
- Para cada Fatura gerada no TMS Protheus, será gerado um Título no Contas a Receber, portanto, deve ser informado no Recebimento Padrão, as informações que serão utilizadas para geração deste título, espécie, série, portador, carteira, etc...
- A princípio, o Código do Cliente não precisa ser informado. Ele somente será informado, caso seja necessário gerar o Título com parametrizações diferentes para um determinado cliente.
- No Menu do Datasul, através do programa "Seleção Recebimento Padrão", deverá ser realizada parametrização conforme abaixo:
- Através deste programa, é realizada a parametrização para determinar qual Recebimento Padrão será utilizado para geração do Título no Contas a Receber, a partir da integração de Faturas do TMS Protheus;
- Caso, o Título deve ser gerado sempre da mesma forma, pode ser criado um único registro de Seleção mais genérico, deixando os campos "Código Transação" e "Clientes" em branco e informado um único Recebimento Padrão;
- Mas, também é possível criar parâmetros mais específicos, por exemplo, informando um Cliente, desta forma, na geração do Título, caso a Fatura seja para o cliente que está parametrizado, será utilizado o Recebimento Padrão informado para aquela Seleção. Caso seja outro cliente, será utilizado o Recebimento Padrão da parametrização mais genérica;
- O campo "Código Transação" equivale ao Tipo de Documento do Conhecimento de Transporte parametrizado no TMS Protheus. Portanto, é possível criar uma Seleção de Recebimento Padrão diferenciada por Tipo de Conhecimento que faz parte da Fatura.
- É possível parametrizar o Datasul para que, a cada Conhecimento (ou CT-e) registrado no TMS Protheus, seja criado um Título no Contas a Receber para representá-lo, para fazer isto deve-se:
- Para as Naturezas de Operação que foram marcadas como "Natureza Transporte TMS" (conforme descrito no documento: DI_SIGATMS_x_Datasul_Faturamento_Fiscal) deve ser marcada a opção "Emite Duplicata";
- Desta forma, para cada CT-e registrada no TMS Protheus, será realizada uma integração com o Faturamento do Datasul, para geração de uma Nota Fiscal, que posteriormente será integrada com o Contas a Receber para geração de um Título;
- Caso o Datasul seja parametrizado desta forma, o Título gerado no Contas a Receber a partir da integração da Fatura do TMS Protheus, será criado a partir de uma Substituição, onde, os títulos de Origem serão os que foram criados a partir da Nota Fiscal criada no Faturamento a partir da CT-e
Limitações / Restrições Gerais
- Fatura por Documento e Fatura Automática
- Para efetuar corretamente a geração da fatura, é necessário que o CTe e NFST estejam devidamente integrados ao Datasul Faturamento Fiscal. Detalhes no documento de integração: DI_SIGATMS_x_Datasul_Faturamento_Fiscal.
- Alguns cadastros devem estar relacionados em ambos os sistemas: Protheus SIGATMS e BackOffice Datasul. Detalhes no documento de integração: DI_SIGATMS_x_Datasul_Cadastros.
Como fazer
- Fatura por Documento e Fatura Automática
Os procedimentos para utilização do processo de fatura no módulo SIGATMS integrando com o BackOffice Datasul, estão descritos no documento técnico Integração SIGATMS x ERP Datasul Finanças ACR.
Situações comuns
Erros de integração:
Código | Erro | Rota de integração | Situação |
---|---|---|---|
707 | Valor do Título Inválido ! | O valor do título deve ser maior que 0 (zero). | PROTHEUS>DATASUL | Ao disparar a integração entre a Fatura do SIGATMS com o Contas a Receber Datasul, a geração do título foi realizada, porém, a fatura não foi criada (alguns motivos possíveis: Ocorreu Timeout durante a execução (é necessário aumentar o tempo de Timeout nas configurações do servidor HTTP Protheus), a sessão Protheus fechou ou foi finalizada incorretamente durante o processo). Realize manualmente o estorno do título no financeiro. |
360 | Tradução da Empresa &1 não encontrada na Matriz &2 ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Cadastre na Matriz de Tradução de Unidade Organizacional Externa &2, a correspondente da empresa &1 no Datasul-EMS. |
361 | Tradução do Estabelecimento &1 não encontrado na Matriz &2 ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Cadastre na Matriz de Tradução de Unidade Organizacional Externa &2, o correspondente do estabelecimento &1 no Datasul-EMS. |
446 | Cliente Financeiro &1 inexistente ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Verifique se existe tal ocorrência no cadastro de &2. |
691 | Matriz da Unidade Organizacional não cadastrada ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: A Matriz da Unidade Organizacional informada não está cadastrada. |
8148 | Não existe tradução para a moeda ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Não existe tradução para a moeda &1 na matriz &2. |
22358 | Cliente não encontrado ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Cliente da Empresa: &1, com CPF/CNPJ: &2 e Inscrição Estadual: &3, não está cadastrado. |
22359 | Seleção do Recebimento Padrão Inexistente ou Inválida ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Consulte o cadastro de Seleção de Recebimento Padrão. Empresa: &8, Transação: &3, Cod Trans: &7, Estab: &4, &5: &6. |
22360 | Rateio Padrão Recebimento não encontrado ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Não foi encontrado Rateio Padrão para o Recebimento Padrão: &3. |
22361 | Condição de Pagamento Inexistente ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Não encontrada nenhuma Condição de Pagamento cadastrada para o &1: &2. |
22364 | Nenhum Conhecimento Informado ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Para gerar Título(s) no ACR é necessário selecionar pelo menos um Conhecimento. |
22365 | Título do Contas a Receber não encontrado ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Título ACR de Origem Faturamento não encontrado. Estab: &1, Série: &2, Conhecimento: &3. |
22386 | Nenhum Título encontrado. | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Não foram encontrados Títulos relacionados ao Estab: &1, Fatura: &2. |
22387 | Título não encontrado. | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Título relacionado a Fatura, não encontrado. Estab: &1, Esp: &2, Série: &3, Título: &4, Parcela: &5. |
22391 | Tipo de Conhecimento inválido ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Os Conhecimentos agrupados para Faturamento não possuem a mesma parametrização de atualização do financeiro, conforme Natureza de Operação. &1 |
22393 | Parâmetro POL não econtrado. | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Parâmetro Plataforma Operador Logístico do Estabelecimento: &1, não encontrado. |
22394 | Condição de Pagamento Inválida ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: O campo 'Permite Fatura Parcelada' do Parâmetro Plataforma Operador Log¡stico do Estabelecimento: &1, está marcado como 'Não' e a Condição de Pagamento do Cliente: &2, está parametrizado para gerar mais de uma Parcela. |
22395 | Recebimento Padão inválido. | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Os Conhecimentos informados possuem Recebimento Padrão diferentes. Verifique o cadastro de Seleção Recebimento Padrão. &1 |
22427 | Erro ao buscar informações da Nota Fiscal ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Nota Fiscal não encontrada para o Conhecimento do Estabelecimento: &1, Série: &2, Fatura: &3. |
INTEGRAÇÃO PROTHEUS SIGATMS X DATASUL - CONTAS A RECEBER
Introdução
Cada vez mais as empresas necessitam gerenciar e otimizar sua logística e conforme legislação, necessitam do papel de uma Transportadora. Por isto, há uma busca por softwares de Gestão de Transportes que controlem os processos e operações de uma Transportadora. O módulo SIGATMS da linha Microsiga Protheus é a solução TOTVS para este cenário de mercado. Em relação aos clientes desta linha, o módulo já possui integração nativa com os módulos de BackOffice como, Faturamento (SIGAFAT), Fiscal (SIGAFIS), Financeiro (SIGAFIN) e Contábil (SIGACTB). Já em relação aos clientes da linha Datasul, o módulo SIGATMS não possuía integração.
Sistemas Envolvidos
Linha Microsiga Protheus
- SIGATMS (Transportation Management System): Sistema de gerenciamento de transportes que tem como objetivo principal controlar todos os processos fiscais e gerenciais envolvidos na operação de transportes, bem como, controlar os veículos, motoristas, fretes e viagens da empresa e de terceiros. Entre as atividades mais importantes, destacam-se controle das despesas dos veículos, viagens, fretes, emissão de CTRC (Conhecimento de Transporte Rodoviário de Cargas), nota fiscal de serviço, manifesto entre outros. O SIGATMS controla todos os processos de um transportador, abrangendo as áreas: Operacional, Comercial, Seguros, Faturamento, Logística e SAC. Solução totalmente integrada com a área administrativa (Financeiro, Fiscal e Contábil).
Linha Datasul (BackOffice)
- Financeiro:
- Contas a Receber (ACR): O Módulo de Contas a Receber visa auxiliar o gerenciamento administrativo, controlando movimentações de títulos e outros. Maiores detalhes, consultar: ACR - Contas a Receber
Integração
O módulo SIGATMS da linha Microsiga Protheus, possui integração nativa com os módulos de BackOffice de mesma linha como, Faturamento (SIGAFAT), Fiscal (SIGAFIS), Financeiro (SIGAFIN) e Contábil (SIGACTB).
Existem clientes da linha Datasul que demandam a necessidade de utilização de um módulo de Gestão de Transportes como o SIGATMS, porém mantendo os módulos de BackOffice da linha Datasul.
Para que seja possível atender esta demanda e possibilitar uma nova oferta de mercado TOTVS, por meio desta integração será possível a utilização do módulo SIGATMS da linha Microsiga Protheus, integrado aos módulos de BackOffice da linha Datasul (Faturamento, Fiscal, Financeiro e Contábil).
Este documento especificamente apresenta os detalhes da integração do SIGATMS com o módulo Datasul: Contas a Receber.
- Premissas
- Integrar o módulo SIGATMS da linha Protheus com o módulo Financeiro do BackOffice Datasul: Contas a Receber;
- Arquitetura (Tecnologia)
- Integração por intermédio do EAI - Enterprise Application Integration com o padrão de Mensagem Única;
Escopo
Pré-requisitos instalação/implantação/utilização
Datasul
Versão mínima | 12.1.18 |
---|---|
Módulo implantado | ACR - Contas a Receber |
Ferramentas necessárias | Configuração do WebService EAI2 |
Protheus
Versão mínima | 12.1.18 |
---|---|
Módulo implantado | SIGATMS - Gestão de Transportes |
Funcionalidades implantadas | Conhecimento de Transporte Eletrônico (Ct-e) |
Ferramentas necessárias | ¹ Servidor WebServices Protheus iniciado |
Schedule Protheus configurado |
Aviso |
---|
¹ Ajuste o timeout do servidor HTTP na qual o WebService Protheus estará para acima de 15 minutos (900 segundos).
|
Instalação/Atualização
Datasul
Configurações Iniciais
Realizar as configurações descritas no documento:
Configurações EAI
Toda a configuração do EAI Datasul® será feita através do TOTVS Monitor, que é acessado através do caminho: http://<HOST-DATASUL>:<PORTA>/totvs-monitor
Configurações EAI
Toda a configuração do EAI Datasul® será feita através do TOTVS Monitor, que é acessado através do caminho: http://<HOST-DATASUL>:<PORTA>/totvs-monitor
- Realizar o cadastro do Aplicativo Externo que irá representar Protheus®:
- A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Externa;
- Deve ser incluída uma Aplicação Externa através do Botão "Adicionar Aplicação Externa";
- Deverá ser informado o caminho WSDL de instação do Protheus®, bem com a Porta de Acesso e o Usuário/Senha.
Configurar no EAI do Datasul® as mensagens de Cadastro que serão trocas com o Protheus®:
A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Interna / Transações Disponíveis;
As mensagens deverão ser configuradas conforme tabela abaixo:
TransaçãoVersãoModo HabilitadoCustomerShippingAddress 1.001 Ambos CustomerVendor 1.000 Ambos CustomerVendorReserveID 1.000 Recebimento ElectronicTransportDocument 1.000 Recebimento Item 3.006 Recebimento
Configurar as Rotas de Envio para as Transações que serão enviadas ao Protheus®.
A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Interna / Rotas de Envio;
- Importante: para que seja possível realizar este procedimento, é necessário que previamente as transações estejam atualizadas do lado do Protheus®, conforme descrito neste manual;
Deverá ser selecionado no combo-box "Aplicação Externa" a aplicação que representa o Protheus®;
Para cada uma das transações "CustomerShippingAddress" e "CustomerVendor", deve ser selecionada e marcada a opção "Habilitado".
- Configurar o De-Para de Empresa e Estabelecimento entre a Aplicação Externa (Protheus®) e o Datasul®.
- A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Externa;
- Selecionar a Aplicação Externa que representa o Protheus®;
- Clicar no botão "De-Para";
- Para Empresa:
- Selecionar a estrutura "CompanyInternalId - fnd_empres";
- Informar os campo "Valor Externo" com o Código da Empresa do Protheus® e o "cod_empresa" com o Código da Empresa correspondente no Datasul®;
- Repetir este Processo para todas a Empresas.
- Para Estabelecimento:
- Selecionar a estrutura "BranchInternalId - estabelec";
- Informar os campo "Valor Externo" com o Código do Estabelecimento (ou Filial) do Protheus® e o "cod-estabel" com o Código do Estabelecimento correspondente no Datasul®;
- Repetir este Processo para todos os Estabelecimento.
Configurações Gerais
- No Menu do Datasul®, através do programa "Parâmetros Funções do Produto" (HUB), deverão ser habilitadas as seguintes funções:
- TMS Transportador - Para empresas que irão utilizar o TMS Protheus® integrado com o BackOffice Datasul®;
- WMS Operador Logistico - Para empresas que irão utilizar o WMS Logix® integrado com o BackOffice Datasul®; Grupos utilizados para Replicação
- Codigo Unico Cliente Fornecedor Transportador - Para empresas que optarem por realizar o controle de Código Único de Cliente/Fornecedor/Transportador nas integrações TMS Protheus®/WMS Logix® x BackOffice Datasul®.
- No Menu do Datasul®, através do programa "Módulos Produto Datasul", deverá ser incluído um novo módulo conforme abaixo (caso ele não exista):
- Módulo: TMS
- Descrição: TMS Transportador
- Sistema: CAD
- No Menu do Datasul®, através do programa "Matriz Tradução Finalidade Externa", deverá ser criada uma nova matriz conforme abaixo:
- Código Matriz Trad Finalid: Qualquer código, de preferência "TMS";
- Finalid Econ Externa: "1" (este código corresponde a moeda Corrente no TMS Protheus®);
- Tipo Cotação: Valor
- Finalidade: "Corrente"
- No Menu do Datasul®, através do programa "Matriz Tradução Organização Externa", realizar o seguinte procedimento:
- Selecionar a Matriz chamada "EMS2" e realizar uma cópia dela através do botão "Duplicar Matriz UO";
- No campo "Matriz UO Destino" informar um código qualquer, de preferência "TMS";
- Na nova Matriz criada, alterar os De-Para já existentes, modificando o campo "Matriz Trad Finalid" para o código da Nova Matriz de Tradução de Finalidade Externa criada no item anterior (3).
- No Menu do Datasul®, através do programa "Parâmetros do Operador Logístico", incluir um novo parâmetro para cada Estabelecimento utilizado, conforme abaixo:
- Estabelecimento: Código do Estabelecimento que irá utilizar os Parâmetros;
- Matriz Trad Organização Extern: Informar o código da nova Matriz criada no item anterior (4);
- Grupo Padrão - Grupo Cliente: Código do Grupo de Cliente padrão, que será utilizado para criação de novos Clientes cadastrados a partir do Protheus®;
- Grupo Padrão - Grupo Fornecedor: Código do Grupo de Fornecedor padrão, que será utilizado para criação de novos Fornecedores cadastrados a partir do Protheus®;
- Grupos utilizados para Replicação - Grupos Cliente: Lista de Grupos de Clientes que serão replicados para o Protheus®, toda vez que um Cliente for incluído, alterado ou excluído, se ele pertencer a um grupo contido nesta lista, ele será replicado para o Protheus®;
- Grupos utilizados para Replicação - Grupos Fornecedor: Lista de Grupos de Fornecedores que serão replicados para o Protheus®, toda vez que um Fornecedor for incluído, alterado ou excluído, se ele pertencer a um grupo contido nesta lista, ele será replicado para o Protheus®;
- No Menu do Datasul®, através do programa "Grupo Fornecedor (Financeiro)", realizar o seguinte procedimento:
- Selecionar o Grupo de Fornecedor informado anteriormente, no item 5 - Parâmetros do Operador Logístico, no campo "Grupo Padrão - Grupo Fornecedor";
- Alterar o campo "Receita/Despesa", informar o código da Despesa que será utilizada na criação de novos Fornecedores cadastrados a partir do Protheus®;
- Alterar o campo "Portador", informar o Código do Portador que será utilizado na criação de novos Fornecedores cadastrados a partir do Protheus®.
- Para mais detalhes sobre as configurações, acessar a FAQ: http://tdn.totvs.com/x/sCocEQTiscEQ
Protheus
Parâmetros de Integração
- Acessar o ambiente Protheus / Programa inicial: SIGACFG.
- Ambiente / Cadastros / Parâmetros.
Busque e altere os parâmetros:
Parâmetro Descrição Valor MV_TMSERP ERP que está integrado ao SIGATMS. 0 - Protheus, 1 - Datasul. 1 MV_TMSMFAT Modo de Faturamento do TMS. 1- Faturamento a partir do SE1; 2- Faturamento a partir do DT6 2
Configurações EAI
Cadastre um agendamento no Schedule para a rotina FWEAI, de forma que fique sempre ativo (Este serviço é necessário para processamento das mensagens).
Configure a rota para o ambiente Datasul que será integrado, por meio da alteração dos parâmetros ou do cadastro de rotas:
(Lib inferior a label 20170208)
Parâmetro | Descrição | Valor |
---|---|---|
MV_EAIWS | Nome do Client WS do EAI para envio a outro EAI. | WSEAIDATASUL |
MV_EAIURL2 | Nome do canal configurado no EAI para envio a outro EAI. | http://<HOST>:<PORTA>/eai2-ws/EAIService * Ambiente Datasul |
MV_EAIMETH | Método de envio do EAI para envio a outro EAI | receiveMessage |
MV_EAIXSD | Diretórios dos XSD usados na validação | <DIRETÓRIO XSD> |
MV_EAIUSER | Usuário para autenticação | <USUÁRIO> |
MV_EAIPASS | Senha para autenticação | <SENHA> |
(Lib igual ou superior label 20170208)
Por intermédio do cadastro de rotas:
- Acessar o ambiente Protheus / Programa inicial: SIGACFG.
Ambiente / Schedule / Cadastro Rotas Eai.
Produto Aplicação URL Client WS Método Usuário Senha DATASUL <Aplicação Datasul> http://<HOST>:<PORTA>/eai2-ws/EAIService * Ambiente Datasul WSEAIDATASUL receiveMessage <USUÁRIO> <SENHA>
- Realize o cadastro de De/Para de Empresas Mensagem Única:
- Acessar o ambiente Protheus / Programa inicial: SIGACFG.
Ambiente / Schedule / Emp.filial Mensagem Única.
Referência Company Branch Emp.Protheus Fil.Protheus DATASUL <EMPRESA DATASUL> <EMPRESA PROTHEUS> <FILIAL PRINCIPAL> Informações Cadastre o De/Para, para todas as empresas que possuírem integração.
- Devem ser realizados os seguintes cadastros de adapters EAI:
- Acessar o ambiente Protheus / Programa inicial: SIGACFG.
- Ambiente / Schedule / Adapter E.a.i.
Cadastre os seguintes registros:
Mensagem única? Rotina Mensagem Descrição Envia? Recebe? Método Operação Canal Envio XSD Versão Envio 1 - Sim TMSA851 TRANSPORTINVOICE FATURA DE TRANSPORTE A RECEBER 1 - Sim 2 - Não 1 - Síncrono 1 - Todas 2 - EAI 2.000 1 - Sim TMSI852 TRANSPORTINVOICESTATUS STATUS DA FATURA DE TRANSPORTE 2 - Não 1 - Sim 2 - Assíncrono 1 - Todas 2 - EAI 2.000 Aviso title Observação (Lib igual ou superior label 20170208) Vincule a rota criada do produto Datasul e indique o campo Envia como Sim, para todos os adapters que enviam mensagem (Envia? 1 - Sim).
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 SIGATMS Protheus e BackOffice Datasul, estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Transações/Entidades/Mensagens únicas
Método | ID | Descrição | Origem | Destino | XSD (versões podem variar) |
Processos | 01 | Fatura de Transporte a Receber | Protheus | Datasul | TransportInvoice_2_000.xsd |
02 | Status da Fatura de Transporte | Datasul | Protheus | TransportInvoiceStatus_2_000.xsd |
Fluxo das Informações
Processos
- Fatura por Documento e Fatura Automática
Tipo de Fluxo: Protheus > Datasul
Mensagem: TransportInvoice_2_000
Versão: 2.000
Modo: Síncrono
O processo de geração de Fatura por Documento e Fatura Automática no SIGATMS, quando ativada a integração com o ERP Datasul, não realizará a criação da tabela financeira do Contas a Receber do módulo Protheus SIGAFIN e sim uma nota tabela intermediária do módulo SIGATMS (DRT - Fatura de Transporte a Receber). O processo de geração de fatura permanece o mesmo já existente no produto para ambas as rotinas de Fatura por Documento e Fatura Automática, porém, na efetivação será criado um registro na nova tabela e será disparada a integração com o módulo de Contas a Receber Datasul, onde será criado o título para cobrança. Em relação ao processo de cancelamento da fatura, será acionado também pelas rotinas de faturamento do SIGATMS Protheus e integrado ao BackOffice para cancelamento do título gerado. - Status da Fatura
Tipo de Fluxo: Datasul > Protheus
Mensagem: TransportInvoiceStatus_2_000
Versão: 2.000
Modo: Assíncrono
Nota | |||||
---|---|---|---|---|---|
| |||||
Integração no modo Assíncrono: Ao ser disparada, a mensagem será enviada ao EAI Protheus para que seja processada pela agenda do programa FWEAI no Schedule. Ao processar a mensagem, será enviada ao EAI Datasul que por sua vez irá processar a mensagem conforme agenda do programa Registrar Fila do EAI2 no RPW (BTB948AA).
Integração no modo Síncrono: Ao ser disparada, a mensagem será enviada pelo EAI Protheus diretamente ao EAI Datasul, que irá processar e retornar a resposta. O processo que disparou a mensagem fica aguardando até o retorno da resposta do ambiente destino para dar continuidade em sua execução. |
Limitações / Restrições Gerais
- Fatura por Documento e Fatura Automática
- Para efetuar corretamente a geração da fatura, é necessário que o CTe e NFST estejam devidamente integrados ao Datasul Faturamento Fiscal. Detalhes no documento de integração: DI_SIGATMS_x_Datasul_Faturamento_Fiscal.
- Alguns cadastros devem estar relacionados em ambos os sistemas: Protheus SIGATMS e BackOffice Datasul. Detalhes no documento de integração: DI_SIGATMS_x_Datasul_Cadastros_restore.
Como fazer
- Fatura por Documento e Fatura Automática
Os procedimentos para utilização do processo de fatura no módulo SIGATMS integrando com o BackOffice Datasul, estão descritos no documento técnico Integração SIGATMS x ERP Datasul Finanças ACR.
Situações comuns
Erros de integração:
Código | Erro | Rota de integração | Situação |
---|---|---|---|
707 | Valor do Título Inválido ! | O valor do título deve ser maior que 0 (zero). | PROTHEUS>DATASUL | Ao disparar a integração entre a Fatura do SIGATMS com o Contas a Receber Datasul, a geração do título foi realizada, porém, a fatura não foi criada (alguns motivos possíveis: Ocorreu Timeout durante a execução (é necessário aumentar o tempo de Timeout nas configurações do servidor HTTP Protheus), a sessão Protheus fechou ou foi finalizada incorretamente durante o processo). Realize manualmente o estorno do título no financeiro. |
360 | Tradução da Empresa &1 não encontrada na Matriz &2 ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Cadastre na Matriz de Tradução de Unidade Organizacional Externa &2, a correspondente da empresa &1 no Datasul-EMS. |
361 | Tradução do Estabelecimento &1 não encontrado na Matriz &2 ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Cadastre na Matriz de Tradução de Unidade Organizacional Externa &2, o correspondente do estabelecimento &1 no Datasul-EMS. |
446 | Cliente Financeiro &1 inexistente ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Verifique se existe tal ocorrência no cadastro de &2. |
691 | Matriz da Unidade Organizacional não cadastrada ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: A Matriz da Unidade Organizacional informada não está cadastrada. |
8148 | Não existe tradução para a moeda ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Não existe tradução para a moeda &1 na matriz &2. |
22358 | Cliente não encontrado ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Cliente da Empresa: &1, com CPF/CNPJ: &2 e Inscrição Estadual: &3, não está cadastrado. |
22359 | Seleção do Recebimento Padrão Inexistente ou Inválida ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Consulte o cadastro de Seleção de Recebimento Padrão. Empresa: &8, Transação: &3, Cod Trans: &7, Estab: &4, &5: &6. |
22360 | Rateio Padrão Recebimento não encontrado ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Não foi encontrado Rateio Padrão para o Recebimento Padrão: &3. |
22361 | Condição de Pagamento Inexistente ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Não encontrada nenhuma Condição de Pagamento cadastrada para o &1: &2. |
22364 | Nenhum Conhecimento Informado ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Para gerar Título(s) no ACR é necessário selecionar pelo menos um Conhecimento. |
22365 | Título do Contas a Receber não encontrado ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Título ACR de Origem Faturamento não encontrado. Estab: &1, Série: &2, Conhecimento: &3. |
22386 | Nenhum Título encontrado. | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Não foram encontrados Títulos relacionados ao Estab: &1, Fatura: &2. |
22387 | Título não encontrado. | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Título relacionado a Fatura, não encontrado. Estab: &1, Esp: &2, Série: &3, Título: &4, Parcela: &5. |
22391 | Tipo de Conhecimento inválido ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Os Conhecimentos agrupados para Faturamento não possuem a mesma parametrização de atualização do financeiro, conforme Natureza de Operação. &1 |
22393 | Parâmetro POL não |
encontrado. | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Parâmetro Plataforma Operador Logístico do Estabelecimento: &1, não encontrado. | |
22394 | Condição de Pagamento Inválida ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: O campo 'Permite Fatura Parcelada' do Parâmetro Plataforma Operador Log¡stico do Estabelecimento: &1, está marcado como 'Não' e a Condição de Pagamento do Cliente: &2, está parametrizado para gerar mais de uma Parcela. |
22395 | Recebimento |
Padrão inválido. | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Os Conhecimentos informados possuem Recebimento Padrão diferentes. Verifique o cadastro de Seleção Recebimento Padrão. &1 | |
22427 | Erro ao buscar informações da Nota Fiscal ! | PROTHEUS>DATASUL | Situação de negócio retornada do Datasul Contas a Receber: Nota Fiscal não encontrada para o Conhecimento do Estabelecimento: &1, Série: &2, Fatura: &3. |