Histórico da Página
Índice |
---|
Anatomia da Mensagem TOTVS
A Mensagem Padronizada TOTVS estabelece alguns padrões que devem ser seguidos por todos os aplicativos que participam da integração. Estes padrões estabelecem alguns tipos de mensagens suportadas bem como informações obrigatórias que devem fazer parte do seu conteúdo.
...
Clique aqui para obter mais informações sobre integração via API
Definição da Mensagem no modelo JsonSchema
Abaixo encontram-se as regras para definir uma mensagem padronizada.
- Seguir essa especificação do formato JsonSchema
- Seguir a definição de campos especificada <link para definição de campos reformulada>
- Especificar propriedade X-Totvs, de acordo com regras especificadas, incluindo quais ERPs implementam aquela mensagem e os campos relacionados.
- Sempre que possível, utilizar padrões internacionais. Para saber se já existe uma mensagem de conta contábil, por exemplo, pesquise no Google usando "account xsd oasis repository".
- Mensagens criadas para atender uma exigência legal devem se ater estritamente ao que é definido pela legislação. Nestes casos, o nome da mensagem e dos campos podem ser em português, se a legislação exigir.
Âncora | ||||
---|---|---|---|---|
|
Cabeçalho (Info)
O objetivo dessa propriedade é especificar quais produtos Totvs implementaram uma determinada propriedade da mensagem, e trazer outras informações sobre a mesma.
Bloco de código | ||||
---|---|---|---|---|
| ||||
"info": { ... "x-totvs": { "messageDocumentation": { "name": "StockTurnOver", "description": "Baixa de estoque", "segment": "Construção e Projetos" }, "productInformation": [ { "product": "RM", "contact": "Bruno Barbosa de Souza", "note": "GDP Inovação Const. e Proj.", "adapter": "MovMovimentoData" }, { "product": "PROTHEUS", "contact": "Eduardo de Souza", "note": "GDP de Materiais", "adapter": "MATI241" }, { "product": "PIMS", "contact": "José Alberto da Silva", "note": "", "adapter": "" } ], "transactionDefinition": { "subType": "event", "businessContentType": { "$ref": "#/definitions/BusinessContentType", "type": "object" }, "returnContentType": { "$ref": "#/definitions/ReturnContentType", "type": "object" } } } } |
MessageInformation
Contém nome, descrição e agrupador da mensagem (esse último definido através da propriedade segment)
Clique aqui para verificar os valores disponíveis para a propriedade segment
Campo Obrigatório
ProductInformation
Contém lista com nomes dos produtos em que essa mensagem foi implementada, qual o seu adapter correspondente e responsável.
Campo Obrigatório
TransactionDefinition
Esse campo deve ser definido para ativar a integração dessa mensagem via transaction (EAI)
...
Clique aqui se existem dúvidas sobre integração via transaction
Campo Opcional
Corpo/Propriedades
O objetivo dessa propriedade é especificar quais produtos Totvs implementaram uma determinada propriedade da mensagem, e trazer informações específicas sobre aquele campo em um determinado produto.
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
Code": { "type": "string", "description": "Código do País", "x-totvs": [ { "product": "Logix", "Field": "paises.cod_pais", "Required": true, "Type": "Char", "length": "3", "note": "some info...", "available": true, "canUpdate": false }, { "product": "RMS", "Field": "AA1CPAIS.PAIS_COD", "Required": true, "Type": "integer", "length": "6", "note": "some info...", "available": true, "canUpdate": false } ] }, |
Product
Nome do produto TOTVS do qual as outras informações se referem
Campo Obrigatório
Available
Define se essa propriedade está ou não disponível
Campo Obrigatório
CanUpdate
Define se essa propriedade pode ser atualizada
Campo Obrigatório
Field
A qual tabela.campo o campo da mensagem se refere.
Caso no produto este campo possa estar em mais tabela, explicar o funcionamento.
Campo Obrigatório
Required
Obrigatoriedade do campo, ou condições em que ele será obrigatório ou não.
Campo Obrigatório
Type
Tipo do campo no produto. Importante declarar aqui o tipo do campo como é conhecido no produto.
Campo Obrigatório
Length
Tamanho do campo no produto, pode ser informado apenas o tamanho ou outro texto que descreva como este tamanho funciona.
Campo Obrigatório
Note
Complemento de informações sobre o campo se for o caso.
Campo Opcional
Âncora | ||||
---|---|---|---|---|
|
Json Schema da Mensagem Branch 2.001 : https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_001.json
...
Exemplos Oficiais site json-schema: https://json-schema.org/learn/miscellaneous-examples.html
Âncora | ||||
---|---|---|---|---|
|
http://docs.oasis-open.org/ubl/prd1-UBL-2.1/UBL-2.1.html
...