User Guide Version: 8.4.
User Guide Version 8.4.1 Last Revision: 2016-07-12 Objectif Lune, Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 +1 (514) 875-5863 www.objectiflune.com All trademarks displayed are the property of their respective owners. © Objectif Lune, Inc. 1994-2016. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc. Inc. Objectif Lune Inc. Inc.
Table of Contents Table of Contents 4 Welcome to PlanetPress Workflow 8.4.
About Printing 56 About Processes and Subprocesses 67 Using Scripts 77 Special Workflow Types 105 About Tasks 150 Task Properties 151 Working With Variables 468 About Configurations 477 About Related Programs and Services 481 The Interface 485 Customizing the Workspace 486 PlanetPress Workflow Button 495 The Configuration Components Pane 496 Other Dialogs 521 The Debug Information Pane 542 The Message Area Pane 543 The Object Inspector Pane 544 The Plug-in Bar 545 Prefere
The Process Area 583 The Quick Access Toolbar 594 The PlanetPress Workflow Ribbon 595 The Task Comments Pane 597 Copyright Information 598 Legal Notices and Acknowledgements 599 Page 6
Welcome to PlanetPress Workflow 8.4.1 This PDF documentation covers version 8.4.1. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow is the heart of all of our solutions. Working in conjunction with PlanetPress Connect, PlanetPress Capture, CaptureOnTheGO, PlanetPress Imaging, PlanetPress Fax, and a variety of plug-ins, it helps improve your communications processes.
Technical Information that may require specific knowledge to understand. Warning Information that is potentially critical to using PlanetPress Workflow. Pay close attention.
Basics PlanetPress Workflow is a tool for the automation of the processing, the distribution and the printing of your business documents. Once installed on the server, it can be set up to automate all tasks related to document processing. Setting Up the Working Environment Setting up the working environment has to be done the first time you start PlanetPress Workflow. 1. Defining the printer (see Activate Your Printers). 2. Configure PlanetPress Workflow Services (see Workflow Services).
To add a PlanetPress Workflow startup process: l l In the Ribbon, go to the Home tab and click the Startup Process button in the Processes group. In the Configuration Components pane, right-click on any process or the Processes folder and select Insert Startup Process. Note You can only have one Startup Process in any given configuration and cannot add more.
If PlanetPress Workflow service is running when you send a new configuration, it stops and restarts automatically with the new configuration. If the service is stopped, it will not start automatically. To send a Configuration to the local server: 1. Open the configuration you want to use as a new configuration. 2. Edit the configuration, if required. 3. When the configuration is ready to be used, from the PlanetPress Workflow button, choose Send Configuration, then Send Local.
Features PlanetPress Workflow are input driven applications designed to output data in a variety of ways through diverse means to various applications and devices. PlanetPress Workflowcan be used as simple go between, passing along input data to output devices, but it can also perform various types of data processing. You can combine the various PlanetPress Workflow services to set up versatile automated processes to print jobs as well as generate other types of output.
Branches A branch is effectively a doubling of your job file. As your job file goes down the process, when it encounters a branch it will go in that branch, process all tasks up to the output, and return to the main trunk to continue processes. You can have branches within branches, and all branches must have an output. For more information on branches, see Branch. A branch is represented as a crossing . Conditions A condition will either execute the branch it creates or the main trunk, but never both.
Available Resources l Data Mapping Configurations: Displays a list of data mapping configurations used with the Execute Data Mapping task. Each of the templates have been sent from PlanetPress Connect using the Send to Workflow tool. For each template in the list, the following two items appear within them: l l l l l Data Model: Displays the data model used in the data mapping configuration. Double-click on the data model to view it in your default XML viewer (generally, Internet Explorer).
Resource Archives From version 8.2, PlanetPress Workflow maintains an archive of previous versions of resources, in the following location: %PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\OLConnect\Archive , each in their own folder: l l l l l datamapper contains archives of the data mapping configurations (.OL-datamapper) jobcreation contains archives of the Job Presets (.OL-jobpreset) outputcreation contains archives of the Output Presets (.
PlanetPress Workflow Configuration program, and that they may also be printed differently by different printers. To ensure consistency, you should consider filtering out such characters. Data File and Job File Whichever source it may come from, a serial port, an e-mail message, or an LPR request, for instance, and whatever its format, data entering a PlanetPress Workflow process via an input task is always referred to as a data file.
Job File Names and Output File Names When an input task sends a new data file down a process, it gives it an internal file name referred to as the job file name (associated with the %f variable). The new job file typically keeps the same name until the end of the process. l l If the job file comes to a branch in the process, PlanetPress Workflow makes a copy of the job file and give the new file a new job file name.
Invoice2. Note that this does not apply to multiple TIFFs, which can include multiple images in a single file. Note You can change the name of a previously named file using a Rename action task (see "Rename" on page 252). About Data Selections A data selection could be compared to an address. It indicates a location within a data file using coordinates. PlanetPress Workflow includes a tool called the Data Selector that helps you make data selections.
Note It is strongly recommended to use the automatic method, as it returns precisely the same selections but is generally more reliable Text-Based Data Selections These selections are used for text data files such as Line Printer, ASCII and Channel Skip emulations. The selection refers to a rectangular selection that may contain multiple lines, rows, columns on a given page.
The alternate "quick" syntax lets you grab data from a single line from the first data page in the file. Here is a breakdown of the syntax (all options are mandatory): l l l l @(): Always surrounds a data selection. Line Number: The line from which to get the data. From Column: the leftmost character position of the data selection. To Column: the rightmost character position of the data selection.
Here is a breakdown of the syntax (all options are mandatory): l l l l l l l region(): Always surrounds PDF data selections. Page: The page of the PDF from which to retreive the data. Left: Exact horizontal position (in inches) that defines the left of the selection region. Top: Exact vertical position (in inches) that defines the top of the selection region. Right: Exact horizontal position (in inches) that defines the right of the selection region.
Name Value Behavior NoCascade 2 Search only the level specified by the path argument (defaults to Page level when path argument is empty), instead of default behavior, going from the Page level to the Job level. FailIfNotFound 4 Raise an error and crash the job is the specified name is not found instead of returning an empty string. SelectedNodesOnly 8 Returns values from the selected nodes only.
Depending on the chosen emulation and data file, the options in the data selector, the Sample data file section and the Data pane itself may change to accommodate your choice. The Line Printer, Ascii, Channel Skip and User-Defined emulations will display the default options (see the Emulation section) and a grid-like display of each character on each line. The following emulations however, will be slightly different.
the database. Each column represents a field returned by the query, with its field name as a row header. XML Emulation l XML data is represented in a tree structure which corresponds to the data in the XML file. Each node of the XML can be expanded to see the nodes under it. See XML Data Emulations. PDF Emulation l l l If you use a PDF emulation, the Data pane displays the data as you would see it in any PDF reader.
Metadata tab The Metadata tab allows users to either generate the metadata file for their active sample data file, or to associate an existing metadata file to their document. The Sample Metadata file name is the path to the metadata file describing the current sample data file. Buttons on the right can be used to load metadata from a file or to save the current metadata to a file.
l l Search from a specific location only. Search from level X to Job, where X can be any metadata level (Job, Group, Document, Datapage, Page). With this search option, if the selected metadata element does not exist at the specified level, then it will be searched for, starting at the lowest metadata level as specified in the search option, then one level up until the element is found.
Connect documents use their own emulations, as defined in the document itself from PlanetPress Connect. Emulations in PlanetPress Workflow: l l l l l l l Line Printer ASCII CSV Channel Skip Database XML PDF Warning PDF Emulation, also called Document Input, is only available in PlanetPress Workflow. For more information about each emulation and how to use them, please refer to PlanetPress Connect User Guide.
PlanetPress Connect documents. It is an important section which you should fully understand before you start creating your configuration. Also included in this section are procedures that let you make data selections as well as get data from the sample data file.
PlanetPress Workflow also keeps the last 9 used data files in memory, which you can reopen to use in the same process, or a different one. To reopen a sample data file used previously: 1. 2. 3. 4. 5. Click the Debug tab in the PlanetPress Workflow Ribbon. Click on Reopen Data File in the Data group. Click on one of the data files in the list. Use the Data Selector to change the emulation options if necessary. Click OK on the Data Selector.
l l l Document: group of 1 or more ordered datapages intended to the same recipient from the same source (ex: invoice). Group: a logical and ordered group of documents (ex: all invoices for a specific customer number; all documents going to the same address, etc.) Job: file that contains 1 or more groups. When Metadata is produced for a given job, a hierarchical (i.e. tree-like) structure is created, composed of the above elements in the following order: Job->Group(s)->Document(s)>Datapage(s)->Page(s).
A single JOB can be composed of GROUPS of DOCUMENTS, which themselves are composed of physical PAGES produced by executing a PlanetPress Connect document on one or more DATAPAGES. Metadata Elements Each metadata node (i.e. Job, Group, Document, etc.) is described with a series of elements, that is, system-defined attributes or user-defined fields holding static or dynamic information about the node they are attached to. Each element has a name and a value.
l physical page) or evaluated on-the-fly (e.g. the number of documents in a group). Attributes are non-repetitive (i.e. name is unique) and does not persist through metadata recreation. Field: A read-write, user-defined element which hold custom information about a certain node from the metadata structure. Fields are repetitive (i.e. the same field may appear multiple times) and persist through metadata recreation.
Attribute Description Categor y J o b Gro up Docum ent Name of the character encoding. on DataFile (optional) Path and name of the data file used by the PlanetPress Design Document. Producti on X X X Date Date the metadata was created in ISO format. Producti on X X X Time Time the metadata was created in ISO format. Producti on X X X Title Title of the source document. Producti on X X X Producer Name of the software that created the metadata.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge created the source of the metadata. TargetDevice Name of the device for which the metadata and associated data is intended. Producti on X X X Dimension Two floats separated by a colon indicating the media size in typographical points (ex: 612:792). Finishin g X X X X X Orientation "Rotate0", "Rotate90", "Rotate180" or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Side "Front" or "Back"; indicate whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent. Finishin g Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicate a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedepedent color of the media. Finishin g X X X X X MediaType Devicedependent type of the media. Finishin g X X X X X X X X X X X X X Index Index/C ount IndexInDocument Returns the Absolute index of the node within all the node under the parent Document.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge X X X X X X X parent Group. IndexInJob Returns the Absolute index of the node within all the node under the parent Job.
Attribute Description Categor y SelectedIndexInDo cument Returns the Absolute index of the node within all the selected node under the parent Document. Index/C ount SelectedIndexInGr oup Returns the Absolute index of the node within all the selected node under the parent Group. Index/C ount SelectedIndexInJo b Returns the Absolute index of the node within all the selected node under the parent Job.
Attribute Description Categor y J o b Producti on X Gro up Docum ent Datap age Pa ge a Windows driver. Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input. Metadata Tools PlanetPress Workflow includes a complete set of metadata-related functionality, which can be referred to as Metadata Tools.
PlanetPress Workflow can capture the incoming stream and convert it internally into a PDF file along with its metadata. By default, capturing a document input using a PlanetPress Printer will generate a PDF along with its metadata. Metadata Generation and Refresh without using PlanetPressPrinter It is possible to generate or refresh metadata for any given sample datafile by using the Refresh Metadata option available when right-clicking on the Metadata Fields folder found in the Document Structure Window.
The Metadata Selector allows to view and select metadata elements.
Metadata tab in the properties of a PlanetPress Workflow document allows to easily define documents or groups. Metadata Fields Metadata Fields in the properties of a PlanetPress Workflow document allows to easily define documents or groups. About Documents A Document is a file sent to PlanetPress Workflow by PlanetPress Connect and is used to produce an output when merged with data. A Document can be an invoice, a report, a receipt or anything else, but by itself it is empty and without any variable data.
Import Documents This procedure describes how to import variable content documents created in PlanetPress Connect. Importing documents can be useful when transferring configurations between PlanetPress Workflow installations. To import documents into PlanetPress Workflow: 1. Choose File | Import Documents. The Import PlanetPress Connect Document dialog box appears. 2. In the File type box, select the desired file type. 3. Navigate to the document you want to import, select it and click Open.
from the PlanetPress Workflow Configuration Tool, in order to detect and resolve issues with your process. Error Handling, on the other hand, occurs when your configuration has been sent to PlanetPress Workflow services, and are running in "production" mode. On one hand the manual task is critical when creating a process, on the other the automated handling of errors within your processes will have a large impact on recovering from errors as they happen during production.
ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Creating and Using Error Processes An Error Process is a special type of process that never runs on its own, and cannot be called using the GoSub or Send to Process tasks.
Accessing the Logs If your process is running live in PlanetPress Workflow service, you have two ways of seeing what is happening, now or in the past. To view what processes are running and processing data as it happens: 1. In the PlanetPress Workflow Ribbon, click on the Tools tab, then select Service Console in the Services group. The PlanetPress Workflow Service Console opens. 2.
1. From PlanetPress Workflow Configuration software, press CTRL+SHIFT+ALT+F4 simultaneously. The PlanetPress Workflow working folders are opened. 2. Double-click on the folder called Log. 3. There are multiple logs displayed here, including: l l ppwYYYYMMDD.log - PlanetPress Workflow logs, including the year, month and day of the log (from midnight to midnight). FTP, LPD, LPR, ??? (to be verified) Note The PlanetPress Image and PlanetPress Fax logs are available in different folders.
The numbers on the left indicate the task index, the folder capture being level 1 and the Text condition being on level 4. To resubmit backed up input data files: 1. In the PlanetPress Workflow Ribbon, go to the Tools tab then click Resubmit Job in the Services group. The File Resubmission dialog box is displayed. 2. From the Process box, select the process for which you want to resubmit the backed up input files. 3. From the Task index box, select the index level to which you want the data to be sent.
Warning The From page and To page boxes are only useful for printer queue (or printer capture) inputs. They will not function for other types of inputs. In these cases, the complete backup job is submitted. Knowing What to Resubmit When something goes wrong with an output job, a print job for instance, and printouts are lost, you usually need to know the following information in order to resubmit the input: l l The name of the job. This refers to the name used internally by PlanetPress Workflow.
Debugging your PlanetPress Workflow Process Debugging a process is separated in two parts. The first part is designing the process, which is to add the different tasks, branches and conditions to the process and configuring them. The second step is testing whether or not the process and configuration actually work. Before debugging begins, the following prerequisites must be completed: l l There must not be any Unknown Tasks in the process. A sample data file must be selected.
information on how to capture your sample data file properly, please refer to the PlanetPress Trigger and Data Capture Guide. Debugging can be run in different ways: l l l From the Debug tab, click on Step. This executes only the first task in the process and waits for further action. From the Debug tab, click on Run. This executes the complete process, step by step, until it is completed. Right-click on any task in the process and click Run from Here or Step from Here.
l l Look at the Messages Area pane to see any message generated by the tasks that run (See " The Message Area Pane" on page 543). Use the Debug Information pane to see the current value of any variable in your process or globally, or to evaluate custom expression. See "The Debug Information Pane" on page 542.
l Instead of skipping through each task, use the Run from here or Step from here options, either from the Debug tab or by right-clicking on the task where you want to start the process. Once you have created and fully debugged all your processes, you will be ready to send it to PlanetPress Workflow service. See "Saving and Sending" on page 478.
Note An Uncategorized category is dynamically created if your PlanetPress Workflow finds any plug-in that would not be part of the existing Plug-in bar. User-defined plug-ins and third party application plug-ins falls into such a category. Settings & Customization The Plug-in bar can be customized according to your needs and the plug-ins you most frequently used.
About Printing To print a document using PlanetPress Workflow, you can either use the Print using a Windows Driver output task, or use a combination of a printer queue and a Printer Queue output task. These tasks are created and defined using PlanetPress Workflow Configuration program. The following types of printer outputs are available in PlanetPress Workflow Configuration program: l Local printing: l l l Remote printing: l l l Windows output queues let you send jobs to a local printer.
l l l A file that contains the data and the document to the selected printer queue. Since the data and the document with which it must be merged are both sent to the printer, printing should never fail. In both cases, the document+data merging process takes place inside the printer. Send output data already merged with a document: PlanetPress Workflow sends a file that contains the document already merged with the data to the selected printer queue.
To send print jobs to any of those PlanetPress Workflow printer queues, you must use a Printer Queue output task. Note that with a single task, you can send print jobs to multiple printer queues, regardless queue types. Shared Printer Queue Properties A printer queue’s advanced properties includes the printer’s speed and any special pre- or post-job commands required for printer specific reasons.
Character name: Character code: Typical use in printing context: Horizontal Tab \t Adds a horizontal tab Line Feed \012 Moves to the next line Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape character New Line (CRLF) \n Goes to a new line Windows Output Printer Queue Windows output printer queues send print jobs to local or network pr
l Job owner name: Enter the job owner name. You may use a PlanetPress Workflow variable. The field is empty by default, which is equivalent to use the default print job owner name, i.e. the current logged in user name. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing.
l l data in the TeX DVI format. Select (o) PostScript file if the job file is a PostScript file. Select (n) Ditroff format if the job file contains data in device independent troff. Select (t) Troff format if the job file contains data in troff. Select (v) Sun raster file if the job file contains raster images. This ensures that the printer uses the correct filter to interpret the data. Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used.
FTP Output Printer Queue Unlike FTP output tasks, which are typically used to send data files to FTP sites, FTP output printer queues are mostly used to send print jobs to FTP sites. FTP output printer queue properties are as follows: General tab l l l l l l l l FTP Server: Enter the IP address or host name of the FTP server. User name: Enter an FTP server user name. Password: Enter a password associated with the FTP server user name entered above.
l l l l Add: Click to add a new command to the list displayed in the Commands box. You must then edit the new command’s description and value. Note that new commands are shared by all printer queues. Delete: Click to remove a command from the Commands box. Command description: Use this box to edit the description of the command currently selected in the Commands box. Command value: Use this box to edit the code of the command currently selected in the Commands box.
l l l l Add: Click to add a new command to the list displayed in the Commands box. You must then edit the new command’s description and value. Note that new commands are shared by all printer queues. Delete: Click to remove a command from the Commands box. Command description: Use this box to edit the description of the command currently selected in the Commands box. Command value: Use this box to edit the code of the command currently selected in the Commands box.
In the General tab of the Printer Queue Output Properties dialog box, you may select multiple printers, and in the Advanced tab, you can set the load balancing options for the selected printers. Objectif Lune Printer Driver (PS) Introduction The Objectif Lune Printer Driver (PS) allows end-users to print directly to PlanetPress Workflow from any Windows application, by using the familiar File|Print option.
Printer Properties setup PlanetPress Workflow WinQueue Input task can be configured to set a Windows printer queue using Objectif Lune Printer Driver (PS) to produce one of 3 different types of data files: EMF, PostScript, or PDF. Note that PlanetPress Workflow can only produce EMF or PostScript files. Possible printer properties settings, along with the data file type it will produce: Spool Print Jobs in EMF Format: l l l This will create an EMF data file.
5. 6. 7. 8. 9. 10. Click OK. Send the configuration and start your PlanetPress Workflow service. Start the windows application from which you want to capture data. Open your selected document. Click File | Print. Choose the same Windows print queue as in step 4. Note Steps 6-8 can be performed at any time, even if PlanetPress Workflow is not yet started. This is because every Windows printer queue using Objectif Lune Printer Driver (PS) is paused by default.
tasks. In its simplest form, a process can simply retrieve data from a given folder and save it in a different folder. In most cases, though, processes are more elaborate and configurations, which may include many processes, can be extremely complex. The available processes in your PlanetPress Workflow Configuration are listed in the "The Configuration Components Pane" on page 496. Processes in a configuration will always run concurrently.
feature is synchronous with the main process. This also means the calling process actually appends the subprocess to its own workflow. Process Properties To have access to the properties of a process or subprocess: l l Right-Click on the Process in the Configuration Components Area. Select Properties. You can also double-click on the process to show its options. Note Subprocesses do not have the "General Tab" which is only used for scheduling, but they do have the Information Tab.
l l l l Day(s) to keep backup: Indicate the number of days to keep backups of jobs processed by input tasks. Note that backups will only be kept for those input tasks that have the Keep backup file option selected and that they are required to resubmit input files. Polling interval: Enter the frequency (in seconds) at which the process should verify if there are new jobs to process. The polling interval also applies to scheduled tasks that only run on certain times.
In the Time Grid, a blue block will indicate that the process is active within that time block. While blocks mean the process will not be active. l l Click on any block to select / deselect it. Click and drag from one block to another to toggle all blocks between the two.
l l l l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click. To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler.
Activate or Deactivate a Process All processes are Active by default, but you may make any PlanetPress Workflow process Inactive as required. Because making a process active or inactive is a change in the configuration, to make the change effective you will have to send the edited configuration to your PlanetPress Workflow service (See "Send your Configuration" on page 10). To activate or deactivate a process: 1. Right-click the process in question in the Configuration Components pane 2.
If any task converted into a subprocess was previously using local variables, these variables must be removed or transferred to global variables or job information to be usable in the newly created subprocess. Import Processes from Another Configuration File You can import individual processes or groups of processes from a PlanetPress Workflow configuration file without having to import the contents of the entire configuration file.
Important considerations l l When importing a PlanetPress Workflow configuration file, your PlanetPress Connect and PrintShop Mail document are not physically imported as they are not part of the configuration file itself. In order for the documents to be available, you will need to send each document from PlanetPress Connect and PrintShop Mail (see their respective documentation for details).
Using Scripts Scripts can be used to perform various operations, such as to manipulate data, for example. PlanetPress Workflow can perform scripts written in four different scripting languages and also provides an interface for editing scripts. Warning While this chapter provides some very useful and detailed information about scripting within PlanetPress Workflow, its focus is to inform you about the features, variables and functions unique to this environment.
Multiple APIs (methods of communicating with PlanetPress Workflow scripting tools) are available through the scripting engine, in all languages. l l l l l The Watch object is used to communicate with your current process and configuration. See "The Watch Object" on page 90. You can manipulate PDF files using the PlanetPress Alambic API. See AlambicEdit Library Reference. Note that the PlanetPress Alambic API is part of the PDF Tools.
Import and Export Scripts Both the Script Editor and XSLT Editor let you import and export scripts. Note When you import a script, it replaces any script currently displayed in the editor. To import a script: 1. In the editor, choose File | Import. The Open dialog box appears. 2. To import a script that uses a different scripting language or that was saved under a different file format, make a selection in the Files of type drop-down list. 3. Navigate to the script you want to import and select it. 4.
To find strings in a script: Note If you only want to search a particular section of the script, you should select it before performing the following procedure. 1. Choose Search | Find, or press CTRL+F. The Find Text dialog box appears. The last used string is displayed in the Text to find drop-down list box. 2. Set the search settings and options. Text to find: Enter a new search string or select a previous search from the drop-down list.
The first matching string is highlighted in the script. 4. To find the next matching string, choose Search | Find Again or press F3. Find and Replace Strings in a Script The Replace With dialog box lets you search for and replace text strings in the editor. The available options help you limit the search, making replacements quicker and easier. To find and replace strings in a script: 1. Choose Search | Replace, or press CTRL+R. The Replace With dialog box appears.
From cursor: Select to start the search from the position of the cursor. Entire scope: Select to search either the entire script, or a script selection. The scope corresponds to a script selection if you make a selection before executing the Find. 3. Do one of the following: l l Click OK to replace the first string encountered. If you selected Prompt on replace, a dialog box opens to ask you whether to proceed with the replacement.
Note Bookmarks are not preserved when you close the editor. To toggle bookmarks: l Place the cursor on a line in your script and, from the editor’s pop-up menu, choose Toggle Bookmark and a given bookmark number. If the bookmark you selected was not displayed on any line, it is added to the line where you placed the cursor. If the bookmark you selected was displayed on the line where you placed the cursor, it is removed.
Note PlanetPress Workflow already come with a SOAP Client Plug-in, which can be used as an input, action or output; this task was renamed Legacy SOAP Client. Since the SOAP Server API Reference is primarily targeted at programmers or systems engineers, it is rather technical.
l 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 of the PlanetPress Workflow process (for instance, if the process creates a PDF and sets it as the current job file, the PDF is the file that gets returned to the calling SOAP client).
l l l PostJobInfStruc – Structure containing any required information to prepare the file for resubmission into a PlanetPress Workflow process. user name – String containing the user name. Password – String containing the password. This value is case sensitive. Return Value l l l l PostjobResult - Structure containing the following information: Success – Integer indicating the Success/Error level of the operation. A result of 0 means that the operation was successful.
Return Value l l l l l l GetProcessListResult - Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. Message – String containing text information about the Success status. ProcessList – Structure containing the following information details. ProcessName – String containing the process name Active – Boolean value specifying whether the process is currently active.
l l l TaskName – String containing the name of the task TaskIndex – Integer : 1 based index of the task. TaskDepth – Integer : 1 based depth of the task. Note The TaskNames array will be sorted by the execution order of the process with the primary input of the process having an index of 1.
Note If a user has administrator privilege, he will have access to all processes and therefore he will see all the processes. SOAP API - PostJobInfoStruc PostJobInfStruc Structure containing any required information to prepare the file for resubmission into a PlanetPress Workflow process. l l l l l VariableList – Array of complex type, containing pairs of variable names and variables value. The list also contains the JobInfo variables.
l OAPActionName – String containing the name of the Input SOAP task’s action name. The Watch Object PlanetPress Workflow scripting offers a number of methods of communicating with your process by means of PlanetPress Workflow automation object's methods and functions. The automation object is available in all 4 languages through their own syntax - the examples provided here are for VBScript.
Variable Name Description Example Usage (VBScript) Example Usage: str = Watch.getmetadatafilename "Watch.GetJobInfo" on page 97 Retrieves the content of a numbered job info (%1 to %9). Example Usage: str = Watch.getjobinfo(9) "Watch.GetVariable" on page 98 Retrieves the content of a local or global variable by name. Example Usage: str = Watch.getvariable("Varname") "Watch.
Variable Name Description Example Usage (VBScript) Example Usage: Watch.setjobinfo 9, "String" "Watch.SetVariable" on page 99 Writes the value of a string to a local or global variable by name. Example Usage: Watch.setvariable "global.GlobalVar", "Hello World!" "Watch.Sleep" on page 102 Pauses all processing for X milliseconds. Example Usage: Watch.sleep(1000) "Watch.ExecuteExternalProgram" on the next page Calls and executes an external program in the command line. Example Usage: Watch.
Examples In the following example, showmessage() displays a dialog box saying “test message”. VBScript Watch.ShowMessage("test message") JavaScript Watch.ShowMessage("test message"); Python Watch.ShowMessage("test message") Perl $Watch->ShowMessage("test message"); Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line. The program's execution will be directed by the appropriate flags specified as this method's parameters. Syntax Watch.
Flag Effect 2 Display the window minimized. 3 Display the window maximized. 4 Makes the window visible and brings it to the top, but does not make it the active window. WaitForTerminate: A boolean value that, if true, pauses the script until the command line has been fully executed. Examples VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true JavaScript Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); Pytho
VBScript Dim s s = Watch.GetJobFileName Watch.Log "The job filename is: " + s, 3 JavaScript var s; s = Watch.GetJobFilename(); Watch.Log("The job filename is: " + s, 3); Python s = Watch.GetJobFileName() Watch.Log("The job filename is: " + s, 3) Perl $s = $Watch->GetJobFileName; $Watch->Log("The job filename is: " + $s, 3); Watch.GetOriginalFileName Returns the original name of the file, when it was captured. This method is the same as PW_ GetOriginalFileName. Example VBScript Watch.
Example VBScript Watch.GetMetadataFileName JavaScript Watch.GetMetadataFileName(); Python Watch.GetMetadataFileName() Perl $Watch->GetMetadataFileName(); Watch.InputBox Warning Starting version 7.0, the Watch.InputBox function is deprecated and may no longer work due to changes in the way in which the Watch Service functions. This function is completely disabled in PlanetPress Workflow 7.3 and higher. Prompts the user to enter a string. The string is displayed as the window caption.
Examples In the following example,Watch.InputBox requires the user to enter a line of text. The script the displays a pop-up of the message contents using "Watch.ShowMessage" on page 92. VBScript s = Watch.InputBox("Your Name", "Please enter your name", "John Doe") Watch.ShowMessage("Will the real " + s + " please stand up?") JavaScript s = Watch.InputBox("Your Name", "Please enter your name", "John Doe"); Watch.ShowMessage("Will the real " + s + " please stand up?"); Python s = Watch.
Python s = Watch.GetJobInfo(3) Watch.Log("Jobinfo 3's value is: " + s, 2) Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("Jobinfo 3's value is: " . $s, 2); Watch.SetJobInfo Sets the job information index to a specified string value. Syntax Watch.SetJobInfo(Index: Integer; Value: String) Example VBScript Watch.SetJobInfo 3, "Job info 3 Value" JavaScript Watch.SetJobInfo(3, "Job info 3 Value"); Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.
Example VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.Log "MyVariable's value is: " + s, 2 s = Watch.GetVariable("global.MyVariable") Watch.Log "global.MyVariable's value is: " + s, 2 JavaScript var s; s = Watch.GetVariable("MyVariable"); Watch.Log("MyVariable's value is: " + s, 2); s = Watch.GetVariable("global.MyVariable"); Watch.Log("Jobinfo 3's value is: " + s, 2); Python s = Watch.GetVariable("MyVariable") Watch.Log("global.
Python Watch.SetVariable("MyVariable", "Desired value") Watch.SetVariable("global.MyVariable", "Desired value") Perl $Watch->SetVariable("MyVariable", "Desired value"); $Watch->SetVariable("global.MyVariable", "Desired value"); Watch.ExpandString Provides access to the emulated job file and to all variables. This function returns a string that is the expanded version of the input string. Syntax Watch.
Perl $s = $Watch->ExpandString("%y-%m-%d"); $Watch->Log("Current Date is: " . $s,2); Watch.Log Creates messages that are added to PlanetPress Workflowwatch.log file. PlanetPress Workflow watch.log file is located in ...\Program Files\PlanetPress Workflow 7\PlanetPress Watch\Log\ppw[log date].log. View error messages in the Services Console while PlanetPress Workflow is in Run mode by choosing Tools | Services | Service Console.
Level Description 3 The message is logged as Information in the log file. 4 The message only appears when the application runs in Debug mode. Examples In the following example, log() will write an information entry in the watch log that says "this is a log" VBScript Watch.Log "this is a log", 3 JavaScript Watch.Log("this is a log", 3); Python Watch.Log("this is a log",3) Perl $Watch->Log("this is a log",3); Watch.Sleep Pauses the process for the specified number of milliseconds.
Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.ReturnValue Set this variable to 1 (true) or 0 (false) in order to return a true or false status to PlanetPress Workflow, when using your script as a conditional branch. This variable will have no effect if the script is run as an action. Example This example will always return true, as the condition is static. It is, after all, simply an example. You get the idea. VBScript Dim everythingOK everythingOK = true if (everythingOK = true) then Script.
Perl $everythingOK = true; if (everythingOK = true) { $Script->{ReturnValue} = 1; } else { $Script->{ReturnValue} = 0; } Stopping Execution When using a script, you may come to a point where you'd like the task to fail (raise an error) and trigger your On Error tab under certain conditions. This can be done by using the scripting language's built-in error features, described here. Note that the value or description of the error will not be available to your error process if one is used.
throw "Value Cannot be empty"; } else { // Do something with Job Info 9! Watch.Log("Job Info 9's value is: " + s,4); } Python In Python, the raise statement is similar to JavaScript and will stop processing unless an except statement is used. See the python documentation. s = Watch.GetJobInfo(9) if not s: raise NameError('Value cannot be empty') else: # Do something with Job Info 9! Watch.
Special Workflows PDF Workflow A PDF workflow uses a PDF as it's job file and manipulations are generally made in the Metadata instead of the PDF itself, since PDF files are much larger than most other data files compatible with PlanetPress Suite. The Metadata Tools are extensively used in the example presented, which is a weekly sales report sent to all the sales associates of a particular company branch. See the "PDF Workflow" on page 147 for more details.
Warning There are important considerations to keep in mind when dealing with PlanetPress Capture. Please review them in "PlanetPress Capture Implementation Restrictions" on page 122. In order to properly build a PlanetPress Capture workflow, it is very important to understand the terminology, implications and limitations of the technology.
Capturing and Archiving After the printed documents have been inked with the Anoto Digital Pen, the PGC files from the pen must be processed and merged with the appropriate documents in the PlanetPress Capture Database. A workflow process that receives PGC files and reads them in turn consists of the following actions: l l l l l An "HTTP Server Input" on page 176 task or "Folder Capture" on page 164 task that receives the PGC.
the ink data as an EPS layer. This is useful when, for example, data is received for a document that's already been closed. l l l The "Input Error Bin" on page 181 input task is triggered when the process sends data to the error process. A "PGC to PDF Converter" on page 386 task converts the PGC to a PDF Any existing output is used here, for example an email notification.
Capture Condition PlanetPress Workflow task that is used for post-processing of documents after they have been processed by the Capture Fields Processor. Conditions can be made on the document status or the presence (or absence) of ink on any of the Capture Fields on the document. Capture-Ready Document A PlanetPress Connect document (*.pp7) that contains at least one Capture Field on at least one page.
ICR (Intelligent Character Recognition) Recognizing text that has been hand-written with the Anoto Digital Pen. This feature is currently not implemented in PlanetPress Capture, but will be in the (near) future. Ink Data The pen stroke information contained within the PGC file. This is the actual data applied to the document (lines, signatures, text, etc).
Pidget Type of PlanetPress Capture object. Page element used to give instructions to the Anoto pen, as opposed to recording ink. PlanetPress Capture Database A database containing the list of patterns, sequences, registered pens and documents. The Capture Database can be used by a single server, or by multiple servers in a Client/Server architecture. Session The time spent by the pen between events that trigger a new session.
The following considerations should be kept in mind while working with ODBC Databases in PlanetPress Suite. l All databases l l l l l l Microsoft Access l l l l l Database file (mdb) must be local to the PlanetPress Workflow computer. It cannot be located on a network drive or another server. Total database size is limited to 4GB of data. Total size of a single table is 2GB. May be unstable in large implementations.
l When configuring the ODBC connection, your must use the Microsoft version of the driver, and not the Native SQL version of the driver. This is due to a technical limitation of the native driver that interferes with the PlanetPress Suite database requests.
This means the security that is implemented both on your network and physical premises are critical to the security of your PlanetPress Workflow implementation. Here are a few notable points with the security of PlanetPress Capture on a network: l l l l l PGC Files, while not written in plain text, are not encrypted and are readable through either PlanetPress Workflow (even a server that did not generate the document associated with it), or through third-party applications using the Anoto SDK.
explain how the 20,000 patterns limitation can be circumvented in some cases. We will also touch upon the potential pitfalls of these workarounds as they are used. The Numbers First and foremost, the 20,000 patterns is a fixed number - PlanetPress can only generate 20,000 unique patterns as this is the number of patterns that we license through Anoto. The 20,000 patterns are, however, not all available when generating documents.
Example Say you print 19,000 pages containing a pattern, every day. You may think you'll "run out of patterns" after a single day. But if 18,900 of these documents are being written to and processed within the day, at the end of the day you only have a 100 page difference, possibly due to mistakes, lost pages, or errors during processing. In this specific example, you would run out of patterns only after 10 days, assuming the numbers remained completely static.
Pattern Sequences can be handled in 2 different ways: by attaching a Pattern Sequence to a specific pen, or by attaching it to a specific PlanetPress Workflow process. Here is an example for each cases, using a typical situation of a shipping company that uses PlanetPress Capture to simplify the archiving of the client's signature on a "Confirmation of Reception" slip. l Pen-Based Sequences: In this case, each pen is attributed a specific pattern sequence.
Contamination The single but critical danger with any implementation that deals with PlanetPress Capture is "Contamination". Basically, contamination happens when an Anoto Digital Pen writes on a "wrong" document or is docked in the wrong location. This can happen any number of ways and in different situations, and can have devastating effects in some of those cases so please pay special attention to this section.
processed - this often works with no error. However, when the "right" data is processed, then it tries to update a document that has already been closed by the "wrong" data, and thus fails. Safeguards There are certain safeguards against contamination: l l PlanetPress Capture checks for pattern size and placement. If the data contains ink for a specific pattern but the ink location does not correspond to the Capture Fields of the document it's updating, it will fail.
To configure this communication: 1. Open penDirector setup by right-clicking on its icon in the Windows System Tray, and selecting penDispatcher. 2. Double-click on the PlanetPress Capture entry. 3. Change the PGC Storage folder or PGC POST URL settings to your liking. 4. Click OK, then OK again. The PGC POST URL should correspond to your server name or IP, Port and the HTTP Action task of your HTTP Input, if that is what you are using. Example: http://127.0.0.
preview patter, or the special registration pattern, using Bluetooth connectivity. To use the preview Pattern in PlanetPress Connect or use the special registration pattern, the pen's docking station must be used. To specify where to send the PGC files received through Bluetooth: 1. 2. 3. 4. 5. 6. 7. Open penDirector.
this is not recommended. A color laser printer should be used, and any elements placed close to, or on top of, the Capture Patterns should be printed in color. Black ink can be simulated using composite colors, but should never be pure black. Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper.
the pen can only recognize a single dot within that pattern, at the top of the field. This is because the pen's camera (which captures the position of the pen) is located under the pen tip and must fully see the pattern.
Knowing this, the best practice when creating fields is that they have, at the very least, a 7mm margin on each size of the actual area you want to capture from. For example, an effective 30mm wide pattern will actually be 44mm wide using these margins. The margin should be for both the vertical size and the horizontal size.
the next field. This can cause PlanetPress Capture to detect the ink as being present, and thus trigger whatever that field does. PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition".
components are required in order for the ICR to work: l l l l In PlanetPress Connect, a Capture Field Object must be added and the Perform ICR option must be activated (See the Capture Field page in the PlanetPress Connect User Guide). This must be either a Multi-Area Field or a Text Field. The Capture Fields Processor must have the Perform ICR Recognition option checked, and language needs to be selected. Once the ICR data is available, do something with it.
l l ICR Confidence: A percentage value that the ICR engine gives to any specific value, when comparing the pen data with it's character database. ICR Resemblance: A percentage value that defines how closely the value resembles the "average" character shape. Both the Confidence and Resemblance can be used together to make an informed decision on the contents received by ICR. PlanetPress Capture ICR Best Practices The latest version of PlanetPress Workflow (7.
The following guidelines are applicable when configuring a PlanetPress Capture object that utilizes ICR: l l l l l l l The collected data is expected to be a number, therefore the numeric mask type must be selected, or The collected data is expected to be a letter, therefore the alphabet mask type must be selected, If upper case letters are expected, select Upper case in the Case option menu. The captured characters would be immediately converted to capital letter i.e.
The following diagram illustrates the available mask types. It is recommended to select the mask type that is the closest to the desired result. An alphanumeric field should be used as a last resort. Guidelines for Capture-Ready Fields l l Target: Form designer What: Only one character per Capture field can be recognized. When expecting multiple characters making up a word or phrase, you must make sure that the user only writes one character per field.
Why: To avoid any ink marks that would spill over from one field to another. If both fields A and B are to close in proximity and the ink marks from field A spill over to field B, then the marks captured on field B would be considered as being part of a character written on field B. For example, if a number spills over and is written over two fields like numbers 9, 1 or 7; then the bottom tip of these numbers could be considered as number 1 in the second field.
How: Make sure there’s enough space between each field. You must re-design the document if that’s the case. There’s no minimum value that is required as the distance between 2 fields, except for the 7mm border that is required in order for the Anoto digital pen to recognize the pattern being used. Writing in a Legible Way l l Target: User. What: It is important to write in a legible way i.e. applying yourself by writing well defined numbers and letter that are easily interpreted.
Multiple cultural characters can be interpreted with ICR once the correct language is selected such as û, à, é, etc. How: This option is available from the Capture Fields Processor task.
Possibility of Interpretation Error in an Automated Process l l Target: Workflow designer What: We cannot be 100% sure that a character would be recognized by PlanetPress Capture as it should. Therefore, the analysis of a value interpreted with ICR should only occur if the level of confidence is superior to a determined level. Why: An automated process can treat the characters incorrectly due to an incorrect interpretation of a value. This occurrence should be minimized as much as possible.
l l l l Any input task "Create Metadata" on page 389 "Capture Fields Generator" on page 365 Print output PGC Handling Process The second process is the PGC Handling process. It receives data from the Anoto Digital pen, updates the Capture database and releases patterns as appropriate.
Capture Post Processing Workflow Though the "Basic Functional Capture Workflow" on page 134 is minimal functional one, it will most likely not be enough for most actual implementations. The goal with PlanetPress Capture (and PlanetPress Workflow in general) being to automate as much as possible, there are some tools within the PlanetPress Capture tasks that can greatly help with this goal.
Task Breakdown: l l l The HTTP Server Input receives a POST request sent either by the Anoto penDirector or the PlanetPress Mobile Application. This requests contains information sent by the pen as well as a PGC file as an attachment. Because we're only concerned about the PGC, the task is configured to ignore the XML envelope as well as loop through each attachments (of which there is only one). So, the output of the task is the PGC file alone.
After Retrieving Information from the Capture Database There are two basic ways in which the Find Capture Document task can be used. First, in an automated process that runs at specified intervals. For example, the following process which sends a daily report of all incomplete and "in error" documents to an agent who would presumably take action on each document through the document manager.
Task Breakdown l l The Find Capture Documents task queries the Capture database for documents that correspond to certain specific conditions. For example, here we would look for all documents that are either in an "Error" or a "Partial" state, which means they received ink but are not completed correctly. To do this, the "Content Status" filter and setting it "Equal to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met".
4. Open the configuration file CaptureExampleProcess.pw7 5. Click the PlanetPress Workflow button (File menu) and go in Preferences. 6. In the HTTP Server Input 2 section, check the Serve HTTP resources option, change the Resource action name box to static , and the Resource folder to c:\PlanetPress\http . Then, click OK. 7. Send the configuration to your local PlanetPress Workflow server. 8. Start PlanetPress Workflow services (see "Start and Stop PlanetPress Workflow Service" on page 483). 9.
l l HTML Form Action: An HTML Form in the browser that may contain text and attached files can be filled and sent to a process with the HTTP Server Input task. HTTP Data Submission: A custom application or a server sends the request to PlanetPress Workflow using either a POST or GET command. The application or server then waits for a response from PlanetPress Workflow Tools.
l Serve HTTP resources: This is where you enable static resources in PlanetPress Workflow. When enabling this option, the HTTP server will always look in the Resource Folder for files requested inside of the Resource action name as a folder. This means that, if your Resource folder is c:\PlanetPress\http and your Resource action name is static, pointing your browser to http://127.0.0.1:8080/static/css/style.css will immediately load and return the file c:\PlanetPress\http\css\style.css .
l l l l opening http://127.0.0.1:8080/myaction in your browser. The HTTP service accepts both POST and GET requests. Other than the presence of file attachments, there is little difference in how these are handled. This means that visiting /myaction?id=12345&q=test would be the same as having a form with two fields named, respectively, id and q, and submitting them with the information "12345" and "test".
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 Workflow. For example, if the data file is a text file and this file is sent to PlanetPress Image using the Image connector, it is a text file that is returned, not the output of the Imaging.
Process Illustration Task Breakdown l l l l The HTTP Server Input task receives a request through the /getinvoice HTTP Action. Because this task either returns an HTML page with an error message or a PDF, the MIME type is Auto-Detect. It checks whether the invoice request exists by checking if the size of the file is less than 1kb using "File Size Condition" on page 307. The condition returns "true" if the file is not found: c:\PlanetPress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum[
HTTP Brochure Request This workflow builds on the knowledge acquired in "HTTP PDF Invoice Request" on page 144 and uses a single process, but in this case it also uses a PlanetPress Connect document which merges the data received from a browser form with the document to generate a PDF brochure, which is sent via email. Resources l l HTTPBrochureRequest.pw7 (PlanetPress Workflow Configuration) InformationBrochure.
l Then, we have a small condition that verifies if the user checked the "Newsletter" box. If so, the conditional branch is triggered. Note that this condition is put inside its own branch because otherwise, the rest of the process would not run when the newsletter is selected. Since we want both to happen, the branch is there with a "stub" if the condition is false. PDF Workflow A PDF workflow, in essence, is one that does not contain any PlanetPress Connect document and only uses PDF files as data files.
l l l l l "Create PDF" on page 222 has the option to reset your metadata according to the new PDF file. In reality, Create PDF is one of the most useful tasks in PDF workflows, since it is the easiest way to make your PDF file conform to the metadata without using a PlanetPress Connect document. See the "Create PDF" on page 222 page for more information. "Run Script" on page 313 tasks can also modify metadata using the Metadata API (See "Using Scripts" on page 77).
l l l l l l l l The "Metadata Level Creation" on page 401 creates the Document level of the metadata by placing each PDF data file in its own Document level. It does this by detecting when the Address in the document changes. Then, the "Metadata Fields Management" on page 393 adds a few fields at the Document level in order to properly tag each document with the appropriate information, in this case the Customer ID, Country and Rep ID.
This section describes the implementation details for a Capture OnTheGo process, including how to create, send and submit COTG documents to the Mobile application. Capture OnTheGo Glossary This topic describes different terms used in the Capture OnTheGo application and other implementation locations. About Tasks A task is a plug-in or a block that is used to build PlanetPress Workflow processes. Tasks can do multiple things depending on the type of task and where they are placed.
Note Completely empty files (0 bytes) cannot be processed by Workflow. Task Properties Any task you add to your PlanetPress Workflowprocess must be configured using its properties dialog box. Each task's Properties dialog will give you the options to configure that specific, individual task.
Variable properties can also be mixed, meaning you can combine, within a single variable property box, any number and order of variable types. You can, for example, do the following for an output file name: %O_@ (1,1,1,30, KeepCase,Trim)_%y-%m-%d.txt. This would translate in the original file name, followed by part of the first line of a text data file, then the current date.
You can quickly identify variable information that is already present in your variable properties as such: l l l l A percentage sign identifies standard variables, as well as standard and custom job info variables — %f, for example. A backslash indicates a control character — \004, for example. An at sign (@) indicates a data selection for emulations other than database — @ (1,1,1,1,17,KeepCase,Trim), for example.
Technical Masks are case-insensitive, since the Windows platform does not support case-sensitive file names (yes, you can have mixed case in a file name but that's visual fluff - the OS itself does not care). Mask Format Here are the different mask formats available: l l Literal characters: Any alphanumerical character is considered literal character and must appear. For example, a mask of "trigger.txt" will not capture any other files than that name. Wildcards: Two wildcards are available in masks.
Date and Time Format To simplify things and to prevent errors, date and time formats have been standardized. l l Date are entered and displayed as yyyy/MM/dd (2007/06/13, for example). Times are entered and displayed using the 24 hour format as HH:mm:ss (3:38:54 PM, for example, is entered and displayed as 15:38:54).
Input Tasks Input tasks are the starting point to any process and determine what file this process will being with. Each process must begin with an input tasks, and although a given process may have multiple input tasks, no task can have more than one initial input task. Initial Input Tasks Initial input tasks are always at the beginning of a process and are always triggered when the process starts.
time. It is also important that while the Folder Capture input task is processing files it keeps a copy of each file in a temporary folder, and will not delete any of these files until it has finished processing all of them. This may cause issues with running out of disk space. Secondary Input Tasks Secondary input tasks are placed in the process like an action task would and will replace the job file in the process with the file they retrieve.
Create File Create File input tasks are different from other input tasks in that they do not pull in data from a source location. The data that this task passes along to other task is its own: text or values from variables entered when the task was created or last edited. Since Create File input tasks are not dependent on data from external sources, they are performed at every polling interval and the process is thus started every time.
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
Input Email Input captures all emails and their attachments from the selected inbox, when those emails correspond to the rules defined in the General tab. If no rule is defined, all emails in the inbox are retrieved. Emails retrieved using POP3 are deleted from the server, emails retrieved from an Outlook inbox are moved to the Deleted Items folder by default.
l l l Nothing: Select to limit those messages used by this task to those that do not specify any subject. “From” contains: Select to limit those messages used by this task to those that are sent from a specific address. The address you enter in the box below can include variables. “To” contains: Select to limit those messages used by this task to those that are sent to a specific address. The address you enter in the box below can include variables.
l Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l l %1 - Date received. Contains the date of the reception of the email (and not the date of retrieval by PlanetPress Workflow). The format is YYYY/MM/DD HH:MM:SS.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
Input Folder Capture retrieves all files corresponding to the specified mask. These files may be of any format, even formats that are not readable by PlanetPress Workflow. Processing Each file capture by the input is sent down through the process, one at a time. When the file is finished, the process goes back to the input which feeds another file down, as long as there are files in the queue.
l l l l l l Sort order: If you selected a sorting method in the Sort files by box, select the order in which you want the files to be sorted. Use archive attribute: Select to turn on the archive attribute of the data files found in the source folder and to leave them in their original location (i.e. to take copies of the source files). Note that PlanetPress Workflow never takes source files that have their archive attribute turned on (so the source files will not be taken again and again).
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane.
C:\Samples\manuals\ usermanual.pdf C:\Samples\manuals\ 644037 Note that the
Job Information definitions l %1 - Folder: Contains the full path of the base folder from which the files are listed. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
Properties General tab l l l l l l l FTP Server: Enter the IP address or host name of the FTP server to poll. User name: Enter the name of a user account on the FTP server. Password: If account named in the User name box is password protected, enter the password here. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available.
On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
l Server requires authentication: Check this option if the HTTP server requires user authentication. This enables the following options. l l user name: A user name known to the Web server. Password: The password associated with the user name entered above. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
For HTTPS Support information, see HTTP Server Input User Options. Note While you can insert the HTTP Server Input task anywhere in your process as a secondary input task, in reality the HTTP Server Input task will only function when used as the initial input, as it is triggered when PlanetPress Workflow HTTP Server receives a request and passes it on to the correct task.
Processing Depending on the options chosen in the HTTP Server Input task properties, the task may choose to ignore some of the files. For example, using the "Do not include XML envelope" means that only the POST attachments will be used in the process, the XML file will be discarded. Attachments are always saved on disk in a specific location, which is accessible either directly in the XML or directly as a data file through the "Loop each attachment as data file" option.
is sent as a data file. l l l Respond on error: Enter a message to be sent to the client as the output file if the process encounters an error and is unable to send a reply that includes the actual output file. The information can be in any desired format such as HTML or plain text, but most browsers will interpret it as plain text. Send immediate response to client: Do not wait for the process to finish and send a static HTML or Text file back to the client instead.
l l l HTTP PDF Invoice Request HTTP Brochure Request Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
Processing No processing is done by this task. Output The output of this task is the same as the input - a data file and job infos that are sent from a task that generated an error. General Tab l The Input Error Bin task does not have any specific properties unique to it, since it only receives input directly from tasks in other processes when an error is generated. For more information, see the chapter on "Debugging and Error Handling" on page 43.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Input SOAP The Input SOAP task is used to answer calls from a remote SOAP client and to return a response to that request. It is similar in functionality to the "HTTP Server Input" on page 176 task. Input This task does not poll any location by itself.
process sharing the same SOAP action must be identical because there is no way to decide the execution order of all the process. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input.
l l l l l l l Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message.
LPD tasks are configured primarily through user options (See "LPD Input Plug-In Preferences" on page 569). The only LDP information you enter in each LPD task is the queue name. Input This task does not poll an input, it sits there and waits for a job file to be sent through the LPR port. Processing When the job is received through LPR, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification.
l l l %3 - Job name: Contains the name of the job as specified by the software that sent the job. %4 - Source file name: Contains the name of the job file as specified by the software that sent the job. %5 - Sender's IP address: Contains the IP adress from which the job was sent. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
Output A single PDF containing as many pages as all the combined input PDFs is generated. If the option is selected, this PDF is optimized. An optional metadata file is also created, containing information about the PDFs. This metadata is divided such that each PDF file is its own document, which can contain multiple data pages. General tab l l l l l l l l l Folder: Enter the full path of the folder from which the input files are to be taken.
Note Metadata can be manipulated with the Metadata Tasks, See "Metadata Tasks" on page 388. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Serial Input Serial Input tasks receive files sent to a serial port on the computer running PlanetPress Workflow. All the Serial Input tasks in a PlanetPress Workflow configuration share the same general properties, which are configured through user options (see "Serial Input Plug-In Preferences" on page 570). Only the properties set in the Other and Error tabs are specific to individual tasks.
Job Information definitions l %1 - Source file name: Contains the name of the job file as specified by the software that sent the job. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
Warning In its initial implementation, the SMTP Input task will NOT receive the BCC addresses from most emails sent to it. This is due to a technical limitation that will be resolved in a future version. Processing The task reads the incoming SMTP request and provides the data within its body.
l l “From” contains: Select to limit those messages used by this task to those that are sent from a specific address. The address you enter in the box below can include variables and wildcards. “To” contains: Select to limit those messages used by this task to those that are sent to a specific address. The address you enter in the box below can include variables and wildcards.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Telnet Input The Telnet Input Task (also known as the Raw Socket Printing Input) receives files sent to a specific port. If you want PlanetPress Workflow to receive data using multiple ports, you must use multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see "Telnet Input Plug-In Preferences" on page 571).
l l Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l This task does not generate any job information. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Processing The print job, by default, is in EMF format. If this option is selected, no action is taken on the data file. However, if the RAW format is selected, the job is converted to RAW. Furthermore, if the Create PDF option is selected, the file is converted to a PDF, including metadata. Output Either one of 3 formats is output from this task: l l l An EMF job format A RAW job format A PDF with attached metadata.
"Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
The difference between an action task and an input task is that an action task can never be the first task of a process. In the same fashion, the difference between an action task and an output task, is that an action task can never appear at the end of a process. In other words, action tasks are always placed between other tasks. This section covers all the action tasks available in PlanetPress Workflow.
Input This task can support files in any emulation, however, the actual file that should be used is one that is compatible with the selected PlanetPress Connect document. Processing This task takes the PostScript version of the document (.ps7), ads the trigger and then the active data file to it. If metadata is present, the output is based on this metadata (unselected data pages will not generate output, the sort order will be respected, etc). Otherwise the complete data file is merged.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
l l l To add or remove characters. To add or remove lines of data. To add the content of a text file. Note that the content must be located at the beginning or the end of the data file. Input Any text-based file can be used in this task, even formats that are not directly compatible with PlanetPress. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task.
l l l l ASCII file: Enter the path and name of the text file to be added to the job file, or use the Browse button to navigate to this file. This box is only displayed when the Text file option is selected in the Content box. Characters: Enter the string of characters to be added to the job file. This box is only displayed when the Characters option is selected in the Content box. Lines: Enter the lines of text to be added to the job file.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task Properties General tab l Search mode group: Select your chosen search mode within this group. l l l l l Treat as regular expression: Select to specify that the string or strings entered above are to be interpreted as regular expressions rather than ordinary text strings. This option disables all position options as well as the Whole words only option.
l l l l At the end of a line: Select to indicate that the search string must be the last string on the line. At column: Select to indicate that the search string must be in a specific column. Specify the column number (the value must be greater then 0) in the Column value box below. Between specific words: Select to indicate that the search string must be between specific words. Specify these words in the Word before and Word after boxes below.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Barcode Scan The Barcode Scan task is used to convert barcode data from multiple image formats into text-readable information. This information is placed in the metadata and can be used by the rest of the process.
Barcode types Description EAN8 EAN8 symbology. Short version of EAN-13, 8 characters. UPCA UPCA symbology. Used with consumer products in U.S., 12 characters. UPCE UPCE symbology. Short version of UPC symbol, 6 characters. Code11 Code 11 symbology. Used to identify telecommunications equipment Code39 Code 39 symbology. U.S. Government and military use, required for DoD applications Code93 Code 93 symbology. Compressed form of Code 39. Code128 Code128 symbology.
Barcode types Description PostNet PostNet symbology. Used by the United States Postal Service to assist in directing mail. RM4SCC RM4SCC symbology. Used by the Royal Mail. Note The fewer barcode types are selected, the faster the plug-in performs. Selecting only the expected barcodes is therefore a good practice. Barcode Orientations Barcode orientations represent a barcode orientation on an image.
l l l l Process by File: The task will process the file once and will insert the barcode information in one metadata file. Metadata will be created if it does not exist or will be enhanced with the values if it already exists. Replace non-printable character with: Enter a character that will be used as a replacement for all nonprintable characters read from the barcode. Some barcode types like Data Matrix can store nonprintable characters that metadata does not support.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
l l If the selected option is process by page, then the metadata file is created and overwritten for each new scanned page. If the selected option is process by file, then only one metadata file will be created (or updated). Note: If metadata was created previously in the process, the task only adds new fields to the existing metadata at the datapage level. Metadata Fields The barcode values are stored at the datapage level of the metadata.
Another method is to use a Set Job Infos and Variables task to copy a metadata field into a Workflow variable. Limitations l l Some barcodes created with PlanetPress 5 could not be read by the Barcode Scan task, so please use PlanetPress version 6 or 7 to create barcoded documents. When using a secondary input, a known issue of the Workflow Tool can cause some unexpected behavior, like having the same metadata file reused instead of a new one being created for each data file captured.
l The options of this task are basically the same as the Data Selector in PlanetPress Connect. Please refer to the PlanetPress Connect User Guide for information on how to use the Data Selector. Examples & Use Cases This task is put into effect in the following use cases and example processes: l Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
In the case of a PDF data file, two things can happen. The PDF can be used as a data file for a Design document, or it can be part of a straight PDF workflow. When this is the case, this task will rather apply the active metadata to the PDF data file (see "PDF Workflow" on page 147 for more information on this). Output The output of this task is always, exclusively, a PDF file, optionally optimized and optionally with fresh metadata.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Other Notes Here's a list of the hard-coded PDF values for files generated with this new plugin. Basically, these settings correspond to Digital Action and PlanetPress Image settings for Standard Quality: l l l PDF version : 1.
l Open options : l l Zoom factor: Fit in window Default view: Page only Database Query Database Query action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format. Database Query action tasks are not considered input tasks as such, because they cannot be used to start a process.
Processing A connection to the selected database is made, the data is retrieved, and an output in the selected emulation format is generated. Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and jobinfos are not modified in any way. Properties Database Connection tab l Database group l l l Range group l l l Location: Enter either the path and name of the database or a database connection string in this box.
l PlanetPress Workflow Database Emulation: If you selected PlanetPress Workflow Database in the Output file emulation box, the following options are available: l l l l CSV Emulation: If you selected CSV in the Output file emulation box, the following options are available: l l l l l Sort on field: If you want the table to be sorted before the data page creation process is started, select the sort field from this box. Text delimiter: Select the text delimiter to be used in the generated file.
l l l l l l l l l Create data pages as follows: Select the option used to generate the data pages. Each data page created using the table or query selected above (Table/Query box) can contain a single record, a fixed number of records, or a variable number of records. To choose the last option, select one of the When [field name] changes listed in this box.
l Export Config: Click to export the currently displayed properties of the PlanetPress Workflow action task. The exported configuration can then be reused on other PlanetPress Workflow workstations. Dynamic SQL tab l Use dynamic values at run-time: Select to use a dynamic database connection string and / or SQL statement at run-time. Check this box to enable the options included in this group (this disables the corresponding options in the General tab).
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Input This task only accepts ZIP Files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself. Processing Every file in the ZIP is extracted to the specified location. If a folder structure exists in the ZIP, it is respected in the output folder. Output This task outputs the data file it received with no modification. Metadata and job files are not touched either.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Digital Action Digital Action action tasks generates the same types of documents generated by PlanetPress Image output tasks. Since Digital Action tasks are not output tasks, the documents they create are typically passed on to the following task. The image files they generate are always saved, along with their index files (if any), to an archive folder.
Note While the Do not use a document (passthrough) is visible in this list, it is not compatible with the PlanetPress Image output if the PostScript was not generated by merging a design document with data in PlanetPress Workflow. In order to generate an image in passthrough mode with external PostScript, please use the Digital Action task.
l l bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images. 8-bits produce grayscale images (in PlanetPress Connect you can have 8-bit color images, but these are reduced to grayscale if you select 8-bit here), while 24-bits produce full color images. For JPEG output, you cannot select a monochrome (1 bpp) color depth. For TIFF G3 and TIFF G4, monochrome (1 bpp) is the only Color depth option you can select.
l Index group: This group lets you specify which type of index must be created for each document generated by this task. PDI files are used by PlanetPress Search as indexing information. l l l None: Select if you do not want this task to add an index file to the generated document. PDI: Select if you want this task to add a PDI index file to the generated document. XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document.
l l Monochrome images group l l l you suspect that the data may contain parentheses, you should use a Run script action task (see Run Script Action Task Property) with a Strip() function to strip them out. Keywords: You may enter keywords for the document. Since this is a variable property box, you may use variables and data selections and let PlanetPress Workflow interpret this information at run-time. Monochrome compression: Select the compression to use for the monochrome images.
l l Color images group l l l l Grayscale resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. Color compression: Select the compression to use for the color images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs.
l Font group l l l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded. If a font is not embedded in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font.
l l l l l l l l Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory. This option is available only when you select Access database in the Database type box. Data source name: Enter the name of the computer on which the database runs. This option is available only when you select SQL Server database or Oracle database in the Database type box.
Output A postscript file containing the necessary code to save the data file on the hard drive. Properties General tab l l l Hard disk name and path (as required): Enter the name and path of the hard disk to which the file is to be saved (enter “%disk0%/PPFiles/Resources”, for example, to save the file to the folder [ROOT] /PPFiles/Resources located on a hard disk identified internally as “disk0”). Leave blank to save the printer’s default hard disk and path.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Note As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the Network Considerations page in the Advanced Configuration and Options chapter (Reference Guide, in English only). There are some important things to consider when using the External Program task: l l The executable file must accept so-called "command-line options" and be able to run without any sort of user interaction.
l l l l Program output capture group l l l better if the application has no user interface. Parameters: Enter parameters that will be passed to the external program when it is launched. Each parameter should be enclosed in quotation marks and separated by a space ("Param1" "Param2" "Param3") except command line options (such as -f, /n). The exact parameters accepted are unique to the executable and defined in its documentation if it exists.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Load External File Load External File action tasks are used to replace the current job file by the designated text file. Loading an external file does not delete the original file or modify it in any way.
initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Mathematical Operations The Mathematical Operations action task resolves a mathematical expression and stores the result in an existing job information or variable.
Properties General Tab l l l Mathematical Expression: Variable data field containing the expression to be evaluated. This expression may combine any combination of standard PlanetPress Workflow variables and VBScript mathematical expressions. For example, to multiply Job Info 9 by 2, the expression would be %9*2 . Store result in: Variable data field containing the job information, local or global variable in which to store the result.
Output The modified XML data file is output. Metadata and jobinfos are not modified. l File l l l l Edit l l l l l l l l l l l XSLT 1.0: Select if you will be entering or pasting XSLT version 1.0 code. XSLT 2.0: Select if you will be entering or pasting XSLT version 2.0 code. Tools l l Find: Brings up the Find dialog. Find Again: Repeats the previous search and finds the next occurrence. Replace: Brings up the Replace dialog.
l l Script running from: Choose if the script should be run from the editor text box, or from an external script file. Script filename and path: Either enter the full path of the XSLT Script, or click the Browse button to navigate to the file. This option is only available if you choose external script file in the Script running from option. Rename Rename action tasks are used to rename the job files they receive.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" on page 243). However, they can be slower to execute. The Run Script action task can be used either as an action or a condition.
l File l l l l Edit l l l l l l l l l l l l l VBScript: Select if your script is written in VBScript. JavaScript: Select if your script is written in JavaScript. Perl: Select if your script is written in Perl. Python: Select if your script is written in Pyton. Tools l l Find: Brings up the Find dialog. Find Again: Repeats the previous search and finds the next occurrence. Replace: Brings up the Replace dialog.
l Script filename and path: Either enter the full path of the XLST Script, or click the Browse button to navigate to the file. This option is only available if you choose external script file in the Script running from option. Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties.
l l l l Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Properties General Tab l l l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
tasks (see "Download to Printer" on page 241), but they include image specific options. Furthermore, they can be used to send images not only to printers, but also to the virtual drive of other computers running PlanetPress Workflow applications. Note that each Sent Images to Printer action task must be followed by a Printer Queue Output task set to "passthrough", in order for the images to be actually sent to that printer.
l l l l l l l Naming convention: Select ’File name, original’ to store the file under its original file name. Select ’File name, no extension’ to store the file without its original file name extension. Note that all characters are converted to uppercase and that extended characters (characters, such as é, for example) are not recommended in image file names. Image quality: Select the same image quality chosen in the PlanetPress Connect documents that reference the image files you are sending.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
involved with paths and permissions of these resources. Please refer to the Network Considerations page in the Advanced Configuration and Options chapter (Reference Guide, in English only). Input Any data file in any format. Processing A copy of the data file is saved on the hard drive at the specified location. Output The original data file, metadata and job infos are not modified, they are passed on to the next task.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Set Job Infos and Variables Add Set Job Infos and Variables action tasks to set job info elements as well as custom variables. You can set multiple variables and job info values in a single task. Be aware that lines are processed from top to bottom. Input Any data file in any format. Processing This task assigns the defined values to each local or global variables or job information. It does not modify the data file nor the metadata.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. SOAP Client Plug-In SOAP Client Plug-In tasks can be used as input, output and action tasks, although their basic function is to generate output.
Properties General tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the drop-down list. Note The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l l l l l l l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
Advanced tab l l l l Domain: Enter the domain for the authentication on the SOAP server. The Domain is optional even when authentication is used. user name: Enter the user name for the authentication, if required. Password: Enter the password for the above user name. Allow invalid security certificate: Check to ignore SSL certificates that are invalid. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Processing All HP PCL characters are removed from the data file. Note that these characters are not interpreted, only stripped out. Output The modified data file, with stripped characters, is output from this task. Metadata, job infos and variables are not modified. Properties General tab l l Process job using ASCII emulation: Select to use the ASCII emulation to process the job file. This reverses LF-CR end-of-line sequences that may result in unwanted double-spacing.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
Technical You can create your own translation matrix files for the Translation Action Task by adding them to the following folder: %CommonProgramFiles%\Objectif Lune\PlanetPress Workflow 7\Plugins\Translator Two examples are already present, converting ASCII to and from IBMEBCDIC.
On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
Output A Line Printer file. Metadata, job infos and variables are not changed. Properties General tab EMF to XY group: Select this option if the file received by this task is a Windows print file. This will prompt the task to perform the first phase of the process, and thus convert the file to an XML file. If this option is not selected, the input file will not be converted to an XML file (note that the task will fail if the file it receives is not an XML file).
Word distance: Indicates the largest acceptable distance between two text passages, so that they are still recognized as belonging together. This the factor the font's mean character width is multiplied with. The value for the mean character width is taken from the corresponding font's attributes (for texts which are printed justified, it is suggested to raise this value up to about 2).
Winport Translator: Select this option if the task is to generate a Line Printer file. This will prompt the task to perform the second phase of the process, and thus convert the XML file to a Line Printer file. If this option is not selected, the output file will thus be an XML file. The settings included in this group determine the format settings of the generated Line Printer file. Character per inch (CPI): The number of individual characters per inch on a line of text.
Warning Splitters do not modify the metadata that is currently active within your process. This means that, if you are intending to use metadata along with a process using splitters, you can either use the "Metadata Sequencer" on page 405 instead of a splitter, or (re)create the metadata after the splitter. About Using Emulations with Splitters When an emulation is used with a splitter action task, the job file is emulated, cut to pieces and de-emulated.
l l l l With most emulations, if a file is split on a form feed, the form feed will not be appended to the output file. With the ASCII emulation, tabs within the input data file are replaced by spaces (the number of spaces is determined within the configuration of the emulation). With the ASCII emulation, if the Remove HP PCL Escapes option is selected, the data coming out of the splitter will have no escape sequences. The Goto column option of Channel Skip emulation is not supported.
l l l l l l l l l l l The following options are only displayed when the Field value condition option has been selected at the top of the dialog box. Operator: Select the condition to fulfill for the condition to be true and thus for the splitting process to take place. Value: Enter the condition value.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Emulated Data Splitter Emulated Data Splitter action tasks are used to split emulated data files (with the exception of XML and database data files - refer to "XML Splitter" on page 298 or "Database Splitter" on page 280) into multiple data files that are passed to subsequent tasks in the process. The data received by the process is typically prepared for a given output device using a pre-set emulation.
changes, and to activate the options from this group, which are used to tailor exactly how you want the word based splitting process to take place. l l l l l l l l l l Word change: Select if you want the data file to be split when the word found at a given location changes. Get: Click to go to the Data Selector and select the location associated with the Word change option. Specific word: Enter the word to use as the splitting criteria.
l CSV Emulation Group l Add header to each output file: This option should only be checked if you are using CSV emulation, and will copy the first line of your data file as the first line of each split file afterward. This is useful only if your first line is a Header line that contains your field names. Examples & Use Cases This task is put into effect in the following use cases and example processes: l Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task. Properties General Tab l l l l l l Split data file on: Use this box to choose the item on which top split the file. The options available depend on whether or not the Use emulation box is checked (see below).
l l Where to split group l l l l Consider case: Select to force the Generic Splitter to match the character casing of the string of characters entered above with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Pages: Enter exactly where to split the file.
l l Before or after: In the previous box, you entered exactly where you wanted to split the file, here is where you specify whether you want the split before or after. Split when word changed: You may not want to split the file every time the string of characters entered above changes, but only every other time, or every third time. If so, enter the number of times in this box.
before or after the string. Choose 5 in the Pages or records box and “Records after” in this box, for example, to split the file 5 records after the record that matches the condition. l Split when condition found: You may not want to split the file every time the string of characters entered in the Value box is found, but only every other time, or every third time. If so, enter the number of times in this box.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. In-Stream Splitter In-Stream Splitter action tasks are used to split non-emulated data files into multiple data files that are passed to subsequent tasks in the process. Note Performing the splitting process on raw, non-emulated data speeds up the splitting process.
l l l l l Match case: Select to force the splitter to match the character casing of the string of characters entered above with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Where to split: By default, the task splits the file at the beginning of the line on which the search word is found (the default value is 0).
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task.
l l l l l l l Match case: Select to force the splitter to match the character casing. Note that this setting applies both to the On region change and Specific word options. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Trim selection: Select to force the splitter to strip empty trailing characters.
l l Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized. Optimization can lead to a significant reduction in the size of the PDF, but it may also add a certain amount of time to the process. This option should only be unchecked if the timing of the process is critical and needs to be done quickly, but keep in mind that the resulting PDF may be much larger than it should be and may even be too large for PlanetPress Workflow to handle.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Properties General Tab This tab lets you choose the splitter settings for default PlanetPress Workflow XSLT engine. If you want to use your own XSLT engine, click the Alternate XSLT Engine tab. l l Split method: Use this box only if you want to edit the standard XSLT script that will be used to split the XML file. First use the Standard XML splitter option to define the standard settings. Then, to change the standard XSLT script, select Advanced XML splitter and edit the script as required.
l l Refresh XSLT: Once you have made all the required settings using the Standard XML splitter option, click this button to display the XML code generated by the XML splitter. You can then use the box below to edit the code as required. {WATCHTEMPFOLDER} file separator: Use this box to edit the default XML file separator (/). Alternate XSLT Engine tab This tab lets you choose the splitter settings for your own XSLT engine.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Process Logic Tasks A process is like a flowchart. The data files captured by the input tasks become job files (see "Data File and Job File" on page 16) that travel down the process. Many processes include multiple process logic tasks. In the Process area, conditional branches appear with their associated condition, allowing you to understand the logic of the whole process at a glance.
Branch A Branch duplicates your job file along with accompanying information. Branches do not execute in parallel - the branch is executed, and then the trunk (or the following branch) continues. Properties Backup Tab l l l l Backup job file: Select if you want PlanetPress Workflow to use identical copies of the job file for the main and secondary branches.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Comment Comments can be used to clarify your process either for yourself or others, to explain branches and scripts, or add information for anyone editing the configuration in the future.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. File Size Condition File Size conditions test the size of the job file they receive. Note that the job file may include data selections, attachments and documents that were added by other tasks.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess. When a process encounters a GoSub action, it halts its own execution, start the subprocess and waits for it to complete before resuming its workflow with the next task. Every subprocess starts with a BeginSub input task and ends with a EndSub output task, both of which have nothing to configure and cannot be replaced or deleted. The simply represents entry and exit points for the subprocess.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Loop Loop action tasks are used to repeat those tasks that are located after it on a given process branch. The number of repeats can be fixed or variable, as required. Properties General tab l l l l Number of iterations: The number of times the loop should be repeated. Every task after the Loop action task will be repeated this number of times. The number may be static, or use a variables (See Variable Properties).
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" on page 243). However, they can be slower to execute. The Run Script action task can be used either as an action or a condition.
l File l l l l Edit l l l l l l l l l l l l l VBScript: Select if your script is written in VBScript. JavaScript: Select if your script is written in JavaScript. Perl: Select if your script is written in Perl. Python: Select if your script is written in Pyton. Tools l l Find: Brings up the Find dialog. Find Again: Repeats the previous search and finds the next occurrence. Replace: Brings up the Replace dialog.
l Script filename and path: Either enter the full path of the XLST Script, or click the Browse button to navigate to the file. This option is only available if you choose external script file in the Script running from option. Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties.
l l l l Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
General tab l Process: The name of the target process to send current job to. Note that startup and subprocesses are not available. You can either enter the name of a process (or use variable properties) or use the dropdown to list existing processes. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Properties General tab l Parameters group l l l l l l l Community: Enter the community name for the printer or other SNMP compliant device you want to monitor. A community acts like a combination of a user and password granting you access to an SNMP device. Depending on the community name, the device knows what rights to grant, for example, read-only or read-write. Community names serve as a form of organization and security used with SNMP.
l User Defined (displayed when User Defined is selected in the Condition Type box) l l l l l MIB OID number: Enter the Management Information Base Object Identifier corresponding to the object you want to test. Vendors of SNMP compliant devices sometimes list MIB OIDs in their documentation. Test: Click to test communication with the device and the MIB OID number. Operator: Select the operator used to test the condition. Value: Enter a specific object status.
l l l l l l l Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message.
l To compare two strings. As with the test above, this test can also be used to search for a string in a given location. The difference with this test is that it gives you comparison options. Using the “Contains” operator, you can test the presence of the string “Gold member” at a given location in the job file (using a data selection), but the other operators can be used to test whether or not the first string is equal to the second one, whether it is equal or lower than the second one, etc.
l l l l Compare to string: You cannot enter a comparison string when either “Is found” or “Is not found” is selected in the Operator box. Enter the second string of the comparison in this box. As with the String box, you can enter a static string, a variable or a data selection in this box. Page range: Select Any page if you do not want to specify a precise data page. Select Pages to specify individual pages or page ranges.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
You can choose contiguous as well as separate time blocks as required. The condition is tested True every time the current time and date corresponds to a selected time block. Properties General tab l l l l l l l Month: Select “All months” if you want the selected time blocks to be valid every month of the year. Select a specific month if you want the selected time blocks to be valid only on that month.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
Create MRDX The Create MRDX action task is used to register a job on a Suretrac server using an MRDX file. The MRDX contains information about the job and its finishing, as well as integrity features use by SureTrac. This task requires a PDF file as an input, along with metadata generated through a document that contains PitneyBowes Scan Codes. Properties General Tab l Register Job to the SureTrac Server group: Check this option to enable the group.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Input from SharePoint The Input from SharePoint task can be used to retrieve files from a SharePoint server on your network, filtering on your template fields and creating metadata to use in your process. When the Input from SharePoint task runs, it first lists all of the files to download then runs the process once for each file in the list.
Properties General Tab Note For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab. l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files.
l l User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries. Password: The correct password for the user name. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
work with previous versions. It also requires a valid PlanetPress license. Laserfiche is a provider of digital document and records management systems. Laserfiche has two components: the Laserfiche server, which hosts the repository, and the Laserfiche client, which serves as the user’s interface with the repository.
l l l l l Force folder creation: Select to force the folder creation if it does not already exist on the Laserfiche server. Volume: A list allowing to choose among available Laserfiche volumes. Configure Tags: Click to open the Configure Tags dialog. See LaserFiche Repository Output Configure Tags. Configure Templates: Click to open the Configure Templates dialog. See LaserFiche Repository Output - Configure Templates.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
l To use the “Use PlanetPress PDF/A archives” option, make sure to: l l l l l l l Check the field as Multiple, select CHAR type and enter the width fields in Laserfiche administration console as long as your PlanetPress fields. Insert a folder path to your PDI source files in the PlanetPress Image archive folder. If a field is checked as Required in Laserfiche administration console, fill the field value.
levels, individually. Output The original data file is unchanged. Metadata is updated according to the specified criteria. Properties General Tab l Excel group l l l l Excel workbook: The full path and file name of a Microsoft® Excel® workbook (.xls or .xslx file). You can use the Browse button on the right to browse to the file on your computer. Excel worksheet: The name of the worksheet you want to use. Once a workbook is open, this drop-down will automatically list all the available worksheets.
l Search option group l Match case: Will force the lookup column names to be in exactly the same case as the Lookup column name. This means if you type in "CustomerID" in the lookup column and the actual column is named "customerid", it would not return any result. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
Note Microsoft® Word® needs to be installed for this task to be functional and to test the connection. Input A compatible Microsoft Word Document (see notes). Processing The Word document is converted into a PDF file. If a Mail Merge is made, the mail merge is done in the document before the document is converted into a PDF file. The conversion is done through the use of a printer queue - the document is printed to this queue and the print job is converted to PDF.
Properties General tab l l Microsoft Word Document: Enter a Microsoft® Word® document or template, or click the browse button to navigate to the location of the document. The supported extensions are: *.doc, *.docx, *.dot and *.dotx. Perform Mail Merge: Check when providing a Microsoft® Word® document or template configured for mail merge. l l l l l l Use settings specified in document: Selected to instruct the task to use the connection string and SQL statements stored in the DOC file.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Notes l l l l l l l l Microsoft Word must be installed on PlanetPress Workflow system. Microsoft Word must not be currently opened when the automation task runs. Microsoft Word 2003 and up are supported.
Processing This task does not process the data or metadata file. The information entered in the Deposit tab of this task is sent to the repository configured in the Repository tab. Output This task produces no output, other than the information sent to the Capture OnTheGo online repository. Properties Repository Tab The Repository tab is where you enter the connection information necessary to create the link between OL Connect or PlanetPress and CaptureOnTheGo.
l l l Author(s): Enter a name identifying the document’s creator(s). Description: Enter a description helping users identify the document. Metadata group: This group lets you determine which Capture OnTheGo users can see the document and where they will see it. l l l Recipients: Enter valid Capture OnTheGo user group names or individual user names in this box. These names determine which users can have access to the document.
l l automatically downloaded if the value is ‘Yes’ (whether entered manually or returned by the variable) and if the recipients list includes only individual user names. In any other case, the document will need to be manually downloaded by the users. Stored on a User Device for: Enter the number of days for which the document is to remain on a user’s device once downloaded. If you leave this box empty or enter a value of 0, the document will never automatically expire on the devices.
Output The output of this task is the original data file. Properties General Tab l l l l l l l SharePoint Site: The name of the SharePoint site where you want to send the files. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to send the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously.
l l l l l Number: This type may contain a number (1, 1.0, 100). The decimal separator is “.” in the plugin. Currency: This type contains the currency ($ …). Date/Time: Date/Time fields contain a date and time Yes/No: Yes/No (menu to choose from). If passing a variable, has to be either "Yes" or "No". Hyperlink or Picture: This type contains an html hyperlink or picture. Technical Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. PlanetPress Fax PlanetPress Fax output tasks are used to make request to PlanetPress Fax, which creates faxes and sends them to a faxing program. In addition to the job-specific PlanetPress Fax properties you configure in the task’s Properties dialog box, there are configurable options common to all PlanetPress Fax outputs processed by a given computer (See "PlanetPress Fax Plug-In Preferences" on page 571).
l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Run mode group l l Printer centric: Select to send the document along with the trigger and data to the component that generates fax documents. Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to the component that generates fax documents.
The .ps file must be the result of the merge between a PlanetPress Connect document and a data file, and can be generated either with the use of "Add Document" on page 205, or a printer queue using a "Send to Folder Printer Queue" on page 63. Postscript generated using any other way will fail, as PlanetPress Image requires knowledge of the number of pages in the document, which is not available in output generated using any other means.
l l List only documents using VDX compilation: Check to ensure that only documents that are compatible with the VDX compilation method are shown in the list, if producing VDX output. Run mode group l l l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Output type: Select the output file type that you want.
l l l l l l goes with the Multiple TIFF option and is only visible if either the AutoStore, DocAccel or KYOcapture format is selected. Archive output: Select to archive generated files. If you select this option, you must enter a folder path in the Archive folder box and a name in the File name box. Send Email: Select to send the generated file via email. You enter the emailing properties in the Login, Recipients, and Attachment(s) tabs.
l supports numerous PDF standards: Standard, High Quality, Custom, and a variety of PDF/VT, PDF/A and PDF/X formats. General group l l l l l l l l l ASCII format: Select to create the PDF file using ASCII characters (instead of the usual 8-bit binary format). This option produces a file suitable for transmission over a 7-bit ASCII link. This option is useful if the PDFs need to be opened in a text editor, sent across networks, or sent via email using a program that does not support binary files.
l l Grayscale images group l l l l method. Monochrome resolution: Select the resolution to use for monochrome images. Grayscale compression: Select the compression to use for the grayscale images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs.
l l l Security group l l l l l l l Permissions password: Enter a password in this box only if you want to prevent users who does not have this password from changing the security options of the generated PDF files. PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files. Allow printing: Select to let users print the generated PDF files.
l size. Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty. Select Bookmarks and page to display the contents of the Bookmarks tab (you use data selection objects to create bookmarks in PlanetPress) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages.
Login, Recipient, Attachments For the Login, Recipient and Attachment tabs, please see the "Send Email" on page 462 task properties. l PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Workflow. It is not available in older versions nor is it available in PlanetPress Office and PlanetPress Watch. PlanetPress Capture is a set of tools available in PlanetPress Workflow that enable output and input for interaction with an Anoto Digital Pen.
Processing The condition is evaluated using the specified rules, combination (condition is true when...) and scope (condition scope). Output The original data file and metadata is output by this task. If the rules used in the condition return True, the data and metadata is sent down in the condition's branch. Otherwise, this same information is sent in the trunk.
l l l l For Pattern Sequence: The name or identification of the pattern sequence to check. Leave blank if no pattern sequence is used. Number of Patterns available are: The operator for the comparison. Numeric comparison with the number of available patterns in the specified pattern sequence. This number of Patterns: The number to use as a comparison to the available number of patterns in the pattern sequence.
l l l l l l End timestamp: Triggered when the last stroke finishes in the field. (see Start Timestamp for detailed options) Pen Id: Triggered by the ID (serial number) of the pen. A box provides a way to specify which Pen ID will trigger this condition to be true. Field List Value: Triggered only on Field List Capture Fields. A box provides a way to specify which value will trigger this condition to be true. Content Status: Triggered when the field is in a specific status.
l Condition Scope: Determines whether the conditions need to be true for all the pages of the document, or any one of them. l l l In the document (occurrence): The task will return true if the condition set it true for any page of the document. On each pages: The task will return true only if the condition set is true for all of the pages of the document. Invert condition: Inverts the result of the task.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
must review and understand the Critical PlanetPress Capture Implementation Restrictions. Input The Capture Field Generator action task expects to receive a regular data file that corresponds to the Capture-Ready document that uses it, along with Metadata generated using the same data file and document. This means that this task must be preceded by at least the Create Metadata task.
Note If any error occurs during processing, such as running out of patterns while generating the job, every action made by this task will be rolled back as if they hadn't happened. Output The Capture fields Generator action task will output either a PDF and Metadata, or an Optimized PostScript Stream file without Metadata.
and cannot be used with the Anoto Digital Pen, however this option can be used to keep the same overall design of your document. Examples & Use Cases This task is put into effect in the following use cases and example processes: l l Basic Functional Capture Workflow Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. l l If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing The PlanetPress Capture Fields Processor action task receives and processes the information sent by the Anoto digital pen and updates all the documents in the PlanetPress Capture Database using the information from the pen. Any ink in the pen is added as an EPS (image) layer on the PDF inside the Capture Database. If a specific document needs to be closed to release its pattern, this task does so.
l l l CapPatternSequence: The value of the pattern sequence assigned to the document. CapPGCName: The name of each PGC file that was used to update this document (will repeat for each PGC file) CapStatus: Current status of the document: l l l l l l 0: Open 1: Closed by an optional field 2: Closed by a mandatory field 3: Closed by a final field CapTemplateName: Name of the PlanetPress Connect document used to generate the document.
l ICR Settings group l l l l l l Perform ICR Recognition: Triggers the PlanetPress Capture ICR engine. For more information, see PlanetPress Capture ICR. Engine Language: Define the language the ICR engine will use for text recognition. This has a major effect on the way text is recognized, as different languages use different databases to recognize letters, numbers and characters. For example, accented letters are not correctly recognized in the English ICR database.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Capture PGC Splitter The Capture PGC Splitter task can be used to separate each document into its own PGC file so they can be processed separately.
Task Properties General tab l Pattern sequence group: Determines what Pattern Sequence will be assigned to each PGC file. l Type: Specify from where the Pattern Sequence should be taken. l l l l None: Do not use a Pattern Sequence. Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database. Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
Input Any data file, but generally one associated with the document in question (either a PGC or a PDF), along with an associated metadata file. Processing A query is made to the Capture database and the ICR data is retrieved. The document that is queried must be available in the database (must not have been closed and retrieved previously). Output The original data file is output by this task, along with the original Metadata file that has been enhanced with the ICR data at the selected level.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
This task is most often useful as the beginning of an automated process using a series of Capture documents, for example one that removes old documents to unlock patterns. However, it can also be used as a secondary input in order to retrieve one or more documents after some operations. Technical The Find Capture Document task makes multiple simultaneous statements to the database when requesting a list of documents.
l Condition Grid: Displays the list of current condition criteria that were set for document retrieval. l Filter: The selected filter type. This can be any of the following: l l l l l l l l l l Document Name: The name of the document, as specified in the Document Name property of the "Capture Fields Generator" on page 365. Date Generated: The date, in YYYY-MM-DD format, when the document was generated through the Capture Field Generator.
l l l l l l l l l l l Contains: Inclusive string comparison, documents where the specified value is present within the chosen filter are included. Does not contain: Exclusive string comparison, documents where the specified value is not present within the chosen filter are included. Before: Date comparison, documents of which the date is previous to the specified value are included (Date Generated and Date Closed filters only).
On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
will take more time then if it retrieved it from a 100 page PDF. Output The Get Capture Document action task is a loop that outputs a PDF version of the Capture Document. The PDF contains the original document, any ink added by the "Capture Fields Processor" on page 369 action task.
Examples & Use Cases This task is put into effect in the following use cases and example processes: l l l Basic Functional Capture Workflow Capture Post Processing Workflow Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Output A PDF file with a blank background and only the ink data found in the PGC file. Properties General Tab l PDF page size: Choose the page size of the output PDF. The default size is A2, and changing the format does not scale the digital ink. Ink appearing outsize of the selected page size will not be visible. Note This task was built using a custom plugin system and does not display the On Error tab in the regular view.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
Create Metadata Creates all the metadata that is either the result of the merging between a data file and a PlanetPress Connect document, or the information about a PDF File. Input Either a data file in any supported Emulation, or a PDF File. Processing If a data file and document are selected, the metadata is generated by merging the data file and document and retrieving only the metadata generated by this merge.
l Add job information to the document: Select to prompt your PlanetPress Workflow to add the available job information elements in the header of the generated file. Note that this option is only enabled if a document was selected. Examples & Use Cases This task is put into effect in the following use cases and example processes: l l l Basic Functional Capture Workflow Capture Web Manager Workflow Daily Sales Report from PDF Files On Error Tab The On Error Tab is common to all tasks.
l l l l Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
Output The PDF file with embedded metadata (the metadata is not deleted from the PDF File on extraction, so this task will always output a PDF with embedded metadata). Properties General Tab l l Extract metadata into PDF job file: the metadata is extracted from the current data file (which is assumed to be a PDF file in which metadata has been previously embedded), and it becomes the current metadata from this point on, overwriting any current metadata file that may already be set.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
Input Any data file with accompanying metadata. Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties. If the field is present in a level that repeats (for example, the data page level), this task loops so that the action may take place on each of the occurrence of that level. Output The original data file is output, along with the modified metadata. Properties General tab l Action: Select the type of Metadata Field Management action to perform.
l Decimal Separator: Set the decimal separator for the Sum option. 3 possible modes are offered: l l l l Auto-detect: Interpret automatically the value. This option is ideal for documents using mixed decimal separators. Note that the auto-detect option encountering the value 1,000 (with a comma separator), interprets it as a thousand while interpreting 1.000 (with a dot separator), as one. .: Treat every value with the dot (".") decimal separator. Commas (",") are treated as thousand separator.
l l l l Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
l l Metadata Fields Management actions on the page level are not possible since the entire task execution is based on the data page node. The task raises an error if the selected Metadata Fields Management action is Sum and if one of the field values is not numeric. The task supports approximately 15 digits of precision in a range from 2.23 x 10-308 to 1.79 x 10308. Metadata File Management The Metadata File Management action task is used to execute actions on Metadata files.
On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
l l l l l Group: Select the metadata Group nodes (the nodes only) based on the specified rule(s). Document: Select the metadata Document nodes (the nodes only) based on the specified rule(s). Datapage: Select the metadata Datapage nodes (the nodes only) based on the specified rule(s). Rules: Define according to which criteria the action must to be performed. The condition must be TRUE to execute the action. All nodes on a specific level with false condition become Unselected.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing The metadata file is split on the selected level. Output The original data file is output, along with the modified metadata. Properties General Tab l l Document: Create a new Document level. Note: Attributes and Fields are deleted for all new Document levels created as well as existing Groups. Group: Create a new Group level. Note Attributes and Fields are deleted for all new Group levels created.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
New Wild Card Since all metadata data pages, and possibly all physical data pages, are treated by the task at run-time in order to evaluate the condition at each level, it is necessary to dynamically define metadata as well as data selections to check all occurrences instead of a fixed one. To accommodate this requirement, a syntax modification is introduced in all current data and metadata functions (region(), @(), field(), xmlget()).
3. Metadata Sequencer: Splits the data file on each metadata document node level. With this example, before the Metadata Level Creation task, the metadata structure contains one group containing one document (containing multiple data pages). After the Metadata Level Creation task, the metadata structure contains one group containing multiple documents.
l l The following number of sequences in the job: Divides the metadata into a set number of sequences and equally distributes the number of levels between the sequences. For example, it the Metadata level is set to Document, and this value is set to 5, a 100 document job file will be divided into 5 sequences of 20 documents each. The following rule: Determine if a new sequence starts or if the current one ends.
l l l Sort by: The drop down displays a list of available fields and attributes in that level, letting you select on which to sort. The field or attributes must be present for every instance of the level you are searching on, or the task raises an error. Order: Choose Ascending (orders like a,b,c, or 1,2,3) or Descending (orders like 3,2,1 or c,b,a) order. If the Numeric sorting option is not checked, numbers are sorted like this: "1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9".
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Output The output is the same as the input, no modification is done to either the data file or the metadata. However, a PDI file is generated and saved in the location specified in the task. Metadata to PDI Task Properties are as such: l l l Archive Folder: Specifies where the PDI file should be saved. This should be the same location as the PDF file that the PDI refers to. Filename: The file name for the PDI. This name should correspond exactly with the name of the PDF that the PDI file refers to.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
l l l l All PlanetPress Connect document templates must use the n-up object on both the front and the back pages of the duplex document. Each instance of the n-up object must have the “change data page with each repeat” option checked. The total number of repeats on each page (vertical X horizontal) must correspond to the number specified in the Number of virtual pages per physical page option..
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. OL Connect Tasks Note OL Connect Tasks are available in PlanetPress Workflow 8.0 and up, and are used specifically to communicate with the Server component of PlanetPress Connect or PReS Connect. OL Connect includes a set of automation tasks to communicate with the Server component and automate certain tasks such as creating record sets, generating contents and generating output.
l l l Configuration Names: Select the appropriate data mapping configuration. Adding configurations is done through the Send to Workflow option in the DataMapper Module. Open data model of selected configuration: Click to view the data model attached to the configuration in the Data Mapper module, to verity that the right one is used. Only works for configurations listed (will not work for "None" or "Dynamic" options). Filter: Retrieves records from the Connect Database.
Content Creation Tab The Content Creation tab generates Content Items either by merging a Record Set with a Template, or by processing a PDF/VT file into individual content items. l Template: Select the appropriate template or option to execute it: l l l l l "None" filename: Select to skip Content Creation completely. "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use.
l l l l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Input This task must receive the information regarding a valid Record Set. This can be the output of the Create Record Set task, or a Record Set retrieved using the Retrieve Entities task. Processing This task loops through each record in the Record Set. For each record, an HTML Email is generated using the record's data. The output generated is then sent via an SMTP server to the email set by the template.
l Use Authentication group: Check to enable authentication to the SMTP server. l l l user name: Enter a user name that has permission to send email through the SMTP server. Password: Enter the password for the above user name. Start TLS: Check to send connect to the SMTP server using TLS (also called "SSL"). Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs send through these tasks.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
Input The task expects to have a valid Print Content Set, output from the Create Print Content task, or the result of the Retrieve Entities task set to retrieve either Content Items or Content Set. Processing The task prepares the content items or content sets for printing, tagging them as printable. Only the content items that are part of the job will generate output. Output The task outputs a Print Job ready to be sent to the Create Output task for printing.
On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
l l l "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below. Preset Names: Select the appropriate preset to generate output. Output Management group: l l As defined by Output Preset: Select to send the output of the job to the location set in the Print Preset (file, printer, etc). Through Workflow: Select to replace the current job file with the output produced by the server.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Create PDF/VT The Create PDF/VT, similar to the Create PDF task, creates PDF/VT files from a PlanetPress Document. This PDF/VT is compatible with the Create Print Content directly without the use of a Connect Template (PDF/VT mode). Input Any data file supported by the selected PlanetPress Document. Processing The input data file is merged with the selected PlanetPress Document. Output The output is a PDF/VT with default quality settings.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Create Print Content The Create Print Content task generates a set of printable content items from a template's Print Context, and saves those content items in the database until output creation is requested. Input This task can receive either the information regarding a valid Record Set (which can be the output of the Create Record Set task, or a Record Set retrieved using the Retrieve Entities task) or a PDF/VT File.
Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs send through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l l l l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
Processing For a single record, this task generates the output for the HTML Context of the specified template. Any external resources such as images, css stylesheets or JavaScript files, are also produced and put aside on the OL Connect Server component. Output The task outputs HTML code as a job file. Within this HTML code, references to external resources point to the local OL Connect Server and are served to the requester directly when the HTML file is opened in a browser.
l l l l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Output The output to this task is twofold. On the OL Connect Server side, a Record Set containing multiple records is created and saved. On PlanetPress Workflow side, metadata is returned with information about each record set. Alternatively, it is possible to ignore creation of the Record Set on the OL Connect Server and simply return an XML file containing the full Record Set structure. Properties General Tab l l l Data mapping configuration: Enter the full path to a valid data mapping configuration (.
l l l l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Properties l Set types to mark for deletion based on metadata content: l l l Job Set: Tag any Job set created by the Create Job task or the Retrieve Items task set to retrieve Job Sets. Content Set: Tag any Content set created by the Create Print Content task or the Retrieve Items task set to retrieve Content Sets. Record Set: Tag any Record set created by the Execute Data Mapping task or the Retrieve Items task set to retrieve Record Sets.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Merge Jobs The Merge Jobs action task merges an external metadata file containing an OL Connect Job with the current job file. Input The task must receive a Job metadata file, which is output from the Create Job task. The selected metadata file must also be the output of a Create Job task. Processing The current metadata file is merged with the selected external metadata file. Output The task outputs a merged Job metadata file which can be used in the Create Output task.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
can retrieve items at any level, it can be used to generate metadata used in multiple tasks. Input The task requires no input file, but any input information such as metadata, job information or data file can be used to specify which items to retrieve. Processing The task requests the items on the OL Connect Server using the conditions set in the task properties. Only the condition information and the return metadata are exchanged.
l l l l Import a rule: Click to open the Browse dialog and load a Rules file. This will load its rules into the list. Export the rule: Click to open a Save dialog and save the Rules file to disk. Rule Viewer: Displays a text-based view of the condition using operators and parentheses. Output Type group: l l Output IDs in Metadata: Select to only output minimal metadata containing the entity IDs.
preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l l l l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab The On Error Tab is common to all tasks.
l l l l Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
Set Properties The Set Properties action task defines properties for entities saved in the OL Connect Database (Records, Content, and Jobs). These properties are applied to the entities and can then be used to retrieve them using the Retrieve Entities task. Input The task must receive metadata that contains appropriate entities, generally from the Create Record Set, Create Print Content, Create HTML Content Set or the Create Job tasks.
Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs send through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l l l l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
considers its job done once it has sent its request to PlanetPress Image, not once PlanetPress Image has finished generating the actual image file. Other tasks available in PlanetPress Workflow can be used to generate output, such as Digital Action, Create VDX and PrintForm action tasks. Unlike output tasks, action tasks are only considered completed once the output file has been generated.
On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or PlanetPress Workflow task. l l l l l User name: Enter an FTP server user name. Password: Enter a password associated with the FTP server user name entered above. Directory: Enter the directory to which the job files are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer.
Web services, a SOAP class of applications, expose their services via the Internet in a manner that lets other applications access them, as well as use and combine them as required. In order to access and successfully use Web services, client applications must know how to get them, what operations they support, what parameters they expect, as well as what they return. SOAP servers make this information available via WSDL (Web Service Description Language) files.
l l l l l l l l Namespace: You may choose an available namespace to prevent ambiguity between identically named elements or attributes. You may also enter a namespace directly. Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below. As script: Click to apply the options you chose above and to display information on the chosen Web service in JavaScript format in a script viewer.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
is closed with the OK button, and are displayed in The Task Comments Pane. Print Using a Windows Driver Printing Using a Windows Driver output tasks are used to send jobs to a local or network printer without going through a PlanetPress Workflow printer queue. Since the printer driver itself is not necessarily postscript, we cannot optimize the print file, so using a Windows Driver Output will always generate a larger and slower print job.
l l Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used. You may use a different variable, but you may not use a data selection. This information may be used for the printer’s banner page. Job owner name: Enter the job owner name. You may use a PlanetPress Workflow variable. Note This option is not functional when natively printing PDFs (without a document).
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
data file with a PlanetPress Connect document, you must have associated at least one document with a printer queue. You can select multiple queues in a Printer Queue Output tasks and choose exactly how your jobs will be dispatched to the selected printers. Input Any data file. Processing If the data file is in a valid Emulation and a document is selected, the data file and document are merged to produce a PostScript output.
Advanced tab l l Copies: Enter the number of copies to be printed outputs. Since this is a variable property box, you may enter a fixed value or use a data selection. Note that load balancing options have an impact on how copies are printed as well as on the total number of printed copies. Load balancing group (Options from this group are only valid if multiple printer queues were selected.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Send Email The Send Email output task send the data files it receives via email.
l l l Bcc: Specify discreet addresses (other recipients will not be able to see these addresses) to which copies of the generated emails are to be sent. Subject: Enter the subject of the emails generated by PlanetPress Image for this task. Note that if you use a data selection in this box, you must be sure that the data that will be selected at run-time will not contain any parentheses, as this would cause the task to fail.
l l Password protect Zip file(s): Select to force recipients to use a password to open the attached zip files. Note that users will be required to use this password open each one of the generated zip files. Password: Enter the zip file password. Login tab l l l l l l l l l l l Use Microsoft Outlook: Select to use Microsoft Outlook to send emails (and attachments). The host computer must be running Outlook, and PlanetPress must have access to Outlook.
the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Send to Folder Send to Folder output tasks send the files they receive to a local folder.
Note This feature is part of the PDF Tools, which is only available in PlanetPress Workflow. l Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected. On Error Tab The On Error Tab is common to all tasks. Details can be found on " Task Properties Dialog" on page 587.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
generally used to gather information from the input task, or transfer information to your PlanetPress Connect document. All the variables in PlanetPress Workflow are considered strings, even if the information itself can be a number. There are no other types of variables (such as arrays, floating point numerical values or Boolean) in PlanetPress Workflow. Job Info Variables Job Infos have two main uses.
l l Job infos sent to the document are global to that document, meaning the values do not change between data files. This means that if your data file contains multiple data pages for different clients, your job infos cannot be used to send information to the document. Job infos are in limited quantity and are slowly being deprecated when transferring data to your document. You should probably consider using Metadata, or Local Variables.
Variable Name Example value when interpreted %M Current Month (text) June %L Current Month (short text) JUN %d Current Day (numeric) 16 %D Current Day (text) Monday %l Current Day (short text) MON %h Current Hour 18 %n Current Minute 03 %s Current Second 41 %v Current Millisecond 24 %u Unique 13-char string (will be different every time it is used) 0ZIS4CW8U47VI00 %t Current Temporary Folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Wor
Variable Name Example value when interpreted %i Current Loop Iteration Index (always the innermost loop) 2 The %i Loop Count Variable In version 7.4, the %i variable is introduced. Its value is equivalent to the current iteration of loops inside of a process. It always contains the value of the innermost loop, and only certain tasks trigger the counter to start. Here is an example process and the value of %i during this process: Initial input tasks do not modify the value of %i.
l l Capture PGC Splitter PrintShop Mail Error Handling Variables The following variables are available in error-handling tasks (that start with the Error Bin Input task). Note that these are new in PlanetPress Workflow 7.4 and are not available in previous versions. Variable Name % {error.process} Name of the process where the error was triggered % {error.tasktype} The type of task that triggered the error % {error.taskname} The name of the task that triggered the error % {error.
Manipulate Local Variables Note For information about Global Variables see Global Variables. Local Variables are set at the level of the Process and are not shared with any other process or instance of that process. Local variables can be used anywhere that accepts variables by using it's namee, surrounded by curly brackets and preceded by a percent sign (for example: %{myLocalVariable}).
While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it will not change the references in any script within a Run Script task. Deleting a variable, on the other hand, does not delete any reference to it. In both the case where a script refers to a variable and it is renamed, or in the case of deleting a variable, any task or script that refers to it will cease to function and will generate an error.
To add a global variable from the Ribbon: 1. Click on the Home tab of the PlanetPress Workflow Ribbon 2. Click Global Variable in the Variables group. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To set the value of a global variable from the Configuration Components pane: 1. Double-click on the global variable in the Configuration Components pane. (Right-clicking then clicking Properties also works) 2. Enter the new value for your global variable 3.
About Configurations PlanetPress Workflow configuration files are defined as a set of processes, subprocesses, variables, documents and printer queues, that work together within PlanetPress Workflow Service. PlanetPress Workflow cannot work without a valid configuration and a PlanetPress Workflow session running on a given computer can only use one configuration at a time. Once you have created a configuration, you must “send” it to the PlanetPress Workflow Service.
configuration. Select the Always send without prompting for confirmation option to automatically send the edited version of the configuration. If a file different from the default configuration file is currently opened, and if it includes unsaved modifications, PlanetPress Workflow asks you whether to save the configuration before creating the new configuration. Select the Always save without prompting for confirmation option to automatically save any unsaved work.
As you are working on your configuration, you can save that configuration file as a file on your local hard drive. Saving a configuration file never replaces the current PlanetPress Watch service configuration. To do this, you must use the Send Configuration command. Saving a Configuration Files created and edited using PlanetPress Workflow can be saved as PlanetPress Workflow configuration files anywhere on your computer or even a network location.
1. Open the configuration you want to use as PlanetPress Workflow’s new configuration. 2. Edit the configuration, if required. 3. When the configuration is ready to be used, from the PlanetPress Workflow button, choose Send Configuration, then Send Local. To send a PlanetPress Workflow Configuration to a remote server: 1. Open the configuration you want to use as PlanetPress Workflow’s new configuration. 2. Edit the configuration, if required. 3.
If the default configuration file is currently opened, and if it includes unsaved modifications, the PlanetPress Workflow Configuration program asks you whether to send the configuration to the PlanetPress Workflow service before exiting. Select the Always send without prompting for confirmation option to automatically send the edited version of the configuration before exiting.
l l l l PrintShop Mail Web Capture service: Monitors print requests from a PrintShop Web server. Serial Input service: Monitors a single serial port for incoming data. Note that all Serial input tasks use the same serial port (set in the user options of the PlanetPress Workflow Configuration program). Telnet Input service: Monitors multiple telnet ports for incoming data. Note that each Telnet input task has its own telnet port number (set in each task).
Workflow run under the same account. For more information on services and system permissions, refer to Windows documentation. For more information on how to configure the account used by the services, See "Workflow Services" on page 522.
To pause your PlanetPress Workflow Workflow Tools service via the PlanetPress Workflow Configuration program: 1. Click Tools in the PlanetPress Workflow Ribbon. 2. Click Pause in the Services Status group. The PlanetPress Workflow service temporarily stops performing jobs. Note If you send a new configuration when PlanetPress Workflow is paused, it will continue using the old configuration when you resume processing until you stop and restart it.
The Interface This chapter centers on the PlanetPress Workflow Configuration program, which you use to create and edit your configurations. The basic user interface elements are as follows: 1. The PlanetPress Workflow button. See "PlanetPress Workflow Button" on page 495. 2. The Quick Access Toolbar. See " The Quick Access Toolbar" on page 594.
3. 4. 5. 6. 7. The Ribbon Tabs. See "The PlanetPress Workflow Ribbon" on page 595. A Group within the Ribbon The Process area. See " The Process Area" on page 583. A specific link (aka a "component", "button" or "link"). The Dockable panels including "The Plug-in Bar" on page 545, " The Object Inspector Pane" on page 544 and "The Debug Information Pane" on page 542. 8. The status bar. This displays your current software version and status of the PlanetPress Service. 9. The Configuration Components pane.
The Configuration Components pane, the Object Inspector and the Messages area can each be displayed inside its own window, whether docked or undocked, but they can also be displayed attached or combined inside the same window. l l l When separate areas are displayed simultaneously, they appear in different sections of the Program window. When attached areas are displayed simultaneously, they appear side-by-side or above one another inside sub-windows.
To show or hide a Program window area: l l In the PlanetPress Workflow Ribbon, click the View tab. From the Show/Hide group, click on any area name to hide or display it. A "highlighted" (orange) button means the area is displayed somewhere on your screen(s). A dim (blue) button means the area is hidden. Note The Process Area is always visible and cannot be hidden.
bottom of the rectangle. To switch between combined area: l At the bottom of the combined area, click the tab of the area you want to bring to the top. If all the tabs are not displayed, use the left and right arrows to navigate between them. The left and right arrows lets you show hidden tabs. To reorder tabs in a combined area: l At the bottom of the combined area, click the tab of the area you want to move, drag it to the left or right and drop it at the desired position.
To take an area out of a combined area, do one of the following: l l Click the tab displaying the name of the area you want to take out and move the mouse pointer so as to drag the area away from the combined area. As you drag, a rectangle is displayed to show the landing position. Release the mouse button when the rectangle is away from the combined area. Double-click the tab of the area you want to take out of the combined area. The area will jump outside of the combined area. To attach areas: 1.
3. Resize each part of the new group as desired. Attaching an area to a group of combined areas. The rectangle showing the landing position is not tabbed and the area will therefore be moved next to the combined area. To maximize or restore attached areas, do one of the following: l l l l To maximize a vertically attached area, click the upward pointing arrow on its title bar. To restore a vertically attached area, click the downward pointing arrow on its title bar.
A) Click to maximize this area. B) Click to restore this currently maximized area. C) Click to maximize this area. D) Click to restore this currently maximized area. To take an attached area out of a group, do one of the following: l l Click the title bar displaying the name of the attached area you want to take out and move the mouse pointer so as to drag the area away from the group. As you drag, a rectangle is displayed to show the landing position.
Resize the Program Window Areas You can adjust the layout of the Program window by resizing one of the Program window areas. This also applies to resizing a combined area (see "Combine and Attach Areas" on page 488). To resize a Program window area: l Move the pointer to the edge of an area you want to resize to display the resize pointer, then click and drag to resize the area.
mapping used to convert back and forth the letters and numbers used by humans to the numeric characters used by computers). By default, codepage 1252 is used for Latin languages (good for Afrikaans, Basque, Catalan, Danish, Dutch, English, Faroese, Finnish, French, Galician, German, Icelandic, Indonesian, Italian, Malay, Norwegian, Portuguese, Spanish, Swahili and Swedish) and codepage 932 is used for Japanese.
l l l l l Close: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. Closing the current configuration is the same as creating a new one. Recent Documents: Displays a list of the 9 most recently opened configuration files. Click on any of them to open it. Select Language: Click to display the language selection dialog, which changes PlanetPress Workflow interface language.
l Subprocesses: Displays a list of subprocesses in your configuration. Right-click on a subprocess to access a drop-down menu that offers these choices: l l l l l l l l Global Variables: Displays a list of variables that are shared between all your processes. Right-click on a Global Variable to access a drop-down menu that offers these choices: l l l l l l l l Insert Subprocess: Inserts a new process with a default input and output task. Insert Local Variable: Inserts a new local variable.
l PPS/PSM Documents: Displays a list of PlanetPress Connect and PrintShop Mail Design document that have been imported into PlanetPress Workflow. Right-click on a document to access a drop-down menu that offers these choices: l l l l l l l Insert Resident Document: Inserts a new Resident Document, which is a placeholder for a PlanetPress Connect document that resides exclusively on the printer. Cut, Copy, Paste: Controls the clipboard.
Process Properties To have access to the properties of a process or subprocess: l l Right-Click on the Process in the Configuration Components Area. Select Properties. You can also double-click on the process to show its options. Note Subprocesses do not have the "General Tab" which is only used for scheduling, but they do have the Information Tab. Options General tab l l l l l l l Active: Select to make the process active.
l l week, it will capture the input 120 times during that period. Note that the polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to process. Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked. Week of month / by date: Select the desired option for the time grid.
l l l Click on any block to select / deselect it. Click and drag from one block to another to toggle all blocks between the two. Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
l l l To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler. To deselect all the days or dates for a given time segment, CTRL+click the time segment on the left grid ruler.
Create a New Process You can create a new process in a two different ways: l l In the Ribbon, go to the Home tab and click the Process button in the Processes group. In the Configuration Components pane, right-click on any process or the Processes folder and select Insert Process. Regardless of the method, a new process is created with a default name (Process1, Process2, etc), Input Task and Output Task. The defaults are configurable in the "Default Configuration Behavior Preferences" on page 550 screen.
Manipulate Local Variables Note For information about Global Variables see Global Variables. Local Variables are set at the level of the Process and are not shared with any other process or instance of that process. Local variables can be used anywhere that accepts variables by using it's namee, surrounded by curly brackets and preceded by a percent sign (for example: %{myLocalVariable}).
While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it will not change the references in any script within a Run Script task. Deleting a variable, on the other hand, does not delete any reference to it. In both the case where a script refers to a variable and it is renamed, or in the case of deleting a variable, any task or script that refers to it will cease to function and will generate an error.
Selecting this option automatically creates a new subprocess, takes the branch and all of its children tasks and inserts it in the new subprocess, including the branch task itself. In the main process, the branch is removed and replaced with a GoSub action task referring to the newly created subprocess.
To add a global variable from the Configuration Components pane: 1. Right-Click on Global Variables 2. Click Insert, then Insert Global Variable. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To add a global variable from the Ribbon: 1. Click on the Home tab of the PlanetPress Workflow Ribbon 2. Click Global Variable in the Variables group. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented).
is renamed, or in the case of deleting a variable, any task or script that refers to it will cease to function and will generate an error. You can set the value of a variable within your process in two ways: l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 265. You can use Scripts. See the chapter "Using Scripts" on page 77. Variables may be used as variable properties in variable property boxes (see Variable Properties).
l l l l DataMapper contains the data mapping configurations (.OL-datamapper) JobCreation contains the Job Presets (.OL-jobpreset) OutputCreation contains the Output Presets (.OL-outputpreset) Template contains the templates (.OL-template) Note Package Files are not saved anywhere. The individual resources contained within the package are extracted and placed in the folders noted above. Resource Archives From version 8.
The Document name of printer-resident documents can be changed using PlanetPress Workflow Configuration program simply because it is initially set using that program. The properties available via the Printer Settings tab define how documents are printed. They are also set using PlanetPress Workflow Configuration program and are retained when documents are assigned to printer queues.
l l Custom Trigger Box (appears only when Custom Trigger is selected in Trigger type): Lets you enter the exact trigger you want to use. This trigger must absolutely be in standard postscript language. Run mode group l l l Document location group (enabled only when using Printer-Centric mode) l l l l l PlanetPress Workflow-based: Select if the PlanetPress Connect document is in PlanetPress Workflow.
Use Data and Metadata Files Attached to Documents Note This feature was introduced in PlanetPress Workflow 7.3. Data Files When sending a PlanetPress Connect Document from PlanetPress Connect to PlanetPress Workflow, all data files used in the document are automatically sent to PlanetPress Workflow along with the Connect Document. These data files appear under the Connect Document in the Documents section of the Configuration Components. To set an attached data file as a sample data file in a process: 1.
3. Right-click on the data file, then click Save sample data file. Metadata When a Design Document uses Metadata, it can also be attached with the document. One Metadata file is generated for each data file attached to the Design Document. Metadata does not appear in the Configuration Components but it follows the data file and can be viewed from the Metadata tab whenever the data file is viewed through the Data Selector.
that are either available on printers or on other PlanetPress Workflow servers must added to the list, otherwise you will not be able to use them in your PlanetPress Workflow configuration. To add a resident document in the Configuration Components pane: 1. In the PlanetPress Workflow Configuration Components pane, click the Documents button and choose Insert | Resident Document. The Add Resident Document dialog box is displayed. 2. Enter the document’s name.
document association to be broken. 3. Click OK. To modify the settings of a document assigned to a printer queue: The settings available in this window are the same as the Printer Settings dialog of a document properties in the Documents list of the Configuration Components Area, but they are specifically for this document on this printer queue. See " View Document Properties" on page 509 for more details. l Double-click on the document located within a printer queue.
Copy Mouse Pointer Prohibited Mouse Pointer Moving Configuration Components Using Drag & Drop: l l l Click on the component and hold the mouse button. Move the component to the location where you want to drop it. Let go of the mouse button. Using the clipboard buttons: l l l l l Click on the component you want to move. Go to the Home tab of the Ribbon. Click the Cut button in the Clipboard group. Click on the new location where you want the component. Click the Paste button in the Clipboard group.
Copying components You can make a copy of any component in the Configuration Components pane, with the only exception being Documents (of which you can only have one copy). Copying components is done using the same methods as moving them, with the following differences: l l To move components using the clipboard buttons and contextual menu, replace "Cut" by "Copy". Otherwise the methods are the same. To move components using the keyboard shortcuts, replace "CTRL+X" by "CTRL+C".
Note Names cannot begin with a number. They can only contain the following ASCII characters: underscore, upper and lower case letters of the alphabet, all digits 0 through 9. If you enter an invalid name, you will be prompted to correct it (unless if the corresponding option has been turned off). To rename a process, printer queue or group in the Configuration Components pane: 1. In the Configuration Components pane, right-click the name of an object or group and choose Rename from the pop-up menu.
l l l Down One Level to move the item one level down in the hierarchy. If the item is already the bottom object in the category, or within a group, this command has no effect. To Top Level to move the item to the top level in the hierarchy. This moves the item to the top of the category or to the top of the group. If the item is already the top object in the category, or within a group, this command has no effect. To Bottom Level to move the item to the bottom level in the hierarchy.
To remove objects from a group: l Drag-and-drop the objects out of the group. The objects are removed from the group. If the group becomes empty, you are prompted to confirm the deletion of the group. To add selected objects to a new group: 1. Select multiple objects that are not part of a group. Press CTRL+G. A new group is added and the selected items are moved to that new group. To ungroup selected objects: 1. Select objects in a group. 2. Press CTRL+U.
In the case of documents, you are first prompted to confirm the deletion. You can turn off this prompt in the Notification Messages User Options. To delete a group of processes, documents, or printer queues: l Click a process group, documents group, or printer queue group, then press the DELETE key. In the case of process groups and printer queue groups, the group and all its members are deleted. In the case of documents, you are first prompted to confirm the deletion of each member of the group.
l l l Activation Code: The activation code generated by your license number and magic number. If the activation code is incorrect, your jobs will output with a watermark on that printer. Printer Name (Optional): Name and/or model of the printer. Comments (Optional): Comments about the printer. The following buttons are available in this dialog: l l l l l Add: Brings up the Printer Activation dialog.
l l l l l l recommended that you create a configuration for a particular user. Clear the Local System account checkbox to run all the PlanetPress Workflow Services under the account you specify. Use the options that become available when you clear Local System account to enter the account information—you must enter a valid user name and password to use Microsoft Outlook as your email client for Email input and Send email output tasks.
l l Right-Click on the Process in the Configuration Components Area. Select Properties. You can also double-click on the process to show its options. Note Subprocesses do not have the "General Tab" which is only used for scheduling, but they do have the Information Tab. Options General tab l l l l l l l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PlanetPress Workflow.
l l Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked. Week of month / by date: Select the desired option for the time grid. Note that any selection you make in this box will be interpreted based on the selection made in the Month box.
l l l Click on any block to select / deselect it. Click and drag from one block to another to toggle all blocks between the two. Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
l l l To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler. To deselect all the days or dates for a given time segment, CTRL+click the time segment on the left grid ruler.
Advanced SQL Statement Dialog The Advanced SQL Statement dialog is available by clicking the Edit SQL button from the Database Query action task. You can enter a custom SQL query in this dialog, using the language supported by the database you select in the Database Query action task. The dialog is separated in two parts: l l l The left part displays the available tables in your database. Click the Show Tables button to display them.
Technical Messenger communications (between different part of the PlanetPress Workflow) is limited to within the same Class C subnet. This means that PlanetPress Workflow on 192.168.1.23 cannot send a job to a PlanetPress Image on 192.168.100.54. This limitation has been removed in PlanetPress Workflow 7.3 and higher. To open the Access Manager 1. Open PlanetPress Workflow. 2. In the Ribbon, go in Tools | Managers | Access Manager. The Access Manager dialog box is displayed.
To manually add a new entry in the list l l l l l l l Open the Access Manager Make sure you are in the Messenger tab. In the IP address box, enter the IP address of the remote machine. Click on the button. Add the necessary permissions Click OK Restart the Messenger service.
Technical The format of the IP address must be one of the following: l l l l 127.0.0.1: The local computer. Typically this IP should have all the accesses checked. 255.255.255.255: Everyone on the same subnet. This is equivalent to hard-coding the current subnet, such as 192.168.1.255 or 10.0.0.255. 192.168.0.42 : A single IP address. This can be any valid address on the same subnet. 10.0.255.255: Any IP in the 10.0.X.X range. To automatically detect machines on the network and add them 1. 2. 3. 4. 5.
l l l for certain IPs or IP ranges. The configuration of the Access Manager is saved in a file on the hard drive which can be edited manually. See Access Manager hosts.allow File. HTTP, FTP and SOAP communication is not limited to the local subnet on any version where these plugins appear. Any change to the Access Manager requires a restart of the Messenger server which can be done in The PlanetPress Workflow Service Console.
To add a new SOAP user 1. Click on the button. 2. Enter the following information under the Username column for the new entry that was created: l l l User name: An alphanumerical user name for the user. Password: A password to protect the user. Note that the password will always revert to ******** (8 stars) when clicking outside of this box - that is normal and is meant to protect the length of the password as much as its contents.
l l Admin: Has access to all processes and features. When this option is selected, the Permissions section is grayed out an all options are selected in it. Disabled: Has access to nothing. The result is the same as not having this user defined at all, but has the advantage that a disabled user can be reactivated with a simple click. 3. Define the permissions for the user (see below). 4. Click OK to save the changes.
The PDF Viewer
To open the PDF Viewer: In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer. The PDF Viewer is accessible through one of the following methods: l l l In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer. Click View as PDF in the Debug toolbar.
To open the PlanetPress Workflow Service Console via the PlanetPress Workflow Configuration program: l Choose Tools | Service Console. A) The PlanetPress Workflow services monitored by the PlanetPress Workflow Service Console. B) The run-time information provided by the console. Note The log window only displays the 1000 most recent lines. Older lines are hidden as new ones appear to replace them.
To view the log messages generated by a service: l Click the service in question in Services pane, on the left hand side. A line appears to separate each log, and information from the newly selected service is displayed. To clear the Messages area of the PlanetPress Workflow Service Console: l Click in the Messages area of the Service Console, and from the right-click menu choose Clear. To save the information from the Messages area of the PlanetPress Workflow Service Console: 1.
To open the PlanetPress Workflow Service Console via the PlanetPress Workflow Configuration program: l Choose Tools | Service Console. A) The PlanetPress Workflow services monitored by the PlanetPress Workflow Service Console. B) The run-time information provided by the console. Note The log window only displays the 1000 most recent lines. Older lines are hidden as new ones appear to replace them.
To view the log messages generated by a service: l Click the service in question in Services pane, on the left hand side. A line appears to separate each log, and information from the newly selected service is displayed. To clear the Messages area of the PlanetPress Workflow Service Console: l Click in the Messages area of the Service Console, and from the right-click menu choose Clear. To save the information from the Messages area of the PlanetPress Workflow Service Console: 1.
applications) of any computer included in your network. You need to do this, for instance, if you plan to run documents that contain dynamic images on those computers (using the Optimized PostScript Stream option). You can then use the Virtual Drive Manager to see the images that were downloaded to your computer as well as to delete them from your virtual drive.
Click in the box on the left to edit the expression and add any variable properties or static text you want, and click outside of the box to save it. Once saved, the Value column displays the expression's result. The contextual (right-click) menu displays the following items when at least one expression is present: l l l l l Copy Value (only when right-clicking an existing expression): Places the resulting value of the expression in your clipboard. Revalue all: Refreshes the value of all the expressions.
l l l l l While a line is selected, press CTRL+X on your keyboard or right-click on the line and select Cut to place the line in the clipboard. Press CTRL+C on your keyboard or right-click on the line and select Copy to place a copy of the line in the clipboard. Press CTRL+A on your keyboard or right-click on any line and select Select All to select all the lines in the Message Area. Right-click anywhere in the Message Area and select Clear Messages to clear the contents of the Message Area.
it for all the selected objects. The Object Inspector also displays information about the Job File while it is being processed in Debug mode. Seeing how files change as they travel down a process can provide valuable debugging information. You can even change some of the job information from the Object Inspector (such as Job Infos) while in debugging.
l l l l l Outputs Data splitters Metadata Related Process logic Connectors Note An Uncategorized category is dynamically created if your PlanetPress Workflow finds any plug-in that would not be part of the existing Plug-in bar. User-defined plug-ins and third party application plug-ins falls into such a category. Settings & Customization The Plug-in bar can be customized according to your needs and the plug-ins you most frequently used.
3. Browse to the location of the plugin DLL file 4. Click on Open. 5. New plugins appear in the Uncategorized category. Preferences PlanetPress Workflow Configuration program lets you configure a variety of options, from how the application itself looks or behaves, to plugin specific options. Most of PlanetPress Workflow preferences are located in the PlanetPress Workflow Preferences window, accessible through the Preferences button in the PlanetPress Workflow button.
l l "LPR Output User Options" on page 578 "PrintShop Web Connect Service User Options" on page 579 Note Preferences are saved automatically and applied immediately. Other Preferences and Settings l l The PlanetPress Workflow Services dialog lets you select the account that PlanetPress Workflow Service uses to communicate on the server and the network. See "Workflow Services" on page 522. You can change the appearance of the Run Script and XSLT Editor through the Editor Options dialog.
l l l Underline: Select to use an underlined font to display inactive processes. Italic: Select to use an italic font to display inactive processes. Strikethrough: Select to use a strikethrough font to display inactive processes. Object Inspector Appearance Preferences Colors l This window lets you set the color of individual Object Inspector elements. To change the color of a given element, select it in the list box above and then choose a color from the drop-down list below.
l l l l l l Selection rectangle: Select whether your selection rectangle (used to select multiple objects by dragging a rectangle around multiple objects) will be displayed as a dotted line rectangle, or a blended rectangle (normally a blue rectangle with darker blue border). Button Style: Select whether to show the expansion links as either an arrow (points right for a closed tree, down for an open tree) or a square (shows a minus symbol for an open tree, plus symbol for a closed tree).
Preferences l l l l l l l l l l l l l l User mismatch: Select to have PlanetPress Workflow display a prompt when a different user opens the application. Task deletion: Select to prompt for confirmation when deleting a task. Document deletion: Select to have PlanetPress Workflow prompt for confirmation when deleting a document.
l l l l l l l l l l l l Plugin not found: Select to have PlanetPress Workflow display a prompt when you import a configuration, and one or more of the plugins used in the configuration are not found on the computer running the software. Prompt on configuration overwrite: Select to have PlanetPress Workflow prompt for confirmation when a configuration is about to overwrite a file with the same name.
l maintained because of its historical purpose but should no longer be used since it can almost always be replaced by more specialized and efficient splitters. Warn on Component Rename: Select to have PlanetPress Workflow prompt for action when configuration components, such as processes, are imported from an external configuration file. Imported components can overwrite existing components, or be renamed automatically with unique names.
l l l Tree: Enter the NetWare Directory Services (NDS) tree where the user resides. This is the user you entered in the user name text box. Click Trees to navigate to the desired tree. You must enter a value for the Tree text box. Context: Enter the context on the NDS tree where the user you enter in the user name text box resides. Server: Enter the server where the NDS tree you entered in the Tree text box resides.
l Document and Pattern Database group l l l l l l l Status: Displays the status of the database. Use ODBC Database: Check to ignore the default location for the Microsoft Access database (MDB) and use an ODBC connection to your own database location instead. ODBC Settings: Click to open the "PlanetPress Capture ODBC Settings" on page 557 dialog. Test Connection: Click to verify the connection to the ODBC Database. Reset Database: Click to reset the database to its original status. Manage Documents...
PlanetPress PlanetPress Document Manager The PlanetPress Capture Document Manager dialog is used to manage all the documents present in the PlanetPress Capture database that are currently open. Options and Controls Documents Lookup Group l Filter by: Select what information you want to look for in the documents database. l l l l l l l l l l Document ID: Search using the Document ID, a unique and automatic identifier attributed to each document by the Capture Field Generator task.
l l Mask: Enter the text or number to compare with the database information. Search: Click to start the search. Manage Documents Group l Document list: Displays the results from the search in 3 columns: l l l l l l l Document Title: Displays the title of the document as specified in the Capture Field Generator task Production date: Displays the date and time on which the document was added to the Capture Database.
Settings l l l l Name: Click to displays and choose from a drop-down of each DSN (Data Source Name) available on the system, along with it's source (User DSN or System DSN) and the driver it uses (database type). Type: Click to display a drop-down of supported database types. This must correspond to the database type of the DSN chosen in the previous option. user name: If the database is secured with a user name and password, enter the user name here.
data sources. In order to create an ODBC connection visible by PlanetPress, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\odbcad32.exe . The following considerations should be kept in mind while working with ODBC Databases in PlanetPress Suite. l All databases l l l l l l Microsoft Access l l l l l User Rights: During normal operation, Read/Write to tables should be sufficient.
l MSSQL (Microsoft SQL Server) l l l l All versions of the SQL Server are supported, including all Express versions. Database can be in any location, but performance will depend on the speed of the connection between PlanetPress Production and the SQL server. In the event where 2 requests are made simultaneously on the same record, SQL Server will drop the most complex request. Resubmitting the PGC for processing should resolve this issue. This, however, should happen only rarely.
Bottom Toolbar l l l Button: Click to add a new line in the Pen Data List, then edit the information on this new line. Button: Place a checkmark on the line of any pen you wish to remove from the database, then click this button. Search in column Pen ID: Enter a search term for a Pen ID, then click the Search button. The Pen Data List will highlight any pen containing your search term. To register a new pen manually 1. Click on the icon 2.
PlanetPress Capture License Management The PlanetPress Capture License Management window is used to manage the pen pack available in the installation of PlanetPress Capture. Each Pen Pack contains a limited number of pens that can be registered in the Capture Database. When the number of pens have been reached, new pens can no longer be registered. If no pen pack is available, PlanetPress Capture functions in Demo Mode. In Demo mode, only one (1) pen can be registered in the pen management window.
PDF Text Extraction Tolerance Factors When extracting text from a PDF (for example, through a data selection), a lot more happens in the background than what can be seen on the surface. Reading a PDF file for text will generally return text fragments, separated by a certain amount of space. Sometimes the text will be shifted up or down, spacing will be different, etc. In some cases, every letter is considered to be a different fragment.
When this value is 0, no vertical shift is accepted between two fragments. When the value is 1, the second text fragment can be shifted by as much as the height of the first fragment. Accepted values range from 0 to 1. The default value is 0.15, recommended values are between 0.00 and 0.50. Font Delta Height Defines the tolerance for the difference in average height of fonts in the two target fragments. The higher the number, the more difference in average font heights will be accepted.
be accounted for in Debug mode. The available OL Connect user options define the default behavior of OL Connect tasks' OL Connect Proxy tab. These values are used unless they are overwritten in a task's properties: l Server Connect Settings l l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 user name: Enter the user name expected by the OL Connect Server.
l l l l All events with details: Select to log everything that happens in PlanetPress Workflow. This includes when it starts and stops, the success and failure of tasks, and details on the success and failure of tasks. Add time stamp to all processes events: Delete log files after: Select how many days log files are kept before being deleted.
Technical By default, the request XML also contains a CDATA section which contains the raw input data, effectively doubling the size of the incoming file. Due to technical restrictions, the incoming XML file cannot be more than 400MB, which because of CDATA is reduced to around 200MB. To help in this situation, you may elect to omit CDATA from the attachment in this dialog. Please note that this limitation also affects incoming binary files (sent through file upload in a form), regardless of CDATA settings.
XML envelope. This option removes them from the envelope, but they remain accessible through their direct path. This option has no incidence on any other option of this task. Technical SSL is used to accept secured, encrypted requests from web clients and requires a certificate delivered by an approved authority. SSL can also be called HTTPS, though that is a misnomer. For more information on SSL and how to purchase a certificate, please see Q10694 on SSL.com.
LPD Input Plug-In Preferences LPD input plug-in preferences control certain functions of the PlanetPress Workflow LPD Server service, which in turn has an impact on LDP input tasks performed by PlanetPress Workflow on a given computer. The LPD Server service receives jobs using TCP/IP from LPD servers. For information on the preferences set in individual LDP input tasks, refer to LPD Input Task Properties.
Serial Input Plug-In Preferences Serial input plug-in preferences control certain functions of the PlanetPress Serial Capture service, which in turn has a direct impact on all Serial input tasks performed by PlanetPress Workflow on a given computer. Preferences l Serial settings group l l l l l l l Serial port: Select the port of the computer where the Serial input is connected to (COM1 through COM8). Baud rate: Select the baud rate of the Serial input.
l Log (verbose): Select to keep a log of errors and other information related to the Serial input. Since these messages can accumulate, you have the option of not logging them. Telnet Input Plug-In Preferences The Telnet input plug-in preferences controls the log of the PlanetPress Workflow Telnet Capture service. Since PlanetPress Workflow lets you monitor multiple Telnet inputs simultaneously, the port setting for all Telnet input tasks cannot be set in the Preferences.
l installation folder (on the computer that actually performs the PlanetPress Fax output tasks). Fax service: Select the faxing program to which PlanetPress Fax sends its documents for faxing. Each faxing program has its own options and changing this option also changes the options below to reflect the following: l WinFax Pro l Dialing format: Select how you want PlanetPress Fax to read the fax number in the data selection and send it to WinFax PRO.
l l l l Folder: Enter or select the location of the report file. PlanetPress Fax generates report file names automatically with the file name extension PFX. The report file is copied to the specified Report folder only after all fax transmissions in a PlanetPress Fax job are completed or have exceeded the maximum number of retries. This folder can then be used as an input for a PlanetPress Workflow process for monitoring the status of PlanetPress Fax jobs.
l local naming system (such as the DOS naming system in Windows) would result in “File not found” error messages. Dialing options button: Click to set the appropriate options as required. Since these options are specific to the faxing program, refer to the faxing program’s documentation for more information. Captaris RightFax options l l l l l RightFax Printer: Select a RightFax printer. A RightFax printer is a fax driver that makes it possible to send faxes automatically.
l l l PlanetPress Workflow installation folder. They are named ftpdate.log, where date is the current date in yyyymmdd numerical format. Note that changing this option also affects the log displayed in the PlanetPress Workflow Service Console. Interval: Select the interval (in seconds) at which the FTP service is to dispatch jobs from the ftpPut folder to the FTP sites. Back up job on error: Select to move the job file to a local folder ftpPut\error if an error occurs while sending a job via the FTP outp
l l l l l l l l Error Log: Select to send an email that includes the current error log to the administrator when an error occurs. The error log is sent to all addresses you enter in the Administrator’s address(es) text box. Error file: When enabled, sends an e-mail with an attachment of the offending file when an error occurs in the PlanetPress Image output task. Additionally, a backup of the job is created in the Error folder, which is located in the PlanetPress Workflow installation folder.
l l l l l l l l Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory. This option is available only when you select Access database in the Database type box. Data source name: Enter the name of the computer on which the database runs. This option is available only when you select SQL Server database or Oracle database in the Database type box.
l l l l Email address: Enter the email address of the user sending the error messages to the administrators. Reply address: Enter the reply address that recipients use to reply to the error messages. Outgoing mail (SMTP): Enter the IP address of the server that PlanetPress Workflow uses to send the emails via SMTP. Server requires authentication: Select if the outgoing server used to send the emails via SMTP requires authentication.
l Error handling group l l l l Max. retry period: Select the maximum time period, in hours, within which PlanetPress Workflow attempts to dispatch the job using the LPR output before giving up. Note that entering a maximum retry period of 0 hours disables retries altogether. Retry interval: Select the interval, in seconds, at which time PlanetPress Workflow attempts to dispatch the job using the LPR output. This takes place only within the Max. retry period, after which the attempt ends.
Editor Options The Script Editor is used to edit scripts used in Run Script and the XSLT Editor is used to edit scripts used in Open XSLT action tasks. Most of the options listed below are valid for both editors. Those options which are only valid for a specific editor are identified as such.
l l l l l l l l l l l l Cursor beyond EOF: Select to make it possible to position the pointer beyond the end of the program file. Clear to prevent this. If you clear Insert mode and select Cursor beyond EOF, you can only overwrite the existing lines of the program; you cannot add lines to it. Cursor beyond EOL: Select to make it possible to position the pointer beyond the end of the line. Clear to prevent this.
Enter a sequence of two or more integers, each separated by a space, to specify tab stops. The sequence must be in ascending order. Tab stops are measured in number of space characters. For example, a value of 20 places the tab stop at the 20th space character. You can also use the drop-down list to select a previously entered value. l Display l Display Options Group l l l l l Editor font: Use to select the font the Editor uses to display the program code.
l l Line numbers on gutter: Select to display code line numbers in the gutter between the Commands and Code areas. Selecting this option has effect only if you selected the Gutter option. If you clear both this and the Line numbers on gutter option, no line numbers appear alongside the lines of code.
The first task of any process, also called the initial input task, always appears in the first box in the upper left corner. When you create a new process, this first task is always followed by the default output task in the following box.
To insert a task: 1. Open the Plug-in Bar by clicking on its tab. If you can't see the Plug-in Bar tab, click on the View tab in the Ribbon and make sure the Plug-in Bar is highlighted in the Show/Hide section. 2. Locate the task you want to add to your process. You can navigate between the different task categories by clicking the icons at the bottom of the Plug-in Bar. 3. Using your mouse, click and drag the task in your process at the place you want to insert it. 4.
Edit a Task To edit a task, you simply need to access and change its properties. You may even do it while your process is in Debug mode (See About the Debug Mode). To edit a task: 1. In the PlanetPress Workflow Process area, double-click the task icon. A dialog box containing the available task properties is displayed. 2. Edit the task properties as required. Click specific tabs to see all the properties associated with the task. 3. Click OK to close the dialog box and save the new properties.
l l l Click on the task or branch you want to delete, go to the Home tab of PlanetPress Workflow Ribbon and click on the Delete button in the Clipboard group. Click on the task or branch you want to delete, and press the Delete (or "Del") key on your keyboard. Right-click on the task or branch you want to delete, and select Delete from the menu. When you remove a branch, all the tasks located in that branch are also deleted. When you delete a task, only that task is deleted.
The "On Error" tab that is common to almost all tasks contain the following options: l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
5. From the Home tab in the Ribbon, choose Paste (or right-click and select Paste from the drop-down menu). To copy and paste tasks or branches: 1. In PlanetPress Workflow Process area, select the task or branch you want to copy and paste. 2. From the Home tab in the Ribbon, choose Copy (or right-click and select Copy from the drop-down menu). 3. To paste the task or branch to a different process, select that process. 4.
Note You can only paste the properties of an input task on the initial input task of your process. Similarly you can only paste the properties of an output task on another output task. Also, you cannot paste the properties of a task on a branch and vice-versa. Note You can paste only the properties of the On Error tab of any task or branch on another one. To copy and paste the On Error properties of a task or branch: 1. Copy or cut a task or branch from which you want the On Error properties. 2.
To duplicate a task or branch, the same method applies but with a slight difference: 1. In PlanetPress Workflow Process area, click the icon of the task or branch you want to duplicate. 2. While holding down the mouse button, press and hold down the CTRL key and drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item and release the CTRL key. The dropped task or branch is copied above the item over which it was dropped.
Resize Rows and Columns of the Process Area Resize the rows and columns of PlanetPress Workflow Process area in which tasks are located to better visualize the organization of your process. To resize rows and columns of the PlanetPress Workflow Tools Process area: 1. In the PlanetPress Workflow Tools Process area, place your cursor over the separator line dividing each section of row or column rulers. 2.
To use a variable document: 1. Click on the %o entry in the document list 2. Type the variable properties or use the right-click menu to insert the correct variable properties. 3. Click OK on the dialog. At run-time, if PlanetPress Workflow cannot find the document name generated by those variables, the task will fail. Highlight a Task or Branch The Highlight command lets you toggle the background color of selected tasks and branches.
To redo a command: l From the Quick Access Toolbar, choose Redo. The Quick Access Toolbar PlanetPress Workflow Quick Access Toolbar is displayed, by default, on the right side of the PlanetPress Workflow button and provides one-click shortcuts to commonly used functions and features. You can add as many buttons as you want to the Quick Access Toolbar and remove them at will. To add a new button to the Quick Access Toolbar: 1. Locate the button you want to add in one of the tabs of the Ribbon 2.
The PlanetPress Workflow Ribbon The PlanetPress Workflow Ribbon centralizes commands, organizing them into a set of Tabs, each tab containing groups of controls. Each tab on the Ribbon displays the commands that are most relevant to a given feature set. The built-in Ribbon and Quick Access Toolbar contain commands that are frequently used and convenient to keep close at hand. You can minimize the Ribbon, and choose the position of the Quick Access Toolbar, as well as the commands it displays.
l l The Debug tab includes the Data, Debug and Debug Messages groups. l l l l The Show/Hide group contains four controls to display or hide any of the four panes; the Configuration Components pane, the Object Inspector pane, the Message pane, the Debug Info pane and the Plug-in Bar. The Data group allows to associate a sample data file to the currently selected process, as well as update or replace it, and display it in its text/PDF or Hexadecimal format.
l The Test Page group contains: l l l The PS Test Page control allows to print a Status Page for the selected Printer Queue. Note that if no printer queue is selected in the Configuration Components pane, the control is disabled. The Text Test Page control allows to print a raw text test page for the selected Printer Queue. Note that if no printer queue is selected in the Configuration Components pane, the control is disabled. The Help tab includes the Help, Activation and License groups.
Copyright Information Copyright © 1994-2016 Objectif Lune Inc. All Rights Reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any other language or computer language in whole or in part, in any form or by any means, whether it be electronic, mechanical, magnetic, optical, manual or otherwise, without prior written consent of Objectif Lune Inc. Objectif Lune Inc.
Legal Notices and Acknowledgements PlanetPress Workflow, Copyright © 2016, Objectif Lune Inc. All rights reserved. The license agreements for the associated open source third party components can be downloaded here. This application uses the following third party components: l l l l l l l l l l l l l l Apache Javascript Support (Rhino) version 1.7.3 which is licensed under the terms of the Mozilla License Version 1.1. The source code can be obtained from the following location: https://developer.
l l l l l l l l l l l l l l Jersey which is distributed under the terms of the Common Development and Distribution License (CDDL) Version 1.1. Information on how to obtain the source code can be found at the following location: http://repo1.maven.org/maven2/org/glassfish/jersey/jersey-bom jersey-json-1.13 which is licensed under the terms of the Common Development and Distribution License (CDDL) Version 1.1.
l l l l l location: http://ebr.springsource.com/repository/app/bundle/version/detail?name=com.springsource.javax.mail& version=1.4.5&searchType=bundlesByName&searchQuery=mail Springsource SLF4J 1.6.1, Copyright © 2004-2008 QOS.ch. All rights reserved. Web Services Description Language for Java which is distributed under the terms of the Common Public License v 1.0. The source code for this can be obtained from the following location: http://wsdl4j.cvs.sourceforge.
l l l l l l l l l l l l l l l l l l l l l l l l l l l Apache Commons Pool Apache Commons VFS Apache Derby Apache Felix and dependencies Apache Geronimo Apache Jakarta HttpClient Apache Log4j Apache Neethi Apache OpenCMIS Apache POI Apache ServiceMix Apache Tomcat Apache WSS4J Apache Xalan Apache Xerces2 Java Parser Apache XMLGraphics Apache XML-RPC Barcode4j Google Collections Google GSON Jetty LMAX Disruptor OPS4J Pax Web org.json.
This includes the following subcomponents that are licensed by the Apache Software Foundation under the Apache License, Version 2.0: l l l l l l l l freemarker/ext/jsp/web-app_2_2.dtd freemarker/ext/jsp/web-app_2_3.dtd freemarker/ext/jsp/web-app_2_4.xsd freemarker/ext/jsp/web-app_2_5.xsd freemarker/ext/jsp/web-jsptaglibrary_1_1.dtd freemarker/ext/jsp/web-jsptaglibrary_1_2.dtd freemarker/ext/jsp/web-jsptaglibrary_2_0.xsd freemarker/ext/jsp/web-jsptaglibrary_2_1.
