Variable / Function Insert Tool

The variable / function insert tool provides a visual interface to insert workflow variables or functions into fields as needed. All workflow variables or functions get resolved to a dynamic value when the flow is being executed. The dynamic value is recalculated each time in the context of the job being processed.

Variables and functions can be mixed in with any text in workflow property data fields. Variables can be manually typed however the variable insert tool makes it easy to search for and insert variables as needed.

 

How to Use the Variable / Function Insert Tool

  1. Place the cursor in any text field at the location you wish to insert the variable or function
    • Note: You can also highlight entire text to replace on insert as well
  2. Click on the ƒ(x) button next to the field to launch the variable / function insert tool
  3. Use search and select the variable or function you wish to use and click Insert
  4. The preformatted variable or function will be inserted into the field.

 

Variable Categories

The variables available are separated into predefined categories and groups. A description of each section can be found below. For additional details on each variable see the description in the tool.

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.

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

System

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

User

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

PDF

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

 

Function Categories

The functions available are separated into predefined data types. For additional details on each function see the description in the tool.

String

Strings are used for storing plain text and can contain letters & numbers. Functions in this category manipulate or get information about String variables.

Number

Numbers store values in floating point numerical format. Functions in this category manipulate or get information about Number variables.

Boolean

Booleans store values in one of two states: true or false. Functions in this category manipulate Boolean variables.

Date

Stores a specific instance in time with millisecond precision. Functions in this category manipulate or get information about Date variables.

 

 

 


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

Automate PDF Document Workflows through RESTful Web Services & Folder Watching

Copyright © 2002-Present Qoppa Software. All rights reserved.