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 de mesma linha 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
Logix
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
Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo. Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si. As informações mínimas necessárias para teste tópico são:
- Procedimentos que devem ser observados quando um dos produtos for atualizado.
- Configuração necessária que deve ser realizada em arquivos de configuração ou programas de parâmetros etc.
- Arquivos diversos que devem ser mantidos em determinados locais para o funcionamento da integração, exemplo: xml, xsd.
- Atualizações necessárias em banco de dados ou instruções para que elas sejam feitas.
- Processos, módulos ou programas que precisam ser instalados ou atualizados. Deve ser definida a versão mínima necessária dos programas envolvidos.
- Ferramentas, servidores ou serviços que precisam ser disponibilizados e configurados, o que pode gerar necessidade de novo hardware ou aumento de capacidade. Exemplo: serviço de WebService.
- Instruções para habilitar a comunicação da ferramenta EAI entre as partes, quais rotas devem ser definidas ou como as transações devem ser habilitadas.
Observação: evite o uso de Prints de telas, facilitando, assim, o trabalho de tradução e versionamento deste documento.
Datasul
Insira aqui as informações pertinentes a Datasul.
Logix
Insira aqui as informações pertinentes ao Logix.
Datasul
Protheus
Alterações de Dicionário de Dados
- Acessar o ambiente Protheus
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> Fiscal MV_TMSOPEN Código da natureza de operação do Datasul que será utilizado em CT-e Normal. <COD NATUREZA DTS> Fiscal MV_TMSOPNF Código da natureza de operação do Datasul que será utilizado em Nota Fiscal. <COD NATUREZA DTS> 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;> 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> Ou (Lib igual ou superior label 20170208)configure a rota para o ambiente Datasul que será integrado, através
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 | ||
---|---|---|
| ||
(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
- Cliente
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
<INCLUIR IMAGEM COM O FLUXO DE MENSAGENS DE INTEGRAÇÃO>
Método | ID | Descrição | Origem | Destino | XSD (versões podem variar) |
Cadastros | 01 | Cliente/Fornecedor | Protheus | Datasul | CustomerVendor_3_000.xsd |
02 | Local de Entrega | Protheus | Datasul |
| |
03 | Transportadora | Protheus | Datasul |
| |
04 | Produto | Protheus | Datasul |
| |
Processos | 05 | Fatura de Transporte a Receber | Protheus | Datasul | TransportInvoice_1_000.xsd |
06 | Status da Fatura de Transporte | Datasul | Protheus | TransportInvoiceStatus_1_000.xsd |
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>
Mensagem Padrão | PROTHEUS | RM | ||
Tabela | Campo | Tabela | Campo | |
Code | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO * |
Description | CTO990 | CTO_DESC | GMOEDA | DESCRICAO |
Symbol | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO |
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
Problemas de integração (Protheus):
Situação | Possíveis Causas | Solução |
Ao realizar a autorização do CT-e no SIGATMS, não disparou a mensagem de integração para o Faturamento Datasul (ELECTRONICTRANSPORTDOCUMENT). |
|
|
NFSE Chave Registro: 9999999999999|999|9999999 Relacionamento Série X Estabelecimento não cadastrado. |
|
|
Erros de integração:
Código | Erro | Rota de integração | Situaçã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. |
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.