Définir les métadonnées d’application dans le code avec ServiceNow Fluent et ServiceNow SDK

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

    • Définir les métadonnées d’application dans le code avec ServiceNow Fluent et le ServiceNow SDKfichier .

    Avant de commencer

    Rôle requis : administrateur

    Pourquoi et quand exécuter cette tâche

    ServiceNow Fluent est un langage DSL (Domain-Specific Language) 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. Pour en savoir plus sur les API et des exemples, reportez-vous ServiceNow Fluent à la section ServiceNow Fluent Référence d’API.

    Procédure

    1. Dans Visual Studio Code, ouvrez votre répertoire d’applications incluses dans le périmètre.
    2. Dans le répertoire src/fluent , ajoutez un fichier avec l’extension .now.ts .
      Vous pouvez définir les métadonnées d’application dans un seul fichier ou autant .now.ts fichiers que vous le souhaitez et organiser les fichiers dans des répertoires au sein du répertoire Fluent .
      Conseil :
      Dans le répertoire fluent , vous pouvez vous référer à un fichier d’exemple nommé index.now.ts.
    3. Dans le fichier .now.ts , utilisez des objets des ServiceNow Fluent API pour définir les métadonnées dans l’application.
      Par exemple, pour créer une table [sys_db_object] dans l’application, utilisez l’API Table. L’exemple suivant comprend une table simple pour les listes de tâches à l’aide d’un objet Table avec les propriétés et les valeurs nécessaires.
      export const x_snc_example_to_do = Table({
    name: 'x_snc_example_to_do',
    schema: {
        deadline: DateColumn({ label: 'deadline' }),
        state: StringColumn({
            label: 'State',
            choices: {
                ready: { label: 'Ready' },
                completed: { label: 'Completed' },
                in_progress: { label: 'In Progress' },
            },
        }),
        task: StringColumn({ label: 'Task', maxLength: 120 }),
    },
})
      Remarque :
      Vous pouvez utiliser l’API d’enregistrement pour définir les métadonnées d’application qui n’ont pas d’API dédiée.
    4. Ajoutez les importations requises pour les API à partir de @servicenow/sdk/core.
      Par exemple, pour définir une table avec une colonne de date et une colonne de chaîne, importez les objets correspondants à utiliser à partir de l’API Table :
      import { Table, DateColumn, StringColumn } from '@servicenow/sdk/core'
    5. Facultatif : Pour ServiceNow Fluent les API qui utilisent des scripts côté serveur, tels que les règles métier, importez du code à partir de modules JavaScript pour les appeler à partir de la propriété de script d’un objet.
      Cet exemple importe la fonction showStateUpdate , qui peut ensuite être référencée à partir de la propriété de script .
      import { showStateUpdate } from '../server/script.js'
    6. Enregistrez vos changements.

    Définition des métadonnées d’application dans le code source avec ServiceNow Fluent

    Dans les fichiers avec l’extension .now.ts , utilisez des objets dans les ServiceNow Fluent API pour définir les métadonnées dans l’application. Vous devez également inclure les importations requises pour les API à partir de @servicenow/sdk/core.

    L’exemple suivant inclut les définitions d’une table, d’un script client et d’une règle métier dans l’application. La règle métier utilise une fonction du module JavaScript script.js .
    import '@servicenow/sdk/global'
import { BusinessRule } from '@servicenow/sdk/core'
import { ClientScript } from '@servicenow/sdk/core'
import { Table, DateColumn, StringColumn } from '@servicenow/sdk/core'
import { showStateUpdate } from '../server/script.js'

//creates todo table, with three columns (deadline, status and task)
export const x_snc_example_to_do = Table({
    name: 'x_snc_example_to_do',
    schema: {
        deadline: DateColumn({ label: 'deadline' }),
        state: StringColumn({
            label: 'State',
            choices: {
                ready: { label: 'Ready' },
                completed: { label: 'Completed' },
                in_progress: { label: 'In Progress' },
            },
        }),
        task: StringColumn({ label: 'Task', maxLength: 120 }),
    },
})

//creates a client script that pops up 'Table loaded successfully!!' message everytime todo record is loaded
ClientScript({
    $id: Now.ID['cs0'],
    name: 'my_client_script',
    table: 'x_snc_example_to_do',
    active: true,
    applies_extended: false,
    global: true,
    ui_type: 'all',
    description: 'Custom client script generated by Now SDK',
    messages: '',
    isolate_script: false,
    type: 'onLoad',
    script: script`function onLoad() {
        g_form.addInfoMessage("Table loaded successfully!!")
    }`,
})

//creates a business rule that pops up state change message whenever a todo record is updated
BusinessRule({
    $id: Now.ID['br0'],
    action: ['update'],
    table: 'x_snc_example_to_do',
    script: showStateUpdate,
    name: 'LogStateChange',
    order: 100,
    when: 'after',
    active: true,
})

    Une fois l’application générée et déployée, ce code source génère les fichiers de métadonnées d’application suivants sur l’instance.

    Figure 1. Métadonnées d’application générées à partir du ServiceNow Fluent code
    Fichiers d’application générés à partir de l’exemple de code.

    Que faire ensuite

    Créez et déployez votre application pour compiler le code source dans les métadonnées de l’application et rendre vos changements disponibles sur l’instance. Pour en savoir plus, consultez Créez et déployez une application avec l’option ServiceNow SDK.