Industries Common Resources Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Industries Common Resources
AI Accelerator and Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Collections and Recovery
Context Service
Criteria-Based Search and Filter
Data Processing Engine, Batch Management, and Monitor Workflow Services
Digital Lending
Discovery Framework
Decision Explainer
Einstein Relationship Insights
Einstein Standard Invocable Actions
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Intelligent Form Reader Standard Objects
Intelligent Form Reader Business APIs
Intelligent Form Reader Metadata API Types
Intelligent Form Reader Tooling API Objects
OcrSampleDocument
OcrSampleDocumentField
OcrSampleDocumentPage
OcrSampleDocumentPageItem
OcrTargetObject
OcrTargetObjFieldMapping
OcrTemplate
OcrTemplateSampleDocument
Intelligent Form Reader Standard Invocable Actions
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Process Compliance Navigator
Record Alerts
Record Rollup Definitions
Scheduled Reminders
Sentiment Insights
Service Process Studio
Timeline
Virtual Calls
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

OcrTemplate

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

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.

Important

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

To use this tooling API object, your Salesforce org must have the AWSTextract1000LimitAddOn license.

Fields

Field Details
Description
Type
string
Properties
Filter, Group, Sort
Description
Description of the OCR template.
DeveloperName
Type
string
Properties
Filter, Group, Sort
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
FullName
Type
string
Properties
Create, Group, Nillable
Description
The full name of the associated metadata type in Metadata API.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsActive
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this OCR template is active (true) or not (false).
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Language of the OCR template.
ManageableState
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package.
Possible values are:
  • beta—Managed-Beta
  • deleted—Managed-Proposed-Deleted
  • deprecated—Managed-Proposed-Deprecated
  • deprecatedEditable—SecondGen-Installed-Deprecated
  • installed—Managed-Installed
  • installedEditable—SecondGen-Installed-Editable
  • released—Managed-Released
  • unmanaged—Unmanaged
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Label of the optical character reader (OCR) template.
Metadata
Type
complexvalue
Properties
Create, Nillable, Update
Description
OCR template metadata.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix.
PageCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Number of pages in the document from which information is extracted.
TemplateName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name of the OCR template.