Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Índice |
---|
Especificação | |||
Produto | TOTVS | Módulo | EAI |
Segmento Executor | Framework | ||
Projeto1 | DEAI1 | IRM/EPIC1 | |
Requisito/Story/Issue1 | DEAI1-1160 | Subtarefa1 | DEAI1-1608 |
Chamado/Ticket2 | |||
País | ( ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( X ) TODOS. | ||
Outros | <Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>. |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
Elaborar a especificação que orientará a implementação do Identificador Global de Recursos nas respectivas linhas de produto com EAI.
Informações | ||
---|---|---|
| ||
Este documento leva em consideração que o leitor tenha um conhecimento prévio da mensagem padronizada TOTVS. Caso algum termo não esteja suficientemente descrito aqui, recomenda-se consultar o documento Padrão para criação de mensagem padronizada, disponível no portal de Integrações TOTVS. |
Estamos propondo a criação de um Identificador Global de Recursos para as entidades trafegadas entre os ERP's da TOTVS afim de substituir o uso de "Internal ID" em todas as integrações SOAP e REST.
As marcas deverão atender os seguintes pré-requisitos:
Os termos "DEVE", "NÃO DEVE", "REQUERIDO", "PODE", "NÃO PODE", "DEVERIA", "NÃO DEVERIA", "RECOMENDADO", "NÃO RECOMENDADO" e "OPCIONAL" devem ser interpretados como descritos na BCP-14, RFC-2119 e RFC-8174.
Informações |
---|
Recursos podem ser compreendidos como as Entidades que são trafegadas através das mensagens padronizadas a partir do EAI dos ERP's da TOTVS. |
Em termos gerais, o ERP de onde se origina a entidade a ser trafegada através do EAI (RM, Datasul, Protheus, Logix) irá realizar a geração do UUID v4, que identificará este recurso através de todas as linhas de produtos que compartilhem esta integração.
Iremos adotar o padrão de compatibilidade total com as mensagens atualmente em uso, sendo assim, mesmo que uma mensagem não utilize a estrutura proposta, os EAIs irão processar estas mensagens através do funcionamento legado utilizando o de-para na entidade "InternalId" para identificar o recurso.
Nossa proposta inicial é de se utilizar UUID's (Universally Unique Identifier), também conhecidos por GUID's (Globally Unique IDentifier), como URN (Uniform Resource Name) de entidades sendo trafegadas entre os ERP's da TOTVS.
Informações |
---|
Um UUID é composto por 128 bits de informação e não requer um processo de geração centralizado. |
Uma das principais razões pela escolha do UUID é que, além de sua geração poder ser descentralizada e automatizada, o algoritmo de geração do UUID suporta geração concorrente de até 10 milhões de registros por segundo por máquina, permitindo seu uso até como identificador de transações.
Informações |
---|
Exemplo de uma representação em texto de um UUID como URN: urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 |
Foi escolhida a versão 4 (UUID v4) por se tratar de um algoritmo que utiliza geração de valores randômicos e que não se baseia no MAC Address da máquina que realiza a geração do identificador (UUID v1).
Todas as linhas irão adequar seus adapters para enviar o Identificador Global de Recursos através da entidade "InternalId" no conteúdo de uma mensagem padronizada.
A especificação atual das mensagens será alterada para discriminar o tipo de identificador de recursos sendo utilizado na mensagem disparada.
Iremos incluir um atributo "globalType" no elemento "InternalId" do conteúdo da mensagem padronizada
Bloco de código | ||
---|---|---|
| ||
<xs:attribute name="globalType" type="xs:string" use="optional"> <xs:restriction base="xs:string"> <xs:enumeration value="UUID"></xs:enumeration> <xs:enumeration value="INTERNALID"></xs:enumeration> <xs:enumeration value="uuid"></xs:enumeration> <xs:enumeration value="internalid"></xs:enumeration> </xs:restriction> </xs:attribute> |
Especificação do elemento InternalId
Bloco de código | ||
---|---|---|
| ||
<xs:element name="InternalId" type="xs:string" minOccurs="1" maxOccurs="1"> <xs:annotation> <xs:documentation> Define um identificador universal para este recurso. Todas as mensagens que enviem um mesmo recurso terão o mesmo UUID e este valor permanece sempre o mesmo, seja no aplicativo que gera a mensagem, seja no que recebe. </xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="globalType" type="xs:string" use="optional"> <xs:restriction base="xs:string"> <xs:enumeration value="UUID"></xs:enumeration> <xs:enumeration value="INTERNALID"></xs:enumeration> <xs:enumeration value="uuid"></xs:enumeration> <xs:enumeration value="internalid"></xs:enumeration> </xs:restriction> </xs:attribute> </xs:complexType> </xs:element> |
Exemplo de utilização da estrutura proposta para representar um identificador global de recursos
Bloco de código | ||
---|---|---|
| ||
<InternalId globalType="uuid">f81d4fae-7dec-11d0-a765-00a0c91e6bf6</InternalId> |
Iremos incluir um atributo "GlobalType" no elemento "Content" da mensagem padronizada
Bloco de código | ||
---|---|---|
| ||
{ "title": "Content", "type": "object", "properties": { "GlobalType": { "type": "string" } } } |
Utilização da entidade "InternalId" em mensagens padronizadas
Bloco de código | ||
---|---|---|
| ||
{ "Content" : { "CompanyId" : "99", "BranchId" : "01", "CompanyInternalId" : "99", "Code" : "ABC001", "GlobalType" : "uuid" "InternalId" : "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "RegisterSituation" : "Active", "Name" : "Centro de Custo ABC001", "ShortCode" : "ABC001", "SPED" : true, "Class" : 2 } } |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|