Atributos da tela do formulário de entrada para entradas

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 16 min. de leitura
  • Diferentes tipos de entradas estão disponíveis para uso em telas de formulário de entrada e você pode usar diferentes atributos para configurar as entradas.

    Use atributos de entrada para definir a aparência e definir limitações em suas entradas. Os exemplos incluem a definição de valores mínimos e máximos ou a exibição de um valor de entrada como uma porcentagem.

    Nota:
    Todos os atributos fazem distinção entre maiúsculas e minúsculas.

    Atributo geral

    Você pode usar este atributo com qualquer tela de formulário de entrada, independentemente do tipo de entrada.

    Atributo Descrição
    DescriptionRenderType Defina um tipo de renderizador para a descrição de entrada.

    html: permite que você use marcadores HTML para formatar o texto no campo Descrição da sua entrada.

    DataSourceId Defina este atributo sempre que você criar um mecanismo de fonte de dados para carregar valores de entrada. Para obter mais informações, consulte Fontes de dados.
    Nota:
    Este atributo não é compatível com entradas de assinatura.
    ElementIdentifier Defina este atributo sempre que você criar um mecanismo de fonte de dados para carregar valores de entrada. Para obter mais informações, consulte Fontes de dados.
    Nota:
    Este atributo não é compatível com entradas de assinatura.

    Entradas de anexo

    Use entradas de anexo para permitir que os usuários anexem arquivos em uma tela de formulário de entrada. As entradas de anexo exigem um item de ação com script e um objeto actionResult para carregar um arquivo.
    Nota:
    As entradas de anexo são compatíveis somente com ações com script.
    Exemplo de entrada de anexo.
    A seguir está um exemplo de código que contém entradas de anexo.
    (function WriteBackAction(parm_input, parm_variable, actionResult) {
    
      //other write-back inputs and variables here
    
        actionResult.addAttachment("attach", "incident", gr.getUniqueValue()); //where "attach" is the input name from above screenshot, and “incident” is the table name
    
    })(parm_input, parm_variable, actionResult); 
    
    Restringir origens de anexo a usuários
    Você tem a opção de limitar as origens dos anexos para garantir que as imagens sejam obtidas de um ou de todos os seguintes:
    • no local por meio de uma câmera
    • da galeria do telefone do usuário
    • do sistema de arquivos do usuário

    No registro de atributo de entrada, selecione HiddenAttachmentSources. Selecione câmera, arquivos ou galeriano campo Valor e selecione Salvar. Repita o processo se quiser incluir mais de uma origem de anexo. Para obter mais informações, consulte Definir origens de anexo disponíveis para usuários.

    Atributo Descrição
    HiddenAttachmentSources Decida de onde você não deseja que as imagens sejam obtidas. Selecione um dos seguintes valores de origem: câmera, arquivos ou galeria, no campo Valor.
    Nota:
    Para evitar que imagens e arquivos sejam obtidos de mais de uma origem, adicione atributos HiddenAttachmentSources adicionais depois de salvar o atributo que você está configurando no momento.

    Entradas de código de barras

    Use entradas de código de barras para verificar um ou vários códigos de barras. Códigos de barras são códigos legíveis por máquina na forma de números e um padrão de linhas paralelas de larguras variadas. Esses códigos são usados para identificar itens como produtos, peças ou ativos. Você pode usar este tipo de entrada para inserir informações sobre itens em sua instância ServiceNow usando seu aplicativo para celular.

    • As entradas de código de barras podem ser configuradas para verificações únicas, verificações múltiplas ou verificações agrupadas. As verificações únicas permitem que o usuário verifique apenas uma vez. Nesse caso, o usuário deve verificar novamente tocando no ícone de verificação, o que limpa o valor de verificação. Você não precisa configurar um atributo para uma única entrada de código de barras de verificação.
    • As entradas de verificação múltipla podem ser configuradas com o atributo MaxEntries. Se a entrada de código de barras da tela do formulário de entrada estiver configurada com o atributo MaxEntries, os usuários poderão verificar rapidamente vários códigos de barras sequencialmente sem sair da interface de verificação.
    • As verificações agrupadas podem ser configuradas para verificar vários códigos de barras associados a um ativo que deve ser agrupado em um conjunto. Para configurar uma entrada de código de barras agrupado, você deve criar uma seção de código de barras na tela do formulário de entrada que tenha somente entradas de código de barras. Em seguida, o atributo section MaxEntries deve ser configurado para a seção de código de barras agrupado para que os usuários possam verificar vários grupos de códigos de barras.
    Figura 1. Leitura de código de barras em um aplicativo para celular
    Exemplos de leitura de código de barras com um aplicativo para celular.
    Você pode usar este atributo com entradas de código de barras.
    Atributo Descrição
    MaxEntries Usado somente para configurar a verificação múltipla e vários grupos de códigos de barras. Define o número máximo de códigos de barras que um usuário pode verificar por vez. Por exemplo, você pode definir o valor como 5 para permitir que os usuários verifiquem novamente 5 vezes.
    Nota:
    Use este atributo somente para entradas de código de barras de verificação múltipla. Se a entrada do código de barras for destinada a verificações únicas, nenhum atributo será necessário.

    Para obter informações sobre como criar uma tela de formulário de entrada com entradas de código de barras, consulte Configurar telas de formulário de entrada com entradas de código de barras de varredura única e múltipla e Configurar telas de formulário de entrada com entradas de código de barras de verificação agrupadas.

    Entradas boolianas

    Use entradas boolianas para entradas com valores verdadeiro ou falso. Você pode configurar entradas boolianas para aparecerem como uma caixa de seleção ou como um comutador de alternância.

    Exemplos de entradas boolianas configuradas como caixa de seleção ou comutador de alternância.

    Você pode usar esses atributos com entradas boolianas.

    Atributo Descrição
    RenderType Especifique um tipo de renderizador para a entrada booliana.
    Caixa de seleção
    Exibe a entrada como uma caixa de seleção.
    seletor
    Exibe a entrada como uma alternância.

    Entradas de opção

    Use entradas de escolha para dar aos usuários opções de seleção. Você pode criar essas opções manualmente ou usar uma tabela e um campo existentes para fornecer as opções.

    Configure uma entrada de opção para permitir que os usuários selecionem uma ou várias opções. A opção de selecionar mais de um chip em uma categoria é marcada por um sinal + nos chips.

    Defina o número de chips a serem exibidos, permitindo que o usuário veja todas as opções disponíveis em uma única tela de formulário de entrada. Se o número definido de chips a serem exibidos exceder o valor definido, um botão Ver tudo será exibido. Toque no botão Ver tudo para abrir uma página com todas as opções listadas.

    Figura 2. Opções de entrada de escolha única e múltipla em uma tela de formulário de entrada
    Opções de entrada de escolha única e múltipla na tela do formulário de entrada.

    Você pode usar esses atributos com entradas de opção.

    Atributo Descrição
    MultiSelect Opção para permitir que os usuários selecionem várias opções para a entrada. O valor deve ser verdadeiro ou falso. As opções de seleção múltipla são indicadas com um sinal "+" no chip.
    Table A tabela em que o campo de opção está localizado.
    Nota:
    Use esta opção para usar as opções em uma tabela e campo existentes em vez de criar opções manualmente. Você deve selecionar um campo nesta tabela usando o atributo Field.
    Field O campo que contém suas escolhas.
    Nota:
    Use esta opção para usar as opções em uma tabela e campo existentes em vez de criar opções manualmente. O campo definido neste atributo deve estar na tabela definida no atributo Table.
    Inline Opção para selecionar como exibir suas entradas de escolha. Por padrão, o valor é falso, o que significa que a exibição da opção está na mesma tela, eliminando a necessidade de navegar para uma tela separada. Para obter um exemplo visual, consulte a imagem na introdução Entradas de opção.

    Se você selecionar verdadeiro, uma opção de tipo de lista será exibida em que os usuários devem navegar para uma tela adicional, depois que uma seleção é feita.

    Figura 3. Opção de estilo de lista de seleção em linha mostrando a necessidade de uma tela secundária
    Opção de escolha em linha mostrando a necessidade de uma tela de seleção secundária.
    MaxItemInline Opção para definir o número de chips a serem exibidos em uma seção da tela do formulário de entrada. As seguintes entradas no campo Valor estão disponíveis:
    • Vazio: exibe o padrão de até 8 valores de seleção. Se houver mais opções do que 8 valores de seleção, o botão Ver tudo será exibido.
    • Valor numérico negativo: exibe todos os valores de seleção, mesmo se exceder 8 valores.
    • Valor numérico positivo: exibe o número de valores de seleção definidos. Se houver mais opções do que o valor numérico inserido, um botão Ver tudo será exibido.
    A imagem a seguir ilustra um cenário em que 8 é o valor inserido e há 12 valores de seleção. A primeira tela exibe 8 valores. Quando o usuário toca no botão Ver tudo, uma nova tela é aberta com todos os 12 valores de seleção exibidos.
    Figura 4. Lista de seleção com botão Ver tudo
    Lista de seleção com o botão Ver tudo.
    RenderType Opção para renderizar as opções de escolha como uma imagem para a entrada de escolha. O valor deve ser imagem.

    Entradas de mapa personalizado

    Use entradas de mapa personalizadas para adicionar um link a um mapa interno em seu aplicativo para celular. Os usuários podem usar esses mapas para obter direções e reservar recursos, como mesas, salas de reunião ou guarda-volumes.

    Os administradores também podem configurar um item de dados com parâmetros com condições de consulta que permitem a classificação e a filtragem da entrada do mapa personalizado.

    Importante:

    As entradas de mapa personalizado que oferecem suporte a itens de dados com parâmetros devem usar somente o atributo ScreenId. Não use nenhum outro tipo de atributo para entradas de mapa personalizadas que oferecem suporte a itens de dados parametrizados.

    Se você estiver modificando uma entrada de mapa personalizado existente que usa o qualificador de referência avançado para usar um item de dados com parâmetros, use somente o atributo ScreenId e remova todos os outros atributos.


    Mostra como a entrada do mapa personalizado é exibida em um aplicativo para celular em que você seleciona "Avançar" para exibir o mapa.
    Você pode usar esses atributos com entradas de mapa personalizadas.
    Nota:
    Você pode adicionar o tipo de entrada de mapa personalizado ao seu aplicativo para celular usando Construtor de apps para celular, mas deve configurar os atributos na IU da web da plataforma da sua instância.
    Atributo Descrição
    CustomMapConfigId O sys_id da tabela sys_sg_custom_map_config.
    CustomMapDefaultProviderId O sys_id do registro do provedor na tabela sys_sg_custom_map_provider.
    CustomMapInputs O sys_id do piso na tabela sys_sg_input. Este valor deve ser inserido como uma matriz JSON.
    ScreenId O sys_id de um item de dados com parâmetros usado para classificar e filtrar entradas de mapa personalizadas.
    Importante:
    Este atributo não pode ser usado com nenhum outro atributo de entrada de mapa personalizado. Se você usar o atributo ScreenId com uma entrada de mapa personalizado, não use nenhum outro atributo com a entrada.
    TargetTable Defina como sn_wsd_core_space.

    Entradas de data/hora

    Use entradas de data/hora para permitir que os usuários insiram valores de data e hora. Você pode configurar a entrada para data e hora ou somente data.

    Exemplos de configurações de data e hora.

    Você pode usar esses atributos com entradas de data/hora.

    Atributo Descrição
    RenderType Especifique um tipo de renderizador para a entrada de data/hora.
    data/hora
    Exibe data e hora. Se nenhum RenderType estiver definido, esta opção será o padrão.
    data
    Exibe somente a data.
    IncludeTimezone

    O fuso horário do dispositivo móvel ao qual a entrada está sendo adicionada. O valor deve ser verdadeiro ou falso.

    Quando definido como verdadeiro, o cliente móvel envia as informações de fuso horário do dispositivo junto com o valor de data e hora para a instância de back-end no seguinte formato:

    AAAA-MM-DDThh:mm:ss.sssTZD

    Nota:
    O fuso horário do dispositivo é diferente do fuso horário do perfil de usuário configurado na plataforma.

    Se este atributo não estiver configurado, o cliente móvel não incluirá informações de Fuso horário do dispositivo nos valores de entrada de data/hora. Este comportamento é o padrão. Os valores de entrada de data/hora estão no seguinte formato:

    AAAA-MM-DD hh:mm:ss

    Para obter informações sobre como configurar o atributo IncludeTimezone de entradas de data/hora para diferentes tipos de ação, consulte Configuração de entrada de data/hora para diferentes tipos de item de ação.

    Para obter informações sobre os tipos de item de ação, consulte Configurar um item de ação.

    MaxRangeDays

    Atributo opcional que determina se as datas futuras podem ser selecionadas quando uma entrada de data/hora é adicionada. Este atributo oferece suporte a valores inteiros positivos e negativos. Definir MaxRangeDays como 0 evita que os usuários selecionem datas futuras e os restringe às datas atuais ou passadas.

    Nota:
    MaxRangeDays pode ser usado junto com MinRangeDays, MaxRangeHourse MinRangeHours.
    MinRangeDays

    Atributo opcional que determina se datas passadas podem ser selecionadas quando uma entrada de data/hora é adicionada. Este atributo oferece suporte a valores inteiros positivos e negativos. Definir MinRangeDays como 0 evita que os usuários selecionem datas passadas e os restringe a datas atuais ou futuras.

    Nota:
    MinRangeDays pode ser usado junto com MaxRangeDays, MaxRangeHourse MinRangeHours.
    MaxRangeHours

    Atributo opcional que determina se os horários futuros podem ser selecionados quando uma entrada de data/hora é adicionada. Este atributo oferece suporte a valores inteiros positivos e negativos. Definir MaxRangeHours como 0 evita que os usuários selecionem datas e horas futuras e os restringe às datas e horas atuais ou passadas.

    Nota:
    MaxRangeHours pode ser usado junto com MaxRangeDays, MinRangeDayse MinRangeHours.
    MinRangeHours

    Atributo opcional que determina se as últimas horas podem ser selecionadas quando uma entrada de data/hora é adicionada. Este atributo oferece suporte a valores inteiros positivos e negativos. Definir MinRangeHours como 0 evita que os usuários selecionem datas e horas passadas e os restringe a datas e horas atuais ou futuras.

    Nota:
    MinRangeHours pode ser usado junto com MaxRangeDays, MinRangeDayse MaxRangeHours.

    Entradas de número

    Use entradas numéricas para permitir que os usuários insiram valores numéricos. Defina valores mínimos e máximos opcionais para definir um intervalo de números para sua entrada.

    Opcionalmente, você pode configurar uma entrada de número para aparecer como uma porcentagem.

    Por padrão, as entradas numéricas oferecem suporte a decimais.

    Exemplos de entradas numéricas configuradas como valores numéricos ou percentuais.

    Você pode usar esses atributos com entradas numéricas.

    Atributo Descrição
    CustomErrorMessage Define uma mensagem de erro personalizada que você pode especificar. Esta mensagem é exibida quando a condição de regra de IU associada é atendida.
    Max Especifique um valor máximo para a entrada.
    Min Especifique um valor mínimo para a entrada.
    RenderType Especifique um tipo de renderizador para a entrada numérica.
    porcentagem
    Exibe um símbolo de porcentagem (%) após o número na entrada.
    linha
    Exibe a entrada como um campo de linha.
    caixa
    Exibe a entrada como um campo de caixa.
    inteiro
    Exibe números inteiros, como 3, 1003ou 57. Quando integer é usado, os usuários finais só podem inserir números inteiros e não podem inserir decimais.
    SkipValidationWhenHidden Pode ser definido como verdadeiro ou falso. Por padrão, ela é definida como falsa, o que significa que, por padrão, a validação da regra de IU associada é executada nas entradas ocultas. Defina como verdadeiro somente quando quiser ignorar a validação em entradas ocultas.

    Entradas de classificação

    Use entradas de classificação para permitir que os usuários classifiquem as opções disponíveis em ordem de preferência ou prioridade. Os usuários tocam e arrastam as opções disponíveis.

    As opções para a entrada de classificação devem ser definidas manualmente.

    Exemplo de entrada de classificação.

    Não há atributos para classificar entradas diferentes dos atributos gerais listados neste tópico.

    Entradas de referência

    Use entradas de referência para entradas que fazem referência a um campo em uma tabela. Essas entradas funcionam como campos de referência nos formulários da sua instância. Você pode configurar sua entrada de referência com condições, qualificadores de referência e uma opção de pesquisa para ajudar os usuários a encontrar o que precisam rapidamente.

    A opção de pesquisa opcional usa pesquisas de palavra-chave "Para texto" e pode pesquisar elementos na exibição móvel.

    Você pode usar esses atributos com entradas de referência.

    Tabela 1. Atributos obrigatórios
    Atributo Descrição
    SourceTable A tabela de origem do seu qualificador de referência.
    SourceFieldName O nome do campo referenciado na tabela de origem.
    TargetTable A tabela que você deseja direcionar para o qualificador de referência.

    Os seguintes atributos adicionais são opcionais:

    Tabela 2. Atributos extras
    Atributo Descrição
    MultiSelect Opção para permitir que os usuários selecionem várias opções para a entrada. O valor deve ser verdadeiro ou falso.
    MobileViewId ID de exibição móvel (configuração de exibição) a ser usada para itens da lista de referência​.
    EnableSearch Opção para exibir a barra de pesquisa. O valor deve ser verdadeiro ou falso.
    SearchPlaceholder Texto que aparece em uma barra de pesquisa como um espaço reservado.
    Conditions Insira uma consulta codificada para aplicar condições à sua lista de referência. Para obter detalhes sobre como criar essas consultas, consulte Cadeias de caracteres de consulta codificadas.
    SearchType Define a consulta usada para pesquisa. O valor pode ser starts_with ou contains. Se este atributo não estiver configurado, a instância usará starts_with por padrão na coluna do rótulo de exibição.

    Este exemplo cria uma entrada de tela de formulário de entrada para o campo Atribuído a na tabela Incidente [incidente]. Para criar esta entrada, você usa os três atributos necessários: TargetTable, SourceTablee SourceFieldName.

    1. Seus usuários selecionam em uma lista de usuários aos quais o incidente será atribuído. Portanto, você define o atributo TargetTable como sys_user.
    2. Como você está adicionando o usuário a um registro de incidente, o atributo SourceTable é definido como incident.
    3. Defina o SourceFieldName como assigned_to para que o usuário selecionado seja atribuído ao campo Atribuído a.
    Figura 5. Entrada de referência para o campo assigned_to configurado em Construtor de apps para celular
    Entrada da tela do formulário de entrada para o campo assigned_to configurado no Construtor de apps para celular.
    Figura 6. Atributos de entrada de referência para o campo assigned_to configurado em Construtor de apps para celular
    Atributos de entrada da tela do formulário de entrada para o campo assigned_to configurado em Construtor de apps para celular.

    Entradas de assinatura

    Use entradas de assinatura para capturar assinaturas eletrônicas em uma tela de formulário de entrada. As entradas de assinatura podem ser incluídas em seções ou páginas da tela do formulário de entrada.

    Figura 7. Entradas de assinatura em uma tela de formulário de entrada em um dispositivo móvel
    Entradas de assinatura em uma tela de formulário de entrada em um dispositivo móvel.

    Você pode usar o atributo opcional IsOverlay com entradas de assinatura. Por padrão, as assinaturas são renderizadas na janela modal completa. Quando o valor do atributo IsOverlay é definido como verdadeiro, as assinaturas são renderizadas em uma janela meio modal.

    Atributo Descrição
    IsOverlay Define se a entrada de assinatura é aberta em uma janela meio modal. Você pode definir o Valor como verdadeiro ou falso. Um valor verdadeiro configura a assinatura para abrir em uma janela meio modal.
    Nota:
    Se a entrada de assinatura estiver configurada como a única entrada em uma página e o atributo isOverlay estiver definido como verdadeiro, o atributo isOverlay será ignorado e a entrada de assinatura será exibida em tela inteira.
    Para obter informações sobre como criar uma tela de formulário de entrada com entradas de assinatura, consulte Configurar telas de formulário de entrada com entradas de assinatura.
    Nota:
    O mecanismo de carregamento da fonte de dados, que usa os atributos DataSouceId e ElementIdentifier, não é compatível com as entradas de assinatura.

    Entradas de cadeia de caracteres

    Use entradas de cadeia de caracteres para entrada de texto. Você pode definir um tamanho máximo de caracteres para esta entrada.

    Exemplo de entrada de cadeia de caracteres.

    Você pode usar esses atributos com entradas de cadeia de caracteres.

    Atributo Descrição
    Inline Opção para mostrar a entrada em linha ou para abrir a entrada em um modal separado. O valor deve ser verdadeiro ou falso.
    MaxLength Número máximo de caracteres para o valor de entrada.
    ShowDeleteAll Opção para exibir um botão de exclusão sempre que houver texto no campo de entrada. Este valor deve ser verdadeiro ou falsoe é definido como falso por padrão.
    ConfirmDeletion Opção para mostrar ao usuário uma mensagem de confirmação antes que o texto seja excluído ao usar ShowDeleteAll. O valor deve ser verdadeiro ou falsoe está definido como verdadeiro por padrão.

    Entradas de tela

    Use uma entrada de tela para transformar uma tela de lista em uma entrada de lista selecionável. Os usuários podem selecionar vários itens de lista e executar uma operação de write-back no cache.

    Exemplo de entrada de tela em um aplicativo para celular.

    Você pode usar esses atributos com entradas de tela.

    Atributo Descrição
    ScreenId Configura a tela de lista usada para a entrada de lista selecionável. O valor é o sys_id da tela da lista.
    GetDataFromParent Transforma uma tela de lista de uma tela primária na entrada de lista selecionável. Os filtros aplicados à tela da lista primária são transportados para a entrada da tela. Insira verdadeiro para habilitar este atributo. Por padrão, ele está desativado na instância.