Read Text in Image activity

An activity that reads text in your image with the optical character recognition (OCR) function in Microsoft Cognitive Services, and stores the result of this function in your process schema.

Configure the Read Text in Image activity

To configure the Read Text in Image activity, do the procedure in this topic.

Examples

(Example) How to Get the Access Token Credentials from Microsoft Cognitive Services

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the MS Cognitive Services tab.
On the MS Cognitive Services tab, drag the Read Text In Image activity onto your process.

General Configuration

Specifies the basic settings for the Read Text in Image activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name	Definition
Display Name	Function: Specifies the activity name that shows in your process. Accepted Values: One line of text that can have spaces. Default Value: None Accepts Process Data Variables: No Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Function: Specifies an optional text description for your activity. Accepted Values: More than one line of text. Default Value: None Accepts Process Data Variables: No

Field Name

Definition

Display Name

Function:

Specifies the activity name that shows in your process.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Accepts Process Data Variables:

Example:

This is a common configuration field that is used in many examples. Refer to:

Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:: Specifies an optional text description for your activity.
Accepted Values:: More than one line of text.
Default Value:: None
Accepts Process Data Variables:: No

Source Repository

Specifies the original, or source, location type for your files.

Fields

Field Name	Definition
Amazon S3	Function: Specifies that Amazon S3 is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > Amazon S3.
Box	Function: Specifies that Box is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > Box.
Dropbox	Function: Specifies that Dropbox is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > Dropbox.
FTP	Function: Specifies that FTP is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > FTP.
Google Drive	Function: Specifies that Google Drive is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > Google Drive.
NetSuite	Function: Specifies that NetSuite is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > NetSuite.
OneDrive	Function: Specifies that OneDrive is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > OneDrive.
OneDrive for Business	Function: Specifies that OneDrive for Business is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > OneDrive for Business.
Salesforce	Function: Specifies that Salesforce is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > Salesforce.
SFTP	Function: Specifies that SFTP is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > SFTP.
SharePoint	Function: Specifies that SharePoint is the source location for your files. To select your file in the source location, complete the fields on Read Text in Image > Source Repository > SharePoint.

Read Text in Image Configuration screen

Configures the response settings to read text in the images.

Fields

Field Name	Definition
MS Cognitive Services	Function: Specifies the access token that connects to your Microsoft Cognitive Services. Accepted Values: A list of access tokens configured for your environment. The selected access token must have the Microsoft Cognitive Service Type configured for Computer Vision API. Default Value: None Example: Refer to: (Example) How to Get the Access Token Credentials from Microsoft Cognitive Services
Create	Opens this Screen: Access Token for Microsoft Cognitive Services Function of this Screen: Configure an access token to connect to Microsoft Cognitive Services. Example: Refer to: (Example) How to Get the Access Token Credentials from Microsoft Cognitive Services
Store Response Text in this Variable	Function: Specifies the process data variable that stores the responses from the Microsoft Read Text in Image service. Accepted Values: A process data variable that accepts an alphanumeric string that can have spaces and special characters that contains the extracted text from an image. Default Value: None Accepts Process Data Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?