GlideForm : client
L’API GlideForm fournit des méthodes pour personnaliser les formulaires.
GlideForm.js est la classe JavaScript contenant les méthodes. La g_form d’objet global est utilisée pour accéder aux méthodes GlideForm . Les méthodes GlideForm ne sont utilisées que sur le client. Ces méthodes sont utilisées pour apporter des modifications personnalisées à la vue de formulaire des enregistrements. Toute la validation des exemples a été effectuée à l’aide de scripts clients.
Certaines de ces méthodes peuvent également être utilisées dans d’autres scripts clients (tels que les scripts clients de catalogue ou les scripts clients d’assistants), mais vous devez d’abord les tester pour déterminer si elles fonctionneront comme prévu.
Il n’existe aucun constructeur pour la classe GlideForm . Accédez aux méthodes GlideForm à l’aide de l’objet global g_form.
GlideForm - addDecoration(String fieldName, icône de chaîne, titre de chaîne)
Ajoute une icône sur l’étiquette d’un champ.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Le nom du champ. |
| icône | Chaîne | Icône de police à afficher à côté du champ. Icônes prises en charge : 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, icon-star-empty, 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-circle, icon-alert, icon-sort-ascending, icon-console, icon-list, icon-form et icon-livefeed. |
| Titre | Chaîne | Le titre textuel de l’icône. |
| Type | Description |
|---|---|
| nul |
g_form.addDecoration('caller_id', 'icon-star', 'preferred member');
GlideForm : addDecoration(String fieldName, String icon, String title, String color)
Ajoute une icône sur l’étiquette d’un champ.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Le nom du champ. |
| icône | Chaîne | Icône de police à afficher à côté du champ. Icônes prises en charge : 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, icon-star-empty, 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-circle, icon-alert, icon-sort-ascending, icon-console, icon-list, icon-form et icon-livefeed. |
| Titre | Chaîne | Le titre textuel de l’icône. |
| couleur | Chaîne | Une couleur CSS. |
| Type | Description |
|---|---|
| nul |
g_form.addDecoration('caller_id', 'icon-star', 'Mark as Favorite', 'color-green');
GlideForm : addErrorMessage (message de chaîne)
Affiche le message d’erreur spécifié en haut du formulaire.
Ce message apparaît pendant environ quatre secondes, puis disparaît. Ce délai n’est pas configurable pour l’instant.
| Nom | Type | Description |
|---|---|---|
| message | Chaîne | Message à afficher. |
| Type | Description |
|---|---|
| nul |
g_form.addErrorMessage('This is an error');
GlideForm - addFormMessage(message de chaîne, type de chaîne, options d’objet)
Affiche un message de formulaire flottant en haut de la section de détails du formulaire. Le message ne couvre pas les actions d’interface utilisateur.
| Nom | Type | Description |
|---|---|---|
| message | Chaîne | Message à afficher. |
| type | Chaîne | Le type de message. Valeurs valides :
|
| options | Objet | Facultatif. Objet contenant des boutons à ajouter au message du formulaire et toutes les métadonnées nécessaires pour gérer un clic sur un bouton. |
| options.boutons | Tableau | Tableau de boutons à ajouter au message du formulaire. |
| options.boutons.étiquette | Chaîne | Texte à afficher sur le bouton. |
| options.buttons.actionName | Chaîne | Nom utilisé par les gestionnaires d’événements FORM_MESSAGE_BUTTON_CLICKED pour déterminer le bouton sur lequel vous avez cliqué. Par exemple, si vous ajoutez un bouton avec le |
| options.meta | Objet | Carte de toutes les métadonnées nécessaires pour gérer le clic sur le bouton, au format de paires clé-valeur. Par exemple, pour un bouton Me l’affecter, le gestionnaire d’événements a besoin de l’sys_id de l’utilisateur auquel affecter l’enregistrement. |
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment ajouter des messages de formulaire de chaque type.
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 (message de chaîne)
Ajoute le message d’information spécifié en haut du formulaire.
Ce message apparaît pendant environ quatre secondes, puis disparaît. Ce délai n’est pas configurable pour l’instant.
| Nom | Type | Description |
|---|---|---|
| message | Chaîne | Message à afficher. |
| Type | Description |
|---|---|
| nul |
g_form.addInfoMessage('The top five fields in this form are mandatory');
GlideForm : addOption(String fieldName, String choiceValue, String choiceLabel)
Ajoute un choix à la fin d’un champ de liste de choix.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Valeur du choix | Chaîne | Valeur à stocker dans la base de données. |
| Étiquette de choix | Chaîne | Valeur affichée. |
| Type | Description |
|---|---|
| nul |
g_form.addOption('priority', '6', '6 - Really Low');
GlideForm : addOption(String fieldName, String choiceValue, String choiceLabel, Number choiceIndex)
Ajoute un choix au champ de liste à la position spécifiée.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Le nom du champ. |
| Valeur du choix | Chaîne | La valeur stockée dans la base de données. |
| Étiquette de choix | Chaîne | Valeur affichée. |
| Index de choix | Numéro | Ordre du choix dans la liste. L’index se trouve dans un tableau basé sur zéro. |
| Type | Description |
|---|---|
| nul |
g_form.addOption('priority', '2.5', '2.5 - Moderately High', 3);
GlideForm : clearMessages()
Supprime tous les messages d’information et d’erreur du haut du formulaire.
Supprime les messages d’information et d’erreur ajoutés avec g_form.addInfoMessage() et g_form.addErrorMessage().
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
g_form.clearMessages();
GlideForm : clearAllFormMessages()
Supprime tous les messages de formulaire, quel que soit leur type.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment effacer tous les messages du formulaire.
g_form.clearAllFormMessages();
GlideForm : clearFormMessages(type de chaîne)
Supprime tous les messages de formulaire d’un type donné.
| Nom | Type | Description |
|---|---|---|
| type | Chaîne | Le type de message. Valeurs valides :
|
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment effacer tous les messages d’erreur du formulaire.
g_form.clearFormMessages('error');
GlideForm : clearOptions(String fieldName)
Supprime toutes les options de la liste de choix.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| nul |
GlideForm : clearValue(String fieldName)
Supprime toutes les valeurs du champ.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| nul |
GlideForm : disableAttachments()
Empêche l’ajout de pièces jointes.
Cette méthode n’est pas disponible sur Mobile Platform. Si cette méthode est exécutée sur une plate-forme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : enableAttachments()
Permet d’ajouter des pièces jointes de fichier. Affiche l’icône de trombone.
Cette méthode n’est pas disponible sur Mobile Platform. Si cette méthode est exécutée sur une plate-forme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm - flash(Nom du champ de chaîne, Couleur de la chaîne, Nombre de nombres)
Utilisé pour attirer l’attention sur un domaine particulier. Fait clignoter la couleur spécifiée pendant une durée spécifiée dans le champ spécifié.
Cette méthode n’est pas prise en charge par Service Catalog.
Cette méthode n’est pas disponible sur Mobile Platform. Si cette méthode est exécutée sur une plate-forme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Spécifie le champ à mettre en surbrillance au format suivant : « <table-name>.<field-name> ». |
| couleur | Chaîne | Couleur RVB ou couleur CSS acceptable. |
| compter | Numéro | Spécifie la durée de clignotement de l’étiquette. Les options incluent :
|
| Type | Description |
|---|---|
| nul |
g_form.flash("incident.number", "#FFFACD", 0);
GlideForm : getActionName()
Renvoie le nom de l’action la plus récente ou, pour un script client, la sys_id de l’action d’interface utilisateur sur laquelle vous avez cliqué.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Chaîne | Nom de l’action actuelle. |
function onSubmit() {
var action = g_form.getActionName();
alert('You pressed ' + action);
}
GlideForm : getBooleanValue(String fieldName)
Renvoie une valeur booléenne pour le champ spécifié.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| Booléen | Renvoie la valeur false si la valeur du champ est false ou non définie ; sinon, renvoie la valeur true. |
GlideForm : getControl(String fieldName)
Renvoie l’élément HTML pour le champ spécifié.
Les champs composés peuvent contenir plusieurs éléments HTML. Cette méthode n’est généralement pas nécessaire, car il existe des méthodes intégrées qui utilisent les champs d’un formulaire.
Si le champ est un champ de référence et que le contrôle est une liste de choix, getControl() peut ne pas renvoyer un contrôle comme prévu. Dans ce cas, utilisez sys_select.<table name>.<nom de champ>.
Cette méthode n’est pas disponible dans les scripts Mobile ou les scripts Service Portal.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| HTMLElement | Élément HTML du champ. |
GlideForm : getDecimalValue(String fieldName)
Renvoie la valeur décimale du champ spécifié.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| Chaîne | Valeur décimale du champ spécifié. |
function onChange(control, oldValue, newValue, isLoading) {
alert(g_form.getDecimalValue('percent_complete'));
}
GlideForm : getDisplayBox(String fieldName)
Obtient la valeur d’affichage d’un formulaire dans l’interface utilisateur principale.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ à partir duquel vous souhaitez récupérer une valeur dans le formulaire. |
| Type | Description |
|---|---|
| Néant |
var caller = g_form.getDisplayBox('caller_id').value;
var assignee = g_form.getDisplayBox('assigned_to').value;
if (caller == assignee)
{
alert('in');
}
GlideForm : getDisplayValue(String fieldName)
Obtient la valeur d’affichage d’un formulaire dans Portail de services.
g_form.getDisplayValue() sans argument renvoie la valeur d’affichage de l’enregistrement plutôt que la valeur d’affichage d’un champ individuel.| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ à partir duquel vous souhaitez récupérer une valeur dans le formulaire. |
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment obtenir la valeur d’affichage d’une variable de référence dans l’interface utilisateur principale ou Portail de services. Le cas d’utilisation de cet exemple se trouve sur le site de la communauté .
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(String id)
Renvoie l’élément HTML spécifié par le paramètre.
Les champs composés peuvent contenir plusieurs éléments HTML. Cette méthode n’est généralement pas nécessaire, car il existe des méthodes intégrées qui utilisent les champs d’un formulaire.
Cette méthode n’est pas disponible dans les scripts Mobile ou les scripts Service Portal.
| Nom | Type | Description |
|---|---|---|
| ID | Chaîne | L’ID du champ. |
| Type | Description |
|---|---|
| HTMLElement | Élément HTML du champ. |
GlideForm : getFormElement()
Renvoie l’élément HTML pour le formulaire.
Cette méthode n’est pas disponible dans les scripts Mobile ou les scripts Service Portal.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Élément HtmlForm | L’élément HTML pour le formulaire. |
GlideForm : getHelpTextControl(String fieldName)
Renvoie l’élément HTML du texte d’aide pour le champ spécifié.
Cette méthode s’applique uniquement aux variables du catalogue de services.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| HTMLElement | Élément HTML du champ de texte d’aide. |
GlideForm : getIntValue(String fieldName)
Renvoie la valeur entière du champ.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Le nom du champ. |
| Type | Description |
|---|---|
| Numéro | Valeur entière du champ. |
GlideForm : getLabelOf(String fieldName)
Renvoie la valeur de texte brut de l’étiquette de champ.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Le nom du champ |
| Type | Description |
|---|---|
| Chaîne | Le texte de l’étiquette. |
if (g_user.hasRole('itil')) {
var oldLabel = g_form.getLabelOf('comments');
g_form.setLabelOf('comments', oldLabel + ' (Customer visible)');
}
GlideForm : getOption(String fieldName, String choiceValue)
Renvoie l’élément d’option pour une zone sélectionnée nommée fieldName où choiceValue correspond à la valeur de l’option.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Valeur du choix | Chaîne | Valeur de l’option. |
| Type | Description |
|---|---|
| HTMLElement | Le HTMLElement de l’option. Renvoie la valeur null si le champ ou l’option est introuvable. |
L’exemple suivant montre comment obtenir l’étiquette d’une valeur de liste de choix.
// 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(String fieldName, Function callBack)
Renvoie le GlideRecord pour un champ spécifié.
Si une fonction de rappel est présente, cette routine s’exécute de manière asynchrone. Le traitement du navigateur (et du script) se poursuit normalement jusqu’à ce que le serveur retourne la valeur de référence, moment auquel la fonction de rappel est appelée. Si une fonction de rappel n’est pas présente, cette routine s’exécute de manière synchrone et le traitement s’arrête (ce qui donne l’impression que le navigateur se bloque) en attendant une réponse du serveur.
La prise en charge de la fonction de rappel pour ServiceCatalogForm.getReference est disponible.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Rappel | Fonction | Nom de la fonction de rappel. |
| Type | Description |
|---|---|
| GlideRecord | Objet GlideRecord pour le champ spécifié. Si la référence spécifiée est introuvable, elle renvoie un objet GlideRecord initialisé où currentRow = -1 et 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()
Renvoie un tableau de noms de listes connexes à partir du formulaire actuel.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Tableau | Tableau de chaînes de noms de listes connexes provenant du formulaire actuel. Les noms des listes connexes sont répertoriés dans l’ordre dans lequel ils apparaissent sur le formulaire. |
var listNames = g_form.getRelatedListNames();
for (var i = 0; i < listNames.length; i++) {
this.showRelatedList(listNames[i]);
}
GlideForm : getSectionNames()
Renvoie tous les noms de sections, qu’ils soient visibles ou non.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Tableau de chaînes | Les noms des sections. |
GlideForm : getSections()
Renvoie un tableau des sections du formulaire.
Cette méthode n’est pas disponible sur Mobile Platform. Si cette méthode est exécutée sur une plate-forme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Tableau d’éléments HTML | Les sections du formulaire. |
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()
Renvoie le nom de la table à laquelle appartient cet enregistrement.
Côté serveur, la table de l’enregistrement actuel peut être récupérée avec current.sys_class_name ou current.getTableName().
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Chaîne | Nom de la table. |
function onLoad() {
if (g_form.isNewRecord()) {
var tableName = g_form.getTableName(); //Get the table name
}
}
GlideForm : getUniqueValue()
Renvoie la sys_id de l’enregistrement affiché dans le formulaire.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Chaîne | Le disque est sys_id. |
function onLoad() {
var incSysid = g_form.getUniqueValue();
alert(incSysid);
}
GlideForm : getValue(String fieldName)
Renvoie la valeur du champ de formulaire spécifié.
Cette méthode permet également d’obtenir des valeurs à partir d’un jeu de variables de plusieurs lignes (MRVS). Pour obtenir des données à partir de champs au sein d’un MRVS, vous devez d’abord utiliser JSON.parse(getValue('<mrvs_field_name>') || '[]') pour obtenir le tableau MRVS, puis utilisez l’indexation pour accéder aux champs dans les objets de ligne. Pour plus de détails, consultez l’exemple de code ci-dessous.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ dont la valeur doit être renvoyée. |
| Type | Description |
|---|---|
| Chaîne | Valeur du champ spécifié. |
L’exemple suivant montre comment obtenir la brève description à partir du formulaire actuel.
function onChange(control, oldValue, newValue, isLoading) {
alert(g_form.getValue('short_description'));
}
L’exemple suivant montre comment obtenir des valeurs à partir d’un MRVS. Dans cet exemple, les salaires sont gérés via Service Catalog. Le script client recherche la valeur saisie dans l’intitulé Tâche dans toutes les lignes du MRVS, puis met à jour les entrées correspondantes dans le MRVS avec ce qui est saisi dans le champ Salaire . Le MRVS est nommé « variable_set_1 » et contient les champs suivants dans chaque objet de ligne : Nom de l’employé [employee_name], Titre du poste [employee_job_title] et Salaire [employee_salary]. En outre, l’élément de catalogue contient : Titre du poste [job_title] et Salaire [salary].
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()
Masque tous les messages de champ.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : hideAllFieldMsgs (type de chaîne)
Masque tous les messages de champ du type spécifié.
| Nom | Type | Description |
|---|---|---|
| type | Chaîne | Le type de message. Valeurs valides :
|
| Type | Description |
|---|---|
| nul |
GlideForm : hideErrorBox(String fieldName)
Masque le message d’erreur placé par showErrorBox().
Dans la mesure du possible, utilisez hideFieldMsg() plutôt que cette méthode dans la mesure du possible.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ ou du contrôle. |
| Type | Description |
|---|---|
| nul |
GlideForm : hideFieldMsg(String fieldName)
Masque le dernier message placé par showFieldMsg().
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| nul |
GlideForm : hideFieldMsg(String fieldName, booléen clearAll)
Masque les messages placés par showFieldMsg().
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| clearAll (effacer) | Booléen | Si la valeur est vrai, tous les messages du champ sont effacés. Si la propriété est définie sur false, seul le dernier message est supprimé. |
| Type | Description |
|---|---|
| nul |
g_form.hideFieldMsg('impact', true);
GlideForm : hideRelatedList(String listTableName)
Masque la liste connexe spécifiée sur le formulaire.
Cette méthode n’est pas disponible sur Mobile Platform. Si cette méthode est exécutée sur une plate-forme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| listTableName (en anglais seulement) | Chaîne | Nom de la liste connexe. Utilisez la sys_id pour masquer une liste par le biais d’une relation. |
| Type | Description |
|---|---|
| nul |
GlideForm : hideRelatedLists()
Masque toutes les listes connexes sur le formulaire.
Cette méthode n’est pas disponible sur Mobile Platform. Si cette méthode est exécutée sur une plate-forme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : isLiveUpdating()
Renvoie la valeur true pendant qu’une mise à jour active est effectuée sur l’enregistrement affiché dans le formulaire.
Cela peut être utilisé dans un script client onChange() pour déterminer si un changement apporté à l’enregistrement est dû à une mise à jour en direct d’une autre session. Le script client peut alors décider de l’action à entreprendre ou de ne pas entreprendre. Cela s’applique aux systèmes utilisant Interface utilisateur principale des formulaires opérationnels activés.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Booléen | Renvoie la valeur true si une mise à jour en direct se produit sur l’enregistrement affiché par le formulaire. |
GlideForm : isMandatory(String fieldName)
Renvoie la valeur true si le champ est obligatoire.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| Booléen | True si le champ est obligatoire, false dans les autres cas. |
GlideForm : isNewRecord()
Renvoie la valeur true si l’enregistrement n’a jamais été sauvegardé.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Booléen | Renvoie la valeur true si l’enregistrement n’a pas été enregistré ; Sinon, c’est faux. |
function onLoad() {
if(g_form.isNewRecord()){
alert('New Record!');
}
}
GlideForm : isSectionVisible(String sectionName)
Renvoie la valeur true si la section est visible.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Booléen | Renvoie la valeur true lorsque la section est visible ; sinon, la valeur false est renvoyée. |
GlideForm : onUserChangeValue(Function fn)
Enregistre un écouteur d’événement personnalisé qui détecte lorsqu’un champ du formulaire actuel est modifié par un utilisateur.
Lorsqu’un champ de formulaire est modifié, l’écouteur d’événements appelle la fonction qui est transmise lors de l’enregistrement initial de l’écouteur. Cet écouteur est uniquement déclenché lorsqu’un utilisateur modifie un champ du formulaire. Les changements apportés par les scripts clients, les politiques d’interface utilisateur ou toute autre interaction non utilisateur ne déclenchent pas l’écouteur.
| Nom | Type | Description |
|---|---|---|
| Fn | Fonction | Fonction à appeler lorsqu’un utilisateur modifie la valeur d’un champ dans le formulaire actuel. Il s’agit en fait du code de la fonction, pas seulement du nom de la fonction. Cette fonction doit accepter les trois arguments suivants :
|
| Type | Description |
|---|---|
| Fonction | Fonction à appeler pour annuler l’inscription de l’écouteur d’événements onUserChangeValue. |
Exemple
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(String fieldName)
Vous pouvez mettre à jour une variable Collecteur de liste.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de la zone de sélection. |
| Type | Description |
|---|---|
| nul |
g_form.refreshSlushbucket('bucket');
GlideForm - removeDecoration(nom de champ de chaîne, icône de chaîne, titre de chaîne)
Supprime l’icône du champ spécifié qui correspond à l’icône et au titre.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ. |
| icône | Chaîne | Nom de l’icône à supprimer. |
| Titre | Chaîne | Le titre (nom) du texte de l’icône. |
| Type | Description |
|---|---|
| nul |
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(nom de champ de chaîne, icône de chaîne, titre de chaîne, couleur de chaîne)
Supprime l’icône du champ spécifié qui correspond à l’icône, au titre et à la couleur.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ. |
| icône | Chaîne | Nom de l’icône à supprimer. |
| Titre | Chaîne | Le titre (nom) du texte de l’icône. |
| couleur | Chaîne | Une couleur CSS |
| Type | Description |
|---|---|
| nul |
g_form.removeDecoration('caller_id', 'icon-star', 'VIP', 'blue');
GlideForm : removeOption(String fieldName, String choiceValue)
Supprime l’option spécifiée de la liste de choix.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Valeur du choix | Chaîne | La valeur stockée dans la base de données. Ce n’est pas l’étiquette. |
| Type | Description |
|---|---|
| nul |
g_form.removeOption('priority', '1');
GlideForm - save()
Enregistre l’enregistrement sans naviguer (mettre à jour et rester).
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm – setMandatory(String fieldName, Booléen obligatoire)
Rend le champ spécifié obligatoire.
Dans la mesure du possible, utilisez une politique d’interface utilisateur plutôt que cette méthode.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| obligatoire | Booléen | Si la valeur est vrai, le champ est obligatoire. Si la valeur est définie sur false, le champ est facultatif. |
| Type | Description |
|---|---|
| nul |
GlideForm - setSectionDisplay(String sectionName, affichage booléen)
Affiche ou masque une section.
| Nom | Type | Description |
|---|---|---|
| sectionName | Chaîne | Le nom de la section est en minuscules avec un trait de soulignement remplaçant le premier espace du nom, et les espaces restants étant supprimés, par exemple « Section Four is Here » devient « section_fourishere ». Les autres caractères non alphanumériques, tels que l’esperluette (&), sont supprimés. Les noms de section peuvent être trouvés à l’aide de la méthode getSectionNames(). |
| affichage | Booléen | Si la valeur est définie sur vrai, affiche la section. Si la valeur est définie sur faux, la section est masquée. |
| Type | Description |
|---|---|
| Booléen | Renvoie la valeur true en cas de réussite. |
GlideForm : setValue(String fieldName, String value, String displayValue)
Définit la valeur d’un champ de formulaire spécifié sur la valeur d’une valeur d’affichage spécifiée dans un enregistrement de référence.
Pour améliorer les performances en empêchant un aller-retour lors de la définition de la valeur d’un champ de référence, utilisez cette méthode, et non setValue(fieldName, value). Lors de la définition de plusieurs valeurs de référence pour un champ de collecteur de liste, transmettez des tableaux dans les value paramètres et displayValue .
setValue(shortDesc, newValue.toUpperCase()) ;, vérifiez que la description courte n’est pas déjà en majuscules. Cela empêchera le script client d’appliquer la fonction toUpperCase() plus d’une fois.| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ de formulaire à mettre à jour. |
| valide | Chaîne ou tableau | Sys_id de l’enregistrement de référence à utiliser pour mettre à jour le champ. Si le champ spécifié est une GlideList, ce paramètre peut contenir un tableau de sys_ids. Dans ce cas, la méthode effectue une recherche de tous les enregistrements spécifiés dans le tableau et ces valeurs sont utilisées pour mettre à jour le contenu du champ spécifié (liste connexe). Remarque : Lorsque vous définissez une valeur dans une liste de choix, assurez-vous d’utiliser une valeur numérique plutôt que l’étiquette. |
| displayValue | Chaîne ou tableau | Champ dans l’enregistrement de référence spécifié à utiliser pour mettre à jour le champ spécifié. Par exemple, dans la table Utilisateur [sys_user], il peut s’agir du nom d’utilisateur. Si le champ spécifié est une GlideList, ce paramètre peut contenir un tableau de noms de valeurs d’affichage. Pour plus d’informations sur les valeurs d’affichage, reportez-vous à la rubrique Valeur d’affichage. |
| Type | Description |
|---|---|
| nul |
Cet exemple montre le passage de la sys_id de l’enregistrement de référence qui contient le champ userName à utiliser pour mettre à jour le champ de formulaire assigned_to .
g_form.setValue('assigned_to', userSysID, userName);
Cet exemple montre le passage d’un tableau de sys_ids d’enregistrement de référence et d’un tableau de noms de valeurs d’affichage correspondants à utiliser pour mettre à jour les champs de formulaire dans le glide-list_field_name GlideList.
g_form.setValue('glide-list_field_name', sysIDArray, displayNameArray);
GlideForm – showErrorBox(nom de chaîne, message de chaîne, scrollForm booléen)
Affiche un message d’erreur sous le champ de formulaire spécifié (soit un objet de contrôle, soit le nom du champ). Si le contrôle ou le champ est actuellement hors de l’écran et que le paramètre scrollForm est défini sur true, le formulaire défile jusqu’au contrôle ou au champ.
Une propriété globale (glide.ui.scroll_to_message_field) est disponible pour contrôler le défilement automatique des messages lorsque le champ du formulaire est hors de l’écran (fait défiler le formulaire vers le contrôle ou le champ). La méthode showFieldMsg() est une méthode similaire qui nécessite un paramètre type.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom du champ ou du contrôle. |
| message | Chaîne | Message à afficher. |
| scrollForm | Booléen | Si la valeur est vrai, le formulaire fait défiler jusqu’au champ. Si la propriété est définie sur faux, le formulaire ne défile pas jusqu’au champ. |
| Type | Description |
|---|---|
| nul |
GlideForm - showFieldMsg(champ de chaîne, message de chaîne, type de chaîne)
Affiche un message d’information ou un message d’erreur sous le champ de formulaire spécifié (soit un objet de contrôle, soit le nom du champ). Si le champ ou le champ n’apparaît pas à l’écran, le formulaire défile jusqu’au champ.
Une propriété globale (glide.ui.scroll_to_message_field) est disponible pour contrôler le défilement automatique des messages lorsque le champ du formulaire est hors de l’écran (fait défiler le formulaire vers le contrôle ou le champ).
La méthode showErrorBox() est une méthode abrégée qui ne nécessite pas le paramètre type.
| Nom | Type | Description |
|---|---|---|
| champ | Chaîne | Nom du champ ou du contrôle. |
| message | Chaîne | Message à afficher. |
| type | Chaîne | « erreur », « info » ou « avertissement ». |
| Type | Description |
|---|---|
| nul |
g_form.showFieldMsg('impact','Low impact response time can be one week','info');
GlideForm - showFieldMsg(champ de chaîne, message de chaîne, type de chaîne, scrollForm booléen)
Affiche un message d’information ou un message d’erreur sous le champ de formulaire spécifié (soit un objet de contrôle, soit le nom du champ). Si le champ ou le contrôle est actuellement hors de l’écran et que scrollForm a la valeur true, le formulaire défile jusqu’au champ.
Une propriété globale (glide.ui.scroll_to_message_field) est disponible pour contrôler le défilement automatique des messages lorsque le champ du formulaire est hors de l’écran (fait défiler le formulaire vers le contrôle ou le champ).
La méthode showErrorBox() est une méthode abrégée qui ne nécessite pas le paramètre type.
| Nom | Type | Description |
|---|---|---|
| champ | Chaîne | Nom du champ ou du contrôle. |
| message | Chaîne | Message à afficher. |
| type | Chaîne | « erreur », « info » ou « avertissement ». |
| scrollForm | Booléen | Si la valeur est vrai, le formulaire défile jusqu’au champ s’il est hors écran. Si la propriété est définie sur false, le formulaire ne défile pas. |
| Type | Description |
|---|---|
| nul |
g_form.showFieldMsg('impact','Low impact not allowed with High priority','error',false);
GlideForm - setDisabled(String fieldName, Boolean disable)
Rend le champ spécifié disponible ou indisponible.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Désactiver | Booléen | Si la valeur est Vrai, le champ est désactivé. Si la valeur est définie sur false, active le champ. |
| Type | Description |
|---|---|
| nul |
GlideForm - setDisplay(String fieldName, Affichage booléen)
Affiche ou masque un champ.
Cette méthode ne peut pas masquer un champ obligatoire sans valeur. Si le champ est masqué, l’espace est utilisé pour afficher d’autres éléments. Dans la mesure du possible, utilisez une politique d’interface utilisateur au lieu de cette méthode.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| affichage | Booléen | Si la valeur est vrai, affiche le champ, dans le champ défini sur faux, il est masqué. |
| Type | Description |
|---|---|
| nul |
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(String fieldName, String label)
Définit la valeur de texte brut de l’étiquette de champ.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Le nom du champ. |
| étiquette | Chaîne | L’étiquette de texte du champ. |
| Type | Description |
|---|---|
| nul |
if (g_user.hasRole('itil')) {
var oldLabel = g_form.getLabelOf('comments');
g_form.setLabelOf('comments', oldLabel + ' (Customer visible)');
}
GlideForm : setReadOnly(String fieldName, Booléen readOnly)
Rend le champ spécifié accessible en lecture seule ou modifiable.
Dans la mesure du possible, utilisez une politique d’interface utilisateur au lieu de cette méthode.
Pour qu’un champ obligatoire soit en lecture seule, vous devez d’abord supprimer l’exigence obligatoire pour ce champ à l’aide de la méthode setMandatory( ).
Une fois que vous avez défini un champ en lecture seule, vous ne pouvez pas utiliser la méthode setValue() pour mettre à jour la valeur de ce champ. Si vous devez définir la valeur de cette façon, vous devez définir la valeur readOnly sur false.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| readOnly | Booléen | Marqueur qui détermine si le champ associé est modifiable ou en lecture seule. Valeurs possibles :
|
| Type | Description |
|---|---|
| Néant |
L’exemple suivant montre comment définir l’éditeur de variable en lecture seule. Pour ce faire dans Catalogue de services les tables, utilisez 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(String fieldName, String value)
Définit la valeur d’un champ de formulaire spécifié sur la valeur transmise.
Cette méthode prend également en charge la définition de valeurs dans un jeu de variables de plusieurs lignes (MRVS). Vous devez d’abord utiliser JSON.parse(getValue('<mrvs_field_name>')) pour obtenir le tableau MRVS, puis utiliser l’indexation pour mettre à jour les champs dans les objets de ligne. Une fois que toutes les valeurs sont mises à jour dans le MRVS, utilisez la méthode setValue() pour enregistrer le tableau MRVS mis à jour. Pour plus de détails, consultez l’exemple de code ci-dessous.
setValue(shortDesc, newValue.toUpperCase()) ;, vérifiez que la description courte n’est pas déjà en majuscules. Cela empêchera le script client d’appliquer la fonction toUpperCase() plus d’une fois.| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ de formulaire à mettre à jour. |
| valide | Chaîne | Valeur de chaîne à définir dans le champ spécifié. |
| Type | Description |
|---|---|
| nul |
L’exemple suivant montre comment définir la description brève dans le formulaire actuel.
g_form.setValue('short_description', 'replace this with appropriate text');
L’exemple suivant montre comment définir des valeurs dans un MRVS. Dans cet exemple, les salaires sont gérés via Service Catalog. Le script client recherche la valeur saisie dans l’intitulé Tâche dans toutes les lignes du MRVS, puis met à jour les entrées correspondantes dans le MRVS avec ce qui est saisi dans le champ Salaire . Le MRVS est nommé « variable_set_1 » et contient les champs suivants dans chaque objet de ligne : Nom de l’employé [employee_name], Titre du poste [employee_job_title] et Salaire [employee_salary]. En outre, l’élément de catalogue contient : Titre du poste [job_title] et Salaire [salary].
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(booléen isReadOnly)
Met un éditeur de Catalogue de services variable en lecture seule.
La méthode doit être placée dans le script client de la table dans laquelle l’éditeur de variable est ajouté, par exemple Élément demandé [sc_req_item], Incident [incident], etc. Pour définir des variables en lecture seule dans d’autres tables, utilisez la méthode setReadOnly( ).
Voir aussi : Éditeurs de variables Service Catalog
| Nom | Type | Description |
|---|---|---|
| isReadOnly | Booléen | Marqueur qui détermine si l’éditeur de variable est en lecture seule. Valeurs possibles :
Valeur par défaut : false |
| Type | Description |
|---|---|
| Néant |
L’ajout de la ligne suivante à un script client définit l’éditeur de variable en lecture seule.
g_form.setVariablesReadOnly(true);
GlideForm - setVisible(String fieldName, affichage booléen)
Affiche ou masque le champ.
Sur l’interface utilisateur de bureau, l’espace est laissé vide lorsqu’il est masqué. Dans l’interface utilisateur Mobile ou Service Portal, l’espace est rempli dans mes autres champs lorsqu’ils sont masqués. Cette méthode ne peut pas masquer les champs obligatoires sans valeur.
Dans la mesure du possible, utilisez la politique d’interface utilisateur plutôt que cette méthode.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Le nom du champ. |
| affichage | Booléen | Si la valeur est définie sur Vrai, affiche le champ. Si la valeur est définie sur faux, le champ est masqué. |
| Type | Description |
|---|---|
| nul |
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(nom de chaîne, message de chaîne)
Affiche un message d’erreur sous le champ de formulaire spécifié (soit un objet de contrôle, soit le nom du champ). Si le champ ou le champ n’est pas affiché, le formulaire défile jusqu’au contrôle ou au champ.
Une propriété globale (glide.ui.scroll_to_message_field) est disponible pour contrôler le défilement automatique des messages lorsque le champ du formulaire est hors de l’écran (fait défiler le formulaire vers le contrôle ou le champ). La méthode showFieldMsg() est une méthode similaire qui nécessite un paramètre type.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom du contrôle ou du champ. |
| message | Chaîne | Le message à afficher. |
| Type | Description |
|---|---|
| nul |
GlideForm : showRelatedList(String listTableName)
Affiche la liste connexe spécifiée sur le formulaire.
Cette méthode n’est pas disponible sur Mobile Platform. Si cette méthode est exécutée sur une plate-forme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| listTableName (en anglais seulement) | Chaîne | Nom de la liste connexe. |
| Type | Description |
|---|---|
| nul |
GlideForm : showRelatedLists()
Affiche toutes les listes connexes du formulaire.
Cette méthode n’est pas disponible sur Mobile Platform. Si cette méthode est exécutée sur une plate-forme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : submit()
Enregistre l’enregistrement.
L’utilisateur est retiré du formulaire, ce qui le renvoie à l’endroit où il se trouvait.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm - submit(verbe à chaîne)
Effectue l’action d’interface utilisateur spécifiée par le paramètre.
| Nom | Type | Description |
|---|---|---|
| Verbe | Chaîne | Un action_name à partir d’un enregistrement sys_ui_action. Le nom de l’action doit être pour un bouton de formulaire visible. |
| Type | Description |
|---|---|
| nul |