Document Event Variables

Last Updated: June 08, 2026

When a document event trigger activates, Vasion Automate receives metadata variables from the originating input source. You can use these variables throughout the workflow in conditional branches, step configurations, and data mapping.

Available variables 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 are being standardized across input sources. Confirm final names with your Vasion Automate representative before building workflows that depend on optional variables.

Common Variables

All document event triggers include these required variables, regardless of input source.

Common Variables
Variable	Type	Description
eventType	String	Identifies the input source that activated the trigger. Values include "cpa," "client," "rules_and_routing."
document	Object	The document object passed into the workflow.

Document Scan (CPA)

These variables are provided when the trigger activates from a document scan through the Control Panel Application (CPA) on a multifunction printer (MFP).

Required Variables

Document Scan Required Variables
Variable	Type	Description
eventType	String	Always "cpa."
document	Object	The document object passed into the workflow.

Optional Variables

Document Scan 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	Universally Unique Identifier (UUID) of the user who scanned the document.
filename	String	Name of the scanned file.
fileContentType	String	Multipurpose Internet mail extensions (MIME) type of the document, for example, application/pdf or 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 activates from a print job submitted through the PrinterLogic Agent.

Required Variables

Print Job Required Variables
Variable	Type	Description
eventType	String	Always "client."
document	Object	The document object passed into the workflow.

Optional Variables

Print Job Optional Variables
Variable	Type	Description
printerId	String	ID 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, or archive.
username	String	Username of the user on the submitting operating system (OS).
alternativeUserName	JSON	Alternate username associated with the user, typically the identity provider (IdP) username.
jobSourceType	String	Source of the print job, for example, workstation, web print, or 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, etc.
isDuplex	Boolean	Whether the print job used duplex printing.
created	Datetime	Timestamp when the print job was created.
submitted	Datetime	Timestamp when the print job was submitted.
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 of the submitting user.
company	String	Company or organization associated with the user.

Output Automation and Rules and Routing

These variables are provided when the trigger activates from an Output Automation Output Rules event.

Required Variables

Output Automation Required Variables
Variable	Type	Description
eventType	String	Always "rules_and_routing."
document	Object	The document object passed into the workflow.

Optional Variables

Output Automation 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 the print job used duplex printing.
isColor	Boolean	Whether the job 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, etc.
serviceClientName	String	Name of the Service Client used to print the job.
sourceType	String	Origin of the job, for example, Output Automation, API Cloud Link, etc.

Document Event Variables

Common Variables

Document Scan (CPA)

Required Variables

Optional Variables

Print Job (Client)

Required Variables

Optional Variables

Output Automation and Rules and Routing

Required Variables

Optional Variables

Related Topics