Newer Version Available

This content describes an older version of this product. View Latest

OcrTemplate

Represents the details of the mapping between the document and the Salesforce object using Intelligent Document Reader. This object is available in API version 55.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field Details
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the OCR template. Available in API version 56.0 and later.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

Note

DocumentTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the document type associated with the OCR template.
This field is a relationship field.
Relationship Name
DocumentType
Relationship Type
Lookup
Refers To
DocumentType
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the OCR template is active.
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The combined language and locale ISO code, which controls the language of the OCR template.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Label for the OCR target object. This display value is the internal label that doesn't get translated.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
For managed packages, this field is the namespace prefix assigned to the package. For unmanaged packages, this field is blank.
PageCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Number of pages of the document, from the start of the document, from which information is extracted. If the document has lesser pages than this number, then information is extracted from all the pages of the document.
TemplateName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of the OCR template.