プロパティ
| Name | Type | Access Level | Description |
|---|---|---|---|
| CheckSucceeded | bool | 読み取り/書き込み | ルール条件が満たされているかを示します。既定値は true です。条件が満たされていない場合は、スクリプトで false に設定してください。その場合、オペレーターには既定のエラーメッセージ「Error in the rule <rule_name>: <field_name>」が表示されます。別のメッセージを表示したい場合は、ErrorMessage プロパティで設定します。重要: エラーが生成されるのは CheckSucceeded が false に設定されている場合のみです。スクリプトで CheckSucceeded を false に変更しない限り、条件を満たしていなくてもエラーメッセージは表示されません。 |
| CurrentField | Field | 読み取り専用 | ルールで検証される field。反復ルールで反復 field を検証する場合は、現在の呼び出しで検証中の該当インスタンスを指します。ルールが文書全体を参照する場合は、null を返します。 |
| Document | Document | 読み取り専用 | ルールが実行されるドキュメント。 |
| ErrorMessage | string | 読み取り/書き込み | スクリプトが CheckSucceeded を false に設定した場合に表示されるユーザー定義メッセージ。設定しない場合、エラー時に表示されるメッセージは「Error in the rule <rule_name>: <field_name>」になります。 |
| Transaction | Transaction | 読み取り専用 | 現在のトランザクション。 |
メソッド
| 名前 | 説明 |
|---|---|
| Field GetField(string fieldName); | 名前または識別子で Field を取得します。重要: このメソッドには Field の文字列名を直接渡してください。同じ文字列値を持つ変数は機能しません。実行前にスクリプトを解析するプリプロセッサは、Field の名前をその識別子に置き換えますが、変数は処理できません。Field グループ内の Field にアクセスする場合は、BusinessUnit/Address のようにフルパスを使用してください。繰り返しルールで使用した場合、このメソッドは処理された各 Field インスタンスを順に返します。そうでない場合、参照された繰り返し Field の最初のインスタンスを返します。 |
| Field[] GetFields(string fieldName); | 指定された名前を持つ Field の一覧を返します。このメソッドは、テーブル列内のすべてのセルを含め、繰り返し Field の全インスタンスを取得するために使用できます。ループ利用時に繰り返し Field へアクセスしやすくなります。重要: このメソッドには Field の文字列名を直接渡してください。同じ文字列値を持つ変数は機能しません。実行前にスクリプトを解析するプリプロセッサは、Field の名前をその識別子に置き換えますが、変数は処理できません。 |
| Record GetCatalogRecord(string catalogId, string externalId); | カタログ（外部データベース）から Record を取得します。カタログから情報を取得し、ドキュメント内の Field 値とカタログ内の Field 値を比較するために使用します。カタログ名（catalogId）とカタログレコード識別子（externalId）を引数として渡します。このメソッドは、カタログ側で適切な識別子（例: ベンダー識別子）が設定されている場合にのみ使用できます。 |
| SkillParameter SkillParameter(string ParameterName); | Skill の Parameter から値を取得します。このメソッドは、Document skill に少なくとも 1 つの Parameter がある場合にのみ使用できます。 |