SAP Help Home SAP Intelligent RPA Help Portal SAP Intelligent RPA Community

Module - Document Information Extraction Activities

Set of activities related to Document Information Extraction & Business OCR service.

Author:
  • SAP Intelligent RPA R&D team

Activities

Extract Data With Template Deprecated

Extract data with Document Information Extraction using the chosen document template and given PDF file.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
extractData synchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
templateArtifact any mandatory An object representing a dox template artifact.
readOnlyDataType any mandatory An object representing response JSON schema.
documentPath string mandatory Path to the document.
filterSenderEnrichmentBy irpa_pdf.enums.entitySubType optional None Filter sender business entity by this sub-type.
filterReceiverEnrichmentBy irpa_pdf.enums.entitySubType optional None Filter receiver business entity by this sub-type.

Output Parameters:

Name Type Description
extractedData any Object based on readOnlyDataType containing extracted information from the document.

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid document path


Extract Data Without Template Deprecated

[Deprecated] Extracts data with the Document Information Extraction service without template.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
extractDataWithoutTemplate synchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
documentType irpa_pdf.enums.doxDocumentType mandatory Type of document to extract.
documentPath string mandatory Path to the document.
filterSenderEnrichmentBy irpa_pdf.enums.entitySubType optional None Filter sender business entity by this sub-type.
filterReceiverEnrichmentBy irpa_pdf.enums.entitySubType optional None Filter receiver business entity by this sub-type.

Output Parameters:

Name Type Description
extractedData any Extracted data from DOX.

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid document path


Open Document (Online OCR) Deprecated

Activity to extract the Image/PDF document using OCR provided by the Document Information Extraction service. Once a document is opened, other PDF activities can be used later.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
doxOCR synchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
documentPath string mandatory Full path of the existing document.

Errors:

Error Class Package Description
SequenceError irpa_core Another PDF file is already opened
InvalidArgument irpa_core Invalid document path


Create Employee Entity Enrichment Data Deprecated

Activity to create employee entity master data in Document Information Extraction service.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
enrichment.createEmployeeEntityEnrichmentData asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
employeeDataEntities Array.<irpa_pdf.employeeEntity> mandatory List of Employee entity objects.

Output Parameters:

Name Type Description
requestId any Request ID of created record in Document Information Extraction service.


Create Business Entity Enrichment Data Deprecated

Activity to create business entity master data in Document Information Extraction service.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
enrichment.createBusinessEntityEnrichmentData asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
businessDataEntities Array.<irpa_pdf.businessEntity> mandatory List of Business entity objects.
assignEntitySubtype irpa_pdf.enums.entitySubType optional None Create enrichment business entity of this sub-type.

Output Parameters:

Name Type Description
requestId any Request ID of created record in Document Information Extraction service.


Activate Master Data Deprecated

Activate master data in Document Information Extraction service.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
enrichment.activateMasterData asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
requestId any Request ID from activation job at Document Information Extraction service.


Delete Master Data Deprecated

Activity to delete all master data from Document Information Extraction service.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
enrichment.deleteAllMasterData asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
entityType irpa_pdf.enums.entityType mandatory Entity type for which the master data needs to be deleted.
entitySubType irpa_pdf.enums.entitySubType optional None Filter deletion of business entity by this sub-type.

Output Parameters:

Name Type Description
requestId any Extracted request ID from deletion in Document Information Extraction service.


Delete Master Data Records Deprecated

Activity to delete single or multiple master data records from the Document Information Extraction service.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
enrichment.deleteMasterDataRecord asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
recordIds Array. mandatory Record IDs of records which need to be deleted.
entityType irpa_pdf.enums.entityType mandatory Entity type for which the master data needs to be deleted.
entitySubType irpa_pdf.enums.entitySubType optional None Filter deletion of business entity by this sub-type.

Output Parameters:

Name Type Description
deletedRecords any Number of records deleted at Document Information Extraction service

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid record Id's


Get Enrichment Data Deprecated

Activity to retrieve one or more enrichment data entities from Document Information Extraction service.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
enrichment.getEnrichmentData asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
entityType irpa_pdf.enums.entityType mandatory Entity type of the enrichment data.
filterEntityEnrichmentBy irpa_pdf.enums.entitySubType optional None Filter business entity data by this sub-type.

Output Parameters:

Name Type Description
enrichmentData any List of records filtered by entity type and sub type at Document Information Extraction service


Get Enrichment Data Status (Creation/Deletion) Deprecated

Activity to retrieve information about a master data record from Document Information Extraction service.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
enrichment.getEnrichmentDataCreationOrDeletionStatus asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
requestId string mandatory Job ID of the record.

Output Parameters:

Name Type Description
status any Status of creation or deletion job at Document Information Extraction service

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid job id.


Get Data Activation Details Deprecated

Activity to retrieve information about a master data activation record from Document Information Extraction service. A corresponding activity with the same name is available in the Document Information Extraction SDK.


Status
Deprecated

Comment:

This activity has been deprecated. Please use the substitute activity in new Document Information Extraction SDK (irpa_sapdox) instead.



Technical Name Type Minimal Agent Version
enrichment.getDataActivationDetails asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Default Description
requestId string mandatory Data activation job record ID.

Output Parameters:

Name Type Description
status any Status of activation job at Document Information Extraction service

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid id.