TOTVS Logística Recintos Aduaneiros

Árvore de páginas

Versões comparadas

Versão antiga 26

changes.mady.by.user Rodrigo Azanha

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Willian Jhonnes Lara Tuttoilmondo dos Santos

Gravado em

Chave

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

01. DADOS GERAIS


Produto:

Solucoes_totvs
SolucaoTOTVS Logística Recintos Aduaneiros

Solucoes_totvs_cross
SolucaoCross

Solucoes_totvs_parceiros
SolucaoParceiros

Solucoes_totvs_parceirosexptotvs
SolucaoParcsExpsTOTVS

Linha de Produto:

Linhas_totvs
SegmentoDistribuição
RegionConstrução Projetos
LinhaLinha Logix

Segmento:

Segmentos_totvs
SegmentoLogística

Módulo:EAI Service
Função:Serviço de integrações com sistemas externos

02. OBJETIVO

O EAI Service, é uma aplicação do tipo "Serviço Windows" desenvolvida para realizar a integração de dados do sistema TOTVS LOGÍSTICA RECINTOS ADUANEIROS com outros sistemas (aplicações externas).

...

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameDiagrama EAIService
simpleViewerfalse
width
diagramWidth711
revision3


03. DEMAIS INFORMAÇÕES

Totvs custom tabs box
tabsPré-requisitos,Instalação e Configuração, Integrações disponíveis, Monitoramento
ids0,1,2,3
Totvs custom tabs box items
defaultyes
referencia0

São pré-requisitos para a instalação do serviço EAI Service:

  1. Sistema operacional Microsoft Windows Server 2012 ou superior e;
  2. 500 MB de espaço em disco.

Instalando o serviço isoladamente

Quando da necessidade de instalação do serviço de maneira isolada do ecossistema TOTVS Logística Recintos Aduaneiros, os seguintes passos devem ser observados:

  1. Efetuar a cópia do diretório Redist, presente no ecossistema TLRA, para um caminho acessível no servidor de destino e;
  2. Incluir na variável de ambiente PATH, do sistema operacional, o caminho completo para os complementos constantes no diretório Redist\Win32 - Ex.: C:\TOTVS\SARA\Redist\Win32.

Para garantir o perfeito funcionamento do serviço, quando instalado, este requer:

  1. Microsoft .NET Framework 3.5 e suas dependências e;
  2. Visual C++ 2008 - e seguintes - e suas dependências.

Instalando o EAI Service em múltiplas instâncias

Quando da necessidade de instalação de múltiplas instâncias do EAI Service no mesmo servidor, as instruções referenciadas aqui devem ser observadas. Contudo, para facilitar os processos de implantação e atualização, os seguintes requisitos devem ser observados:

  1. As bibliotecas .BPL devem ser movidas para um diretório acessível no servidor de destino - Ex.: C:\TOTVS\SARA\Services\EAI Service\Lib;
  2. Cada instância do serviço deve ter seu diretório específico, contendo os demais arquivos - executável e arquivos de configuração - e contemplando o nome da instância - Ex.: C:\TOTVS\SARA\Services\EAI Service\Homologação - e;
  3. O caminho para as bibliotecas .BPL  deve estar na variável de ambiente PATH do sistema operacional;
Totvs custom tabs box items
defaultno
referencia1

Componentes

O serviço EAIService possui os seguintes componentes:

  • Módulos
    • EAIService.exe - Arquivo executável do serviço.
    • EAILog.bpl - Arquivo utilizado pelo "EAIService.exe" para a geração dos 'LOGs' do EAI no banco de dados.
  • Arquivo INI
    • EAIService.ini - Arquivo de inicialização configurado para o serviço.
    • Config.ini - Arquivo de inicialização configurado para o serviço. 

Instalação do serviço

A instalação do serviço EAIService poderá ser instalada utilizando a pasta "EXECUTAVEIS" onde contém os outros módulos do sistema, ou também poderá ser instalada em uma outra pasta, exemplo SERVICES.

Para a instalação do serviço na pasta "SERVICES", deverá ser seguido os seguintes passos:


1) A pasta SERVICES deverá ser criada no diretório que contém a pasta "EXECUTAVEIS" no servidor de arquivos do SARA.

Exemplo:


2) Na pasta "SERVICES", deverá ser criada a pasta "Config" e a pasta "EAIService"


3) Na pasta "Config", criar o arquivo CONFIG.INI com o conteúdo abaixo informando o servidor de banco de dados, a base de dados, um usuário do banco de dados para o serviço do EAI e a sua senha. Na chave FILE, também deverá ser informado os diretórios e arquivos de LOG. Por sugestão, criar a pasta LOG no diretório do EAIService.

Painel
titleConfig.ini


[CONNECTION]
databaseID=MSSQL
servername=
databasename=
user=
password=
[FILE]
ErrorLog=C:\TOTVS 12\SARA\SARA Server\SARA_10\SERVICES\EAIService\Log\error.log
LanguageLog=C:\TOTVS 12\SARA\SARA Server\SARA_10\SERVICES\EAIService\Log\language.log
ExecutionLog=C:\TOTVS 12\SARA\SARA Server\SARA_10\SERVICES\EAIService\Log\execution.log
[CONFIG]
RecordLogExecutionLevel=5
RecordLogExecution=1


4) Na pasta EAIService, copiar os arquivos "EAIService.exe" e "EAILog.bpl" distribuído no pacote do SARA dentro da pasta 'EXECUTAVEIS'.


5) Para a instalação do serviço é necessário que os arquivos de redistribuição das aplicações DELPHI estejam inclusas no PATH do Windows para não acusar erros de dependências de arquivos. Caso não esteja, executar o arquivo "Redist_SARA_Register.bat" como administrador conforme exemplo abaixo:

Após a execução, será necessário fechar o "prompt de comando" e abrir outro novamente.


6) Na pasta EAIService, abrir um prompt de comando como 'Administrador", e executar o comando para a instalação do serviço.

Exemplo:


Após a instalação será exibida a seguinte mensagem:


7) Após a instalação do serviço, será criado o arquivo "EAIService.ini" para configuração. Deverá ser editado o arquivo informando os dados de conexão do banco de dados, arquivos de LOG, e outras configurações. O campo FrequencyInSeconds determinará á frequência da verificação da fila de pendências do EAIService.

Painel
titleEAIService.ini

[FILESECURIT]
Active=0
[SHARECONNECTION]
configIni=';..\config\config.ini
[CONNECTION]
databaseID=MSSQL
servername=
databasename=
user=
password=
[FILE]
erviceExecution.log
ErrorLog=C:\TOTVS 12\SARA\SARA Server\SARA_10\SERVICES\EAIService\Log\error.log
LanguageLog=C:\TOTVS 12\SARA\SARA Server\SARA_10\SERVICES\EAIService\Log\language.log
ExecutionLog=C:\TOTVS 12\SARA\SARA Server\SARA_10\SERVICES\EAIService\Log\execution.log
[CONFIG]
language=pt-br
RecordLogExecutionLevel=5
RecordLogExecution=1
FrequencyInSeconds=10
[SERVER]
serviceName=TOTVS | SARA - EAI Service


8) Após a configuração do arquivo "EAIService.ini", o serviço poderá ser inicializado.


Na pasta configurada para o LOG no arquivo CONFIG.INI, será possível visualizar o arquivo de execução e saber se o serviço foi inicializado com sucesso.


Totvs custom tabs box
tabsDicionário de dados
ids11
Totvs custom tabs box items
defaultyes
referencia11

Diagrama

Tabelas

  • tab_eai_operation_system

Tabela de registro de operações do sistema SARA que servirão de gatilhos para algum tipo de integração com outro sistema.

  • tab_eai_external_application

Tabela de registro de aplicações externas que possuem integração com o sistema SARA.

  • tab_eai_transaction

Tabela de registro das transações/mensagens de uma determinada aplicação externa que possuem integração com o sistema SARA

  • tab_eai_adapter

Tabela de registro dos adaptadores que estão disponíveis para um determinada mensagem/transação.

Um adaptador é uma função do sistema desenvolvida para enviar, receber ou enviar/receber a mensagem. Uma mensagem poderá possuir um adaptador para envio e outro para recebimento se for o caso.

  • tab_eai_send_route

Tabela de registro da rotas habilitadas para a integração entre o SARA e as aplicações externas. 

Para o sistema A, poderá ser registrada uma rota somente para envio de informações da entidade de clientes, e para o sistema B, registrar uma rota somente para receber informações da entidade de clientes ou produtos.

As rotas poderão ser cadastradas de acordo com os adaptadores disponíveis para cada transação/mensagem.

  • tab_eai_send

Tabela de registro de filas para a integração, ou seja, para geração e envio da mensagem para uma determinada aplicação externa.

O registro nesta tabela são gerados pelo sistema SARA, de acordo com o gatilho vinculado a um determinado adaptador de uma mensagem/transação.

  • tab_eai_message

Tabela de registro das mensagens enviadas para uma determinada aplicação externa.

Por meio desta tabela é possível ver o conteúdo da mensagem de envio e o conteúdo da mensagem de retorno do processamento da aplicação externa, sabendo se a mensagem foi processada (integrada) com sucesso ou se houve erros na integração, e também o tipo de erro.

Totvs custom tabs box items
defaultno
referencia2

Para saber mais sobre cada integração deverão ser consultados os manuais disponibilizados abaixo:

1) Pucomex | Módulo CCT - Controle de Carga e Trânsito de Exportação

2) Pucomex | Módulo Recintos

Totvs custom tabs box items
defaultno
referencia3

Para realizar o monitoramento das integrações do TL Recintos Aduaneiros com outros sistemas por meio do EAIService, deverá ser instalado e utilizado o módulo "EAI Monitor Viewer" conforme manual disponível no link Módulo - EAI Monitor Viewer.


...