Start Transaction activity

An activity that starts a transaction in ABBYY Vantage.


Start Transaction activity

Configure the Start Transaction 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 Start Transaction activity onto your process.

    Drag Start Transaction activity

General Configuration

Specifies the basic settings for the Start Transaction 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

Source Repository

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

Figure: Source Repository screen

Source Repository screen

Fields

Field NameDefinition

Source 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.

Start Transaction Configuration

Specifies the configuration to start a transaction in ABBYY Vantage.

Figure: Start Transaction Configuration screen

Start Transaction 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.

Skill Type

Description:
Specifies the type of skill to use to start the transaction.
Allowed Values:
  • Document
  • Process
  • Classification
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 Or ID

Description:
Specifies the name or ID of the skill to start the transaction.

The skill name or ID comes from ABBYY Vantage.

Allowed Values:
A skill from the list.

When you select the type of skill in the Skill Type field, this field shows the skills 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?

Store Response Transaction ID In This Variable

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

The transaction 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?