8.8
Table Of Contents
- Table of Contents
- Welcome to PlanetPress Workflow 8.8
- System Requirements
- Basics
- Features
- The Nature of PlanetPress Workflow
- About Branches and Conditions
- Configuration Components
- Connect Resources
- About Data
- Data Repository
- About Documents
- Debugging and Error Handling
- The Plug-in Bar
- About Printing
- About Processes and Subprocesses
- Using Scripts
- Special Workflow Types
- About Tasks
- Working With Variables
- About Configurations
- About related programs and services
- The Interface
- Customizing the Workspace
- PlanetPress Workflow Button
- The Configuration Components Pane
- Components Area Sections
- Processes and Subprocesses
- Manipulate Global Variables
- Connect Resources
- PPS/PSM Documents
- Associate Documents and PlanetPress 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
- Other Dialogs
- The Debug Information Pane
- The Message Area Pane
- The Object Inspector Pane
- The Plug-in Bar
- Preferences
- Other Preferences and Settings
- General appearance preferences
- Object Inspector appearance preferences
- Configuration Components Pane appearance preferences
- Default Configuration behavior preferences
- Notification Messages behavior preferences
- Sample Data behavior preferences
- Network behavior preferences
- PlanetPress Capture preferences
- OL Connect preferences
- PDF Text Extraction Tolerance Factors
- General and logging preferences
- Messenger plugin preferences
- HTTP Server Input 1 plugin preferences
- HTTP Server Input 2 plugin preferences
- LPD Input plugin preferences
- Serial Input plugin preferences
- Telnet Input plugin preferences
- PlanetPress Fax plugin preferences
- FTP Output Service preferences
- PlanetPress Image preferences
- LPR Output preferences
- PrintShop Web Connect Service preferences
- Editor Options
- 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 Links
- Highlight a Task or Branch
- Undo a Command
- Redo a Command
- The Quick Access Toolbar
- The PlanetPress Workflow Ribbon
- The Task Comments Pane
- Additional Information
- Copyright Information
- Legal Notices and Acknowledgements
Condition or Action
When using the Run Script as a condition, you need a way to tell your process whether the
result is true or false. The condition result is returned by the "Script.ReturnValue" on page119
variable. If the return value is zero (the default), the condition is false. Otherwise, it is true.
When using the Run Script as an action task, the job file going out of the Run Script action
task will be the same as the one coming in, unless you have specifically changed it within your
script by writing to the file that is the target of the "Watch.GetJobFileName" on page110
function. The same goes for any job info, local or global variables, unless you use the
"Watch.SetJobInfo" on page114 or "Watch.SetVariable" on page116 functions to modify them.
APIs
Multiple APIs (methods of communicating with PlanetPress Workflow scripting tools) are
available through the scripting engine, in all languages.
l The Watch object is used to communicate with your current process and configuration.
See "The Watch Object" on page105.
l The PlanetPress Connect REST API consists of many services that expose access to a
number of areas including Workflow, data entity management and file store operations.
See PlanetPress Connect REST API Cookbook.
l You can manipulate PDFfiles using the PlanetPress Alambic API. See AlambicEdit
Library Reference. Note that the PlanetPress Alambic API is part of the PDFTools.
l You can manipulate the metadata in your process using the Metadata API. See Metadata
API Reference.
l You can communicate with a SOAPserver using the SOAPAPI. See "SOAP Server API
Reference" on page98.
l You can communicate with the PlanetPress Capture Database using the Capture API.
See Capture API Reference.
l You can communicate the with the Data Repository using the Data Repository API. See:
"Data Repository API" on page121.
The Script Editor and XSLT Editor
How can I edit scripts and XSLT code?
Scripts can be edited in the Script Editor and the XSLT Editor. Both editors are visually
identical and share almost exactly the same commands. They let you import and export scripts,
Page 92