7.0
Table Of Contents
- Other Documentation
- Understanding PlanetPress Suite Workflow Tools
- Key Concepts
- PlanetPress Suite Workflow Tools
- The Origins of PlanetPress Watch
- The Nature of PlanetPress Suite Workflow Tools
- Configurations and Processes
- More on PlanetPress Suite Workflow Tools and How They Work
- The Configuration and its Processes
- Tasks
- More on PlanetPress Suite Services
- PlanetPress Design and PlanetPress Workflow Tools
- Data
- Data File and Job File
- Job File Names and Output File Names
- Error Handling Tools
- PlanetPress Suite Workflow Tools and Printing
- The PlanetPress Suite Workflow
- Date and Time Format
- Microsoft Outlook, Outlook Express® and MAPI
- Key Concepts
- The PlanetPress Suite Workflow Tools Configuration Program
- Key Concepts
- Detailed Directions
- Start the PlanetPress Suite Workflow Tool Configuration Program
- Choose the Account to be Used by your PlanetPress Suite Workflow Tool
- Control Access to the Locally Installed Services
- Exit the PlanetPress Suite Workflow Tool Configuration Program
- Create a New Configuration
- Open a PlanetPress Suite Configuration File
- Reopen a Configuration File
- Add a PlanetPress Suite Process
- Import Processes from Another Configuration File
- Save a Configuration
- Use Online Help
- Rename Objects in the Configuration Components Area
- Expand and Collapse Categories and Groups in the Configuration Components Area
- Cut, Copy and Paste Objects in the Configuration Components Area
- Reorder Objects in the Configuration Components Area
- Group and Ungroup Objects in the Configuration Components Area
- Delete Objects and Groups from the Configuration Components Area
- Undo a Command
- Redo a Command
- View Document Properties
- Edit Properties in the Object Inspector
- Select a Process
- Resize Rows and Columns of the PlanetPress Suite Process Area
- Zoom In or Out within the PlanetPress Suite Process Area
- Highlight a Task or Branch
- Resize the Program Window Areas
- Show or Hide Areas of the Program Window
- Dock and Undock Areas of the Program Window
- Combine and Attach Areas
- Configurations, Processes and Tasks
- Configuration Management
- Opening and Importing Configurations and Processes
- Users and Configurations
- Anatomy of a Process
- Configurations, Processes and Flowcharts
- Design Versus Debug Mode
- Tasks as Plugins
- Task Properties Dialog Boxes
- Variable Properties
- Standard Variables
- Job Information Elements and Job Info Variables
- Custom Variables
- Selecting Documents in Tasks
- Sending Job Info Variables to Output Devices
- Working with Tasks in the PlanetPress Process Area
- Adding Branches
- Detailed Directions
- Adding Tasks
- Editing Tasks or Branches
- Adding Comments
- Replacing Tasks, Conditions, Branches or Comments
- Removing Tasks and Branches
- Cutting and Pasting, or Copying and Pasting Tasks and Branches
- Moving Tasks, Branches and Comments Using Drag-and-Drop
- Duplicating Tasks, Branches and Comments Using Drag-and-Drop
- Copying and Pasting Properties between Task, Conditions or Comments
- Disabling and Enabling Tasks and Branches
- Data in PlanetPress Watch
- Input Tasks
- Detailed Directions
- Email Input Task Properties
- Folder Listing Input Task Properties
- Folder Capture Input Task Properties
- FTP Input Task Properties
- HTTP Client Input Task Properties
- HTTP Server Input Task Properties
- Create File Input Task Properties
- LPD Input Task Properties
- Serial Input Task Properties
- Telnet Input Task Properties
- WinQueue Input Task Properties
- Detailed Directions
- Output Tasks
- PlanetPress Fax
- PlanetPress Image
- Action Tasks
- Detailed Directions
- Advanced Search and Replace Action Task Properties
- Database Action Task Properties
- PrintForm Action Task Properties
- PrintShop Mail Action Task Properties
- Rename Action Task Property
- Run Script Action Task Properties
- Search and Replace Action Task Properties
- Send Images to Printer Action Task Properties
- Send to Folder Action Task Properties
- Set Variables Action Task Properties
- Standard Filter Action Task Properties
- Translator Action Task Properties
- Windows Print Converter Action Task Properties
- Create Metadata Action Task Properties
- Create PDF Action Task Properties
- In-Stream Splitter Action Task Properties
- Load External File Action Properties
- PDF Splitter Action Task Properties
- Send to Process Action Task Properties
- Emulated Data Splitter Action Task Properties
- XML Splitter Action Task Properties
- Database Splitter Action Task Properties
- Generic Splitter Action Task Properties
- Add Document Action Properties
- Add/Remove Text Action Properties
- Change Emulation Action Task Properties
- Create VDX Action Task Properties
- Decompress Action Task Properties
- Digital Imaging Action Task Properties
- Digital Signature Action Task Properties
- Download to Printer Action Task Properties
- External Program Action Task Properties
- Loop Action Task Properties
- Open XSLT Action Task Properties
- Detailed Directions
- Using Conditions
- Using Scripts
- Printer Queues and Documents
- Detailed Directions
- LPR Output Printer Queue Properties
- Windows Output Printer Queue Properties
- FTP Output Printer Queue Properties
- Send to Folder Printer Queue Properties
- Printer Queue Advanced Properties
- Import Documents
- Import PrintShop Mail Documents
- Add Resident Documents in the Configuration Components Area
- Associate Documents and PlanetPress Watch Printer Queues
- Print a Test Page
- Manually Update Documents
- Detailed Directions
- Scheduling PlanetPress Watch Processes
- Advanced Configurations and Options
- Key Concepts
- Service Options Versus Properties
- Languages
- Detailed Directions
- Delete Images From Your Virtual Drive
- Editor Options
- LPR Output User Options
- Network Ports Settings
- Change Languages
- Change your User Options
- Change your Script Editor or XSLT Editor User Options
- General User Options
- Object Inspector User Options
- Configuration Components Area User Options
- Default Configuration User Options
- Notification Messages User Options
- Sample Data User Options
- Logging User Options
- Network User Options
- HTTP Server Input User Options
- LPD Input User Options
- Serial Input Service User Options
- Telnet Input User Options
- FTP Output Service User Options
- Error Handling
- Debugging PlanetPress Watch Processes
- Sending and Running a Configuration
12.3 SOAP Server API Reference
PlanetPress Suite offers a SOAP server API Reference allowing jobs to be submitted from third party
application using the SOAP protocol. Remember that SOAP stands 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 five methods that will allow
SOAP clients to submit jobs and get information from the PlanetPress Suite Workflow Tool executing them.
Note that PlanetPress Suite Workflow Tools already come with a SOAP client plugin, which can be used as an
input, action or output; this task was renamed SOAP Legacy Client.
Since the SOAP Server API Reference is primarily targeted at programmers or systems engineers, it is rather
technical.
Related topics:
• SOAP Client Task Properties (Page 143)
• SOAP Input Task Properties (Page 0)
• SOAP API - SubmitJob (Page 229)
• SOAP API - PostJob (Page 230)
• SOAP API - GetProcessList (Page 230)
• SOAP API - GetProcessTaskList (Page 231)
• SOAP API - GetSOAPProcessList (Page 232)
• SOAP API - SubmitJobInfStruc (Page 233)
• SOAP API - PostJobInfStruc (Page 232)
12.3.1 SOAP API - SubmitJob
Syntax
SubmitJob (File, SubmitJobInfStruc , ReturnJobFile, Username, Password) : SubmitJobResult
Description
The SubmitJob method allows users to remotely submit files to their PlanetPress Suite Workflow Tool from a
SOAP client. The SOAP client has the option to wait for a response file from the PlanetPress Suite Workflow
Tools SOAP server.
Arguments
• File – base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64).
• SubmitJobInfStruc – Structure containing any required information to prepare the file for a valid
insertion into a PlanetPress Suite process.
• ReturnJobFile – Boolean value. When true, the PlanetPress Suite Workflow Tools SOAP server returns
the job file. When false, there no file is returned to the SOAP client. (For example: when submitting a
job for print, there is no need to return a file)
• Username – String containing the username.
• Password – String containing the password. This value is case sensitive.
Return Value
• SubmitJobResult - Structure containing the following information:
• Success – Integer indicating the Success/Error level of the operation. A result of 0 means the operation
was successful.
• Message – String containing text information about the Success/Failure status.
• SubmitJobInfStruc – See point SubmitJobInfStruc for details.
• ResultFile – base64Binary. If Success is different than 0 or the ReturnJobFile was set to False in the
initial call, no file is returned. Otherwise, ResultFile contains the job file, as it existed at the completion
Objectif Lune Inc. © 2009 229