2020.2
Table Of Contents
- Table of Contents
- Welcome to PlanetPress Workflow 2020.2
- 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 "Run Script" on page473 tasks can modify Metadata using the "Metadata API" on
page194 (see "Using Scripts" on page139).
l "Create PDF" on page390 has the option to reset your Metadata according to the new
PDF file.
l "OL Connect tasks" on page582 can add information, such as record IDs, a record set ID
or a print job ID, to the Metadata. They put it under 'User defined information' on the Job,
Group or Document level.
l The "Barcode Scan" on page380 task can add information to the existing Metadata, and
creates it if there is none.
l The "Capture Fields Generator" on page534, "Capture Fields Processor" on page537,
"Get Capture Document" on page547 and "Find Capture Documents" on page543 tasks
generate their own Metadata.
l The "Lookup in Microsoft® Excel® Documents" on page491 enhances Metadata fields
with information from an Excel spreadsheet, but does not otherwise change its structure.
How Metadata affects the output
By default the data file is not affected when the Metadata are modified. There are however a
few situations in which Metadata will or may affect the output.
In OL Connect, output is normally created from records in the Connect database, but options in
some "OL Connect tasks" on page582 make it possible to influence the output via the
Metadata.
l The "Execute Data Mapping" on page618 task and "Retrieve Items" on page635 task
can output records in the Metadata.
l The "Create Print Content" on page606 and "Create Email Content" on page590 tasks
have the option to update the records in the Connect database from the Metadata and use
the updated records as input.
In PlanetPress Suite, the Metadata defines the order in which the data is consumed by a
Design template. Changing the order and location of the various items means that the final
output will be different than the original and will follow the order dictated by the Metadata
instead of the order of the physical data.
l When you print a PDF with a Windows Print Queue, the Metadata is inspected to
determine whether pages should print or not (see "Print using a Windows driver" on
Page 78