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
Name Description
only adds a key name to the group, not a key value. See
AddValue() for information on how to set a value for a key.
ListKeys
Retrieves the list of all Key names and data types in Group
GroupName, stored in a JSONStringObject. You should use
JSON.Parse() to convert the string into an actual JavaScript
object. You can then use the for…in construct to list the
different properties for that object (i.e. the keys in the group).
RemoveKey
Removes existing key KeyName from group GroupName.
The key to remove must exist in the group, otherwise an error
is raised. All values for the key, in all keysets for the group,
are removed. Note that when the Group contains a large
number of KeySets, this operation may take a while.
RenameKey
Renames key oldName to newName in group GroupName.
While this operation has no impact on the data stored in that
Group, it does require any plugin and/or script that uses
oldName to be modified to refer to newName.
Value Methods
Name Description
AddValue
Creates a new KeySet by assigning Value to the key
KeyName in Group GroupName. Note that KeyName must
exist in GroupName, otherwise an error is raised. See
AddKey() for information on adding a key to a group. Upon
successful completion, the method returns the ID of the
newly created KeySet.
GetValue
Performs a lookup in group GroupName and retrieves the
first value for key KeyName that matches Condition. The
condition is specified using basic SQL WHERE syntax. The
Page 126