Skip to main content
A Custom activity that has been set up using a custom script collects information about the documents in the transaction and sends it in a specific format to an external system via an HTTP request. Once the response to the request is received, it is processed and saved in the transaction data. You can pass one or all of the transaction documents in a single request.
Important! The Custom activity requires a security level 2 SSL certificate to verify that the connection is secure. If your server provides a lower level of security, you will not be able to send requests to it from a Custom activity.
A Custom activity placed in a For Each Document activity can process each document in the transaction separately. In this case the Custom activity will have access only to one document at a time. Custom activities are separate blocks in the workflow that you can use as additional steps to improve document processing.

​
Set up a Custom Activity

To set up a Custom activity, follow these steps:
  1. In the Process skill designer, add a Custom activity block to the document processing workflow.
  2. On the Actions pane, click Edit Activity to open the activity settings.
  3. On the Available Files tab, select the formats for text fields, document fields, and images to send to the external system. You must select at least one format for each type.
  4. On the Activity Script tab, set up your script and click Save.

​
Verify the Custom Activity

To verify that the activity you set up is working as intended, follow these steps:
  1. Publish your skill. Click the Publish tab.
  2. Enter a name, description, and a description of changes made to the skill.
  3. Click Publish Skill.
  4. Process documents in the workflow you set up using a Custom activity.
  5. Check your skill’s results in Skill Monitor. If your script ran with an error, the transaction will be interrupted, and the error description will be displayed in Transaction Event Log in the Skill Monitor. You can also find the appropriate information messages in the Transaction Event Log if you used the LogMessage method to display a custom message in the log.
For a detailed description of objects that you can use in scripts, see Object model. For sample scripts that you can use in Vantage, see Sample scripts.
Important! The Custom activity has been updated. Some of its interfaces are now deprecated. Obsolete scripts will continue to work and will have access to all documents of a transaction, but the deprecated methods will only have access to the first document in a transaction.
List of the deprecated objects: