7.1
Table Of Contents
- Copyright Information
- Table of Contents
- Overview
- Getting Started
- Understanding PlanetPress Suite Workflow Tools
- The Nature of PlanetPress Suite Workflow Tools
- The Three Flavors of the PlanetPress Suite Workflow Tools
- Terms and Definitions
- About Configurations
- About Processes
- About Subprocesses
- About Tasks
- About Branches and Conditions
- About Data
- About Data Selections
- About Data Emulation
- About Related Programs and Services
- About Documents
- About Printing
- The PlanetPress Suite Workflow Tools Configuration Program
- Start the PlanetPress Suite Workflow Tools Configuration Program
- The PlanetPress Suite Button
- Create a New Configuration
- Open a PlanetPress Suite Configuration File
- Saving and Sending a Configuration
- Save your Configuration
- Send your Configuration
- Import Processes from Another Configuration File
- Import Documents
- Import PrintShop Mail Documents
- Change the Interface Language
- Exit the PlanetPress Suite Workflow Tools Configuration Program
- The Quick Access Toolbar
- The PlanetPress Suite Ribbon
- The Configuration Components Pane
- Using the Clipboard and Drag & Drop
- Add a PlanetPress Suite Process
- Activate or Deactivate a Process
- Access Process Properties
- View Document Properties
- Convert a Branch to a Subprocess
- Add Resident Documents in the Configuration Components Pane
- Associate Documents and PlanetPress Watch Printer Queues
- Rename Objects in the Configuration Components Pane
- Reorder Objects in the Configuration Components Pane
- Grouping Configuration Components
- Expand and Collapse Categories and Groups in the Configuration Components Pane
- Delete Objects and Groups from the Configuration Components Pane
- The Process Area
- Zoom In or Out within Process Area
- Adding Tasks
- Adding Branches
- Edit a Task
- Replacing Tasks, Conditions or Branches
- Remove Tasks or Branches
- Task Properties Dialog
- Cutting, Copying and Pasting Tasks and Branches
- Moving a Task or Branch Using Drag-and-Drop
- Ignoring Tasks and Branches
- Resize Rows and Columns of the Process Area
- Selecting Documents in Tasks
- Highlight a Task or Branch
- Undo a Command
- Redo a Command
- The Plug-in Bar
- The Object Inspector Pane
- The Debug Information Pane
- The Message Area Pane
- Customizing the Program Window
- Preferences
- General User Options
- Object Inspector User Options
- Configuration Components Pane User Options
- Default Configuration User Options
- Notification Messages Preferences
- Sample Data User Options
- Network User Options
- Logging User Options
- Messenger User Options
- HTTP Server Input User Options
- LPD Input Preferences
- Serial Input Service User Options
- Telnet Input User Options
- PlanetPress Fax User Options
- FTP Output Service User Options
- PlanetPress Image User Options
- LPR Output User Options
- PrintShop Web Connect Service User Options
- Editor Options
- Advanced SQL Statement dialog
- PlanetPress Suite Access Manager
- Add or Delete Document Instances
- Virtual Drive Manager
- Working With Variables
- Data in PlanetPress Suite Workflow Tools
- Task Properties Reference
- Input Tasks
- Initial and Secondary Input Tasks
- Create File Input Task Properties
- Folder Capture Input Task Properties
- Folder Listing Input Task Properties
- Concatenate PDF Files Input Task Properties
- Email Input Task Properties
- Error Bin Input Task Properties
- FTP Input Task Properties
- HTTP Client Input Task Properties
- WinQueue Input Task Properties
- HTTP Server Input Task Properties
- LPD Input Task Properties
- Serial Input Task Properties
- PrintShop Web Connect Input Task Properties
- Telnet Input Task Properties
- SOAP Input Task Properties
- Action Tasks
- Add Document Action Properties
- Add/Remove Text Action Properties
- Search and Replace Action Task Properties
- Advanced Search and Replace Action Task Properties
- Create PDF Action Task Properties
- Digital Action Task Properties
- Decompress Action Task Properties
- Change Emulation Action Task Properties
- External Program Action Task Properties
- Download to Printer Action Task Properties
- Load External File Action Properties
- Rename Action Task Property
- Set Job Infos and Variables Action Task Properties
- Windows Print Converter Action Task Properties
- Standard Filter Action Task Properties
- Translator Action Task Properties
- PlanetPress Database Action Task Properties
- XSLT Editor Action Task Properties
- Send Images to Printer Action Task Properties
- Send to Folder Action Task Properties
- Run Script Action Task Properties
- Microsoft® Word® To PDF Action Task Properties
- Create MRDX Action Task Properties
- PrintShop Mail Action Task Properties
- Process Logic Tasks
- Branch Properties
- Comment Properties
- Conditions
- File Name Condition Properties
- File Size Condition Properties
- SNMP Condition Properties
- Text Condition Properties
- Time of Day Condition
- Splitters
- About Using Emulations with Splitters
- Database Splitter Action Task Properties
- Emulated Data Splitter Action Task Properties
- In-Stream Splitter Action Task Properties
- PDF Splitter Action Task Properties
- XML Splitter Action Task Properties
- Generic Splitter Action Task Properties
- Loop Action Task Properties
- Send to Process Task Properties
- Metadata Tasks
- Barcode Scan Action Task Properties
- Create Metadata Action Task Properties
- Embed/Extract PlanetPress Suite Metadata
- Lookup in Microsoft® Excel® Documents Action Task Properties
- Metadata Fields Management Task Properties
- Metadata Filter Action Task Properties
- Metadata Level Creation Action Task Properties
- Metadata Sequencer Action Task Properties
- Metadata Sorter Task Properties
- Metadata-Based N-Up Task Properties
- Rule Interface
- Output Tasks
- Delete Output Task Properties
- FTP Output Task Properties
- Laserfiche Repository Output Task Properties
- Printer Queue Output Task Properties
- Print Using a Windows Driver Output Task Properties
- SOAP Client Task Properties
- Send Email Output Task Properties
- Send to Folder Output Task Properties
- About PlanetPress Fax
- PlanetPress Fax Output Task Properties
- About PlanetPress Image
- PlanetPress Image Output Task Properties
- Overview of the PDF/A and PDF/X Standards
- Variable Properties
- Unknown Tasks
- Masks
- Input Tasks
- Printer Queues and Documents
- PlanetPress Suite Workflow Tools Printer Queues
- Printer Queue Advanced Properties
- Windows Output Printer Queue Properties
- LPR Output Printer Queue Properties
- FTP Output Printer Queue Properties
- Send to Folder Printer Queue Properties
- PlanetPress Suite Workflow Tools and PlanetPress Design Documents
- Variable Content Document File Formats: PTZ, PTK and PS
- PlanetPress Suite Workflow Tools and Printshop Mail Documents
- Load Balancing
- Location of Documents and Resources
- Debugging PlanetPress Suite Processes
- Error Handling
- Using Scripts
- Index
Working With Variables
A Variable is basically a keyword that points to specific location in your computer's memory. This location contains data that
you decide to place in it, by assigning that data to the variable name. This chapter will help you learn about these variables and
how you can use them.
Types of Variables
There are 3 types of variables that can be used in the PlanetPress Suite Workflow Tools:
l Global Variables are available by all processes and tasks within the configuration, and any modification made to
them affects all tasks and configurations. Global variables are generally used to keep information that applies to mul-
tiple locations but need to be changed easily. For example, a lot of uses use them to set a server's IP, a printer name,
or folder location that is used by multiple processes. This is useful when moving the configuration file to another instal-
lation of the Workflow Tools where this information is different, or to quickly modify specific information if something
changes on the server. You can have as many global variable as you want in any given configuration.
l Local Variables are specific to an instance of a process. That is to say, when a process changes the information in a
local variable, it changes it only for that process and only for that specific instance of the process. When the process
ends, the local variable forgets whatever value was given to it by the process and goes back to its default value. Local
variables are generally used to keep information that is useful for the process itself but not to any other process or
instance of the process. For example, you could store the current order IDfor the process, a name or an email. You can
have as many local variables as you want in any given process.
l Job Infos are also specific to an instance of a process, however their use is different. Just after an initial or secondary
input task, Job Infos contain information about the job file itself. Job Infos are also, by default, accessible by Plan-
etPress Design documents used throughout your process. They are generally used to gather information from the input
task, or transfer information to your PlanetPress Design document.
All the variables in the PlanetPress Suite Workflow Tools are considered strings, even if the information itself can be a number.
There are no other types of variables (such as arrays, floating point numerical values or booleans) in PlanetPress Suite Work-
flow Tools.
Local and Global Variables
Global Variables
Global Variables are set at the level of the Configuration file and are shared between all processes and tasks. Global variables
can be used anywhere that accepts variables by using it's name preceded by "global."and surrounded by curly brackets (for
example:%{global.myGlobalVariable}).
To add a global variable, you can use one of two methods:
l Click on the Home tab of the PlanetPress Suite Ribbon, then click Global Variable in the Variables group.
l Right-click on the Global Variables folder in the Configuration Components area, then click on Insert Global
Variable.
To set the default value of a global variable, you can use one of two methods:
Working With Variables
©2010 Objectif Lune Inc - 81 -










