Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

Objetivo

O serviço getSchema deverá prover a recuperação das estruturas de dados usadas como parâmetros de entrada e saída para os cadastros e APIs do Datasul que forem expostos como Web Services.

Este serviço é parte da nova arquitetura de integração EAI, a qual está sendo denominada Mensageria TOTVS, que visa, entre outras coisas, definir os "donos" de uma integração e reduzir o tempo de suporte em situações de inconsistência. Para mais informações sobre a Mensageria TOTVS, acessar este documento.

Definição da Regra de Negócio

Em resumo, o serviço de recuperação de estrutura de dados será implementado utilizando uma transação do tipo Mensagem Única TOTVS, com nome getSchema. Para mais detalhes, consultar este documento de especificação. Nele é possível verificar o XML Schema (XSD) da transação, entre outras informações.

O fluxo a seguir demonstra como o serviço getSchema será utilizado no contexto das integrações:

No lado do Datasul (que no desenho acima é representado pelo ERP), será implementado um adapter seguindo os padrões de Mensagem Única TOTVS, o qual utilizará a classe helper gerada a partir do XSD da transação GetSchema 1.000.

O adapter, de nome GetSchemaAdapter_1_000, receberá o XML com o nome do objeto de negócio para o qual deve retornar o XSD correspondente aos parâmetros de entrada e saída. A resposta será o XSD que define os parâmetros de entrada e saída para o objeto de negócio solicitado.

A geração do XSD se dará a partir da infra-estrutura definida pelo serviço Datasul REST (veja mais detalhes aqui). Será reaproveitada a definição dos objetos de negócio, os quais estão registrados em arquivos no formato JSON. Estes arquivos serão carregados pelo adapter e interpretados para obter as definições necessárias para a geração do XSD, cujo conteúdo será incorporado na mensagem de resposta gerada.

O fluxo a seguir descreve em detalhes os elementos necessários para que a geração do XSD ocorra:

Abaixo está um exemplo do XML que deve ser enviado pelo aplicativo que deseja obter o schema para um determinado objeto de negócio:

<colocar o XML de exemplo aqui>

Observe que na tag Adapter o nome do objeto de negócio deve vir precedido do nome do produto que estará exercendo o papel de ERP na integração.

O diretório onde reside os arquivos de definição dos objetos de negócio deve ser indicado no arquivo de configuração do EAI (eai2-config.properties), através da propriedade eai2.mt.adapter.definition.dir.

O objeto de negócio também deve estar registrado no EAI para que seja possível obter seu schema. O registro é feito seguindo o mesmo padrão para adapters de mensagem única, com mudança apenas no nome da classe que implementa o adapter. Como o objeto de negócio é uma rotina Progress existente, o modo de registro do mesmo deve obedecer os seguintes padrões, para que o Engine do EAI saiba diferenciar um tipo de adapter do outro:

• Nome da classe deve ser precedido do prefixo "MT_" (Mensageria TOTVS);
• Nome do objeto de negócio deve incluir a pasta onde o objeto reside;
• Se o objeto for uma API, deve constar também o nome do método que se deseja publicar, não apenas o nome do objeto;
  

Opcional

Protótipo de Tela

<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.

Protótipo 01

Opcional

Fluxo do Processo

<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>. 

Opcional

Dicionário de Dados

Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/

(Opcional)

Grupo de Perguntas

<Informações utilizadas na linha Protheus>.

Nome: FINSRF2

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

Consulta: AMB

(Opcional)

Estrutura de Menu

<Informações utilizadas na linha Datasul>.

Procedimentos

Programas

Cadastro de Papéis

<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.

<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.