Skip to end of metadata
Go to start of metadata

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.                                                             

  

Informações Gerais

 

Especificação

Produto

FRAMEWORK

Módulo:

EAI

Segmento Executor

 

Projeto1

R_FRW_FRW002

IRM

PCREQ-9646

Requisito1

PCREQ-9648

Subtarefa:

PDR_FRW_FRW002-52

Chamado2

 

País

(X ) Brasil  (  ) Argentina  (  ) Mexico  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colombia   (  ) Outro _____________.

Outros

<Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>.

Objetivo:

Melhorar as mensagens de erro do EAI e propor um mecanismo de geração e gravação de logs de execução de mensagens do EAI. 

 

Introdução

Será utilizado o padrão de SysLog para geração dos Logs do EAI.

Trata-se de um padrão definido pela Totvs para implementação de mecanismos de geração de logs.

Esse padrão foi implementado na Lib RM,  e atualmente diversos recursos da Lib utilizam o mesmo. ex: DataServers, Host, Process, Jobs, etc.


Definição da Regra de Negócio


1) - Regras para ativação do log do EAI:


a) Atributo "TRACESYSLOG":

O atributo "TRACESYSLOG" (disponível nos arquivos de configuração do Host) deve ser ativado (TRACESYSLOG" = true).

Isso possibilitará o uso do padrão SysLog nos processos do ERP, inclusive nas rotinas do EAI.


b) - Atributo "TRACESYSLOGDEBUG":

 

O atributo "TRACESYSDEBUG" (disponível nos arquivos de configuração do Host) permitirá que informações de debug sejam também logadas.

A ativação desse atributo permitirá a produção de logs mais detalhados, aumentando assim o volume dos logs gerados.


c) Atributo "TRACESYSLOGEAI":

Será criado o atributo "TRACESYSLOGEAI" nos arquivos de configuração do Host.

Por default, esse atributo estará desligado = "false". 

Quando estiver ligado = "true", as mensagens de log do EAI serão geradas e gravadas na nova tabela de Log do EAI "HcLogMensagem".

Caso contrário, nenhum log será gravado na tabela de log do EAI.


2) - Estrutura de tabelas


a) - Criação da tabela: HCMonitor.

      Uma linha nessa tabela indicará um "monitoramento de uma determinada ação no EAI". Basicamente essa tabela será usada para agrupar mensagens relacionadas;

   

        Informações principais:

          ID- Identificador do monitor
          IDPROCESSO Identificador do processo

Cenário:

      - Em um determinado cliente existem duas integrações mapeadas para a mensagem  "COSTCENTER 2.000" (mensagem de centro de custo);

               Integração A: RM ---> Protheus

               Integração B: RM —> DataSul

      - Ao cadastrar um centro de  custo no RM, ocorrerá o seguinte:

  • O EAI RM será chamado para executar o envio da mensagem de centro de custo;
  • Será gerada uma única linha na tabela HCMonitor (responsável em agrupar as mensagens geradas na fila);
  • Serão geradas duas linhas na fila HCFilaMensagem (uma linha para cada integração mapeada);

 

b)-   Criação da coluna "MonitorID" na tabela "HCFilaMensagem" com referência para tabela HCMonitor;

     As mensagens gravadas na fila (HCFilaMensagem) estarão vinculadas a uma informação de monitor (HCMonitor).

 

c) - Criação da tabela: HCLogMensagem.

   Todos os logs gerados para uma determinada mensagem serão gravados nessa tabela.

     Uma linha nessa tabela indicará uma única mensagem de log, ou seja, várias linhas serão incluídas nessa tabela para cada tentativa de execução da mensagem.

      Informações principais:

          UUID- Identificador da mensagem na fila
          SEQUENCIAL- Compor chave primária

         DATAMENSAGEM: Data e hora da geração do log

        LOCALIZACAO: região do eai que gerou a mensagem

        TIPOLOG : Tipo da mensagem de log [error, warning, info]

                    Info: 0 - Mensagem de informação

                   Warning: 1 - Mensagem de aviso

                  Error: 2 - Mensagem de erro

       INFOLOG: mensagem de log.

       INFODEBUG: Informações de debug. Nesse campo serão gravadas informações de valores de variáveis, propriedades de objetos, contextos existentes no momento da geração do log.


 

3) - Geração de logs customizados:


a) - Será disponibilizada na classe "HandleServices" (localizada no projeto: RM.Con.TotvsMessage.IServices" uma instância para o objeto "LogServices".

Um objeto da classe "HandleServices" está disponível atualmente nos extensions e estará disponível nas futuras classes de adapters.

 

b) - Será disponibilizado no objeto "LogServices" três métodos: 

       - WriteTraceInformation: responsável pelo envio de mensagens de informação;

       - WriteTraceError: responsável pelo envio de mensagens de erro;

      - WriteTraceWarning: responsável pelo envio de mensagens de aviso;

        Esses métodos recebem como parâmetro os seguintes dados:

    • Identificador do monitor : disponível no contexto global do EAI. (this.TotvsMessageContext.Monitor.MonitorId);
    • Mensagem de log: texto contendo a mensagem de log;
    • Informações de debug: Devem ser enviadas no seguinte formato: "Identificação da inf. de debug", "Valor da informação de debug";

 

   Segue abaixo um exemplo de criação customizada de logs nos adapters / extensions:



4) - Mapeamento dos logs gerados pela engine do EAI

Abaixo serão listados todos os logs a serem disponibilizados durante o processo de gravação e execução da mensagem. 

Todas as mensagens de erro logadas serão acompanhadas de seus respectivos erros técnicos (exceções geradas).

A coluna "Todas as marcas" indicará se o log deve ou não ser implementado nos EAIs das outras marcas.

 

a) - Informações de log disponibilizadas durante o processo de "Recebimento de mensagens":

Localização

Mensagem

Tipo de menagem

E - Erro

A - Aviso

I - Informação

Todas as marcas

Fila

INÍCIO DO PROCESSO DE SALVAR MENSAGEM DE RECEBIMENTO NA FILA

I

Sim

Fila

Xml recebido é válido

I

Sim

Fila

Xml recebido não é válido

E

Sim

FilaIntegrações recuperadas.ISim
FilaId da integração recuperadaINão
FilaNão foi possível localizar nenhuma integração.ESim
FilaNão foi encontrada nenhuma entidade mapeada.ENão
FilaMapa de integração carregado.INão
FilaErro ao carregar mapa de integração.ENão
FilaXSLT de entrada não foi preenchido.ENão
FilaRecebimento de mensagem assíncrona.ISim
FilaEvento CanSaveQueue será executado.INão
FilaMensagem gravada na fila.ISim
FilaErro ao salvar mensagem na fila.ESim
FilaFIM DO PROCESSO DE SALVAR MENSAGEM NA FILA.ISim
Inicializando execução INÍCIO DO PROCESSO DE EXECUÇÃO DA MENSAGEM DE RECEBIMENTO.Sim 
Inicializando execução Mensagem recuperada da fila.ISim
Validação de execuçãoNão foi encontrada nenhuma entidade mapeada.ENão
Validação de execuçãoMapa de integração carregado.INão
Validação de execuçãoErro ao carregar mapa da integração.ENão
Validação de execuçãoEvento CanExecuteQueue executadoINão
Validação de execuçãoEntidade não mapeadaENão
Validação de execuçãoXSLT de entrada não foi preenchido.ENão
Preparação de contextoPreparação de contexto. INão
Preparação de contextoColigada e filial recuperados.INão
Preparação de contextoAlterando código de todas as coligadas e filiais encontradas.INão
Preparação da execuçãoEvento BeforeExecuteHandle será executado.INão
Preparação da execuçãoInício da execução do manipulador (handle)INão
Preparação da execuçãoManipulador (Handle) de 'DataServer' definido!INão
Preparação da execuçãoManipulador (Handle) de 'Process' definido!INão
Preparação da execuçãoManipulador (Handle) de 'Module' definido!INão
Preparação da execuçãoManipulador (Handle) de 'CustomHandle' definido!INão
Preparação da execuçãoContexto da RM (RMSContext) criado:INão
Preparação da execuçãoInicio do processo de transformação via xslt!INão
Preparação da execuçãoEvento BeforeTransformReceive será executado!INão
Preparação da execuçãoEvento BeforeTransformReceive será executado!INão
Preparação da execuçãoEvento AfterTransformReceive será executado!INão'
Preparação da execuçãoEvento AfterTransformDataSet será executado!INão
Preparação da execuçãoFim do processo de transformaçaõ via xsltINão
Preparação da execuçãoDataSet está vazioENão
Executando handle de dataServerInício da execução do manipulador de Dataserver!INão
Executando handle de dataServerExecutando o dataServer + "Nome do dataServer"INão
Executando handle de dataServerEvento BeforeSave será executado!INão
Executando handle de dataServerSchema do dataServer recuperado!INão
Executando handle de dataServerInício da recuperação dos valores da chave primáriaINão
Executando handle de dataServerValor Chave primária:[serão informados os valores da chave primária"INão
Executando handle de dataServerFim da recuperação dos valores da chave primáriaINão
Executando handle de dataServerPreechimento dos relacionamentos!INão
Executando handle de dataServerLinha principal do dataSet em estado de exclusão!INão
Executando handle de dataServerLinha principal do dataSet em estado de alteração!INão
Executando handle de dataServerLinha principal do dataSet em estado de inclusão!INão
Executando handle de dataServerMétodo 'SaveRecord' do dataServer executado:INão
Atualização De/ParaAtualizando De/Para da tabela + "Nome da tabela"ISim
Atualização De/ParaA coluna 'INTERNALID' não existe no dataSet a ser enviado para o DataServer. O De/Para não será atualizado!ANão
Atualização De/ParaNão existe chave primária na tabela. O De/Para não será atualizado!ANão
Atualização De/ParaInformações do De/Para a serem gravados:[dados do de/para]ISim
Atualização De/ParaInformações do De/Para serão excluídasISim
Atualização De/ParaErro ao atualizar De/ParaESim
Executando handle de dataServerEvento AfterSave será executadoINão
Executando handle de dataServerFim da execução do manipulador de Dataserver!INão
Executando handle de ProcessoInício da execução do manipulador de processo.INão
Execução de handle de ProcessoEvento BeforeExecute será executadoINão
Execução de handle de ProcessoFim da execução do manipulador de processINão
Execução de handle de ProcessoEvento AfterExecute será executadoINão
Execução de handle de móduleInício da execução do manipulador de moduleINão
Execução de handle de móduleEvento BeforeExecuteMethod será executadoINão
Execução de handle de móduleEvento AfterExecuteMethod será executadoINão
Execução de handle de móduleFim da execução do manipulador de module!INão
Finalizando execuçãoErro ao executar manipulador (handle)ENão
Gerrando respostaInício da recuperação do xml de respostaINão
Gerrando respostaEvento CreateResponse será executadoI'Não
Gerrando respostaInício da construção da tag ReturnContent do dataServer!INão
Gerrando respostaInformações do internalId. Dados do internalIdISim
Gerrando respostaFim da construção da tag ReturnContent do dataServerINão
Gerrando respostaFim da recuperação do xml de respostaISim
Finalizando execuçãoFim da execução do manipulador (handle)INão
Finalizando execuçãoEvento AfterExecuteHandle será executado!INão
Finalizando execuçãoInformações de execução da mensagem foram gravadas na filaINão
Finalizando execuçãoInformações de execução da mensagem.ISim
Finalizando ExecuçãoFIM DO PROCESSO DE EXECUÇÃO DA MENSAGEM DE RECEBIMENTO!ISim
    

 

b) - Informações de log disponibilizadas durante o processo de "Envio de mensagens":

 

Localização

Mensagem

Tipo de menagem

(E) - Erro

A - (Aviso)

I - (Informação)

Todas as marcas

Fila

INÍCIO DO PROCESSO DE SALVAR MENSAGEM DE ENVIO NA FILA

I

Sim

FilaRecuperação das integraçõesISim
FilaMensagem não foi gravada na fila, pois não existe integração mapeada!ISim
FilaEntidade não foi mapeadaENão
FilaMapa de integração carregado.INão
FilaErro ao carregar mapa de integraçãoENão
FilaExecutando mensagem da integração. [Serão listados os dados da integração]INão
FilaEvento CanSaveQueue será executado!ENão
FilaMensagem gravada na filaISim
FilaErro ao salvar mensagem na filaESim
FilaDados da mensagem gravada. [Serão listados os dados da mensgem gravada na fila]ISim
FilaFIM DO PROCESSO DE SALVAR MENSAGEM DE ENVIO NA FILAISim
Inicializando execuçãoINICIO DO PROCESSO DE EXECUÇÃO DA MENSAGEM DE ENVIO NA FILA!ISim
Inicializando execuçãoMensagem recuperada da fila!ISim
Inicializando execuçãoExecução da mensagem de forma sincrona!ISim
Inicializando execuçãoExecução da mensagem de forma assincrona!ISim
Validação de execuçãoEntidade não mapeadaENão
Validação de execuçãoMapa de integração carregado.INão
Validação de execuçãoErro na carga de informaçõesENão
Validação de execuçãoEvento CanExecuteQueue será executado!INão
Preparação de contextoColigada não foi encontrada no dataSet enviado pelo produto!ANão
Preparação de contextoFilial não foi encontrada no dataSet enviado pelo produto!ANão
Preparação de contextoColigada e filial recuperadosINão
Preparação de contextoInício da execução do manipulador (handle)INão
Preparação de contextoInicio do processo de transformação via xslt!INão'
Preparação de contextoEvento BeforeTransformSend será executado!INão
Preparação de contextoEvento AfterTransformSend será executado!INão
Preparação de contextoFim do processo de transformação via xslt!INão
Execução handle WebServicesInício da execução do manipulador de WebServices!INão
Execução handle WebServicesEvento BeforeSendWebService será executado!INão
Execução handle WebServicesInicio da execução do webServices!INão
Execução handle WebServicesObjeto wsdl não gerado!ENão
Execução handle WebServicesInformações do assemblyProxy não encontradas!ENão
Execução handle WebServicesProxy não recuperado!ENão
Execução handle WebServicesFim da execução do webServices!ISim
Execução handle WebServicesEvento AfterSendWebService será executado!INão
Execução handle WebServicesErro ao executar manipulador (handle):ENão
Validação da respostaA resposta da execução do WebServices foi bem sucedida!ISim
Validação da respostaErro ao realizar parser da resposta da mensagem (ResponseMessage):ESim
Validação da respostaInformações retornadas na resposta da mensagem:[Serão listadas as informações retornas de InternalId]ISim
Atualização De/ParaInício do processo de salvar De/para!ISim
Atualização De/ParaAtributo 'ListOfInternalId' retornado no conteúdo da resposa da mensagem!ISim
Atualização De/ParaInformações do De/Para a ser gravado:[Serão listados dados do De/para]ISim
Atualização De/ParaTabela não existente no dataSet original da mensagem:ANão
Atualização De/ParaDe/para não atualizado. Indentificador do internalId não localizado na lista!ANão
Atualização De/ParaDe/Para excluído com sucesso!ISim
Atualização De/ParaExclusão de De/Para não retornou nenhum valor!ASim
Atualização De/ParaNão foi possível encontrar valores no de/para para exclusão!ASim
Atualização De/ParaValor do 'internalId' não foi encontrado!ANão
Atualização De/ParaCampo 'InternalId' não foi encontrado no dataSet de transformação!ANão
Atualização De/ParaCampos chaves do De/Para não foram informados!ANão
Atualização De/ParaNão foi encontrada a tabela no dataSet originalANão
Atualização De/ParaTabela não encontrada no dataSet original:ANão
Atualização De/ParaDe/para não atualizado. Atributo 'ListOfInternalId' não retornado no conteúdo da resposa da mensagem!ISim
Atualização De/ParaConteúdo da mensagem (ReturnContent) não retornado na resposta da mensagem. De/para não atualizado.ASim
Atualização De/ParaFim do processo de salvar De/para!ISim
Atualização De/ParaErro ao salvar tabela De-Para:ESim
Finalizando execuçãoFim da execução do manipulador (handle)INão
Finalizando execuçãoEvento AfterExecuteHandle será executado!INão
Finalizando execuçãoMensagem não foi executada.ISim
Finalizando execuçãoInformações de execução da mensagem [ Serão listados dados de status da execução]ISim
Finalizando execuçãoFIM DO PROCESSO DE EXECUÇÃO DA MENSAGEM DE ENVIO NA FILA!ISi

 

 

 

Dicionário de Dados

   

HCMONITOR

CAMPODESCRIÇÃOTIPO
IDIdentificador do monitorint
IDPROCESSO Identificador do processovarchar(255)
RECCREATEDBY Usuário de criaçãovarchar(50)
RECCREATEDON Data de criaçãodatetime
RECMODIFIEDBY Usuário de alteraçãovarchar(50)
RECMODIFIEDON Data de alteraçãodatetime

 

HCLOGMENSAGEM

CAMPODESCRIÇÃOTIPO
UUID Identificador da mensagem na filavarchar(255)
SEQUENCIAL Sequencialint
DATAMENSAGEM Data de geração da mensagemdatetime
TIPOLOG 

Tipo do Log

0 - Information

1 - Warning

2 - Error

int
LOCALIZACAOlocalização do log na engine do eaivarchar(100)
INFOLOG dados do logtext
INFODEBUGdados do debuggertext
RECCREATEDBYusuário de criaçãovarchar(50)
RECCREATEDON Data de criaçaõdatetime
RECMODIFIEDBY usuário de alteraçãovarchar(50)
RECMODIFIEDON data de alteraçãodatetime


Scripts:

CREATE TABLE HCMONITOR -- Monitor do EAI
(
ID VARCHAR(255) NOT NULL,--Identificador do nonitor
IDPROCESSO VARCHAR(255) NULL, --Identicador do processo
RECCREATEDBY VARCHAR(50) NULL,
RECCREATEDON DATETIME NULL,
RECMODIFIEDBY VARCHAR(50) NULL,
RECMODIFIEDON DATETIME NULL,
)

ALTER TABLE HCMONITOR
ADD CONSTRAINT PK_HCMONITOR PRIMARY KEY (ID)

CREATE TABLE HCLOGMENSAGEM -- Log de mensagens.
(
UUID VARCHAR(255) NOT NULL,--Identificador do log
SEQUENCIAL INT NOT NULL,--Número sequencial
DATAMENSAGEM DATETIME NULL, --Data de inclusão da mensagem.
TIPOLOG INT NULL, --Tipo do log [error, warning, info, danger]

LOCALIZACAO VARCHAR(100) NULL, --localização dolog na engine do eai
INFOLOG TEXT NULL,--Informações de Log do monitor

INFODEBUG TEXT NULL, --Informações de debug
RECCREATEDBY VARCHAR(50) NULL,
RECCREATEDON DATETIME NULL,
RECMODIFIEDBY VARCHAR(50) NULL,
RECMODIFIEDON DATETIME NULL,
)

ALTER TABLE HCLOGMENSAGEM
ADD CONSTRAINT PK_HCLOGMENSAGEM PRIMARY KEY(UUID, SEQUENCIAL)

ALTER TABLE HCLOGMENSAGEM
ADD CONSTRAINT FK_HCLOGMENSAGEM_HCFILAMENSAGEM FOREIGN KEY(UUID)
REFERENCES HCFILAMENSAGEM (UUID)

 

--ALTERAÇÕES NA TABELA DE FILA DE MENSAGEM
ALTER TABLE HCFILAMENSAGEM
ADD MONITORID VARCHAR(255) NULL --Identificador do monitor.

ALTER TABLE HCFILAMENSAGEM
ADD CONSTRAINT FK_HCFILAMENSAGEM_HCMONITOR FOREIGN KEY (MONITORID)
REFERENCES HCMONITOR(ID)

ALTER TABLE HCFILAMENSAGEM
ADD STATUSMENSAGEM INT NULL --Status da mensagem.

 

  

 

 


 

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.