# Regra para monitorar/observar documentos
## Visão geral
Essa regra faz parte das que rodam em background, conforme comentamos nessa [página](/zeevdocs/criar-bibliotecas/o-que-sao-regras-de-negocio.md), ou seja, sua configuração não reflete a interface de algum módulo, por isso é chamada "regra do tipo **Serviço"**.
Ela é responsável por monitorar documentos, conforme critérios pré-estabelecidos, podendo realizar ações automatizadas, como:
* Excluir o documento;
* Notificar uma pessoa;
* Associar (bloquear) o documento para uma pessoa;
* Movimentar o documento de Etapa, Situação e Pendência;
* Acionar uma API.
## Como configurar a regra de Observação
O serviço possui diversas configurações que podem ser realizadas. Isso não significa que você deve utilizar todas as funcionalidades disponíveis.
Agora vamos te explicar o objetivo e comportamento de suas principais funcionalidades.
### Aba Geral
Na aba Geral é possível configurar:
* Recorrência de verificação (em horas) / (máximo 24 horas);
* Definir quantidade de documentos por ciclo a serem verificados;
* Habilitar a exclusão lógica do documento;
* Priorizar por ordem de data de inclusão do documento (ascendente ou descendente).
### Aba Critérios
Na aba Critérios é possível configurar os critérios da regra para realizar alguma ação.
#### Critério via campo do tipo Data
A ação será executada a partir do vencimento de um documento. E para calcular esse vencimento, é necessário definir a data de origem, ou seja, a partir de quando o prazo será contabilizado.
É possível definir a data de origem através dos campos:
* Data de inserção do documento (nativo do Zeev docs);
* Data de atualização do documento (nativo do Zeev docs);
* Campo de data customizado (criado pelo usuário na criação da biblioteca).
#### Como definir os prazos de vencimento dos documentos
1. **Dias fixos**: todos os documentos vencerão ao final dos dias configurados nesse campo, a contar a partir da data preenchida no campo selecionado anteriormente (Data de emissão);
2. **Temporalidade por tipo**: o vencimento dos documentos será dinâmico, conforme a [temporalidade do tipo selecionado](/zeevdocs/criar-bibliotecas/como-criar-grupos-e-tipos-de-documento.md#temporalidade-dos-documentos).
* Exemplo: se você tipificou um documento como "RG" e configurou sua temporalidade para 3650 dias (10 anos), o RG vencerá ao final desse período. Se importou outro tipo de documento, com outra temporalidade, ele vencerá ao final de sua temporalidade, e assim por diante.
#### Entendendo os operadores
Os operadores são utilizados para calcular o vencimento do documento, como no exemplo abaixo:
O resultado da seguinte soma: Data de emissão + a quantidade de dias, definido na regra, é menor ou igual à data de hoje? Se o resultado for negativo, então nenhuma ação é realizada. Se for positivo, quer dizer que o documento já venceu e a ação pode ser realizada.
Para facilitar a compreensão, vamos a um exemplo prático:
1. Importei no Zeev docs um documento com a seguinte data de emissão do contrato: 30/09/2023;
2. Defini que o prazo fixo para vencimento do contrato é de 180 dias;
3. Nos critérios da regra utilizei o operador menor ou igual: <=
4. Para simularmos, considere que atualmente estou no dia 30/10/2023
A regra de monitoramento realizará o seguinte cálculo:
* 30/09/2023 + 180 dias = 30/03/**2024**
Na sequência, realizará a seguinte validação:
* 30/03/**2024** é <= (menor ou igual) à data de hoje (30/10/2023)?
A resposta é "NÃO", pois a data de vencimento é maior. Logo, nenhuma ação será executada.
Quando chegar no dia 30/03/**2024** ele fará a mesma validação e a resposta será "SIM", pois esse dia será igual à data de vencimento do documento (30/03/**2024**). Entao a ação será executada.
{% hint style="info" %}
**Dicas**:
* No exemplo acima utilizamos dias fixos, porém, o mesmo cálculo é realizado quando usamos a temporalidade por tipo;
* Devido a maneira como a lógica foi desenvolvida deve ser usado somente os operadores: menor (<) e menor ou igual (<=).
{% endhint %}
A tabela abaixo contém outro exemplo de maneira ilustrativa para validar o comportamento.
### Aba Notificações
Na aba Notificações, caso os critérios sejam atendidos, é possível configurar para:
* Notificar usuários por e-mail;
* *Ad hoc* por usuário (bloquear o documento um usuário específico);
* Configurar requisições de métodos e retornos para *webservices*:
{% hint style="info" %}
**Dica**: para que a notificação por e-mail funcione corretamente, é necessário que os parâmetros SMTP do serviço de observação estejam configurados. Contate os canais de apoio da Zeev para validar essa configuração.
{% endhint %}
### Como determinar etapas de processamento
Para essa regra de negócio funcionar, é obrigatório configurar as etapas, situações e pendências do Processamento, Sucesso e Exceção.
Isso significa que a regra observará somente os documentos que estejam na etapa, situação e pendência configurada na coluna "**Processar**" e os enviará para a etapa, situação e pendência da coluna "**Sucesso**". Caso haja algum erro na execução da operação, enviará para as etapas da coluna "**Exceção**".
---
# 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://kb.stoque.com.br/zeevdocs/criar-bibliotecas/o-que-sao-regras-de-negocio/regra-para-monitorar-observar-documentos.md?ask=
```
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.