Integração com driver SDK

O driver SDK deve ser instalado no cliente para que a integração com dispositivos que utilizam SDK ocorra com sucesso. Esse driver monitora a comunicação (on-line ou off-line) com todos os dispositivos conectados a ele, envia-lhes dados e informações e efetua os procedimentos necessários para sua integração com o sistema.

Para obter o driver SDK:

1. Realize o cadastro na tela de drivers e selecione o item SDK no campo Tipo do driver;
2. Em seguida, acesse a tela Downloads para baixar esse driver;
3. Descompacte o driver;
4. Para que o driver possa ser iniciado e parado através dos arquivos start-service.bat e stop-service.bat, respectivamente, crie esse serviço no Windows, utilizando o arquivo create-service.bat. A execução desse arquivo .bat deve ser feito com um usuário administrador do Windows.

Um driver SDK também pode exigir o cadastro de certas informações, dependendo dos dispositivos que ele atenderá. Esse cadastro deve ser feito na tela de propriedades extensíveis e, em seguida, selecionado na tela de drivers. Para mais informações sobre as propriedades exigidas, verifique a documentação do fabricante dos dispositivos.

A configuração do driver é feita no arquivo config.properties, que fica no diretório onde o driver foi descompactado. Esse arquivo também pode ser obtido pelo botão Baixar arquivo de configuração da tela de drivers. O arquivo possui as configurações padrão já preenchidas, mas, se for necessário alterar algum dos seus campos, utilize um editor de texto (Bloco de Notas, por exemplo) para abri-lo.

Links utilizados pelo SDK Proxy:

• http://sam.senior.com.br/download/driver_sdk/version.properties
• https://sam.senior.com.br/download/driver_sdk_java_25/last/SDKProxy.zip
• wss://sam-api.senior.com.br/websocket/pendency
• https://sam-api.senior.com.br/sdk/v1

A partir da versão 4.0.1 do SDK Proxy, ele passa a utilizar o Java 25 como requisito de execução ao invés do Java 8. Para migrar o SDK Proxy da versão baseada em Java 8 para a nova versão compatível com Java 25, execute os passos a seguir:

1. Instale o Java 25 JDK no ambiente em que o SDK Proxy será executado, utilizando o arquivo disponibilizado no site da Adoptium;
2. Após a instalação do Java, configure uma das variáveis de ambiente abaixo com o caminho da instalação do Java 25. O SDK Proxy utilizará uma dessas variáveis para localizar a instalação do Java no ambiente:
   • JAVA_HOME_PROXY_SDK
   • JAVA_HOME
   • JAVA_HOME_SAM
3. Remova o serviço da instalação anterior do SDK Proxy. Para isso, execute o arquivo Remove-service.bat que está localizado na pasta da instalação atual do SDK Proxy;
4. Antes de prosseguir com a nova instalação, faça uma cópia do arquivo config.properties, que contém os tokens e as chaves utilizados para a comunicação com os drivers dos fabricantes;
5. Faça o download da nova versão do SDK Proxy. O arquivo está disponível no menu Gestão de Riscos e Segurança | Ronda X > Downloads > SDK Proxy;
6. Na nova instalação, substitua o arquivo config.properties pela cópia que você fez no passo 4;
7. Execute o arquivo Create-service.bat para criar o serviço da nova versão do SDK Proxy;
8. Após a criação do serviço, inicie-o normalmente no ambiente.

• proxy.driver.port: porta que detecta as conexões do driver. Quando a propriedade não é encontrada no arquivo, o valor padrão é de 61000;
• sdk.connection.timeout: tempo máximo, em milissegundos, pelo qual o driver aguarda para estabelecer uma conexão com o Ronda Senior X. O valor mínimo sugerido é de 5000 milissegundos. Ele pode ser ajustado conforme a preferência do cliente, respeitando esse limite mínimo, especialmente em casos de instabilidade ou lentidão na conexão que possam prejudicar a comunicação entre o proxy e o SDK. Quando a propriedade não é encontrada no arquivo, o valor padrão é de 5000;
• sdk.request.timeout: tempo máximo, em milissegundos, do intervalo da consulta de pendências do driver ao Ronda Senior X. O valor mínimo sugerido é 5000 utilizando websocket, ou 120000 sem websocket. Quando a propriedade não é encontrada no arquivo, o valor padrão é de 5000;
• sdk.api_response.timeout: tempo máximo, em milissegundos, pelo qual o driver aguarda uma resposta de um serviço solicitado ao Ronda Senior X. O valor mínimo sugerido é de 5000 milissegundos, podendo ser ajustado conforme a preferência do cliente, desde que esse limite seja respeitado. Essa propriedade pode influenciar o desempenho caso o cliente tenha cadastros complexos em seu ambiente, o que pode aumentar o tempo de processamento das requisições pelo SDK. Nesses casos, recomenda-se configurar um valor mais alto para evitar falhas de comunicação com o proxy. Quando a propriedade não é encontrada no arquivo, o valor padrão é de 5000;
• sdk.driver0.driver_key: token do driver (disponível no cadastro de drivers). O proxy utiliza esse token para identificar o driver dentro do Ronda Senior X. Caso não encontre a chave sdk.driver0.driver_key, o proxy considera que não há driver configurado.

O proxy oferece suporte ao gerenciamento de múltiplos drivers, sempre começando pela chave sdk.driver0.driver_key, incrementando o índice para encontrar uma nova chave. Por exemplo, sdk.driver1.driver_key, sdk.driver2.driver_key, e assim sucessivamente, até que o índice seguinte não seja encontrado.

Essas configurações são enviadas aos dispositivos quando o driver SDK for iniciado e quando o comando Configurar dispositivo for enviado ao sistema.

Informações de pessoas, crachás, locais e permissões de acesso são enviadas ao dispositivo sempre que houver uma inclusão, alteração ou exclusão nesses dados. "Permissões de acesso" correspondem a todos os dados que definem se uma pessoa pode efetuar acesso em um dispositivo: papéis, níveis, faixas horárias e afins. Somente pessoas que possuam acesso permitido no dispositivo e não estejam bloqueadas são enviadas.

Ao enviar essas informações e configurações aos dispositivos, se a comunicação estiver off-line, esses dados serão enviados no momento em que a comunicação for restabelecida.

Os procedimentos efetuados pelo driver SDK (Software Development Kit) são registrados em arquivos de log, que podem ser acessados dentro da pasta onde o driver está instalado. Cada mensagem do log possui uma classificação dentre as seguintes:

• FATAL: mensagens que interrompem o funcionamento da aplicação, forçando o serviço ou o executável a ser reiniciado;
• ERROR: mensagens de mau funcionamento da aplicação, que deve ser analisada pela equipe técnica da Senior, porém, o serviço ou o executável continua executando;
• WARN: mensagens que indicam falha em cadastros ou nas configurações do sistema. Devem ser analisadas pelo administrador do sistema;
• INFO: mensagens de funcionamento normal do sistema, como evento recebido, pendência enviada etc., para efeitos informativos;
• DEBUG: mensagens de funcionamento interno de componentes do sistema (como timer iniciado, parâmetros lidos etc.) para efeitos informativos à equipe técnica da Senior. Esse nível de log deve ser habilitado somente em caso de problemas com o ambiente;
• TRACE: mensagens de funcionamento interno de componentes do sistema, com detalhes dos dados que estão sendo tratados.

Os aplicativos geram na pasta LOG um arquivo contendo os registros de log. Ao atingir 10 MB, esse arquivo é automaticamente compactado e alocado em uma pasta de backup, sendo criado um novo arquivo de registro na pasta de LOG.

A pasta de backup criada tem seu nome alterado para a data atual do compactamento do arquivo de log e, por ser cíclica, ela comporta um máximo de dez arquivos alocados, substituindo o arquivo mais antigo quando houver um novo arquivo que ultrapasse a capacidade máxima.

O SDK Proxy requer o JDK 25 para funcionar. Em ambientes que possuem outras versões do Java instaladas (por exemplo, Java 8, 11 ou 17 usados por outras aplicações), crie uma variável de ambiente exclusiva para o SDK Proxy, evitando alterar as variáveis Java compartilhadas do sistema:

1. Crie a variável de sistema JAVA_HOME_PROXY_SDK apontando para a pasta de instalação do JDK 25, por exemplo: C:\Program Files\Eclipse Adoptium\jdk-25.0.1-hotspot;
2. Execute o script create-service.bat para criar o serviço (executar como Administrador). Para aplicar atualizações a um serviço já existente, execute o script update-service.bat.

Ao criar o serviço, o SDK Proxy procura o Java nesta ordem, utilizando a primeira variável que apontar para um JDK 25 válido: JAVA_HOME_PROXY_SDK → JAVA_HOME_SAM → JAVA_HOME. Caso nenhuma delas aponte para o JDK 25, a criação do serviço é interrompida com uma mensagem indicando o ajuste necessário.