Árvore de páginas

Versões comparadas

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
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
Totvs custom tabs box
tabsInstalação manual,Instalação automatizada
idsmanual,automatizada
Totvs custom tabs box items
defaultyes
referenciamanual

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

NOTA

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
referenciaautomatizada

Este serviço conta, também, com um assistente de instalação automatizado, o qual pode ser obtido aqui. Este assistente permite que ao usuário instalar o novo serviço e suas dependências de maneira simples e rápida. Assim como na instalação manual, é possível configurar o novo serviço durante sua instalação, fornecendo, inclusive, informações não contempladas na instalação manual, sendo:

  1. Diretório de instalação (valor padrão: C:\TOTVS\Logística\Recintos Aduaneiros\Services\IntegraçãoBalanças);
  2.  API:
    1. IP de instalação do servidor (quando o servidor de destino contar com mais de um endereço IP);
    2. Porta de comunicação (valor padrão: 4321) e;
    3. Leitura cumulativa (valor padrão: desmarcada);
  3. Banco de dados:
    1. Servidor\Instância (sem valor padrão);
    2. Porta de comunicação (valor padrão: 1433);
    3. Banco de dados (valor padrão: sara_db);
    4. Usuário (valor padrão: sa) e;
    5. Senha (sem valor padrão);
  4. Log:
    1. Caminho para os arquivos de log (valor padrão: C:\Temp\TOTVS\Log\IntegraçãoBalanças);
    2. Log detalhado de erros (valor padrão: desmarcado) e;
    3. Log de eventos (valor padrão: desmarcado).

Vale ressaltar que a instalação ocorre de maneira sequencial, onde as informações são fornecidas conforme o usuário avança no processo de instalação. A escolha dos diretórios, tanto de instalação quanto de armazenamento dos arquivos de log é de escolha livre, sem a necessidade da observância dos valores padrão. Os demais valores sugeridos como valor padrão são os valores adotados por padrão no produto, mas podem ser alterados caso a implantação do ecossistema TLRA assim demande.

É importante lembrar que, para uma melhor experiência durante o processo de instalação, o assistente seja executado com privilégios administrativos, permitindo que este remova, sendo este o caso, o serviço legado e, ao fim do processo, comande a inicialização do novo serviço.

O assistente de instalação pode, também, ser executado através de linha de comando, com parametrização idêntica à utilizada para a instalação manual, fazendo com que os parâmetros de instalação venham preenchidos com os valores fornecidos na linha de comando. Além disso, o assistente pode promover a criação ou atualização1 do parâmetro BALANCA_SVC_HOST na base de dados, com os dados de endereço IP e porta de comunicação com o serviço sem a necessidade da interação direta do usuário.

NOTAS

  1. Caso o instalador seja incapaz de determinar o endereço IP do servidor, parâmetro não contará com esta informação, devendo o usuário informá-la manualmente. 
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\TOTVSIntegracaoBalancas

Esta chave apresenta todas as configurações do serviço junto ao servidor e deve conter três sub-chaves: APIDatabaseLog. Cada uma destas sub-chaves 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
APIPortPorta TCP pela qual o serviço fará a exposição de sua API.43211~65535
APICumulativeReadingFlag indicadora do parâmetro de leitura cumulativa do buffer de saída da balança.falsetrue/false
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)$
LogDetailedLogErrorLogFlag indicadora do parâmetro de registro de registros logs de log detalhadoserro.falsetrue/false
LogEventLogFlag indicadora do parâmetro de registro de logs de evento.falsetrue/false
Totvs custom tabs box items
defaultno
referenciainicializacao

Para o caso de instalação manual - quando não parametrizada, é necessário efetuar a configuração dos parâmetros de operação do serviço por meio do registro do sistema operacional -, ou em caso de falha na inicialização do serviço através do assistente, 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.25.48.1 e a porta de comunicação seja 9876, o acesso à documentação se dá pela URL http://172.25.48.1:9876/api/tlra/intgbalanca/v1/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, excetuando o endpoint /access/currentdatetime, é necessário autenticar-se para executar os demais métodos. O processo é simples e pode ser feito por meio de um usuário válido dentro do ecossistema TLRA.

São endpoints expostos pela API:

  • [GET] /access/balances: Obtém a lista de balanças integradas ao serviço.
  • [GET] /access/canconnecttodatabase: Verifica se o servidor está apto a se conectar ao banco de dados.
  • [GET] /access/connecttodatabase: Comanda a conexão do servidor com o banco de dados.
  • [GET] /access/currentdatetime: Requisita ao servidor a data e hora atualizadas.
  • [GET] /access/isconnectedtodatabase: Verifica se o servidor está conectado ao banco de dados.
  • [GET] /access/reloadbalances: Recarrega as configurações das balanças cadastradas no sistema.
  • [GET] /config/cumulativereading/{action}: Ativa/Desativa a leitura cumulativa do buffer de saída da balança. (activate/deactivate)
  • [GET] /config/detailedlogerrorlog/{action}: Ativa/Desativa os logs detalhados de erro do servidor. (activate/deactivate)
  • [GET] /config/eventlog/{action}: Ativa/Desativa os logs de eventos do servidor. (activate/deactivate)
  • [GET] /config/readconfig: Lê a configuração corrente do servidor.
  • [GET] /config/reloadconfig: Recarrega as configurações do serviço.
  • [GET] /reading/readweight/{balanca}: Lê o peso medido na balança solicitada. (nome_da_balanca)
  • [GET] /log/showlog/{date}: Mostra o log de eventos da data informada. (formato ISO YYYY-MM-DD)


04. DEMAIS INFORMAÇÕES

Para uma perfeita integração com o ecossistema TOTVS Logística Recintos Aduaneiros, este deve estar em sua versão 12.1.2411 ou superior para os módulos Operacional e Portaria, bem como o serviço do coletor de dados TELNET, uma vez que esta versão está preparada para a integração com este serviço. Em versões anteriores a esta, a tentativa de integração ocasionará falhas no processo de integração que podem paralisar o serviço de integração e, na pior das hipóteses, paralisar o servidor onde ele esteja abrigado.

...