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
l As soon as possible:This option needs to be checked, otherwise requests will not be handled as they come in (this
option is meant to be used on scheduled processes that run at intervals).
l Polling Interval (sec):This option determines how much time the HTTPServer Input waits between the moment it
finishes processing a request and the moment it picks up a new request. This should be put at 0 in order to process
requests as soon as possible, meaning immediately.
And finally, the HTTPServer Input task properties. While these are described in the HTTP Server Input task properties page,
here are a few considerations to keep in mind when using this task:
l The HTTPAction corresponds precisely to the name immediately following the first slash of your address. That is to
say, placing the action myaction here means the process would be triggered by opening http://1-
27.0.0.1:8080/myaction in your browser.
l The HTTPservice accepts both POSTand GETrequests. Other than the presence of file attachments, there is little dif-
ference in how these are handled. This means that visiting /myaction?id=12345&q=test would be the same as
having a form with two <input> fields named, respectively, id and q, and submitting them with the information
"12345"and "test". In both cases, this information is located in the XMLenvelope that is the original input file.
l When doing POSTrequests and uploading files, always make sure to include the "multipart"option in the <form>tag:
<form action="http://127.0.0.1:8080/myaction" method="POST" enctype="multipart/form-data">
Otherwise, file attachments will not be received, only their file names.
l The Mime Type option is better left at Auto-Detect unless the process requires it to be forced to a specific type. This
means that if a process can either return a PDF when successeful or an HTMLpage with an error message, it will not
attempt to send an HTML with a PDFmime type (which, obviously, would cause confusion).
l There is no HTTPServer Output task (see below on how to end your process)
Request/Process/Response cycle
Once a process using the HTTPServer Input task is created, it is important to understand the cycle that is triggered when such
a process runs. Note that this is the process when the default HTTPServer Input task options are used (more on how that
behavior changes later):
1. A request is received by the HTTPservice.
2. This request is converted into an XMLrequest file along with one or more attachements when present.
3. The XMLrequest file and attachments are saved in a local folder, if the HTTPAction is a valid one (otherwise, the files
are deleted).
4. The HTTPservice keeps the request from the client open (it does not yet respond ot it), and waits.
5. The HTTPprocess corresponding to the HTTPAction captures the XMLfile and attachments and the process begins.
6. The process runs its course just like any other process would (including subprocesses, send to process, etc).
7. The very last file that is active when the process finishes is then returned to the HTTPservice.
8. The HTTPservice returns the file to the client and then closes the connection.
9. If, during this time, the timeout has expired (if the process takes more than 120 seconds), the HTTPservice returns a
"timeout"to the client, but the process stills finishes on its own. When the process finishes, the return file is ignored by
the HTTPservice.
Point 7 is critical to understand, as it has an impact on what the client receives. If a process receives a file that is split into mul-
tiple parts and each of these parts generates and output, the last split's output will be sent to the client. If the last output task
generates a PostScript file for printing, this PostScript is returned to the client.
In most cases, what is returned is what remains after the last task, but only if this task's processing is done in PlanetPress
Worfklow. For example, if the data file is a text file and this file is sent to PlanetPress Imaging using the Image connector, it is
a text file that is returned, not the output of the Imaging. Similarly, ending a process with the Delete task does not return an
empty file, it returns the actual data file.
Special Workflow Types