Formulários de Autoatendimento

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 alterações, como a necessidade de uma nova configuração de posto de trabalho em um escritório.

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

Usaremos um fluxo de trabalho para "indicar um novo animal de estimação" como exemplo.

Exemplo de Formulário

Usando Formulários

Usando o item de navegação, os usuários podem selecionar um formulário para preencher e enviar.

Seletor de Formulários

Quando um usuário preenche e envia um formulário, seu conteúdo será enviado por e-mail ao destinatário indicado na definição do formulário. O e-mail será enviado através da infraestrutura da RealmJoin e não terá origem nos endereços de e-mail da sua empresa.

Exemplo de e-mail de um formulário

Quando os Formulários de Autoatendimento estiverem ativados para seu locatário, todos os usuários poderão usar/enviar formulários.

Revisar Envíos

Usando o ícone de navegação, você pode revisar envios de formulários anteriores dos seus usuários.

Lista de Envios

Você pode buscar envios pelo nome de usuário que enviou e pelo nome do formulário, mas não por campos dentro do envio do formulário.

Clique em "Ver" 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

Lista de Formulários

Use "Novo Formulário" ou "Editar" para descrever o formulário usando JSON Schema. 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 à esquerda para dar ao seu formulário um nome descritivo. Use o campo à direita para nomear o endereço de e-mail do destinatário dos dados enviados pelo usuário.

Exemplo do Editor de Esquema

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

Pré-visualização do Editor

Após 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) para simplificar o processo.

Para dar pelo menos um ponto de partida, vamos examinar o esquema do nosso exemplo

{
  "title": "Person",
  "type": "object",
  "required": [
    "name",
    "date",
    "location",
    "pets"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "First and Last name",
      "minLength": 4,
      "default": "- Your Name here -"
    },
    "date": {
      "type": "string",
      "format": "date",
      "options": {
        "flatpickr": {}
      }
    },
    "location": {
      "type": "object",
      "title": "Location",
      "properties": {
        "city": {
          "type": "string",
          "default": "San Francisco"
        },
        "state": {
          "type": "string",
          "default": "CA"
        },
        "citystate": {
          "type": "string",
          "description": "This is generated automatically from the previous two fields",
          "template": "{{city}}, {{state}}",
          "watch": {
            "city": "location.city",
            "state": "location.state"
          }
        }
      }
    },
    "pets": {
      "type": "array",
      "format": "table",
      "title": "Pets",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "title": "Pet",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "cat",
              "dog",
              "bird",
              "reptile",
              "other"
            ],
            "default": "dog"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "default": [
        {
          "type": "dog",
          "name": "Walter"
        }
      ]
    }
  }
}

Todo JSON Schema consiste em objetos. Todo objeto tem que ter pelo menos um tipo e um nome.

Tipos

Objeto

"Objetos" "Complexos" que contêm outros objetos-filho devem usar o object tipo. No nosso exemplo, o nó raiz "Person" do esquema é deste tipo.

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

Use properties para descrever as características de cada campo necessário, isso inclui atribuir um tipo e um nome.

Array

Arrays permitem que você adicione múltiplos items semelhantes a uma lista. Use a items palavra-chave para descrever o tipo dos itens etc.

String

Apenas texto simples. Você pode preencher isso antecipadamente usando a padrão palavra-chave.

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