GlideForm (g_form) - Cliente
A API GlideForm fornece métodos para personalizar formulários.
GlideForm.js é a classe JavaScript que contém os métodos. Use somente métodos GlideForm no cliente. Você pode usar esses métodos para fazer mudanças personalizadas na exibição de formulário de registros. Toda a validação de exemplos foi feita usando client scripts.
Você também pode usar alguns desses métodos em outros scripts de cliente (como Scripts de cliente de catálogo ou Scripts de cliente do assistente), mas primeiro você deve testar isso para determinar se eles funcionarão conforme o esperado.
Não há construtor para a classe GlideForm. Acesse métodos GlideForm usando o objeto global g_form.
GlideForm – addDecoration(cadeia de caracteres fieldName, ícone de cadeia de caracteres, título de cadeia de caracteres)
Adiciona um ícone ao rótulo de um campo.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo. |
| ícones | Cadeia de caracteres | O ícone de fonte a ser mostrado ao lado do campo. Ícones compatíveis - icon-user, icon-user-group, icon-lightbulb, icon-home, icon-mobile, icon-comment, icon-mail, icon-locked, icon-database, icon-book, icon-drawer, icon -folder, icon-catalog, icon-tab, icon-cards, icon-tree-right, icon-tree, icon-book-open, icon-paperclip, icon-edit, icon-trash, icon-image, icon-search , icon-power, icon-cog, icon-star, icon-star-vazio, icon-new-ticket, icon-dashboard, icon-cart-full, icon-view, icon-label, icon-filter, icon-calendar , icon-script, icon-add, icon-delete, icon-help, icon-info, icon-check-círculo, icon-alert, icon-sort-crescente, icon-console, icon-list, icon-form e ícone-livefeed. |
| título | Cadeia de caracteres | O título de texto do ícone. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.addDecoration('caller_id', 'icon-star', 'preferred member');
GlideForm - addDecoration(cadeia de caracteres fieldName, ícone de cadeia de caracteres, título de cadeia de caracteres, cor de cadeia de caracteres)
Adiciona um ícone ao rótulo de um campo.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo. |
| ícones | Cadeia de caracteres | O ícone de fonte a ser mostrado ao lado do campo. Ícones compatíveis - icon-user, icon-user-group, icon-lightbulb, icon-home, icon-mobile, icon-comment, icon-mail, icon-locked, icon-database, icon-book, icon-drawer, icon -folder, icon-catalog, icon-tab, icon-cards, icon-tree-right, icon-tree, icon-book-open, icon-paperclip, icon-edit, icon-trash, icon-image, icon-search , icon-power, icon-cog, icon-star, icon-star-vazio, icon-new-ticket, icon-dashboard, icon-cart-full, icon-view, icon-label, icon-filter, icon-calendar , icon-script, icon-add, icon-delete, icon-help, icon-info, icon-check-círculo, icon-alert, icon-sort-crescente, icon-console, icon-list, icon-form e ícone-livefeed. |
| título | Cadeia de caracteres | O título de texto do ícone. |
| cor | Cadeia de caracteres | Uma cor de CSS. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.addDecoration('caller_id', 'icon-star', 'Mark as Favorite', 'color-green');
GlideForm – addErrorMessage(cadeia de caracteres mensagem)
Exibe a mensagem de erro especificada na parte superior do formulário.
Essa mensagem aparece por aproximadamente quatro segundos e depois desaparece. Este tempo limite não é configurável no momento.
| Nome | Tipo | Descrição |
|---|---|---|
| message | Cadeia de caracteres | Mensagem a ser exibida. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.addErrorMessage('This is an error');
GlideForm - addFormMessage(cadeia de caracteres mensagem, tipo de cadeia de caracteres, opções de objeto)
Exibe uma mensagem de formulário flutuante na parte superior da seção de detalhes do formulário. A mensagem não cobre ações de IU.
| Nome | Tipo | Descrição |
|---|---|---|
| message | Cadeia de caracteres | Mensagem a ser exibida. |
| tipo | Cadeia de caracteres | O tipo de mensagem. Valores válidos:
|
| opções | Objeto | Opcional. Objeto que contém botões a serem adicionados à mensagem do formulário e todos os metadados necessários para lidar com um clique de botão. |
| opções.botões | Matriz | Matriz de botões a serem adicionados à mensagem do formulário. |
| opções.botões.rótulo | Cadeia de caracteres | Texto a ser exibido no botão. |
| opções.botões.açãoNome | Cadeia de caracteres | Nome usado pelos manipuladores de eventos FORM_MESSAGE_BUTTON_CLICKED para determinar o botão que foi clicado. Por exemplo, se você adicionar um botão com o actionName |
| opções.meta | Objeto | Mapa de todos os metadados necessários para lidar com o clique do botão formatado como pares de chave-valor. Por exemplo, para um botão Atribuir a mim, o manipulador de eventos precisa do sys_id do usuário ao qual atribuir o registro. |
| Tipo | Descrição |
|---|---|
| Nenhum(a) |
O exemplo a seguir mostra como adicionar mensagens de formulário de cada tipo.
g_form.addFormMessage('info message','info');
g_form.addFormMessage('warning message','warning');
g_form.addFormMessage('error message','error');
g_form.addFormMessage('info2 message','info');
g_form.addFormMessage('warning2 message','warning');
g_form.addFormMessage('error2 message','error');
g_form.addFormMessage('Would you like to reassign this to yourself?', 'info', {buttons: [{label: "Assign to me", actionName: "assign_to_me"}], meta: {'userId': '46d44a23a9fe19810012d100cca80666'}});
GlideForm - addInfoMessage(cadeia de caracteres mensagem)
Adiciona a mensagem informativa especificada à parte superior do formulário.
Essa mensagem aparece por aproximadamente quatro segundos e depois desaparece. Este tempo limite não é configurável no momento.
| Nome | Tipo | Descrição |
|---|---|---|
| message | Cadeia de caracteres | Mensagem a ser exibida. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.addInfoMessage('The top five fields in this form are mandatory');
GlideForm - addOption(cadeia de caracteres "fieldName", cadeia de caracteres "choleValue", cadeia de caracteres "choiceLabel")
Adiciona uma opção ao final de um campo de lista de seleção.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo. |
| escolhaValor | Cadeia de caracteres | O valor a ser armazenado no banco de dados. |
| escolhaRótulo | Cadeia de caracteres | O valor exibido. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.addOption('priority', '6', '6 - Really Low');
GlideForm - addOption(cadeia de caracteres "fieldName", cadeia de caracteres "choiceValue", cadeia de caracteres "choiceLabel", "Número" "choiceIndex")
Adiciona uma opção ao campo de lista na posição especificada.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo. |
| escolhaValor | Cadeia de caracteres | O valor armazenado no banco de dados. |
| escolhaRótulo | Cadeia de caracteres | O valor exibido. |
| índicede escolha | Número | Ordem da seleção na lista. O índice está em uma matriz baseada em zero. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.addOption('priority', '2.5', '2.5 - Moderately High', 3);
GlideForm – clearMessages()
Remove todas as mensagens informativas e de erro da parte superior do formulário.
Remove mensagens informativas e de erro adicionadas com g_form.addInfoMessage() e g_form.addErrorMessage().
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.clearMessages();
GlideForm – clearAllFormMessages()
Remove todas as mensagens do formulário de qualquer tipo.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Nenhum(a) |
O exemplo a seguir mostra como limpar todas as mensagens do formulário.
g_form.clearAllFormMessages();
GlideForm – clearFormMessages(tipo de cadeia de caracteres)
Remove todas as mensagens de formulário de um determinado tipo.
| Nome | Tipo | Descrição |
|---|---|---|
| tipo | Cadeia de caracteres | O tipo de mensagem. Valores válidos:
|
| Tipo | Descrição |
|---|---|
| Nenhum(a) |
O exemplo a seguir mostra como limpar todas as mensagens de erro do formulário.
g_form.clearFormMessages('error');
GlideForm - clearOptions(cadeia de caracteres fieldName)
Remove todas as opções da lista de seleção.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm - clearValue(String fieldName)
Remove todos os valores do campo.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – disableAttachments()
Impede que anexos de arquivo sejam adicionados.
Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – enableAttachments()
Permite que anexos de arquivo sejam adicionados. Mostra o ícone de clipe de papel.
Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm - flash (cadeia de caracteres fieldName, cor da cadeia de caracteres, contagem de números)
Usado para chamar a atenção para um campo específico. Pisca na cor especificada por uma duração especificada no campo especificado.
Este método não é compatível com o Catálogo de serviços.
Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Especifica o campo a ser realçado no seguinte formato: "<table-name> .<field-name> " . |
| cor | Cadeia de caracteres | Cor RGB ou cor CSS aceitável. |
| contagem | Número | Especifica por quanto tempo o rótulo ficará intermitente. As opções incluem:
|
| Tipo | Descrição |
|---|---|
| vazio |
g_form.flash("incident.number", "#FFFACD", 0);
GlideForm – getActionName()
Retorna o nome da ação mais recente ou, para um client script, o sys_id da ação de IU clicada.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Cadeia de caracteres | O nome da ação atual. |
function onSubmit() {
var action = g_form.getActionName();
alert('You pressed ' + action);
}
GlideForm – getBooleanValue(cadeia de caracteres fieldName)
Retorna um valor booliano para o campo especificado.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| Tipo | Descrição |
|---|---|
| Booliano | Retorna falso se o valor do campo for falso ou indefinido; caso contrário, retornará verdadeiro. |
GlideForm – getControl(String fieldName)
Retorna o elemento HTML do campo especificado.
Os campos compostos podem conter vários elementos HTML. Este método geralmente não é necessário, pois há métodos internos que usam os campos em um formulário.
Se o campo for um campo de referência e o controle for uma lista de seleção, getControl() poderá não retornar um controle conforme o esperado. Nesse caso, use sys_select.<table name>.<field name> .
Este método não está disponível em scripts móveis ou scripts do Portal de serviços.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| Tipo | Descrição |
|---|---|
| Elemento HTML | O elemento HTML do campo. |
GlideForm – getDecimalValue(cadeia de caracteres fieldName)
Retorna o valor decimal do campo especificado.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo. |
| Tipo | Descrição |
|---|---|
| Cadeia de caracteres | O valor decimal do campo especificado. |
function onChange(control, oldValue, newValue, isLoading) {
alert(g_form.getDecimalValue('percent_complete'));
}
GlideForm – getDisplayBox(cadeia de caracteres fieldName)
Obtém o valor de exibição de um formulário na IU principal.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo do qual você deseja recuperar um valor no formulário. |
| Tipo | Descrição |
|---|---|
| Nenhum |
var caller = g_form.getDisplayBox('caller_id').value;
var assignee = g_form.getDisplayBox('assigned_to').value;
if (caller == assignee)
{
alert('in');
}
GlideForm – getDisplayValue(cadeia de caracteres fieldName)
Obtém o valor de exibição de um formulário em Portal de serviços.
g_form.getDisplayValue() sem um argumento retorna o valor de exibição do registro em vez do valor de exibição de um campo individual.| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo do qual você deseja recuperar um valor no formulário. |
| Tipo | Descrição |
|---|---|
| Nenhum(a) |
O exemplo a seguir mostra como obter o valor de exibição de uma variável de referência na IU principal ou Portal de serviços. O caso de uso deste exemplo está no site da comunidade.
function onChange(control, oldValue, newValue, isLoading) {
if (isLoading || newValue == '') {
return;
}
if(window == null){
var valuePortal = g_form.getDisplayValue('requester');
alert('Portal->' + valuePortal);
}
else{
var valueNative = g_form.getDisplayBox('requester').value;
alert('CoreUI->' + valueCoreUI);
}
//Type appropriate comment here, and begin script below
}
GlideForm – getElement(ID da cadeia de caracteres)
Retorna o elemento HTML especificado pelo parâmetro.
Os campos compostos podem conter vários elementos HTML. Este método geralmente não é necessário, pois há métodos internos que usam os campos em um formulário.
Este método não está disponível em scripts móveis ou scripts do Portal de serviços.
| Nome | Tipo | Descrição |
|---|---|---|
| id | Cadeia de caracteres | O ID do campo. |
| Tipo | Descrição |
|---|---|
| Elemento HTML | O elemento HTML do campo. |
GlideForm – getFormElement()
Retorna o elemento HTML do formulário.
Este método não está disponível em scripts móveis ou scripts do Portal de serviços.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| HTMLFormElement | O elemento HTML do formulário. |
GlideForm – getHelpTextControl(cadeia de caracteres fieldName)
Retorna o elemento HTML do texto de ajuda do campo especificado.
Este método é aplicável somente a variáveis do catálogo de serviços.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| Tipo | Descrição |
|---|---|
| Elemento HTML | Elemento HTML do campo de texto de ajuda. |
GlideForm – getIntValue(cadeia de caracteres fieldName)
Retorna o valor inteiro do campo.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo. |
| Tipo | Descrição |
|---|---|
| Número | Valor inteiro do campo. |
GlideForm – getLabelOf(cadeia de caracteres fieldName)
Retorna o valor de texto simples do rótulo do campo.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo |
| Tipo | Descrição |
|---|---|
| Cadeia de caracteres | O texto do rótulo. |
if (g_user.hasRole('itil')) {
var oldLabel = g_form.getLabelOf('comments');
g_form.setLabelOf('comments', oldLabel + ' (Customer visible)');
}
GlideForm – getOption(cadeia de caracteres "fieldName", cadeia de caracteres "choiceValue")
Retorna o elemento de opção de uma caixa selecionada chamada fieldName em que choiceValue corresponde ao valor da opção.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| escolhaValor | Cadeia de caracteres | Valor da opção. |
| Tipo | Descrição |
|---|---|
| Elemento HTML | O HTMLElement da opção. Retorna nulo se o campo ou a opção não for encontrado. |
O exemplo a seguir mostra como obter o rótulo para um valor de lista de seleção.
// Get the label for a choice list value
// fieldName is 'category'
function onChange(control, oldValue, newValue, isLoading) {
var choiceValue = g_form.getValue('category');
var choiceLabel = g_form.getOption('category', choiceValue).text;
}
GlideForm – getReference(cadeia de caracteres fieldName, retorno de chamada de função)
Retorna o GlideRecord para um campo especificado.
Se uma função de retorno de chamada estiver presente, esta rotina será executada de forma assíncrona. O processamento do navegador (e do script) continua normalmente até que o servidor retorne o valor de referência, momento em que a função de retorno de chamada é invocada. Se uma função de retorno de chamada não estiver presente, esta rotina será executada de forma síncrona e o processamento será interrompido (fazendo com que o navegador apareça travado) enquanto aguarda uma resposta do servidor.
O suporte à função de retorno de chamada para ServiceCatalogForm.getReference está disponível.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| retorno de chamada | Função | Nome da função de retorno de chamada. |
| Tipo | Descrição |
|---|---|
| GlideRecord | Objeto GlideRecord para o campo especificado. Se a referência especificada não puder ser encontrada, ele retornará um objeto GlideRecord inicializado em que currentRow = -1 e rows.length = 0. |
function onChange(control, oldValue, newValue, isLoading) {
g_form.getReference('caller_id', doAlert); // doAlert is our callback function
}
function doAlert(caller) { // reference is passed into callback as first arguments
if (caller.getValue('vip') == 'true') {
alert('Caller is a VIP!');
}
}
GlideForm – getRelatedListNames()
Retorna uma matriz de nomes de lista relacionada do formulário atual.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Matriz | Matriz de cadeia de caracteres de nomes de lista relacionada do formulário atual. Os nomes das listas relacionadas são listados na ordem em que aparecem no formulário. |
var listNames = g_form.getRelatedListNames();
for (var i = 0; i < listNames.length; i++) {
this.showRelatedList(listNames[i]);
}
GlideForm – getSectionNames()
Retorna todos os nomes de seção, visíveis ou não.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Matriz de cadeias de caracteres | Os nomes das seções. |
GlideForm – getSections()
Retorna uma matriz de seções do formulário.
Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Matriz de elementos HTML | As seções do formulário. |
function onChange(control, oldValue, newValue, isLoading) {
//this example was run on a form divided into sections (Change form)
// and hid a section when the "state" field was changed
var sections = g_form.getSections();
if (newValue == '2') {
g_form.setSectionDisplay(sections[1], false);
} else {
g_form.setSectionDisplay(sections[1], true);
}
}
GlideForm – getTableName()
Retorna o nome da tabela à qual este registro pertence.
No lado do servidor, a tabela do registro atual pode ser recuperada com current.sys_class_name ou current.getTableName().
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Cadeia de caracteres | Nome da tabela. |
function onLoad() {
if (g_form.isNewRecord()) {
var tableName = g_form.getTableName(); //Get the table name
}
}
GlideForm – getUniqueValue()
Retorna o sys_id do registro exibido no formulário.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Cadeia de caracteres | O sys_id do registro. |
function onLoad() {
var incSysid = g_form.getUniqueValue();
alert(incSysid);
}
GlideForm – getValue(cadeia de caracteres fieldName)
Retorna o valor do campo de formulário especificado.
Este método também oferece suporte à obtenção de valores de um conjunto de variáveis com várias linhas (MRVS). Para obter dados de campos em um MRVS, você deve primeiro usar JSON.parse(getValue(' <mrvs_field_name> ') || '[]') para obter a matriz MRVS e usar a indexação para acessar os campos nos objetos de linha. Para obter mais detalhes, consulte o exemplo de código abaixo.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo cujo valor será retornado. |
| Tipo | Descrição |
|---|---|
| Cadeia de caracteres | Valor do campo especificado. |
O exemplo a seguir mostra como obter a descrição resumida do formulário atual.
function onChange(control, oldValue, newValue, isLoading) {
alert(g_form.getValue('short_description'));
}
O exemplo a seguir mostra como obter valores de um MRVS. Neste exemplo, os salários estão sendo gerenciados por meio do Catálogo de serviços. O client script pesquisa todas as linhas no MRVS em busca do valor inserido no cargo e atualiza as entradas correspondentes no MRVS com o que está inserido no campo Salário. O MRVS é chamado de "variable_set_1" e contém os seguintes campos em cada objeto de linha: Nome do funcionário [employee_name], Cargo [employee_job_title] e Salário [employee_salary]. Além disso, o Item do catálogo contém: Cargo [job_title] e Salário [salário].
function onChange(control, oldValue, newValue, isLoading) {
if (isLoading || newValue == '') {
return;
}
// Get the MRVS
var vs1 = g_form.getValue('variable_set_1') || '[]';
var multiRowVariableSet = JSON.parse(vs1);
for (var i = 0; i < multiRowVariableSet.length; i++) {
// Check if the entered job title matches the title in the current MRVS row
if (multiRowVariableSet[i].employee_job_title == g_form.getValue("job_title")){
// Update the value of a matching field with the new salary
multiRowVariableSet[i].employee_salary = newValue;
}
}
// Update the MRVS
g_form.setValue('variable_set_1', JSON.stringify(multiRowVariableSet));
}
GlideForm – hideAllFieldMsgs()
Oculta todas as mensagens de campo.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – hideAllFieldMsgs(tipo de cadeia de caracteres)
Oculta todas as mensagens de campo do tipo especificado.
| Nome | Tipo | Descrição |
|---|---|---|
| tipo | Cadeia de caracteres | O tipo de mensagem. Valores válidos:
|
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – hideErrorBox(cadeia de caracteres fieldName)
Oculta a mensagem de erro colocada por showErrorBox().
Sempre que possível, use hideFieldMsg() em vez deste método.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo ou controle. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – hideFieldMsg(cadeia de caracteres fieldName, booliano clearAll)
Oculta a primeira mensagem que aparece no campo especificado no formulário atual.
Use os métodos GlideForm - showFieldMsg(cadeia de caracteres de campo, mensagem de cadeia de caracteres, tipo de cadeia de caracteres) ou GlideForm - showFieldMsg(cadeia de caracteres de campo, mensagem de cadeia de caracteres, tipo de cadeia de caracteres, rollForm booliano) para exibir mensagens em um formulário.
work_notes de um formulário e ocultar a primeira mensagem: g_form.showFieldMsg('work_notes', 'First message', "error");
g_form.showFieldMsg('work_notes', 'Second message', "error");
g_form.hideFieldMsg('work_notes', false); // This call hides the 'First message'| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo no qual a mensagem será ocultada. |
| limparTudo | Booliano | Opcional. Sinalizador que indica se todas as mensagens do campo especificado devem ser ocultadas. Valores válidos:
Padrão: falso |
| Tipo | Descrição |
|---|---|
| vazio |
O exemplo a seguir mostra como limpar todas as mensagens de um campo de formulário especificado e exibir uma mensagem de erro de criptografia.
function submitEncryptedInputs() {
return processEncryptedInputs(function(inputName, fieldName) {
if (!checkEncryptedFieldValue(fieldName)) {
g_form.hideFieldMsg(fieldName, true); // Hide all messages for the specified field
g_form.showFieldMsg(fieldName, "Your activity requires an encrypted input.", "error");
return false;
}
return true;
});
}
GlideForm – hideRelatedList(cadeia de caracteres listTableName)
Oculta a lista relacionada especificada no formulário.
Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.
| Nome | Tipo | Descrição |
|---|---|---|
| listTableName | Cadeia de caracteres | Nome da lista relacionada. Use o sys_id para ocultar uma lista por meio de um relacionamento. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – hideRelatedLists()
Oculta todas as listas relacionadas no formulário.
Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – isLiveUpdating()
Retorna verdadeiro enquanto uma atualização em tempo real está sendo feita no registro que o formulário está mostrando.
Isso pode ser usado em um client script onChange() para determinar se uma mudança no registro é devido a uma atualização em tempo real de outra sessão. O script do cliente pode decidir qual ação executar ou não. Isso se aplica a sistemas que usam IU principal com formulários dinâmicos habilitados.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Booliano | Retorna verdadeiro se uma atualização em tempo real estiver acontecendo no registro exibido pelo formulário. |
GlideForm – isMandatory(String fieldName)
Retorna verdadeiro se o campo for obrigatório.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| Tipo | Descrição |
|---|---|
| Booliano | Verdadeiro se o campo for obrigatório, caso contrário, falso. |
GlideForm – isNewRecord()
Retorna verdadeiro se o registro nunca foi salvo.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Booliano | Retorna verdadeiro se o registro não tiver sido salvo; caso contrário, falso. |
function onLoad() {
if(g_form.isNewRecord()){
alert('New Record!');
}
}
GlideForm – isSectionVisible(cadeia de caracteres "sectionName")
Retorna verdadeiro se a seção estiver visível.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| Booliano | Retorna verdadeiro quando a seção está visível; caso contrário, falso será retornado. |
GlideForm – isVisible(cadeia de caracteres fieldName)
Determina se o campo associado ao nome do campo passado está visível no formulário atual.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo para verificar se ele está visível no formulário atual. |
| Tipo | Descrição |
|---|---|
| Booliano | Sinalizador que indica se o campo especificado está visível no formulário atual. Valores válidos:
|
O exemplo de código a seguir mostra como verificar se o campo user_address está visível no formulário atual.
if(g_form.isVisible('user_address')) {
alert('is visible');
}
else {
alert('is hidden');
}
GlideForm – onUserChangeValue(Função fn)
Registra um ouvinte de eventos personalizado que detecta quando qualquer campo no formulário atual é modificado por um usuário.
Quando um campo de formulário é modificado, o ouvinte de eventos chama a função que é passada quando o ouvinte é registrado inicialmente. Este ouvinte só é acionado quando um usuário faz uma mudança em um campo no formulário. Mudanças de client scripts, políticas de IU ou quaisquer outras interações que não sejam do usuário não acionam o ouvinte.
| Nome | Tipo | Descrição |
|---|---|---|
| fn | Função | Função a ser chamada quando um usuário altera o valor de um campo no formulário atual. Na verdade, este é o código da função, não apenas o nome da função. Esta função deve aceitar os três seguintes argumentos:
|
| Tipo | Descrição |
|---|---|
| Função | Função a ser chamada para cancelar o registro do ouvinte de eventos onUserChangeValue. |
var handler = function(fieldname, originalValue, newValue) {
console.log('The field ('+ fieldname + ') has a new value of: ' + newValue); // function code
}
var unregister = g_form.onUserChangeValue(handler);
// To unregister the event listener
unregister();
GlideForm – refreshSlushbucket(cadeia de caracteres fieldName)
Você pode atualizar uma variável do coletor de lista.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do bucket de slush. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.refreshSlushbucket('bucket');
GlideForm - removeDecoration(cadeia de caracteres fieldname, ícone de cadeia de caracteres, título de cadeia de caracteres)
Remove o ícone do campo especificado que corresponde ao ícone e ao título.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| ícones | Cadeia de caracteres | Nome do ícone a ser removido. |
| título | Cadeia de caracteres | O título de texto do ícone (nome). |
| Tipo | Descrição |
|---|---|
| vazio |
function onChange(control, oldValue, newValue, isLoading) {
// if the caller_id field is not present, then we can't add an icon anywhere
if (!g_form.hasField('caller_id'))
return;
if (!newValue)
return;
g_form.getReference('caller_id', function(ref) {
g_form.removeDecoration('caller_id', 'icon-star', 'VIP');
if (ref.getValue('vip') == 'true')
g_form.addDecoration('caller_id', 'icon-star', 'VIP');
});
}
GlideForm - removeDecoration(cadeia de caracteres fieldname, ícone de cadeia de caracteres, título de cadeia de caracteres, cor de cadeia de caracteres)
Remove o ícone do campo especificado que corresponde ao ícone, título e cor.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| ícones | Cadeia de caracteres | Nome do ícone a ser removido. |
| título | Cadeia de caracteres | O título de texto do ícone (nome). |
| cor | Cadeia de caracteres | Uma cor de CSS |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.removeDecoration('caller_id', 'icon-star', 'VIP', 'blue');
GlideForm - removeOption(cadeia de caracteres "fieldName", cadeia de caracteres "choiceValue")
Remove a opção especificada da lista de seleção.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| escolhaValor | Cadeia de caracteres | O valor armazenado no banco de dados. Este não é o rótulo. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.removeOption('priority', '1');
GlideForm – salvar ()
Salva o registro sem sair da navegação (atualizar e permanecer).
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – setMandatory(cadeia de caracteres fieldName, booliano obrigatório)
Torna o campo especificado obrigatório.
Sempre que possível, use uma política de IU em vez deste método.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| obrigatória | Booliano | Quando verdadeiro, o campo é obrigatório. Quando falso, torna o campo opcional. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – setSectionDisplay(cadeia de caracteres "sectionName", exibição booliana)
Mostra ou oculta uma seção.
| Nome | Tipo | Descrição |
|---|---|---|
| sectionName | Cadeia de caracteres | O nome da seção está em minúsculas com um sublinhado substituindo o primeiro espaço no nome e com os espaços restantes sendo removidos, por exemplo, "Seção quatro está aqui" se torna "section_Fourishere". Outros caracteres não alfanuméricos, como e comercial (&), são removidos. Os nomes de seção podem ser encontrados usando o método getSectionNames(). |
| tela | Booliano | Quando verdadeiro, mostra a seção. Quando falso, oculta a seção. |
| Tipo | Descrição |
|---|---|
| Booliano | Retorna verdadeiro quando bem-sucedido. |
GlideForm - setValue(cadeia de caracteres fieldName, cadeia de caracteres valor, cadeia de caracteres displayValue)
Define o valor de um campo de formulário especificado como o valor de um valor de exibição especificado em um registro de referência.
Para melhorar o desempenho, evitando um retorno ao definir o valor de um campo de referência, use este método, não setValue(fieldName, value). Ao definir vários valores de referência para um campo de coletor de lista, passe matrizes nos parâmetros value e displayValue.
setValue(shortDesc, newValue.toUpperCase());, valide se a descrição resumida ainda não está em maiúscula. Isso impedirá que o client script aplique toUpperCase() mais de uma vez.| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo de formulário a ser atualizado. |
| valor | Cadeia de caracteres ou matriz | Sys_id do registro de referência a ser usado para atualizar o campo. Se o campo especificado for um GlideList, este parâmetro poderá conter uma matriz de sys_ids. Nesse caso, o método executa uma pesquisa de todos os registros especificados na matriz e esses valores são usados para atualizar o conteúdo do campo especificado (lista relacionada). Nota:
Ao definir um valor em uma lista de seleção, certifique-se de usar o valor numérico em vez do rótulo. |
| displayValue | Cadeia de caracteres ou matriz | Campo no registro de referência especificado a ser usado para atualizar o campo especificado. Por exemplo, na tabela Usuário [sys_user], pode ser userName. Se o campo especificado for um GlideList, este parâmetro poderá conter uma matriz de nomes de valor de exibição. Para obter informações adicionais sobre valores de exibição, consulte Valor de exibição. |
| Tipo | Descrição |
|---|---|
| vazio |
Este exemplo mostra a passagem do sys_id do registro de referência que contém o campo userName a ser usado para atualizar o campo de formulário assigned_to.
g_form.setValue('assigned_to', userSysID, userName);
Este exemplo mostra a passagem de uma matriz de sys_ids do registro de referência e uma matriz de nomes de valor de exibição correspondentes a serem usados para atualizar os campos de formulário no GlideList glide-list_field_name.
g_form.setValue('glide-list_field_name', sysIDArray, displayNameArray);
GlideForm – showErrorBox(cadeia de caracteres nome, cadeia de caracteres mensagem, booliano rollForm)
Exibe uma mensagem de erro no campo de formulário especificado (um objeto de controle ou o nome do campo). Se o controle ou campo estiver fora da tela e o parâmetro rollForm for verdadeiro, o formulário será rolado para o controle ou campo.
Está disponível uma propriedade global (glide.ui.scroll_to_message_field) que controla a rolagem automática de mensagens quando o campo do formulário está fora da tela (rola o formulário para o controle ou campo). O método showFieldMsg() é um método semelhante que requer um parâmetro de tipo.
| Nome | Tipo | Descrição |
|---|---|---|
| nome | Cadeia de caracteres | Nome do campo ou controle. |
| mensagem | Cadeia de caracteres | Mensagem a ser exibida. |
| rolarFormulário | Booliano | Quando verdadeiro, rola o formulário para o campo. Quando falso, o formulário não rola para o campo. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm - showFieldMsg(cadeia de caracteres de campo, mensagem de cadeia de caracteres, tipo de cadeia de caracteres)
Exibe uma mensagem informativa ou de erro no campo de formulário especificado (um objeto de controle ou o nome do campo). Se o controle ou o campo estiver fora da tela, o formulário será rolado para o campo.
Está disponível uma propriedade global (glide.ui.scroll_to_message_field) que controla a rolagem automática de mensagens quando o campo do formulário está fora da tela (rola o formulário para o controle ou campo).
O método showErrorBox() é um método abreviado que não requer o parâmetro de tipo.
| Nome | Tipo | Descrição |
|---|---|---|
| Assunto: | Cadeia de caracteres | Nome do campo ou controle. |
| mensagem | Cadeia de caracteres | Mensagem a ser exibida. |
| tipo | Cadeia de caracteres | "erro", "informações" ou "aviso". |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.showFieldMsg('impact','Low impact response time can be one week','info');
GlideForm - showFieldMsg(cadeia de caracteres de campo, mensagem de cadeia de caracteres, tipo de cadeia de caracteres, rollForm booliano)
Exibe uma mensagem informativa ou de erro no campo de formulário especificado (um objeto de controle ou o nome do campo). Se o controle ou o campo estiver fora da tela e o rollForm for verdadeiro, o formulário será rolado para o campo.
Está disponível uma propriedade global (glide.ui.scroll_to_message_field) que controla a rolagem automática de mensagens quando o campo do formulário está fora da tela (rola o formulário para o controle ou campo).
O método showErrorBox() é um método abreviado que não requer o parâmetro de tipo.
| Nome | Tipo | Descrição |
|---|---|---|
| Assunto: | Cadeia de caracteres | Nome do campo ou controle. |
| mensagem | Cadeia de caracteres | Mensagem a ser exibida. |
| tipo | Cadeia de caracteres | "erro", "informações" ou "aviso". |
| rolarFormulário | Booliano | Quando verdadeiro, o formulário rola para o campo se ele estiver fora da tela. Quando falso, o formulário não rola. |
| Tipo | Descrição |
|---|---|
| vazio |
g_form.showFieldMsg('impact','Low impact not allowed with High priority','error',false);
GlideForm – setDisabled(cadeia de caracteres fieldName, Booliano disable)
Torna o campo especificado disponível ou indisponível.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| desativar | Booliano | Quando verdadeiro, desabilita o campo. Quando falso, habilita o campo. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm - setDisplay(cadeia de caracteres fieldName, exibição booliana)
Exibe ou oculta um campo.
Este método não pode ocultar um campo obrigatório sem valor. Se o campo estiver oculto, o espaço será usado para exibir outros itens. Sempre que possível, use uma política de IU em vez deste método.
| Nome | Tipo | Descrição |
|---|---|---|
| nome do campo | Cadeia de caracteres | Nome do campo. |
| tela | Booliano | Quando verdadeiro, exibe o campo, quando falso, oculta o campo. |
| Tipo | Descrição |
|---|---|
| vazio |
function onChange(control, oldValue, newValue, isLoading, isTemplate) {
//If the page isn't loading
if (!isLoading) {
//If the new value isn't blank
if (newValue != '') {
g_form.setDisplay('priority', false);
}
else
g_form.setDisplay('priority', true);
}
}
GlideForm – setLabelOf(cadeia de caracteres fieldName, cadeia de caracteres rótulo)
Define o valor de texto simples do rótulo do campo.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo. |
| rótulo | Cadeia de caracteres | O rótulo de texto do campo. |
| Tipo | Descrição |
|---|---|
| vazio |
if (g_user.hasRole('itil')) {
var oldLabel = g_form.getLabelOf('comments');
g_form.setLabelOf('comments', oldLabel + ' (Customer visible)');
}
GlideForm – setReadOnly(cadeia de caracteres fieldName, booliano readOnly)
Torna o campo especificado somente leitura ou editável.
Sempre que possível, use uma política de IU em vez deste método.
Para tornar um campo obrigatório somente leitura, você deve primeiro remover o requisito obrigatório desse campo usando o método setMandatory().
Depois de definir um campo como somente leitura, você não poderá usar o método setValue() para atualizar o valor desse campo. Se você precisar definir o valor dessa forma, deverá definir o valor readOnly como falso.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo. |
| readOnly | Booliano | Sinalizador que determina se o campo associado é editável ou somente leitura. Valores possíveis:
|
| Tipo | Descrição |
|---|---|
| Nenhum(a) |
O exemplo a seguir mostra como definir o Editor de variáveis como somente leitura. Para fazer isso em tabelas Catálogo de serviços, use setVariablesReadOnly().
// Create a Client Script on a table (e.g., incident) and paste this script
// Uncheck (set to false) the "isolate script" checkbox (not available by default)
// To add the isolate script checkbox to the form, configure form layout to add the checkbox
function onLoad() {
$("variable_map").querySelectorAll("item").forEach(function(item){
var variable = item.getAttribute("qname");
g_form.setReadOnly("variables."+ variable, true);
});
}
GlideForm - setValue(cadeia de caracteres fieldName, valor de cadeia de caracteres)
Define o valor de um campo de formulário especificado para o valor passado.
Este método também oferece suporte à definição de valores em um conjunto de variáveis com várias linhas (MRVS). Você deve primeiro usar JSON.parse(getValue(' <mrvs_field_name> ')) para obter a matriz MRVS e usar a indexação para atualizar os campos nos objetos de linha. Depois que todos os valores forem atualizados no MRVS, use o método setValue() para salvar a matriz do MRVS atualizada. Para obter mais detalhes, consulte o exemplo de código abaixo.
setValue(shortDesc, newValue.toUpperCase());, valide se a descrição resumida ainda não está em maiúscula. Isso impedirá que o client script aplique toUpperCase() mais de uma vez.| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | Nome do campo de formulário a ser atualizado. |
| valor | Cadeia de caracteres | Valor de cadeia de caracteres a ser definido no campo especificado. Nota: Ao definir um valor em uma lista de seleção, certifique-se de usar o valor numérico em vez do rótulo. |
| Tipo | Descrição |
|---|---|
| vazio |
O exemplo a seguir mostra como definir a descrição resumida no formulário atual.
g_form.setValue('short_description', 'replace this with appropriate text');
O exemplo a seguir mostra como definir valores em um MRVS. Neste exemplo, os salários estão sendo gerenciados por meio do Catálogo de serviços. O client script pesquisa todas as linhas no MRVS em busca do valor inserido no cargo e atualiza as entradas correspondentes no MRVS com o que está inserido no campo Salário. O MRVS é chamado de "variable_set_1" e contém os seguintes campos em cada objeto de linha: Nome do funcionário [employee_name], Cargo [employee_job_title] e Salário [employee_salary]. Além disso, o Item do catálogo contém: Cargo [job_title] e Salário [salário].
function onChange(control, oldValue, newValue, isLoading) {
if (isLoading || newValue == '') {
return;
}
// Get the MRVS
var multiRowVariableSet = JSON.parse(g_form.getValue('variable_set_1'));
for (var i = 0; i < multiRowVariableSet.length; i++) {
// Check if the entered job title matches the title in the current MRVS row
if (multiRowVariableSet[i].employee_job_title == g_form.getValue("job_title")){
// Update the value of a matching field with the new salary
multiRowVariableSet[i].employee_salary = newValue;
}
}
// Update the MRVS
g_form.setValue('variable_set_1', JSON.stringify(multiRowVariableSet));
}
GlideForm – setVariablesReadOnly(Booliano isReadOnly)
Torna um editor de variáveis Catálogo de serviços somente leitura.
O método deve ser colocado no client script da tabela na qual o editor de variáveis é adicionado, como Item solicitado [sc_req_item], Incidente [incident] e assim por diante. Para definir variáveis para leitura somente em outras tabelas, use o método setReadOnly().
Consulte também: Editores de variáveis do Catálogo de serviços
| Nome | Tipo | Descrição |
|---|---|---|
| isReadOnly | Booliano | Sinalizador que determina se o editor de variáveis é somente leitura. Valores possíveis:
Padrão: falso |
| Tipo | Descrição |
|---|---|
| Nenhum(a) |
Adicionar a seguinte linha a um client script define o editor de variáveis como somente leitura.
g_form.setVariablesReadOnly(true);
GlideForm – setVisible(cadeia de caracteres fieldName, exibição booliana)
Exibe ou oculta o campo.
Na IU da área de trabalho, o espaço é deixado em branco quando oculto. Na IU para celular ou no Portal de serviços, o espaço é preenchido em Meus outros campos quando oculto. Este método não pode ocultar campos obrigatórios sem valor.
Use a Política de IU em vez deste método sempre que possível.
| Nome | Tipo | Descrição |
|---|---|---|
| fieldName | Cadeia de caracteres | O nome do campo. |
| tela | Booliano | Quando verdadeiro, exibe o campo. Quando falso, oculta o campo. |
| Tipo | Descrição |
|---|---|
| vazio |
function onChange(control, oldValue, newValue, isLoading, isTemplate) {
//If the page isn't loading
if (!isLoading) {
//If the new value isn't blank
if(newValue != '') {
g_form.setVisible('priority', false);
}
else
g_form.setVisible('priority', true);
}
}
GlideForm – showErrorBox(cadeia de caracteres nome, cadeia de caracteres mensagem)
Exibe uma mensagem de erro no campo de formulário especificado (um objeto de controle ou o nome do campo). Se o controle ou campo estiver fora da tela, o formulário rolará para o controle ou campo.
Está disponível uma propriedade global (glide.ui.scroll_to_message_field) que controla a rolagem automática de mensagens quando o campo do formulário está fora da tela (rola o formulário para o controle ou campo). O método showFieldMsg() é um método semelhante que requer um parâmetro de tipo.
| Nome | Tipo | Descrição |
|---|---|---|
| nome | Cadeia de caracteres | O nome do controle ou campo. |
| mensagem | Cadeia de caracteres | A mensagem a ser exibida. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – showRelatedList(cadeia de caracteres listTableName)
Exibe a lista relacionada especificada no formulário.
Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.
| Nome | Tipo | Descrição |
|---|---|---|
| listTableName | Cadeia de caracteres | Nome da lista relacionada. |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – showRelatedLists()
Exibe todas as listas relacionadas ao formulário.
Este método não está disponível na plataforma móvel. Se este método for executado em uma plataforma móvel, nenhuma ação ocorrerá.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm – enviar()
Salva o registro.
O usuário é retirado do formulário, retornando-o para onde estava.
| Nome | Tipo | Descrição |
|---|---|---|
| Nenhum |
| Tipo | Descrição |
|---|---|
| vazio |
GlideForm - submit (verbo da cadeia de caracteres)
Executa a ação de IU especificada pelo parâmetro.
| Nome | Tipo | Descrição |
|---|---|---|
| verbo | Cadeia de caracteres | Um action_name de um registro sys_ui_action. O nome da ação deve ser para um botão de formulário visível. |
| Tipo | Descrição |
|---|---|
| vazio |