オブジェクト

Web Verification Station のカスタム スクリプト用オブジェクト モデル。field、データセット、ドキュメント フォームの関数に加え、commandArgs と field プロパティを含みます。

以下の関数は、カスタム スクリプトの作成に使用できます。オブジェクト インスタンスにアクセスするには、commandArgs 変数を使用します。

このセクションのすべての変数はグローバル変数であり、プログラム全体で参照できます。

​

Field パス

一部の関数は、field へのパスを入力パラメーターとして受け取ります。パスは、field 名とその親要素 (field グループ、セクション) の名前で構成されます。テーブル、繰り返しテーブル、および繰り返しグループの場合は、0 (ゼロ) から始まるインスタンス番号を指定します。

たとえば、['Document Section 1', 'Group[10]', 'Field3'] の場合、[10] は繰り返しグループのインスタンス番号です。

​

fields を操作する関数

​

getCurrentField

getCurrentField()

現在のカスタム スクリプトで使用されているfield オブジェクトへのリンクを返します。

​

getFieldByName

getFieldByName(namesPath)

カスタム スクリプトが開かれている field へのリンクを返します。

パラメーター	説明
namesPath	field へのパスを構成する field 名とグループ名を格納した配列、または field オブジェクトへのリンクです。Field paths を参照してください。

​

getFieldValue

getFieldValue(namesPath)

fieldの値を返します。TextField fieldの場合は文字列、Checkmark fieldの場合はチェックマークの値、Checkmark Group fieldの場合は文字列の配列です。

Parameter	説明
namesPath	fieldへのパスを構成するfield名とグループ名の配列、またはfieldオブジェクトへのリンクです。Field pathsを参照してください。

​

setCurrentFieldValue

setCurrentFieldValue(value, forced, onSaved)

カスタム スクリプトが開かれているfieldの値を変更します。

Parameter	説明
value	fieldの値。
forced	オプション。fieldの値を更新し、新しいデータを記録します。false の場合、Document Definition内のfieldの値は save() が呼び出された後にのみ更新されます。true の場合、fieldの値は直ちに更新されます。カスタム スクリプトの場合は、モードに関係なく更新されます。デフォルトは false です。
onSaved	オプション。コールバック関数です。forced が true に設定されている場合に呼び出されます。

​

setFieldValue

setFieldValue(namesPath | field, value, forced, onSaved)

fieldの値を変更します。

Parameter	説明
namesPath	fieldへのパスを構成するfield名とグループ名の配列、またはfield objectへのリンク。 Field pathsを参照してください。
value	対応するfieldの値。
forced	オプション。fieldの値を更新し、新しいデータを記録します。falseの場合、Document Definition内のfieldの値はsave()が呼び出された後にのみ更新されます。trueの場合、fieldの値は直ちに更新されます。カスタム スクリプトの場合は、モードにかかわらず更新されます。デフォルトはfalseです。
onSaved	オプション。コールバック関数。forcedがtrueに設定されている場合に呼び出されます。

​

save

save()

カスタム スクリプトを実行しているウィンドウを閉じ、変更を保存します。

​

cancel

cancel()

変更を保存せずに、カスタム スクリプトの実行ウィンドウを閉じます。

​

データセットを扱うための関数

​

addEntity

addEntity(entityInfo: {cacheName, columns, values}, onResult(newId))

データセットにエントリを追加します。

Parameter	説明
entityInfo.cacheName	データセットの名前。
entityInfo.columns	データを記録する列の名前。stringのarray。
entityInfo.values	対応する列の値。stringのarray。
onResult	データセット内に作成されたrecordのIDを受け取るコールバック関数。

​

editEntity

editEntity(entityInfo: {cacheName, columns, values}, onResult())

データベース内のエントリを編集します。

Parameter	説明
entityInfo.cacheName	データセット の名前。
entityInfo.columns	データを記録する columns の名前。string の array。
entityInfo.values	対応する columns の値。string の array。
onResult	コールバック関数。

​

getDict

getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult(param: {FieldName, FieldValue, BoldMask}[][]))

指定した値またはその一部をデータセット内で検索します。

Parameter	説明
cacheName	データセット名です。
filters	検索パラメーターです。各エントリには、FieldName (field名。すべてのfieldsを検索する場合は空欄にします) とFieldValue (field値) が含まれます。
cursorPos	入力フィールド内のカーソル位置です。値の一部が入力され、カーソルが入力済みの文字の後ろにある場合、その文字列は検索する値のプレフィックスとして扱われます。カーソルが部分的に入力された単語の前にある場合、その文字列は単語の末尾として扱われます。たとえば、会社名を検索する場合、カーソルをADOの後ろに置くとAVOCADOが選択され、ADOの前に置くとADONISが選択されます。
allowMultipleColumnResults	検索で見つかったfieldsの値を返します。データセットには、1つのfield名 (FieldName) が複数のfield値 (FieldValue) に対応するエントリが含まれる場合があります。たとえば、CompanyName列に会社名の複数の表記がある場合です。trueの場合は検索条件を満たすすべてのfield値を返して記録し、falseの場合は最も適合する1件の結果を返して記録します。
onResult	検索結果の配列を返すコールバック関数です。各結果はデータセットの文字列の配列であり、各文字列にはfield名、その値、およびBoldMaskパラメーターが含まれます。

BoldMaskは、見つかった値と同じ長さの0と1からなる文字列です。1は、検索field内の対応する文字と一致する、見つかった値内の文字を示し、0は一致しない文字を示します。

たとえば、データセットにCompanyName: ABBYYが含まれ、ABBの文字を検索した場合、次の内容が返されます。

[
  [
    {
      FieldName: 'CompanyName',
      FieldValue: 'ABBYY',
      BoldMask: '11100'
    },
  ]
]

返される配列には、当初は検索条件に適合しなかったものを含め、複数の値が含まれる場合があります。結果は BoldMask の値の降順で並べ替えられ、検索条件に最もよく一致する文字列から順に表示されます。

​

getDictAll

getDictAll({cacheName, filters: {FieldName, FieldValue}}, }, onResult(param: {FieldName, FieldValue, BoldMask}[][]))

指定した値全体をデータベースで検索します。見つかったすべてのfieldの値を返します。

Parameter	説明
cacheName	データセットの名前。
filters	object array。各エントリには、FieldName (field名。すべてのfieldを検索する場合は空欄にします) とFieldValue (fieldの値) が含まれます。
onResult	検索結果のarrayを返すコールバック関数。各結果はデータセット内のstring (string array) であり、各stringにはfield名、その値、およびBoldMask Parameterが含まれます。

BoldMaskは、見つかった値と同じ長さの0と1で構成されるstringです。1は、検索field内の対応する文字と一致する、見つかった値の文字を示します。0は一致しない文字を示します。

たとえば、データセットにCompanyName: ABBYYが含まれ、文字ABBを検索した場合、次が返されます。

[
  [
    {
      FieldName: 'CompanyName',
      FieldValue: 'ABBYY',
      BoldMask: '11100'
    },
  ]
]

返される配列には、最初は検索条件に合致しなかった値を含め、複数の値が含まれる場合があります。結果は BoldMask 値の降順で並べ替えられ、検索条件に最もよく一致する文字列が先頭になります。

詳細な例については、サンプルデータベース検索スクリプトを参照してください。

​

ドキュメントフォームの操作に使用する関数

​

selectRow

selectRow(tablePath, rowNumber)

テーブルの行を選択状態にします。

Parameter	説明
tablePath	テーブル field へのパスを構成する field 名とグループ名の配列、またはテーブルオブジェクトへのリンク。Field paths を参照してください。
rowNumber	選択する行の番号。ゼロベースです。

​

deselectRow

deselectRow(tablePath, rowNumber?)

テーブルの行の選択を解除します。

Parameter	説明
tablePath	テーブルfieldへのパスを構成するfield名およびグループ名の配列、またはテーブル オブジェクトへのリンク。Field pathsを参照してください。
rowNumber	選択を解除する行の番号 (0始まり) 。省略した場合、テーブル内のすべての行の選択が解除されます。

​

scrollFormToField

scrollFormToField(namesPath)

field が表示される位置までフォームエディターをスクロールします。

Parameter	説明
namesPath	field へのパスを構成する field 名とグループ名の配列、またはテーブル オブジェクトへのリンク。Field パスを参照してください。

​

getDomElementPosition

getDomElementPosition(domId, onResult: (result?: {width, height, top, left, right, bottom}))

フォームエディターウィンドウ内の要素の位置を取得し、その結果をコールバック関数に返します。

Parameter	説明
domId	DOM 形式の要素 ID。
onResult	ブラウザーウィンドウの左上隅を基準とした要素の DOM 座標 (width、height、top、left、right、bottom) を含むオブジェクトを受け取るコールバック関数です。

​

setStyles

setStyles(styles, callback)

カスタムアクションのフレームウィンドウにCSSスタイルを追加します。

Parameter	説明
styles	CSSプロパティ名と値を持つobject (次の例を参照) 。
callback	コールバック関数。

{
  display: 'block',
  position: 'absolute',
  top: '0px',
  bottom: '0px',
  left: '0px',
  right: '0px',
  width: '100%',
  height: '100%',
  border: '0',
  overflow: 'hidden',
  'overflow-x': 'hidden',
  'overflow-y': 'hidden',
  'z-index': '10000'
}

​

commandArgs オブジェクト

​

変数

変数	型	説明
commandArgs.params.document	Document	開いているドキュメントのオブジェクトのコピーを格納します。現在のドキュメントのエラー、field、またはregion にアクセスするために使用します。
commandArgs.params.currentField	(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)	スクリプト呼び出し時点のfieldの状態を反映したfieldオブジェクトへのリンクを返します。上記のドキュメントの一部です。スクリプトの初期化後にfieldの値を変更しても、その変更は適用されません。
commandArgs.params.appPath	String	サーバーのドメイン名です。
commandArgs.params.coordinates	Object [{X1,X2,Y1,Y2}]	カスタム スクリプトを呼び出したDOM要素の座標です。
commandArgs.params.currentElementDomId	String	カスタム スクリプトを呼び出したDOM要素のIDです。

​

イベント

関数	説明
commandArgs.events.addEventHandler	カスタム スクリプトのグローバル コンテキストにイベント ハンドラーを追加します。
commandArgs.events.triggerHandlers	カスタム スクリプトのグローバル コンテキストでイベントを発生させます。
commandArgs.events.removeEventHandler	カスタム スクリプトのグローバル コンテキストからイベント ハンドラーを削除します。

​

Field オブジェクトの型

カスタム スクリプトからは、次の field オブジェクトの型および Document オブジェクトにアクセスできます。すべての field オブジェクトは、Regions プロパティを介して Region オブジェクトを公開します。

​

Field Group field

プロパティ	型	アクセス	説明
Fields	(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)[]	読み取り専用	field の配列。
HasTableLayout	Boolean	読み取り専用	field region がテーブルであるかどうかを指定します。
Caption	String	読み取り専用	カスタム field 名 (キャプション) 。
FieldType	Number	読み取り専用	field タイプ。値: 4 (field グループ) 。
Id	Number	読み取り専用	field ID。
IsReadOnly	Boolean	読み取り専用	fields の編集を禁止するかどうかを指定します。
IsVisible	Boolean	読み取り専用	field をデータ フォームに表示するかどうかを指定します。
MaxRegions	Number	読み取り専用	field regions の最大数。値が -1 の場合、任意の数の region を指定できます。
Name	String	読み取り専用	field の内部名。
NamePath	String[]	読み取り専用	field へのパスを構成する field 名およびグループ名の配列。
NeedRecognize	Boolean	読み取り/書き込み	ルールの再チェック時に region から field 値を取得するかどうかを指定します。
Regions	Region[]	読み取り専用	field の regions。Region オブジェクトを参照してください。

​

Section field

プロパティ	型	アクセス	説明
Fields	(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)[]	読み取り専用	field の配列。
Pageids	Number[]	読み取り専用	セクションが存在するページの識別子。
IsFlexible	Boolean	読み取り専用	セクションが flexible かどうかを指定します。
Caption	String	読み取り専用	カスタム field 名 (キャプション) 。
FieldType	Number	読み取り専用	field タイプ。値：6 (section) 。
Id	Number	読み取り専用	field ID。
IsReadOnly	Boolean	読み取り専用	field の編集を禁止するかどうかを指定します。
IsVisible	Boolean	読み取り専用	データ フォームに field を表示するかどうかを指定します。
MaxRegions	Number	読み取り専用	field region の最大数。値が -1 の場合、region の数に制限はありません。
Name	String	読み取り専用	field の内部名。
NamePath	String[]	読み取り専用	field へのパスを構成する field 名とグループ名の配列。
NeedRecognize	Boolean	読み取り/書き込み	ルールを再チェックする際に、region から field 値を取得するかどうかを指定します。
Regions	Region[]	読み取り専用	field の region。Region オブジェクトを参照してください。

​

テーブルフィールド

プロパティ	型	アクセス	説明
Rows	Row[]	読み取り専用	テーブルの行の List。Row オブジェクト を参照してください。
Caption	String	読み取り専用	カスタム field 名 (キャプション) 。
FieldType	Number	読み取り専用	field タイプ。値: 7 (テーブル) 。
Id	Number	読み取り専用	Field ID。
IsReadOnly	Boolean	読み取り専用	field を編集できないかどうかを指定します。
IsVisible	Boolean	読み取り専用	field がデータ フォームに表示されるかどうかを指定します。
MaxRegions	Number	読み取り専用	-1 の場合、任意の数の region を指定できます。
Name	String	読み取り専用	field の内部名。
NamePath	String[]	読み取り専用	field へのパスを構成する field 名とグループ名の配列。
NeedRecognize	Boolean	読み取り/書き込み	ルールを再チェックするときに、region から field 値を取得するかどうかを指定します。
Regions	Region[]	読み取り専用	field の region。Region object を参照してください。

​

Row オブジェクト

プロパティ	型	説明
Id	number	行の ID。
RowNumber	number	0 から始まる行の連番。
HasColorImage	boolean	行の画像がカラーかどうかを指定します。
TableBlockID	number[]	テーブルブロックへのパスを構成するセクション、テーブル、テーブルブロックの識別子。
Cells	(Picture | Checkmark | CheckmarkGroup | TextField)[]	テーブルのセル内の field。

​

テキスト入力 field

Property	型	アクセス	説明
Flags	Number[]	読み取り/書き込み	field Value と同じ長さで、0 と 1 からなる配列です。Flags 内の 0 と同じ位置にある Value の文字は検証が必要です。
Suggests	String[]	読み取り専用	推奨される field 値の List。
Value	String	読み取り/書き込み	Field 値。
TextType	Number	読み取り専用	Text field の型。TextType 値を参照してください。
Caption	String	読み取り専用	カスタム field 名 (キャプション) 。
FieldType	Number	読み取り専用	field タイプ。値: 0 (テキスト field) 。
Id	Number	読み取り専用	Field ID。
IsReadOnly	Boolean	読み取り専用	field の編集が禁止されているかどうかを指定します。
IsVisible	Boolean	読み取り専用	field がデータ フォームに表示されるかどうかを指定します。
MaxRegions	Number	読み取り専用	field regions の最大数。値が -1 の場合、任意の数の region を指定できます。
Name	String	読み取り専用	field の内部名。
NamePath	String[]	読み取り専用	field へのパスを構成する field 名およびグループ名の配列。
NeedRecognize	Boolean	読み取り/書き込み	ルールを再チェックする際に、region から field 値を取得するかどうかを指定します。
Regions	Region[]	読み取り専用	field の region。Region オブジェクトを参照してください。
IsVerified	Boolean	読み取り/書き込み	field が検証済みかどうかを指定します。
NeedVerification	Boolean	読み取り専用	field に検証が必要かどうかを指定します。
NeedDoubleVerification	Boolean	読み取り専用	field に二重検証が必要かどうかを指定します。
IsSummary	Boolean	読み取り専用	field がデータ フォームのデータ概要で使用されるかどうかを指定します。

​

TextType の値

値	意味
0	Text field
1	数値フィールド
2	通貨金額フィールド
3	DateTime フィールド
4	日付フィールド
5	時刻フィールド
6	コードフィールド

​

チェックマーク field

プロパティ	型	アクセス	説明
Value	Boolean	読み取り/書き込み	Field の値。
Caption	String	読み取り専用	カスタム field 名 (キャプション) 。
FieldType	Number	読み取り専用	field タイプ。値: 2 (チェックマーク) 。
Id	Number	読み取り専用	Field ID。
IsReadOnly	Boolean	読み取り専用	field を編集できないかどうかを指定します。
IsVisible	Boolean	読み取り専用	field がデータ フォームに表示されるかどうかを指定します。
MaxRegions	Number	読み取り専用	field region の最大数。値が -1 の場合、region 数に制限はありません。
Name	String	読み取り専用	field の内部名。
NamePath	String[]	読み取り専用	field へのパスを構成する field 名およびグループ名の配列。
NeedRecognize	Boolean	読み取り/書き込み	ルールの再チェック時に、region から field 値を取得するかどうかを指定します。
Regions	Region[]	読み取り専用	field の region。Region オブジェクトを参照してください。
IsVerified	Boolean	読み取り/書き込み	field が検証済みかどうかを指定します。
NeedVerification	Boolean	読み取り専用	field の検証が必要かどうかを指定します。
NeedDoubleVerification	Boolean	読み取り専用	field の二重検証が必要かどうかを指定します。
IsSummary	Boolean	読み取り専用	field がデータ フォームのデータ サマリーで使用されるかどうかを指定します。

​

チェックマークグループfield

Property	型	アクセス	説明
MaxSelectedCount	Number	読み取り専用	選択可能なfield 値の最大数。
MinSelectedCount	Number	読み取り専用	選択可能なfield 値の最小数。
Values	Number[]	読み取り/書き込み	Field 値。候補となるfield 値のリスト (Variants) を構成するrecord ID の配列。
Variants	{Id: number, Name: string}[]	読み取り専用	候補となるfield 値のList。各候補には、Id (record ID) と Name (record 名) が含まれます。
Caption	String	読み取り専用	カスタム field 名 (キャプション) 。
FieldType	Number	読み取り専用	field タイプ。値: 3 (チェックマークグループ) 。
Id	Number	読み取り専用	Field ID。
IsReadOnly	Boolean	読み取り専用	field を編集できないかどうかを指定します。
IsVisible	Boolean	読み取り専用	field をデータ フォームに表示するかどうかを指定します。
MaxRegions	Number	読み取り専用	field region の最大数。値が -1 の場合、region の数に制限はありません。
Name	String	読み取り専用	field の内部名。
NamePath	String[]	読み取り専用	field へのパスを構成するfield 名とGroup 名の配列。
NeedRecognize	Boolean	読み取り/書き込み	Rules を再確認する際に、region からfield 値を取得するかどうかを指定します。
Regions	Region[]	読み取り専用	field のregion。Region オブジェクトを参照してください。
IsVerified	Boolean	読み取り/書き込み	field が検証済みかどうかを指定します。
NeedVerification	Boolean	読み取り専用	field にVerification が必要かどうかを指定します。
NeedDoubleVerification	Boolean	読み取り専用	field にdouble verification が必要かどうかを指定します。
IsSummary	Boolean	読み取り専用	field をデータ フォームのデータ概要に使用するかどうかを指定します。

​

画像 field

プロパティ	型	アクセス	説明
Caption	String	読み取り専用	カスタム field 名、キャプション。
FieldType	Number	読み取り専用	field タイプ。値：1 (画像) 。
Id	Number	読み取り専用	field ID。
IsReadOnly	Boolean	読み取り専用	field の編集が禁止されているかどうかを指定します。
IsVisible	Boolean	読み取り専用	field がデータ フォームに表示されるかどうかを指定します。
MaxRegions	Number	読み取り専用	field region の最大数。値が -1 の場合、region 数に制限はありません。
Name	String	読み取り専用	field の内部名。
NamePath	String[]	読み取り専用	field へのパスを構成する field 名とグループ名の配列。
Regions	Region[]	読み取り専用	field の region。Region オブジェクトを参照してください。

​

セクションの繰り返しグループ field

Property	型	アクセス	説明
Id	Number	読み取り専用	Field ID。
Name	String	読み取り専用	field 名。
Sections	Section[]	読み取り専用	Section field 型の field の配列。
FieldType	Number	読み取り専用	field タイプ。値：8 (繰り返しセクショングループ) 。

​

Region オブジェクト

各fieldオブジェクトのRegionsプロパティは、以下の構造を持つregionのarrayを返します。

プロパティ	型	説明
Id	number	Region ID。
Status	number	regionのステータス：0 regionは重ね合わせられていない (または削除されている) 、1 regionは認識されていない、2 regionの値がfieldに代入されている。
PageId	Number	regionが存在するページのID。
IsNew	Boolean	新しいregionを示すFlag。
Coordinates	Object [{X1,X2,Y1,Y2}]	画像内のregionの座標。

​

Document オブジェクト

Document オブジェクトは commandArgs.params.document を介して利用できます。

プロパティ	型	アクセス	説明
AssemblingErrors	AssemblingError[]	読み取り専用	ドキュメントのアセンブリ エラー。Assembly error object を参照してください。
BatchId	Number	読み取り専用	パッケージ ID。
Errors	Error[]	読み取り専用	ドキュメントのエラー。Error object を参照してください。
Fields	(Section | SectionsGroup)[]	読み取り専用	セクションおよび重複セクションのリスト。
Id	Number	読み取り専用	文書識別子。
Index	Number	読み取り専用	パッケージ内のドキュメントのインデックス。
Pages	Page[]	読み取り専用	文書ページのリスト。Page object を参照してください。
ProjectId	Number	読み取り専用	Project 識別子。
TaskId	Number	読み取り専用	タスクID。
TemplateId	Number	読み取り専用	ドキュメントの定義 ID。
TemplateName	String	読み取り専用	ドキュメント Definition の名前。
TemplateVersion	Number	読み取り専用	ドキュメントの定義バージョン。
Version	Number	読み取り専用	ドキュメントのバージョン。

​

アセンブリ エラー object

Property	型	説明
DocumentNodeRef	number[][]	フォーム内の field へのリンクのリスト。field ID の配列として表されます。
Description	string	エラーの説明。
SectionName	string[]	エラーに関係する sections のリスト。

​

Error オブジェクト

プロパティ	型	説明
DocumentNodeRef	number[][]	フォーム内の field へのリンクのリスト。field ID の配列として表されます。
Severity	number	1 はエラー、0 は警告。
Message	string	エラーテキスト。
RuleName	string	エラーの原因となった rule の名前。

​

Page オブジェクト

プロパティ	型	説明
Id	number	ページ ID。
Modification	number	ページのリビジョン番号。
HasColorImage	boolean	ページがカラーかどうかを指定します。
ImageResolution	number	画像解像度。
KeyValue	string	キー field のページ値。
SectionTemplateId	number	ページのセクション ID。
SectionTemplateName	string	ページのセクション名。
FlexibleInstanceId	number	flexible インスタンスの ID。
SectionTemplatePageNumber	number	セクション内のページ番号。
Comment	string	ページのレビュー。
ImageWidth	number	ページ画像の幅。
ImageHeight	number	ページ画像の高さ。