Histórico da Página
INTEGRAÇÃO PROTHEUS SIGATMS X DATASUL BACKOFFICE
Contexto de negócio (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).
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 e 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)
- Faturamento:
- Fiscal:
- Financeiro:
- ACR (Contas a Receber):
- APB (Contas a Pagar):
- Contábil:
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, através 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).
- Premissas
- Possibilitar a integração de cadastros principais como Produto, Cliente, Fornecedor, Transportador e Local de Entrega;
- Integrar o módulo SIGATMS da linha Protheus com os módulos de faturamento, fiscal, financeiro e contábil do BackOffice Datasul;
- Arquitetura (Tecnologia)
- Integração através do EAI - Enterprise Application Integration com o padrão de Mensagem Única;
Escopo
Office PowerPoint | ||||||
---|---|---|---|---|---|---|
|
Pré-requisitos instalação/implantação/utilização
Datasul
Protheus
Pré-requisitos necessários:
Versão mínima | 12.1.17 |
---|---|
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
Protheus
Alterações de Dicionário de Dados
- Acessar o ambiente Protheus / Programa inicial: SIGACFG;
- Base de Dados / Dicionário / Bases de Dados;
- Altere o Grupo de Campos "Codigo Cliente/Fornecedor" para o tamanho 9, para que o campo fique equivalente ao do Datasul;
Deixe o Grupo de Campos "Loja Cliente/Fornecedor" com o tamanho 2. O conceito de loja não existe no Datasul;
Aviso Lembre-se de ajustar o parâmetro MV_CLIGEN após realizar a alteração no Grupo de Campos.
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 Relação MV_TMSERP ERP que está integrado ao SIGATMS. 0 - Protheus, 1 - Datasul. 1 Geral MV_TMSMFAT Modo de Faturamento do TMS. 1- Faturamento a partir do SE1; 2- Faturamento a partir do DT6 2 Financeiro MV_TMSOPEC Código da natureza de operação do Datasul que será utilizado em CT-e Cortesia. <COD NATUREZA DTS> Faturamento/Fiscal MV_TMSOPEN Código da natureza de operação do Datasul que será utilizado em CT-e Normal. <COD NATUREZA DTS> Faturamento/Fiscal MV_TMSOPNF Código da natureza de operação do Datasul que será utilizado em Nota Fiscal. <COD NATUREZA DTS> Faturamento/Fiscal MV_ESPECIE Relação entre a série e o tipo de documento fiscal. Exemplo: 1=CTE;UNI=NF (Indica que a série "1" será de documento do tipo CTE e a série "UNI" será de nota fiscal <SÉRIE=CTE/NF;> Faturamento/Fiscal
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, através 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)
Através 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 PROTHEUS 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 1.000 1 - Sim TMSI852 TRANSPORTINVOICESTATUS STATUS DA FATURA DE TRANSPORTE 2 - Não 1 - Sim 2 - Assíncrono 1 - Todas 2 - EAI 1.000 1 - Sim TMSAE76 ELECTRONICTRANSPORTDOCUMENT CTE PARA FATURAMENTO DATASUL 1 - Sim 1 - Sim 2 - Assíncrono 1 - Todas 2 - EAI 1.000 1 - Sim MATA010 ITEM PRODUTO 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 3.001 1 - Sim MATA020 CUSTOMERVENDOR FORNECEDOR 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.000 1 - Sim MATA030 CUSTOMERVENDOR CLIENTE 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.000 1 - Sim MATA050 CARRIER TRANSPORTADOR 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 2.000 1 - Sim TMSA450 CUSTOMERSHIPPINGADDRESS LOCAL DE ENTREGA 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.001 1 - Sim TMSA070 TRANSPORTDOCUMENT CUSTO DE TRANSPORTE 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.000 1 - Sim TMSA240 TRANSPORTDOCUMENT COMPLEMENTO DA VIAGEM 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.000 1 - Sim TMSA250 TRANSPORTDOCUMENT CONTRATO CARRETEIRO 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.000 1 - Sim TMSA310 TRANSPORTDOCUMENT FECHAMENTO DA VIAGEM 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.000 1 - Sim TMSA330 TRANSPORTDOCUMENT FECHAMENTO DE SEGURO 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.000 1 - Sim TMSA370 TRANSPORTDOCUMENT INDENIZAÇÃO 1 - Sim 1 - Sim 1 - Síncrono 1 - Todas 2 - EAI 1.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).
Informações necessárias em Cadastros
Cadastro no menu | Informações necessárias | Relação | Observação |
---|---|---|---|
Atualizações / Cadastros / Clientes | Nome, endereço, estado, CEP, Cd. Município, País, CNPJ/CPF, Insc. Estadual, Reg. Cliente | Faturamento/Fiscal | Estas informações são necessárias para o correto funcionamento da integração do CTe e NFST com o Faturamento/Fiscal Datasul. A relação entre os clientes cadastrados no Protheus e os clientes cadastrados no Datasul é dada através do CNPJ + Inscrição estadual. |
Atualizações / Cadastros / Produtos | Código | Faturamento/Fiscal | O código dos produtos de cálculos do SIGATMS devem ser correspondentes aos códigos de itens cadastrados no Datasul. |
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) |
Cadastros | 01 |
|
|
|
|
Processos | 02 | Envio CTE/NFST para DTS | Protheus | Datasul | ElectronicTransportDocument_1_000.xsd |
03 | Fatura de Transporte a Receber | Protheus | Datasul | TransportInvoice_1_000.xsd | |
04 | Status da Fatura de Transporte | Datasul | Protheus | TransportInvoiceStatus_1_000.xsd |
Fluxo das Informações
Cadastros
Processos
Autorização CTe / NFST
Tipo de Fluxo: Protheus -> Datasul
Mensagem: ElectronicTransportDocument_1_000
Versão: 1.000
Modo: Assíncrono
O processo de autorização do CTe pelo SEFAZ ou NFST pela prefeitura dentro do módulo SIGATMS irá disparar a integração com o módulo de Faturamento Datasul que por sua vez integrará com o módulo Fiscal automaticamente e com o módulo Financeiro manualmente se executado o programa Atualização do Contas a Receber (FT0603). Assim também o Cancelamento do CTe e NFST e a Inutilização do CTe.
O processo de autorização, cancelamento e inutilização se mantém o mesmo já existente no módulo SIGATMS, porém, quando houver integração com o ERP Datasul (ativação através do parâmetro MV_TMSERP), também será realizado esta integração com o backoffice.Este processo ocorre somente após:
CTe: do retorno do SEFAZ autorizando o mesmo;
NFST: do retorno da prefeitura autorizando a mesma (caso a integração com a prefeitura ocorra de forma eletrônica) ou alterando o registro fiscal no módulo de Livros Fiscais do Protheus indicando o status SEFA e Nr Eletrônico que indique autorização ou cancelamento;
- Fatura por Documento e Fatura Automática
Tipo de Fluxo: Protheus -> Datasul
Mensagem: TransportInvoice_1_000
Versão: 1.000
Modo: Síncrono
O processo de geração de fatura por documento e fatura automática no SIGATMS, quando ativado 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á disparado 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.
Notas:
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).
Aviso |
---|
É estritamente necessário que o Schedule Protheus e RPW Datasul estejam corretamente configurados para o processamento no modo assíncrono. |
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
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
- Autorização CTe / NFST
- CT-e - Inclusão
- Acesse o ambiente Protheus, módulo SIGATMS, Atualizações / Recebimento / Entrada Documento de Clientes;
- Inclua um novo documento com um lote Eletrônico para geração do conhecimento de transporte eletrônico;
- Calcule o documento em Outras Ações / Cálculo Frete / Calcular;
- Acesse o Monitor CT-e, selecione o documento e clique em Transmitir;
- É necessário que o retorno da SEFAZ esteja como 100 - Autorizado o uso do CT-e, para que seja disparada a integração, por isso, enquanto estiver em processamento é necessário consultar o Status até que o retorno seja atualizado;
- Após ser autorizado, a mensagem de integração pode ser consultada em Miscelânea / Monitor EAI (Código da função: ELECTRONICTRANSPORTDOCUMENT);
- Também serão criados registros na tabela DJQ e DJR ao ser acionada a integração. Através da rotina Atualizações / Recebimento / Reenvio DTS, poderá ser consultado os registros enviados ao EAI e caso ocorra algum erro retornado pela resposta Datasul, após corrigi-los, a mensagem pode ser reenviada através deste monitor;
- CT-e - Cancelamento
- Acesse o ambiente Protheus, módulo SIGATMS, Atualizações / Recebimento / Entrada Documento de Clientes;
- Selecione o documento desejado para ser cancelado e vá em Outras Ações / Cálculo Frete / Estornar;
- Marque o documento que deve ser estornado e clique em Confirmar;
- Será apresentado um Help indicando que o cancelamento deve ser autorizado pelo SEFAZ;
- Para transmitir os documentos cancelados é necessário acessar o Monitor CT-e em Outras Ações / Cálculo Frete / CT-e;
- Não selecione nenhum documento e clique em Transmitir, será apresentado uma questão indicando se devem ser transmitidos os documentos cancelados, clique em sim;
- Quando houver a autorização de cancelamento pelo SEFAZ, será disparado a integração com o Datasul;
- Caso ocorra algum erro durante o cancelamento, após corrigi-los, a mensagem de integração poderá ser reenviada pela rotina Atualizações / Recebimento / Reenvio DTS;
- CT-e - Inutilização
- No Protheus, caso na transmissão do documento ao SEFAZ ocorra algum erro no retorno (Exemplo: 002 - Não foi possível assinar o CT-e...) e seja realizado o estorno deste documento, automaticamente é transmitido ao SEFAZ a solicitação de inutilização;
- Quando o SEFAZ autoriza a inutilização é chamado a integração com o Faturamento e Fiscal Datasul;
- NFST - Inclusão
- Acesse o ambiente Protheus, módulo SIGATMS, Atualizações / Recebimento / Entrada Documento de Clientes;
- Inclua um novo documento com um lote Normal para geração da NFST;
- Calcule o documento em Outras Ações / Cálculo Frete / Calcular;
- Para efetuar o processo de autorização desta NFST, é necessário acessar o módulo Livros Fiscais (09);
- Miscelânea / Acertos / Acertos Fiscais;
- Posicione no registro fiscal relacionado a NFST e clique em Alterar;
- Será apresentado uma mensagem de aviso de alteração, clique em Sim;
- Informe o Nr. Eletr. e o Retorno SEFA como 100 (Autorizado), após clique em Salvar;
- Neste momento é disparado a integração com o Faturamento Datasul que irá atualizar o módulo de Fiscal;
- NFST - Cancelamento
- Acesse o ambiente Protheus, módulo SIGATMS, Atualizações / Recebimento / Entrada Documento de Clientes;
- Selecione o documento desejado para ser cancelado e vá em Outras Ações / Cálculo Frete / Estornar;
- Marque o documento que deve ser estornado e clique em Confirmar;
- Acesse o módulo Livros Fiscais (09), Miscelânea / Acertos / Acertos Fiscais;
- Posicione no registro fiscal relacionado a NFST e clique em Alterar;
- Será apresentado uma mensagem de aviso de alteração, clique em Sim;
- Informe o Retorno SEFA como 101 (Cancelado), após clique em Salvar;
- Neste momento é disparado a integração com o backoffice Datasul;
- CT-e - Inclusão
- 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
Problemas de integração (Protheus):
Situação | Possíveis Causas | Solução | Relação |
Ao realizar a autorização do CT-e no SIGATMS, não disparou a mensagem de integração para o Faturamento Datasul (ELECTRONICTRANSPORTDOCUMENT). |
|
| Faturamento/Fiscal |
NFSE Chave Registro: 9999999999999|999|9999999 Relacionamento Série X Estabelecimento não cadastrado. |
|
| Faturamento/Fiscal |
Erros de integração:
Código | Erro | Rota de integração | Situação | Relação |
---|---|---|---|---|
EAI005 | Adapter com.totvs.datasul.logistics.dis.ElectronicTransportDocumentAdapter gerou uma exceção... | DATASUL -> PROTHEUS | Verifique o log de processamento da mensagem no Datasul (logs: RPW e Appserver), pois foi gerado um erro Progress que gerou a exceção. | Faturamento/Fiscal |
56 | Unidade da Federação: SP inexistente. | DATASUL -> PROTHEUS | É provável que o código IBGE do País da Unidade de Federação não tenha sido informado no cadastro do cliente (Protheus) em um dos clientes relacionados ao conhecimento (remetente, destinatário, devedor, consignatário). | Faturamento/Fiscal |
707 | Valor do Título Inválido ! | O valor do título deve ser maior que 0 (zero). | DATASUL -> PROTHEUS | 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. | Financeiro |
8 | Não foi enviada a data do cancelamento | DATASUL -> PROTHEUS | Durante o processo de cancelamento de uma NFST, foi realizado a alteração do status SEFA do registro fiscal Protheus antes de realizar o estorno do cálculo do conhecimento e por isso a data não foi enviada na mensagem de integração. Realize o estorno do cálculo do conhecimento e após reenvie a mensagem de cancelamento através da rotina de Atualizações / Recebimento / Reenvio DTS. | Faturamento/Fiscal |
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.