7.4
Table Of Contents
- Copyright Information
- Table of Content
- Overview
- Getting Started
- Understanding PlanetPress Suite Workflow Tools
- The Nature of PlanetPress Suite Workflow Tools
- The Three Flavors of the PlanetPress Suite Workflow Tools
- Terms and Definitions
- About Configurations
- About Processes
- About Subprocesses
- About Tasks
- About Branches and Conditions
- About Data
- About Data Selections
- About Data Emulation
- About Related Programs and Services
- About Documents
- About Printing
- The PlanetPress Suite Workflow Tools Configuration Program
- Start the PlanetPress Suite Workflow Tools Configuration Program
- The PlanetPress Button
- Create a New Configuration
- Open a PlanetPress Suite Configuration File
- Saving and Sending a Configuration
- Save your Configuration
- Send your Configuration
- Import Processes from Another Configuration File
- Import Documents
- Import PrintShop Mail Documents
- Change the Interface Language
- Exit the PlanetPress Suite Workflow Tools Configuration Program
- The Quick Access Toolbar
- The PlanetPress Suite Ribbon
- The Configuration Components Pane
- Access Process Properties
- Add a PlanetPress Suite Process
- Manipulate Local Variables
- Activate or Deactivate a Process
- Convert a Branch to a Subprocess
- Manipulate Global Variables
- View Document Properties
- Use Data and Metadata Files Attached to Documents
- Use Attached Document Preview
- Add Resident Documents in the Configuration Components Pane
- Associate Documents and PlanetPress Watch Printer Queues
- Using the Clipboard and Drag & Drop
- Rename Objects in the Configuration Components Pane
- Reorder Objects in the Configuration Components Pane
- Grouping Configuration Components
- Expand and Collapse Categories and Groups in the Configuration Components Pane
- Delete Objects and Groups from the Configuration Components Pane
- The Process Area
- Zoom In or Out within Process Area
- Adding Tasks
- Adding Branches
- Edit a Task
- Replacing Tasks, Conditions or Branches
- Remove Tasks or Branches
- Task Properties Dialog
- Cutting, Copying and Pasting Tasks and Branches
- Moving a Task or Branch Using Drag-and-Drop
- Ignoring Tasks and Branches
- Resize Rows and Columns of the Process Area
- Selecting Documents in Tasks
- Highlight a Task or Branch
- Undo a Command
- Redo a Command
- The Plug-in Bar
- The Object Inspector Pane
- The Debug Information Pane
- The Message Area Pane
- Customizing the Program Window
- Preferences
- General User Options
- Object Inspector User Options
- Configuration Components Pane User Options
- Default Configuration User Options
- Notification Messages Preferences
- Sample Data User Options
- Network User Options
- PlanetPress Capture User Options
- PDF Text Extraction Tolerance Factors
- Logging User Options
- Messenger User Options
- HTTP Server Input User Options
- HTTP Server Input 2 User Options
- LPD Input Preferences
- Serial Input Service User Options
- Telnet Input User Options
- PlanetPress Fax User Options
- FTP Output Service User Options
- PlanetPress Image User Options
- LPR Output User Options
- PrintShop Web Connect Service User Options
- Editor Options
- Other Dialogs
- Working With Variables
- Data in PlanetPress Suite Workflow Tools
- Task Properties Reference
- Input Tasks
- Action Tasks
- Add Document
- Add/Remove Text
- Advanced Search and Replace
- Barcode Scan
- Change Emulation
- Create PDF
- Decompress File(s)
- Digital Action
- Download to Printer
- External Program
- Load External File
- Mathematical Operations
- Open XSLT
- PlanetPress Database
- Rename
- Run Script
- Send Images to Printer
- Search and Replace
- Send to Folder
- Set Job Infos and Variables
- SOAP Client Plug-in
- Standard Filter
- Translator
- Windows Print Converter
- Data Splitters
- Process Logic Tasks
- Connector Tasks
- Create MRDX
- Input from SharePoint
- Laserfiche Repository Output
- Lookup in Microsoft® Excel® Documents
- Microsoft® Word® Documents To PDF Conversion
- Output to SharePoint
- About PlanetPress Fax
- PlanetPress Fax
- Captaris RightFax Configuration
- About PlanetPress Image
- PlanetPress Image
- Overview of the PDF/A and PDF/X Standards
- PrintShop Mail
- PlanetPress Capture
- Metadata Tasks
- Output Tasks
- Variable Properties
- Unknown Tasks
- Masks
- Special Workflow Types
- Printer Queues and Documents
- PlanetPress Suite Workflow Tools Printer Queues
- Shared Printer Queue Properties
- Windows Output Printer Queue
- LPR Output Printer Queue
- FTP Output Printer Queue
- Send to Folder Printer Queue
- PlanetPress Suite Workflow Tools and PlanetPress Design Documents
- Variable Content Document File Formats: PTZ, PTK and PS
- PlanetPress Suite Workflow Tools and Printshop Mail Documents
- Triggers
- Load Balancing
- Location of Documents and Resources
- Debugging and Error Handling
- Using Scripts
- Index
GetProcessList (Username, Password) : GetProcessListResult
Description
The GetProcessList function allows SOAP clients to request the list of available PlanetPress Suite processes, based on their
authentication credentials.
Parameters
l Username – String containing the username.
l Password – String containing the password. This value 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 result 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.
Notes
l To obtain access to the complete list of processes for all users, the end-user must have administrator privileges.
SOAP API - GetProcessTaskList
Syntax
GetProcessTaskList (ProcessName, Username, Password) : GetProcessTaskListResult
Description
The GetProcessTaskList function will allow a user to remotely request the tasks list of a process. This will be useful with the
PostJob API since it needs a TaskIndex.
Parameters
l ProcessName – The Name of the PlanetPress Suite process.
l Username – String containing the username.
l Password – String containing the password. This is case sensitive.
Return Value
l GetProcessTaskListResult – Structure containing the following information:
l Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the
operation was successful.
l Message – String containing text information about the Success status.
l TaskNames– Structure containing the following information details.
Using Scripts