Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Especificação de Requisitos

 

Projeto/Versão: PDR_SER_TUR001-P12

Requisito/Módulo: PCREQ-2774/SIGATUR

Sub-Requisito/Função:

Tarefa/Chamado:

País: All

Data Especificação: 31/08/2015

 

Âncora
table02
table02
Rotinas Envolvidas

 

Rotina

Tipo de Operação

Opção de Menu

TURA005.PRW

Alteração

Atualizações-> Cadastros-> Tipos de Entidades

TURI005.PRW

Criação

 

  

Âncora
table03
table03
Estratégia de Desenvolvimento e Liberação

 

Produto

Microsiga Protheus

Release que está sendo desenvolvido

Versão 12

Possui Réplica?

( ) Sim  ( X ) Não

Qual a versão?

12.1.7

...


Integrar o cadastro de Tipos de Entidades Adicional do ERP Microsiga Protheus com o sistema de FrontOffice da agência de viagem. A integração possibilitará que os sistemas se comuniquem através de uma Mensagem Única, utilizando o schema XSD da TotvsMessage AdditionalEntitiesTypesAdditionalEntityType.

Definição da Regra de Negócio


Os sistemas de FrontOffice da agências de viagem irão se comunicar com o ERP Microsiga Protheus para sincronismo das informações entre as respectivas bases de dados. Para isso, se faz necessária a utilização da tecnologia Enterprise Application Integration (EAI).
Essa comunicação utilizará o padrão SOAP para envio e recebimento de arquivos XML, além de seguir um conjunto de regras definidas para o padrão de Mensagem Única da TOTVS. Os dados que serão sincronizados entre os sistemas integrados estarão contidos no arquivo XML, que deverá estar no padrão definido no esquema da Mensagem Única conforme XSD da TotvsMessage AdditionalEntitiesTypesAdditionalEntityType.
Na integração, as mensagens recebidas e enviadas pelo BackOffice serão processadas pelo adapter EAI do respectivo cadastro. O adapter é o responsável por processar essas mensagens e, se estiver configurada, acionar a rotina de integração para inclusão, alteração e/ou exclusão desse cadastro. Por sua vez, essa rotina será responsável por validar e gravar os dados de acordo com a operação que estiver sendo realizada e retornar para o adapter a mensagem de retorno do processamento (êxito ou falha) que, por fim, envia a mensagem de resposta ao sistema requisitante.
A manutenção (inclusão, alteração ou exclusão) de um registro desse cadastro será feita tanto pelo sistema de FrontOffice como pelo BackOffice, replicando os dados mutuamente. Portanto, o sistema de FrontOffice deverá levar em consideração a regra de negócio do cadastro.

Definição Técnica

 

  • A rotina TURA005 deve ser alterada para realizar a chamada para a rotina TURI005, que será utilizada para processar a Mensagem Única AdditionalEntityType. Para isso, deverá ser implementada a função IntegDef que deverá ser "Static", conforme definição da equipe de FrameWork.


Static Function IntegDef( cXML, nTypeTrans, cTypeMessage )
Local aRet := {}
aRet:= TURI005( cXml, nTypeTrans, cTypeMessage )
Return aRet

  • Acrescentar o campo G3E_MSBLQL na tabela G3E, conforme dicionário de dados abaixo;
  • Desenvolver o fonte TURI005, que fará todo o tratamento para o envio e recebimento do XML, da seguinte forma:


Function TURI005 ( cXML, nTypeTrans, cTypeMessage )
Local lRet     := .T.
Local cXMLRet  := ""
If nTypeTrans == TRANS_RECEIVE
If cTypeMessage == EAI_MESSAGE_BUSINESS
          cXMLRet := '<TAGX>TESTE DE RECEPCAO BUSINESS MESSAGE</TAGX>'
ElseIf cTypeMessage == EAI_MESSAGE_RESPONSE
          cXMLRet := '<TAGX>TESTE DE RECEPCAO RESPONSE MESSAGE</TAGX>'
ElseIf cTypeMessage == EAI_MESSAGE_WHOIS
          cXMLRet := ' <Version>1.0 </Version>'
Endif
ElseIf nTypeTrans == TRANS_SEND
     cXMLRet := '<TAGX>TESTE DE ENVIO</TAGX>'
EndIf
Return { lRet, cXMLRet }

  • No fonte TURI005, deve ser adicionado a diretiva de include para o arquivo FWADAPTEREAI.CH;
  • Microsigra Protheus recebe Mensagem Única:
    • Ao receber a mensagem de negócio (BusinessMessage), o EAI verificará se a rotina TURA005 está cadastrada no "Adapter EAI" e se a mesma está configurada para o recebimento de mensagem no método Síncrono. Caso a rotina esteja cadastrada e configurada corretamente, a função IntegDef deverá chamar a rotina TURI005 que fará o tratamento do XML recebido, e efetuar a gravação dos dados;
    • No final do processamento, deverá será enviada a mensagem de resposta (ResponseMessage) ao sistema requisitante com o status do processamento e, no caso de sucesso da operação INSERT, o valor da chave da entidade para atualização do respectivo DE/PARA;
  • Microsigra Protheus envia Mensagem Única:
    • Ao ser efetuada uma inclusão, alteração ou exclusão, será disparado um evento que verificará se a rotina TURA005 está cadastrada no "Adapter EAI" e se a mesma está configurada para o envio de mensagem no método Síncrono. Caso a rotina esteja cadastrada e configurada corretamente, a função IntegDef retornará o XML (BusinessMessage) ao EAI, que o enviará a mensagem ao sistema requisitante;
    • Após o sistema requisitante receber e processar a mensagem, deverá enviar a mensagem de resposta (ResponseMessage) ao Microsiga Protheus com o o status do processamento e, no caso de sucesso da operação INSERT, o valor da chave da entidade para atualização do respectivo DE/PARA;
  • Depois da alteração do fonte TURA005 e do desenvolvimento do fonte TURI005, acessar o módulo Configurador e cadastrar o adapter através do menu Ambiente -> Schedule -> Adapter E.a.i da seguinte forma:
    • Mensagem única: Sim;
    • Rotina: TURA005;
    • Mensagem: AdditionalEntityType;
    • Descrição: Tipos de Entidade Adicional;
    • Envia: Sim;
    • Recebe: Sim;
    • Método: Síncrono;
    • Operação: Todas;
    • Versão Envio: 1.000;
  • A seguir, detalhe dos campos do cadastro de Tipos de Entidades Adicional (tabela G3E) com as respectivas TAGS do TotvsMessage AdditionalEntitiesTypesAdditionalEntityTypes:

 

Tag Superior

TAG

Campo

Observação

BusinessContentType

CompanyId

 cEmpAnt

Código da Empresa

BusinessContentType

BranchId

G3E_FILIAL

Código da Filial

BusinessContentType

CompanyIternalId

 


InternalId da chave Empresa+Filial

BusinessContentType

Code

G3E_CODIGO

Código

BusinessContentType

InternalId 

cEmpAnt + G3E_FILIAL + G3E_CODIGO

InternalId do Tipo de Entidade Adicional

BusinessContentType

Description

G3E_DESCR

Descrição

BusinessContentType

BlockedSituation

G3E_MSBLQL

Bloqueado ( "1"-Sim / "2"-Não )



DICIONÁRIO DE DADOS

  • Arquivo SX3 – Campos da Tabela

     

    Campo

    G3E_MSBLQL

     

     

    Tipo

    C

     

     

    Tamanho

    1

     

     

    Contexto

    Real

     

     

    Propriedade

    Alterar

     

     

    Descrição

    Registro Bloqueado?

     

     

    Título

    Bloqueado 

     

    Help de Campo

    Define se registro está bloqueado ou não.

    Obrigatório

     

    Sim

    Usado

     

    Sim

    Browser

     

    Não

    Combo

     

    1=Sim;2=Não

    Validação

     

    Pertence("12")

    Inic. Padrão

     "2"

     

    Fluxo do Processo






    Protótipo de Tela (Figuras meramente ilustrativas)



    Browser do cadastro de Adpater E.a.i
    Âncora
    _GoBack
    _GoBack

    Formulário de Cadastro do Adapter E.a.i – TURA005