7.4
Table Of Contents
- Copyright Information
- Table of Content
- 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 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
- Access Process Properties
- Add a PlanetPress Suite Process
- Manipulate Local Variables
- Activate or Deactivate a Process
- Convert a Branch to a Subprocess
- Manipulate Global Variables
- View Document Properties
- Use Data and Metadata Files Attached to Documents
- Use Attached Document Preview
- Add Resident Documents in the Configuration Components Pane
- Associate Documents and PlanetPress Watch Printer Queues
- Using the Clipboard and Drag & Drop
- 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
- PlanetPress Capture User Options
- PDF Text Extraction Tolerance Factors
- Logging User Options
- Messenger User Options
- HTTP Server Input User Options
- HTTP Server Input 2 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
- Other Dialogs
- Working With Variables
- Data in PlanetPress Suite Workflow Tools
- Task Properties Reference
- Input Tasks
- Action Tasks
- Add Document
- Add/Remove Text
- Advanced Search and Replace
- Barcode Scan
- Change Emulation
- Create PDF
- Decompress File(s)
- Digital Action
- Download to Printer
- External Program
- Load External File
- Mathematical Operations
- Open XSLT
- PlanetPress Database
- Rename
- Run Script
- Send Images to Printer
- Search and Replace
- Send to Folder
- Set Job Infos and Variables
- SOAP Client Plug-in
- Standard Filter
- Translator
- Windows Print Converter
- Data Splitters
- Process Logic Tasks
- Connector Tasks
- Create MRDX
- Input from SharePoint
- Laserfiche Repository Output
- Lookup in Microsoft® Excel® Documents
- Microsoft® Word® Documents To PDF Conversion
- Output to SharePoint
- About PlanetPress Fax
- PlanetPress Fax
- Captaris RightFax Configuration
- About PlanetPress Image
- PlanetPress Image
- Overview of the PDF/A and PDF/X Standards
- PrintShop Mail
- PlanetPress Capture
- Metadata Tasks
- Output Tasks
- Variable Properties
- Unknown Tasks
- Masks
- Special Workflow Types
- Printer Queues and Documents
- PlanetPress Suite Workflow Tools Printer Queues
- Shared Printer Queue Properties
- Windows Output Printer Queue
- LPR Output Printer Queue
- FTP Output Printer Queue
- Send to Folder Printer Queue
- 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
- Triggers
- Load Balancing
- Location of Documents and Resources
- Debugging and Error Handling
- Using Scripts
- Index
Local Variables are set at the level of the Process and are not shared with any other process or instance of that process. Local
variables can be used anywhere that accepts variables by using it's namee, surrounded by curly brackets and preceded by a
percent sign (for example:%{myLocalVariable}).
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.
To add a local variable, you can use one of two methods:
l Select the process where you want to add the variable.
l Click on the Home tab of the PlanetPress Suite Ribbon, then click Local Variable in the Variables group.
l Right-click on the process in the Configuration Components area, then click on Insert Local Variable.
Shared tasks
These procedures can be used on both local and global variables.
To delete a variable
l Right-click on the variable name in the Configuration Components Area and click Delete.
To rename a variable:
l Right-click on the variable name in the Configuration Components Area.
l Click Rename
l Type in the new name of the variable, then press Enter on your keyboard.
While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it
will not change the references in any script within a Run Script task. Deleting a variable, on the other hand, does not delete any
reference to it. In both the case where a script refers to a variable and it is renamed, or in the case of deleting a variable, any
task or script that refers to it will cease to function and will generate an error.
You can set the value of a variable within your process in two ways:
l Use the Set Job Info and Variable action task. See Set Job Infos and Variables.
l You can use Scripts. See the chapter Using Scripts.
Variables may be used as variable properties in variable property boxes (see Variable Properties).
Activate or Deactivate a Process
All processes are Active by default, but you may make any PlanetPress Suite process Inactive as required. Because making a
process active or inactive is a change in the configuration, to make the change effective you will have to send the edited con-
figuration to your PlanetPress Suite Workflow Tools service (see Send your Configuration).
To activate or deactivate a process:
l Right-click the process in question in the Configuration Components Pane
l Click Active to disable or enable the process.
l Send your configuration.
If you try to send a configuration that contains only inactive processes, the PlanetPress Suite Workflow Tools Con-
figuration program will ask you to confirm the operation (this can be changed in the Notification User Options).
The PlanetPress Suite Workflow Tools Configuration Program