> For the complete documentation index, see [llms.txt](https://kb.stoque.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.stoque.com.br/zeevdocs/criar-bibliotecas/o-que-sao-regras-de-negocio/regra-para-consultar-documentos.md).

# Regra para consultar documentos

Esta regra representa a configuração do módulo de consulta de documentos, e é possível configurar quais campos serão apresentados para filtrar uma pesquisa, entre outros.

## Visão geral

Esta regra representa a configuração do módulo de consulta de documentos, e é possível configurar quais campos serão apresentados para filtrar uma pesquisa, quais colunas serão apresentadas na GRID de resultados, quantos resultados por página, quais serão as formas de pesquisa disponíveis, entre outros.

### Como configurar o módulo Consultar documento

O módulo 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 das principais funcionalidades do módulo.

{% hint style="info" %}
**Dica**: para saber mais sobre as abas "Campos", "Listas", "Botões" e "Script cliente" consulte a página de [configurações padrão](/zeevdocs/criar-bibliotecas/o-que-sao-regras-de-negocio/configuracoes-padrao-nas-regras-de-negocio.md) das regras de negócio.
{% endhint %}

#### Aba Resultado

A aba Resultado permite configurar:

* **Exibição de campos**: neste caso, do resultado da busca;
* **Quantidade de documentos por página**: quantidade de documentos que devem ser carregados por página no resultado da busca.
* **Exibição de documentos excluídos logicamente**: se marcado, os documentos excluídos pelos usuários serão ~~<mark style="color:red;">tachados</mark>~~ e exibidos na *interface* de consulta, possibilitando sua restauração antes da exclusão definitiva.
* **Ordenável:** habilita o campo para ser ordenável pontual e manualmente pelo usuário.
* **Ordenar**: ao carregar o resultado da consulta, SEMPRE será ordenado pelo campo em questão. É possível escolher 1 campo para ser ordenado.
* **Agrupável**: habilita o campo para ser agrupado pontual e manualmente pelo usuário.
* **Agrupar**: ao carregar o resultado da consulta, SEMPRE será agrupado pelo campo em questão. É possível escolher 1 campo para ser agrupado.

{% hint style="warning" %}
**Impotante**: não é recomendável configurar agrupamento para campos do tipo texto grande.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.stoque.com.br/zeevdocs/criar-bibliotecas/o-que-sao-regras-de-negocio/regra-para-consultar-documentos.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.