ServiceNow IDE の ServiceNow Fluent を使用してコードでアプリケーションメタデータを定義する
コードでアプリケーションメタデータを定義するServiceNow Fluent を ServiceNow IDE で使用します。
始める前に
アプリケーションを作成、変換、またはクローンして、ワークスペースに追加します。詳細については、「ServiceNow IDEでのアプリケーションの追加」を参照してください。
必要なロール:admin
このタスクについて
ServiceNow Fluent は、アプリケーションを構成するメタデータファイル [sys_metadata] を定義するための TypeScript に基づくドメイン固有言語 (DSL) であり、テーブル、ロール、ACL、ビジネスルール、自動テストフレームワーク (ATF) テストなど、さまざまなタイプのメタデータの API が含まれています。 ServiceNow Fluent API と例の詳細については、「ServiceNow Fluent API リファレンス」を参照してください。 ServiceNow IDE には、ServiceNow Fluent API とアプリケーションの言語処理と検証がデフォルトで含まれています。
手順
@fluent-ignore:次のコード行の ServiceNow Fluent 診断警告とエラーを抑制します。@fluent-disable-sync:ServiceNow Fluent オブジェクトへの変更の同期をオフにします。呼び出し式の前 (たとえば、Record({ ... })) を使用して、そのオブジェクトと子オブジェクトの同期をオフにします。このディレクティブは、ソースコードの外部でオブジェクトに加えられた変更を無視し、同期時に更新しない場合にのみ使用します。@fluent-disable-sync-for-file:ServiceNow Fluent ファイル (.now.ts) への変更の同期をオフにします。ファイル内のすべてのコードの同期をオフにするには、ファイルの最初の行で使用します。このディレクティブは、ソースコードの外部でファイルに加えられた変更を無視し、同期時に更新しない場合にのみ使用します。
ServiceNow Fluent を使用してソースコードでアプリケーションメタデータを定義する
拡張子が .now.ts のファイルで、ServiceNow Fluent API のオブジェクトを使用して、アプリケーションのメタデータを定義します。また、@servicenow/sdk/core からの API に、必要なインポートも含める必要があります。BusinessRule オブジェクトなどのサーバー側スクリプトを持つオブジェクトの場合は、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,
})アプリケーションのビルド後、このソースコードはインスタンスで次のアプリケーションメタデータファイルを生成します。