# Instalação e Configuração do Coletor de Marcação

## Visão Geral

Este módulo orienta a instalação e parametrização do Coletor de Marcação SURICATO TOTVS para sincronização de registros de ponto. 

O serviço já é compatível com outros ERPs de mercado, porém este manual aborda estritamente a integração TOTVS; os tutoriais para as demais plataformas homologadas serão disponibilizados em breve.

## Regra de Negócio

Para que o serviço de Coletor de Marcação SURICATO TOTVS funcione corretamente, é obrigatório atender aos seguintes requisitos:

* **Instalação Prévia:** O sistema SURICATO deve estar previamente instalado.
* **Presença de Diretório:** O diretório `SURICATOTotvsMarcacao` deve existir no caminho padrão de instalação.
* **Parametrização do Arquivo:** O arquivo `suricato-totvs-marcacao.properties` deve estar configurado corretamente.
* **Integridade de Chaves:** Todos os parâmetros obrigatórios do arquivo `.properties` devem existir e estar preenchidos conforme o ambiente.
* **Múltipla Conexão de Banco:** O arquivo `persistence.xml` deve conter as configurações corretas de conexão com o banco do SURICATO e do TOTVS.
* **Atualização do Pacote:** O arquivo `SURICATO-totvs-marcacao.jar` deve ser atualizado após qualquer alteração no `persistence.xml`.
* **Ciclo de Instalação:** O serviço de marcação só será instalado corretamente após a execução da `install.bat`.
* **Criptografia de Comunicação:** Caso seja utilizada comunicação segura, o parâmetro de SSL deve estar habilitado corretamente.

*O não cumprimento dessas regras pode impedir o envio das marcações para os sistemas TOTVS.*

## Como instalar e configurar o Serviço

Primeiramente, é necessário configurar o arquivo `.properties` do Suricato Marcação.

* Acesse o diretório abaixo:

```
C:\Program Files\Telematica\SURICATO\SURICATO-TOTVS\SURICATOTotvsMarcacao
```

* Localize o arquivo:  `suricato-totvs-marcacao.properties` e abra o arquivo utilizando um editor de texto.

<figure><img src="/files/JIM7Jh2ETDstZeRySyxM" alt=""><figcaption><p><em>suricato-ma-properties</em></p></figcaption></figure>

### Configuração dos Parâmetros

Verifique se os parâmetros abaixo existem no arquivo. Caso exista necessidade, edite os valores e salve o arquivo.

<table data-header-hidden><thead><tr><th width="292"></th><th></th></tr></thead><tbody><tr><td><strong>Parâmetro</strong></td><td><strong>Descrição / Valores Aceitos</strong></td></tr><tr><td><code>suricato-totvs-marcacao.timeout</code></td><td>Tempo limite da tentativa de coleta de marcações.</td></tr><tr><td><code>suricato-totvs-marcacao.limit</code></td><td>Limite de tentativas consecutivas que o sistema realizará para coletar as marcações.</td></tr><tr><td><code>suricato-totvs-marcacao.ssl</code></td><td>Ativação de certificado para comunicação via HTTPS (<code>TRUE</code>/<code>FALSE</code>).</td></tr><tr><td><code>portaria</code></td><td>Define a portaria de trabalho. Valor padrão: <code>617</code>. Para operar com a Portaria 671, remova o caractere <code>#</code> que antecede esta linha.</td></tr><tr><td><code>suricato-totvs.marcacao.api</code></td><td>Define se o serviço utilizará API para a coleta (<code>true</code> ou <code>false</code>).</td></tr><tr><td><code>totvs.method</code></td><td>Método de envio da marcação. Valores aceitos: <code>DB</code> (Banco de Dados) ou <code>WS</code> (WebService).</td></tr><tr><td><code>totvs.erp</code></td><td>Sistema TOTVS integrado no ambiente. Valores aceitos: <code>RM</code>, <code>Datasul</code> ou <code>Protheus</code>.</td></tr><tr><td><code>totvs.token.username</code></td><td>Usuário do token de requisição da API.</td></tr><tr><td><code>totvs.token.password</code></td><td>Senha do token de requisição da API.</td></tr><tr><td><code>totvs.token.url</code></td><td>URL do método de validação do token na API.</td></tr><tr><td><code>totvs.marcacao.send</code></td><td>Método responsável por enviar as marcações. Suporta protocolo HTTP ou HTTPS.</td></tr><tr><td><code>totvs.marcacao.version</code></td><td>Método utilizado para validar a versão da API.</td></tr></tbody></table>

<figure><img src="/files/I6miNQhaepSO40FV85i8" alt=""><figcaption><p><em>Note – suricato-ma-properties</em></p></figcaption></figure>

{% hint style="warning" %}

#### <mark style="color:red;">Observações:</mark>

* Para que o serviço de coletor de marcação funcione com a **Portaria 671**, é necessário retirar o caractere `#` do parâmetro **portaria** e salvar o arquivo.
* O parâmetro **totvs.marcacao.send** passou a aceitar protocolo **HTTPS** no link. Caso a API esteja utilizando esse recurso, o parâmetro deve ser ajustado conforme a necessidade do ambiente.
  {% endhint %}

### Configuração do arquivo JAR

{% stepper %}
{% step %}
Após salvar o arquivo `.properties`, volte para o diretório abaixo:

```
C:\Program Files\Telematica\SURICATO\SURICATO-TOTVS\SURICATOTotvsMarcacao
```

{% endstep %}

{% step %}
Localize o arquivo:

```
SURICATO-totvs-marcacao.jar
```

<figure><img src="/files/QG8pwuXQCvw6aCr9YsAG" alt=""><figcaption><p><em>Diretório – SURICATO TOTVS Marcação</em></p></figcaption></figure>
{% endstep %}

{% step %}
Abra o arquivo `SURICATO-totvs-marcacao.jar` utilizando o WinRAR e localize o arquivo:

```
persistence.xml
```

{% endstep %}

{% step %}
O caminho para localizar o arquivo é: `\META-INF`  &#x20;
{% endstep %}

{% step %}
Clique sobre o arquivo `SURICATO-totvs-marcacao.jar` e utilize o WinRAR para extrair o arquivo.

<figure><img src="/files/5ofm0j3qCS0s3OJnAvfx" alt=""><figcaption><p><em>Exemplo – Configurar Suricato-ma.jar</em></p></figcaption></figure>

<figure><img src="/files/zbQjRretoD3hW0Zb2lZA" alt=""><figcaption><p><em>Configurando – Property de Conexão SURICATO</em></p></figcaption></figure>
{% endstep %}

{% step %}
Edite o arquivo `persistence.xml.`
{% endstep %}

{% step %}
No primeiro bloco de código que contém a tag `<properties>`, deve ser realizada a configuração da conexão com o banco de dados do sistema SURICATO.

<figure><img src="/files/YWRfar2rVA9eV6NfGWdH" alt=""><figcaption><p><em>Configurando – Properties</em></p></figcaption></figure>
{% endstep %}

{% step %}
No segundo bloco de código que contém a tag `<properties>`, deve ser realizada a configuração da conexão com o banco de dados do sistema TOTVS.

<figure><img src="/files/FnwFrqNMiELcyMbL6a2Y" alt=""><figcaption><p><em>Configurando – Property de Conexão TOTVS</em></p></figcaption></figure>
{% endstep %}

{% step %}
Após finalizar as configurações do arquivo `persistence.xml`, salve o arquivo e substitua o original dentro do `SURICATO-totvs-marcacao.jar`.
{% endstep %}

{% step %}
Em seguida, execute a **bat install**, para que o serviço de marcação seja instalado corretamente.

<figure><img src="/files/oY70Oaj5hcR59GOxzsPZ" alt=""><figcaption><p><em>Instalando - SURICATO TOTVS Marcação</em></p></figcaption></figure>
{% endstep %}
{% endstepper %}

### Possíveis erros

* Erro **PKIX** path building failed:\
  **sun.security.provider.certpath.SunCertPathBuilderException:** unable to find valid certification path to requested target

Para corrigir esse erro, é necessário ativar o parâmetro:

```
suricato-totvs-marcacao.ssl = TRUE
```

Além disso, verifique se a URL configurada no parâmetro **recordClockMarking** está utilizando **HTTPS**, garantindo que a URL do WebService esteja correta e segura.

<a href="/pages/jAJB92OU1eqa8wuV55Yi" class="button primary">Clique aqui e Aprenda a configuração coringa de Conexão com o banco de dados - SQL</a>

## Glossário

* **JAR (Java Archive):** Arquivo compactado que contém classes Java e arquivos de configuração necessários para execução de um serviço.
* **SSL (Secure Sockets Layer):** Protocolo de segurança utilizado para criptografar a comunicação entre sistemas, geralmente associado ao uso de HTTPS.

## FAQ – Perguntas Frequentes

<details>

<summary>O serviço não envia as marcações para o TOTVS. O que verificar primeiro?</summary>

Verifique se o arquivo `suricato-totvs-marcacao.properties` está corretamente configurado e se todos os parâmetros obrigatórios estão preenchidos.

</details>

<details>

<summary>É necessário configurar o persistence.xml mesmo utilizando API?</summary>

Sim. O arquivo `persistence.xml` deve estar configurado corretamente para a conexão com os bancos do SURICATO e do TOTVS.

</details>

<details>

<summary>Utilizo a Portaria 671. O que preciso ajustar?</summary>

É necessário remover o caractere `#` do parâmetro **portaria** no arquivo `.properties` e salvar o arquivo.

</details>

<details>

<summary>Após alterar o persistence.xml, o serviço não funciona. O que pode ser?</summary>

Verifique se o arquivo alterado foi corretamente substituído dentro do `SURICATO-totvs-marcacao.jar` e se a `bat install` foi executada novamente.

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://software-telematica-com.gitbook.io/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-do-suricato/instalacao-e-configuracao-do-coletor-de-marcacao.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.