API - Construtor de IU

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 27 min. de leitura

    • A API fornece métodos que você pode usar ao desenvolver scripts de cliente no Construtor de IU.

    Esta API está exposta a scripts de cliente, também conhecidos como scripts de página. Os scripts de cliente são executados em resposta a algo que acontece em uma página, como:
    • Eventos/ações de interação do usuário, como um clique de botão.
    • Eventos de ciclo de vida, como uma execução de agente de dados iniciada.
    Esses scripts não precisam retornar nada para a estrutura e podem ser gravados como uma função assíncrona.
    Esta API também está exposta a valores de propriedade com script. Esses scripts são executados sempre que o tempo de execução do framework precisa calcular um valor, como:
    • Passando para uma propriedade de componente.
    • Determinar a visibilidade do componente.
    • Emitindo um evento com uma carga.
    Esses scripts não podem ser gravados como uma função assíncrona. Eles também não podem invocar métodos de efeito colateral no objeto de API, como api.emit(), api.setState()e api.data.<data_resource_id> .*() .

    O objeto de API contém propriedades dependentes e independentes de configuração que você pode acessar dentro do contexto da página ou componente associado. Você não pode modificar diretamente as propriedades neste objeto. A modificação só pode ser feita por meio dos métodos disponíveis.

    api - api.context.props.<page_property_name>

    As propriedades da página podem ser configuradas em Construtor de IU. Os valores de configuração dependem do contexto em que a página é usada.

    Tabela 1. Campo
    Nome Tipo Descrição
    <page_property_name> Qualquer Os valores disponíveis dependem da implementação do client script.

    Para acessar essas propriedades, use o seguinte: api.context.props.<page_property_name> .

    Por exemplo: 
    // A record page with property table could be accessed with
function isActivityStreamVisible({api}) {
  return api.context.props.table === 'incident';
}
    Nota:
    Esses valores de propriedade são somente leitura. Não há suporte para mutação de valores de objeto aninhados de scripts.

    api - api.context.session.<session_property>

    Propriedades da sessão de contexto associadas ao usuário atual.

    Tabela 2. Propriedades de sessão disponíveis
    Nome Tipo Descrição
    estáLogin Booliano Sinalizador que indica se o usuário atual está conectado ao sistema.
    Valores possíveis:
    • verdadeiro: o usuário atual está conectado a
    • falso: o usuário atual não está conectado.
    propriedades.awaEnabled Cadeia de caracteres A propriedade do sistema glide.awa.enabled que indica se a atribuição automática de itens de trabalho do Advanced Work Assignment (AWA) está habilitada para o usuário atual.
    Valores possíveis:
    • verdadeiro: o AWA está habilitado para o usuário.
    • falso: o AWA não está habilitado para o usuário.

    Para obter informações adicionais, consulte Componentes instalados com o Advanced Work Assignment.
    propriedades.esquecer-me.valor Cadeia de caracteres A propriedade glide.ui.forgetme que indica se a caixa de seleção Lembrar-me deve ser removida da página de login para impedir que as informações de login sejam armazenadas em cache.
    Valores possíveis:
    • verdadeiro: remova a caixa de seleção Lembrar-me.
    • falso: exibe a caixa de seleção Lembrar-me.

    Para obter informações adicionais, consulte Remover lembrar-me.
    properties.sessionTimeLeft.value Cadeia de caracteres

    Número forçado para cadeia de caracteres

    		 A propriedade do sistema glide.ui.session_timeleft que determina o tempo restante antes que a sessão atual expire. Use esta propriedade para solicitar que o usuário estenda a sessão atual antes que ela expire.

    Unidade: minutos
    properties.sessionTimeout.value Cadeia de caracteres

    Número forçado para cadeia de caracteres

    		 A propriedade do sistema glide.ui.session_timeout que determina o valor de tempo limite da sessão inicial.

    Unidade: minutos - Valores superiores a 1.440 minutos são tratados como um dia.

    Para obter informações adicionais, consulte Tempo limite de atividade da sessão
    propriedades.acompanhamentoEnabled.value Cadeia de caracteres A propriedade do sistema glide.uxbuilder.tracking.enabled que indica se é para habilitar/desabilitar o carregamento e a instanciação da biblioteca de análise da web para aplicações baseadas em Construtor de IU.
    Valores possíveis:
    • verdadeiro: habilitado para o usuário.
    • falso: desabilitado para o usuário.
    usuário.avatar Cadeia de caracteres URL do avatar do usuário atual.
    user.dateFormat Cadeia de caracteres Formato de data padrão.
    usuário.domínio Cadeia de caracteres Caminho de domínio para o usuário atual.
    usuário.primeiroNome Cadeia de caracteres Nome do usuário atual.
    user.fullName Cadeia de caracteres Nome e sobrenome do usuário atual.
    usuário.iniciais Cadeia de caracteres Iniciais do usuário atual.
    usuário.idioma Cadeia de caracteres Idioma primário falado pelo usuário atual.
    preferências.usuário Matriz de objetos Pares de nome-valor que descrevem as preferências do usuário. Essas preferências do usuário são armazenadas como registros na tabela Preferência do usuário [sys_user_preference] e são atualizadas sempre que o usuário muda suas configurações.

    Para obter informações adicionais, confira Exploring user administration.
    funções.usuário Matriz Lista separada por vírgulas de funções atribuídas ao usuário atual.
    Nota:
    Se o usuário não tiver funções atribuídas, esta propriedade de sessão de contexto retornará nulo em vez de uma matriz vazia.
    usuário.sys_id Cadeia de caracteres Sys_id do usuário na tabela Usuário [sys_user].
    user.timeFormat Cadeia de caracteres Formato de tempo padrão a ser usado para o usuário.
    usuário.fusotempo Cadeia de caracteres Fuso horário do usuário atual.
    user.timeZoneOffset Cadeia de caracteres Compensação de fuso horário do usuário atual.

    api - api.data.<data_resource_id> .lifecycle.lastFetchSucceeded

    Sinalizador booliano que indica se a última tentativa de busca da instância de recurso de dados especificada foi concluída com sucesso.

    Se o valor for verdadeiro, a última tentativa de busca da instância do recurso de dados foi concluída com sucesso; caso contrário, falso.

    Tabela 3. Campo
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.

    api - api.data.<data_resource_id> .addErrorMessage(carga do objeto)

    Exibe a mensagem de erro especificada na parte superior do formulário atual.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve a mensagem de erro a ser exibida.
    "payload": {
  "message": "String"
}
    carga.mensagem Cadeia de caracteres Mensagem de erro a ser exibida.
    Tabela 5. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.addErrorMessage({message: 'Error message'});

    API - API.data.<data_resource_id> .addInfoMessage(carga do objeto)

    Exibe a mensagem informativa especificada na parte superior do formulário atual.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve a mensagem informativa a ser exibida.
    "payload": {
  "message": "String"
}
    carga.mensagem Cadeia de caracteres Mensagem informativa a ser exibida.
    Tabela 7. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.addInfoMessage({message: 'Test message'});

    api - api.data.<data_resource_id> .addOption(carga do objeto)

    Adiciona uma opção ao campo de tipo de opção especificado.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve o valor do campo a ser atualizado.
    "payload": {
  "choiceIndex": "String",
  "choiceLabel": "String",
  "choiceValue": "String",
  "fieldName": "String"
}
    carga.ÍndiceDeEscolha Cadeia de caracteres Opcional. Índice na lista de seleção na qual a opção será inserida.

    Padrão: fim da lista de seleção.
    payload.choiceLabel Cadeia de caracteres Rótulo da opção a ser adicionada ao campo especificado.
    payload.choiceValue Cadeia de caracteres Valor da opção a ser adicionada ao campo especificado.
    carga.NomeDoCampo Cadeia de caracteres Nome do campo de formulário de tipo de opção ao qual a opção especificada será adicionada.
    Tabela 9. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.addOption({fieldName: 'priority', choiceLabel: 'Extremely High', choiceValue: '10'});

    api - api.data.<data_resource_id> .addWarningMessage(carga do objeto)

    Exibe a mensagem de aviso especificada na parte superior do formulário atual.

    Tabela 10. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve a mensagem de aviso a ser exibida.
    "payload": {
  "message": "String"
}
    carga.mensagem Cadeia de caracteres Mensagem de aviso a ser exibida.
    Tabela 11. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.addWarningMessage({message: 'Test message'});

    api - api.data.<data_resource_id> .clearMessage()

    Remove todas as mensagens informativas e de erro da parte superior do formulário atual.

    Tabela 12. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    Tabela 13. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.clearMessage();

    api - api.data.<data_resource_id> .clearOptions(carga do objeto)

    Limpa todas as opções do campo de tipo de opção especificado.

    Tabela 14. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve o campo de tipo de opção cujas opções serão limpas.
    "payload": {
  "fieldName": "String"
}
    carga.NomeDoCampo Cadeia de caracteres Nome do campo de tipo de opção cujas opções serão apagadas.
    Tabela 15. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.clearOptions({fieldName: 'priority'});

    api - api.data.<data_resource_id> .executeUiAction(carga do objeto)

    Executa a ação de IU especificada.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Descrição da ação de IU a ser executada.
    "payload": {
  "actionSysId": "String"
}
    carga.actionSysId Cadeia de caracteres Sys_id da ação de IU a ser executada.

    Tabela: ação de IU [sys_ui_action]
    Tabela 17. Retornos
    Tipo Descrição
    Nenhum

    O exemplo de código a seguir mostra como chamar este método.

    api.data.gform.executeUiAction({actionSysId: '60615ff90f730010ac7de6f8c4767e9a'});

    api - api.data.<data_resource_id> .execute(Object inputValues)

    Aciona uma operação de execução no recurso de dados especificado.

    Este método só estará disponível se o recurso de dados for um dos seguintes tipos:
    • Composto
    • GraphQL
    • REST
    • Scriptlet
    • Transformação
    Nota:
    Este método só será exposto se o campo mutates_server_data estiver definido como verdadeiro no registro de recurso de dados correspondente (tabela sys_ux_data_broker_*). Ele pode ser acessado em api.data.<data_resource_Id> .refresh() .
    Tabela 18. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado. As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    inputValues Objeto Objeto a ser passado para o recurso de dados especificado. Este objeto deve estar em conformidade com os parâmetros de entrada do recurso de dados.
    Tabela 19. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo de código mostra um script de página que é invocado quando o botão Enviar na página é clicado. A página está configurada com um recurso de dados do servidor que cria um novo registro.

    function handler({api}) {
  if (api.state.movieYear === 2020) {
    // The data resource used in this case specifies two input parameters: name and year
    api.data.create_movie_record.execute({
      name: api.state.movieName,
      year: api.state.movieYear
    });
  }
}

    api - api.data.<data_resource_id> .hideFieldMessage(carga do objeto)

    Oculta a mensagem mais antiga ao lado do campo especificado ou limpa todas as mensagens associadas ao campo.

    Tabela 20. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve a mensagem do campo a ser ocultada.
    "payload": {
  "clearAll": Boolean,
  "fieldName": "String"
}
    carga.limparTodos Booliano Opcional. Sinalizador que indica se todas as mensagens associadas ao campo de formulário especificado devem ser limpas.
    Valores válidos:
    • verdadeiro: limpa todas as mensagens associadas ao campo especificado.
    • falso: não limpa todas as mensagens associadas ao campo especificado.

    Padrão: falso
    carga.NomeDoCampo Cadeia de caracteres Nome do campo de formulário para o qual ocultar a mensagem mais antiga ou limpar todas as mensagens associadas.
    Tabela 21. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.hideFieldMessage({fieldName: 'short_description'});

    api - api.data.<data_resource_id> .hideRelatedList(carga do objeto)

    Oculta a lista relacionada especificada no formulário atual.

    Tabela 22. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve a lista relacionada a ser ocultada.
    "payload": {
  "listTableName ": "String"
}
    carga.listTableName Cadeia de caracteres Nome da lista relacionada a ser ocultada. Se a lista a ser ocultada for por meio de um relacionamento, forneça o sys_id da lista em vez do nome.

    Tabela: lista relacionada [sys_ui_related_list]
    Tabela 23. Retornos
    Tipo Descrição
    Nenhum

    O exemplo de código a seguir mostra como chamar este método.

    api.data.gform.hideRelatedList({listTableName:'incident.parent_incident'});

    api - api.data.<data_resource_id> .hideRelatedList()

    Oculta todas as listas relacionadas no formulário atual.

    Tabela 24. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    Tabela 25. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.hideRelatedLists();

    api - api.data.<data_resource_id> .atualizar()

    Aciona uma operação de atualização para a instância de recurso de dados não mutáveis especificada.

    Chame este método se os dados subjacentes que estão sendo obtidos pelo recurso de dados forem alterados. Um recurso de dados é considerado não mutável se o campo mutates_server_data no registro estiver definido como falso.

    Este método é assíncrono e emite um evento interno para acionar a atualização da instância de recurso de dados especificada. O Construtor de IU permite que você acione client scripts em resposta a eventos de ciclo de vida de recursos de dados, como DATA_FETCH_SUCCEEDED e DATA_FETCH_FAILED. Para obter informações adicionais sobre esses eventos, consulte Mapeamento de eventos.

    Este método só estará disponível se o recurso de dados for um dos seguintes tipos:
    • Composto
    • GraphQL
    • REST
    • Scriptlet
    • Transformação
    Nota:
    Este método só será exposto se o campo mutates_server_data estiver definido como falso no registro de recurso de dados correspondente (tabela sys_ux_data_broker_*).
    Tabela 26. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado. As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    Tabela 27. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo de código mostra um script de página que é invocado quando um item suspenso é selecionado em uma página. A página está configurada com dois Recursos de Dados do Servidor que consultam tabelas de problemas e incidentes.

    function handler({api, event}) {
  const value = event.payload.value[0];
  if (value === 'problem')
    api.data.problem_list_1.refresh();
  else if(value === 'incident')
    api.data.incident_list_1.refresh();
}

    api - api.data.<data_resource_id> .recarregar()

    Recarrega o formulário atual usando a mesma tabela e sys_id.

    Tabela 28. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    Tabela 29. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.reload();

    api - api.data.<data_resource_id> .removeOption(carga do objeto)

    Remove uma opção do campo de tipo de opção especificado.

    Tabela 30. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve o campo de tipo de opção a ser atualizado.
    "payload": {
  "choiceValue": "String",
  "fieldName": "String"
}
    payload.choiceValue Cadeia de caracteres Valor da opção a ser removida do campo de tipo de opção especificado.
    carga.NomeDoCampo Cadeia de caracteres Nome do campo de formulário de tipo de opção do qual o valor especificado será removido.
    Tabela 31. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.removeOption({fieldName: 'priority', choiceValue: '1'});

    api - api.data.<data_resource_id> .save()

    Aciona o envio do formulário usando a ação de IU Salvar.

    Tabela 32. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    Tabela 33. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.save();

    api - api.data.<data_resource_id> .setMandatory(carga do objeto)

    Define se o campo de formulário especificado é obrigatório.

    Tabela 34. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve o campo cujas informações obrigatórias serão atualizadas.
    "payload": {
  "fieldName": "String",
  "mandatory": Boolean
}
    carga.NomeDoCampo Cadeia de caracteres Nome do campo de formulário cujo valor obrigatório será definido.
    carga.obrigatório Booliano Sinalizador que indica que o campo de formulário especificado é obrigatório, o que significa que o formulário não pode ser salvo sem que este campo contenha um valor válido.
    Valores válidos:
    • verdadeiro: o campo é obrigatório.
    • falso: o campo é opcional.
    Tabela 35. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.setMandatory({fieldName: 'short_description', mandatory: false});

    api - api.data.<data_resource_id> .setReadOnly(carga do objeto)

    Define as capacidades de leitura/gravação do campo de formulário especificado.

    Tabela 36. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve o campo cujas informações de legibilidade serão atualizadas.
    "payload": {
  "fieldName": "String",
  "readonly": Boolean
}
    carga.NomeDoCampo Cadeia de caracteres Nome do campo de formulário cuja legibilidade será definida.
    carga.somente leitura Booliano Sinalizador que indica as capacidades de leitura/gravação do campo de formulário especificado.
    Valores válidos:
    • verdadeiro: o campo é somente leitura.
    • falso: o campo é de leitura/gravação.
    Tabela 37. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.setReadOnly({fieldName: 'short_description', readonly: false});

    API - API.data.<data_resource_id> .setValue(carga do objeto)

    Atualiza um campo GlideForm especificado com o valor especificado. Opcionalmente, você também pode atualizar o valor de exibição com o mesmo valor especificado.

    Somente o valor no formulário é atualizado. O valor não é salvo no banco de dados.

    Tabela 38. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve o campo cujo valor será atualizado.
    "payload": {
  "displayValue": "String",
  "fieldName": "String",
  "value": "String"
}
    carga.displayValue Cadeia de caracteres Opcional. Nome do valor de exibição a ser atualizado. Se for deixado em branco, o valor de exibição não será modificado.
    carga.NomeDoCampo Cadeia de caracteres Nome do campo de formulário a ser atualizado.
    carga.valor Cadeia de caracteres Valor com o qual atualizar o campo.
    Tabela 39. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.setValue({fieldName: 'short_description', value: 'short description'});

    api - api.data.<data_resource_id> .setVisible(carga do objeto)

    Define a visibilidade do campo de formulário especificado.

    Tabela 40. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve o campo no qual a visibilidade será definida.
    "payload": {
  "fieldName": "String",
  "visibility": Boolean
}
    carga.NomeDoCampo Cadeia de caracteres Nome do campo de formulário cuja visibilidade será definida.
    carga.visibilidade Booliano Sinalizador que indica se o campo associado está visível no formulário atual.
    Valores válidos:
    • verdadeiro: o campo será exibido no formulário.
    • falso: o campo não será exibido no formulário.
    Tabela 41. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.setVisible({fieldName: 'short_description', visibility: false});

    api - api.data.<data_resource_id> .showFieldMessage(carga do objeto)

    Exibe a mensagem especificada ao lado do campo especificado.

    Tabela 42. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve a mensagem do campo a ser exibida.
    "payload": {
  "fieldName": "String",
  "message": "String",
  "type": "String"
    carga.NomeDoCampo Cadeia de caracteres Nome do campo ao lado do qual a mensagem deve aparecer.
    carga.mensagem Cadeia de caracteres Mensagem a ser exibida.
    carga.tipo Cadeia de caracteres Opcional. Tipo de mensagem a ser exibida.
    Valores válidos:
    • erro
    • informações
    • aviso

    Padrão: informações
    Tabela 43. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.showFieldMessage({fieldName: 'short_description', message: 'Error message', type: 'error'});

    api - api.data.<data_resource_id> .showRelatedList(carga do objeto)

    Exibe a lista relacionada especificada no formulário atual.

    Tabela 44. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve a lista relacionada a ser exibida.
    "payload": {
  "listTableName ": "String"
}
    carga.listTableName Cadeia de caracteres Nome da lista relacionada a ser exibida. Se a lista a ser exibida for por meio de um relacionamento, forneça o sys_id da lista em vez do nome.

    Tabela: lista relacionada [sys_ui_related_list]
    Tabela 45. Retornos
    Tipo Descrição
    Nenhum

    O exemplo de código a seguir mostra como chamar este método.

    api.data.gform.showRelatedList({listTableName:'incident.parent_incident'});

    api - api.data.<data_resource_id> .showRelatedList()

    Exibe todas as listas relacionadas associadas ao formulário atual.

    Tabela 46. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    Tabela 47. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.showRelatedLists();

    api - api.data.<data_resource_id> .enviar()

    Aciona o envio do formulário usando a ação de IU especificada.

    Tabela 48. Parâmetros
    Nome Tipo Descrição
    data_resource_id Cadeia de caracteres Identificador exclusivo do recurso de dados associado.

    Na maioria dos casos, você pode usar a ação CTRL_RECORD#SAVE_FORM do controlador de formulário. Se a página de registro tiver o componente Guias da página de registro, o recurso de dados para este método deverá ser baseado em GlideForm (g_form).

    As instâncias de recursos de dados disponíveis dependem da configuração e são definidas quando você adiciona o recurso de dados à sua página em Construtor de IU.
    carga Objeto Objeto que descreve a ação de IU a ser usada para enviar o formulário atual.
    "payload": {
  "submitActionName": "String"
}
    carga.submitAçãoNome Cadeia de caracteres Nome da ação de IU a ser executada para enviar o formulário atual.
    Tabela 49. Retornos
    Tipo Descrição
    Nenhum 

    api.data.gform.submit({submitActionName:'sysverb_ws_save'});

    api - api.emit(cadeia de caracteres eventName, carga do objeto)

    Emite um evento com o nome e a carga especificados.

    O nome do evento emitido deve fazer parte da lista de eventos expedidos da definição de página associada, que é armazenada na tabela Definição de macroponent de UX [sys_ux_macroponent]. Qualquer chamada api.emit que expede eventos não declarados nesta tabela é ignorada.

    Para obter informações adicionais sobre eventos, consulte Trabalho com eventos.

    Tabela 50. Parâmetros
    Nome Tipo Descrição
    eventName Cadeia de caracteres Nome do evento a ser emitido. Este nome deve seguir as diretrizes de nomenclatura de ação da Estrutura de IU:
    • Deve ser maiúscula, como ITEM_CHANGED. Todas as letras em maiúsculas e todos os espaços substituídos por sublinhados.
    • Deve estar no passado, como BUTTON_CLICKED ou USER_SELECTED.

    Para obter informações adicionais sobre essas diretrizes de nomenclatura de ação, consulte https://developer.servicenow.com/dev.do#!/reference/now-experience/sandiego/ui-framework/main-concepts/dispatching-actions.
    carga Objeto Opcional. Objeto que contém os dados a serem enviados com o evento emitido. Este objeto tem forma livre e pode conter todos os dados necessários para a entidade que os recebe.
    Nota:
    Cargas de tipo primitivo funcionam, mas podem resultar em comportamento inconsistente.
    Tabela 51. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo de código a seguir mostra a emissão de um evento chamado NOW_UXF_PAGE#ADD_NOTIFICATIONS com uma carga items associada.

    function handler({api}) { 
  api.emit('NOW_UXF_PAGE#ADD_NOTIFICATIONS', { 
    items: [
      { 
        id: 'alert1', 
        status: 'positive', 
        icon: 'check-circle-outline', 
        content: 'Here is some information!', 
        textLinkProps: { 
          label: 'More info',
          href: 'https://www.servicenow.com' 
        }, 
      action: {type: 'acknowledge'} 
      } 
    ] 
  }); 
}

    api - setState(cadeia de caracteres "stateParam", qualquer valor)

    Define o valor do parâmetro de estado do cliente especificado.

    Use parâmetros de estado do cliente para manter um estado compartilhado em uma página. O estado compartilhado pode ser passado como valores para propriedades de componentes usados na página. Você também pode acessar e atualizar estados do cliente em scripts de várias páginas. Um caso de uso comum é acompanhar os valores inseridos por usuários em vários controles de formulário em uma página. Quando o formulário é enviado, um client script pode usar todos os valores armazenados nos parâmetros de estado do cliente para criar um novo registro com um agente de dados. Uma página pode ter um ou mais parâmetros de estado do cliente, que você pode declarar para uma página por meio do Construtor de IU. Você pode vincular um parâmetro de estado do cliente a um ou mais componentes para compartilhar ou agir no parâmetro de estado do cliente.

    As chamadasapi.setState() são executadas de forma assíncrona e não atualizam necessariamente a IU imediatamente. Se o valor a ser definido depender de currentValue do parâmetro de estado do cliente ou de qualquer uma das propriedades fornecidas no objeto de API, você deverá usar esta variante do método api.setState() para evitar o uso de valores desatualizados.

    Tabela 52. Parâmetros
    Nome Tipo Descrição
    stateParm Cadeia de caracteres Nome do parâmetro de estado do cliente a ser atualizado. Este nome deve ser declarado nos parâmetros de estado do cliente da página associada.

    Para obter informações adicionais sobre como declarar parâmetros de estado do cliente, consulte Como trabalhar com parâmetros de estado do cliente.
    valor Qualquer - deve ser igual à declaração do parâmetro de estado do cliente. Valor para definir o parâmetro de estado do cliente especificado.
    Tabela 53. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo mostra um script que pode ser executado para atualizar o parâmetro de estado do cliente de e-mail quando um valor de entrada é definido em um componente now-input.

    function handler({api, event}) {
    api.setState('email', event.payload.value);
}

    api - setState(String stateParam, função callbackFn)

    Define o valor do parâmetro de estado do cliente especificado como o valor retornado pela função de retorno de chamada especificada.

    A função de retorno de chamada é invocada com um objeto que tem duas propriedades: currentValue e api. A função nunca deve alterar a propriedade currentValue ou o objeto api diretamente.

    Use parâmetros de estado do cliente para manter um estado compartilhado em uma página. O estado compartilhado pode ser passado como valores para propriedades de componentes usados na página. Você também pode acessar e atualizar estados do cliente em scripts de várias páginas. Um caso de uso comum é acompanhar os valores inseridos por usuários em vários controles de formulário em uma página. Quando o formulário é enviado, um client script pode usar todos os valores armazenados nos parâmetros de estado do cliente para criar um novo registro com um agente de dados. Uma página pode ter um ou mais parâmetros de estado do cliente, que você pode declarar para uma página por meio do Construtor de IU. Você pode vincular um parâmetro de estado do cliente a um ou mais componentes para compartilhar ou agir no parâmetro de estado do cliente.

    As chamadasapi.setState() são executadas de forma assíncrona e não atualizam necessariamente a IU imediatamente. Se o valor a ser definido depender de currentValue do parâmetro de estado do cliente ou de qualquer uma das propriedades fornecidas no objeto de API, você deverá usar esta variante do método api.setState() para evitar o uso de valores desatualizados.

    Tabela 54. Parâmetros
    Nome Tipo Descrição
    stateParm Cadeia de caracteres Nome do parâmetro de estado do cliente a ser atualizado. Este nome deve ser declarado nos parâmetros de estado do cliente da página associada.

    Para obter informações adicionais sobre como declarar parâmetros de estado do cliente, consulte Como trabalhar com parâmetros de estado do cliente.
    retorno de chamadaFn Função Função de retorno de chamada a ser executada para obter o valor.
    Tabela 55. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo mostra como usar api.setState para conectar usuários a uma página.

    function handler({api, event}) {
  const {name, value} = event.payload;
  if (name === 'username' || name === 'password') {
    // Update the loginParameters state object with the username/password value
    api.setState('loginParameters', ({currentValue}) => {
      return {
        ...currentValue,
        [name]: value
      };
    });
  }
}

    api - api.state.<client_state_parameter_name>

    Valor atual do parâmetro de estado do cliente especificado.

    Tabela 56. Campo
    Nome Tipo Descrição
    <client_state_parameter_name> Qualquer. Os parâmetros de estado do cliente disponíveis dependem da configuração da página. Nome do parâmetro de estado do cliente. Os estados do cliente disponíveis dependem da implementação do client script.

    Para acessar os estados de cliente disponíveis, use o seguinte: api.state.<client_state_name> .

    Por exemplo: 
    function showRelatedLists({api}) { 
  return !api.state.isCustomListSelected; 
}
    Nota:
    Esses valores de propriedade são somente leitura. Para atualizar um parâmetro de estado do cliente, use api.setState(). Não há suporte para mutação de valores de objeto aninhados de scripts.