> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/pt/administracao-e-definicoes/self-service-forms.md).

# Formulários de autosserviço

Os Formulários de autosserviço do RealmJoin recolhem dados estruturados dos utilizadores, como relatórios de incidentes ou pedidos de alteração, depois de ativados pelo Suporte.

## Visão geral

Você pode usar Formulários de Autoatendimento para coletar dados estruturados dos usuários. Isso pode ser usado para permitir que os usuários relatem incidentes ou indiquem mudanças, como a necessidade de uma nova configuração de local de trabalho em um escritório.

"Formulários de Autoatendimento" é um recurso opcional que pode ser habilitado para o seu tenant pelo suporte do RealmJoin. Se não estiver habilitado, você ainda pode inserir/preparar formulários na página de configurações, mas os usuários não poderão ver/usar formulários de autoatendimento.

Usaremos um fluxo de trabalho para "indicar um novo pet" como exemplo.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2Fk4raaucFdNBWERFd1K7V%2Fimage.png?alt=media&amp;token=1e3f9fb5-66eb-405e-962f-ba1adab495b6" alt=""><figcaption><p>Exemplo de formulário</p></figcaption></figure>

## Usando formulários

Usando o ![](https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FEoSZwvVn9NMFPA1LgGVn%2Fimage.png?alt=media\&token=0ef42605-f332-45bc-8a1d-503b842f8c12) item de navegação, os usuários podem selecionar um formulário para preencher e enviar.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FPUnJnLhYCdcgI9aTfJew%2Fimage.png?alt=media&amp;token=6455eb83-923f-4a39-b871-43d73f2d43c5" alt=""><figcaption><p>Seletor de formulário</p></figcaption></figure>

Quando um usuário preenche e envia um formulário, seu conteúdo será enviado por e-mail para o destinatário informado na definição do formulário. O e-mail será enviado pela infraestrutura do RealmJoin e não se originará dos endereços de e-mail da sua empresa.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FOk30wlZKDMEe3MWvzxS1%2Fimage.png?alt=media&amp;token=c40cb2ea-113c-4b4f-9da0-ff085a808b65" alt=""><figcaption><p>E-mail de exemplo de um formulário</p></figcaption></figure>

{% hint style="info" %}
Quando Formulários de Autoatendimento estão habilitados para o seu tenant, todos os usuários podem usar / enviar formulários.
{% endhint %}

## Revisar envios

Usando o ![](https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FzLUitkjFFMieHZaQppjS%2Fimage.png?alt=media\&token=bb07172e-904c-459d-a9a8-e73c48f18ae6) ícone de navegação, você pode revisar envios anteriores de formulários dos seus usuários.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FhW7xAk19PilNZOMOGodf%2Fimage.png?alt=media&amp;token=adc9d2ba-359a-4fa1-b272-996d354c6b4f" alt=""><figcaption><p>Lista de envios</p></figcaption></figure>

Você pode pesquisar envios pelo nome de usuário do remetente e pelo nome do formulário, mas não pelos campos no envio do formulário.

Clique em "Visualizar" para ver os dados do formulário preenchido. A visualização é somente leitura.

## Página de configurações

A página de configurações de Formulários de Autoatendimento permite gerenciar formulários existentes, adicionar, editar e excluir formulários.

### Lista de formulários na página de configurações

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FYfij5VCCe1WNBYeIe1Jl%2Fimage.png?alt=media&amp;token=e6f11b7c-8a3e-42ba-aeaf-57f6b5fa8b08" alt=""><figcaption><p>Lista de formulários</p></figcaption></figure>

Use "Novo Formulário" ou "Editar" para descrever o formulário usando [JSON Schema](https://json-schema.org/). Isso define quais campos precisam ser preenchidos e quais valores são válidos. A interface oferece um editor com verificação de sintaxe e uma pré-visualização do formulário resultante.

O esquema será usado para criar dinamicamente um formulário para o usuário. Basicamente, use o esquema não apenas para descrever os dados desejados, mas também para criar implicitamente a interface do formulário.

### Editor de esquema

Acima do editor há dois campos. Use o campo da esquerda para dar ao seu formulário um nome descritivo. Use o campo da direita para indicar o endereço de e-mail do destinatário dos dados submetidos pelo usuário.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FlDKKa8gI37FWDapkH2xh%2Fimage.png?alt=media&amp;token=d13dbe12-150a-4503-ba1c-50d637962498" alt=""><figcaption><p>Exemplo do editor de esquema</p></figcaption></figure>

Você pode usar "Atualizar pré-visualização do formulário JSON" para criar uma pré-visualização do formulário resultante abaixo do editor.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FPqMhyTDusXhcaIcafvFu%2Fimage.png?alt=media&amp;token=f04e8882-1d3c-4bd4-a032-2af26f763e59" alt=""><figcaption><p>Pré-visualização do editor</p></figcaption></figure>

Depois de modificar o esquema, pressione "Enviar" para salvar suas alterações. Será exibido um erro se a verificação de sintaxe falhar.

## JSON Schema

O uso de JSON Schema está fora do escopo deste documento. Você pode usar geradores de esquema online (como [este](https://www.jsonschema.net/app)) para simplificar o processo.

Para fornecer ao menos um ponto de partida, vamos examinar o esquema do nosso exemplo

```json
{
  "title": "Pessoa",
  "type": "object",
  "required": [
    "name",
    "date",
    "location",
    "pets"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Nome e sobrenome",
      "minLength": 4,
      "default": "- Seu nome aqui -"
    },
    "date": {
      "type": "string",
      "format": "date",
      "options": {
        "flatpickr": {}
      }
    },
    "location": {
      "type": "object",
      "title": "Localização",
      "properties": {
        "city": {
          "type": "string",
          "default": "San Francisco"
        },
        "state": {
          "type": "string",
          "default": "CA"
        },
        "citystate": {
          "type": "string",
          "description": "Isso é gerado automaticamente a partir dos dois campos anteriores",
          "template": "{{city}}, {{state}}",
          "watch": {
            "city": "location.city",
            "state": "location.state"
          }
        }
      }
    },
    "pets": {
      "type": "array",
      "format": "table",
      "title": "Animais de estimação",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "title": "Animal de estimação",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "gato",
              "cão",
              "pássaro",
              "réptil",
              "outro"
            ],
            "default": "cão"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "default": [
        {
          "type": "cão",
          "name": "Walter"
        }
      ]
    }
  }
}
```

Todo JSON Schema consiste em objetos. Todo objeto precisa, no mínimo, ter um tipo e um nome.

### Tipos

#### Objeto

"Objetos" complexos que contenham outros subobjetos devem usar o **object** tipo. No nosso exemplo, o nó raiz "Pessoa" do esquema é desse tipo.

Você pode definir campos obrigatórios usando a **required** palavra-chave. Esses campos também precisam ser definidos no esquema.

Utilize **properties** para descrever os recursos necessários de cada campo, isso inclui atribuir um tipo e um nome.

#### Array

Arrays permitem adicionar vários itens semelhantes **itens** a uma lista. Use a **itens** palavra-chave para descrever o tipo dos itens etc.

#### Texto

Apenas texto simples. Você pode preencher isso previamente usando a **predefinição** palavra-chave.

Para permitir apenas certos valores, você pode usar a **enum** palavra-chave.


---

# 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://docs.realmjoin.com/pt/administracao-e-definicoes/self-service-forms.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.
