2022.2
Table Of Contents
- Welcome to PlanetPress Workflow 2022.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 variables
- Workflow add-ons
- About related programs and services
- About Tasks
- Adding tasks
- Editing a task
- Task properties
- Masks
- Selecting a resource file in task properties
- Input tasks
- Initial Input tasks
- Secondary Input tasks
- Properties common to all input tasks
- Available Input tasks
- Create File
- Email Input
- File Count
- Folder Capture
- Folder Listing
- FTP Input
- HTTP Client Input
- Input Error Bin
- Input SOAP
- LPD Input
- Merge PDF Files
- Microsoft 365 Email Input
- Microsoft 365 OneDrive Input
- NodeJS Server Input
- PrintShop Web Connect
- Secure Email Input
- Serial Input
- SFTP Input
- SMTP Input
- Telnet Input
- WinQueue Input
- Action tasks
- Add/Remove Text
- Advanced Search and Replace
- Barcode Scan
- Change Emulation
- Create PDF
- Database Query
- Decompress File(s)
- Digital Action
- External Program
- Load External File
- Logger
- Mathematical Operations
- Open XSLT
- PDF/A-3 Attachments
- Push to Repository
- Rename
- Run Script
- Search and Replace
- Send to Folder
- Set Job Infos and Variables
- SOAP Client plugin
- Standard Filter
- Translator
- XML/JSON Conversion
- Data splitters
- Process logic tasks
- Connector tasks
- Metadata tasks
- OL Connect Send
- OL Connect tasks
- All In One
- Create Email Content
- Create Job
- Create Output
- Create PDF/VT
- Create Preview PDF
- Create Print Content
- Create Web Content
- Download EML Messages
- Execute Data Mapping
- File Store - Delete File
- File Store - Download File
- File Store - Upload File
- Mark Connect Sets for Deletion
- Merge Jobs
- PDF to Bitmap
- Render Email Content
- Retrieve Items
- Set Properties
- Update Data Records
- Output tasks
- Document Management tasks
- Email Services
- Legacy tasks
- Unknown tasks
- 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
- SMTP Input 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
- Access Manager
- Access Manager hosts.allow File
- Activate a printer
- Advanced SQL Statement Dialog
- Data Repository Manager
- The Data Selector
- Data Selector display preferences
- The File Viewer
- LaserFiche Repository Output Task - Configure Tags
- LaserFiche Repository Output Task - Configure Templates
- PDF Viewer
- Printer utilities
- Process properties
- Rule Interface
- The PlanetPress Workflow Service Console
- Task Properties dialog
- Update document
- Virtual Drive Manager
- 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
they are attached to. Each element has a name and a value. Here is a definition of these 2 types of ele-
ments:
l
Attribute: A read-only, system-defined element which holds certain information about a certain
node in the Metadata structure. This information can be static (e.g. the size of a physical page) or
evaluated on-the-fly (e.g. the number of documents in a group). Attributes are non-repetitive (i.e.
name is unique) and do not persist through Metadata recreation. (See also: "Metadata Attributes
reference" on page73.)
l
Field: A read-write, user-defined element which holds custom information about a certain node in
the Metadata structure. Fields are repetitive (i.e. the same field may appear multiple times) and
persist through Metadata recreation.
When the Metadata file is viewed through the Data Selector in Workflow, attributes are listed under Pro-
duction information; fields are listed under User defined information (see "Metadata tab" on
page715).
In addition to attributes and fields, each Metadata node has a number of properties and methods. The
Boolean property selected indicates whether or not to produce the pages under that node. By default,
this property is set to true for all nodes. This property is not visible in the Metadata file, but it can be
used in a Run Script task via the Metadata API.
Metadata Tools in PlanetPress Design
PlanetPress Suite includes a complete set of Metadata-related functionality, which can be referred to
as Metadata Tools. These tools can be used to generate Metadata, retrieve or define Metadata ele-
ments, and build the Metadata structure of a PlanetPress Design document. For information about
these tools see the Design user guide: PlanetPress Design 7.6 User Guide.
Working with Metadata
A set of special Workflow plugins allows to edit the Metadata during a Workflow process (see
"Metadata" on page67 and "Metadata tasks" on page469). This topic describes what you have to know
about Metadata in order to be able to use these plugins effectively.
How data and Metadata influence each other
When Metadata are created, they are based upon a data file. However, modifying one file doesn't auto-
matically change the other, and Metadata aren't reset by default in a Branch, Condition or Loop.
l
Modifying Metadata does not immediately modify the data. This is one of the benefits of
Metadata because you can sort it, filter it, sequence it, add data to it, without ever modifying the
data file itself. This is important because if you, for instance, filter out certain data pages from the
Metadata and then save your data file with the Send to Folder task, the full data file is saved, not
Page 69