Get Results activity

An activity that retrieves results from ABBYY Vantage.

Configure the Get Results activity

Examples

(External) AgilePoint NX Connector For ABBYY Vantage
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.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.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 ABBYY Vantage tab.
On the ABBYY Vantage tab, drag the Get Results activity onto your process.

General Configuration

Specifies the basic settings for the Get Results activity.

Good to Know

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

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts 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	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts 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

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Get Results Configuration

Specifies the information to retrieve results from ABBYY Vantage.

Fields

Field Name	Definition
ABBYY Vantage	Description: Specifies the access token that connects to your ABBYY Vantage service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access tokens for ABBYY Vantage Function of this Screen: Configure an access token to connect to ABBYY Vantage.
Skill Type	Description: Specifies the type of skill to use to retrieve results from ABBYY Vantage. Allowed Values: Document Process Default Value: Document 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?
Skill Name	Description: Specifies the name of the skill to retrieve results from ABBYY Vantage. Allowed Values: A skill name from the list. When you select the type of skill in the Skill Type field, this field shows the skill names associated with the skill type. Default Value: None Accepts 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?
Transaction ID	Description: Specifies the ID of the transaction whose information to retrieve. The transaction ID comes from ABBYY Vantage. Allowed Values: A transaction ID from ABBYY Vantage. Default Value: None Accepts 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?
Use Fields (JSON) / Use Fields (JSON) Metadata	Description: Specifies whether to retrieve results with the file ID or metadata ID from ABBYY Vantage. Allowed Values: Use Fields (JSON) - Uses the file ID to retrieve results. Use Fields (JSON) Metadata - Uses the metadata ID to retrieve results. Default Value: Use Fields (JSON) 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?
Field (JSON) File ID	Description: Specifies the ID of the file to retrieve results. The file ID comes from ABBYY Vantage. To Open this Field: On the Get Results Configuration screen, select Use Fields (JSON). Allowed Values: A file ID from ABBYY Vantage. Default Value: None Accepts 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?
Field (JSON) Metadata ID	Description: Specifies the ID of the metadata whose results to retrieve. The metadata ID comes from ABBYY Vantage. To Open this Field: On the Get Results Configuration screen, select Use Fields (JSON) Metadata. Allowed Values: A metadata ID from ABBYY Vantage. Default Value: None Accepts 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?
Generate Response Schema / Enter Response Payload	Description: Specifies how to store the response data from ABBYY Vantage to the process schema. Allowed Values: Generate Response Schema - Uses the ABBYY Vantage API to retrieve the response schema from ABBYY Vantage based on the specified skill. Click Map Respose To App Schema to open the Schema Mapper screen. Use this screen to connect the response to the data model for your process. Enter Response Payload – Specify a payload in JSON format to use to map the response to the process schema. Click Map Schema to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper 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?
Store Result File In Document Repository	Description: Specifies whether to store the result file to the repository. Allowed Values: Deselected - The response data is stored in the AgilePoint process schema and does not store the data as a result file. Selected - Configures the Target Repository screen to store the result file in the repository. Default Value: Deselected 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?

Target Repository

Selects the target storage repository type for your files.

Fields

Field Name	Definition
Target Repository	Opens this Screen: The configuration screen for your document repository. The specific screen that shows depends on your document repository type. For more information, refer to Document Repositories. Function of this Screen: Configures your document repository.