2021.1
Table Of Contents
- Table of Contents
- Welcome to PlanetPress Workflow 2021.1
- Installation and setup
- Basics
- Features
- About Workflow Configurations
- Workflow Configuration resource files
- About data
- Data Repository
- Debugging and error handling
- About printing
- OL Connect print jobs
- PlanetPress Suite print jobs
- PlanetPress Workflow printer queues
- Shared printer queue properties
- Windows Output printer queue
- LPR Output Printer Queue
- FTP Output Printer Queue
- Send to Folder printer queue
- Load balancing
- Associating PlanetPress Design documents and PlanetPress printer queues
- Triggers
- Objectif Lune Printer Driver (PS)
- About processes and subprocesses
- Using Scripts
- Run Script task
- APIs
- The Script Editor and XSLT Editor
- SOAP Server API Reference
- The Watch Object
- Data Repository API
- Metadata API
- Attributes
- Count
- Fields
- Index
- NodeType
- Parent
- Selected
- SelectedCount
- SelectedState
- Add(Integer Index)
- AttributeByIndex(Integer Index)
- AttributeByName(const String Name)
- Clear()
- Copy()
- Cut()
- DatapageCount()
- Delete()
- DocumentCount()
- FieldByIndex(Integer Index)
- FieldByName(const String Name)
- FieldByNameIndex(const String Name, Integer Index)
- IndexInDocument()
- IndexInGroup()
- IndexInJob()
- Item(Integer Index)
- PageCount()
- Paste()
- PasteAt(Integer Index)
- Select(TSelectWhat SelectWhat)
- SelectedDatapageCount()
- SelectedDocumentCount()
- SelectedIndexInDocument()
- SelectedIndexInGroup()
- SelectedIndexInJob()
- SelectedPageCount()
- Sort(const String Name, optional TSortFlags Flags, optional const String Name...
- Parameters
- Exceptions
- Parameters
- Exceptions
- Parameters
- Returns
- Parameters
- Exceptions
- Parameters
- Returns
- Exceptions
- Parameters
- Returns
- Parameters
- Returns
- Exceptions
- Parameters
- Returns
- Exceptions
- AlambicEdit API reference
- Stopping execution
- Special workflow types
- About Tasks
- Adding tasks
- Editing a task
- Task properties
- Masks
- Selecting a resource file in task properties
- Input tasks
- Action tasks
- Data splitters
- Process logic tasks
- Connector tasks
- PlanetPress Capture
- Metadata tasks
- OL Connect Send
- OL Connect tasks
- Output tasks
- Document Management tasks
- Connection tab
- Download tab
- Connection tab
- Upload tab
- Advanced properties
- Advanced properties
- Email Services
- Unknown tasks
- About variables
- Workflow add-ons
- About related programs and services
- 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 plugin preferences 1
- HTTP Server Input plugin preferences 2
- LPD Input plugin preferences
- NodeJS Server Input plugin preferences 1
- NodeJS Server Input plugin preferences 2
- NodeJS Server Input plugin preferences 3
- 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 user interface
- Customizing the Workspace
- PlanetPress Workflow Button
- Configuration Components pane
- Components Area Sections
- PlanetPress Design document properties
- Moving and copying configuration components
- 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...
- Deleting something from the Configuration Components pane
- Dialogs
- The Debug Information pane
- The Message Area Pane
- The Object Inspector pane
- The Plug-in Bar
- The Process area
- Cutting, copying and pasting tasks and branches
- Highlight a task or branch
- Disabling tasks and branches
- Moving a task or branch using drag-and-drop
- Redo a command
- Removing tasks or branches
- Replacing tasks, conditions or branches
- Resize the rows and columns of the Process area
- Collapse and expand branches and conditions
- Undo a command
- Zoom in or out within the Process Area
- The Quick Access Toolbar
- The PlanetPress Workflow Ribbon
- The Task Comments Pane
- The PlanetPress Workflow Service Console
- Knowledge Base
- Legal Notices and Acknowledgments
l "MetaDocument" on page206
l "MetaDatapage" on page210
l "MetaPage" on page213
The MetaJob is a collection of MetaGroup objects, where each MetaGroup is a collection of one
or more MetaDocument objects, and so on, except for the MetaPage which does not have child
nodes.
Properties and methods
All Node objects share a number of properties and methods that are common to all Node
object types. There are also properties and methods that are either unique to a specific Node
object type, or shared between only a few of them.
Each Node object type provides methods to access its children (in other words, Nodes that are
located underneath that Node item in the tree structure). The method's name varies to match
the type of Node. For example, the child accessor method in a MetaDocument node is named
Datapage.
There is also a generic accessor method named Item that is common across all Node object
types. The Item method of the MetaGroup returns a MetaDocument, while the same method for
a MetaDatapage returns a MetaPage.
Note: The "MetaPage" on page213 object does not have a child accessor method as it does
not contain any Node objects.
For the available properties and methods see the Node type's documentation: "MetaJob" on
page200, "MetaGroup" on page203, "MetaDocument" on page206, "MetaDatapage" on
page210, and "MetaPage" on page213.
Including or excluding nodes from the output
The Selected property of any Node object is used to select whether the node - and all of its
children, down to the smallest unit - are to be included in the final output or not.
If a node has its Selected property set to true, all of its children that also have their own
Selected property set to true will print.
If Selected is false, its children will not print, regardless of their Selected status.
Methods like Count, Index or PageCount work on all nodes, regardless of their Selected
attributes.
Methods whose names start with "Selected" however are meant to work with selected nodes. In
other words, "Selected..." methods only consider nodes that are set to be part of the output.
Page 216