INTEGRAÇÃO TOTVS PLANEJAMENTO DE ROTAS X

MÓDULO

OMS PROTHEUS

Contexto de negócio

O TOTVS OMS disponibiliza uma funcionalidade que permite enviar  pedidos ou itens de pedidos de vendas liberados, veículos, parâmetros de entregas ao TPR - TOTVS Planejamento de Rotas, que realizará a otimização dos dados recebidos para compor a carga e a melhor rota de entrega dos Pedidos.

Exemplo: colocar tela do Mapa

Contextualização sobre do que se trata a área em que iremos dissertar tal integração.

Seu negócio, sua gestão, complexidade, o que está envolvido (em demais áreas), processos, etc. Tais explanações não precisam citar ferramentas (softwares) e sim as expectativas e resultados do uso de um sistema informatizado.

Interessante citar as tendências e necessidades de mercado, o quê, em geral, os software proporcionam (destinam/propósito), principais recursos, etc, e motivos que levaram a criar a integração (em outros termos, o porquê de integrar).

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

• Protheus/OMS-FAT - No OMS, seleção de pedidos, seleção de veículos, parametrização, visualização de pedidos a roteirizar, visualização de pedidos rejeitados, visualização de pedidos processados com carga, visualização do json de envio, visualização do json de resposta, visualização do json de retorno, geração da carga de acordo com a viagem retornada pela integração, validações de alterações de pedidos, aviso da exclusão da roteirização ao estornar pedido.
• Protheus/OMS-TMS - manter geolocalizações dos clientes para planejamento de rotas
• Neolog/TPR - Validações de entrada de informações para processamento de geolocalização, retornar latitude e longitude para a api consumidora da geolocalização, validações de entrada de informações para processamento de roteirização, retornar para a api consumidora se fará o processamento da roteirização, realizar o processamento de roteirização e retornar para a api consumidora as viagens geradas.
• a
• Sistema/Módulo vertical - Qual o módulo, qual marca, suas principais características, funcionalidades, escopo do módulo, etc
• BackOffice(s) - Qual(ais) marca(s), o que o ERP engloba, quais são seus pontos fortes, funcionalidades, etc, explanações principalmente no que diz respeito às funcionalidades do ERP que serão utilizadas pela integração (mas sem citar a integração)

Sistemas Envolvidos

• Protheus/OMS-FAT - No OMS, seleção de pedidos, seleção de veículos, parametrização, visualização de pedidos a roteirizar, visualização de pedidos rejeitados, visualização de pedidos processados com carga, visualização do json de envio, visualização do json de resposta, visualização do json de retorno, geração da carga de acordo com a viagem retornada pela integração, validações de alterações de pedidos, aviso da exclusão da roteirização ao estornar pedido.
• Protheus/OMS-TMS - manter geolocalizações dos clientes para planejamento de rotas
• Neolog/TPR - Validações de entrada de informações para processamento de geolocalização, retornar latitude e longitude para a api consumidora da geolocalização, validações de entrada de informações para processamento de roteirização, retornar para a api consumidora se fará o processamento da roteirização, realizar o processamento de roteirização e retornar para a api consumidora as viagens geradas.

Integração

A integração com o TOTVS Planejamento de Rotas deve automatizar o processo de geração de cargas. No qual o usuário seleciona pedidos de vendas liberados e veículos para que via integração, seja definida a melhor organização de cargas e a melhor ordem e rota de entregas desses pedidos nos clientes.

Premissas para a integração:

• Para realizar a integração é necessário o preenchimento do endereço completo dos clientes (Endereço com número, CEP, bairro, cidade, estado e país);
• Veículos cadastrados;

• Pedidos gerados e liberados;

Escopo

O escopo desta integração abrange a Geração da Carga e a visualização do Mapa no TOTVS OMS na rotina Montagem de Carga - OMSA200. A Geração da Carga ocorre com base nos pedidos de vendas liberados, veículos e parâmetros de entrega enviados ao TPR. A visualização do Mapa contém a melhor rota para a entrega, apresentando a quilometragem que será realizada, o tempo que será consumido, o volume  e o peso do serviço.

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

Para realizar a integração é necessário possuir os novos programas ou atualizações dos programas do Faturamento, OMS e TMS:

Para a integração é necessário realizar algumas configurações no appserver.ini

•  Configuração do REST do Protheus (appserver.ini)

;************************************
;*** REST
;************************************
[HTTPV11]
Enable=1
Sockets=HTTPREST
MAXSTRINGSIZE=500

[HTTPREST]
Port=8084
URIs=URIHTML
SECURITY=0

[URIHTML]
URL=/rest
PrepareIn=All
Instances=1,2
CORSEnable=1
AllowOrigin=*

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=environment1

[ONSTART]
JOBS=HTTPJOB
RefreshRate=120

• Configurações HTTP (appserver.ini)

[HTTP]
ENABLE=1
PATH=C:\Bases\environment1\data\web  (Pasta que contém os arquivos index.html e tprchannel.js)
PORT=8021   
INSTANCES=1,10    
SESSIONTIMEOUT=60
INSTANCENAME=WS_HTTP

[179.223.161.22:8021/ws] (Porta aberta)
ENABLE=1
PATH=C:\Bases\environment1\data\web  (Pasta que contém os arquivos index.html e tprchannel.js)
ENVIRONMENT=environment1
INSTANCENAME=WS_OMSCARGA
RESPONSEJOB=JOB_WS_OMS
DEFAULTPAGE=wsindex.apw

• Configurar Portais e Webservices (appserver.ini)

[JOB_WS_OMS]
TYPE=WEBEX
ENVIRONMENT=environment1
INSTANCES=1,10               
INSTANCENAME=JOB_WS_OMS
ONSTART=__WSSTART
ONCONNECT=__WSCONNECT
PREPAREIN=All
SIGAWEB=WS

• Parâmetros utilizados (SIGACFG):

• Arquivos relacionados ao mapa (data/web):

                   Verifique se os arquivos index.html e tprchannel.js constam na pasta web conforme PATH configurado (PATH=C:\Bases\environment1\data\web).

• Atualizar o menu do OMS

                 sigaoms.xnu

• Atualizar o help

               hlppor.txt

• Aplicar o pacote de dicionários do TMS 9506 para que sejam criadas as tabelas DMR e DMS. O pacote criará campos nas tabelas DLU e DLV.

               Informações sobre os campos do TMS em DT DLOGTMS02-17080 Integração SIGATMS x Planejamento de Rotas (TPR) -   DETALHAMENTO DA ATUALIZAÇÃO DE DICIONÁRIO CONFORME ABAS

• Aplicar o pacote de dicionários do OMS 9560 para que sejam criadas campos nas tabelas DA3 e DAK. O pacote criará o parâmetro MV_TPRCLOG e os campos abaixo:

Integração

A integração com o TOTVS Planejamento de Rotas deve automatizar o processo de geração de cargas. No qual o usuário seleciona pedidos de vendas liberados e veículos para que via integração, seja definida a melhor organização de cargas e a melhor ordem e rota de entregas desses pedidos nos clientes.

O que levou a criação da integração / o porquê da integração (Finalidade/Objetivo), de forma macro, o que será integrado do, por exemplo, Vertical com o ERP (BackOffice)

Explique o contexto de negócio ou do problema na qual esta integração estará inserida. Isto inclui o funcionamento da(s) ponta(s) envolvida(s).

Premissas para a integração:

• Para realizar a integração é necessário o preenchimento do endereço completo dos clientes (Endereço com número, CEP, bairro, cidade, estado e país).
• Veículos cadastrados

• Pedidos gerados e liberados

O escopo desta integração abrange a Geração da Carga e a visualização do Mapa no TOTVS OMS na rotina Montagem de Carga - OMSA200. A Geração da Carga ocorre com base nos pedidos de vendas liberados, veículos e parâmetros de entrega enviados ao TPR. A visualização do Mapa contém a melhor rota para a entrega, apresentando a quilometragem que será realizada, o tempo que será consumido, o volume  e o peso do serviço.

Não faz parte do escopo desta integração:

• elencar os itens que não vamos atender na integração

Descreva, dado o contexto, qual o escopo de atuação da integração. Cite as áreas/perfis de usuários e funções impactadas. Se existe uma parte do contexto de negócio que a integração não tenta resolver, deixe explícito.

Defina exatamente o que a integração FAZ, o que ela NÃO FAZ e a sua finalidade.

[O conteúdo poderá estar disponível na ferramenta PMS – Painel de Gestão de Projetos, opção Plano do Projeto]

Como são os processos os que serão integrados, mas com uma visão geral e não só o ponto de integração caso contrário a homologação [ou outro que pegar o documento] não saberá do que se trata no sistema vertical, de forma sucinta, como funciona e o(s) ponto(s) de integração.

Citar a responsabilidade de cada produto.

Descrever com mais detalhes sobre o que será integrado (mas não ser especialista nas entidades/processos, pois suas particularidades serão descritas posteriormente) incluindo diagramas, prints, imagens, etc o que for interessante para auxiliar o entendimento.

Interessante aqui a inclusão de diagramas, imagens, lógicas, fluxo(s) do(s) processo(s) o que considerar interessante e agregador ao documento e ao escopo.

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

Para realizar a integração é necessário possuir os novos programas ou atualizações dos programas do Faturamento, OMS e TMS:

Para a integração é necessário realizar algumas configurações no appserver.ini

• Configuração Rest Protheus (appserver.ini)

;************************************
;*** REST
;************************************
[HTTPV11]
Enable=1
Sockets=HTTPREST
MAXSTRINGSIZE=500

[HTTPREST]
Port=8084
URIs=URIHTML
SECURITY=0

[URIHTML]
URL=/rest
PrepareIn=All
Instances=1,2
CORSEnable=1
AllowOrigin=*

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=environment1

[ONSTART]
JOBS=HTTPJOB
RefreshRate=120

• Configurações HTTP (appserver.ini)

[HTTP]
ENABLE=1
PATH=C:\Bases\environment1\data\web  (Pasta que contém os arquivos index.html e tprchannel.js)
PORT=8021   
INSTANCES=1,10    
SESSIONTIMEOUT=60
INSTANCENAME=WS_HTTP

[179.223.161.22:8021/ws] (Porta aberta)
ENABLE=1
PATH=C:\Bases\environment1\data\web  (Pasta que contém os arquivos index.html e tprchannel.js)
ENVIRONMENT=environment1
INSTANCENAME=WS_OMSCARGA
RESPONSEJOB=JOB_WS_OMS
DEFAULTPAGE=wsindex.apw

• Configuração do Job (appserver.ini)

[JOB_WS_OMS]
TYPE=WEBEX
ENVIRONMENT=environment1
INSTANCES=1,10               
INSTANCENAME=JOB_WS_OMS
ONSTART=__WSSTART
ONCONNECT=__WSCONNECT
PREPAREIN=All
SIGAWEB=WS

• Parâmetros utilizados (SIGACFG):

• Arquivos relacionados ao mapa (data/web):

                   Verifique se os arquivos index.html e tprchannel.js constam na pasta web conforme PATH configurado (PATH=C:\Bases\environment1\data\web).

• Atualizar o menu do OMS

                 sigaoms.xnu

• Atualizar o help

               hlppor.txt

• Aplicar o pacote de dicionários do TMS 9506 para que sejam criadas as tabelas DMR e DMS. O pacote criará campos nas tabelas DLU e DLV.

SX2:

SX3:

Tabela DLU - Controle Integração Roteirização

DLV- Cadastro Roteirizador

DMR - Roteirização TPR

Campo

DMR_FILIAL

Tipo

Caractere

Tamanho

2

Decimal

0

Formato

Título

Filial

Descrição

Filial do Sistema

Usado

Não

Obrigatório

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Indica a Filial do Sistema

Campo

DMR_FILROT

Tipo

Caractere

Tamanho

2

Decimal

0

Formato

Título

Fil. Roteir.

Descrição

Filial Roteirização

Usado

Sim

Obrigatório

Sim

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Filial do Identificador da Roteirização

Campo

DMR_IDROT

Tipo

Caractere

Tamanho

9

Decimal

0

Formato

Título

Id.Roteir.

Descrição

Id. Roteirização

Usado

Sim

Obrigatório

Sim

Browse

Sim

Opções

When

Relação

GetSx8Num("DMR","DMR_IDROT")

Val. Sistema

Help

Identificador da Roteirização da Integração com o Planejamento de Rotas (TPR)

Campo

DMR_STATUS

Tipo

Caractere

Tamanho

1

Decimal

0

Formato

Título

Status

Descrição

Status

Usado

Sim

Obrigatório

Sim

Browse

Não

Opções

1=Pendente;2=Processado;3=Cancelado

When

Relação

'1'

Val. Sistema

Pertence('123')

Help

Status da Roteirização da Integração com o Planejamento de Rotas (TPR)

DMS - Itens Roteirização TPR

Campo

DMS_FILIAL

Tipo

Caractere

Tamanho

2

Decimal

0

Formato

Título

Filial

Descrição

Filial do Sistema

Usado

Não

Obrigatório

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Indica a Filial do Sistema

Campo

DMS_FILROT

Tipo

Caractere

Tamanho

2

Decimal

0

Formato

Título

Fil.Roteir.

Descrição

Filial Roteirização

Usado

Não

Obrigatório

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Filial do Identificador da Roteirização

Campo

DMS_IDROT

Tipo

Caractere

Tamanho

9

Decimal

0

Formato

Título

Id.Roteir.

Descrição

Id. Roteirização

Usado

Não

Obrigatório

Browse

Opções

When

Relação

Val. Sistema

Help

Identificador da Roteirização da Integração com o Planejamento de Rotas (TPR)

Campo

DMS_ITEM

Tipo

Caractere

Tamanho

6

Decimal

0

Formato

Título

Item

Descrição

Item

Usado

Sim

Obrigatório

Sim

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Identifica o item da roteirização

Campo

DMS_ENTIDA

Tipo

Caractere

Tamanho

3

Decimal

0

Formato

Título

Entidade

Descrição

Entidade

Usado

Sim

Obrigatório

Não

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Indica a Entidade do Documento.

Campo

DMS_INDENT

Tipo

Caractere

Tamanho

1

Decimal

0

Formato

Título

Indice Entid.

Descrição

Indice Entidade

Usado

Sim

Obrigatório

Não

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Indica o Indice da Entidade a ser utilizado para a pesquisa da Chave da Entidade 

Campo

DMS_CHVENT

Tipo

Caractere

Tamanho

200

Decimal

0

Formato

Título

Chave Entid.

Descrição

Chave Entidade

Usado

Sim

Obrigatório

Não

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Chave que contem os dados do Documento integrados ao Planejamento de Rotas (TPR)

Campo

DMS_INDEXT

Tipo

Caractere

Tamanho

1

Decimal

0

Formato

Título

Ind.Chv.Ext

Descrição

Indice Chave Externa

Usado

Sim

Obrigatório

Não

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Indica o Indice da Entidade a ser utilizado para a pesquisa da Chave Externa

Campo

DMS_ENTEXT

Tipo

Caractere

Tamanho

3

Decimal

0

Formato

Título

Ent.Chv.Ext

Descrição

Entidade Chave Externa

Usado

Sim

Obrigatório

Não

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Indica a Entidade da Chave Externa

Campo

DMS_CHVEXT

Tipo

Caractere

Tamanho

30

Decimal

0

Formato

Título

Chv. Externa

Descrição

Chave Externa

Usado

Sim

Obrigatório

Não

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Identifica o registro gerado na Integração Protheus x Planejamento de Rotas (TPR)

Exemplo: Módulo SIGATMS, caso a integração tenha sido realizada pela rotina de Programação de Carregamento, neste campo irá constar o Nro da Programação que o Documento foi vinculado.

(Filial + Fil.Prog + Nro Prog + Seq.Prog)

Campo

DMS_STATUS

Tipo

Caractere

Tamanho

1

Decimal

0

Formato

Título

Status

Descrição

Status

Usado

Sim

Obrigatório

Sim

Browse

Não

Opções

1=Pendente;2=Rejeitado;3=Processado;4=Falha no Processamento

When

Relação

'1'

Val. Sistema

Pertence("12345")

Help

Identifica o status do Documento para Roteirização

1-Pendente - Enviado para o TPR e aguardando retorno.

2-Rejeitado - Documento rejeitado pelo TPR.

Campo

DMS_MSGERR

Tipo

Memo

Tamanho

50

Decimal

0

Formato

Título

Msg. Erro

Descrição

Mensagem Erro

Usado

Sim

Obrigatório

Browse

Não

Opções

When

Relação

Val. Sistema

Help

Mensagem de erro recebida pelo Roteirizador do referido documento

Criação de índices:

DMR

Índice

Ordem

DMS

Índice

Ordem

Grupo- TMSA146TPR

Pergunta

Definição3

Criterio da Capacidade

Ambos

• Aplicar o pacote de dicionários do OMS 9560 para que sejam criadas campos nas tabelas DA3 e DAK. O pacote criará o parâmetro MV_TPRCLOG e os campos abaixo:

Campo

DA3_VELOC

Tipo

Numérico

Tamanho

6

Decimal

0

Formato

Título

Veloc. média

Descrição

Velocidade média

Usado

Sim

Obrigatório

Não

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Informar a velocidade média do veículo.

Campo

DAK_INTTPR

Tipo

Caractere

Tamanho

1

Decimal

0

Formato

Título

Int. TPR

Descrição

Integração TPR

Usado

Sim

Obrigatório

Não

Browse

Não

Opções

1=Carga gerada pelo TPR

When

Relação

Val. Sistema

Help

Informa se a carga foi gerada através da integração com o TPR (Totvs Planejamento de Rotas).

Campo

DAK_VIAEXT

Tipo

Caractere

Tamanho

1

Decimal

0

Formato

Título

Viagem Extra

Descrição

Viagem extra do TPR

Usado

Sim

Obrigatório

Não

Browse

Não

Opções

1=Sim, 2=Não

When

Relação

"2"

Val. Sistema

Help

Indica se a viagem gerada pelo TPR é uma viagem extra. Uma viagem extra é quando o TPR informa que durante a análise faltaram veículos para todos os pedidos. Para poder entregar mais pedidos, o planejamento sugeriu reutilizar um dos veículos enviados.

SX6:

                 DA3_VELOC: Neste campo, poderá ser informada a velocidade média do veículo via rotina OMSA060 (Cadastro de Veículos)

                 DAK_INTTPR: Ao aplicar o pacote, marcar via SIGACFG como usado. Este campo informará se a origem da geração da carga será via TPR.

                 DAK_VIAEXT: Ao aplicar o pacote, marcar via SIGACFG como usado. Este campo informará se a carga gerada é uma viagem extra.

• Configurar as URLs de integração TPR - (Totvs Planejamento de Rotas) -  Passo a passo TMSAC20

Após a geração e ativação do token no passo anterior via TMSAC20. Ao alterar um cliente via MATA030, será realizada uma integração para obter a geolocalização com base no cadastro do endereço. 

• A geolocalização pode ser incluída/alterada ou visualizada pelo programa de Referência Geográfica (TMSA015 - SIGATMS)

Relacione quais são os pré-requisitos (técnicos ou de negócio) para a integração. Este tópico não deve incluir informações da implantação normal do módulo, mas apenas informações específicas da integração. É como se este tópico já partisse do princípio que o módulo que será integrado já está normalmente instalado.

Entre os tópicos deste tópico podemos citar:

• Versões mínimas de produtos.
• Módulos ou programas que geram informações necessárias a integração. Muitas vezes a integração partirá de informações que somente são trabalhadas em um determinado programa ou processo, que deverá estar em uso no cliente.
• Ferramentas que são necessárias a integração, como: EAI, ESB, servidor de WebService etc.
• Aspectos legais nos quais as partes envolvidas na integração devem estar inseridas, caso as informações envolvidas sejam utilizadas para o cumprimento de alguma lei específica.
• Requisitos de hardware ou Software, como servidores, link de internet, capacidade de armazenamento e memória, sistema operacional.

Datasul

Insira aqui as informações pertinentes a Datasul.

Logix

Insira aqui as informações pertinentes ao Logix.

Protheus

Insira aqui as informações pertinentes ao Protheus.

RM

Insira aqui as informações pertinentes ao RM.

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.

Protheus

Insira aqui as informações pertinentes ao Protheus.

RM

Insira aqui as informações pertinentes ao RM.

Controle de Versão

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

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

Suporte

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

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

SX6:

                 DA3_VELOC: Neste campo, poderá ser informada a velocidade média do veículo via rotina OMSA060 (Cadastro de Veículos)

                 DAK_INTTPR: Ao aplicar o pacote, marcar via SIGACFG como usado. Este campo informará se a origem da geração da carga será via TPR.

                 DAK_VIAEXT: Ao aplicar o pacote, marcar via SIGACFG como usado. Este campo informará se a carga gerada é uma viagem extra.

• Configurar as URLs de integração TPR - (Totvs Planejamento de Rotas) -  Passo a passo TMSAC20

Após a geração e ativação do token no passo anterior via TMSAC20. Ao alterar um cliente via MATA030, será realizada uma integração para obter a geolocalização com base no cadastro do endereço. 

• A geolocalização pode ser incluída/alterada ou visualizada pelo programa de Referência Geográfica (TMSA015 - SIGATMS)

Integrações

1 - Geolocalização: Retorna as coordenadas geográficas de acordo com o endereço do fornecedor/cliente cadastrado (MATA020/MATA030):

Exemplo de envio:

{
   "address":{
      "identifier":"  MG000101",
      "address":"AVENIDA CONTORNO, 6283                                                          ",
      "state":"MG",
      "zipCode":"30110931",
      "country":"BRA",
      "city":"BELO HORIZONTE                                              "
   },
   "callbackAuthenticationType":"NONE",
   "dateCall":"2021-10-28T22:46:14",
   "callbackURL":"HTTP://179.223.161.99:8084/REST/V1/WSTPRNEOLOG/",
   "version":"7.00.191205P-20210601",
   "qualifiers":"{\"usuario\":\"Administrador\"}",
   "callbackAuthenticationValue":"",
   "system":"OMS"
}

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

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

Exemplos:

Fluxo das Informações

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

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

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

Cadastros

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

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

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

<Transação/Entidade>

Identificador da Mensagem: <mensagem>

Versão: <versão>

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

Módulo <marca 2>: <SIGAXXX>

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

Notas:

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

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

Limitações/Restrições

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

Processos

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

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

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

<Transação/Processo>

Tipo de Fluxo: Protheus -> RM

Mensagem: Request_1_000

Versão: 1.000

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

Acrescentar um diagrama do processo.

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

Notas:

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

Limitações/Restrições

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

Limitações / Restrições Gerais

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

• ERP1 envia ITEM cadastrado para o ERP2

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

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

• ERP2 envia PEDIDO cadastrado para o ERP1

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

Como fazer (opcional)

Descreva os passos que viabilizem a integração.

Exemplo:

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

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

Situações comuns (opcional)

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

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

Exemplo 1:

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

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

Exemplo 2:

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

Exemplo:

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

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

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

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

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

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

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

Checklist de suporte da aplicação

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

Instalação/Configuração

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

Checklist de Verificações:

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

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

Anexos