GlideForm (g_form) : client
L’API GlideForm fournit des méthodes pour personnaliser les formulaires.
Utiliser uniquement les méthodes GlideForm sur le client. Vous pouvez utiliser ces méthodes 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.
Vous pouvez également utiliser certaines de ces méthodes dans d’autres scripts clients (tels que les scripts clients de catalogue ou les scripts clients d’assistant), mais vous devez d’abord tester cela 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(Nom de champ de chaîne, 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 | Nom de champ. |
| icône | Chaîne | Nom de l’icône à afficher en regard du champ spécifié. Valeurs valides :
|
| Titre | Chaîne | Titre de l’icône. |
| Type | Description |
|---|---|
| nul |
g_form.addDecoration('caller_id', 'icon-star', 'preferred member');
GlideForm : addDecoration(Nom de champ de chaîne, icône de chaîne, titre de chaîne, couleur de chaîne)
Ajoute une icône sur l’étiquette d’un champ.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ. |
| icône | Chaîne | Nom de l’icône à afficher en regard du champ spécifié. Valeurs valides :
|
| Titre | Chaîne | Titre de l’icône. |
| couleur | Chaîne | 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 s’affiche 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 des 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 | Type de message. Valeurs valides :
|
| options | Objet | Facultatif. 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 | Liste des boutons à ajouter au message du formulaire. |
| options.boutons.nom de l’action | Chaîne | Nom utilisé par les gestionnaires d’événements FORM_MESSAGE_BUTTON_CLICKED pour déterminer le bouton sur lequel l’utilisateur a cliqué.Par exemple, si vous ajoutez un bouton avec le actionName |
| Options.Boutons.Étiquette | Chaîne | Texte à afficher sur le bouton. |
| options.meta | Objet | Carte de toutes les métadonnées nécessaires pour gérer le clic sur le bouton, formatées sous forme de paires clé-valeur. Par exemple, pour un bouton Me l’affecter , le gestionnaire d’événements a besoin du sys_id de l’utilisateur auquel affecter l’enregistrement. |
| Type | Description |
|---|---|
| Aucun |
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 : addHighMessage (message de chaîne)
Affiche un message de priorité élevée en haut du formulaire.
Ce message s’affiche pendant environ quatre secondes, puis disparaît. Ce délai n’est pas configurable pour l’instant.
| Nom | Type | Description |
|---|---|---|
| message | Chaîne | Message de priorité élevée à afficher sur le formulaire. |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment afficher un message de priorité élevée en haut du formulaire.
g_form.addHighMessage("This is a high priority message");
GlideForm : addInfoMessage (message de chaîne)
Ajoute le message d’information spécifié en haut du formulaire.
Ce message s’affiche 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 : addLowMessage(message de chaîne)
Affiche un message de priorité faible en haut du formulaire.
Ce message s’affiche pendant environ quatre secondes, puis disparaît. Ce délai n’est pas configurable pour l’instant.
| Nom | Type | Description |
|---|---|---|
| message | Chaîne | Message de priorité faible à afficher sur le formulaire. |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment afficher un message de priorité faible en haut du formulaire.
g_form.addLowMessage(“This is a low priority message");
GlideForm : addModerateMessage(message de chaîne)
Affiche un message de priorité de niveau modéré en haut du formulaire.
Ce message s’affiche pendant environ quatre secondes, puis disparaît. Ce délai n’est pas configurable pour l’instant.
| Nom | Type | Description |
|---|---|---|
| message | Chaîne | Message de priorité modérée à afficher sur le formulaire. |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment afficher un message de priorité modérée en haut du formulaire.
g_form.addModerateMessage("This is a moderate priority message");
GlideForm : addOption(String fieldName, String choiceValue, String choiceLabel)
Ajoute un choix à la fin d’un champ de liste de choix spécifié.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ dans lequel ajouter l’option de champ de choix. |
| choiceValue | Chaîne | Valeur à stocker dans la base de données. |
| Étiquette de choix | Chaîne | Valeur à afficher. |
| 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 | Nom du champ dans lequel ajouter l’option de champ de choix. |
| choiceValue | Chaîne | Valeur à stocker dans la base de données. |
| Étiquette de choix | Chaîne | Valeur à afficher. |
| index de choix | Numéro | Ordre du choix dans la liste. L’index est un tableau de base zéro. |
| Type | Description |
|---|---|
| nul |
g_form.addOption('priority', '2.5', '2.5 - Moderately High', 3);
GlideForm : addSuccessMessage(Message de chaîne)
Affiche un message de réussite en haut du formulaire.
Ce message s’affiche pendant environ quatre secondes, puis disparaît. Ce délai n’est pas configurable pour l’instant.
| Nom | Type | Description |
|---|---|---|
| message | Chaîne | Message de réussite à afficher sur le formulaire. |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment afficher un message de confirmation d’un message de réussite en haut du formulaire.
g_form.addSuccessMessage("This is a success message");
GlideForm : clearAllFormMessages()
Supprime tous les messages de formulaire de n’importe quel type.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Aucun |
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 spécifié.
| Nom | Type | Description |
|---|---|---|
| type | Chaîne | Type de message. Valeurs valides :
|
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment effacer tous les messages d’erreur du formulaire.
g_form.clearFormMessages('error');
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 : clearOptions(String fieldName)
Supprime toutes les options de la liste de choix spécifiée.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ pour lequel effacer les options de choix. |
| Type | Description |
|---|---|
| nul |
GlideForm : clearValue(String fieldName)
Supprime toutes les valeurs du champ spécifié.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ à effacer. |
| Type | Description |
|---|---|
| nul |
GlideForm : disableAttachments()
Empêche l’ajout de pièces jointes au formulaire.
Cette méthode n’est pas disponible sur la plateforme mobile. Si cette méthode est exécutée sur une plateforme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : disableChoice(String fieldName, String choiceValue)
Désactive par programmation un choix spécifique dans le champ déroulant, si le choix existe. Aucun changement n’est apporté si le choix est déjà désactivé.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ à désactiver. Type de données : chaîne |
| choiceValue | Chaîne | Valeur du choix à désactiver. Type de données : chaîne |
| Type | Description |
|---|---|
| Booléen | Marqueur indiquant si le choix donné est désactivé ou actif dans le formulaire. Valeurs valides :
Type de données : booléennes |
L’exemple suivant appelle disableChoice() pour désactiver le choix loading_dock dans le champ de formulaire delivery_location.
if (g_form.getValue('address_type') == 'home') {
g_form.disableChoice('delivery_location', 'loading_dock');
}
// Only itil_admin users can select the "Closed" option
function onLoad() {
if (g_user.hasRole('itil_admin')) return;
if (g_form.getValue('incident_state') != '7')
g_form.disableChoice('incident_state', 7);
if (g_form.getValue('state') != '7') {
g_form.disableChoice('state', 7);
}
}
GlideForm : enableAttachments()
Permet d’ajouter des pièces jointes au formulaire. Affiche l’icône du trombone.
Cette méthode n’est pas disponible sur la plateforme mobile. Si cette méthode est exécutée sur une plateforme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : enableChoice(String fieldName, String choiceValue)
Active par programmation un choix spécifique dans le champ déroulant, si le choix existe. Aucun changement n’est apporté si l’option est déjà activée.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ du choix à activer. |
| choiceValue | Chaîne | Valeur du choix à activer. |
| Type | Description |
|---|---|
| Booléen | Marqueur indiquant si le choix donné est activé avec succès. Valeurs valides :
Type de données : booléennes |
L’exemple suivant appelle enable() pour activer un nouveau choix déroulant, 1, dans le champ de formulaire de priorité .
var shortDescription = g_form.getValue('shortDescription');
// Allow priority 1 selection if short description mentions security
if (shortDescription.includes('security')) {
var p1Choice = g_form.getChoice('priority', '1');
g_form.enableChoice('priority', '1');
}
GlideForm : flash(String fieldName, String color, Number count)
Utilisez cette propriété pour attirer l’attention sur un champ. 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 Catalogue de services.
Cette méthode n’est pas disponible sur la plateforme mobile. Si cette méthode est exécutée sur une plateforme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Champ à mettre en surbrillance au format suivant : « <nom-table>.<nom-de-champ> ». |
| couleur | Chaîne | Couleur RVB ou couleur CSS acceptable. |
| compter | Numéro | Durée pendant laquelle l’étiquette clignotera. Valeurs valides :
|
| 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, le sys_id de l’action d’interface utilisateur cliquée.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Chaîne | Nom de l’action actuelle ou sys_id de l’action d’interface utilisateur cliquée. |
function onSubmit() {
var action = g_form.getActionName();
alert('You pressed ' + action);
}
GlideForm : getAnnotationByName(nom de chaîne)
Renvoie une annotation de formulaire d’un nom donné.
Les annotations sont des séparateurs visuels entre les éléments de formulaire, ou des blocs de texte coloré utilisés pour mettre en surbrillance des éléments de formulaire. Utilisez cette propriété GlideForm : getAnnotationByName(nom de chaîne) pour renvoyer toutes les annotations dans un formulaire.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom de l’annotation à renvoyer. Table : Annotations de formulaire [sys_ui_annotation], Champ : Nom |
| Propriété | Description |
|---|---|
| Tableau d'objets | Contenu de l’annotation. Type de données : tableau d’objets |
| tableau.contenu | Texte de l’annotation renvoyée. Type de données : chaîne |
| array.name | Nom de l’annotation renvoyée. Type de données : chaîne Emplacement de la table : Annotations de formulaire [sys_ui_annotation], Champ : name |
| tableau.visible |
Marqueur indiquant si l’annotation est visible sur le formulaire. Valeurs valides :
Type de données : booléennes |
L’exemple suivant montre comment utiliser la méthode getAnnotationByName() pour récupérer une annotation de formulaire en fonction de son nom donné, test-annotation-msg-1.
var sampleAnnotation = g_form.getAnnotationByName("test-annotation-msg-1");
/* returns:
{
"name": "test-annotation-msg-1",
"visible": true,
"content": "Test<input id=\"make_spacing_ok\" style=\"visibility:hidden; width:0px;\">"
}
*/
GlideForm : getAnnotations()
Renvoie une liste de toutes les annotations sur un formulaire.
Les annotations sont des séparateurs visuels entre les éléments de formulaire, ou des blocs de texte coloré utilisés pour mettre en surbrillance des éléments de formulaire. Utilisez cette option GlideForm : getAnnotationByName(nom de chaîne) pour renvoyer une annotation spécifique par son nom.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Propriété | Description |
|---|---|
| Tableau d'objets | Contenu de l’annotation. Type de données : tableau d’objets |
| tableau.contenu | Texte de l’annotation renvoyée. Type de données : chaîne |
| array.name | Nom de l’annotation renvoyée. Type de données : chaîne Emplacement de la table : Annotations de formulaire [sys_ui_annotation], Champ : name |
| tableau.visible |
Marqueur indiquant si l’annotation est visible sur le formulaire. Valeurs valides :
Type de données : booléennes |
L’exemple suivant appelle d’abord getAnnotations() pour renvoyer toutes les annotations d’un formulaire, puis appelle hideAnnotation() pour masquer toutes les annotations du formulaire.
const annotations = getAnnotations();
/* returns:
[
{
"name": "test-annotation-msg-1",
"visible": true,
"content": "Test<input id=\"make_spacing_ok\" style=\"visibility:hidden; width:0px;\">"
},
{
"name": "test-annotation-msg-2",
"visible": true,
"content": "Test 2<input id=\"make_spacing_ok\" style=\"visibility:hidden; width:0px;\">"
}
]*/
annotations.forEach(function(annotation) {
g_form.hideAnnotation(annotation.name);
});
// this script hides all annotations on the form.
GlideForm : getBooleanValue(String fieldName)
Renvoie une valeur booléenne pour le champ spécifié.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Champ à mettre en surbrillance au format suivant : « <nom-table>.<nom-de-champ> ». |
| Type | Description |
|---|---|
| Booléen | Renvoie la valeur false si la valeur du champ est fausse ou indéfinie ; sinon, renvoie la valeur vrai. |
GlideForm : getChoice(String fieldName, String choiceValue)
Renvoie un objet avec des propriétés représentant un champ et une valeur de choix donnés.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ du choix à récupérer. |
| choiceValue | Chaîne | Valeur du choix à récupérer. |
| Propriété | Description |
|---|---|
| Objet GlideFormChoice ou nul | Objet GlideFormChoice pour le champ et la valeur de choix spécifiés. Renvoie null si aucun choix correspondant n’existe. Type de données : objet |
| GlideFormChoice.label | Texte d’affichage en lecture seule au choix. Type de données : chaîne |
| GlideFormChoice.value | Valeur en lecture seule du choix. Type de données : chaîne |
| GlideFormChoice.disabled | Marqueur indiquant si le choix est désactivé dans le formulaire. Valeurs valides :
Type de données : booléennes |
| GlideFormChoice.index | Indique la position du choix dans la liste déroulante. Type de données : nombre |
L’exemple suivant appelle enable() pour activer un nouveau choix déroulant, 1, dans le champ de formulaire de priorité .
var shortDescription = g_form.getValue('shortDescription');
// Allow priority 1 selection if short description mentions security
if (shortDescription.includes('security')) {
var p1Choice = g_form.getChoice('priority', '1');
g_form.enableChoice('priority', '1');
}
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 de 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 ou Portail de services scripts mobiles.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ pour lequel renvoyer l’élément HTML. |
| 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 dont la valeur décimale doit être renvoyée. |
| 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)
Renvoie la valeur d’affichage à partir d’un formulaire dans l’interface utilisateur principale.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne |
| Type | Description |
|---|---|
| Aucun | Nom du champ à partir duquel récupérer la valeur dans le formulaire. |
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)
Renvoie 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 |
|---|---|
| Chaîne | Valeur d’affichage du champ spécifié. |
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(ID de chaîne)
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 ou Portail de services scripts mobiles.
| Nom | Type | Description |
|---|---|---|
| id | Chaîne | ID de 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 ou Portail de services scripts mobiles.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| HTMLFormElement | É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 est applicable uniquement aux variables de 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 spécifié.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ. |
| Type | Description |
|---|---|
| Numéro | Valeur entière du champ. |
GlideForm : getLabelOf(String fieldName)
Renvoie la valeur en texte brut de l’étiquette du champ.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ. |
| Type | Description |
|---|---|
| Chaîne | 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 d’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. |
| choiceValue | Chaîne | Valeur de l’option. |
| Type | Description |
|---|---|
| HTMLElement | Le HTMLElement pour l’option. Renvoie 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 : getOptions(String fieldName)
Renvoie les options disponibles et sélectionnées pour un champ de choix ou de référence sur le formulaire. Cette méthode est utile pour les formulaires dynamiques, les variables de catalogue et les jeux de variables, ainsi que pour les intégrations qui doivent inspecter ou filtrer les options de champ au moment de l’exécution.
Par exemple, vous pouvez utiliser g_form.getOptions() pour :
- Obtenez et définissez les paires nom-valeur dans un type de champ watch_list.
- Recherchez ou filtrez les options disponibles par un terme de recherche.
- Activez l’accès aux mêmes résultats de saisie semi-automatique via un rappel.
- Obtenez et définissez des options sur les champs de choix, les champs de référence et les types de champs avancés tels que watch_list, glide_list, field_list et zone de liste double.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Le nom du champ de choix ou de référence à récupérer. |
| Propriété | Description |
|---|---|
| Tableau d’objets ou nul | Tableau en lecture seule d’objets contenant la valeur et l’étiquette de chaque option sélectionnée. Renvoie null si le champ ne prend pas en charge les options. Type de données : tableau d’objets |
| tableau.valeurdisplayValue | Valeur d’affichage du choix. Type de données : chaîne |
| tableau.valeur | Valeur de l’option. Type de données : chaîne |
| getAvailable(terme) | Fonction permettant de retourner toutes les options disponibles. Un terme de recherche peut être fourni comme argument pour filtrer les options par valeur d’affichage (une correspondance de sous-chaîne non sensible à la casse). Renvoie une promesse de tableau d’objets avec la valeur d’affichage et la valeur du choix correspondant. Type de données : tableau d’objets |
L’exemple suivant appelle g_form.getOptions() pour renvoyer tous les choix disponibles pour les champs de formulaire spécifiés, tels que état, work_notes_list et autres.
g_form.getOptions("state"); //table: incident, field: state, type: integer, choice: Dropdown without --None--
/*
returns [{"value":"1","displayValue":"New"},{"value":"2","displayValue":"In Progress"},{"value":"3","displayValue":"On Hold"},{"value":"6","displayValue":"Resolved"},{"value":"7","displayValue":"Closed"},{"value":"8","displayValue":"Canceled"}]
*/
g_form.getOptions("category"); //table: incident, field: category, type: string, choice: Dropdown with --None--
/*
returns [{"value":"","displayValue":"-- None --"},{"value":"inquiry","displayValue":"Inquiry / Help"},{"value":"software","displayValue":"Software"},{"value":"hardware","displayValue":"Hardware"},{"value":"network","displayValue":"Network"},{"value":"database","displayValue":"Database"}]
*/
g_form.getOptions("work_notes_list") //table: incident, field: work_notes_list, type: glide_list
/*
returns [{"value":"62826bf03710200044e0bfc8bcbe5df1","displayValue":"Abel Tuter"},{"value":"a8f98bb0eb32010045e1a5115206fe3a","displayValue":"Abraham Lincoln"},{"value":"5137153cc611227c000bbd1bd8cd2005","displayValue":"Fred Luddy"},{"value":"6a826bf03710200044e0bfc8bcbe5dec","displayValue":"Alissa Mountjoy"}]
*/
g_form.getOptions("restricted_fields") //table: std_change_properties, field: restricted_fields, type: field_list
/*
[{"value":"activity_due","displayValue":"Activity due"},{"value":"additional_assignee_list","displayValue":"Additional assignee list"},{"value":"comments","displayValue":"Additional comments"},{"value":"assignment_group","displayValue":"Assignment group"},{"value":"backout_plan","displayValue":"Backout plan"},{"value":"business_duration","displayValue":"Business duration"},{"value":"cab_delegate","displayValue":"CAB delegate"},...]
*/
g_form.getOptions('table') //table: sys_script_client, field: table, type: table_name
/*
[{"value":"","displayValue":"-- None --"},{"value":"cmdb_ci_appl_dot_net","displayValue":".NET Application [cmdb_ci_appl_dot_net]"},{"value":"evaluation","displayValue":"A/B Testing Evaluation [evaluation]"},{"value":"evaluation_execution","displayValue":"A/B Testing Evaluation Execution [evaluation_execution]"},{"value":"evaluation_parameter","displayValue":"A/B Testing Evaluation Parameter [evaluation_parameter]"},{"value":"sn_access_analyzer_request","displayValue":"Access Analyzer Query [sn_access_analyzer_request]"},{"value":"sn_access_analyzer_access_comparison_request","displayValue":"Access Comparison Request [sn_access_analyzer_access_comparison_request]"},{"value":"sys_security_acl","displayValue":"Access Control [sys_security_acl]"},...]
*/
g_form.getOptions('mandatory_fields'); //table: kb_knowledge_base, field: mandatory_fields, type: slushbucket
/*
[{"value":"active","displayValue":"Active"},{"value":"article_id","displayValue":"Article ID"},{"value":"displayValue","displayValue":"Article body"},{"value":"article_type","displayValue":"Article type"},{"value":"direct","displayValue":"Attachment link"},{"value":"author","displayValue":"Author"},{"value":"base_version","displayValue":"Base Version"},...]
*/
L’exemple de script suivant montre comment appeler g_form.getOptions() avec la fonction getAvailable().
const options = g_form.getOptions('priority');
if (options) {
console.log('Selected:', options.selected);
options.getAvailable('high').then(available => {
console.log('Available matching "high":', available);
});
}
GlideForm : getReference(String fieldName, rappel de fonction)
Retourne 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 renvoie la valeur de référence, auquel cas la fonction de rappel est invoqué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 (provoquant le blocage du navigateur) pendant l’attente d’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ù |
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 de chaînes | Liste des noms de listes connexes 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 section, qu’ils soient visibles ou non.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Tableau de chaînes | Noms des sections. |
GlideForm : getSections()
Renvoie un tableau des sections du formulaire.
Cette méthode n’est pas disponible sur la plateforme mobile. Si cette méthode est exécutée sur une plateforme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Tableau d’éléments HTML | 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 cet enregistrement appartient.
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 le sys_id de l’enregistrement affiché dans le formulaire.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Chaîne | sys_id de l’enregistrement. |
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 prend également en charge l’obtention de valeurs à partir d’un jeu de variables à plusieurs lignes (MRVS). Pour obtenir des données à partir des champs d’un MRVS, vous devez d’abord utiliser JSON.parse(getValue('<mrvs_field_name>') || '[]') pour obtenir le tableau MRVS, puis utiliser 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 description brève à 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 le Service Catalog. Le script client recherche dans toutes les lignes du MRVS la valeur saisie dans le titre de la fonction , 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], Fonction [employee_job_title] et Salaire [employee_salary]. En outre, l’élément de catalogue contient : Fonction [job_title] et Salaire [salaire].
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 | >Type de message. Valeurs valides :
|
| Type | Description |
|---|---|
| nul |
GlideForm : hideAnnotation(nom de chaîne)
Masque une annotation avec un nom donné sur l’interface utilisateur du formulaire.
- GlideForm : showErrorBox(Nom de chaîne, Message de chaîne, booléen scrollForm) pour afficher une annotation spécifique sur le formulaire.
- GlideForm : toggleAnnotations() pour activer et désactiver les annotations avec une plus grande flexibilité.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom de l’annotation à masquer dans le formulaire. Table : Annotations de formulaire [sys_ui_annotation], Champ : Nom |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment masquer par programmation l’annotation nommée test-annotation-msg-1 sur le champ de formulaire à l’aide de la méthode hideAnnotation( ).
g_form.hideAnnotation('test-annotation-msg-1');
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 dont le message d’erreur doit être masqué. |
| Type | Description |
|---|---|
| nul |
GlideForm : hideFieldMsg(String fieldName, booléen clearAll)
Masque le premier message qui apparaît dans le champ spécifié sur le formulaire actuel.
Utilisez la méthode ou GlideForm : showFieldMsg(Champ de chaîne, Message de chaîne, Type de chaîne, Booléen scrollForm) pour afficher les GlideForm : showFieldMsg(Champ de chaîne, Message de chaîne, Type de chaîne) messages sur un formulaire.
work_notes d’un formulaire, puis masquer le premier message : 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'| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ dans lequel masquer le message. |
| clearAll | Booléen | Facultatif. Marqueur indiquant s’il faut masquer tous les messages pour le champ spécifié. Valeurs valides :
Valeur par défaut : false |
| Type | Description |
|---|---|
| nul |
L’exemple suivant montre comment effacer tous les messages d’un champ de formulaire spécifié, puis afficher un message d’erreur de chiffrement.
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 : hideRelatedLinks()
Masque la section Liens connexes d’un formulaire.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Aucun |
L’exemple de script suivant masque les liens connexes dans le formulaire actuel.
// Hide related links
g_form.hideRelatedLinks()
GlideForm : hideRelatedList(String listTableName)
Masque la liste connexe spécifiée sur le formulaire.
Cette méthode n’est pas disponible sur la plateforme mobile. Si cette méthode est exécutée sur une plateforme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| listTableName | 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 la plateforme mobile. Si cette méthode est exécutée sur une plateforme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : hideTemplateBar()
Masque la barre de modèle sur le formulaire.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Aucun |
L’exemple de script suivant masque la barre de modèle sur le formulaire actuel.
g_form.hideTemplateBar()
GlideForm : isLiveUpdating()
Renvoie la valeur true lorsqu’une mise à jour en direct est effectuée sur l’enregistrement affiché par 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 des mesures à prendre ou à ne pas prendre. 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 vrai si le champ est obligatoire.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ. |
| Type | Description |
|---|---|
| Booléen | Vrai si le champ est obligatoire, faux dans les autres cas. |
GlideForm : isNewRecord()
Renvoie la valeur vrai 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é sauvegardé ; sinon faux. |
function onLoad() {
if(g_form.isNewRecord()){
alert('New Record!');
}
}
GlideForm : isSectionVisible(String sectionName)
Renvoie la valeur vrai 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 : isVisible(nom de champ de chaîne)
Détermine si le champ associé au nom de champ transmis est visible sur le formulaire actuel.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ permettant de vérifier s’il est visible sur le formulaire actuel. |
| Type | Description |
|---|---|
| Booléen | Marqueur indiquant si le champ spécifié est visible sur le formulaire actuel. Valeurs possibles :
|
L’exemple de code suivant montre comment vérifier si le champ user_address est visible sur le formulaire actuel.
if(g_form.isVisible('user_address')) {
alert('is visible');
}
else {
alert('is hidden');
}
GlideForm : onUserChangeValue (fonction fn)
Enregistre un écouteur d’événement personnalisé qui détecte quand 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 transmise lors de l’enregistrement initial de l’écouteur. Cet écouteur n’est déclenché que lorsqu’un utilisateur apporte un changement à un champ du formulaire. Les changements apportés aux scripts clients, aux 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 fonction, pas seulement du nom de la fonction. Cette fonction doit accepter les trois arguments suivants :
|
| Type | Description |
|---|---|
| Fonction | Fonction à appeler pour annuler l’enregistrement de l’écouteur d’événement 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(String fieldName)
Vous pouvez mettre à jour une variable de collecteur de liste.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de la zone de liste double. |
| 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 spécifiés.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ dans lequel supprimer la décoration. |
| icône | Chaîne | Nom de l’icône à supprimer. |
| Titre | Chaîne | Titre du texte de l’icône (nom). |
| 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 spécifiés.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ dans lequel supprimer la décoration. |
| icône | Chaîne | Nom de l’icône à supprimer. |
| Titre | Chaîne | Titre du texte de l’icône (nom). |
| couleur | Chaîne | Couleur CSS assortie. |
| 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 spécifiée.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ dans lequel supprimer l’option de la liste de choix. |
| choiceValue | Chaîne | 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 ailleurs (mettre à jour et rester).
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : setChoiceLabel(String fieldName, String choiceValue, String newLabel)
Met à jour l’étiquette d’un choix spécifique dans le champ déroulant.
Lors de l’appel de cette méthode, la position d’index de l’option mise à jour dans la liste déroulante reste inchangée. L’état activé ou désactivé de l’option est conservé.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom de champ qui contient le choix de mise à jour. Type de données : chaîne |
| choiceValue | Chaîne | Valeur de l’étiquette de choix à mettre à jour avec une nouvelle étiquette. Type de données : chaîne |
| newLabel | Chaîne | Nom d’étiquette pour mettre à jour l’étiquette de choix existante. Type de données : chaîne |
| Type | Description |
|---|---|
| Booléen | Marqueur indiquant si l’étiquette de l’option a été mise à jour avec succès. Valeurs valides :
|
L’exemple suivant appelle setChoiceLabel() pour mettre à jour les choix de champ « bonus » (10, 20 et 30) vers de nouvelles valeurs.
// Show the calculated bonus next to the percentage label
var salary = parseInt(g_form.getValue('salary'), 10);
g_form.setChoiceLabel('bonus', '10', '10% ($'+ (salary * .10) +')');
g_form.setChoiceLabel('bonus', '20', '20% ($'+ (salary * .20) +')');
g_form.setChoiceLabel('bonus', '30', '30% ($'+ (salary * .30) +')');
GlideForm : setDisabled(String fieldName, booléen désactiver)
Rend le champ spécifié disponible ou indisponible.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ à activer ou désactiver. |
| Désactiver | Booléen | Marqueur indiquant s’il faut désactiver ou non le champ spécifié. Valeurs valides :
Valeur par défaut : false |
| Type | Description |
|---|---|
| nul |
GlideForm : setDisplay(String fieldName, affichage booléen)
Affiche ou masque un champ spécifié sur le formulaire.
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 | Marqueur indiquant s’il faut afficher ou non le champ spécifié. Valeurs valides :
|
| 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 en texte brut de l’étiquette du champ spécifié.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ pour lequel définir l’étiquette. |
| étiquette | Chaîne | Valeur en texte brut à définir dans l’étiquette. |
| Type | Description |
|---|---|
| nul |
if (g_user.hasRole('itil')) {
var oldLabel = g_form.getLabelOf('comments');
g_form.setLabelOf('comments', oldLabel + ' (Customer visible)');
}
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 à rendre obligatoire. |
| obligatoire | Booléen | Marqueur indiquant si le champ est obligatoire. Valeurs valides :
Valeur par défaut : false |
| Type | Description |
|---|---|
| nul |
GlideForm : setReadOnly(String fieldName, booléen readOnly)
Rend le champ spécifié en lecture seule ou modifiable.
Dans la mesure du possible, utilisez une politique d’interface utilisateur au lieu de cette méthode.
Pour rendre un champ obligatoire 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 manière, vous devez définir la readOnly valeur sur faux.
| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ dont la valeur d’accès doit être définie. |
| readOnly | Booléen | Marqueur qui détermine si le champ associé est modifiable ou en lecture seule. Valeurs valides :
|
| Type | Description |
|---|---|
| nul |
L’exemple suivant montre comment définir l’éditeur de variables sur lecture seule. Pour effectuer cette action 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 : setRelatedLinksDisplay(affichage booléen)
Afficher ou masquer la section Liens connexes dans l’interface utilisateur du formulaire à l’aide de valeurs booléennes.
GlideForm : hideRelatedLinks() masque les actions d’interface utilisateur du lien connexe sur le formulaire tout en GlideForm : showRelatedLinks() les affichant. La méthode g_form.setRelatedLinksDisplay (boolean : display) peut toutefois être utilisée pour afficher ou masquer des liens connexes avec plus de flexibilité dans vos scripts.
| Nom | Type | Description |
|---|---|---|
| affichage | Booléen | Marqueur indiquant s’il faut afficher ou masquer la section Liens connexes d’un formulaire. Valeurs valides :
Par défaut : true |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment afficher ou masquer la section Liens connexes dans un formulaire.
// Displays the Related Links section in the UI
g_form.setRelatedLinksDisplay(true);
// Hides the Related Links section in the UI
g_form.setRelatedLinksDisplay(false);
GlideForm : setSectionDisplay(String sectionName, affichage booléen)
Affiche ou masque une section spécifiée dans le formulaire.
| Nom | Type | Description |
|---|---|---|
| sectionName | Chaîne | Le nom de la section est en minuscules, un trait de soulignement remplaçant le premier espace du nom et les espaces restants étant supprimés. Par exemple, « La section quatre est ici » devient « section_fourishere ». Les autres caractères non alphanumériques, tels que les esperluettes (&), sont supprimés. Les noms de section peuvent être trouvés à l’aide de la méthode getSectionNames( ). |
| affichage | Booléen | Marqueur indiquant s’il faut afficher la section ou non. Valeurs valides :
|
| Type | Description |
|---|---|
| Booléen | Renvoie la valeur vrai en cas de réussite. |
GlideForm : setValue(String fieldName, valeur de chaîne)
Définit la valeur d’un champ de formulaire spécifié sur la valeur spécifiée.
Cette méthode prend également en charge la définition de valeurs dans un jeu de variables à 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 brève n’est pas déjà en majuscules. Cela empêchera le script client d’appliquer toUpperCase() plus d’une fois.| Nom | Type | Description |
|---|---|---|
| Fieldname | Chaîne | Nom du champ de formulaire à mettre à jour. |
| valide | Chaîne | Valeur à définir dans le champ spécifié. Remarque : Lorsque vous définissez une valeur dans une liste de choix, veillez à utiliser la valeur numérique plutôt que l’étiquette. |
| 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 le Service Catalog. Le script client recherche dans toutes les lignes du MRVS la valeur saisie dans le titre de la fonction , 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], Fonction [employee_job_title] et Salaire [employee_salary]. En outre, l’élément de catalogue contient : Fonction [job_title] et Salaire [salaire].
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 : 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 évitant 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). Lorsque vous définissez plusieurs valeurs de référence pour un champ de collecteur de liste, transmettez des tableaux dans les value paramètres and displayValue .
onchange . En effet, chaque fois que la valeur est définie, elle est enregistrée comme un changement, ce qui peut redéclencher le script client OnChange. Pour éviter cela, effectuez une vérification qui validera que la nouvelle valeur sera différente de l’ancienne valeur. Par exemple, avant d’effectuer setValue(shortDesc, newValue.toUpperCase()) ;, vérifiez que la description brève n’est pas déjà en majuscules. Cela empêchera le script client d’appliquer 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 un 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, veillez à utiliser une valeur numérique plutôt qu’une é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 de userName. 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, voir Valeur d’affichage. |
| Type | Description |
|---|---|
| nul |
Cet exemple montre la transmission du 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 la transmission 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 list_field_name GlideList Glide.
g_form.setValue('glide-list_field_name', sysIDArray, displayNameArray);
GlideForm : setVariablesReadOnly(booléen isReadOnly)
Met un éditeur de Catalogue de services variables en lecture seule
La méthode doit être placée dans le script client de la table dans laquelle l’éditeur de variables est ajouté, tel que Requested Item [sc_req_item], Incident [incident], etc. Pour définir les variables en lecture seule dans d’autres tables, utilisez la méthode setReadOnly( ).
Voir aussi : Éditeurs de variables de Catalogue de services
| Nom | Type | Description |
|---|---|---|
| isReadOnly | Booléen | Marqueur qui détermine si l’éditeur de variables est en lecture seule. Valeurs valides :
Valeur par défaut : false |
| Type | Description |
|---|---|
| nul |
L’ajout de la ligne suivante à un script client définit l’éditeur de variables en lecture seule.
g_form.setVariablesReadOnly(true);
GlideForm : setVisible(String, fieldName, affichage booléen)
Affiche ou masque le champ spécifié.
Sur l’interface utilisateur de bureau, l’espace est laissé vide lorsqu’il est masqué. Sur mobile ou Portail de services interface utilisateur, 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 | Nom du champ à afficher ou masquer. |
| affichage | Booléen | Marqueur indiquant s’il faut afficher ou non le champ spécifié. Valeurs valides :
|
| 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 : showAnnotation(nom de chaîne)
Affiche une annotation avec un nom donné sur l’interface utilisateur du formulaire.
- GlideForm : hideAnnotation(nom de chaîne) pour masquer une annotation spécifique sur le formulaire.
- GlideForm : toggleAnnotations() pour activer et désactiver les annotations avec une plus grande flexibilité.
| Nom | Type | Description |
|---|---|---|
| nom | Chaîne | Nom de l’annotation à afficher dans le formulaire. Table : Annotations de formulaire [sys_ui_annotation], Champ : Nom |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment afficher par programmation l’annotation nommée test-annotation-msg sur le champ de formulaire à l’aide de la méthode showAnnotation( ).
g_form.showAnnotation('test-annotation-msg');
GlideForm : showErrorBox(Nom de chaîne, Message de chaîne, booléen scrollForm)
Affiche un message d’erreur sous le champ de formulaire spécifié (objet de contrôle ou nom du champ). Si le contrôle ou le champ est actuellement hors de l’écran et que le scrollForm paramètre est vrai, le formulaire défile jusqu’au contrôle ou au champ.
Une propriété globale (glide.ui.scroll_to_message_field) est disponible qui contrôle le défilement automatique des messages lorsque le champ de formulaire est hors écran (fait défiler le formulaire jusqu’au contrôle ou au 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 sous lequel afficher le message d’erreur. |
| message | Chaîne | Message d’erreur à afficher. |
| formulaire de défilement | Booléen | Marqueur indiquant s’il faut faire défiler automatiquement le formulaire vers le champ de message d’erreur. Valeurs valides :
Par défaut : true |
| Type | Description |
|---|---|
| nul |
GlideForm : showErrorBox(nom de chaîne, message de chaîne)
Affiche un message d’erreur sous le champ de formulaire spécifié (objet de contrôle ou nom du champ). Si le contrôle ou le champ est actuellement hors de l’écran, le formulaire défile automatiquement vers le contrôle ou le champ.
Une propriété globale (glide.ui.scroll_to_message_field) est disponible qui contrôle le défilement automatique des messages lorsque le champ de formulaire est hors écran (fait défiler le formulaire jusqu’au contrôle ou au 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 sous lequel afficher le message d’erreur. |
| message | Chaîne | Message d’erreur à afficher. |
| Type | Description |
|---|---|
| nul |
GlideForm : showFieldMsg(Champ de chaîne, Message de chaîne, Type de chaîne)
Affiche un message sous le champ de formulaire spécifié (objet de contrôle ou nom du champ). Si le contrôle ou le champ n’apparaît pas à l’écran, la méthode fait automatiquement défiler le formulaire vers ce champ.
Une propriété globale (glide.ui.scroll_to_message_field) est disponible qui contrôle le défilement automatique des messages lorsque le champ de formulaire est hors écran (fait défiler le formulaire jusqu’au contrôle ou au 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 sous lequel afficher le message. |
| message | Chaîne | Message à afficher. |
| type | Chaîne | Type de message. Valeurs valides :
|
| 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, Booléen scrollForm)
Affiche un message sous le champ de formulaire spécifié (objet de contrôle ou nom du champ). Si le contrôle ou le champ est actuellement hors de l’écran et scrollFormqu’il est vrai, la méthode fait défiler le formulaire jusqu’à ce champ.
Une propriété globale (glide.ui.scroll_to_message_field) est disponible qui contrôle le défilement automatique des messages lorsque le champ de formulaire est hors écran (fait défiler le formulaire jusqu’au contrôle ou au 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 sous lequel afficher le message. |
| message | Chaîne | Message à afficher. |
| type | Chaîne | Type de message. Valeurs valides :
|
| formulaire de défilement | Booléen | Marqueur indiquant s’il faut faire défiler automatiquement le formulaire jusqu’au champ de message. Valeurs valides :
Par défaut : true |
| Type | Description |
|---|---|
| nul |
g_form.showFieldMsg('impact','Low impact not allowed with High priority','error',false);
GlideForm : showRelatedLinks()
Affiche la section Liens connexes d’un formulaire.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant affiche les liens connexes dans l’interface utilisateur du formulaire.
// Show related links
g_form.showRelatedLinks()
GlideForm : showRelatedList(String listTableName)
Affiche la liste connexe spécifiée sur le formulaire.
Cette méthode n’est pas disponible sur la plateforme mobile. Si cette méthode est exécutée sur une plateforme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| listTableName | Chaîne | Nom de la liste connexe à afficher. |
| Type | Description |
|---|---|
| nul |
GlideForm : showRelatedLists()
Affiche toutes les listes connexes du formulaire.
Cette méthode n’est pas disponible sur la plateforme mobile. Si cette méthode est exécutée sur une plateforme mobile, aucune action ne se produit.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : showTemplateBar()
Si elle est masquée, affiche la barre de modèle au bas du formulaire.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Aucun |
L’exemple de script suivant affiche la barre de modèle au bas du formulaire actuel.
g_form.showTemplateBar()
GlideForm : soumettre()
Enregistre l’enregistrement.
L’utilisateur est retiré du formulaire et le renvoie à l’endroit où il se trouvait.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| nul |
GlideForm : soumettre(verbe de chaîne)
Effectue l’action d’interface utilisateur spécifiée.
| Nom | Type | Description |
|---|---|---|
| verbe | Chaîne | Une action_name d’un enregistrement sys_ui_action. Le nom de l’action doit être pour un bouton de formulaire visible. |
| Type | Description |
|---|---|
| nul |
GlideForm : toggleAnnotations()
Masque ou affiche toutes les annotations sur le formulaire.
Les annotations sont des séparateurs visuels entre les éléments de formulaire, ou des blocs de texte coloré utilisés pour mettre en surbrillance des éléments de formulaire. Si des annotations sont visibles sur le formulaire, l’appel de toggleAnnotations() les masque. De même, si les annotations sont masquées sur le formulaire, l’appel de cette méthode les affiche.
| Nom | Type | Description |
|---|---|---|
| Aucun |
| Type | Description |
|---|---|
| Aucun |
L’exemple suivant montre comment appeler toggleAnnotations() pour afficher ou masquer des annotations de formulaire. Par conséquent, les annotations sont masquées ou affichées en fonction de leur état précédent.
g_form.toggleAnnotations();