2022.1
Table Of Contents
- Table of Contents
- Welcome to PlanetPress Workflow 2022.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
- 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
- Legacy tasks
- Error handling
- 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
SOAP Server API Reference
PlanetPress Workflow offers a SOAP Server API Reference allowing jobs to be submitted from
a third party application using the SOAP protocol. SOAP is short for Simple Object Access
Protocol.
While there are multiple possibilities for solutions using a SOAP server implementation, the
SOAP Server API Reference is specifically for submitting jobs from a SOAP client. It
implements methods that will allow SOAP clients to submit jobs and get information from
PlanetPress Workflow executing them.
Methods, structures Description
"GetProcessList" on the
next page
Allows SOAP clients to request the list of available
PlanetPress Workflow processes, based on their
authentication credentials.
"GetProcessTaskList" on
page151
Allows a user to remotely request the tasks list of a process.
This will be useful with the PostJob method since it needs a
TaskIndex.
"GetSOAPProcessList" on
page152
Allows users to request the list of PlanetPress Workflow
processes that contain a SOAP Input plugin with the SOAP
action name. This is useful when working with the SubmitJob
method since it requires a SOAPActionName.
"PostJob" on page153 Allows users to remotely submit files to PlanetPress Workflow
by using the Resubmit from here feature, which lets a user
specify a starting task index from which the File is to be
processed.
"PostJobInfoStruc" on
page154
Structure containing any required information to prepare the
file for resubmission into a PlanetPress Workflow process.
"SubmitJob" on page154 Allows users to remotely submit files to their PlanetPress
Workflow from a SOAP client. The SOAP client has the option
to wait for a response file from PlanetPress Workflow SOAP
Page 149