Itens de Conteúdo
Last updated
Was this helpful?
Last updated
Was this helpful?
As descrições e os modelos de documentos podem ser criados a partir da informação dos itens que compõem seus conteúdos.
Assim, a informação fica organizada na forma de uma lista na qual cada item descreve detalhadamente um dos campos que representam as informações dinâmicas ou os textos e formatações que são fixos.
O uso de itens de conteúdo pode ser feito tanto para compor a descrição do documento quanto para especificar seu modelo.
A seguir descreveremos cada um dos tipos de itens que podem ser utilizados para produzir as descrições ou modelos.
Utilize este tipo de item para incluir um longo texto fixo, ou seja, que não vai variar entre os documentos que serão produzidos nessa mesma tipologia.
A opção de texto curto tem o mesmo objetivo da opção acima. A única diferença é que o tamanho do campo é um pouco menor. Esta opção deve ser utilizada sempre que o texto for bem pequeno e não precisar de quebras de linha.
É muito comum ser necessário dar um espaço entre o texto e o próximo item de conteúdo. Deixar um espaço a mais no final do texto não resolveria esta situação pois o XRP remove todos os espaços extra no início e no final dos campos. Para acrescentar um espaço antes ou depois do texto utilize um underscore - "_". Por exemplo, use "Nome:_" para que o sistema deixe um espaço depois dos dois pontos.
Conforme a documentação do Markdown, em alguns casos é necessário deixar uma quebra de linha entre os itens de uma lista, por exemplo. Este tipo de item produz uma quebra de linha simples.
De acordo com o Markdown, uma quebra de linha dupla produz uma quebra de parágrafo. Utilize este tipo de item para essa finalidade.
Os campos representam a parte dinâmica do conteúdo e da descrição de cada documento criado. Eles vão variar de documento para documento. O sistema gerará um formulário que será preenchido pelo usuário com estas informações específicas sobre o documento que ele deseja criar ou editar. Depois, o sistema juntará os dados fornecidos pelo usuário com os textos fixos e produzirá a descrição e o conteúdo do documento.
Para utilizarmos os campos precisamos entender o conceito de variável. Na computação, uma variável é uma representação simbólica de um valor armazenado em uma posição de memória do computador.
A seguir descreveremos todos os parâmetros que são utilizados para definir um campo, descrevendo detalhadamente suas características.
Utilize o rótulo para informar o título que o campo deve possuir no formulário que será apresentado ao usuário, na hora de criar ou editar o documento.
Por exemplo, se desejarmos que o usuário informe um número de CPF, o rótulo poderia ser preenchido com "CPF" ou "Número do CPF".
Todo campo precisa ter um identificador único. Este será, para o sistema, o nome da variável que armazenará a informação que foi preenchida pelo usuário no formulário.
É importante que o identificador da variável comece sempre por uma letra minúscula e seja composto apenas por letras maiúsculas e minúscula não acentuadas, números e o símbolo de underscore.
Exemplos válidos de identificador são:
cpf
cpf_pessoa
cpfPessoa
cpf2
Exemplos inválidos são:
Cpf
CPF
cpf pessoa
cpf#
número
ação
Se dois campos tivessem o mesmo identificador, o sistema guardaria o valor informado na mesma posição de memória, fazendo com que, ao preencher um dos campos, o usuário estaria alterando o valor do outro, também. Quando o sistema detecta que existem na lista de conteúdo dois campos com o mesmo identificador, ele omite o segundo campo do formulário e considera que preenchendo o primeiro o segundo já será preenchido automaticamente.
Os valores armazenados em uma variável podem ser de vários tipos, incluindo números, cadeias de caracteres, valores booleanos (verdadeiro ou falso) e até mesmo outros tipos de dados mais complexos.
Texto - uma cadeia de caracteres qualquer. Pode armazenar o nome de uma pessoa ou qualquer outro texto simples, que seja contido em uma única linha.
Memo - uma cadeia de caracteres que pode conter mais de um parágrafo de texto. Por exemplo, uma justificativa ou o conteúdo de um despacho.
Data - dia, mês e ano.
Hora - hora, minuto e segundo.
Telefone - telefone fixo ou celular com código de área.
CEP - código de endereçamento postal.
CPF - número no Cadastro de Pessoas Físicas.
CNPJ - número no cadastro Nacional de Pessoas Jurídicas.
Órgão - código do órgão quando o sistema é configurado para atender a diferentes órgãos usuários.
Unidade - código da unidade organizacional como por exemplo: SG, SGP, etc.
Pessoa - matrícula e nome de um colaborador cadastrado no sistema.
Documento - número de algum documento pré-existente.
Indica se o campo é de preenchimento obrigatório ou se é opcional. Se nada for informado, o sistema considerará que o campo é opcional.
Obrigatório - o campo precisa ser preenchido pelo usuário.
Opcional - o usuário pode deixar em branco.
Deve ser utilizado para informar se este campo pode conter alguma informação protegida pela LGPD ou que por algum outro motivo deva ser tratada com mais cuidado. Se não for preenchido, o sistema considera que o campo não possui informação sensível. As opções são:
Pessoal
Pessoal Sensível
Sigiloso
Alguns parâmetros de configuração dos campos são usados com menos frequência. Para que eles sejam exibido e possam ser informado é necessário selecioná-los na lista de parâmetros adicionais. São eles:
Prefixo - permite que seja incluído um pequeno texto antes do campo. Lembre-se de usar underscore para representar espaços antes os depois do texto.
Sufixo - permite que seja incluído um pequeno texto depois do campo.
Dica - um texto explicativo que é disponibilizado no formulário, logo abaixo do campo. A dica ajuda o usuário a entender como o campo deve ser preenchido.
O campo de seleção é exatamente como um outro campo de texto qualquer, a única diferença é que ele não aceita um texto arbitrário. O usuário é obrigado a selecionar o texto de uma lista de opções que é fixa. Para parametrizar esta lista, o usuário pode criar uma ou mais opções.
Opção - texto fixo que pode ser selecionado pelo usuário no momento da criação ou edição do documento.
Além dos campos que são informados pelo usuário, alguns outros conteúdos dinâmicos podem ser produzidos com base no contexto de produção do documento e seus metadados. Por exemplo, podemos querer incluir em algum ponto da descrição o nome do subscritor ou a data do documento. Veja abaixo a lista completa de campos do sistema:
Subscritor: Nome - Nome do subscritor (assinante) do documento.
Subscritor: CPF - CPF do subscritor.
Subscritor: Cargo - Cargo do subscritor.
Subscritor: Função de Confiança - Função de confiança do subscritor. Por exemplo, diretor ou supervisor.
Destinatário: Nome - Nome do destinatário do documento.
Destinatário: CPF - CPF do destinatário.
Destinatário: Cargo - Cargo do destinatário.
Destinatário: Função de Confiança - Função de confiança do destinatário.
Data do Documento - no formato dd/mm/aaaa
Número do Documento - código que é utilizado para localizar o documento no sistema, por exemplo ACME-2023-MEM-000001
Em alguns casos, queremos que o documento tenha uma tabela com um número de linhas variável, onde serão informados vários itens. Por exemplo, podemos ter um documento que faz um pedido e nele existir uma tabela que discrimina cada um dos ítens que estão sendo pedidos e suas quantidades.
As tabelas têm um rótulo, um identificador e uma lista de colunas. Cada coluna tem um título e um "sub-campo" que pode ser do tipo "campo" ou "campo de seleção".
Rótulo - nome da tabela. De maneira gerar, esta informação não é usada no documento, mas sim no formulário, e só para agrupar os campos pertencentes a uma mesma tabela e diferenciá-los dos demais campos do formulário.
Identificador - Preencha este campo com o nome da variável que receberá a quantidade de linhas que a tabela deve possuir.
Coluna - Informe duas ou mais colunas para compor a tabela. Cada coluna tem um Titulo, um Tipo de campo e os parâmetros de configuração do campo conforme pode ser visto acima.
Indica uma divisão do formulário e é utilizado para agrupar campos que são correlatos. Por exemplo, um formulário pode ter uma divisão que trata da identificação do solicitante e outra que trata dos ítens que estão sendo pedidos.
Rótulo - é o título que será apresentado no formulário para identificar este agrupamento de campos
Se trata da mesma coisa que a divisão acima. A única diferença é que na divisão opcional o usuário pode dizer se quer ativá-la ou não. Quando é desativada, todos os campos que fazem parte desta divisão são omitidos no formulário e todos os texto e campos referentes no conteúdo do documento também são omitidos.
Rótulo - é o título que será apresentado no formulário para identificar este agrupamento de campos
Identificador - é o nome da variável que vai armazenar a informação de que esta divisão está ativa ou inativa
O comentário é um texto que será apresentado junto ao modelo do documento, mas só na visualização da tipologia. Ele pode ser usado para comunicar algum detalhe pontual sobre a tipologia que deve ser visualizado no próprio modelo. Por exemplo, se o modelo vai ser implementado em outro sistema, podemos usar comentários para nos comunicarmos com o desenvolvedor que fará a implementação.
Se um documento desta tipologia for criado no próprio sistema, o usuário não verá os comentários nem no formulário nem no conteúdo do documento.
Comentário - um texto que aparecerá apenas na visualização do modelo, no relatório de tipologias.
Além do texto propriamente dito, também é permitido utilizar comandos de formatação de acordo com o padrão Markdown. Para mais informações sobre Markdown, veja .