OcrDocumentScanResult

Represents the details of the information extracted from the document. This object is available in API version 50.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Sharing Rule

The ContentDocument sharing rule is applicable to all the related OcrDocumentScanResult.

Users can access OcrDocumentScanResult only when you share the related ContentDocument.

Fields

ContentDocumentId

Type: reference
Properties: Filter, Group, Sort
Description: ID of the content document associated with the OCR document scan result.

This field is a relationship field.
Relationship Name: ContentDocument
Relationship Type: Lookup
Refers To: ContentDocument

ContentVersionId

Type: reference
Properties: Create, Filter, Group, Sort
Description: ID of the content version associated with the OCR document scan result.
Relationship Type: Lookup
Refers To: ContentVersion

ErrorMessage

Type: textarea
Properties: Create, Nillable, Update
Description: The message with information about the failure of OCR API calls during extraction. Available in API version 54.0 and later.

ExtractedItemData

Type: textarea
Properties: Nillable
Description: A JSON string from the OCR service’s response containing data extracted from items in the document. Available in API version 56.0 and later.

ExtractedValues

Type: textarea
Properties: Nillable
Description: The information extracted from the document.

This field is encryptable with Salesforce Platform Encryption.
Note

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record, a record related to this record, or a list view.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Name of the OCR document scan result.

OcrService

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The name of the OCR service that extracts information from the form and maps it to the Salesforce object.
Possible values:
- AMAZON_TEXTRACT
- AMAZON_TEXTRACT_ANALYZED_ID—Available in API version 57.0 and later.

OcrStatus

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Status of the extraction and mapping of information from the form field.
Possible values:
- ERROR
- OCR_ENQUEUE
- SUCCESS

PageNumber

Type: int
Properties: Create, Filter, Group, Nillable, Sort
Description: The number of the page in the form in which the extracted value is available.

Rotation

Type: int
Properties: Filter, Group, Nillable, Sort
Description: Angle of the document at which it’s scanned.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

OcrDocumentScanResultFeed: Feed tracking is available for the object.
OcrDocumentScanResultHistory: History is available for tracked fields of the object.