Linha Microsiga Protheus

Árvore de páginas

Bandeira Brasil Localização.png

CONTEÚDO

01. VISÃO GERAL

A rotina Layouts de Integrações (TMSAI82) é utilizada para definir o layout dos dados que serão utilizados na integração.


(ideia) Dica:

Para facilitar o uso da rotina, a TOTVS disponibiliza layout padrão pré-definido, que pode ser importado através da rotina Importa Layout (TMSAI88B - SIGATMS) de forma automática ou de forma manual.

Certifique-se que este esteja atualizado com a última versão (consulte a rotina de Fontes de Integração e vide o campo de versionamento do layout).

Utilizando o layout pré-definido, não será necessário nenhuma intervenção do usuário.

O arquivo de layout possuirá a extensão ".lay".

02. TELAS

TELA PRINCIPAL


Na imagem abaixo é demonstrado a tela principal, onde:

  1. Layout padrão pré-definido foi importado, através da rotina Importa Layout (TMSAI88B - SIGATMS);
  2. O registro deste Layout esta "vinculado" ao Código Fonte  01, exemplo (1.);

*Clique na imagem para ampliar e visualizar corretamente.

LAYOUT COLETA ENTREGA

LAYOUT PORTAL LOGÍSTICO

  1. O registro deste Layout esta "vinculado" ao Código Fonte  04, exemplo (2.);

LAYOUT OMS

  1. O registro deste Layout esta "vinculado" ao Código Fonte  03, exemplo (3.);

LAYOUT FATURAMENTO

  1. O registro deste Layout esta "vinculado" ao Código Fonte  05, exemplo (4.);

TELA PRINCIPAL - VISUALIZAÇÃO

Independente da integração, o layout seguirá o padrão de visualização/abas descritos a seguir:

1. TIPOS DE REGISTRO

Parte superior da tela, está subdivida em 4 abas:

1.1 Geral - Principais dados do Alias (tabela Protheus) do qual se baseará o registro do layout, e o JSON (formato de troca de dados entre sistemas independente de linguagem de programação derivado do JavaScript).

1.2 Dependência - Informa se este registro tem dependência de um registro anterior.

1.3 Adicional - Informa se este registro executará um registro adicional, ou seja, execução posterior.

1.4  Alternativa - Indica dados de JSON (formato de troca de dados entre sistemas independente de linguagem de programação derivado do JavaScript), alternativos a execução deste registro.


2. LAYOUT

Relaciona a origem das informações que serão gravadas na tabela (DN5) da rotina de Histórico de Integrações (TMSAI84 - SIGATMS), para posterior integração pelo JOB ENVIO (TMSAI86 - SIGATMS), utilizando as regras definidas na sessão 1. Tipos de Registro, acima descrita.


3. HERANÇA ID EXTERNO

Relaciona os registros dependentes (que são anteriores a este registro) e que receberão o ID externo resultante da integração deste mesmo registro.


BOTÃO OUTRAS AÇÕES

Executa a ativação/desativação do campo "Ativo?" dos  itens da rotina Layouts de Integração.

*Clique nas imagens para ampliar e visualizar corretamente.

1.

2.

03. UTILIZAÇÃO DA ROTINA

A rotina de Layouts de Integração permite a criação e a manutenção de layouts de cargas de dados utilizadas em "API's" (Application Programming Interface), podendo este layout ser baseado em: 

  1. Dados das tabelas do Protheus;
  2. Funções que retornam dados específicos;
  3. Herança de registros anteriores (definidos no mesmo conjunto de layouts).

Conforme mencionado anteriormente na Visão Geral, utilizando-se do layout pré-definido fornecido pela TOTVS, não será necessário nenhuma intervenção do usuário.

Importante saber


(aviso) Trata-se de uma rotina com complexidade técnica, contudo isso não impede a criação direta de um novo layout personalizado para uso do cliente. Neste cenário será de responsabilidade do cliente toda manutenção de layout personalizado criado, assim como ocorre com o desenvolvimento de Pontos de Entrada. Quando layout padrão sofre alteração passa a ser considerado  como layout customizado, sendo assim de responsabilidade do analista programador, e neste cenário o suporte não auxilia/atende.

Utilizando-se do layout padrão o mesmo garante que as informações enviadas via integração SIGATMS x Portal Coleta Entrega, integração SIGAOMS x Portal Coleta Entrega, integração SIGAFAT x Portal Coleta Entrega ou integração SIGATMS X Portal Logístico continuem íntegras e não possam ser manipuladas no Portal.

Qualquer alteração no layout como por exemplo: a retirada do node/tag ORIGEM que permitiria a alteração dos dados no Portal Coleta Entrega ou no Portal Logístico, é de total responsabilidade do desenvolvedor responsável pela customização. 

Toda alteração de dado ou inclusão feita diretamente no Portal Coleta Entrega ou Portal Logístico não será integrada para o SIGATMS, ou seja, não retornará para o Protheus, desta forma, não recomendamos este tipo de procedimento.

É extremamente importante que qualquer ajuste/alteração de layout seja feito por um usuário de com conhecimento técnico apropriado (estrutura de tabelas Protheus, webservice rest, objetos json).

PROCESSO ENVIO EM LOTE

Para utilização de de envio em lote, validar se o registro 1130 - VIAGEM do layout padrão da TOTVS possui a seguinte informação destacada em vermelho no campo Txt Base (DN2_BASE).

*Clique na imagem para ampliar.

04. TABELAS UTILIZADAS

  • DN2 - Tipos de Registro  
  • DN3 - Layout dos Registros  
  • DNB - Herança ID Externo 

05. ASSUNTOS RELACIONADOS