Esta seção explica como configurar campos de entrada para consultas agregadas. Estes campos são exibidos como opções de filtro ao executar uma consulta agregada. Devem ser cadastrados em um conjunto InputFields, onde um nó Field é utilizado para cadastrar cada campo de entrada (veja abaixo).
Cada nó Field deve conter os seguintes elementos obrigatórios:
• ID: identificador único do campo, a ser utilizado ao longo da configuração. Este atribute deve ser o único no escopo do conjunto. Quando a consulta agregada é executada, cada campo de entrada será enviado na solicitação para a fonte de dados no formato de uma variável com o mesmo valor desse ID. Esse comportamento é adotado a não ser que existam mapeamentos de entrada configurados, conforme descrito no Apêndice -> Configurações para consultas agregadas-> Cadastramento de consultas agregadas -> Como configurar campos de entrada para uma consulta agregada.
• DisplayName: texto a ser exibido para o campo de entrada no sistema ao executar a consulta agregada.
• Type: tipo de campo de entrada. Atualmente, o único tipo disponível é "Text".
O nó Field deve possuir a seguinte estrutura XML:
<Field ID="campo1" DisplayName="Campo 1" Type="Text">
…validation configurations…
</Field>
Validações para cada campo de entrada também podem ser configuradas. Essas podem ser utilizadas para indicar campos obrigatórios ou para prevenir que usuários insiram conteúdo inválido nos campos de busca (através de máscaras de expressão regular). Quando as condições especificadas nas validações não são atendidas, uma mensagem de erro é exibida debaixo do campo (veja abaixo).
A tabela abaixo lista os tipos de validações que podem ser criadas, como também uma descrição de cada uma.
Nome |
Descrição |
Mask |
Define uma máscara de expressão regular para o campo de entrada, definido através de um formato especifico de valores literais e definições de máscara. Qualquer caractere não definido na lista abaixo será considerado um valor literal: a: Representa um caractere alfabético (A-Z, a-z) 9: Representa um caractere numérico (0-9) *: Representa um caractere alfanumérico (A-Z, a-z, 0-9)
Internamente, o masked-input-plugin também é utilizado. Para maiores detalhes, veja a documentação no plugin no link http://digitalbush.com/projects/masked-input-plugin/. |
IsRequired |
Indica se o campo é obrigatório. Valores válidos: "True" ou "False". |
IsEmail |
Indica se o valor a ser inserido deve ser um endereço de e-mail. Valores válidos: "True" ou "False". |
IsUrl |
Indica se o valor a ser inserido deve ser uma URL. Valores válidos: "True" ou "False". |
IsCPF |
Indica se o valor a ser inserido deve ser um CPF. Valores válidos: "True" ou "False". |
IsDateBr |
Indica se o valor a ser inserido deve ser uma data no formato mm/dd/aaaa. Valores válidos: "True" ou "False". |
IsNumeric |
Indica se o valor a ser inserido deve ser um número, que pode conter uma vírgula, um ponto e um sinal negativo na frente. Valores válidos: "True" ou "False". |
IsDigitsOnly |
Indica se o valor a ser inserido deve ser composto de dígitos numéricos. Valores válidos: "True" ou "False". |
Regex |
Define uma máscara de expressão regular customizada para validar o valor inserido. O valor deve ser uma máscara de expressão válida JavaScript. |
MinLength |
Indica a quantidade mínima de caracteres que deve ser inserida. O valor deve ser um número inteiro, indicando a quantidade. |
MaxLength |
Indica a quantidade máxima de caracteres que deve ser inserida. O valor deve ser um número inteiro, indicando a quantidade. |
NumericMinValue |
Se o valor a ser inserido é numérico, indica o valor mínimo válido. O valor deve ser um número real, indicando o valor mínimo. |
NumericMaxValue |
Se o valor a ser inserido é numérico, indica o valor máximo válido. O valor deve ser um número real, indicando o valor máximo. |
Quando preenchido com validações, o nó Field deve a seguinte estrutura:
<Field ID="cpf" DisplayName="CPF" Type="Text">
<IsRequired>True</IsRequired>
<IsSSN>True</True>
</Field>