2018.1
Table Of Contents
- Table of Contents
- Welcome to PlanetPress Workflow 2018.1
- Installation and Setup
- Basics
- Features
- The Nature of PlanetPress Workflow
- About data
- Data Repository
- Debugging and Error Handling
- About Printing
- About Processes and Subprocesses
- Using Scripts
- Special Workflow Types
- About Tasks
- Working With Variables
- About Workflow Configurations
- Workflow Configuration resource files
- About related programs and services
- The Interface
- Customizing the Workspace
- PlanetPress Workflow Button
- Configuration Components pane
- Components Area Sections
- Process properties
- Manipulate Global Variables
- Connect resources
- PPS/PSM Documents
- Associate Documents and PlanetPress Printer Queues
- Using the Clipboard and Drag & Drop
- Renaming objects in the Configuration Components Pane
- Reordering objects in the Configuration Components pane
- Grouping Configuration Components
- Expanding and collapsing categories and groups in the Configuration Component...
- 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
Using a JSON parameter or return value
Whenever a parameter or return value is defined as a JSONStringArray type, that JSON array
is itself a string. Since a JSON array internally defines double quotes as the delimiter for each
element, you must enclose the entire string in single quotes. Alternatively, you can escape the
double quotes inside the JSON Array.
For instance, the following calls to AddGroup() are correct:
RepoObject.AddGroup("MyGroup",'["FirstKey", "SecondKey"]');
RepoObject.AddGroup("MyGroup","[\"FirstKey\", \"SecondKey\"]");
But the following is incorrect:
RepoObject.AddGroup("MyGroup","['FirstKey', 'SecondKey']");
Many methods require using the JSONStringArray type but JSON is not natively supported in
VB Script. Therefore, for those methods, only JavaScript sample code is provided. There are
many resources on the Web that propose ways of implementing JSON parsing in VB Script so
you can implement whichever you see fit. However, using JavaScript is highly recommended.
Repository management methods
Name Description
CheckRepository
Verifies the integrity of the repository and recovers unused
space left by deleted keysets. Similar to packing a
database, the operation is non-destructive but it does
require exclusive access to the Repository. You should
therefore only perform this operation when you know for
sure no other process is accessing the Data Repository.
ClearRepository
Deletes all groups, keys and keysets from the repository,
returning it to a blank state. Use with caution!
ClearGroupData
Deletes all keysets inside GroupName while retaining the
existing key structure.
ClearAllData
Delete all keysets in all groups, while retaining the
Page 124