API : UI Builder

API : api.context.props.<page_property_name>

Les propriétés de la page peuvent être configurées dans .Générateur d'IU Les valeurs de configuration dépendent du contexte dans lequel la page est utilisée.

Tableau 1. Champ
Nom	Type	Description
<page_property_name>	N'importe lequel	Les valeurs disponibles dépendent de l’implémentation du script client. Pour accéder à ces propriétés, utilisez les éléments suivants : `api.context.props.<page_property_name>`. Par exemple : `// A record page with property table could be accessed with function isActivityStreamVisible({api}) { return api.context.props.table === 'incident'; }` Remarque : Ces valeurs de propriété sont en lecture seule. La mutation des valeurs d’objets imbriqués à partir de scripts n’est pas prise en charge.

API : api.context.session.<session_property>

Propriétés de session contextuelle associées à l’utilisateur actuel.

Tableau 2. Propriétés de session disponibles
Nom	Type	Description
isLoggedIn	Booléen	Marqueur indiquant si l’utilisateur actuel est connecté au système. Valeurs possibles : vrai : l’utilisateur actuel est connecté à faux : l’utilisateur actuel n’est pas connecté.
properties.awaEnabled	Chaîne	La propriété système glide.awa.enabled qui indique si l’affectation automatique des éléments de travail pour Affectation de travail avancée (AWA) est activée pour l’utilisateur actuel. Valeurs possibles : vrai : AWA est activé pour l’utilisateur. faux : AWA n’est pas activé pour l’utilisateur. Pour plus d’informations, voir Composants installés avec Advanced Work Assignment (Affectation de travail avancée).
propriété.forgetMe.valeur	Chaîne	La propriété glide.ui.forgetme qui indique s’il faut supprimer la case à cocher « Se souvenir de moi » de la page de connexion pour empêcher que les informations de connexion ne soient mises en cache. Valeurs possibles : true : supprimez la case à cocher Se souvenir de moi . false : affichez la case à cocher Se souvenir de moi . Pour plus d’informations, voir Supprimer Se souvenir de moi.
propriété.sessionTimeLeft.value	Chaîne Nombre contraint à une chaîne	La propriété système glide.ui.session_timeleft qui détermine le temps restant avant l’expiration de la session en cours. Utilisez cette propriété pour inviter l’utilisateur à étendre la session en cours avant qu’elle n’expire. Unité : Minutes
properties.sessionTimeout.value	Chaîne Nombre contraint à une chaîne	La propriété système glide.ui.session_timeout qui détermine la valeur du délai d’expiration de la session initiale. Unité : minutes : les valeurs supérieures à 1 440 minutes sont traitées comme un jour. Pour plus d’informations, voir Délai d’activité de la session
propriété.trackingEnabled.valeur	Chaîne	La propriété système glide.uxbuilder.tracking.enabled qui indique s’il faut activer/désactiver le chargement de la bibliothèque analytique web et l’instanciation pour les applications basées sur Générateur d'IU elle. Valeurs possibles : vrai : activé pour l’utilisateur. faux : désactivé pour l’utilisateur.
utilisateur.avatar	Chaîne	URL de l’avatar de l’utilisateur actuel.
Format.date.utilisateur	Chaîne	Format de date par défaut.
utilisateur.domaine	Chaîne	Chemin de domaine pour l’utilisateur actuel.
utilisateur.prénom	Chaîne	Prénom de l’utilisateur actuel.
utilisateur.nom.complet	Chaîne	Prénom et nom de famille de l’utilisateur actuel.
Initiales.utilisateurs	Chaîne	Initiales de l’utilisateur actuel.
utilisateur.langue	Chaîne	Langue principale parlée par l’utilisateur actuel.
Utilisateur.Préférences	Tableau d’objets	Paires nom-valeur qui décrivent les préférences utilisateur. Ces préférences utilisateur sont stockées sous forme d’enregistrements dans la table des préférences utilisateur [sys_user_preference] et sont mises à jour chaque fois que l’utilisateur modifie leurs paramètres. Pour en savoir plus, consultez Exploring user administration.
utilisateur.rôles	Tableau	Liste de rôles séparés par des virgules affectés à l’utilisateur actuel. Remarque : Si aucun rôle n’est affecté à l’utilisateur, cette propriété de session de contexte renvoie null plutôt qu’un tableau vide.
user.sys_id	Chaîne	Sys_id de l’utilisateur dans la table Utilisateur [sys_user].
user.timeFormat	Chaîne	Format d’heure par défaut à utiliser pour l’utilisateur.
utilisateur.fuseau horaire	Chaîne	Fuseau horaire de l’utilisateur actuel.
utilisateur.timeZoneOffset	Chaîne	Décalage du fuseau horaire de l’utilisateur actuel.

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

Marqueur booléen indiquant si la dernière tentative d’extraction pour l’instance de ressource de données spécifiée s’est terminée avec succès.

Si la valeur est définie sur vrai, la dernière tentative d’extraction pour l’instance de ressource de données s’est terminée avec succès ; sinon, c’est faux.

Tableau 3. Champ
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.

api : api.data.<data_resource_id>.addErrorMessage(charge utile de l’objet)

Affiche le message d’erreur spécifié en haut du formulaire actuel.

Tableau 4. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet décrivant le message d’erreur à afficher. `"payload": { "message": "String" }`
charge.message utile	Chaîne	Message d’erreur à afficher.

Tableau 5. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.addInfoMessage(charge utile de l’objet)

Affiche le message d’information spécifié en haut du formulaire actuel.

Tableau 6. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet décrivant le message d’information à afficher. `"payload": { "message": "String" }`
charge.message utile	Chaîne	Message d’information à afficher.

Tableau 7. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.addOption(charge utile de l’objet)

Ajoute une option au champ de type de choix spécifié.

Tableau 8. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet décrivant la valeur de champ à mettre à jour. `"payload": { "choiceIndex": "String", "choiceLabel": "String", "choiceValue": "String", "fieldName": "String" }`
payload.choiceIndex	Chaîne	Facultatif. Index dans la liste de choix où insérer l’option. Par défaut : fin de la liste de choix.
charge.choixÉtiquette	Chaîne	Étiquette de l’option à ajouter au champ spécifié.
chargeutile.valeurchoix	Chaîne	Valeur de l’option à ajouter au champ spécifié.
charge.champNom	Chaîne	Nom du champ de formulaire de type de choix auquel ajouter l’option spécifiée.

Tableau 9. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.addWarningMessage(charge utile de l’objet)

Affiche le message d’avertissement spécifié en haut du formulaire actuel.

Tableau 10. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet décrivant le message d’avertissement à afficher. `"payload": { "message": "String" }`
charge.message utile	Chaîne	Message d’avertissement à afficher.

Tableau 11. Renvoie
Type	Description
Néant

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

API : api.data.<data_resource_id>.clearMessage()

Supprime tous les messages d’information et d’erreur du haut du formulaire actuel.

Tableau 12. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.

Tableau 13. Renvoie
Type	Description
Néant

api.data.gform.clearMessage();

api : api.data.<data_resource_id>.clearOptions(charge utile de l’objet)

Efface toutes les options du champ de type de choix spécifié.

Tableau 14. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet qui décrit le champ de type de choix dont les options doivent être effacées. `"payload": { "fieldName": "String" }`
charge.champNom	Chaîne	Nom du champ de type choix dont les options doivent être décochées.

Tableau 15. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.executeUiAction(charge utile de l’objet)

Exécute l’action d’interface utilisateur spécifiée.

Tableau 16. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Description de l’action d’interface utilisateur à exécuter. `"payload": { "actionSysId": "String" }`
chargeutile.actionSysId	Chaîne	Sys_id de l’action d’interface utilisateur à exécuter. Table : Action d’interface utilisateur [sys_ui_action]

Tableau 17. Renvoie
Type	Description
Néant

L’exemple de code suivant montre comment appeler cette méthode.

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

api : api.data.<data_resource_id>.execute(Objet inputValues)

Déclenche une opération d’exécution sur la ressource de données spécifiée.

Cette méthode n’est disponible que si la ressource de données est de l’un des types suivants :

Composite
GraphQL
REST
Scriptlet
Transformer

Remarque :

Cette méthode n’est exposée que si le mutates_server_data champ est défini sur vrai sur l’enregistrement de ressource de données (table sys_ux_data_broker_*) correspondant. Il est accessible à l’adresse api.data.<data_resource_Id>.refresh().

Tableau 18. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
inputValues	Objet	Objet à transmettre à la ressource de données spécifiée. Cet objet doit être conforme aux paramètres d’entrée de la ressource de données.

Tableau 19. Renvoie
Type	Description
Néant

Cet exemple de code montre un script de page appelé lorsque l’utilisateur clique sur le bouton Soumettre de la page. La page est configurée avec une ressource de données de serveur qui crée un nouvel enregistrement.

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

api : api.data.<data_resource_id>.hideFieldMessage(charge utile de l’objet)

Masque le message le plus ancien en regard du champ spécifié ou efface tous les messages associés au champ.

Tableau 20. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet décrivant le message du champ à masque. `"payload": { "clearAll": Boolean, "fieldName": "String" }`
charge utile.clearAll	Booléen	Facultatif. Marqueur indiquant s’il faut effacer tous les messages associés au champ de formulaire spécifié. Valeurs valides : vrai : effacer tous les messages associés au champ spécifié. faux : ne pas effacer tous les messages associés au champ spécifié. Valeur par défaut : false
charge.champNom	Chaîne	Nom du champ de formulaire pour lequel masquer le message le plus ancien ou effacer tous les messages associés.

Tableau 21. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.hideRelatedList(charge utile de l’objet)

Masque la liste connexe spécifiée sur le formulaire actuel.

Tableau 22. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet décrivant la liste connexe à masque. `"payload": { "listTableName ": "String" }`
payload.listTableName	Chaîne	Nom de la liste connexe à masque. Si la liste à masquer est liée à une relation, indiquez le sys_id de la liste au lieu du nom. Table : Liste connexe [sys_ui_related_list]

Tableau 23. Renvoie
Type	Description
Néant

L’exemple de code suivant montre comment appeler cette méthode.

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

api : api.data.<data_resource_id>.hideRelatedLists()

Masque toutes les listes connexes sur le formulaire actuel.

Tableau 24. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.

Tableau 25. Renvoie
Type	Description
Néant

api.data.gform.hideRelatedLists();

API : api.data.<data_resource_id>.refresh()

Déclenche une opération d’actualisation pour l’instance de ressource de données non mutante spécifiée.

Appelez cette méthode si les données sous-jacentes extraites par la ressource de données changent. Une ressource de données est considérée comme non mutante si le mutates_server_data champ de l’enregistrement est défini sur faux.

Cette méthode est asynchrone et émet un événement interne pour déclencher l’actualisation de l’instance de ressource de données spécifiée. Vous Générateur d'IU permet de déclencher des scripts clients en réponse aux événements du cycle de vie des ressources de données, tels que DATA_FETCH_SUCCEEDED et DATA_FETCH_FAILED. Pour plus d’informations sur ces événements, consultez Mappage d’événements.

Cette méthode n’est disponible que si la ressource de données est de l’un des types suivants :

Composite
GraphQL
REST
Scriptlet
Transformer

Remarque :

Cette méthode n’est exposée que si le mutates_server_data champ est défini sur false dans l’enregistrement de ressource de données correspondant (table sys_ux_data_broker_*).

Tableau 26. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.

Tableau 27. Renvoie
Type	Description
Néant

Cet exemple de code montre un script de page appelé lorsqu’un élément de liste déroulante est sélectionné dans une page. La page est configurée avec deux ressources de données de serveur qui interrogent les tables de problèmes et d’incidents.

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

API : api.data.<data_resource_id>.reload()

Recharge le formulaire actuel à l’aide de la même table et de la même sys_id.

Tableau 28. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.

Tableau 29. Renvoie
Type	Description
Néant

api.data.gform.reload();

api : api.data.<data_resource_id>.removeOption(charge utile de l’objet)

Supprime une option du champ de type de choix spécifié.

Tableau 30. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet qui décrit le champ de type de choix à mettre à jour. `"payload": { "choiceValue": "String", "fieldName": "String" }`
chargeutile.valeurchoix	Chaîne	Valeur de l’option à supprimer du champ du type de choix spécifié.
charge.champNom	Chaîne	Nom du champ de formulaire de type choix duquel supprimer la valeur spécifiée.

Tableau 31. Renvoie
Type	Description
Néant

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

API : api.data.<data_resource_id>.save()

Déclenche la soumission du formulaire à l’aide de l’action d’interface utilisateur Enregistrer .

Tableau 32. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.

Tableau 33. Renvoie
Type	Description
Néant

api.data.gform.save();

api : api.data.<data_resource_id>.setMandatory(charge utile de l’objet)

Définit si le champ de formulaire spécifié est obligatoire.

Tableau 34. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet qui décrit le champ dont les informations obligatoires doivent être mises à jour. `"payload": { "fieldName": "String", "mandatory": Boolean }`
charge.champNom	Chaîne	Nom du champ de formulaire dont la valeur obligatoire doit être définie.
charge utile.obligatoire	Booléen	Marqueur qui indique que le champ de formulaire spécifié est obligatoire, ce qui signifie que le formulaire ne peut pas être enregistré sans que ce champ contienne une valeur valide. Valeurs valides : vrai : le champ est obligatoire. faux : le champ est facultatif.

Tableau 35. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.setReadOnly(charge utile de l’objet)

Définit les options de lecture/écriture du champ de formulaire spécifié.

Tableau 36. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet qui décrit le champ dont les informations de lisibilité doivent être mises à jour. `"payload": { "fieldName": "String", "readonly": Boolean }`
charge.champNom	Chaîne	Nom du champ de formulaire dont la lisibilité doit être définie.
charge utile.lecture seule	Booléen	Marqueur qui indique les options de lecture/écriture du champ de formulaire spécifié. Valeurs valides : vrai : le champ est en lecture seule. faux : le champ est en lecture/écriture.

Tableau 37. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.setValue(charge utile de l’objet)

Met à jour un champ GlideForm spécifié avec la valeur spécifiée. Vous pouvez également mettre à jour la valeur Display (Affichage) avec la même valeur spécifiée.

Seule la valeur du formulaire est mise à jour. La valeur n’est pas enregistrée dans la base de données.

Tableau 38. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet qui décrit le champ dont la valeur doit être mise à jour. `"payload": { "displayValue": "String", "fieldName": "String", "value": "String" }`
chargeutile.valeurdisplayValue	Chaîne	Facultatif. Nom de la valeur d’affichage à mettre à jour. Si ce champ est laissé vide, la valeur d’affichage n’est pas modifiée.
charge.champNom	Chaîne	Nom du champ de formulaire à mettre à jour.
charge.valeur utile	Chaîne	Valeur avec laquelle mettre à jour le champ.

Tableau 39. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.setVisible(charge utile de l’objet)

Définit la visibilité du champ de formulaire spécifié.

Tableau 40. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet qui décrit le champ sur lequel définir la visibilité. `"payload": { "fieldName": "String", "visibility": Boolean }`
charge.champNom	Chaîne	Nom du champ de formulaire dont la visibilité doit être définie.
chargeutile.visibilité	Booléen	Marqueur indiquant si le champ associé est visible sur le formulaire actuel. Valeurs valides : vrai : le champ s’affichera sur le formulaire. faux : le champ ne s’affiche pas sur le formulaire.

Tableau 41. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.showFieldMessage(charge utile de l’objet)

Affiche le message spécifié en regard du champ spécifié.

Tableau 42. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet qui décrit le message de champ à afficher. `"payload": { "fieldName": "String", "message": "String", "type": "String"`
charge.champNom	Chaîne	Nom du champ en regard duquel le message doit s’afficher.
charge.message utile	Chaîne	Message à afficher.
charge.type	Chaîne	Facultatif. Type de message à afficher. Valeurs valides : erreur infos avertissement Par défaut : info

Tableau 43. Renvoie
Type	Description
Néant

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

api : api.data.<data_resource_id>.showRelatedList(charge utile de l’objet)

Affiche la liste connexe spécifiée sur le formulaire actuel.

Tableau 44. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet décrivant la liste connexe à afficher. `"payload": { "listTableName ": "String" }`
payload.listTableName	Chaîne	Nom de la liste connexe à afficher. Si la liste à afficher est par le biais d’une relation, indiquez le sys_id de la liste au lieu du nom. Table : Liste connexe [sys_ui_related_list]

Tableau 45. Renvoie
Type	Description
Néant

L’exemple de code suivant montre comment appeler cette méthode.

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

api : api.data.<data_resource_id>.showRelatedLists()

Affiche toutes les listes connexes associées au formulaire actuel.

Tableau 46. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.

Tableau 47. Renvoie
Type	Description
Néant

api.data.gform.showRelatedLists();

API : api.data.<data_resource_id>.submit()

Déclenche la soumission du formulaire à l’aide de l’action d’interface utilisateur spécifiée.

Tableau 48. Paramètres
Nom	Type	Description
data_resource_id	Chaîne	Identificateur unique de la ressource de données associée. Dans la plupart des cas, vous pouvez utiliser l’action du contrôleur de formulaire CTRL_RECORD#SAVE_FORM. Si la page d’enregistrement comporte le composant Onglets de page d’enregistrement, la ressource de données pour cette méthode doit être basée sur GlideForm (g_form). Les instances de ressources de données disponibles dépendent de la configuration et sont définies lorsque vous ajoutez la ressource de données à votre page dans Générateur d'IU.
charge utile	Objet	Objet qui décrit l’action d’interface utilisateur à utiliser pour soumettre le formulaire actuel. `"payload": { "submitActionName": "String" }`
chargeutile.submitActionName	Chaîne	Nom de l’action d’interface utilisateur à exécuter pour soumettre le formulaire actuel.

Tableau 49. Renvoie
Type	Description
Néant

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

api : api.emit(String eventName, charge utile de l’objet)

Émet un événement avec le nom et la charge utile spécifiés.

Le nom de l’événement émis doit faire partie de la liste d’événements répartis de la définition de page associée, qui est stockée dans la table Définition du macroponent UX [sys_ux_macroponent]. Tout appel api.emit qui répartit des événements non déclarés dans cette table est ignoré.

Pour plus d’informations sur les événements, voir Utilisation des événements.

Tableau 50. Paramètres
Nom	Type	Description
eventName	Chaîne	Nom de l’événement à émettre. Ce nom doit respecter les directives de dénomination des actions du cadre de travail de l’interface utilisateur : Devrait être en cas de serpent supérieur, tel que ITEM_CHANGED. Toutes les lettres en majuscules et tous les espaces sont remplacés par des traits de soulignement. Doit être au passé, tel que BUTTON_CLICKED ou USER_SELECTED. Pour plus d’informations sur ces directives de dénomination des actions, reportez-vous à la section https://developer.servicenow.com/dev.do#!/reference/now-experience/sandiego/ui-framework/main-concepts/dispatching-actions.
charge utile	Objet	Facultatif. Objet contenant les données à envoyer avec l’événement émis. Cet objet est de forme libre et peut contenir toutes les données nécessaires à l’entité qui reçoit les données. Remarque : Des charges utiles de type primitif fonctionnent, mais peuvent entraîner un comportement incohérent.

Tableau 51. Renvoie
Type	Description
Néant

L’exemple de code suivant montre l’émission d’un événement appelé NOW_UXF_PAGE#ADD_NOTIFICATIONS avec une charge utile associée items .

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

api : setState(String stateParam, n’importe quelle valeur)

Définit la valeur du paramètre d’état de client spécifié.

Utilisez les paramètres d’état du client pour gérer un état partagé sur une page. L’état partagé peut ensuite être transmis en tant que valeurs aux propriétés des composants utilisés sur la page. Vous pouvez également accéder aux états clients et les mettre à jour dans plusieurs scripts de page. Un cas d’utilisation courant consiste à suivre les valeurs saisies par les utilisateurs dans plusieurs contrôles de formulaire sur une page. Lorsque le formulaire est soumis, un script client peut alors utiliser toutes les valeurs stockées dans les paramètres d’état du client pour créer un nouvel enregistrement avec un courtier en données. Une page peut avoir un ou plusieurs paramètres d’état du client, que vous pouvez déclarer pour une page via le Générateur d’IU. Vous pouvez ensuite lier un paramètre d’état client à un ou plusieurs composants pour partager ou agir sur le paramètre d’état client.

Les appels api.setState() sont exécutés de manière asynchrone et ne mettent pas nécessairement à jour l’interface utilisateur immédiatement. Si la valeur à définir dépend currentValue du paramètre d’état du client ou de l’une des propriétés fournies dans l’objet api, vous devez utiliser cette variante de la méthode api.setState() pour éviter d’utiliser des valeurs obsolètes.

Tableau 52. Paramètres
Nom	Type	Description
StateParm	Chaîne	Nom du paramètre d’état du client à mettre à jour. Ce nom doit être déclaré dans les paramètres d’état client de la page associée. Pour plus d’informations sur la déclaration des paramètres d’état du client, consultez Utilisation des paramètres d’état du client.
valide	N’importe lequel : doit être identique à la déclaration de paramètre d’état du client.	Valeur sur laquelle définir le paramètre d’état de client spécifié.

Tableau 53. Renvoie
Type	Description
Néant

Cet exemple montre un script qui peut être exécuté pour mettre à jour le paramètre d’état du client de messagerie lorsqu’une valeur d’entrée est définie sur un composant now-input.

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

api : setState(String stateParam, fonction callbackFn)

Définit la valeur du paramètre d’état du client spécifié sur la valeur renvoyée par la fonction de rappel spécifiée.

La fonction de rappel est invoquée avec un objet qui a deux propriétés : currentValue et api. La fonction ne doit jamais muter directement la currentValue propriété ou l’objet api .

Utilisez les paramètres d’état du client pour gérer un état partagé sur une page. L’état partagé peut ensuite être transmis en tant que valeurs aux propriétés des composants utilisés sur la page. Vous pouvez également accéder aux états clients et les mettre à jour dans plusieurs scripts de page. Un cas d’utilisation courant consiste à suivre les valeurs saisies par les utilisateurs dans plusieurs contrôles de formulaire sur une page. Lorsque le formulaire est soumis, un script client peut alors utiliser toutes les valeurs stockées dans les paramètres d’état du client pour créer un nouvel enregistrement avec un courtier en données. Une page peut avoir un ou plusieurs paramètres d’état du client, que vous pouvez déclarer pour une page via le Générateur d’IU. Vous pouvez ensuite lier un paramètre d’état client à un ou plusieurs composants pour partager ou agir sur le paramètre d’état client.

Les appels api.setState() sont exécutés de manière asynchrone et ne mettent pas nécessairement à jour l’interface utilisateur immédiatement. Si la valeur à définir dépend currentValue du paramètre d’état du client ou de l’une des propriétés fournies dans l’objet api, vous devez utiliser cette variante de la méthode api.setState() pour éviter d’utiliser des valeurs obsolètes.

Tableau 54. Paramètres
Nom	Type	Description
StateParm	Chaîne	Nom du paramètre d’état du client à mettre à jour. Ce nom doit être déclaré dans les paramètres d’état client de la page associée. Pour plus d’informations sur la déclaration des paramètres d’état du client, consultez Utilisation des paramètres d’état du client.
callbackFn	Fonction	Fonction de rappel à exécuter pour obtenir la valeur.

Tableau 55. Renvoie
Type	Description
Néant

Cet exemple montre comment utiliser api.setState pour connecter les utilisateurs à une page.

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

API : api.state.<client_state_parameter_name>

Valeur actuelle du paramètre spécifié de l’état du client.

Tableau 56. Champ
Nom	Type	Description
<client_state_parameter_name>	N’importe lequel. Les paramètres d’état du client disponibles dépendent de la configuration de la page.	Nom du paramètre de l’état du client. Les états clients disponibles dépendent de l’implémentation du script client. Pour accéder aux états de client disponibles, utilisez les éléments suivants : `api.state.<client_state_name>`. Par exemple : `function showRelatedLists({api}) { return !api.state.isCustomListSelected; }` Remarque : Ces valeurs de propriété sont en lecture seule. Pour mettre à jour un paramètre d’état client, utilisez api.setState(). La mutation des valeurs d’objets imbriqués à partir de scripts n’est pas prise en charge.