2022.2
Table Of Contents
- Welcome to PReS 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
- PReS 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 PReS 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
- PReS Fax plugin preferences
- FTP Output Service preferences
- PReS Image preferences
- LPR Output preferences
- PrintShop Web Connect Service preferences
- Editor Options
- The user interface
- Customizing the Workspace
- PReS 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 PReS 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 PReS Workflow Ribbon
- The Task Comments Pane
- The PReS Workflow Service Console
- Knowledge Base
- Legal Notices and Acknowledgments
"GetProcessList" below Allows SOAP clients to request the list of available PReS Workflow processes, based on their authentication credentials.
"GetProcessTaskList" on
the facing page
Allows a user to remotely request the tasks list of a process. This will be useful with the PostJob method since it needs a TaskIn-
dex.
"GetSOAPProcessList"
on the facing page
Allows users to request the list of PReS 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 page126
Allows users to remotely submit files to PReS Workflow by using the Resubmit from here feature, which lets a user specify a start-
ing task index from which the File is to be processed.
"PostJobInfoStruc" on
page127
Structure containing any required information to prepare the file for resubmission into a PReS Workflow process.
"SubmitJob" on page128
Allows users to remotely submit files to their PReS Workflow from a SOAP client. The SOAP client has the option to wait for
a response file from PReS Workflow SOAP server.
"SubmitJobInfStruc" on
page129
Structure containing any required information to prepare the file for a valid insertion into a PReS Workflow process.
Note: With the SOAP API reference, new SOAP plugins have been introduced. The old plugin,
which could be used as an Input, Action or Output task, was renamed Legacy SOAP Client and
has become obsolete.
GetProcessList
The GetProcessList function allows SOAP clients to request the list of available PReS Workflow pro-
cesses, based on their authentication credentials.
Syntax
GetProcessList (user name, Password) : GetProcessListResult
Parameters
l
user name: String containing the user name.
l
Password: String containing the password. This is case sensitive.
Return Value
l
GetProcessListResult: Structure containing the following information:
l
Success: Integer indicating the system-defined Success/Error level of the operation. A res-
ult of 0 means that the operation was successful.
l
Message: String containing text information about the Success status.
l
ProcessList: Structure containing the following information details.
l
ProcessName: String containing the process name.
l
Active: Boolean value specifying whether the process is currently active.
Page 124