Étape Script

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 6 minutes de lecture

    • Ajoutez un JavaScript personnalisé à exécuter dans une action réutilisable. Bien que la plupart des actions et étapes de base correspondent à des cas d’utilisation courants, vous pouvez créer une étape de script pour exécuter un comportement qui n’est pas satisfait par les étapes de base.

    Rôles et disponibilité

    Disponible en tant qu’étape d’action Studio de workflow . Les utilisateurs disposant du rôle action_designer peuvent créer une action personnalisée avec une ou plusieurs étapes d’action.
    Remarque :
    Hub d'intégration Voir Demande Hub d'intégration pour plus d’informations sur Hub d'intégration l’utilisation et les abonnements.

    Champs

    L’étape Script inclut des variables d’entrée et de sortie distinctes qui vous permettent de mapper les données JavaScript aux Studio de workflow données. En définissant des variables d’entrée et de sortie dans l’étape, vous pouvez définir quelles Studio de workflow données sont disponibles dans votre script et quelles variables de script sont disponibles pour les autres étapes de votre action.

    Champ Description
    Exécution obligatoire
    L’environnement d’exécution requis pour prendre en charge le script. Les choix sont les suivants :
    • Instance : l’étape d’action exécute le script à partir de l’instance. Sélectionnez cette option lorsque le script a besoin d’accéder aux données d’API ServiceNow ou d’instance. Il s’agit de la valeur par défaut.
    • MID : l’étape d’action exécute le script à partir du Serveur MID. Sélectionnez cette option lorsque le script a besoin d’accéder aux fichiers de script et aux API de Serveur MID . Si vous sélectionnez cette option, le champ Sélectionner un serveur MID s’affiche .
    • Vanilla (JavaScript principal) : l’étape d’action exécute le script à partir de l’instance ou du MID Server. Sélectionnez cette option lorsque le script n’a besoin que des API JavaScript principales et non de l’API ou des données d’instance ServiceNow .

    La durée d’exécution que vous sélectionnez détermine les objets et méthodes JavaScript affichés dans l’aide contextuelle.

    Remarque :
    Ce champ n’est visible que lorsque Hub d'intégration est activé.
    Sélectionner un MID Server en utilisant
    Spécifiez le processus de sélection de Serveur MID à utiliser. Les choix sont les suivants :
    • N’importe quel MID. Le système exécute l’étape d’action à partir de n’importe quel Serveur MID disponible.
    • Utilisez un alias de connexion. Le système exécute l’action à l’aide de l’alias de connexion que vous spécifiez. La sélection de cette option affiche le champ Alias de connexion .
    • Utilisez la sélection en ligne. Le système exécute l’action à l’aide des détails de connexion que vous spécifiez dans l’action. La sélection de cette option affiche les champs Hôte, Application MID et Options .
    Remarque :
    Ce champ n’est visible que lorsque est activé et que Hub d'intégration vous sélectionnez MID dans Exécution requise.
    Alias de connexion Enregistrement d’alias de connexion et d’informations d’identification que le système utilise pour exécuter l’étape d’action. Les utilisateurs disposant du rôle flow_designer ou admin peuvent créer ou sélectionner un enregistrement de connexion associé. L'utilisation d'un alias élimine la nécessité de configurer plusieurs informations d'identification et profils d'informations de connexion lors de l'utilisation d'une action dans plusieurs environnements. De même, si les informations de connexion changent, vous n’avez pas besoin de mettre à jour votre action personnalisée. Pour en savoir plus sur les connexions et les informations d’identification , consultez Informations d’identification, connexions et alias. Seuls les alias de type de connexion Basique sont pris en charge.
    Remarque :
    Ce champ n’est visible que lorsqu’il Hub d'intégration est activé et que vous sélectionnez Utiliser des alias de connexion à partir de Sélectionner un serveur MID à l’aide de.
    Hôte Nom de domaine complet du Serveur MID sur lequel le système exécute l’étape d’action. Par exemple, mid-server.domain.com.
    Remarque :
    Ce champ n’est visible que lorsque Hub d'intégration est activé et que vous sélectionnez Utiliser la sélection en ligne à partir de Sélectionner Serveur MID à l’aide de.
    Sélection de MID Option permettant de sélectionner le serveur MID ou la grappe MID spécifique.
    • Sélectionner automatiquement un serveur MID : sélectionne automatiquement le serveur MID.
    • Serveur MID spécifique : utilise le serveur MID que vous sélectionnez.
    • Grappe MID spécifique : utilise la grappe MID que vous sélectionnez.
    Ce champ est disponible lorsque MID est sélectionné dans la liste Exécution requise et que l’option Utiliser la sélection en ligne est sélectionnée dans la liste Sélectionner un serveur MID à l’aide de.
    Grappe MID Pilule de données pour la grappe MID que vous souhaitez utiliser. Ce champ est disponible lorsque MID est sélectionné dans la liste Exécution requise et que l’option Utiliser la sélection en ligne est sélectionnée dans la liste Sélectionner un serveur MID à l’aide de.
    Application MID Spécifiez l’application que le MID Server doit prendre en charge pour être éligible à la sélection. Le système exécute l’étape d’action à partir d’un Serveur MID qui prend en charge l’application sélectionnée. Ce champ n’est visible que lorsqu’il est activé, que l’option Hub d'intégrationSélectionner automatiquement le serveur MID est sélectionnée dans la liste Sélection MID et que vous sélectionnez Utiliser la sélection en ligne dans Sélectionner un serveur MID à l’aide de.
    Aptitudes Capacités que le doit prendre en charge pour être éligible à la Serveur MID sélection. Le système exécute l’étape d’action à partir d’un Serveur MID qui prend en charge les options sélectionnées. Ce champ n’est visible que lorsqu’il est activé, que l’option Hub d'intégrationSélectionner automatiquement le serveur MID est sélectionnée dans la liste Sélection MID et que vous sélectionnez Utiliser la sélection en ligne dans Sélectionner un serveur MID à l’aide de.
    Serveur MID spécifique Pilule de données de l’espace requis Serveur MID. Ce champ n’est visible que lorsqu’il est activé, qu’un Hub d'intégrationServeur MID spécifique est sélectionné dans la liste Sélection de MID et que vous sélectionnez Utiliser la sélection en ligne à partir de Sélectionner Serveur MID à l’aide de.
    Variables d'entrée Paires nom-valeur qui représentent les données de l’action, ce qui vous permet d’utiliser les entrées d’action et les données d’autres étapes dans un script.
    Script
    Script qui s’exécute au sein de l’action. Pour accéder aux variables d’entrée et de sortie de votre script, utilisez les entrées et sortiesd’objets globaux. Par exemple, inputs.myVariable.
    Remarque :
    Étape Script Les noms d’entrée et de sortie ne peuvent inclure aucun des noms de système réservés suivants :
    • sys_id
    • sys_created_by
    • sys_created_on
    • sys_updated_on
    • sys_updated_by
    • sys_mod_count
    En général, ne créez pas de variable portant le même nom qu’un champ système. L’étape Script peut confondre une telle variable d’entrée avec un nom de champ et utiliser une valeur erronée.
    L’étape Script convertit toujours les données stockées dans les objets globaux d’entrée et de sortie en chaînes. Si votre étape de script doit fonctionner avec des données JSON, vous pouvez utiliser l’objet global des entrées pour convertir les données JSON en une chaîne. Vous pouvez également définir une variable JavaScript en tant que chaîne plutôt qu’en tant qu’objet JavaScript. Par exemple, ce script illustre deux façons de générer des données JSON.
    (function execute(inputs, outputs) {
  outputs.json_object_1 = inputs.json_input;
  var array_of_objs = '[{"name1":"value1"}, {"id":"abcd"}]';
  outputs.json_object_2 = array_of_objs;
})(inputs, outputs);

    Par défaut, Studio de workflow exécutez les scripts sur l’instance. L’exécution d’un script à partir d’un serveur MID nécessite un Hub d'intégration abonnement.

    Studio de workflow Exécute le script à partir du domaine à partir duquel il est déclenché ou initié. Consultez Séparation de domaine et Studio de workflow.

    Pour connaître les classes et les méthodes disponibles, reportez-vous à l’aide contextuelle de l’API JavaScript ou au API referencefichier .
    Variables de sortie Mappez la sortie JavaScript aux Studio de workflow pastilles de données. Définir des variables de sortie lorsque vous voulez que d’autres étapes de l’action utilisent la sortie d’un script.

    Évaluation de l’erreur d’action

    En cas d'échec de cette étape
    Type de données : Choice

    Option permettant de continuer à exécuter l’étape suivante ou d’accéder à l’évaluation des erreurs. Pour utiliser le code d’état ou le message de l’étape pour une condition d’erreur d’action personnalisée, reportez-vous à la section Évaluation de l’erreur d’action.

    Exemple

    Cet exemple génère une charge utile JSON qui peut être facilement mise à jour ou modifiée et ajoutée à une étape REST ultérieure.

    Remarque :
    Étape REST n’est pas disponible dans le système de base et nécessite un ServiceNow® Hub d'intégration abonnement.

    Exemple d’étape de script dans une action.

    En créant une variable de sortie qui représente la charge utile, vous pouvez faire glisser la pastille de données [Payload] dans le champ Corps de l’étape REST.