Tutoriel partie 3 : Définir une table dans le ServiceNow Fluent code

Créez une table et référencez-la dans des exemples de définitions de script à l’aide ServiceNow Fluent des API.

Avant de commencer

Terminez Didacticiel partie 2 : Initialiser un dépôt pour votre application.

Rôle requis : admin

Pourquoi et quand exécuter cette tâche

ServiceNow Fluent est un langage spécifique à un domaine (DSL) basé sur TypeScript pour définir les fichiers de métadonnées [sys_metadata] qui composent les applications et inclut des API pour les différents types de métadonnées, tels que les tables, les rôles, les ACL, les règles métier et Framework de tests automatisés les tests. Vous utilisez des objets dans les ServiceNow Fluent API pour définir les métadonnées dans les fichiers avec l’extension .now.ts . Le dispose par défaut d’un traitement et d’une ServiceNow IDE validation de la langue pour ServiceNow Fluent les API et les applications. Pour plus d'informations sur ServiceNow Fluent, consultez ServiceNow Fluent.

Dans cet exemple, vous créez une table simple pour une liste de tâches à l’aide d’objets dans l’API Table ServiceNow Fluent . Ensuite, vous mettez à jour l’exemple de code pour les définitions de règle métier et de script client afin de référencer la nouvelle table. Enfin, vous examinez vos modifications à partir de l’explorateur de métadonnées. Pour plus d’informations sur l’API de table, reportez-vous à la section API de table : ServiceNow Fluent.

Procédure

1. Dans la barre d’activité, sélectionnez la vue Explorateur de fichiers ( ).
2. Accédez au répertoire src/fluent dans votre application.
3. Ouvrez le fichier d’exemple index.now.ts .
   Conseil :

   Vous pouvez écrire ServiceNow Fluent du code dans un seul fichier ou autant .now.ts fichiers que vous le souhaitez et organiser les fichiers dans des répertoires du répertoire fluent .
4. Sur une nouvelle ligne à la fin du fichier, entrez Table({}) pour ajouter l’objet Table.
5. Dans la barre d’état, sélectionnez l’icône de diagnostic ( ) pour ouvrir le panneau Problèmes et rechercher des problèmes dans le code.

   

6. Cliquez avec le bouton droit de la souris sur l’erreur qui apparaît et sélectionnez la solution rapide Mettre à jour l’importation dans « @servicenow/sdk/core ».

   

   À la ligne 2, l’objet Table est ajouté à la liste des importations depuis @servicenow/sdk/core :

   import { BusinessRule, ClientScript, Table } from '@servicenow/sdk/core'

   Conseil :

   Après avoir résolu ce problème, vous pouvez fermer le panneau Problèmes tout en procédant comme suit. À une étape ultérieure, vous y reviendrez si des problèmes subsistent.
7. Dans l’objet Table , ajoutez les propriétés suivantes.
   • name : le nom de la table doit commencer par le périmètre de l’application et utiliser des lettres minuscules au format suivant : <scope>_<name>. Vous trouverez le champ d’application dans le fichier now.config.json de l’application.
   • label : l’étiquette doit être unique et s’affiche pour la table dans les vues de liste et de formulaire.
   • extends : nom d’une autre table sur laquelle la table est basée.

   Table({
       name: 'x_snc_hello_world_to_do', //ensure that the name begins with the correct scope (<scope>_<name>)
       label: 'To-do Items',
       extends: 'task',
   })

   Conseil :

   Survolez un objet pour afficher sa documentation intégrée au produit.

   

8. Pour prendre en charge la suggestion automatique lors de la définition de colonnes dans la table, avant l’objet Table , ajoutez une variable exportée portant le même nom que la propriété name.

   export const x_snc_hello_world_to_do = Table({
       name: 'x_snc_hello_world_to_do',
       label: 'To-do Items',
       extends: 'task',
   })

9. Dans l’objet Table , ajoutez la propriété schema pour définir les colonnes de la table.

   export const x_snc_hello_world_to_do = Table({
       name: 'x_snc_hello_world_to_do',
       label: 'To-do Items',
       extends: 'task',
       schema: {
           //define columns here
       }
   })

   La propriété de schéma est un tableau d’objets de colonne . Il existe de nombreux types de colonnes basées sur le type de champ. Les objets de colonne utilisent le format <Type>Column où <Type> est le type de champ.

   Utilisez les détails suivants pour définir trois colonnes dans la table : Date limite, Matrice et Tâche. Consultez la Objet de colonne documentation pour vous aider à configurer chaque colonne.

   Nom de colonne	Détails
   Date limite	Étiquette : Date limite Type : Date/Heure
   matrice	Étiquette : matrice Type : chaîne Choix : Étiquette : Urgent et important Label (Étiquette) : Important, mais pas urgent Étiquette : Urgent mais pas important Label (Étiquette) : Ni urgent, ni important
   tâche	Étiquette : tâche Type : chaîne Longueur maximale : 120

   Avec ces détails, la propriété de schéma doit ressembler à cet exemple. Les clés que vous utilisez pour les choix peuvent être n’importe quelle chaîne.

   export const x_snc_hello_world_to_do = Table({
       name: 'x_snc_hello_world_to_do',
       label: 'To-do Items',
       extends: 'task',
       schema: {
           deadline: DateColumn({ label: 'Deadline' }),
           matrix: StringColumn({
               label: 'Matrix',
               choices: {
                   do: { label: 'Urgent and Important' },
                   decide: { label: 'Important but Not Urgent' },
                   delegate: { label: 'Urgent but Not Important' },
                   delete: { label: 'Neither Urgent nor Important' },
               },
           }),
           task: StringColumn({ label: 'Task', maxLength: 120 }),
       },
   })

10. Dans la ligne 2, ajoutez des importations pour les objets DateColumn et StringColumn .

    import { BusinessRule, ClientScript, Table, DateColumn, StringColumn } from '@servicenow/sdk/core'

11. Mettez à jour les définitions de règle métier et de script client existantes pour référencer la table que vous avez créée.
    1. Dans l’objet ClientScript , remplacez la valeur de la propriété table par le nom de table (x_snc_hello_world_to_do).
    2. Répétez l’étape précédente pour l’objet BusinessRule .
12. Si l’icône de diagnostic ( ) affiche des erreurs ou des avertissements, sélectionnez-la pour ouvrir le panneau Problèmes et passer en revue les messages de diagnostic et les solutions rapides pour les résoudre.
13. Enregistrez vos modifications à l’aide de l’un des raccourcis clavier suivants.
    • Windows : Ctrl-S
    • Mac : Cmd-S

    Remarque :

    Si vous avez des modifications non enregistrées dans un fichier, une icône en forme de point apparaît dans l’onglet Fichier.
14. Dans la barre d’état, sélectionnez Concevoir et installer.

    Si l’installation du se termine avec succès, le code source mis à jour ServiceNow Fluent est compilé dans les fichiers d’application [sys_metadata] sur l’instance.

15. Examinez vos changements en tant que métadonnées.
    1. Dans la barre d’activité, sélectionnez la vue Explorateur de métadonnées ( ).
    2. Sélectionnez votre application pour la développer.
    3. Accédez à la Données > Table et sélectionnez To-do Items (Éléments de tâches).
       La table s’ouvre dans Générateur de tables.

       

16. Facultatif : Modifiez les métadonnées et synchronisez vos changements dans le code source.
    Dans l’explorateur de métadonnées, vous pouvez simuler un autre utilisateur qui modifie les métadonnées en dehors du code source pour voir les modifications transformées en code que vous avez ajouté.
    1. Dans Générateur de tables, recherchez le champ Tâche et remplacez l’étiquette de colonne « Tâche » par « À faire ».
    2. Sélectionnez Enregistrer.
    3. Dans la barre d’activité, sélectionnez la vue SDK Now ( ).
    4. Sélectionnez Synchroniser les changements.

       

       Dans le fichier index.now.ts, vous devriez voir la propriété label de la colonne de tâche changée en « À faire ».

       task: StringColumn({ label: 'To Do', maxLength: 120 }),

Résultats

Vous avez créé vos premières métadonnées d’application à l’aide d’API ServiceNow Fluent . La table Éléments de tâches [x_snc_hello_world_to_do] peut être modifiée dans le code source par d’autres ServiceNow IDE utilisateurs ou à partir d’autres ServiceNow AI Platform interfaces utilisateur.

Dans , ServiceNow AI Platformvous pouvez accéder à la vue de liste de la table en saisissant x_snc_hello_world_to_do.list dans le filtre de navigation. Étant donné que vous avez mis à jour la définition de script client à exécuter sur la table Éléments à faire [x_snc_hello_world_to_do], si vous sélectionnez Nouveau pour ajouter un enregistrement à la table, le message du script client s’affiche lorsque l’enregistrement se charge.

Que faire ensuite

Continuer vers Partie 4 du tutoriel : Installer et utiliser une bibliothèque tierce.