ビジネスルール API - ServiceNow Fluent

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:7分
  • ビジネスルール API には、レコードが表示、挿入、更新、または削除されるとき、またはテーブルがクエリされるときに実行されるサーバー側スクリプト [sys_script] を定義するオブジェクトが含まれます。

    BusinessRule オブジェクト

    特定のサーバー側条件が満たされたときにフォームフィールドの値を自動的に変更するビジネスルール [sys_script] を作成します。

    表 : 1. プロパティ
    名前 タイプ 説明
    $id 文字列または数値 必須。次の形式で提供されるメタデータオブジェクトの一意の ID。ここで、<value> は文字列または数値です。
    $id: Now.ID[<value>]

    アプリケーションをビルドすると、この ID は一意の sys_ID にハッシュされます。

    name 文字列 必須。ビジネスルールの名前。
    table 文字列 必須。ビジネスルールが実行されるテーブルの名前。
    order 整数 このビジネスルールを実行する順序を示す番号。特定のアクティビティに複数のルールがある場合、ルールは指定された順序 (昇順) で実行されます。

    デフォルト:100

    script スクリプト script タグが前に付いた関数またはインラインスクリプト。カスタムスクリプトは、定義された条件が true の場合に実行されます。

    関数には、JavaScript モジュールからエクスポートされて .now.ts ファイルにインポートされた関数、関数式、またはデフォルト関数の名前を使用します。JavaScript モジュールの詳細については、「JavaScript モジュールとサードパーティライブラリ」を参照してください。

    インラインスクリプトは、script タグを次の形式で使用します。
    script: script`gs.info('info')`,
    when 文字列 このビジネスルールを実行するタイミング。ビジネスルールを実行するタイミングの詳細については、「ビジネスルールの仕組み」を参照してください。

    有効な値:before、after、async、display

    デフォルト:before

    action アレイ ビジネスルールが適用されるレコードオプション。ビジネスルールアクションの詳細については、「ビジネスルールの仕組み」を参照してください。

    有効な値:insert、update、delete、query

    active ブーリアン ビジネスルールを使用するかどうかを示すフラグ。
    有効な値:
    • true:ビジネスルールが適用されます。
    • false:ビジネスルールは適用されません。

    デフォルト:true

    add_message ブーリアン ビジネスルールの実行時に表示されるメッセージを追加するかどうかを示すフラグ。
    有効な値:
    • true:メッセージを表示します。
    • false:メッセージを表示しません。

    デフォルト値:false

    abort_action ブーリアン 現在のデータベーストランザクションを中止するかどうかを示すフラグ。たとえば、挿入前のビジネスルールで、条件が満たされている場合は、レコードをデータベースに挿入しません。
    有効な値:
    • false:現在のデータベーストランザクションを中止しません。
    • true:現在のデータベーストランザクションを中止します。フィールド値の設定やスクリプトの実行など、レコードに対して追加のアクションを実行することはできません。add_message プロパティと message プロパティを使用して、ユーザーにメッセージを表示することはできます。

    デフォルト値:false

    message 文字列 ビジネスルールの実行時に表示されるメッセージ。
    role_conditions アレイ テーブル内のレコードを変更するユーザーが、このビジネスルールを実行するために保持している必要がある Role オブジェクトの変数識別子のリスト。詳細については、「ロール API - ServiceNow Fluent」を参照してください。
    condition 文字列 ビジネスルールを実行するために true でなければならないフィールドと値を指定する JavaScript 条件ステートメント。条件ステートメントを filter_condition または script プロパティに含める場合は、このプロパティを使用しないでください。

    このプロパティに条件ステートメントを追加することで、条件を個別に評価し、条件が true の場合にのみビジネスルールを実行するようシステムに指示します。非同期ビジネスルールを実行する前にインスタンスで条件ステートメントを再評価するには、システムプロパティ glide.businessrule.async_condition_check を追加し、値を true に設定します。

    filter_condition 文字列 ビジネスルールを実行するために true でなければならないフィールドと値を指定するフィルタークエリ。詳細については、「Operators available for filters and queries」を参照してください。
    set_field_value 文字列 テーブルのフィールドを設定する値。これは、set_field_value: 'sec_created=false^EQ' などのエンコードされたクエリとして指定できます。
    description 文字列 ビジネスルールの実行内容の説明。
    import { BusinessRule } from '@servicenow/sdk/core'
    import { FunctionExport, FunctionExpression } from '../server/scripts.js'
    import DefaultExportFunction from '../server/scripts.js'
    
    const BR1 = BusinessRule({
        name: 'exportedFunction',
        table: 'x_snc_table',
        when: 'after',
        action: ['update', 'delete', 'insert'],
        script: FunctionExport,
        order: 100,
        active: true,
        add_message: false,
        message: '<p>message</p>',
        abort_action: false,
        $id: Now.ID[0],
    })
    
    const BR2 = BusinessRule({
        name: 'businessrule2',
        table: 'x_snc_table',
        script: FunctionExpression,
        when: 'after',
        action: ['update'],
        $id: Now.ID[1],
    })
    
    const BR3 = BusinessRule({
        name: 'businessrule3',
        table: 'x_snc_table',
        script: DefaultExportFunction,
        when: 'after',
        action: ['update'],
        filter_condition: `sys_updated_onSTARTSWITHb^sys_updated_bySTARTSWITHm^EQ
        <item goto="false" or="false" field="sys_updated_on" endquery="false" value="b" operator="STARTSWITH" newquery="false"/>
        <item goto="false" or="false" field="sys_updated_by" endquery="false" value="m" operator="STARTSWITH" newquery="false"/>
        <item goto="false" or="false" field="" endquery="true" value="" operator="=" newquery="false"/>`,
        $id: Now.ID[2],
    })
    
    const BR4 = BusinessRule({
        name: 'templateBR',
        action: ['insert'],
        when: 'after',
        table: 'x_snc_table',
        role_conditions: [admin],
        order: 100,
        active: true,
        add_message: true,
        message: '<p>message</p>',
        script: script`gs.info('info')`,
        abort_action: false,
        $id: Now.ID[3],
    })