Context はグローバルオブジェクトで、処理中のDocument、その fields、および属するトランザクションのパラメーターにアクセスできます。ルールが成功したかどうかを示すには、CheckSucceeded を設定します。
使用法
Context を通じて field を読み取り、内容を確認したうえで、CheckSucceeded と ErrorMessage を設定して結果を報告します。たとえば、Total field が存在しない、または空の場合は、カスタムメッセージを設定してルールを失敗させます。
プロパティ
CheckSucceeded
bool — Access: 読み取り/書き込み
ルールの条件が満たされているかどうかを示します。既定値は true です。条件が満たされていない場合は、false に設定します。この場合、オペレーターに表示される既定のエラーメッセージは Error in the rule <rule_name>: <field_name> です。メッセージをカスタマイズするには、ErrorMessage プロパティを設定します。
エラーが生成されるのは、スクリプトで
CheckSucceeded を false に設定した場合のみです。スクリプトでこれを明示的に設定しない限り、ルールの条件が満たされていなくてもエラーは表示されません。CurrentField
null を返します。
Document
ErrorMessage
string — Access: 読み取り/書き込み
スクリプトで CheckSucceeded を false に設定したときに表示されるカスタムメッセージです。設定されていない場合、既定のメッセージは Error in the rule <rule_name>: <field_name> です。
Transaction
メソッド
スクリプトは、ルールの設定時に読み取り用として一覧に含まれている fields のみを読み取り、編集可能として一覧に含まれている fields にのみ書き込むことができます。その他の field を参照すると、アクセス エラー (
Attempt to read data from inaccessible field または Attempt to write data to read-only field) が発生し、ルールは失敗します。ビジネス ルールの自動化を参照してください。GetField
Fieldを取得します。その名前のfieldが存在しない場合は null を返します。
グループ内のfieldを指定するには、フルパスを使用します。たとえば、BusinessUnit/Address です。
繰り返しルールで使用すると、GetField は処理済みの各fieldインスタンスを順番に返します。そうでない場合は、繰り返しfieldの最初のインスタンスを返します。
GetFields
Fieldオブジェクトを返します。これは、テーブルの列内のすべてのセルを含め、繰り返しfieldの各インスタンスを反復処理する場合に便利です。その名前のfieldが存在しない場合はnullを返します。
GetCatalogRecord
Record をデータ カタログ (外部データベース) から取得します。このメソッドを使用して、ドキュメントのfield値をカタログのfield値と比較します。
カタログにレコード識別子 (たとえば、ベンダー識別子) が設定されている場合にのみ利用できます。
SkillParameter
SkillParameter を取得します。値は、返されたオブジェクトの Value プロパティから読み取ります。たとえば、Context.SkillParameter("Threshold").Value です。
Document skill に少なくとも 1 つの Parameter がある場合にのみ使用できます。
オブジェクト モデル
Advanced Script Rules で使用するための完全な JavaScript オブジェクト リファレンス。
ビジネス ルールの自動化
Document skill にスクリプト ルールを追加し、読み取り可能および書き込み可能な fields を設定して、テーブル列を参照します。
Field
Field object — ルールの実行中にDocument の field を確認・変更します。
サンプルスクリプト
一般的な Advanced Script Rule シナリオ向けの実用的な JavaScript サンプル。
