TOTVS Logística Recintos Aduaneiros

Árvore de páginas


01. DADOS GERAIS

Produto:

TOTVS Logística Recintos Aduaneiros

Linha de Produto:

Linha Logix

Segmento:

Logística

Módulo:Serviço de Integração - Recintos Aduaneiros
Função:Controle de Acesso
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :

DLOGPORTOS-19081


02. SITUAÇÃO/REQUISITO

Para possibilitar a integração de aplicações que controlam equipamentos responsáveis pelo controle de acesso ao ecossistema TOTVS Logística Recintos Aduaneiros, é disponibilizada uma API RESTful responsável por gerir as regras de controle de acesso, sem interação direta com os equipamentos controlados. Para que as solicitações de acesso realizadas nos equipamentos possam ser validadas pelo ecossistema TLRA, a solução que os controla deve integrar-se a esta API, utilizando-a como referência para validação ou invalidação do evento de acesso requisitado.

03. SOLUÇÃO

A solução, um módulo para o servidor web Apache, deve ser instalado e configurado em servidor da infraestrutura local de rede.

  1. Sistema operacional Microsoft Windows Server 2012 64 bits ou superior OU sistema operacional Linux 64 bits (kernel 6.x ou superior);
  2. 100MB de espaço em disco;
  3. Servidor web Apache Server 2.4.x para ambientes 64 bits;
  4. REDIS 5.0.14 ou superior para ambientes 64 bits.

Nota: Tanto o servidor web Apache quanto o servidor de banco de dados REDIS devem ser instalados previamente. Para mais informações sobre como instalar cada um destes requisitos em ambientes Microsoft Windows, consulte a seção Demais Informações deste documento.

Para a instalação da solução, basta copiar o módulo mod_totvs_access_control_v1.so para o diretório modules do Apache1. A configuração do servidor para uso do módulo varia conforme o sistema operacional e abaixo são mostradas as configurações para ambientes Windows e ambientes Linux baseados no padrão LSB.

A entrada abaixo deve ser incluída no arquivo httpd.conf constante na instalação do Apache:

httpd.conf
LoadModule totvs_access_control_module_v1 modules/mod_totvs_access_control_v1.so

<IfModule totvs_access_control_module_v1>
  <Location /api/tlra/accesscontrol/v1>
    SetHandler mod_totvs_access_control_v1-handler
  </Location>
</IfModule>

Após a inclusão das informações no arquivo de configuração e salvá-lo, basta (re)iniciar o servidor Apache para que o módulo seja carregado.

A entrada abaixo deve ser adicionada ao arquivo /etc/apache2/mods-available/totvs_access_control_v1.load:

totvs_access_control_v1.load
LoadModule totvs_access_control_module_v1 modules/mod_totvs_access_control_v1.so

A entrada abaixo deve ser adicionada ao arquivo /etc/apache2/mods-available/totvs_access_control_v1.conf:

totvs_access_control_v1.conf
<IfModule totvs_access_control_module_v1>
  <Location /api/tlra/accesscontrol/v1>
    SetHandler mod_totvs_access_control_v1-handler
  </Location>
</IfModule>

NOTAS:

  1. O diretório de módulos do servidor apache pode variar conforme sua instalação em ambientes Windows. Em ambientes Linux, o padrão é o diretório /usr/lib/apache2/modules.

O caminho para o arquivo de configuração do módulo varia conforme o sistema operacional escolhido1. Abaixo, seguem os caminhos indicados para cada sistema operacional.

  • Windows: C:\TOTVS\etc\accesscontrol\accesscontrol.conf
  • Linux: /etc/accesscontrol/accesscontrol.conf

O formato do arquivo é texto é apresentado conforme abaixo:

accesscontrol.conf
Hostname SERVIDOR\INSTANCIA
DriverID MSSQL
Database sara_db
Username sa
Password TOTVS@123456
Port 1433
CharSet SQL_Latin1_General_CP1_CI_AS

As configurações seguem a determinação descrita na tabela a seguir.

ParâmetroDescriçãoValor padrãoFormato
HostnameNome da instância/servidor do banco de dados Microsoft SQL Server.NenhumSERVIDOR\INSTÂNCIA
DriverID2Nome do driver de conexão usado pelo módulo.MSSQL^[A-Z]?$
DatabaseNome do banco de dados utilizado pelo ecossistema TLRA.sara_db^[\w]?$
UsernameNome do usuário utilizado na integração com o módulo.sa^[\w]?$
PasswordSenha utilizada pelo usuário referenciado no parâmetro Username.NenhumNenhum
PortPorta de comunicação TCP utilizada pelo servidor de banco de dados SQL Server.14331~65535
CharSet2Conjunto de caracteres usado na codificação dos dados constantes no banco de dados referenciado no parâmetro Database. SQL_Latin1_General_CP1_CI_ASNenhum

NOTAS:

  1. O diretório de configurações, assim como seu arquivo, devem ser previamente configurados, sob risco da geração de exceções durante o processo de inicialização do servidor Apache.
  2. Não é recomendada a alteração do valor parametrizado no arquivo.

Após a criação/alteração dos arquivos de configuração, tanto do servidor Apache quanto do módulo, basta executar a (re)inicialização do servidor web para que o módulo seja carregado e possa ser utilizado. Para ambientes Linux, recomenda-se a execução, via terminal, do comando abaixo, o qual habilita o módulo para uso e reinicia o servidor Apache.

$ sudo a2enmod totvs_access_control_v1 & sudo service apache2 restart


04. DEMAIS INFORMAÇÕES

Para uma perfeita integração com o sistema TOTVS Recintos Aduaneiros, este deve estar em sua versão 12.1.2407 ou superior.

Sobre o servidor web Apache para Windows: https://simplificandoredes.com/instalar-apache-em-windows/

Sobre o banco de dados REDIS para Windows: https://github.com/tporadowski/redis/releases