--- schema_version: "1" id: 26bb04d66dbeae5140d44d181b7eb7444955eddedb7f2653061192820d7d534c title: OcrTemplate collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_ocrtemplate.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ocrtemplate.htm source_site: developer.salesforce.com content_type: documentation content_hash: 839eaeb52d8ae5834ff355c2a0ae34279357db4dd8851fbf384099f5e2ca9057 description: Represents the details of the mapping between a form and a Salesforce object using Intelligent Form Reader. This type extends the Metadata metadata type and inherits its fullName field. --- # OcrTemplate Represents the details of the mapping between a form and a Salesforce object using Intelligent Form Reader. This type extends the Metadata metadata type and inherits its fullName field. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## File Suffix and Directory Location OcrTemplate components have the suffix .ocrTemplate and are stored in the ocrTemplates folder. ## Version OcrTemplate components are available in API version 52.0 and later. ## Special Access Rules To use this metadata type, your Salesforce org must have the AWSTextract1000LimitAddOn license. ## Fields | Field Name | Field Type | Description | | --- | --- | --- | | active | boolean | Indicates whether the OCR template is active (true) or not (false). | | description | string | The description of the OCR template. | | documentType | string | Required. The document type for which this template defines mappings. | | masterLabel | string | Required. The label for the OCR template. | | ocrTargetObjects | [OcrTargetObject](#OcrTargettObj)\[\] | Represents the details of the object to which information from a form is extracted and mapped. | | ocrTemplateSampleDocuments | [OcrTemplateSampleDocument](#OcrTemplateSampleDoc)\[\] | Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form. | | pageCount | integer | The number of pages in the form from which information is extracted. | | templateName | string | Required. The name of the OCR template. | ## OcrTargetObject Represents the details of the object to which information from a form is extracted and mapped. Table 1. Fields | Field Name | Field Type | Description | | --- | --- | --- | | ocrTargetObjFieldMappings | [OcrTargetObjFieldMapping](#OcrTgtObjFieldMap)\[\] | Represents the details of how information from a form field is mapped to fields in an object. | | targetObject | string | Required. The object to which information from a form is mapped. | | targetObjectRecordType | string | The developer name of the record type of the target object. Available in API version 56.0 and later. | ## OcrTargetObjFieldMapping Represents the details of how information from a form field is mapped to fields in an object.
Table 2. Fields
Field Name Field Type Description
ocrSampleDocField OcrSampleDocumentField[] The details of the field in a form whose value is extracted and mapped to a Salesforce object field.
targetField string Required. The field to which information is mapped.
type OcrMappingType (enumeration of type string) Required. Specifies the type of mapping. Available in API version 56.0 and later.

Valid values are:

  • FormField
  • TableColumn
The default value is FormField.
## OcrSampleDocumentField Represents the details of the field in a form whose value is extracted and mapped to a Salesforce object field.
Table 3. Fields
Field Name Field Type Description
cellColumnNumber int The column number in the item with the cell storing this field’s value. Available in API version 56.0 and later.
cellColumnSpanValue int The number of columns that span the cell storing this field’s value. Available in API version 56.0 and later.
cellRowNumber int The row number in the item with the cell storing this field’s value. Available in API version 56.0 and later.
cellRowSpanValue int The number of rows that span the cell storing this field’s value. Available in API version 56.0 and later.
fieldLabelMaxX double A normalized coordinate representing the right edge of the bounding box of the key.
fieldLabelMaxY double A normalized coordinate representing the bottom edge of the bounding box of the key.
fieldLabelMinX double A normalized coordinate representing the left edge of the bounding box of the key.
fieldLabelMinY double A normalized coordinate representing the top edge of the bounding box of the key.
fieldValueName string The name of the referred field value. Available in API version 56.0 and later.
isAutoExtractedValue boolean Indicates whether the key is automatically extracted (true) or not (false). Available in API version 57.0 and later.

This field helps to distinguish auto-extracted keys from manual ones.
keyContent string The content in a particular area of the form, representing the field that is extracted by OCR.
ocrSampleDocument string Required. The associated OCR sample document is used as a reference while extracting and mapping information from a customer form.
ocrSampleDocumentPage string A collection of fields that define a page in the OCR sample document.
ocrSampleDocumentPageItem OcrSampleDocumentPageItem A reference to the item on the sample document page containing this field's value. Available in API version 56.0 and later.
## OcrSampleDocumentPageItem Represents a foreign key reference to the item on the sample document page containing a value for the page item.
Table 4. Fields
Field Name Field Type Description
hasHeader boolean Indicates whether the OCR sample document page item has a header (true) or not (false). The default value is false. Available in API version 56.0 and later.
sequenceNumber int Required. The sequence number of the item on an OCR sample document page with multiple items. Available in API version 56.0 and later.
title string The title of the OCR sample document page item. Available in API version 56.0 and later.
type ItemType (enumeration of type string) Required. Specifies the type of OCR sample document page item.

Valid value is TABLE.

Available in API version 56.0 and later.
## OcrTemplateSampleDocument Represents the details of a sample document or a document type that's used as a reference while extracting and mapping information from a customer form. Table 5. Fields | Field Name | Field Type | Description | | --- | --- | --- | | ocrSampleDocument | string | The associated OCR sample document is used as a reference while extracting and mapping information from a customer form. | ## Declarative Metadata Sample Definition The following is an example of a OcrTemplate component. false Form Form Test 222 1 1 1 1 0.5975854 0.46625894 0.5065626 0.39605626 Last Name image240 1 false 1 Table1 TABLE Account.Name TableColumn Account Account.X240 Form 10 Form Test The following is an example package.xml that references the previous definition. \* OcrTemplate 68.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).