メタデータ API 開発者ガイド
jOcrTemplate
インテリジェントフォームリーダーを使用してフォームと Salesforce オブジェクトの対応付けの詳細を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
OcrTemplate コンポーネントのサフィックスは .ocrTemplate で、ocrTemplates フォルダに保存されます。
バージョン
OcrTemplate コンポーネントは、API バージョン 52.0 以降で使用できます。
特別なアクセスルール
このメタデータ型を使用するには、Salesforce 組織で AWSTextract1000LimitAddOn ライセンスが必要です。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| active | boolean | OCR テンプレートが有効か (true)、否か (false) を示します。 |
| description | string | OCR テンプレートの説明。 |
| documentType | string | 必須。このテンプレートが対応付けを定義する文書型。 |
| masterLabel | string | 必須。OCR テンプレートのラベル。 |
| ocrTargetObjects | OcrTargetObject[] | フォームの情報を抽出して対応付けるオブジェクトの詳細を表します。 |
| ocrTemplateSampleDocuments | OcrTemplateSampleDocument[] | 顧客のフォームの情報を抽出する場合や対応付ける場合に、参照情報として使用するサンプルのドキュメントまたは文書型の詳細を表します。 |
| pageCount | integer | 情報を抽出したフォームのページ数。 |
| templateName | string | 必須。OCR テンプレートの名前。 |
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| ocrTargetObjectFieldMappings | OcrTargetObjFieldMapping[] | フォーム項目の情報をオブジェクトの項目に対応付ける方法についての詳細を表します。 |
| targetObject | string | 必須。フォームの情報を対応付けるオブジェクト。 |
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| ocrSampleDocField | OcrSampleDocumentField[] | 必須。値が抽出されて Salesforce オブジェクトの項目に対応付けられるフォームの項目の詳細。 |
| targetField | string | 必須。情報を対応付ける項目。 |
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| fieldLabelMaxX | double | キーの境界ボックスの右端を表す正規化された座標。 |
| fieldLabelMaxY | double | キーの境界ボックスの下端を表す正規化された座標。 |
| fieldLabelMinX | double | キーの境界ボックスの左端を表す正規化された座標。 |
| fieldLabelMinY | double | キーの境界ボックスの上端を表す正規化された座標。 |
| keyContent | string | 必須。フォームの特定の領域にあるコンテンツ。OCR によって抽出された項目を表します。 |
| ocrSampleDocument | string | 必須。顧���フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメント。 |
| ocrSampleDocumentPage | string | OCR サンプルドキュメントのページを定義する項目のコレクション。 |
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| ocrSampleDocument | string | 顧客フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメント。 |
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。