API Script Include : ServiceNow Fluent

L’API Script Include définit les includes de script [sys_script_include] qui stockent les fonctions et les classes JavaScript à utiliser par les scripts côté serveur.

Remarque :

Pour les nouveaux scripts, utilisez des modules JavaScript au lieu d’includes de script lorsque cela est possible pour prendre en charge la réutilisation du code et l’utilisation de bibliothèques tierces au sein d’une application incluse dans le périmètre. Pour plus d’informations sur la prise en charge et les limitations des modules JavaScript, reportez-vous à la section Modules JavaScript et bibliothèques tierces.

Pour des informations générales sur les includes de script, reportez-vous à la section Script includes.

Concepts associés

• ServiceNow Fluent

Objet ScriptInclude

Créez un include de script [sys_script_include] pour définir un script côté serveur qui s’exécute lorsqu’il est appelé à partir d’autres scripts.

Tableau 1. Propriétés

Nom	Type	Description
$id	Chaîne ou numéro	Requis. ID unique pour l’objet de métadonnées. Lorsque vous créez l’application, cet ID est haché en une sys_id unique. Pour en savoir plus, consultez ServiceNow Fluent Constructions linguistiques. Format : Now.ID['chaîne' ou numéro]
nom	Chaîne	Requis. Nom de l’include de script. Si vous définissez une classe, le nom doit correspondre au nom de la classe, du prototype et du type. Si vous utilisez un include de script sans classe (à la demande), le nom doit correspondre au nom de la fonction.
script	Script	Requis. Un script côté serveur à appeler à partir d’autres scripts. Le script doit définir une seule classe JavaScript ou une fonction globale. Le nom de la classe ou de la fonction doit correspondre à la propriété de nom . Cette propriété prend en charge le JavaScript en ligne ou une référence à un autre fichier dans l’application qui contient un script. Format : Pour utiliser le contenu textuel d’un autre fichier, reportez-vous à un fichier de l’application en utilisant le format suivant : Now.include('chemin/vers/fichier'). Pour plus d'informations, consultez ServiceNow Fluent Constructions linguistiques. Pour fournir un script inline, utilisez des chaînes de caractères ou des modèles de lignes de code : « Script » ou « Script ».
apiName	Chaîne	Nom interne de l’include de script, qui est utilisé pour appeler l’include de script à partir d’applications hors du champ d’application. Par défaut : <scope>.<name>
description	Chaîne	Description de l’objectif et de la fonction de l’include de script.
clientCallable	Booléen	Marqueur indiquant si les scripts côté client peuvent appeler l’include de script à l’aide de GlideAjax. L’include de script est disponible pour les scripts clients, les filtres de liste/de rapport, les qualificatifs de référence ou s’il est spécifié dans le cadre de l’URL. Les includes de script pouvant être appelés par le client sont invoqués à partir de GlideAjax et exigent que les utilisateurs satisfassent à une ACL associée à l’include de script. Valeurs valides : vrai : l’include de script est disponible pour les scripts côté client. false : l’include de script n’est pas disponible pour les scripts côté client. Valeur par défaut : false
mobileCallable	Booléen	Marqueur indiquant si l’include de script est disponible pour les scripts clients appelés à partir d’équipements mobiles. Valeurs valides : vrai : l’include de script est disponible pour les scripts clients appelés à partir d’équipements mobiles. false : l’include de script n’est pas disponible pour les scripts clients appelés à partir d’équipements mobiles. Valeur par défaut : false
sandboxCallable	Booléen	Marqueur indiquant si l’include de script est disponible pour les scripts invoqués à partir du bac à sable de script, comme une condition de requête. Important : Les includes de script ne doivent être mis à la disposition du bac à sable de script que si nécessaire. Valeurs valides : true : l’include de script est disponible pour les scripts invoqués à partir du bac à sable de script. false : l’include de script n’est pas disponible pour les scripts invoqués à partir du bac à sable de script. Valeur par défaut : false
Accès pour l’appelant	Chaîne	Une option indiquant comment l’accès entre périmètres à l’include de script est autorisé. Pour plus d'informations, consultez Paramètres du privilège d’accès restreint pour l’appelant. Valeurs valides : restriction : les appels à l’include de script doivent être approuvés manuellement. Les demandes d’accès sont suivies dans la table Accès restreint pour l’appelant avec l’état Demandé. tracking : les appels à l’include de script sont automatiquement approuvés. Les appels sont suivis dans la table Accès restreint pour l’appelant avec l’état Autorisé.
accessible depuis	Chaîne	Spécifie les applications pouvant accéder à l’include de script. Valeurs valides : public : tous les périmètres de l’application peuvent appeler l’include de script. package_private : l’include de script ne peut être appelé qu’à partir du périmètre de l’application dans lequel il se trouve. Par défaut : package_private
actif	Booléen	Marqueur indiquant si l’include de script est activé. Valeurs valides : vrai : l’include de script peut être appelé. false : l’include de script ne peut pas être appelé. Par défaut : true
$meta	Objet	Métadonnées pour les métadonnées de l’application. Avec la propriété installMethod , vous pouvez mapper les métadonnées d’application à un répertoire de sortie qui ne se charge que dans des circonstances spécifiques. $meta: {       installMethod: 'String' } Valeurs valides pour installMethod : demo : génère les métadonnées de l’application dans le répertoire metadata/unload.demo à installer avec l’application lorsque l’option Charger les données de démonstration est sélectionnée. première installation : génère les métadonnées de l’application dans le répertoire metadata/unload à installer uniquement la première fois qu’une application est installée sur une instance.

Dans l’exemple suivant, l’include de script utilise un script du fichier SampleClass.server.js .

import { ScriptInclude } from '@servicenow/sdk/core';

ScriptInclude({
    $id: Now.ID['sample-script-include'],
    name: 'SampleScriptInclude',
    script: Now.include("./SampleClass.server.js"),
    description: 'some description',
    apiName: 'x_scope.SampleScriptInclude',
    callerAccess: 'tracking',
    clientCallable: true,
    mobileCallable: true,
    sandboxCallable: true,
    accessibleFrom: 'public',
    active: true,
})