OcrTemplate

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

Supported Calls 

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

Fields 

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.

    1<!-- reuse-break schema="reuse-break/v1" intent="dev_guides/api/objects/sforce_api_objects_recordtype.xml#sforce_api_objects_recordtype/note_set_unique_DeveloperName" partial="sforce-api-objects-recordtype-note-set-unique-developername" element="note" canonical_repo="platform-obj-meta-tool" reason="conref target crossed repo boundary; content duplicated instead of transcluded" -->

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
  • Relationship Name: DocumentType
  • Relationship Type: Lookup
  • Refers To: DocumentType
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the associated document type. This is a relationship field.

IsActive 

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether this OCR template is active.

Language 

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Language of the OCR template.

MasterLabel 

  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The label for the OCR template.

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. Available in API version 52.0 and later.

PageCount 

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: Number of pages in the document from which information is extracted.

TemplateName 

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Name of the OCR template.