Árvore de páginas

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

Rotinas Envolvidas

Rotina

Tipo de Operação

Opção de Menu

TURA010.PRW

Alteração

Atualizações-> Cadastros-> Posto de Atendimento

TURI010.PRW

Criação

 

  

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

Integração Front – Posto de Atendimento

Objetivo


Integrar o cadastro de Posto de Atendimento 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 ServiceStation.

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 ServiceStation.
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 TURA010 deve ser alterada para realizar a chamada para a rotina TURI010, que será utilizada para processar a Mensagem Única ServiceStation. 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:= TURI010( cXml, nTypeTrans, cTypeMessage )
Return aRet

  • Desenvolver o fonte TURI010, que fará todo o tratamento para o envio e recebimento do XML, da seguinte forma:


Function TURI010 ( 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 TURI010, 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 TURA010 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 TURI010 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 TURA010 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 TURA010 e do desenvolvimento do fonte TURI010, 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: TURA010;
    • Mensagem: ServiceStation;
    • Descrição: Posto de Atendimento;
    • Envia: Sim;
    • Recebe: Sim;
    • Método: Síncrono;
    • Operação: Todas;
    • Versão Envio: 1.000;
  • A seguir, detalhe dos campos do cadastro de Posto de Atendimento (tabela G3M) com as respectivas TAGS do TotvsMessage ServiceStation:

 

Tag Superior

TAG

Campo

Observação

BusinessContentType

CompanyId

 

Código da Empresa

BusinessContentType

BranchId

G3M_FILIAL

Código da Filial

BusinessContentType

CompanyIternalId

 

InternalId da chave Empresa+Filial

BusinessContentType

Code

G3M_CODIGO

Código

BusinessContentType

InternalId

 

InternalId do Posto de Atendimento

BusinessContentType

Description

G3M_DESCR

Descrição

BusinessContentType

Address

 

Lista contendo os dados de endereço

AddressType

Address

G3M_END

Endereço

AddressType

Complement

G3M_COMPL

Complemento

AddressType

City

 

Lista contendo os dados de Cidade

CityType

CityCode

G3M_CODMUN

Código da cidade

CityType

CityInternalId

 

InternalId da Cidade

CityType

CityDescription

Posicione("G5S", 1, xFilial("G5S") + cCityCode, "G5S_CIDADE")

Nome da Cidade

AddressType

State

 

Lista contendo os dados de Estado

StateType

StateCode

G3M_EST

Código do estado

StateType

StateInternalId

 

InternalId do estado

StateType

StateDescription

POSICIONE("SX5",1,xFilial("SX5")+"12"+cState,"X5_DESCRI")

Nome do Estado

AddressType

ZIPCode

G3M_CEP

CEP

BusinessContentType

ListOfCommunicationInformation

 

Lista de comunicação

ListOfCommunicationInformationType

CommunicationInformation

 

Dados contendo informações para comunicação

CommunicationInformationType

PhoneNumber

G3M_DDI + G3M_DDD + G3M_FONE

Numero do Telefone

CommunicationInformationType

FaxNumber

G3M_DDI + G3M_DDD + G3M_FAX

Numero do Fax

CommunicationInformationType

HomePage

G3M_SITE

Site

CommunicationInformationType

Email

G3M_EMAIL

Email

BusinessContentType

IATA

G3M_NIATA

Número IATA

BusinessContentType

ShortIATA

G3M_ABREV

Abreviatura IATA

BusinessContentType

PCC

G3M_PCC

Código PCC

BusinessContentType

Situation

G3M_MSBLQL

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

 

Fluxo do Processo


Protótipo de Tela (Figuras meramente ilustrativas)



Browser do cadastro de Adpater E.a.i

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