Variable Syntax

The variable syntax is the programming language used to access or reference a specified variable. The correct syntax must be used when referencing variables or the flow could fail to run.

Basic Syntax

The basic variable syntax is:

$[category.variable]

Variables are surrounded by dollar sign & square brackets. This helps PAS to recognize it as a variable
No spaces are used in the variable syntax
Variables are defined in two parts:
- category - the first part referencing the group the variable belongs to, see Variable Categories below
- variable - the second part is the actual variable to be used

Variable Categories

msg = Message

Variables related to the message currently being processed through the flow. These variables are dynamic and can change based on what actions a node performs on the message.

src = Source

Variables related to the source of the original payload that started the flow. These variables are static and never change once the process begins

sys = System

System variables return basic information from the operating system or PAS server details

usr = User

User variables display a list of flow specific variables created by the user. These are only displayed if a varaible has been created.

pdf = PDF Document

Specific variables related to PDF processing. These will only return a value if the payload contains a PDF document.

Qoppa Software's PDF Automation Server for Windows, Linux, Unix, and macOS

Automate PDF Document Workflows through RESTful Web Services & Folder Watching