TOTVS Logística Recintos Aduaneiros

Árvore de páginas

Versões comparadas

Versão antiga 7

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

Gravado em

comparado com

Nova versão 8

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.

...

Totvs custom tabs box
tabsPré-requisitos,Instalação,Configuração,Inicialização,Documentação Swagger,Inicialização
idsprerequisitos,instalacao,configuracao,inicializacao,documentacao
Totvs custom tabs box items
defaultyes
referenciaprerequisitos
  1. Sistema operacional Microsoft Windows Server 2012 ou superior e;
  2. 25MB de espaço em disco.
Totvs custom tabs box items
defaultno
referenciainstalacao

Para a instalação da solução, basta copiá-la para um diretório disponível no servidor alvo - como C:\TOTVS\SARA\Services\IntgraçãoBalanças, por exemplo - e comandar sua instalação através do comando abaixo, devendo ser executado por um usuário com privilégios administrativos:

C:\TOTVS\SARA\Services\IntgraçãoBalanças>TOTVSIntgBalanca.exe /install

É importante notar que a instalação pode ser parametrizada, fornecendo as configurações adequadas através de linha de comando, sendo:

ParâmetroDescriçãoExemplo
-hNome do servidor de banco de dados Microsoft SQL Server.-hSERVIDORBD\SQLSERVER2019
-pPorta de comunicação com o servidor de banco de dados Microsoft SQL Server.-p1433
-dNome do banco de dados a ser utilizado.-dsara_db
-uNome do usuário de banco de dados utilizado na conexão.-usa
-PSenha do usuário de banco de dados utilizado na conexão.-PTotvs@123456
-rPorta de comunicação da API fornecida pelo serviço de integração.-r4321

Sendo assim, um exemplo de instalação parametrizada via linha de comando seria:

C:\TOTVS\SARA\Services\IntgraçãoBalanças>TOTVSIntgBalanca.exe -hSERVIDORBD\SQLSERVER2019 -dsara_db -p1433 -usa -PTotvs@123456 -r9876 /install

NOTAS

  1. Quando a porta de comunicação da API fornecida pelo serviço de integração for escolhida no processo de instalação, a porta seguinte também deve estar livre, uma vez que a documentação Swagger da API será exibida através dela. Ex.: instalando o serviço com a porta 9876 para a API, a porta 9877 será disponibilizada para a documentação.
  2. Quando utilizando a versão legada do serviço, para que o novo serviço possa ser instalado, este deve ser parado e desativado no servidor afim de evitar a concorrência na conexão com as balanças integradas ou pelo consumo da porta de comunicação da API. Uma vez homologado o novo serviço, o serviço legado pode ser desinstalado por meio da linha de comando apropriada em um terminal com privilégios administrativos.
Totvs custom tabs box items
defaultno
referenciaconfiguracao
Após o término da instalação do serviço de integração - com a mensagem de sucesso sendo exibida pelo sistema operacional - é necessário realizar as configurações referentes ao serviço. Para isso, é necessário executar, com privilégios administrativos, o editor de registro do sistema Microsoft Windows, acessando a chave a seguir:

Computador\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\TOTVSIntgBalanca

Esta chave apresenta todas as configurações do serviço junto ao servidor e deve conter três subchaves: API, Database e Log. Cada uma destas subchaves contém um subgrupo de configurações, os quais devem conter os seguintes valores:

SubchaveConfiguraçãoFunção específicaValor padrãoPadrão do valor a ser inserido
APIAudienceValor de validação das restrições de uso da API de integração disponibilizada pelo serviço.Integração BalançasNenhum
APIDSContextValor de configuração da rota de acesso à API de integração disponibilizada pelo serviço.api/^[a-z0-9_]+\/$
APIIssuerValor de validação das restrições de uso da API de integração disponibilizada pelo serviço.SARANenhum
APIPortPorta TCP pela qual o serviço fará a exposição de sua API.43211~65535
APIRESTContextValor de configuração da rota de acesso à API de integração disponibilizada pelo serviço.sara/^[a-z0-9_]+\/$
DatabaseCharSetConjunto de caracteres utilizado pelo servidor Microsoft SQL Server.SQL_Latin1_General_CP1_CI_ASNenhum
DatabaseDatabaseNome do banco de dados usado pelo ecossistema TOTVS Recintos Aduaneiros.sara_dbNenhum
DatabaseDriverIDIdentificação do tipo de banco de dados a ser utilizado.MSSQLNenhum
DatabaseHostnameIndicação de localização do servidor Microsoft SQL Server.localhostNomeDoServidor\NomeDaInstância
DatabasePasswordSenha do usuário usado na integração para acesso ao banco de dados.Totvs@123Nenhum
DatabasePortPorta padrão de comunicação do servidor Microsoft SQL Server.14331~65535
DatabaseUsernameNome do usuário usado na integração para acesso ao banco de dados.saNenhum
LogLogFileCaminho completo para o arquivo de log da aplicação.C:\Temp\TOTVS\IntgBalanca\IntgBalanca_%s.log^[A-Z]{1}:\\([\w]+\\)+(IntgBalanca_%s\.log)$
Totvs custom tabs box items
defaultno
referenciainicializacao

Após efetuada a configuração dos parâmetros de operação do serviço, basta acessar o gestor de serviços do servidor e comandar sua inicialização.

Totvs custom tabs box items
defaultno
referenciadocumentacao

Ao instalar e iniciar o serviço de integração com balanças com comunicação via TCP/IP, este fornecerá um canal para acesso à sua documentação OpenAPI através da ferramenta Swagger inclusa no serviço. Conforme exemplo citado na seção de instalação, o serviço tendo sido instalado em um servidor cujo endereço IP seja 172.26.224.1 e a porta de comunicação seja 9876, o acesso à documentação se dá pela URL http://172.26.224.1:9877/docs, exibindo-a conforme visto abaixo:

Esta documentação permite que as respostas da API sejam testadas e validadas de forma rápida e simples. Contudo, os endpoints que contem com o parâmetro token, seja na URI - {token} - ou em seu corpo - nó token no objeto JSON passado na mensagem - não podem ser gerados senão pela equipe TOTVS durante o atendimento e os mesmos terão validade, máxima, de 30 minutos.

...