Document Event Variables
Last Updated: May 19, 2026
When a Document Event trigger fires, Automate receives a set of metadata variables from the originating input source. These variables are available throughout the workflow for use in conditional branches, step configurations, and data mapping.
The variables available depend on which input source initiated the trigger. Each input source passes its own set of required and optional variables.
Variable names are case-sensitive. Use exact casing as shown in the tables below. Variable names across input sources are being standardized. Confirm final names with your Vasion Automate administrator or engineering contact before building workflows that depend on optional variables.
Common Variables
All Document Event triggers include the following required variables regardless of input source:
|
Variable |
Type |
Description |
|---|---|---|
|
eventType |
string |
Identifies the input source that fired the trigger. Values: cpa, client, rules_and_routing. |
|
document |
object |
The document object passed into the workflow. |
Document Scan (CPA)
These variables are provided when the trigger fires from a document scan through the Control Panel Application (CPA) on an multifunction printer (MFP).
Required Variables
|
Variable |
Type |
Description |
|---|---|---|
|
eventType |
string |
Always "cpa." |
|
document |
object |
The document object passed into the workflow. |
Optional Variables
|
Variable |
Type |
Description |
|---|---|---|
|
initiatorEmail |
string |
Email address of the user who scanned the document. |
|
initiatorName |
string |
Name of the user who scanned the document. |
|
initiatorUUID |
UUID |
UUID of the user who scanned the document. |
|
filename |
string |
Name of the scanned file. |
| fileContentType | string | MIME type of the document (for example, application / pdf, image / tiff). |
|
filesize |
integer |
Size of the file in bytes. |
|
documentUUID |
UUID |
UUID of the document metadata record. |
|
artifactUUID |
UUID |
UUID of the storage artifact. |
|
storagePrefix |
string |
Logical file separation prefix. Always "CPA" for CPA scans. |
|
artifactURL |
string |
Full URL to the storage location of the file. |
|
isExternal |
boolean |
Whether the document is external. Always true for CPA scans. |
|
resourceOwner |
string |
The service that owns the resource. Always "storage" for CPA scans. |
|
uploadedBy |
UUID |
UUID of the user who uploaded the document. |
|
uploadedTime |
string |
ISO 8601 timestamp of when the document was uploaded. |
|
scannerName |
string |
Name of the MFP that created the scan. |
|
scannerID |
integer |
ID of the MFP that created the scan. |
Print Job (Client)
These variables are provided when the trigger fires from a print job submitted through the Vasion Print Client.
Required Variables
|
Variable |
Type |
Description |
|---|---|---|
|
eventType |
string |
Always "client." |
|
document |
object |
The document object passed into the workflow. |
Optional Variables
|
Variable |
Type |
Description |
|---|---|---|
|
printerId |
string |
Unique identifier of the printer that processed the job. |
|
printerType |
string |
Type of printer or printer class. |
|
printerAddress |
string |
Network address or location identifier of the printer. |
|
printerName |
string |
Name of the printer used for the job. |
|
jobType |
string |
Type of job submitted (for example, print, workflow submission, archive). |
|
username |
string |
Username of the user from the submitting operating system. |
|
alternativeUserName |
json |
Alternate username associated with the user, typically the IdP username. |
|
jobSourceType |
string |
Source of the print job (for example, workstation, web print, mobile). |
|
isColor |
boolean |
Whether the job was printed in color. |
|
pageCount |
integer |
Number of pages in the print job. |
|
paperSize |
string |
Paper size used for the print job (for example, Letter, A4). |
|
isDuplex |
boolean |
Whether the print job used duplex (double-sided) printing. |
|
created |
datetime |
Timestamp when the print job was created. |
|
submitted |
datetime |
Timestamp when the print job was submitted to the system. |
|
title |
string |
Title of the print job. |
|
fullName |
string |
Full name of the user who submitted the job. |
|
jobTitle |
string |
Employee job title of the submitting user. |
|
department |
string |
Department associated with the submitting user. |
|
company |
string |
Company or organization associated with the user. |
Output Automation / Rules and Routing
These variables are provided when the trigger fires from an Output Management rules and routing event.
Required Variables
|
Variable |
Type |
Description |
|---|---|---|
|
eventType |
string |
Always "rules_and_routing." |
|
document |
object |
The document object passed into the workflow. |
Optional Variables
|
Variable |
Type |
Description |
|---|---|---|
|
fileName |
string |
Name of the file. |
|
fileSize |
integer |
Size of the file in bytes. |
|
printedByEmail |
string |
Email address of the user who printed the document. |
|
printedByUsername |
string |
Username of the user who printed the document. |
|
printedByUUID |
UUID |
UUID of the user who printed the document. |
|
pageCount |
integer |
Number of pages printed. |
|
isDuplex |
boolean |
Whether duplex printing was used. |
|
isColor |
boolean |
Whether the document was printed in color. |
|
printerID |
integer |
ID of the printer the job was sent to. |
|
printerName |
string |
Name of the printer the job was sent to. |
|
documentType |
string |
File type of the document (for example, PDF, PS, PCL). |
|
serviceClientName |
string |
Name of the Service Client the job was printed from. |
|
sourceType |
string |
Origin of the job (for example, Output Automation, API Cloud Link). |