Get Transaction Information activity

An activity that retrieves informaton about a transaction from ABBYY Vantage.


Get Transaction Information activity

Configure the Get Transaction Information activity

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the ABBYY Vantage tab.

    Open ABBYY Vantage tab
  3. On the ABBYY Vantage tab, drag the Get Transaction Information activity onto your process.

    Drag Get Transaction Information activity

General Configuration

Specifies the basic settings for the Get Transaction Information activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

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

Fields

Field NameDefinition

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

Get Transaction Information Configuration

Specifies the information about a transaction to retrieve from ABBYY Vantage.

Figure: Get Transaction Information Configuration screen

Get Transaction Information Configuration screen

Fields

Field NameDefinition

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 Add Token icon

Opens this Screen:
Access tokens for ABBYY Vantage
Function of this Screen:
Configure an access token to connect to ABBYY Vantage.

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?

Field (JSON) File ID

Description:
Specifies a variable to store the ID of the file.

The file ID comes from ABBYY Vantage.

Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Special characters

Not Accepted:

  • Spaces
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 a variable to store the ID of the metadata.

The metadata ID comes from ABBYY Vantage.

Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Special characters

Not Accepted:

  • Spaces
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?

Status

Description:
Specifies a variable to store the status of the specified transaction from ABBYY Vantage.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
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?

Manual Review Link

Description:
Specifies a variable to store the URL of the manual review for the transaction.

The manual review link comes from ABBYY Vantage.

Allowed Values:
A variable.

Format:

  • String

Accepted:

  • URL
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?