Histórico da Página

(Obrigatório)

Informações Gerais

Objetivo:

Melhorar as mensagens de erros 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 da RM.

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

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

Definição da Regra de Negócio

1) - Ativação 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 causará 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 = "Falsefalse". 

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

 ExemploCenário:

      - No RM o usuário cadastra um novo centro de custo (COSTCENTER 2.000); - Existem duas integrações Em um determinado cliente existem duas integrações mapeadas para a mensagem  COSTCENTER  "COSTCENTER 2.000; - O EAI 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;

     A mensagem gravada na fila (HCFilaMensagem) está vinculada a uma informação de monitor.

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
        TIPOLOG : Tipo da mensagem de log [error, warning, info, danger]

                Error: Mensagem de erro

               Warning: Mensagem de aviso

             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

              Danger: Perigo        INFOLOG Warning: mensagem de log.

       DEBUGINFO: Informações de debug

3) - 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. 

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

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".

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:

Image Added

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. 

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

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

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

4) - Procedimentos para geração de logs pelos produtos.

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

      Um objeto dessa classe já está disponível 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ções";

       - 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 em "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:

Image Removed

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

 Image Removed

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>. 

Dicionário de Dados

Image Added

HCMONITOR

HCLOGMENSAGEM

Dicionário de Dados

Image Removed

1) - 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;

        Estrutura:

          ID - Identificador do nonitor
          IDPROCESSO - Identificador do processo

 Exemplo:

a) - No RM o usuário cadastra um novo centro de custo (COSTCENTER 2.000);

b) - Existem duas integrações mapeadas para a mensagem  COSTCENTER 2.000;

c) - O EAI será chamado para executar o envio da mensagem de centro de custo;

d) - Será gerada uma única linha na tabela HCMonitor (contendo informações do processo);

d) - Serão geradas duas linhas na fila HCFilaMensagem (uma linha para cada integração mapeada);

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

3) - Será criada a 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.

        Estrutura:

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

         DATAMENSAGEM: Data e hora da geração do log
        TIPOLOG : Tipo da mensagem de log [error, warning, info, danger]

                Error: Mensagem de erro

               Warning: Mensagem de aviso

              Info: Mensagem de informação

              Danger: Perigo

       INFOLOG: mensagem de log.

Scripts:

CREATE TABLE HCMONITOR -- Monitor do EAI
(
ID VARCHAR(255) NOT NULL,--Identificador do nonitor
IDPROCESSO VARCHAR(100255) 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.