ServiceNow IDEServiceNow Fluent を使用してコードでアプリケーションメタデータを定義する

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:7分
  • コードでアプリケーションメタデータを定義するServiceNow FluentServiceNow IDE で使用します。

    始める前に

    アプリケーションを作成、変換、またはクローンして、ワークスペースに追加します。詳細については、「ServiceNow IDEでのアプリケーションの追加」を参照してください。

    必要なロール:admin

    このタスクについて

    ServiceNow Fluent は、アプリケーションを構成するメタデータファイル [sys_metadata] を定義するための TypeScript に基づくドメイン固有言語 (DSL) であり、テーブル、ロール、ACL、ビジネスルール、自動テストフレームワーク (ATF) テストなど、さまざまなタイプのメタデータの API が含まれています。 ServiceNow Fluent API と例の詳細については、「ServiceNow Fluent API リファレンス」を参照してください。 ServiceNow IDE には、ServiceNow Fluent API とアプリケーションの言語処理と検証がデフォルトで含まれています。

    手順

    1. 移動先 すべて > アプリ開発 > ServiceNow IDE.
    2. アプリケーションでワークスペースを開きます。
    3. アクティビティバーから、[ファイルエクスプローラー] ビュー(ファイルエクスプローラー) を選択します。
    4. src/fluent ディレクトリに、拡張子が .now.ts のファイルを追加します。
      アプリケーションメタデータは、1 つのファイルまたは任意の数の .now.ts ファイルで定義し、fluent ディレクトリ内のディレクトリにファイルを整理できます。
      ヒント:
      fluent ディレクトリでは、index.now.ts という名前のサンプルファイルを参照できます。
    5. .now.ts ファイルで、ServiceNow Fluent API のオブジェクトを使用して、アプリケーションのメタデータを定義します。
      たとえば、アプリケーションでテーブル [sys_db_object] を作成するには、テーブル API を使用します。次の例では、必要なプロパティと値を持つ Table オブジェクトを使用して、To Do リスト用のシンプルなテーブルを作成しています。
      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' },
                      inProgress: { label: 'In Progress' },
                  },
              }),
              task: StringColumn({ label: 'Task', maxLength: 120 }),
          },
      })
      注:
      レコード API を使用して、専用 API を持たないアプリケーションメタデータを定義できます。
    6. @servicenow/sdk/core から API に必要なインポートを追加します。
      たとえば、日付列と文字列列を持つテーブルを定義するには、使用する対応するオブジェクトをテーブル API からインポートします。
      import { Table, DateColumn, StringColumn } from '@servicenow/sdk/core'
    7. オプション: ビジネスルールなどのサーバー側スクリプトを使用する ServiceNow Fluent API の場合は、JavaScript モジュールからコードをインポートして、オブジェクトのスクリプトプロパティから呼び出します。
      この例では、スクリプトプロパティから参照できる showStateUpdate 関数をインポートします。
      import { showStateUpdate } from '../server/script.js'
    8. 変更内容を保存します。
    9. オプション: アプリケーションしてインストールし、ソースコードをアプリケーションメタデータにコンパイルして、変更をインスタンス全体で使用できるようにします。詳細については、「とインストール ServiceNow IDEでのアプリケーションのビルド」を参照してください。
    ヒント:
    コードコメントで次のディレクティブを使用して、コードを管理できます。
    • @fluent-ignore:次のコード行の ServiceNow Fluent 診断警告とエラーを抑制します。
    • @fluent-disable-syncServiceNow Fluent オブジェクトへの変更の同期をオフにします。呼び出し式の前 (たとえば、Record({ ... })) を使用して、そのオブジェクトと子オブジェクトの同期をオフにします。このディレクティブは、ソースコードの外部でオブジェクトに加えられた変更を無視し、同期時に更新しない場合にのみ使用します。
    • @fluent-disable-sync-for-fileServiceNow Fluent ファイル (.now.ts) への変更の同期をオフにします。ファイル内のすべてのコードの同期をオフにするには、ファイルの最初の行で使用します。このディレクティブは、ソースコードの外部でファイルに加えられた変更を無視し、同期時に更新しない場合にのみ使用します。

    ServiceNow Fluent を使用してソースコードでアプリケーションメタデータを定義する

    拡張子が .now.ts のファイルで、ServiceNow Fluent API のオブジェクトを使用して、アプリケーションのメタデータを定義します。また、@servicenow/sdk/core からの API に、必要なインポートも含める必要があります。BusinessRule オブジェクトなどのサーバー側スクリプトを持つオブジェクトの場合は、JavaScript モジュールからコードをインポートして使用できます。

    次の例には、アプリケーションのテーブル、クライアントスクリプト、およびビジネスルールの定義が含まれています。クライアントスクリプトは、client-script.jsファイルのスクリプトを使用します。ビジネスルールは、script.js JavaScript モジュールの関数を使用します。
    import '@servicenow/sdk/global'
    import { BusinessRule, ClientScript, DateColumn, StringColumn, Table } 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' },
                    inProgress: { 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,
        appliesExtended: false,
        global: true,
        uiType: 'all',
        description: 'Custom client script generated by Now SDK',
        isolateScript: false,
        type: 'onLoad',
        script: Now.include('../client/client-script.js'),
    })
    
    //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,
    })

    アプリケーションのビルド後、このソースコードはインスタンスで次のアプリケーションメタデータファイルを生成します。

    図 : 1. ServiceNow Fluent コードから生成されたアプリケーションメタデータ
    コード例から生成されたアプリケーションファイル。