OcrTemplate | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

ファイルのサフィックスおよびディレクトリの場所

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 テンプレートの名前。

OcrTargetObject

フォームの情報を抽出して対応付けるオブジェクトの詳細を表します。

表 1. 項目
項目名	項目の型	説明
ocrTargetObjectFieldMappings	OcrTargetObjFieldMapping[]	フォーム項目の情報をオブジェクトの項目に対応付ける方法についての詳細を表します。
targetObject	string	必須。フォームの情報を対応付けるオブジェクト。
targetObjectRecordType	string	対象オブジェクトのレコードタイプの API 参照名。API バージョン 56.0 以降で利用できます。

OcrTargetObjFieldMapping

フォーム項目の情報をオブジェクトの項目に対応付ける方法についての詳細を表します。

表 2. 項目
項目名	項目の型	説明
ocrSampleDocField	OcrSampleDocumentField[]	値が抽出されて Salesforce オブジェクトの項目に対応付けられるフォームの項目の詳細。
targetField	string	必須。情報を対応付ける項目。
type	OcrMappingType (string 型の列挙)	必須。対応付けの種別を指定します。API バージョン 56.0 以降で利用できます。有効な値は、次のとおりです。 `FormField` `TableColumn` デフォルト値は `FormField` です。

OcrSampleDocumentField

値が抽出されて Salesforce オブジェクトの項目に対応付けられるフォームの項目の詳細を表します。

表 3. 項目
項目名	項目の型	説明
cellColumnNumber	int	この項目の値を保存しているセルがある項目内の列番号。API バージョン 56.0 以降で利用できます。
cellColumnSpanValue	int	この項目の値を保存しているセルがまたがる列数。API バージョン 56.0 以降で利用できます。
cellRowNumber	int	この項目の値を保存しているセルがある項目内の行番号。API バージョン 56.0 以降で利用できます。
cellRowSpanValue	int	この項目の値を保存しているセルがまたがる行数。API バージョン 56.0 以降で利用できます。
fieldLabelMaxX	double	キーの境界ボックスの右端を表す正規化された座標。
fieldLabelMaxY	double	キーの境界ボックスの下端を表す正規化された座標。
fieldLabelMinX	double	キーの境界ボックスの左端を表す正規化された座標。
fieldLabelMinY	double	キーの境界ボックスの上端を表す正規化された座標。
fieldValueName	string	参照項目の値の名前。API バージョン 56.0 以降で利用できます。
keyContent	string	フォームの特定の領域にあるコンテンツ。OCR によって抽出された項目を表します。
ocrSampleDocument	string	必須。顧客フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメント。
ocrSampleDocumentPage	string	OCR サンプルドキュメントのページを定義する項目のコレクション。
ocrSampleDocumentPageItem	OcrSampleDocumentPageItem	この項目の値を含んだサンプルドキュメントページの項目への参照。API バージョン 56.0 以降で利用できます。

OcrSampleDocumentPageItem

ページ項目の値を含んだサンプルドキュメントページの項目への外部キー参照を表します。

表 4. 項目
項目名	項目の型	説明
hasHeader	boolean	OCR サンプルドキュメントページ項目にヘッダーがあるか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。API バージョン 56.0 以降で利用できます。
sequenceNumber	int	必須。複数の項目がある OCR サンプルドキュメントページの項目の連番。API バージョン 56.0 以降で利用できます。
title	string	OCR サンプルドキュメントページ項目のタイトル。API バージョン 56.0 以降で利用できます。
type	ItemType (string 型の列挙)	必須。OCR サンプルドキュメントページ項目の種別を指定します。有効な値は `TABLE` です。 API バージョン 56.0 以降で利用できます。

OcrTemplateSampleDocument

顧客のフォームの情報を抽出する場合や対応付ける場合に、参照情報として使用するサンプルのドキュメントまたは文書型の詳細を表します。

表 5. 項目
項目名	項目の型	説明
ocrSampleDocument	string	顧客フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメント。

宣言的なメタデータの定義のサンプル

OcrTemplate コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<OcrTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
3   <active>false</active>
4   <documentType>Form</documentType>
5   <masterLabel>Form Test 222</masterLabel>
6   <ocrTargetObjects>
7      <ocrTargetObjFieldMappings>
8         <ocrSampleDocField>
9            <cellColumnNumber>1</cellColumnNumber>
10            <cellColumnSpanValue>1</cellColumnSpanValue>
11            <cellRowNumber>1</cellRowNumber>
12            <cellRowSpanValue>1</cellRowSpanValue>
13             <fieldLabelMaxX>0.5975854</fieldLabelMaxX>
14             <fieldLabelMaxY>0.46625894</fieldLabelMaxY>
15             <fieldLabelMinX>0.5065626</fieldLabelMinX>
16             <fieldLabelMinY>0.39605626</fieldLabelMinY>
17             <keyContent>Last Name</keyContent>
18             <ocrSampleDocument>image240</ocrSampleDocument>
19             <ocrSampleDocumentPage>1</ocrSampleDocumentPage>
20             <ocrSampleDocumentPageItem>
21                <hasHeader>false</hasHeader>
22                <sequenceNumber>1</sequenceNumber>
23                <title>Table1</title>
24                <type>TABLE</type>
25            </ocrSampleDocumentPageItem>
26        </ocrSampleDocField>
27      <targetField>Account.Name</targetField>
28      <type>TableColumn</type>
29      </ocrTargetObjFieldMappings>
30      <targetObject>Account</targetObject>
31      <targetObjectRecordType>Account.X240</targetObjectRecordType>
32   </ocrTargetObjects>
33   <ocrTemplateSampleDocuments>
34      <ocrSampleDocument>Form</ocrSampleDocument>
35   </ocrTemplateSampleDocuments>
36   <pageCount>10</pageCount>
37   <templateName>Form Test</templateName>
38</OcrTemplate>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4      <members>*</members>
5      <name>OcrTemplate</name>
6   </types>
7   <version>57.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。