Campos
O campo de um formulário é o elemento chave na definição do formulário em si. Um campo representa a unidade de informação que será trabalhada na renderização de um formulário na tela.
As operações de criação, edição e remoção de campos são disponibilizadas na interface do Admin console e serão tratadas nas páginas subsequentes.
Tipos de campos
Um Campo de um Formulário pode ser de um dos 13 tipos disponíveis, que são:
String
Usado pra armazenar um valor textual simples, como um nome, um CPF, etc.
Número
Usado para armazenar um valor numérico qualquer.
CheckBox
Usado pra armazenar um valor booleano, como sim ou não, verdadeiro ou falso, etc.
TextArea
Usado pra armazenar um valor textual extenso como uma descrição, ou uma observação, etc.
Data
Usado pra armazenar um valor de data.
Lista
Usado pra armazenar um valor dentre uma lista fixa de valores possíveis.
Organização
Usado pra armazenar um valor de uma organização dentre as existentes.
Usuário
Usado pra armazenar um valor de um usuário dentre os existentes.
Nome de usuário
Usado pra armazenar um valor de nome de usuário possivelmente gerado por uma política de nome de usuário.
Categoria
Usado pra armazenar um valor de uma categoria existente de recurso ou direito.
Classificação
Usado pra armazenar um valor de uma classificação existente de recurso ou direito.
Ambiente
Usado pra armazenar um valor de um ambiente existente de recurso.
Recurso
Usado pra armazenar um valor de um recurso existente.
Criando um campo no formulário
Para criar um campo de um formulário, você deverá acessar a aba Campos, na página do Formulário. Os seguintes passos devem ser seguidos:
Autentique-se no Admin console
Acione o menu Plataforma > Workspace > Geral > Formulários
Busque pelo formulário que se deseja criar um Campo, e clique na linha do mesmo
Na página de detalhamento do formulário, acesse a aba Campos
Acione o botão Novo para adicionar um campo ao formulário
Na caixa de diálogo, especifique o Nome, Label, o Campo para bind e o Tipo do campo que será criado no formulário
Acione o botão Salvar
Nota
Após a criação de um campo, com os atributos básicos, o mesmo pode ser editado conforme a necessidade.
Editando um campo no formulário
Um campo de um formulário pode ser editado a qualquer momento e você deverá seguir os passos:
Autentique-se no Admin console
Acione o menu Plataforma > Workspace > Geral > Formulários
Busque pelo formulário que se deseja editar um Campo, e clique na linha do mesmo
Na página de detalhamento do formulário, acesse a aba Campos
Clique no Campo que se deseja editar
Na caixa de diálogo, na aba Detalhes, edite as configurações do Campo conforme a necessidade
Acione o botão Salvar
Editando configurações específicas de cada tipo de campo
Na caixa de diálogo, na aba Detalhes, ainda é possível configurar informações específicas de cada tipo de Campo.
Para isso, acione o botão de configurações (
), ao lado direito da configuração de Tipo do campo. Após configurar, acione o botão Salvar.
Configurando validações do campo
Cada campo do formulário pode ter associado a ele um script de validação. Esse script de validação, será executado no momento de se validar os dados do formulário, quando de sua renderização em tela.
Pra configurar esse script, basta você acessar a aba Validações, na caixa de diálogo de detalhamento do Campo e digitar o script em Bean Shell.
Removendo um campo no formulário
Você poderá remover Campos de um Formulário de forma simples e apenas seguindo os passos:
Autentique-se no Admin console
Acione o menu Plataforma > Workspace > Geral > Formulários
Busque pelo Formulário que se deseja remover um campo, e clique na linha do mesmo
Na página de detalhamento do formulário, acesse a aba Campos
Selecione o(s) campo(s) que será(ão) removido(s)
Acione o botão Remover
Na caixa de diálogo, acione o botão Confirmar
Ordenando campos do formulário
A ordem que os campos de um Formulário é apresentada na tela, quando o Formulário é renderizado, é a mesma ordem que os campos são apresentados durante a criação.
No entanto você poderá re-ordenar os Campos de um Formulário de forma simples, na tela de listagem dos campos, apenas seguindo os passos:
Autentique-se no Admin console
Acione o menu Plataforma > Workspace > Geral > Formulários
Busque pelo Formulário que se deseja remover um campo, e clique na linha do mesmo
Na página de detalhamento do formulário, acesse a aba Campos
Na linha do Campo que se deseja reposicionar, clique no símbolo (
) e arraste o campo até onde deseja e solte
Pronto, você acaba de reposicionar um campo num Formulário.
Nota
A ordem do campo no Formulário respeita a ordem das seções do mesmo, e isso é feito de forma automática. Logo, pode ser necessário reposicionar em algumas situações, a Seção antes.
Propriedades de um campo
A funcionalidade do Formulário conta com vários tipos de Campos, como tipo String, Data, Número, etc, e cada tipo de Campo conta com um conjunto padrão de propriedades.
As propriedades padrão de todos os tipos de campos são as disponíveis na tela de edição de um campo e podem ser vistas na figura a seguir:
Conforme a figura acima, as propriedades padrão são:
Nome*
Representa o nome interno do campo.
Ajuda
Texto que serve de ajuda para o usuário quando da renderização do formulário.
Campo para bind*
Representa o nome do campo no qual será aplicado o valor após preenchimento e envio dos valores do formulário.
Obrigatório
Define se o valor do campo será de preenchimento obrigatório ou não.
Label*
Representa o texto que será renderizado como rótulo do campo na tela.
Tipo*
Representa o tipo do valor do campo.
Seção*
Representa a seção que o campo está incluído.
Esconder
Define se o campo será ou não renderizado na tela.
Além das propriedades padrão de todo tipo de Campo do Formulário, cada tipo ainda pode ter propriedades específicas.
Configurando propriedades específicas de cada tipo de campo
Algumas propriedades são específicas de cada tipo de campo, essas propriedades específicas podem ser acessadas a partir do botão de configurações (
) do lado direito da propriedade Tipo, conforme a figura anterior.
Vamos ver, pra cada tipo, as propriedades específicas que você pode configurar:
Campo do tipo String:
Máscara
Uma máscara pra formatar o valor do campo.
Valor padrão
Uma string padrão.
Campo do tipo Número:
Valor padrão
Um número padrão.
Campo do tipo CheckBox:
Valor padrão
True ou false.
Campo do tipo TextArea:
Não tem propriedade específica.
Campo do tipo Data:
Valor padrão
Uma data padrão
Campo do tipo Lista:
A lista
Uma lista de valores possíveis para o campo.
Campo do tipo Organização:
Tipo da organização
Pode ser um dos tipos dentre Organização, Departamento ou Centro de custo.
Campo do tipo Usuário:
Filtro
Uma string que irá ser usada para filtragem sobre os usuários.
Campo do tipo Nome de usuário:
Sugestões de quantidade
Um número inteiro positivo que indica quantas sugestões de nome de usuário serão geradas.
Política de nome de usuário
A política de nome de usuário que sera aplicada.
Habilitar entrada do usuário
Se habilita ou não o usuário a entrar com um nome de usuário qualquer.
Campo do tipo Categoria:
Tipo da entrada
Se é pra entrada do tipo Recurso ou pra Direito.
Seleção múltipla
Se é permitido seleção múltipla ou não de valores.
Campo do tipo Classificação:
Tipo da entrada
Se é pra entrada do tipo Recurso ou pra Direito.
Seleção múltipla
Se é permitido seleção múltipla ou não de valores.
Campo do tipo Ambiente:
Seleção múltipla
Se é permitido seleção múltipla ou não de valores.
Campo do tipo Recurso:
Tipos
Filtrar os recursos que serão mostrados no campo, pelos tipos, quando renderizado na tela.
Categorias
Filtrar os recursos que serão mostrados no campo, pelas categorias, quando renderizado na tela.
Classificações
Filtrar os recursos que serão mostrados no campo, pelas classificações, quando renderizado na tela.
Ambientes
Filtrar os recursos que serão mostrados no campo, pelos ambientes, quando renderizado na tela.
Tags
Filtrar os recursos que serão mostrados no campo, pelas tags, quando renderizado na tela.
Validação de um campo
Você pode definir uma validação para um campo de um formulário.
Essa validação é definida como scripts em BeanShell e será executada sempre que o valor de um campo renderizado for editado.
O script de validação de um campo pode acessar os dados do próprio campo apenas. No script o valor do campo será acessado como um variável com o nome do campo ou com o nome padrão "value".
Abaixo um exemplo de um script de validação de um campo do tipo String com o nome "cpf":
if (value == null) {
return "Valor do campo cpf não pode ser nulo.";
}
if (cpf.length() < 11) {
return "Campo cpf com formato incorreto.";
}
return true;Nota
Caso o script de validação dê como saída um texto qualquer, a validação desse campos será considerada com erro e o texto será usado como resposta da validação e apresentado para o usuário durante o preenchimento do campo do formulário. Caso o script dê como saída um valor booleano true, então será considerado como válido.
Usando propriedades específicas de alguns campos
Alguns campos do formulário possuem propriedades específicas e elas podem ser acessadas no script. Esses campos são:
Organization
Representa uma unidade de organização no diretório do Blazon, que pode ser de um dos tipos: ORGANIZATION, DEPARTMENT ou COST_CENTER
User
Representa um usuário do diretório do Blazon.
List
Representa uma lista de valores com seus respectivos rótulos.
Username
Representa um nome de usuário no Blazon.
Cada um desses campos apresenta propriedades específicas, são elas:
Propriedades do campo Organization
name
Contém o nome da organização selecionada no campo.
type
Contém o tipo da organização selecionada no campo.
identifier
Contém o identificador da organização selecionada no campo.
Propriedades do campo User
displayName
Contém o nome de apresentação do usuário do Blazon selecionado no campo.
username
Contém o nome de usuário do usuário do Blazon selecionado no campo.
identifier
Contém o identificador do usuário do Blazon selecionada no campo.
Propriedades do campo List
label
Contém o rótulo do item da lista selecionado no campo.
value
Contém o valor do item da lista selecionado no campo.
Propriedades do campo Username
username
Contém o nome de usuário selecionado no campo.
value
Contém o nome de usuário selecionado no campo.
Exemplo de um script de validação usando propriedade específica
Como definido acima, o campo do tipo "Organization" contem 3 propriedades específicas: name, type e identifier.
Abaixo um exemplo de como um script de validação pode usar uma dessas propriedades:
if (organization.name == null || organization.name.isEmpty()) {
return "Campo organization não pode ser nulo.";
}
return true;Serviços disponíveis para um script de validação de campo
Os scripts de validação de campo possuem à disposição 3 serviços que permitem acesso às informações do diretório do Blazon para efetivação de algumas validações do tipo:
"Existe um usuário com o mesmo cpf definido no campo CPF?"
Esses serviços são os mesmos serviços disponíveis para os scripts de validação do formulário e estão documentados na página:
Manipulador de um campo
Você pode definir um manipulador para um campo de um formulário.
Esse manipulador é definida como scripts em BeanShell e será executada imediatamente antes que o valor de um campo renderizado for editado.
O script de manipulação de um campo pode acessar os dados do próprio campo apenas. No script o valor do campo será acessado como um variável com o nome do campo ou com o nome padrão "value".
Abaixo um exemplo de um script de manipulação, que formata o valor, de um campo do tipo String com o nome "cpf":
try {
String pattern = "###.###.###-##";
javax.swing.text.MaskFormatter mask = new javax.swing.text.MaskFormatter(pattern);
mask.setValueContainsLiteralCharacters(false);
cpf = mask.valueToString(cpf);
} catch (Exception e) {
//nothing here
}Nota
O script de manipulação serve basicamente pra manipular o valor do campo e esse valor pode ser manipulado atribuindo-se um novo valor para uma variável com o nome do campo (como no exemplo acima) ou através do retorno do próprio script.
Usando propriedades específicas de alguns campos
Alguns campos do formulário possuem propriedades específicas e elas podem ser acessadas no script de manipulação. Esses campos são:
Organization
Representa uma unidade de organização no diretório do Blazon, que pode ser de um dos tipos: ORGANIZATION, DEPARTMENT ou COST_CENTER
User
Representa um usuário do diretório do Blazon.
List
Representa uma lista de valores com seus respectivos rótulos.
Username
Representa um nome de usuário no Blazon.
Cada um desses campos apresenta propriedades específicas, são elas:
Propriedades do campo Organization
name
Contém o nome da organização selecionada no campo.
type
Contém o tipo da organização selecionada no campo.
identifier
Contém o identificador da organização selecionada no campo.
Propriedades do campo User
displayName
Contém o nome de apresentação do usuário do Blazon selecionado no campo.
username
Contém o nome de usuário do usuário do Blazon selecionado no campo.
identifier
Contém o identificador do usuário do Blazon selecionada no campo.
Propriedades do campo List
label
Contém o rótulo do item da lista selecionado no campo.
value
Contém o valor do item da lista selecionado no campo.
Propriedades do campo Username
username
Contém o nome de usuário selecionado no campo.
value
Contém o nome de usuário selecionado no campo.
Exemplo de um script de manipulação usando propriedade específica
Como definido acima, o campo do tipo "Organization" contem 3 propriedades específicas: name, type e identifier.
Abaixo um exemplo de como um script de manipulação pode usar uma dessas propriedades:
if (organization.type != null && organization.name != null) {
return organization.name.toLowerCase() + "_" + organization.type.toLowerCase();
}Serviços disponíveis para um script de manipulação de campo
Os scripts de manipulação de campo possuem à disposição 3 serviços que permitem acesso às informações do diretório do Blazon para efetivação de algumas manipulações.
Esses serviços são os mesmos serviços disponíveis para os scripts de manipulação do formulário e estão documentados na página:
Atualizado
Isto foi útil?