Custom activity

The Custom activity lets you use third-party tools not available in Vantage and perform additional actions on documents received during skill processing.

A Custom activity collects information about documents in a transaction and sends it to an external system via an HTTP request. The response is processed and saved back to the transaction data. You can pass one or all of the transaction’s documents in a single request.

The Custom activity requires a security level 2 SSL certificate to verify a secure connection. If your server offers a lower security level, the Custom activity can’t send requests to it.

Place a Custom activity inside a For Each Document activity to process each document separately — the Custom activity then sees only one document at a time.

Set up a Custom activity

1. Add the activity

   In the Process skill designer, add a Custom activity block to the document processing workflow.

2. Open activity settings

   In the Actions pane, click Edit Activity.

3. Choose available files

   On the Available Files tab, select the formats for text, document fields, and images to send to the external system. You must select at least one format for each type.

4. Write the script

   On the Activity Script tab, configure your script and click Save.

For a detailed description of objects you can use in scripts, see Object model. For examples, see Sample scripts.

Verify the Custom activity

1. Publish the skill

   Click the Publish tab, enter a name, description, and description of changes, then click Publish Skill.

2. Run the workflow

   Process documents through the workflow that uses the Custom activity.

3. Check results in Skill Monitor

   Review the skill’s results in Skill Monitor. If the script errored, the transaction is interrupted and the error appears in the Transaction Event Log. If you used LogMessage to add custom log entries, they also appear in the Transaction Event Log.

Deprecated interfaces

The Custom activity has been updated. Obsolete scripts continue to work and have access to all documents in a transaction, but the deprecated interfaces below only have access to the first document in a transaction.

Deprecated object	Replacement
InputData	Transaction.Documents
OutputData	Transaction.Documents
ExtractedData	Document
ExtractedField	Field
FieldType	FieldOcrType

Related topics

Custom activity object model

Script restrictions and the full object model for Custom activity scripting.

Custom activity sample scripts

JavaScript samples for OAuth, exports, field updates, and table manipulation.

For Each Document

Run inner activities against one transaction document at a time.

Set up a Process skill

Build a Process skill from a preset or custom workflow of activities.

Skill Monitor — Transaction Event Log

Inspect events for active and completed transactions in Skill Monitor.