ER_PCEQ_9723_Expor_os_cadastros_do_ERP_como_Webservices

Informações Gerais

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

Objetivo

O objetivo deste requisito é disponibilizar, através do EAI TOTVS e mais precisamente, através da engine de Mensagem Única TOTVS os objetos de negócio dos cadastros que podem ser integrados via EAI.

Definição da Regra de Negócio

Após a implementação deste requisito deverá ser possível enviar, através de uma Mensagem Única TOTVS recebida a definição do objeto de negócios de uma rotina desejada.

Para isto deverá ser criada uma nova Mensagem TOTVS, a mensagem GetSchema, respeitando a estrutura do arquivo anexo a esta especificação.

 Clique aqui e visualize o arquivo GetSchema.xsd.

O exemplo do Xml de entrada também está em anexo a esta especificação. Clique e visualize o arquivo GetSchemaIn.xml .

Somente poderá ser requisitado o Schema de um único adapter.

O exemplo do Xml de retorno também está em anexo a esta especificação. Clique e visualize o arquivo GetSchemaOut.xml.

Comportamentos esperados para a mensagem:

1. ERP recebe mensagem GetSchema com um adapter e o adapter enviado não possui Schema definido:

• • A mensagem deverá retornar com erro, indicando que o adapter não possui Schema definido;

1. ERP responde como Schema solicitado:

• • O ERP sempre irá retonar o schema com as tags de Xml escapadas (https://www.w3.org/TR/xml11/). O conteúdo do XSD não será enviado dentro do limitador <![CDATA[ ]]>.

Específico Protheus

Somente serão retornados adpaters  que possuam modelo de dados na rotina (não será distinguido se o modelo de dados é fake¸ou seja, serve para outro propósito específico ou é o modelo real da rotina impactada).

Os schemas serão retornados pelo método GetXmlSchema da classe FwFormModel.

O Protheus somente faz integrações nativas de rotinas que estejam cadastradas no Cadastro de Adapters Protheus. Desta maneira, somente rotinas cadastradas pela rotina APCFG020 (cadastro de adapters) serão retornadas por esta mensagem.

O nome enviado na tag adapter deverá ser o nome utilizado para a carga do modelo de dados no Protheus. Para efeitos do cadastro de adapter este é o valor do campo XX4_ROTINA.

O adapter Protheus para processamento desta rotina será o APCFG101. Este adapter não precisará ser criado pelo usuário. Ele deverá seguir a mesma regra do Adapter WhoIs, que é criado por demanda quando invocado.

 O usuário deverá conseguir também consultar quais são as interfaces com modelo de dados disponíveis no ERP. Para isto a mensagem única WhoIs deverá ser alterada para a release 1.001. Uma nova tag será adicionada a mensagem, conforme quadro abaixo.

O Protheus somente faz integrações nativas de rotinas que estejam cadastradas no Cadastro de Adapters Protheus. Desta maneira, somente rotinas cadastradas pela rotina APCFG020 (cadastro de adapters) serão retornadas por esta mensagem.

A tag RequestType será opcional, sem conteúdo, contendo apenas o parâmetro, do tipo Boolean, que identifica se o tipo de mensagens resgatadas pela WhoIs são as mensagens únicas TOTVS (false) ou somente mensagens que possuem BusinessObjects (no caso do Protheus, modelo de dados).

Alteração no retorno da mensagem WhoIs:

Todas as tags passam a ser opcionais, com excessão da tag Name.

Foi incluída a nova tag BusinessObject, que irá trafegar o nome do objeto de negócios (o nome do modelo de dados no Protheus). A necessidade desta tag  poderá ser verificada mais abaixo, pois será possível retornar pela WhoIs de uma mensagem única Totvs o objeto de negócio associado a esta mensagem.

Comportamentos esperados no ERP

1. 1.     ERP recebe mensagem WhoIs no formato anterior (versão 1.000)
   1. a.     O comportamento da WhoIs não é alterado;
2. 2.     ERP recebe mensagem WhoIs com a tag RequestType e o parâmetro BusinessObjectOnly=”false”, na versão 1.001
   1. a.     Protheus retornará todas as mensagens únicas disponíveis no cadastro de adapters Protheus e caso alguma destas rotinas possuir modelo de dados definido, a tag BusinessObject é devolvida com o nome do modelo de dados;
3. 3.     ERP recebe mensagem WhoIs com a tag RequestType e o parâmetro BusinessObjectOnly=”true”, na versão 1.001
   1. a.     Protheus devolverá na mensagem WhoIs somente os adapters cadastrados (indiferente se são mensagem única Totvs ou não) que possuam modelo de dados definido. O Protheus irá enviar na tag Message o nome do objeto de negócios, e não mais da mensagem única TOTVS. A tag BusinessObject  irá retornar com o mesmo valor. No Protheus estes valores são representados pelo conteúdo do campo XX4_ROTINA.

Clique e visualize o arquivo  whois_1_001.xsd.

Protótipo de Tela

Não se aplica

Fluxo do Processo

Não se aplica

Dicionário de Dados

Não se aplica

Grupo de Perguntas

Não se aplica

Consulta Padrão

Não se aplica

Estrutura de Menu

Não se aplica

Cadastro de Papéis