8.8

Manuals Brands Objectif Lune Manuals Applications PlanetPress Workflow

Table Of Contents

User Guide

Version:8.8

Summary of content (796 pages)

PAGE 1

User Guide Version: 8.
PAGE 2
PAGE 3

User Guide Version 8.8 Last Revision: 4/9/2018 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-2018. 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.
PAGE 4

Table of Contents Table of Contents 4 Welcome to PlanetPress Workflow 8.
PAGE 5

Accessing the Data Repository Where to find the Data Repository About Documents Import Documents Import PrintShop Mail Documents Debugging and Error Handling About Error Handling Using the On Error tab Creating and Using Error Processes Accessing the Logs Resubmit Backed Up Input Files to a Process Knowing What to Resubmit Debugging your PlanetPress Workflow Process The Plug-in Bar Categories Settings & Customization About Printing PlanetPress Workflow Printer Queues Shared Printer Queue Properties Windows
PAGE 6

The Watch Object Data Repository API Stopping Execution Special Workflow Types Special Workflows PlanetPress Capture Workflow Database Considerations (ODBC) HTTP Server Workflow PDF Workflow Workflow processes in a Connect Send solution The basic processes involved in the Capture OnTheGo Workflow About Tasks Task Properties Variable Properties Input Tasks Action Tasks Data Splitters Process Logic Tasks Connector Tasks PlanetPress Capture Metadata Tasks OL Connect Send OL Connect tasks Output Tasks Working W
PAGE 7

Available Output services Start and Stop PlanetPress Workflow Service The Interface Customizing the Workspace Dock and Undock Areas of the Program Window Show or Hide Areas of the Program Window Combine and Attach Areas Resize the Program Window Areas Change the Interface Language PlanetPress Workflow Button Options The Configuration Components Pane Components Area Sections Processes and Subprocesses Manipulate Global Variables Connect Resources PPS/PSM Documents Associate Documents and PlanetPress Printer
PAGE 8

The Object Inspector Pane The Plug-in Bar Categories Settings & Customization Preferences Other Preferences and Settings General appearance preferences Object Inspector appearance preferences Configuration Components Pane appearance preferences Default Configuration behavior preferences Notification Messages behavior preferences Sample Data behavior preferences Network behavior preferences PlanetPress Capture preferences OL Connect preferences PDF Text Extraction Tolerance Factors General and logging prefer
PAGE 9

Cutting, Copying and Pasting Tasks and Branches Moving a Task or Branch Using Drag-and-Drop Ignoring Tasks and Branches Resize Rows and Columns of the Process Area Selecting Documents in Tasks Links Highlight a Task or Branch Undo a Command Redo a Command The Quick Access Toolbar The PlanetPress Workflow Ribbon The Task Comments Pane Additional Information 778 781 782 782 783 784 784 784 785 786 788 789 Copyright Information 790 Legal Notices and Acknowledgements 791 Page 9
PAGE 10

Welcome to PlanetPress Workflow 8.8 This PDF documentation covers version 8.8. 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 plugins, it helps improve your communications processes.
PAGE 11

Technical Information that may require specific knowledge to understand. Warning Information that is potentially critical to using PlanetPress Workflow. Pay close attention.
PAGE 12

System Requirements These are the system requirements for PlanetPress Workflow 8.8. Operating System (64-bit only) l Microsoft Windows 2008/2008 R2 Server l Microsoft Windows 2012/2012 R2 Server l Microsoft Windows Vista l Microsoft Windows 7 l Microsoft Windows 8.1 l Microsoft Windows 10 (Pro and Enterprise versions only) Note Windows XP, Windows 2003 and older versions of Windows are not supported by PlanetPress Workflow.
PAGE 13

l l l l l l l l l 21962: Barcode scanner task may have issues reading 2-D barcodes printed/scanned with low resolution. Make sure the scans and the original printed output are at least 300DPI (600 or better recommended) 21405: When printing through a Windows printer driver on Windows Server 2008 or Windows Server 2008 R2, the Job Owner setting is ignored. This is caused by a documented issue in those two Operating Systems.
PAGE 14

l l l l 13554: In the LaserFiche connector, when selecting a different template after filling up the fields and then going back to the first template, the values entered in the fields are lost. They have to be entered again. When loading a workflow configuration that includes references to Windows printers, the output task may fail to recognize the printer if the printer driver has changed between the moment the config was set up and the moment it was loaded.
PAGE 15

PlanetPress Workflow configuration file from another PC that includes an instance of the WordToPDF task, you must review the properties of each instance of the task and click OK to validate its contents. A new printer queue will be created if required and the default printer will be reset properly. If you do not perform these steps, running the configuration will result in several error messages being logged and the task failing.
PAGE 16

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).
PAGE 17

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.
PAGE 18

Note OL-workflow files are equivalent to .pp7 files made with older versions of PlanetPress Workflow. They contain the processes and such used by Workflow. 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.
PAGE 19

using the old configuration.
PAGE 20

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.
PAGE 21

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.
PAGE 22

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).
PAGE 23

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.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 datamapper contains archives of the data mapping configurations (.
PAGE 24

For more information about Data, please refer to "Sample Data" on page 36. Note Null characters present in the data may not be displayed properly when using 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.
PAGE 25

In the PlanetPress Workflow Configuration program, you use sample data files to create and edit PlanetPress Workflow configurations. 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.
PAGE 26

One last consideration regarding output file names has to do with standard JPEG and TIFF files generated by PlanetPress Image. When an output job contains multiple pages, multiple JPEG or TIFF files are generated (one image per file), each one identified by a sequence number appended to its name (this is managed by your PlanetPress Workflow). A three page job to be called Invoice, for example, will generate three JPEGs or TIFFs called Invoice0, Invoice1 and Invoice2.
PAGE 27

After opening a sample of the data and/or metadata, you can easily make a selection. It is also possible to manually enter a data selection, or to change it after making a selection with the mouse pointer. Wild card parameter "?" Data/metadata selection functions accept a wildcard parameter "?", indicating the function operates on all nodes (not just one) of a given level. Examples l l l In a PDF emulation, the format of a selected region could be: region(?,0.59375,2.21875,1.85416,2.
PAGE 28

l From Line: The starting line of the data selection. l To Line: the last line of the data selection. l From Column: the leftmost character position of the data selection. l To Column: the rightmost character position of the data selection. l Case Options: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent.
PAGE 29

Data Repository lookups The Data Repository selections are made through the lookup function. Selections are done from the data located in the "Data Repository Manager" on page 721. The lookup function returns the value of a single key, which is always a string. Syntax lookup(group, return key, lookup key, lookup value) Here is a breakdown of the syntax (all arguments are mandatory): l l l l group: The name of the group in which to retrieve the value. Does not need to be surrounded by quotes.
PAGE 30

l Right: Exact horizontal position (in inches) that defines the right of the selection region. l Bottom: Exact vertical position (in inches) that defines the bottom of the selection region. l Case Option: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent. l LowerCase: Converts all letters to their lowercase equivalent.
PAGE 31

l Metadata Path (optional): Defines the precise path where the Metadata Field is located. Note Metadata Index/Count values are zero-based: the first element in any collection has an index of 0 and the last element's index corresponds to the collection's length minus 1. Option flags The flag value to enter should be the sum of all desired flags. So, a value of 11, which is 8+2+1, means that behavior 8, 2 and 1 are applied. A value of 0 means 'no flag'.
PAGE 32

l l l Choose Debug > Select, on the menu. Right-click a task property that may contain variables (recognizable by the color of its field label, which is maroon by default) and choose one of the Get Data ... or Get Metadata ... options. Debug your configuration and step through it until the option Debug > View Metadata gets enabled. This happens when the metadata file has been created by a task in the process. The Data Selector is divided in two tabs: Data and Metadata.
PAGE 33

Display Preferences). The Data Selector uses the emulation (either the emulation chosen when the sample data file was selected, or the one chosen in the last Change Emulation action task appearing above the current task) to format the data. It displays the formatted data to let you make selections easily using the mouse pointer. 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.
PAGE 34

Metadata tab The Metadata tab allows to load a metadata file and make a selection from it. The Sample metadata filename 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. Tip To get a sample of the metadata file, debug your process and step through it until the option Debug > View Metadata gets enabled. This happens when metadata have been created by a task in the process.
PAGE 35

The Production information list displays all metadata fields describing the current metadata level, as selected in the Metadata Level tree view, for the current data page, as selected in the Data page box. The User defined information lists all metadata fields defined by the user on the current metadata level. Note A number of the options in the Metadata Selector in PlanetPress Design 7 are no longer available in the user interface of PlanetPress Workflow .
PAGE 36

l Channel Skip l Database l XML l 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 Design User Guide. Using the File Viewer The File Viewer is like a Data Selector without any data related options, such as emulation settings.
PAGE 37

Choosing a Database Type Sample Data File The procedure for selecting a sample data file that is in fact a database is the same as doing so in PlanetPress Design. For more information, please see the relevant page in the PlanetPress Design User Guide. Note You can also use the PlanetPress Workflow Database action task to get data form a database, and output in multiple different formats such as CSV. See "Database Query" on page 299.
PAGE 38

To reopen a sample data file used previously: 1. Click the Debug tab in the PlanetPress Workflow Ribbon. 2. Click on Reopen Data File in the Data group. 3. Click on one of the data files in the list. 4. Use the Data Selector to change the emulation options if necessary. 5. Click OK on the Data Selector. Metadata Metadata is a hierarchical structure describing a job. Simply put, metadata is data about data or, in other words, information tagged to data.
PAGE 39

l l l Job: a file that contains 1 or more groups. Group: a logical and ordered group of documents (ex: all invoices for a specific customer number; all documents going to the same address, etc.). Document: group of 1 or more ordered datapages intended to the same recipient from the same source (ex: invoice). l Datapage: 1 atomic unit of content that produces zero, one or more pages. l Page: 1 side of a physical paper sheet. When metadata is produced for a given job, a hierarchical (i.e.
PAGE 40

A single JOB can be composed of GROUPS of DOCUMENTS, which themselves are composed of physical PAGES produced by executing a PlanetPress Design 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.
PAGE 41

In addition to attributes and fields, each node of type group, document or datapage has a Boolean property called 'selected' that indicates whether or not to produce the pages under that node. By default, this property is set to true for all nodes. Metadata attributes reference The Metadata attributes are categorized as either Production, Finishing or Index/Count. Production attributes describe the production of the job and/or metadata (e.g.
PAGE 42

Attribute Description Categor y J o b Gro up Docum ent DataEncoding (optional) Name of the character encoding. Producti on X X X 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.
PAGE 43

Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Creator Name of the software that created the source of the metadata. Producti on X X X 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).
PAGE 44

Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge and rotated landscape. Side "Front" or "Back"; indicates 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 X Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicates a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source.
PAGE 45

Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge dependent identifier of the media destination. g 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 Index IndexInDocument Index/C ount Returns the Absolute index of the node within all the nodes under the parent Document.
PAGE 46

Attribute Description Categor y IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group. Index/C ount IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
PAGE 47

Attribute Description Categor y J o b Gro up Count ount SelectedDatapage Count Index/C ount X X SelectedPageCoun t Index/C ount X X SelectedIndexInDo cument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInGr oup Returns the Absolute index of the node within all the selected nodes under the parent Group.
PAGE 48

Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge the parent Job. NumCopies Indicates how many times the job is set to execute, as set when printing using a Windows driver. Index/C ount X 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. Producti on X Metadata tasks A set of special Workflow plugins allows to edit the metadata during a Workflow process.
PAGE 49

l Generate metadata for any given sample datafile. l Graphically retrieve the value of a metadata attribute or field for use in any design object. l Define documents and groups using any condition. l Define custom metadata fields. l Manipulate Metadata with PlanetPress Talk commands.
PAGE 50

Metadata in document properties Page 50
PAGE 51

The Metadata tab in the properties of a PlanetPress Design document allows to easily define documents or groups. Metadata fields The Metadata Fields in the structure of a PlanetPress Design document allow to easily define documents or groups, by dragging and dropping data from the Sample Data directly onto the document's Metadata Fields. Data Repository The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes.
PAGE 52

request is received from an already authenticated user, if the session has expired, what the user name is, etc. Data comes in and is merged into a Capture OnTheGo template and stored in the Data Repository. The end-user augments the data (using the COTG as a data-entry system). The process that receives the augmented data could look into the Data Repository to retrieve the original data (or the ID of the original data records) in order to augment, modify or delete it.
PAGE 53

Accessing the Data Repository Via plugins Storing data in the Data Repository Data can be stored in the Data Repository using the Push to Repository task (see "Push to Repository" on page 331). Retrieving data from the Data Repository In any Workflow task where variable data is allowed (recognisable by the maroon field labels), information can be retrieved from the Data Repository using a Lookup function. Right-click a field with a maroon label and select Get Repository Location.
PAGE 54

Where to find the Data Repository In case the Repository contains valuable information that must not be lost in case of a hardware failure, create a backup of the repository. The Data Repository is located in the following folder: %ProgramData%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\Repository. About Documents A Document is a file sent to PlanetPress Workflow by PlanetPress Design and is used to produce an output when merged with data.
PAGE 55

The document is imported and displayed in the Configuration Components pane. This physically installs the documents to the Documents folder relative to the install folder of PlanetPress Workflow. Import PrintShop Mail Documents This procedure describes how to import variable content documents created in PrintShop Mail. Importing documents can be useful when transferring configurations between PlanetPress Workflow installations. To import documents into PlanetPress Workflow: 1.
PAGE 56

does not exist, or printing to a printer that cannot be found. When such an error occurs, in most cases you would want to be aware of it and to take certain actions in order to correct or report the error. This is where our error handling features come in handy.
PAGE 57

the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration. 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. If the task is not on a branch, the entire process will be stopped.
PAGE 58

your process, and will be triggered if the Send to Process option is checked in that tab and an error process is selected in the drop-down list. To create an error process, simply replace the initial input task by the InputErrorBin input task, and that process automatically becomes able to handle error jobs sent to it. It is up to you, however, to decide how that error job will be handled.
PAGE 59

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. Click on the service you want to check, including: l PlanetPress Workflow l LPD Server l Telnet Capture l Serial Capture l HTTP/SOAP Server l LPR Client l FTP Client l PlanetPress Image l PlanetPress Fax l PlanetPress Messenger 3.
PAGE 60

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.
PAGE 61

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.
PAGE 62

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.
PAGE 63

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.
PAGE 64

Note The sample job file should generally be the exact same format as the data that you will receive when PlanetPress Workflow is processing the job at run-time. For more 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.
PAGE 65

l l l l Use the Set Breakpoint button to tag the currently selected task, branch or condition as a breakpoint. When you click Run in your process, the process will execute every task until it reaches a breakpoint and will stop just before the task that is set as a breakpoint. Use the Ignore button to disable the task, branch or condition that is currently selected. If you disable a branch or condition, all tasks inside that branch or condition are ignored including the output.
PAGE 66

l If you need to continue debugging your process after the emulation change, you can still do it by using Skip on all the tasks until the emulation change, inclusively. Then use Step or Run to continue debugging. Lastly, PlanetPress Workflow 7.4 and higher also has an option that can be used in conjunction with the previous to avoid skipping through large processes: l l l Step through the process until the emulation or data change, as in the first method.
PAGE 67

l Inputs l Actions l Data splitters l Process logic l Connectors l PlanetPress Capture l Metadata Related l OL Connect Send l OL Connect l Outputs Note An Uncategorized category is dynamically created if your PlanetPress Workflow finds any plugin that would not be part of the existing Plug-in Bar. User-defined plugins and third party application plugins falls into such a category.
PAGE 68

l Move plugins from one custom category to another (that you cannot move default plugins from the default categories, you can only copy them) l Copy plugins from one custom category to another by holding the CTRL key. l Delete plugins from any custom category by using the Delete key. l Revert to the default Plug-in Bar by selecting Reset to default. To import a plugin: 1. Click on the popup control ( ). 2. Click on Import Plugin. 3. Browse to the location of the plugin DLL file. 4. Click on Open. 5.
PAGE 69

l Windows Driver Printing: l The Print using a Windows Driver output task lets you send a job to any printer installed on the computer, using its own drivers. In this particular case, the printer does not need to be a PostScript printer. See "Print Using a Windows Driver" on page 629. PlanetPress Workflow provides you with three main printing scenarios: l l Send output data to be printed as is: PlanetPress Workflow sends a file containing only the data to the selected queue.
PAGE 70

l l l l Windows Output printer queues are used to send print jobs to local or network printers. See "Windows Output Printer Queue" on page 72. LPR Output printer queues are used to send print jobs to printers via the LPR/LPD protocol. See "LPR Output Printer Queue" on page 73. FTP Output printer queues are typically used to send print jobs to FTP sites. See "FTP Output Printer Queue" on page 74. Send to Folder printer queues are typically used to send print jobs to local or network folders.
PAGE 71

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.
PAGE 72

Windows Output Printer Queue Windows output printer queues send print jobs to local or network printer queues set up in the Windows session in which PlanetPress Workflow is running. The corresponding Windows printer driver is used in the printing process. This type of printer queue does not support the transparency and duo-tone features, so you should not use it with PlanetPress Design documents that use those features.
PAGE 73

l l 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. Use the right-click menu for a list of standard printer control characters. LPR Output Printer Queue LPR output printer queues send print jobs to LPD-compatible printers using the LPD/LPR protocol.
PAGE 74

l l l l l l Commands: The list of available commands appears in this box. Select either Pre-job commands or Post-job commands in the Selected box, and double-click a command from this list to add it to the appropriate list. Selected: Select either Pre-job commands or Post-job commands to add new commands to the appropriate list and to see those commands that have already selected. Double-click a command to remove it from the selected list.
PAGE 75

l l l l l l Password: Enter a password associated with the FTP server user name entered above. Use FTP Client default port number: Forces the FTP connection on port 21, the default FTP port. FTP Port: Enter the FTP port to use. This option is disabled if Use FTP Client default port number is checked. The port should always correspond with the server's port number. Directory: Enter the directory to which the print jobs are to be uploaded.
PAGE 76

Send to Folder Printer Queue Unlike Send to Folder output tasks, which are typically used to send data files to local or network folders, Send to Folder output printer queues are mostly used to send print jobs. The files generated will always be PostScript files. Properties General tab l l l l Folder: Enter the path of the folder to which the print jobs are to be saved. File name: Enter the name of the print jobs sent to this queue.
PAGE 77

l l 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. Use the right-click menu for a list of standard printer control characters. Triggers In PlanetPress Workflow, a trigger is typically a two line piece of PostScript code placed just before the data.
PAGE 78

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. At the other end, PlanetPress Workflow specifically can capture the incoming stream and convert it internally into a PDF file along with its metadata.
PAGE 79

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 This will create an EMF data file.
PAGE 80

4. In the WinQueue Input properties, select a Windows print queue using the Objectif Lune Printer Driver (PS) from the drop-down list. 5. Click OK. 6. Send the configuration and start your PlanetPress Workflow service. 7. Start the windows application from which you want to capture data. 8. Open your selected document. 9. Click File | Print. 10. 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.
PAGE 81

About Processes and Subprocesses Processes A process is a single workflow within the configuration. A process begins with a single input task, contains one or more tasks and/or branches, and terminates with one or more output 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.
PAGE 82

by sharing them to the whole configuration file. They can thus be used to perform redundant operations that may need to be executed numerous times; for instance, archiving a copy of a zipped file received as the input job file, then decompressing it before sending the unzipped version of it back to the calling process . Whenever a process calls a subprocess, the main process (the caller) will wait for the called subprocess to finish its execution before carrying on with its own.
PAGE 83

l l l l l l Max percentage of threading (%): Determines how many processes you may have running at the same time. This is a percentage of the maximum number of threads specified in the "Messenger plugin preferences" on page 752. For example if the maximum number of thread is 10 and you specify 50% here, a maximum of 5 replications will occur (the original process + 4 copies). As soon as possible: Select to have the process run continuously.
PAGE 84

l Poll once per activity period: Select to perform this process’ initial input task no more than once for each set of contiguous blocks (blocks that are on the top of one another). Choosing this option overrides the polling interval option. By default since the Time Grid blocks are divided by hours, this option will make your polling happen once every hour. The Time Grid The PlanetPress Workflow Process Options dialog box includes a time grid that lets you set exactly when you want a process to run.
PAGE 85

l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two. l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
PAGE 86

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.
PAGE 87

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 17). To activate or deactivate a process: 1. Right-click the process in question in the Configuration Components pane 2.
PAGE 88

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.
PAGE 89

configurations both include a startup process, the one in the imported configuration will become a standard process. Important considerations l l When importing a PlanetPress Workflow configuration file, your PlanetPress Design and PrintShop Mail document are not physically imported as they are not part of the configuration file itself.
PAGE 90
PAGE 91

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.
PAGE 92

Condition or Action When using the Run Script as a condition, you need a way to tell your process whether the result is true or false. The condition result is returned by the "Script.ReturnValue" on page 119 variable. If the return value is zero (the default), the condition is false. Otherwise, it is true.
PAGE 93

perform common editing function, such as search and replace, and feature syntax highlighting and formatting. You can use the Script Editor to edit scripts written in VBScript, JavaScript, Perl and Python (note that the corresponding interpreter must be locally available). You can use the XSLT Editor to edit scripts written in XSLT 1.0 and 2.0. For information on how to use both editors, or for a complete description of the Script or XSLT Editor user options, refer to the Reference Help (English only).
PAGE 94

To export a script: 1. In the editor, choose File | Export. The Save As dialog box appears. 2. To save the script using a different scripting language or under a different file format, make a selection in the Save as type drop-down list. 3. Navigate to the location where you want to save the exported script. 4. Enter the name of the script in the File name box. 5. To save the script using a different scripting language or under a different file format, make a selection in the Save as type drop-down list. 6.
PAGE 95

l l l l l l l Regular expressions: Select to treat the regular expressions of the scripting language as text to search. If you clear this option, the regular expressions of the language are not included in the search. Global: Select to search the entire content of the script. Selected text: Select to find matching text within the text block you select. A portion of text must be selected before you run the search.
PAGE 96

l l l l l l l l l l l Text to find: Enter a new search string or select a previous search from the dropdown list. Replace with: Enter the string that will replace the string displayed in the Text to find box. Case sensitive: Select to limit the search to instances of text with the same case as the text in the Text to find box. Whole words only: Select to limit the search to complete words that match the text in the Text to find box.
PAGE 97

l 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.
PAGE 98

bookmarks may be harder to see. To control line number and gutter display, see "Editor Options" on page 769. 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.
PAGE 99

implements five methods that will allow SOAP clients to submit jobs and get information from PlanetPress Workflow executing them. Note PlanetPress Workflow already come with a SOAP Client plugin, 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.
PAGE 100

Return Value l l SubmitJobResult - Structure containing the following information: Success – Integer indicating the Success/Error level of the operation. A result of 0 means the operation was successful. l Message – String containing text information about the Success/Failure status. l SubmitJobInfStruc – See point SubmitJobInfStruc for details. l ResultFile – base64Binary. If Success is different than 0 or the ReturnJobFile was set to False in the initial call, no file is returned.
PAGE 101

Description The PostJob method allows users to remotely submit files to PlanetPress Workflow by using the Resubmit from here feature. The main advantage of this feature is that it allows a user to specify a starting task index from which the File is to be processed. Parameters l l File – base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64).
PAGE 102

SOAP API - GetProcessList Syntax GetProcessList (user name, Password) : GetProcessListResult Description The GetProcessList function allows SOAP clients to request the list of available PlanetPress Workflow processes, based on their authentication credentials. Parameters l user name – String containing the user name. l Password – String containing the password. This value is case sensitive.
PAGE 103

Description The GetProcessTaskList function will allow a user to remotely request the tasks list of a process. This will be useful with the PostJob API since it needs a TaskIndex. Parameters l ProcessName – The Name of the PlanetPress Workflow process. l user name – String containing the user name. l Password – String containing the password. This is case sensitive.
PAGE 104

Description The GetSOAPProcessList function will allow users to request the list of PlanetPress Workflow processes that contain a SOAP Input plugin with the SOAP action name. This is useful when working with the SubmitJob API since it requires a SOAPActionName. Parameters l user name – String containing the user name. l Password – String containing the password. This is case sensitive.
PAGE 105

l VariableName – String l VariableValue – String l ProcessName – String - Name of the PlanetPress Workflow process. l TaskIndex – Integer - 1 based index of the task where the resubmission should start. l FirstPage – Integer - First page of data to process. l LastPage – Integer - Last page of data to process. Note If both FirstPage and LastPage are set to 0, the entire data file is used.
PAGE 106

some languages (especially JavaScript) are case-sensitive and will require the proper case. Examples in this chapter will always use the proper case when relevant. Here is a list of the methods and functions that are available to you through the automation object (or "Watch" object). While these examples are all in VBScript, you can click on any variable name to open a page to see examples for each supported language. Variable Name Description Example Usage (VBScript) "Watch.
PAGE 107

Variable Name Description Example Usage (VBScript) Example Usage: str = Watch.getvariable("Varname") "Watch.ExpandString" on page 116 Retrieves the content of any Workflow string, containing any variable available to Watch, including data selections. Example Usage: watchDate = Watch.expandstring("%y-%m-%d") "Watch.Log" on page 117 Writes to the Workflow log file, or the message window when in debug - can accept multiple log levels from 1 (red) to 4 (gray). Example Usage: Watch.
PAGE 108

Variable Name Description Example Usage (VBScript) World!" "Watch.Sleep" on page 119 Pauses all processing for X milliseconds. Example Usage: Watch.sleep(1000) "Watch.ExecuteExternalProgram" on the facing page Calls and executes an external program in the command line. Example Usage: Watch.executeexternalprogram "del *.ps" "c:\" 0 true "Script.ReturnValue" on page 119 Returns a boolean True or False value to a Workflow scripted condition Example Usage: Script.returnvalue = 1 Watch.
PAGE 109

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.
PAGE 110

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); Pyth
PAGE 111

Example In the following example, GetJobFileName() retrieves the name of the job file, which is then logged using "Watch.Log" on page 117. 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.
PAGE 112

Perl $Watch->GetOriginalFileName(); Watch.GetMetadataFilename Returns the complete path and file name of the metadata file associated with the current job file. 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.
PAGE 113

You must enable the “Run on desktop” option for the PlanetPress Workflow process whose script calls Watch.InputBox. Otherwise PlanetPress Workflow application may stop working and require a reboot. Example s = watch.inputbox("caption", "message", "default") watch.showmessage(s) 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 108. VBScript s = Watch.
PAGE 114

Syntax Watch.GetJobInfo(Index: integer): string Example VBScript Dim s s = Watch.GetJobInfo(3) Watch.Log "Jobinfo 3's value is: " + s, 2 JavaScript var s; s = Watch.GetJobInfo(3); Watch.Log("Jobinfo 3's value is: " + s, 2); 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.
PAGE 115

Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.GetVariable Returns the string value of the corresponding variable name. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.GetVariable(Name: String): String Example VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.Log "MyVariable's value is: " + s, 2 s = Watch.GetVariable("global.MyVariable") Watch.Log "global.
PAGE 116

Watch.SetVariable Sets the variable to a specified string value. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.SetVariable Name: String; Value: String Example VBScript Watch.SetVariable "MyVariable", "Desired value" Watch.SetVariable "global.MyVariable", "Desired value"/ JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); Python Watch.SetVariable("MyVariable", "Desired value") Watch.
PAGE 117

Example This example results in expanding the string of the variables to the date value in the following format: “YYYY-MM-DD”. VBScript Dim s s= Watch.ExpandString("%y-%m-%d") Watch.Log "Current Date is: " + s, 2 JavaScript var s; s= Watch.ExpandString("%y-%m-%d"); Watch.Log("Current Date is: " + s, 2); Python s= Watch.ExpandString("%y-%m-%d") Watch.Log("Current Date is: " + s, 2) Perl $s = $Watch->ExpandString("%y-%m-%d"); $Watch->Log("Current Date is: " . $s,2); Watch.
PAGE 118

Level Type Text Color in Service Console 3 Information Black 4 Debug Grey Arguments Message—A string representing the message that is logged in the log file. Note that the text of the message must use the locale encoding of the system where the PlanetPress Workflow software will be running, otherwise it will be unreadable. Level—An integer between 1 and 4, specifying the severity level of the error message.
PAGE 119

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. This can be used while waiting for something else to happen when the delay is known. Syntax Watch.Sleep Milliseconds: integer Example In the following example, sleep() pauses the process for 1 second (1000 milliseconds) VBScript Watch.Sleep 1000 JavaScript Watch.Sleep(1000); Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.
PAGE 120

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.ReturnValue = 1 else Script.ReturnValue = 0 end if JavaScript var everythingOK; everythingOK = true; if(everythingOK = true){ Script.ReturnValue = 1; } else { Script.ReturnValue = 0 } Python everythingOK = True if everythingOK == True: Script.ReturnValue = 1 else: Script.
PAGE 121

Data Repository API The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes. The Data Repository can be accessed at runtime by the Push To Repository plugin and other tasks (see "Data Repository" on page 51) and at design time via the "Data Repository Manager" on page 721. This topic explains how to access the Data Repository in script. For a quick start, turn to this How-to: Interacting with the Data Repository API.
PAGE 122

API Reference Obtaining an instance of the Repository Object The Data Repository is accessed via a COM object that exposes methods to store and retrieve data within the Repository. JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); VB Script set repoObject = CreateObject("RepositoryLib.WorkflowRepository") In each example in this documentation, the object repoObject is deemed having been obtained through the above call to the COM object.
PAGE 123

Group methods Name Description AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys. ListGroups Retrieves the list of all group names in the Repository, stored in a JSONStringArray.. RenameGroup Renames group oldName to newName.
PAGE 124

Name Description JSON.Parse() to convert the string into an actual JavaScript object. You can then use the for…in construct to list the different properties for that object (i.e. the keys in the group). RenameKey Renames key oldName to newName in group GroupName. While this operation has no impact on the data stored in that Group, it does require any plugin and/or script that uses oldName to be modified to refer to newName.
PAGE 125

Name Description were updated. SetValueByID Updates KeyName with Value in group GroupName, where the keyset's ID matches the ID parameter. KeyName must exist in GroupName, otherwise an error is raised. The method returns the ID of the keyset that was updated or -1 if the keyset was not updated. Note that this method is functionally equivalent to using SetValue() with its Condition parameter set to "ID=ID".
PAGE 126

Name Description RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise. Note that this method is functionally equivalent to using RemoveKeySets() with its Condition parameter set to "ID=ID". Repository management methods Name Description ClearRepository Deletes all groups, keys and keysets from the repository, returning it to a blank state.
PAGE 127

Syntax AddGroup(GroupName: string, keyNames: JSONStringArray) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 122). JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.AddGroup("Users", ''); VB Script repoObject.AddGroup "Users", "[""FirstName"", ""LastName""]" repoObject.
PAGE 128

AddKeySets Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues must exist otherwise an error is raised. However, it is not required to specify all available keys in KeyValues. Only the keys specified are updated in GroupName while unspecified keys are set to an empty string.
PAGE 129

Tip: to update a row instead of adding it, use the GetValue() function to get the KeySet ID; then update each individual value using SetValueByID() (see "GetValue" on page 132 and "SetValueByID" on page 139). Sample return value The method returns a JSONIntegerArray containing the ID's of all keysets inserted into GroupName: '[131,132]' AddValue Creates a new KeySet by assigning Value to the key KeyName in Group GroupName. Note that KeyName must exist in GroupName, otherwise an error is raised.
PAGE 130

access to the Repository. You should therefore only perform this operation when you know for sure no other process is accessing the Data Repository. Syntax CheckRepository() ClearAllData Delete all keysets in all groups, while retaining the existing key structure. Syntax ClearAllData() ClearGroupData Deletes all keysets inside GroupName while retaining the existing key structure.
PAGE 131

Examples Basic examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 122). JavaScript repoObject.GetKeySets("Users", '["FirstName","LastName"]', "Gender='M'"); VB Script myKeySet = repoObject.
PAGE 132

The return value (saved for example in the %9 JobInfo variable, as the above example does) can be used in a number of ways: l l l It can be returned to a web page that's making an HTTP request to Workflow. JSON is the simplest way to transfer information between any system that supports JavaScript. It can be passed to Designer and loaded up directly as an object in a script there. The JSON can be converted to XML, which makes it useable in the DataMapper module.
PAGE 133

John Smith */ myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" ") /* retrieves email for first user named Smith */ myValue = repoObject.GetValue("Users", "email", "") /* retrieves email for first user */ Retrieving a KeySet ID This JavaScript example retrieves the KeySet ID, which is then used to update values in the row. /* Get KeySet ID */ var Repo = new ActiveXObject("RepositoryLib.WorkflowRepository"); var keySetID = Repo.
PAGE 134

Sample return value '["Users","Cart","Orders"]' ListKeys Retrieves the list of all Key names and data types in Group GroupName, stored in a JSONStringObject. You should use JSON.Parse() to convert the string into an actual JavaScript object. You can then use the for…in construct to list the different properties for that object (i.e. the keys in the group).
PAGE 135

Syntax RemoveGroup(GroupName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 122). JavaScript repoObject.RemoveGroup("Users"); VB Script repoObject.RemoveGroup "Users" RemoveKey Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised.
PAGE 136

RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise. Note This method is functionally equivalent to using "RemoveKeySets" below with its Condition parameter set to "ID=ID". Syntax RemoveKeySetByID(GroupName: string, ID: integer): integer Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.
PAGE 137

Examples Basic examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 122). JavaScript repoObject.RemoveKeySets("Users", 'Gender="M"'); VB Script repoObject.RemoveKeySets "Users", "Gender='M'" Deleting a row This script attempts to delete a client from the rows, then returns "true" or "false" in JobInfo variable %9 as a response.
PAGE 138

JavaScript repoObject.RenameGroup("Users", "Customers"); VB Script repoObject.RenameGroup "Users", "Customers" RenameKey Renames key oldName to newName in group GroupName. While this operation has no impact on the data stored in that Group, it does require any plugin and/or script that uses oldName to be modified to refer to newName.
PAGE 139

Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 122). JavaScript repoObject.SetValue("Users", ); repoObject.SetValue("Users", AND MaritalStatus='Married'" repoObject.SetValue("Users", AND MaritalStatus=''" ); "FormOfAddress", "Mr.", "Gender='M'" "FormOfAddress", "Ms.
PAGE 140

Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 122). JavaScript /* both methods perform the same task */ repoObject.SetValueByID("Users", "FormOfAddress", "Mr.", 10); repoObject.SetValue("Users", "FormOfAddress", "Mr.", "ID=10" ); VB Script /* both methods perform the same task */ repoObject.SetValueByID "Users", "FormOfAddress", "Mr.
PAGE 141

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. However, when available, a description of the error message will be logged in the Watch log. VBScript In VBSCript, the Err.
PAGE 142

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.Log("Job Info 9's value is: " + s,5) Perl In PERL, die() raises an exception and triggers the On Error tab, unless the unless command is used. See the perl documentation.
PAGE 143

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 186 for more details. PlanetPress Capture Workflow A Capture workflow is divided in two steps: Creating an output of documents containing the PlanetPress Capture Fields, and retrieving the information from the Anoto Digital Pen to merge it with the original documents.
PAGE 144

In order to properly build a PlanetPress Capture workflow, it is very important to understand the terminology, implications and limitations of the technology.
PAGE 145

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 228 task or "Folder Capture" on page 213 task that receives the PGC.
PAGE 146

Error Handling Whenever an error occurs during the Capture Field Processor phase, it is of course important to be able to handles these errors. For this purpose, the "PGC to PDF Converter" on page 506 task was added with PlanetPress 7.4, adding the ability to quickly and directly convert a PGC file to a blank PDF file containing the ink data as an EPS layer. This is useful when, for example, data is received for a document that's already been closed.
PAGE 147

Anoto Pattern A series of dots placed in a pattern that is unique to each page where the pattern is printed. The Anoto Digital Pen identifies this pattern and its location on the page. PlanetPress Capture contains 20,000 patterns (8 in demo mode, See "PlanetPress Capture License Management" on page 747) which can be used to generate documents. Capture Condition PlanetPress Workflow task that is used for post-processing of documents after they have been processed by the Capture Fields Processor.
PAGE 148

Closed Document A document still within the PlanetPress Capture Database of which all the required fields have been filled by the Capture Field Processor from a PGC. A closed document will only remain in the database until it is retrieved with the Get Capture Document task, after which it is deleted. Contamination The act of writing on a "wrong" document, aka one that has a Pattern Sequence different that the one for which it was produced..
PAGE 149

that of the document causes Contamination, which can cause errors or ink to be placed on the wrong document. Pen ID The serial number of the Anoto Digital Pen. It is registered in the PlanetPress Capture database and is present in each PGC file. PGC File Pen Generated Coordinates; PGC File containing all ink processed while the pen was undocked along with the Pen ID. It is possible that a single document requires multiple PGC, just as it is possible that a single PGC have multiple documents.
PAGE 150

Warning PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently. In order to design a document with Capture Fields, you must review and understand the Critical PlanetPress Capture Implementation Restrictions.
PAGE 151

l l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database can be in any location, but performance will depend on the speed of the connection between PlanetPress and the MySQL server. MySQL's performance has been slower than SQL Server and SQL Server Express during our tests. By default, MySQL is configured not to allow any SQL request larger than 16 megs.
PAGE 152

l In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue. Security Considerations PlanetPress Capture introduces new and efficient methods for digitally capturing the contents of ink laded out on physical paper. However, because of its nature, some end users may voice concerns about security and privacy.
PAGE 153

l l l l The transfer between the Anoto penDirector and PlanetPress Workflow is not encrypted due to a limitation of penDirector which does not support SSL connections. This means someone located anywhere between penDirector and PlanetPress Workflow could use software such as a packet sniffer to retrieve its parts and recreate the PGC files. This may be resolvable by create a secure VPN tunnel for each location where penDirector is installed instead of going through regular remote HTTP server.
PAGE 154

mode (no license activated), and react the same way that the bulk of the 20,000 patterns. Another single pattern is used to register pens in the database, and one last single pattern is used when printing a "Preview" from PlanetPress Design. So in reality, the number of available patterns for document generation is 19990, but for simplicity's sake this FAQ uses the round number "20,000".
PAGE 155

like this one would be perfectly functional and not be affected by the 20,000 page limit. Remember however that this means that 19,000 physical sheets of paper are printed every day, and those 19,000 documents are written on using one or more Anoto Digital Pens, which are then processed back into the system. The example above actually uses numbers that are much higher than our typical PlanetPress Capture user.
PAGE 156

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. When documents are printed, they are set to attribute a pattern sequence to each document in relation to which pen it will be signed on.
PAGE 157

added to PlanetPress Capture in version 7.4. 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.
PAGE 158

pens inadvertently (we hope, anyways), the pens would be signing the "wrong" documents all day and, when docked, would update the wrong documents in the database. In all of these cases, the errors often do not appear when the wrong document is updated - it actually occurs when the "right" data is processed.
PAGE 159

Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc. The penDirector creates a bridge between the Anoto Digital Pen and a PlanetPress Capture workflow in PlanetPress Workflow. In order to use penDirector, it needs to be downloaded from the Objectif Lune website, on this page. This software must be installed after PlanetPress Workflow. The setup will install a preconfigured version of penDirector which can be immediately used with PlanetPress Capture.
PAGE 160

3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4. Go in the Bluetooth tab of penDirector and click on Add Pen. 5. Click on Search while the cap is off on the pen. 6. When the pen is found, click on it and then click Add. 7. When asked for the PIN, enter the one noted above. 8. Click OK to save the settings. The settings for Bluetooth PGC handling are separate from the ones used when docking.
PAGE 161

PlanetPress Capture Implementation Restrictions This document describes the limitations of the Anoto Digital Pen & Paper Technology, especially in regards to using it within a PlanetPress Workflow implementation. Note that these limitations apply to any Anoto technology implementation and not just our own. Printer limitations Any document printed with Capture Fields (aka Anoto Patterns) must be sent through a Laser printer.
PAGE 162

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. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
PAGE 163

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.
PAGE 164

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.
PAGE 165

PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition". The difference between the two is easily explained: While OCR can only recognize characters using the finished shape (for example, in scanned documents and pictures), ICR relies on much more data which is provided by the Anoto Digital Pen: the path that the pen takes, the exact timing of this path, start and stop points, etc.
PAGE 166

User Guide). This must be either a Multi-Area Field or a Text Field. l l l 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. This is done by reading the ICR data that is available in the metadata generated by the Get Capture Document task. The metadata is also readable by the Capture Condition task, including the captured text and the reliability of this text.
PAGE 167

l l l ICR Value: The alpha, numeric or alphanumeric value that was determined by the ICR engine. 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.
PAGE 168

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.
PAGE 169

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.
PAGE 170

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.
PAGE 171

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.
PAGE 172

Why: The available filters to interpret the ink marks done with the Anoto digital pen, allow you to select the engine language to be used. Doing so will give you results that are the closest match to the captured data. 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.
PAGE 173

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.
PAGE 174

l Any input task l "Create Metadata" on page 509 l "Capture Fields Generator" on page 482 l 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.
PAGE 175

Post-Processing is generally done using the "Capture Condition" on page 476 task, which verifies the presence or state of the ink on the document or on specific fields. After PGC Handling Here is an example of a process that receives ink data, updates the database, and then verifies whether or not a field that indicates manager attention is required (for example, a box noting the wrong number of items in a delivery slip). If attention is required, the document is sent via email to the manager.
PAGE 176

l l The Capture Fields Processor then uses the PGC file to update any documents in the database that the pen wrote on, and closes those documents in the database when they are complete. Capture Condition is where we can check whether a specific field (a "RequireManager" field) has ink contained in it, and if it does, the branch on the right is triggered.
PAGE 177

Task Breakdown 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.
PAGE 178

to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met". l With this list of documents in the metadata, we Branch off. This is done because we need to build a report that will be sent to an administrator, and only one email should be sent. l l To build the report, inside of the branch we use the Metadata Sequencer to create one sequence for each document, by splitting at the Document level, by 1 occurrence of the level for each sequence.
PAGE 179

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 660). 9. Open your browser and point it to http://127.0.0.1:8080/documentlist , assuming you have not changed the default HTTP port in the HTTP Server Input 2 section.
PAGE 180

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.
PAGE 181

l l Enable server for SSL requests: This enables secure communication between the browser and the server via HTTPS. By enabling this option, you will need to provide for the proper certificates, key and password. While this configuration is beyond the scope of this document, there are plenty of resources on the Internet to explain these systems. Serve HTTP resources: This is where you enable static resources in PlanetPress Workflow.
PAGE 182

new request. This should be put at 0 in order to process requests as soon as possible, meaning immediately. And finally, the HTTP Server Input task properties. While these are described in the "HTTP Server Input" on page 228 task properties page, here are a few considerations to keep in mind when using this task: l l l l l The HTTP Action corresponds precisely to the name immediately following the first slash of your address.
PAGE 183

3. The XML request file and attachments are saved in a local folder, if the HTTP Action is a valid one (otherwise, the files are deleted). 4. The HTTP service keeps the request from the client open (it does not yet respond ot it), and waits. 5. The HTTP process corresponding to the HTTP Action captures the XML file and attachments and the process begins. 6. The process runs its course just like any other process would (including subprocesses, send to process, etc). 7.
PAGE 184

HTTP PDF Invoice Request This straightforward workflow simply receives a GET request from a browser, loads an existing PDF invoice from a folder on the hard drive, and returns it to the browser. To do this, a client (or a web service) would request the following page: http://ppworkflowserver:8080/getinvoice?in=INV999999 Breakdown of this URL: l l http:// : transfer protocol. This could be HTTPS if the SSL certificates are activated in the preferences. ppworkflowserver : name of the machine.
PAGE 185

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 402. The condition returns "true" if the file is not found: c:\PlanetPress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value,KeepCase,No
PAGE 186

l l Open HTTPBrochureRequest.pw7 and send the configuration to your local PlanetPress Workflow service. Open your browser to http://localhost:8080/generatebrochure Task Breakdown l l l The HTTP Server Input receives the initial request from the browser. Because this is a demonstration, a backup is made of the XML request. It's not suggested to do this every time, especially on servers receiving a large number of requests, as these files do take some amount of space for each request.
PAGE 187

The idea is that a PDF file, because it is a formatted document in and of itself, doesn't absolutely need to go through PlanetPress Design to be processed and printed. Additionally, because of the PDF tools in PlanetPress Workflow, you can easily merge, split, print and take parts of the PDF file as required.
PAGE 188

l l l l "Run Script" on page 409 tasks can also modify metadata using the Metadata API (See "Using Scripts" on page 91). The "Barcode Scan" on page 279 task can add information to the existing metadata, and creates it if there is none. The "Capture Fields Generator" on page 482, "Capture Fields Processor" on page 486, "Get Capture Document" on page 502 and "Find Capture Documents" on page 497 tasks generate their own metadata.
PAGE 189

l l l l l l l l The "Metadata Level Creation" on page 524 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 515 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.
PAGE 190

the printer driver installer (by default: olcs_transfer). The Job Processor plugin is the only other task in this Workflow process (see "Job Processor" on page 549). Interactive process When a job is received in licensed mode, an interactive process is started. This process, which may consist of several Workflow processes, serves web pages to the customer and handles the customer's response, changing (settings for) the print job.
PAGE 191

settings and print the provided Word file to that printer. The printer will trigger an interactive process on demo.objectiflune.com. l Download the sample files from OL's Resource Center: http://help.objectiflune.com/en/#csend. The basic processes involved in the Capture OnTheGo Workflow PlanetPress® or PReS® Connect is an extremely flexible solution that lets you do almost anything you want with your data.
PAGE 192

This process watches a certain folder. When a file enters that folder, a data mapping is performed on it. Then an HTML file is created and saved to another folder. The Output to PlanetPress Workflow plugin sends a ticket (not the actual HTML file) to the Capture OnTheGo Server, so that when the intended user logs in, the name of the HTML file will appear in the App's Repository, signaling to the user that the file is available for download.
PAGE 193

The Process that Receives Data from Capture OnTheGo Users HTML documents that were downloaded can be used to collect information. This information can be extremely varied, ranging from a simple signature confirming the reception of a parcel, to a complete report including numbers, notes, pictures, etc.
PAGE 194

Since this part of the processing is handled by PlanetPress or PreS Workflow, you can use its renowned feature set to do virtually anything. For detailed information on how to use and configure the HTTP Server Input task to reply to POST requests, refer to PlanetPress Workflow documentation. Also refer to the same documentation to know how to add those tasks that will let you send or process the received data as required.
PAGE 195

Note: To make sure that documents are served only to users of the COTG app, the Input task authenticates download requests, using the authentication key of the COTG repository. This key can be found in the Parameters section of the COTG Web Administration Panel. Enter the key in the HTTP Server Input 2 User Options in the Workflow preferences (see HTTP Server Input 2 User Options (PreS) or HTTP Server Input 2 User Options (PlanetPress)).
PAGE 196

Downloaded PDF documents can then be opened for viewing, and HTML documents can be used to collect information that can then be sent back for processing. About Tasks A task is a plugin 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. You can add as many tasks as you like to your processes and order them in any way you can.
PAGE 197

Some tasks have a multipurpose and can be used as either an input, action or output task or any combination. These multipurpose tasks are indicated as such in the task description and can be found in the most relevant section of the available tasks.
PAGE 198

when, for example, you want to determine how many copies you will print out depending on your data, or what document will be used in the printout depending on the department it came from. Variable properties may include: l Static data. l Standard Variables. See "Standard Variables" on page 646. l Local and Global Variables. See "Manipulate Local Variables" on page 683. l Job Infos. See "Job Info Variables" on page 645. l Data and Metadata Selections. See "Data selections" on page 26.
PAGE 199

l Variables l System: Contains system variables, also called "Standard Variables" on page 646. l Job Info: Contains Job Info variables from %1 to %9 l l l l l l l l l Local Variables: Contains a list of local variables in this process. If no local variables exist, this item is disabled. Global Variables: Contains a list of global variables in this configuration. If no global variables exist, this item is disabled.
PAGE 200

l l Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example. The lookup() function indicates a lookup in the "Data Repository Manager" on page 721. Unknown Tasks An unknown task is a task location that is not linked to any existing known task. Unknown tasks can have multiple causes: l l l l l Cutting an input or output task will replace it with an unknown task.
PAGE 201

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. l l l Asterisk (*): Supports any number of characters. *.txt would pick up any text file, file*.
PAGE 202

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).
PAGE 203

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.
PAGE 204

This is an important consideration when scheduling a task, as the Folder Capture will keep capturing files as long as new files are added, even if it means continuing to capture and process outside its scheduled 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.
PAGE 205

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.
PAGE 206

l l Add CRLF after last line: Check if you want the plugin to automatically add a new line at the end of the file. Remove the checkmark to leave the file as-is, useful in the creation of CSV files for example. Delete Metadata: Check to delete any metadata attached to your data file. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task.
PAGE 207

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.
PAGE 208

error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not 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.
PAGE 209

Output Depending on the options, each email is sent as a data file, followed by each of its attachments sequentially. Technical If you use Email input tasks to capture data encoded using a Double-Byte character set (such as those used for Japanese or Chinese, for instance), it is preferable to use attachments rather than the email body to carry the data from its source to the input task, as data corruption is less likely to occur using this method.
PAGE 210

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.
PAGE 211

"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.
PAGE 212

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 213

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 214

files in the queue. Once all the files are gone, the task polls the input folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. Output The output to this task is a series of individual files, one after the other. These files are not modified in any way from when they are captured from the source folder.
PAGE 215

Note No Variable Data can be used inside this field if the Treat as regular expressions option is ticked. The percent sign, the curly brackets and the period are all key elements of the RegEx syntax, therefore they cannot be mixed and matched with Workflow variable data syntax (e.g. %1, ${global.myvar}, etc.). Also, there is no validation of the RegEx being specified.
PAGE 216

l l l l 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. 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.
PAGE 217

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 218

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Folder Listing Folder Listing input tasks list the files present in a selected folder and gives you the option to use filename masks, to sort files by name or date, and to list the files present in the selected folder’s subfolders. The lists it generates are in XML format.
PAGE 219

C:\Samples\manuals\ usermanual.pdf C:\Samples\manuals\ 1999/10/06 09:52:04 644037 Note The tag is independent of the OS locale, language or settings. The format is always YYYY/MM/DD 23:59:59. Properties General Tab l l l l Input folder: Enter the path of the folder that contains the files you want listed.
PAGE 220

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 %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 in the" Task Properties Dialog" on page 777.
PAGE 221

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 222

Input FTP Input connects to the specified FTP server and path, and 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.
PAGE 223

"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.
PAGE 224

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 225

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 226

General tab l l URL: Enter the URL of the HTTP server from which the file must be downloaded. Since this is a variable property box, variables may be used, as well as the Get Data and Select Data commands. Note that when PlanetPress Workflow connects to a secure page, an SSL (Secure Socket Layer) connection is automatically used. Server requires authentication: Check this option if the HTTP server requires user authentication. This enables the following options.
PAGE 227

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.
PAGE 228

error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not 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.
PAGE 229

Input The HTTP Server Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received. Actually, it is the HTTP service that receives the requests and places them in a specific location on the drive. When a request is received, the HTTP Server Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received.
PAGE 230

last output generated by PlanetPress Workflow is sent back to the initial input, which is returned back to the client. Note Starting in version 7.2 of PlanetPress Workflow, you can now serve static resources through PlanetPress, which is especially useful for images, CSS and JavaScript files. See "HTTP Server Input 2 plugin preferences" on page 756. HTTP Server input task properties are as follows: l l l HTTP action: Enter the name of the action requested of PlanetPress Workflow by the client.
PAGE 231

will be returned in the response header. This is the value that is present at the end of the process, not the beginning. "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.
PAGE 232

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 233

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 234

The following error information is generated by the Input Error Bin starting version 7.5, and is accessible throughout the process: l l %{error.process}: the process name where the error occurred. %{error.tasktype}: the type of the failed task, can be Action, Input, Output, Printer, Comment and Branch. l %{error.taskname}: the name of the plugin (the Display Name as seen in the plugin bar). l %{error.taskindex}: the index of the task in the process (its position in the process). l %{error.
PAGE 235

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 in the" Task Properties Dialog" on page 777.
PAGE 236

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 237

Input This task does not poll any location by itself. It sits there waiting for requests coming in through WSDL (SOAP communication) and, when it receives a request, runs the process and returns the last output generated by the process to the client. Processing No processing is done. The request that is received by this task is XML and it is maintained as such. Output As with the HTTP Server Input, this task has a dual-output purpose.
PAGE 238

"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.
PAGE 239

l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
PAGE 240

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. LPD Input LPD (Line Printer Daemon) input tasks retrieve data in the form of print files sent from remote computers using the LPD/LPR protocol.
PAGE 241

Properties General tab l LPD queue name: Enter the queue name specified in the printer queue on the remote computer or computers. "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.
PAGE 242

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.
PAGE 243

error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not 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.
PAGE 244

Processing Once all PDF files are captured, their original copies are deleted from the input folder (or tagged as Archive if this option is selected) and they are merged into a single PDF. This is done in a single operation, not incrementally, meaning the file is built once and, if the option is chosen, optimized once. 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.
PAGE 245

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.
PAGE 246

Examples & Use Cases This task is put into effect in the following use cases and example processes: l Daily Sales Report from PDF Files On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 247

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 Workflow 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.
PAGE 248

Input This task does not poll an input, it sits there and waits for a job file to be sent through the Serial connection. Processing When the job is received through the Serial connection, 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. General Tab l Since Serial Input tasks have no specific task configurable properties, this section contains no property information.
PAGE 249

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 250

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 251

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. Once all the files are gone, the task polls the FTP folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. Output The output to this task is a series of individual files, one after the other.
PAGE 252

Note The given directory will be looked up from the user's home directory. Such a home directory is usually under the server main user directory and generally includes the user’s name. For example, if "/tmp/temp/copy_pending" is entered, it does not point to the "/tmp/temp/copy_pending" directory but to the "/users/support/tmp/temp/copy_ pending" directory. l l l Delete remote file: Check this option to delete the file after it has been retrieved by Workflow.
PAGE 253

l l Approve: Click to add the server to the list of approved servers. Refresh: Click to refresh the list of known servers "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.
PAGE 254

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. Action: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 255

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 256

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.
PAGE 257

l l Data location: Determines what files are sent into the process: l Envelope: Only the request envelope is sent to the process (see above). l Attachments: Each attachment is sent down the process (see above). Unzip attached file: Select to unzip the attached files. l l Zip password: Enter the password required to unzip the attached files (if any). Note that you can use variables and data selections. Conditions: Defines a filter on capturing files from the SMTP Service's hot folder.
PAGE 258

Job Information definitions l %1 - Date Received: Contains the date and time at which the email was received. l %2 - Originator Name: Contains the Name of the sender (in the from field). l %3 - Originator Address: Contains the Email address of the sender (in the from field). l %4 - Recipients: Contains the recipient(s) of the email (in the to field). l %5 - CC: Contains the Carbon Copy recipient if there is one (in the cc field).
PAGE 259

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 260

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Example In this example, the SMTP Input plugin is used to capture incoming emails data that must meet certain conditions as the subject that contains "Work to do" and the sender that contains "client@company.com ". The process then redirects the content of those emails to an extraction and finally to a PDF printing.
PAGE 261

Telnet Input The Telnet Input Task (also known as the Raw Socket Printing Input) receives files sent to a specific port.
PAGE 262

use multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see "Telnet Input plugin preferences" on page 759). Input This task does not poll an input, it sits there and waits for a job file to be sent through the Telnet port. Processing When the job is received through Telnet, 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.
PAGE 263

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 in the" Task Properties Dialog" on page 777.
PAGE 264

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 265

Note Before you go through the following procedure, on the computer running PlanetPress Workflow you will need to create a local printer queue that will be used to receive data files in the form of print jobs. This queue can be shared, so as to be able to receive jobs sent from local as well as remote users. To ensure that the spooled files created by PlanetPress Workflow queue remain in the spool folder, the printer queue must be paused.
PAGE 266

l Printer properties group l l Spool Print Job ins EMF Format (Advanced printing features): Select to create EMF files for Windows Print Converter action tasks (see "Windows Print Converter" on page 362). Note that this option must not be selected when capturing generic text type data. Spool Print Jobs in RAW Format: Select to output in RAW format, which is the exactly the data that the computer receives (and is not converted in any way).
PAGE 267

l l %3 - Printer name: Contains the name of the printer in which the job was received. Is the same for all jobs received on any given printer. %4 - Document name: Contains the name of the job as seen in the printer queue from which it is captured. This name is defined by the software that creates the print job. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 268

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 Workflow 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.
PAGE 269

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.
PAGE 270

l "Windows Print Converter" on page 362 l "XML/JSON Conversion" on page 365 Add Document The Add Document action task prepares a printer-centric PostScript job by adding a PostScript version of a selected PlanetPress Connect document and the trigger to execute it before the active data file. 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 Design document.
PAGE 271

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.
PAGE 272

error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not 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.
PAGE 273

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 l l l l l l l Action group l Add: Select if you want the task to add content to the job file. l Remove: Select if you want the task to remove content from the job file. Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file.
PAGE 274

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 275

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 276

Processing The appropriate changes are made to the data file (replacing text). 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 Search line by line: Select if you want each line in the data stream to be searched separately.
PAGE 277

this option is selected, “DAY” and “DAYS” will not be considered as matching strings. l Position options group: Specify the location where the string must be found using this group. Note that this whole group is disabled when the Treat as regular expression option is selected. l l l l l l Anywhere on the line: Select to indicate that the search string can be anywhere on the line. At the beginning of a line: Select to indicate that the search string must be the first string on the line.
PAGE 278

l l All before occurrence: All occurrences of the search string will be replaced until the specified number of occurrences has been reached. Specifying 5 occurrences, for instance, means that the four first occurrences will be replaced. Replace with: Enter the string that must be used as the replacement sting when a match is found. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 279

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 280

Input Image formats supported by the Barcode Scan task are: l Tag Image File Format (TIFF) l Portable Document Format (PDF) l Joint Photographic Experts Group (JPEG and JPG) l Portable Network Graphics (PNG) l Bitmap (BMP) Processing The task reads the image and detects the presence of the selected supported barcode types. When a barcode is detected, the data it contains is read and added to the Data Page level of the metadata.
PAGE 281

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.
PAGE 282

Barcode types Description encode up to 2509 numeric or 1520 alphanumeric characters. 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 plugin performs. Selecting only the expected barcodes is therefore a good practice. Barcode Orientations Barcode orientations represent a barcode orientation on an image.
PAGE 283

l Process by: Select to define whether to process the image by page or by file: l l l l l Process by Page: The task is able to handle single or multiple page files (Tiff and PDF) and act as a loop to process each page independently and sequentially. The metadata file will be created separately for each page if it does not exist or will be enhanced with the values on processed Datapage level if it already exists. All supported images will be converted to tiff format.
PAGE 284

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 285

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 286

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. In the following defintions, the first 2 metadata fields are for standard use, while the next 8 fields contain '_1_' in their name. This number represents the barcode index on the page.
PAGE 287

Accessing Barcode Value From a Workflow Tool One method is to use a VBScript with the Open Script task, using the Watch.ExpandString command with a metadata command as its input parameter, in between double quotes. For example, the following script line gives the value of the first BarcodeValue metadata field of the first datapage: watch.expandstring("GetMeta(BarcodeValue[0],0,Job.Group[0].Document[0].
PAGE 288

Processing The emulation for the following tasks is changed to the selected emulation. Output The original data file, metadata and job infos are not modified. Only the emulation is changed. Properties l The options of this task are basically the same as the Data Selector in PlanetPress Design; see PlanetPress Design User Guide.
PAGE 289

Read in binary mode: Select to read the sample data file in binary mode. You select this if you intend to run the document on a printer that is set to binary mode. In binary mode, the printer reads the end of line characters (CR, LF, and CRLF) as they appear in the data stream and does not perform any substitution. A printer that does not support binary mode or is not running in binary mode replaces any CR, LF, or CRLF that appears at the end of a line of data with a LF.
PAGE 290

l l l l Force one record per page: Select to force a single record per data page. If you clear the selection, the document fills the data page completely, splitting a record across data pages if necessary. If you want to avoid splitting a record across data pages, yet have several records in the buffer, select Force one record per page, and, when you stabilize your data, set Pages in buffer to the number of records you want the buffer to hold.
PAGE 291

underscore, it overwrites that character with the one from the new line. If the character in the cell is not a space or an underscore, it leaves it intact. l l l Skip x lines: Use these boxes to enter any channel skip codes in your data that tell the document to skip a specific number of lines. If you want to enter a backslash character (\) as a code, you must precede it with another backslash character (thus you would enter \\).
PAGE 292

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 293

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 294

PDFs created with the new Create PDF action task will effectively replace the current data file in any given process using such a task. Input Any data file supported by PlanetPress Workflow. Processing In the case of regular data files, these files will need to be merged with a PlanetPress Design document. 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.
PAGE 295

l 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.
PAGE 296

l l Subset: Select to embed only a subset of the Type 1 and TrueType fonts used in the document. A font subset is in fact composed of only those characters that are actually used in the document. This option can only be used if the Embed all fonts option is selected. Note that if more than 35% of the characters included in a font are used in the document, the entire font is embedded. This option often produces smaller PDF files and ensures proper PDF display.
PAGE 297

l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
PAGE 298

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Other Notes Here's a list of the hard-coded PDF values for files generated with this new plugin.
PAGE 299

l l l l Pixels per inch: 150 Security : l Allow printing l Allow changing the document l Allow content copying l Allow form filling Font : l Embed all fonts l Subset embedded fonts Open options : l Zoom factor: Fit in window l 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.
PAGE 300

l l You can use static properties (properties that will remain the same regardless of the data processed at run-time). This option lets you use an Open DataBase Connectivity (ODCB) compliant data source. You can also edit the SQL statement that assembles the database table. Note that you can import a database connection configuration that you previously exported from PlanetPress Design (when you created a document) or from PlanetPress Workflow (when you set up a sample data file for a process).
PAGE 301

l l Range group l l l Table/Query: Select the table or query containing the information you need as your input data. All: Select this option use all the records included in the database. Records: Select this option use only some of the records in the database. Indicate the range by entering the number of the first record followed by a dash and the number of the last record. To use records 50 to 75, for example, enter 50-75.
PAGE 302

l l Text delimiter: Select the text delimiter to be used in the generated file. l Field separator: Select the field separator to be used in the generated file. l l Add a header record with field names: Select this option if you want the generated file to have a header record (a record that includes the field names only).
PAGE 303

or edit the configuration. You may choose any encoding listed in the dropdown list or enter your own. l l l l l l Maximum records per page: Select this option if you want to limit the number of records per page. This option is only available if you indicated that you wanted each data page to contain several records in the Create data pages as follows box.
PAGE 304

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 l l l Parse normally: Select to interpret any backslashes included in the database connection string as backslashes. If this option is not selected, any backslash that is not doubled will be disregarded.
PAGE 305

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 306

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 307

Properties General Tab l l l l l l l Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Output folder: Enter the name of the folder in which you want the decompressed files to be stored. File mask: Enter a file name mask to specify which files must be decompressed. Leave the default value of *.* to decompress all the files found within the zip.
PAGE 308

l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
PAGE 309

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Digital Action Digital Action action tasks generates the same types of documents generated by PlanetPress Image output tasks.
PAGE 310

Task Properties General tab l l l Host: Select the IP address of the PlanetPress Image host to which you want the request to be sent. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box. Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections.
PAGE 311

l Output type: Select the output file type that you want. l l l l l l l PDF: The output will be a PDF file. If you select PDF, the DPI and Color Depth options (see below) are disabled and the options available in the PDF tab are enabled. JPEG: The output will be a JPEG file. JPEG is a lossy compression image format that creates small files, compressing continuous tone images (such as scanned photographs) well. TIFF: The output will be a TIFF file.
PAGE 312

l Data Stream group: Determines what is output by the Digital Action task: l l l l l l l l Use Digital as new data stream: Use the file generated by the task for the rest of the process. Use original data stream (without document): Use the same data file as what was input to this task. Use original data stream (with document): Uses the PostScript data generated before image is created.
PAGE 313

l XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document. Job Options tab If you chose PDF as the output type in the General tab, use this tab to choose the appropriate PDF options. Note that all the options available in this tab are only used with PDF files. l l Job options: Select the PDF output option that best describes your needs. This loads all the standard settings for the selected usage scenario. These settings can be changed as required.
PAGE 314

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. If 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. l l Monochrome images group l l l Keywords: You may enter keywords for the document.
PAGE 315

Subsample to use a pixel in the center of the sample area and replace the entire area with that pixel value. This method is significantly faster, but results in images that are less smooth. Select Bicubic to use a weighted average to determine pixel shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l l Color images group l l l l Grayscale resolution: Select the resolution to use for grayscale images.
PAGE 316

options of the generated PDF files. l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l l l l l Allow form filling: Select to let users enter information in the form fields included in 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.
PAGE 317

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. Select Full screen to hide all screen contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen.
PAGE 318

configuration. In order for the settings to work, the Add PDF to PlanetPress Search database must be checked. However, you can override which database will be updating using the option in this window, Override global PlanetPress Search Database settings. The database options then activate. l l l l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server).
PAGE 319

Printer action task must be followed by a Printer Queue output task set to "pass-through", in order for it to be sent to the printer and not merged with a document. You can use Download to Printer action tasks to send various types of files, such as attachments, documents and fonts that are used in PlanetPress Design documents that are executed directly on the printers.
PAGE 320

l l Keep file extension: Select to use extensions when saving files. When this option is selected, if the task receives a file with the “txt” extension, for example, it will keep this extension even if it renames the file (as specified in the File name box). Print confirmation page: Select to print the Variable content document download confirmation page when the download is successful. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 321

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 Workflow 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.
PAGE 322

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.
PAGE 323

Properties General tab l Program group l l l l l 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. Start in: Enter the folder in which the external program is to run.
PAGE 324

l l Value: The numerical exit code that will be verified. Return: Use the drop-down to select whether this exit code should define a success or a failure of the external program. If "Failure" is chosen, exit codes that match the condition set will cause the On Error tab to be triggered and any other exit code will be considered a success.
PAGE 325

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 326

Input The current data file in the process will be discarded. Processing The external file specified in the task's properties is loaded and replaces the current data file. Output The loaded file is output. Metadata is not modified in any way, neither are job infos. Properties General tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field.
PAGE 327

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 328

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 329

Processing The task executes the mathematical operation and stores the result in the selected job info or variable. Output The input data file is returned with no modifications. Metadata is not modified. A single job info or variable is modified by this task. 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.
PAGE 330

XSLT (or XSL Transformation) is a style sheet that describes how an XML document is to be transformed into another XML document. The reason to transform an XML document into another XML document is simply to rearrange the information it contains in order to make the data structure more convenient for your needs. Input A valid XML file. Processing The XSLT is applied to the XML data file. Output The modified XML data file is output. Metadata and jobinfos are not modified.
PAGE 331

l l l XSLT Version l XSLT 1.0: Select if you will be entering or pasting XSLT version 1.0 code. l XSLT 2.0: Select if you will be entering or pasting XSLT version 2.0 code. Tools l l Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Editor Options...: Opens the "Editor Options" on page 769.
PAGE 332

Output The unmodified input file. This task does not change the data file in any way. The only modification is a single variable or job info, if the "Store Result" option is selected. Properties The Push to Repository task options are as follows: General tab l l Group: Use the drop-down to select into which group the KeySet is inserted, or in which group the KeySet should be updated. Key set: Displays a list of keys for the selected group. l l l l l l Key: Displays the key name in the group.
PAGE 333

l Store the result ID in variable: Select a variable or Job Info in which an array of inserted or updated IDs will be placed. The array of IDs in the form of [1, 2, 3, 4, 2443, 532, 5457, ...] On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 334

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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 335

Output The input data file is output, with the new name. Properties General tab l New file name: Enter the job file’s new name. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 336

l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow 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.
PAGE 337

External Program action (see "External Program" on page 321). However, they can be slower to execute. The Run Script action task can be used either as an action or a condition. When dragging and dropping a Run Script action task on a given process, you select whether to use this task as an action or a condition from a contextual menu. For more information on scripts, what languages are supported and how to write scripts and conditions, please see the related chapter, "Using Scripts" on page 91.
PAGE 338

l Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l l Delete: Delete the current selection (only available if there is selected text in the editor). Select All: Select all of the contents of the editor. l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog.
PAGE 339

saved). 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 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.
PAGE 340

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 341

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Search and Replace Search and Replace action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data. Note that this action task cannot be used with binary files. For more advanced search and replace functionality, you can also see "Advanced Search and Replace" on page 275.
PAGE 342

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 button: Click to add a new line to the list of words to find and replace. l button: Click to remove the currently selected line from the list.
PAGE 343

l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow 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.
PAGE 344

Download to Printer action tasks (see "Download to Printer" on page 318), 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.
PAGE 345

Printer action task with the scan orientation set to Side to side, the second one with a different Send Images to Printer action task with the scan orientation set to Top to bottom, each one typically being included on two different branches of the same process. l l l l l l l l Color conversion: Select As is to keep the color information included in the images. Select Grayscale to convert color images to gray scale.
PAGE 346

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 347

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 348

Output The original data file, metadata and job infos are not modified, they are passed on to the next task. Properties General tab l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names. As with any variable property box, you can use any combination of text, variables and data selections.
PAGE 349

l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
PAGE 350

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Set Job Infos and Variables Add Set Job Infos and Variables action tasks to set job info elements as well as custom variables.
PAGE 351

l button: Moves the line up so it is processed before. l button: Moves the line down so it is processed after. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 352

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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 353

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.
PAGE 354

l l l l l l l l l l Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found. Method: Choose an available method from this drop-down list. This populates the Namespace box below. You may also enter the method name directly. Namespace: You may choose an available namespace to prevent ambiguity between identically named elements or attributes.
PAGE 355

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 356

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 357

Input Text-based data files such as Line Printer Emulation and ASCII Emulation data files, which contain HP PCL control characters. 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.
PAGE 358

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 359

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Translator PlanetPress Workflow Translator action tasks can convert your data from its current encoding to a number of different encoding.
PAGE 360

Properties General tab l l l l Source encoding: Select the current data encoding. Note that the source encoding is not selected automatically and you must therefore select the proper encoding from this list in order for the conversion process to be performed successfully. Target encoding: Select the encoding to which you want the data to be converted. Include target encoding signature: This option is only available when converting to UTF-8 (Windows code page 65001) or UCS-4 (code page 12000 or 12001).
PAGE 361

iteration. 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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 362

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Windows Print Converter Windows Print Converter action tasks are designed to convert Windows print files into Line Printer files, that can then be used in a variety of other PlanetPress Workflow tasks. Typically, Windows Print Converter action tasks are located below WinQueue input tasks (note that the latter include options specific to Windows Print Converter action tasks).
PAGE 363

Properties General tab l 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). The settings included in this group fine tune the process.
PAGE 364

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). For example, if the mean character width of the font example shown here corresponds to the width of the blank character (for other fonts it may be another sign).
PAGE 365

l l Character per inch (CPI): The number of individual characters per inch on a line of text. Line per inch (LPI): The number of lines of text per inch. XML/JSON Conversion The XML/JSON Action task converts an XML job file to JSON or a JSON job file to XML. This task makes parsing XML/JSON files much simpler in a JavaScript environment and also allows processes to natively send JSON to a Connect template or data mapping configuration. Input The current job file.
PAGE 366

Output The output is the modified job file, which replaces the input job file. The metadata are reset. Properties The XML/JSON task options are as follows: General tab l Automatic detection: By default, the format of the job file is detected automatically. If the source file is a JSON file, it will be converted to XML. If it is an XML file, it will be converted to JSON. Uncheck this option to limit the task to one type of conversion. l JSON to XML: the task only converts JSON files to XML.
PAGE 367

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 368

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Data Splitters Splitter action tasks are used to single data files into multiple data files. You can use such tasks, for example, to split files that contain statements for multiple clients into smaller files that each contain a single client statement. Each statement can then be printed and sent by snail mail, or even emailed directly from PlanetPress Workflow, to each individual client.
PAGE 369

Let us imagine that a splitter action task processes the following data file using the ASCII emulation: Data line1 of page 1 Data line2 of page 1 Last data line of page 1 Data line1 of page 2 ...and so forth...
PAGE 370

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 Split group: Use this group to indicate how you want the file to be split.
PAGE 371

l l l l l l l Where to split group: Options from this group are used to define a number of pages or records before or after which the file is to be split. Pages or records: Enter the number of pages or records before or after which the file is to be split. Enter 0 if you want the file to be split right before or after the page or record that matches the set condition. Before or after: Options from this list box are used to define exactly how the file is to be split.
PAGE 372

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 373

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 374

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 Split data file on emulated page group: Select to split the data file based on pages (rather than on a word found within the emulated data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place.
PAGE 375

l l l l To column: Enter a value corresponding to the last column in which the splitter must start searching for the word. Match case: Select to force the splitter to match the character casing. Note that this setting applies both to the Specific Word and Word change 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.
PAGE 376

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 377

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 378

Input Any data file. 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).
PAGE 379

Splitter will search in the ten first lines of every page. Note that the actual search region is a combination of the vertical and horizontal search regions. l Word is between columns group l 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”.
PAGE 380

in the From box and 10 in the To box, the Generic Splitter will search in the ten first columns of the line selected above. l l l l l Pages: Enter exactly where to split the file. Enter 1 to split the file 1 page before or after the string, 2 to split the file 2 pages before or after the string, or 0 to split the file immediately before or after the string.
PAGE 381

l l l l Operator: Select the appropriate comparison operator. If you select Equals, the Generic Splitter will only consider that the condition is met when it finds a perfect match (“day“ and “day“, for example). If you select Contains, the Generic Splitter will consider that the condition is met whenever it finds the string of characters entered in the Value box, even if the database field contains additional characters (“day“ and “days“, for example, would be considered a match).
PAGE 382

l Where to split group l l l Pages or records: Enter exactly where to split the file. Enter 1 to split the file 1 page or record before or after the string, 2 to split the file 2 pages or records before or after the string, or 0 to split the file immediately before or after the string. Before or after: In the previous box, you entered where you wanted to split the file.
PAGE 383

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 384

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
PAGE 385

l l l l l l l From column: Enter a value corresponding to the first column in which the splitter must start searching for the word. To column: Enter a value corresponding to the last column in which the splitter must start searching for the word. 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”.
PAGE 386

l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
PAGE 387

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 388

l l Page(s) per output: Enter the number of pages to include in the file generated by the splitter in this edit box below or use the spin buttons. Split PDF file on a word: Select to split the data file whenever a given region is found within the PDF data file (rather than on based on pages), or whenever the region found at a given location changes, and to activate the options from this group, which are used to tailor exactly how you want the region based splitting process to take place.
PAGE 389

box. Enter 1, for example, to split the file at the beginning of the line that precedes the line on which the condition is met. l l l l Before: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines before the line on which the condition is met.
PAGE 390

mind that the resulting PDF may be much larger than it should be and may even be too large for PlanetPress Workflow to handle. l Reset Metadata according to new PDF: Metadata will be recreated according to the new PDF that was created, including page numbering, etc. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 391

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 Workflow 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.
PAGE 392

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 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.
PAGE 393

l l l l l l l l Keep XML structure: Select if you want the generated files to have the exact same structure as the original XML file (all the way to the root node). Add new root node: Select this option and enter a root node name in the box to the right, if you want the generated files to have a structure that begins with a new root name and that then goes directly to the node on which the file was split, as indicated in the Split on node box below.
PAGE 394

engine). Note that you should not enter fixed values for the following parameters: the XSLT stylesheet parameter, the source XML data file parameter or the output file parameter. When you click the buttons below, the corresponding parameters are automatically added at the current cursor position. These variables will be replaced by the correct information at run-time. l l l l XSLT file button: Click to add the {XSLTFILE} variable to the command prompt displayed in the box above.
PAGE 395

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 396

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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 24) 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.
PAGE 397

The Send to Process action and Go Sub Action are used to send the job file to another process or subprocess and, in the case of the GoSub, to get information back from the subprocess. See "Send to Process" on page 413 and "Go Sub" on page 404. 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.
PAGE 398

In case of the failure of a Branch task (the branch itself, not the other tasks contained within), by default the process will ignore the branch and simply go down the main trunk. You can overwrite this in the On Error tab. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 399

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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 400

File Name Condition File Name conditions test the original name of the job file traveling down the process branch, or in other words, the name of the file received by the last input task appearing above the condition. Properties General tab l l File name mask: Enter one file name mask or multiple masks separated by a semicolon (;). See Masks. The condition will be tested True only in the case of an exact match, so consider using wildcard characters.
PAGE 401

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 402

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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. If a file does not exist, it's file size will be 0kb.
PAGE 403

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 404

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess.
PAGE 405

l l Backup emulation: Select if you want to use the emulation selected when the job file reaches the subprocess for the main process as well. Note that the emulation is not passed from a main process to a subprocess or vice versa. Retrieve subprocess error: Select if you want to receive error(s) from the subprocess in order to handle them on its own. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 406

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 Workflow 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.
PAGE 407

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). Store current iteration in Job Info #: The Job Info in which the loop's iteration should be stored. Useful for sequential file names or conditions based on the iteration. The value of this Variable Properties box should be a digit between 1 and 9.
PAGE 408

l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
PAGE 409

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
PAGE 410

on the main trunk. To control the output, use the "Script.ReturnValue" on page 119 variable in your script. Properties The Script Editor menu options are as followed: l File l l l Export: Lets you save the current script as a file. l Print: Prints the current script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l Copy: Copy the current selection (only available if there is selected text in the editor).
PAGE 411

l l VBScript: Select if your script is written in VBScript. l JavaScript: Select if your script is written in JavaScript. l Perl: Select if your script is written in Perl. l Python: Select if your script is written in Pyton. Tools l l Editor Options...: Opens the "Editor Options" on page 769. Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l l l The script editor text box: This is where you enter your XSLT Script that will be used.
PAGE 412

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. Lists any process of which the initial input task is the Input Error Bin task.
PAGE 413

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 414

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.
PAGE 415

error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not 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.
PAGE 416

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.
PAGE 417

make the condition False whenever a critical alert is detected, regardless of its type. Select Non-critical alert to choose a specific non-critical alert in the Detected error box. Select Critical alert to choose a specific critical alert in the Detected error box. Select Do not test if you only want to test the printer status (above). l l Detected error: Select a specific non-critical or critical alert.
PAGE 418

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 419

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 420

Properties General tab l l l l l l l String: If you want to test the presence of a given string at a given location, enter the string in this box. If you want to compare two strings or perform a numeric comparison, enter the first string in this box. Note that you can enter either a static string, a variable or a data selection in this box. If you enter a variable, PlanetPress Workflow will retrieve the string from the variable before performing the comparison.
PAGE 421

l l l 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. The page range setting is only considered when either ”Is found” or ”Is not found” is selected in the Operator box. Range: Entries must be separated by commas. Page ranges are entered using a starting page and an ending page, separated by a dash. For pages 1, 3 and 5 to 7, you would enter the following: 1,3,5-7.
PAGE 422

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 423

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 424

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Time of Day Condition Time of Day conditions test the current time and day.
PAGE 425

l Grid: Select separate or contiguous time blocks. Click a block to toggle it on or off. Click and drag to toggle multiple blocks on or off. Click date or day at the top of the grid to toggle the whole date or day on or off. Click a time interval on the left margin of the grid to toggle the whole time interval on or off. l Select All: Click to toggle all the time blocks on. l Clear: Click to toggle all the time blocks off. On Error Tab The On Error tab is common to all tasks.
PAGE 426

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 427

Available Connector tasks l "Create MRDX" below l "Input from SharePoint" on page 432 l "Laserfiche Repository Output" on page 436 l "Lookup in Microsoft® Excel® Documents" on page 440 l "Microsoft® Word® Documents To PDF Conversion" on page 444 l "Output to Capture OnTheGo" on page 449 l "Output to SharePoint" on page 453 l "PlanetPress Fax" on page 457 l "PlanetPress Image" on page 458 l "PReS Print Controls" on page 468 l "PrintShop Mail" on page 471 Create MRDX The Create MRDX acti
PAGE 428

l Use External MRDX and PDF: Check this option to ignore the MRDX creation and use an existing PDF and MRDX instead. l l Files Location: Enter the path and file name (without extension) of the PDF and MRDX file, or use the Browse button to select either. The PDF and MRDX file must have the exact same name apart from the extension. Use MRDX as new data file: Ignore the PDF file and use the MRDX as a job file after this task. The PDF is discarded. If this is unchecked, the PDF and metadata are used.
PAGE 429

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 430

This task can be added as an Action task (see "Action Tasks" on page 268) or as a Condition Task. When used as a Condition task, the success of the delete operation determines whether the condition returns True or False. Input This task doesn't require an input file. It does need a Repository ID and password, and the ID of the document to delete. Processing This task connects to a Capture OnTheGo Repository and requests removal of a document with a given document ID.
PAGE 431

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. Lists any process of which the initial input task is the Input Error Bin task.
PAGE 432

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 433

Input Any data file present on a SharePoint document store, even those not compatible with PlanetPress Workflow emulations, and the properties of these files. Processing The task connects to the selected Document store and retrieves a copy of files according to the specified rules. The files may be deleted or marked as checked out depending on the options selected, otherwise they are untouched. Output The output to this task is a series of individual files, one after the other.
PAGE 434

l l Do not download checked out documents: If the document is set as "Checked Out" in SharePoint, it will be ignored. Action Group l l l Download the document: Simply download the document and do not modify it in SharePoint. Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint. This is useful for preventing files to be downloaded more than once.
PAGE 435

Job Information definitions l l %1 - Source file name: Contains the name of the current captured file. %2 - Directory: Contains the name of the SharePoint director from which the current file was captured. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 436

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 Workflow 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.
PAGE 437

Input Any file that is compatible with Laserfiche (see the Laserfiche user manual for more information on supported files types) Processing A connection is established with the Laserfiche server, the file is uploaded and the metadata in the Laserfiche server is generated correctly. Output The output from this task is the specified file along with the metadata within the Laserfiche server. The file is not directly modified by this task.
PAGE 438

l l Configure Templates: Click to open the Configure Templates dialog. See LaserFiche Repository Output - Configure Templates. PlanetPress archive folder: Folder path of the folder capture of the current process. This field is optional and should only be set when publishing PlanetPress Workflow archives that have PDI files.
PAGE 439

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 440

Restrictions l l Each Laserfiche Repository Output task uses a connection to Laserfiche. You can use as many Laserfiche Repository Output tasks at the same time as your Laserfiche license allows. If you see the error message ‘The session number was exceeded’ in the PlanetPress Workflow Service Console, it means you have exceeded your allowed number of connections.
PAGE 441

task, otherwise it will run as many times as there are metadata sequences, which will result in decreased performance. Input Any compatible data file, requires metadata to be present. Processing The task parses each level of the metadata and, for each field of the specified name it finds, a lookup is made. If a field of the same name appears on multiple levels, the lookup will happen for all fields, on all levels, individually. Output The original data file is unchanged.
PAGE 442

l l l l l l l Add Field: Creates a new field with the data. This may cause multiple fields to be created. Replace field value: Replaces any existing field with the new content. Only the last result will be displayed. If the field does not exist, it will create it. Append field value: Ads the data to the existing field within the same one. No "separator" is added. If the field does not exist, it will create it. Result Field: The metadata field name in which the result should be stored.
PAGE 443

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 444

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 445

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.
PAGE 446

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.
PAGE 447

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 448

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 449

l l l If using a Microsoft® database such as Access® or Excel®, each software must be installed in the same version. For example, using Microsoft® Word® 2007 with a Microsoft® Access® 2003 database will cause the task to fail. If the database path is specified in the Microsoft® Word® document, the mail merge has to be performed with the settings specified in the document, otherwise the database path provided in the task is ignored and can cause different conflicts.
PAGE 450

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 Repository ID: Enter a valid Capture OnTheGo Server user name (mandatory). Password: Enter the password (mandatory) that corresponds to the Repository ID entered above. Show password: Check this box if you want to see the password you type in the Password box.
PAGE 451

l 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. Click the button marked with a plus sign to add groups of users or individual users to this list box. The list must include at least one entry (otherwise, no one will be able to see the document).
PAGE 452

the Download button, if they want to have the document on their device). You may enter ‘Yes’, ‘No’, or a variable. The document will be 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.
PAGE 453

the following tasks (if the Output to Capture OnTheGo task has been added as an Action). l Blank Forms group: Check the This is a blank form option to make the form reusable. The Form will not be deleted from the app's form library when it is submitted, so it can be used over and over again. It will only be deleted from the app's form library after the number of days set in Days to keep each instance.
PAGE 454

l Force folder creation: If the folder does not exist, it will be created. l Error if the file name exists: Task will generate an error if the file name is already there. l l Mark the document as checked in: Sets the "Checked in" property of the document on the SharePoint server. Configure Fields: Opens the Configure SharePoint Metadata Fields dialog. Configure SharePoint Metadata Fields dialog This dialog lets you setup the information you want to assign to the SharePoint Metadata information.
PAGE 455

Technical Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PlanetPress Workflow 7.4 and higher only. Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted.
PAGE 456

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 457

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 458

Task Properties General tab l l l l l Host: Select the IP address of the PlanetPress Fax host to which you want the request to be sent. The Fax configuration is set in the PlanetPress Fax User Options on the target host. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box. Documents: Select a specific PlanetPress Design document if you want all the jobs to be faxed with that document. You must select a document, pass-troughs are not available.
PAGE 459

Note In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PlanetPress Workflow is running, so emails are not sent out automatically. To correct this, make sure to log on to Windows on the PlanetPress Workflow server using the same login that PlanetPress Workflow is using, and open Outlook before starting the PlanetPress Workflow services. You could also use a startup process to start Outlook before the rest of the services.
PAGE 460

Properties General tab l l l Host: Select the IP address of the PlanetPress Image host to which you want the request to be sent. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box. Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections.
PAGE 461

l Output type: Select the output file type that you want. l l l l l l l l l PDF: The output will be a PDF file. If you select PDF, the DPI and Color Depth options (see below) are disabled and the options available in the PDF tab are enabled. JPEG: The output will be a JPEG file. JPEG is a lossy compression image format that creates small files, compressing continuous tone images (such as scanned photographs) well. TIFF: The output will be a TIFF file.
PAGE 462

l l l l l Send Email: Select to send the generated file via email. You enter the emailing properties in the Login, Recipients, and Attachment(s) tabs. Note that the generated file will only be sent if you select the Attach output file(s) option in the Attachment(s) tab. Archive folder: Enter the path of the folder to which output files generated by this task are to be archived. PDF index files (PDI and XML) are also put in this folder.
PAGE 463

required. Note that if you make changes and then select a different output option, your changes will be lost. PlanetPress Image supports numerous PDF standards: Standard, High Quality, Custom, and a variety of PDF/VT, PDF/A and PDF/X formats. l General group 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.
PAGE 464

l Monochrome images group l l l Compression: Select the compression to use for the monochrome images. Flate compression is lossless, so no data is lost during compression. Flate Mono works well on images with large areas of solid shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs. CCITT typically yields the best compression of monochrome images. It is the compression method developed for fax transmissions.
PAGE 465

l Color images group l l l l 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. JPEG removes image data and may reduce image quality, but may be suitable for continuous-tone photographs containing more detail than can be reproduced onscreen or in print.
PAGE 466

l l l Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128). It gives the task the ability to take an existing PDF in input and apply the selected password to the PDF without any change to the quality level of the original PDF. Font group l l l 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.
PAGE 467

global settings so that the task updates a different database than the one set in that global configuration. In order for the settings to work, the Add PDF to PlanetPress Search database must be checked. However, you can override which database will be updating using the option in this window, Override global PlanetPress Search Database settings. The database options then activate.
PAGE 468

PReS Print Controls The PReS Print Controls output task is used for running PReS Classic jobs through Connect Workflow. Limitations In order for PReS Print Control tasks to be functional, some pre-requisites must first be met: l l PReS Classic 6.3.0 or higher must be installed on the same system. A valid PReS Classic license (either dongle or software based) must be available on the same system. Note All PReS Classic licenses are issued and controlled by the PReS License Server and not Connect.
PAGE 469

Output The available output print stream options are AFPDS, GOPReS (Graphic Output), IJPDS, PCL, PDF and PostScript (PS) outputs. Task Properties General tab l PDC File: Select either an un-compiled PReS Classic script file (PDS) which will need to be compiled on the fly, or a pre-compiled PReS Classic job file (PDC). The job needs to be specified exactly. If you want to compile the job at run time, then you must select a PDS file.
PAGE 470

variable. If the PDC File selection contains a full folder path along with the filename, then the Working Folder does not need to be selected, as Connect Workflow will use the path contained in the PDC File entry. Note If the PDC File selection contains a folder path and the Working Folder also has an entry, then the PDC File entry will be appended to the Working Folder entry. One should be very cautious doing this, as it could easily lead to errors.
PAGE 471

If the job still finishes with a Job Status of “Finished” and Exec Status “1” then the job completed without error. l Instance: Used for specifying the PReS Classic Print Control instance. PReS allows up to four instances of the same Print Control type (license dependent), and any one of those instances can be selected here. Selecting 1 would force Connect Workflow to use Print Control PRN1, whilst selecting 2 would launch PRN2, and so on.
PAGE 472

l l l PrintShop Mail version 6.1 or higher must be installed on the same system, and an activated PrintShop Mail production dongle must be plugged in to the system. You must have at least one printer using a PostScript driver on your system in order to produce PDF output. It is highly recommended that a PostScript printer be set as the default system printer in order to act as a fall back if the selected printer is unreachable.
PAGE 473

l l l l l l l l l l l l Select Preflight to check if the merging of the data file and document would generate warnings or errors. This does not actually produce output, only an XML file containing a list of warnings and errors, including on which record and layout the warning or error occurred, and a description. Select Produce PostScript to generate a standard PostScript file that can then be sent to any PostScript printer. Select JPG to generate a JPG image file.
PAGE 474

l Record Range group l l All records: Select if you want to print all the records included in the job file. Use Record Range: Select if you want to print only some of the range included in the job file. Use the From and To boxes to indicate the record range. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 475

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 Workflow 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.
PAGE 476

PlanetPress Capture is a set of tools available in PlanetPress Workflow that enable output and input for interaction with an Anoto Digital Pen. Anoto Digital Pens are electronic devices containing a camera, processor, memory and communication capabilities and they can recognize their location on any paper where a special Anoto pattern is printed. For more information on building and using PlanetPress Capture processes, please see "PlanetPress Capture Workflow" on page 143.
PAGE 477

Task Properties General Tab l Document Origin: l Document to process: Determines where the document information is read l l l From Specific ID: Select to specify an exact Document ID from the database. This document does not need to be loaded as a data file or its metadata manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database.
PAGE 478

l Capture Field-based condition: Select to base the condition on the state of one or more fields of your document. l Field Name: The name of the field on which to base your condition. This is equivalent to the name of the Capture Field Object in PlanetPress Design. Technical In this field in particular, the right-click menu displays a unique option, 'Open Document Preview'. This option displays a list of existing documents.
PAGE 479

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.
PAGE 480

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. Examples & Use Cases This task is put into effect in the following use cases and example processes: l Capture Post Processing Workflow l Capture Web Manager Workflow On Error Tab The On Error tab is common to all tasks.
PAGE 481

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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
PAGE 482

Capture Fields Generator The Capture Fields Generator action task is used to generate Capture patterns in your job, which will then be printed for use with an Anoto Digital Pen. It also interacts with the Capture database and does some operations. Warning PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently.
PAGE 483

Processing The Capture Fields Generator action task uses an existing PlanetPress Design document containing Capture fields and assigns a unique Capture pattern to each printed page. The task then locks each pattern that it used so it cannot be reassigned to any other document. The whole job is then converted into a PDF file which is stored, without the patterns, in the Capture Database. This PDF file is later used by the "Capture Fields Processor" on page 486 to be merged with ink from the pen.
PAGE 484

l l Output Format group l l l l l Custom: Use the title in the input field as set by the user. The field is variable so the title can be set on a per-document basis using data or metadata selections. Continue process with optimized postscript (no metadata): The job file coming out of the task will be a PostScript file that can be sent to any postscript printer or saved locally.
PAGE 485

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 486

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 487

(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. During processing, ink is always applied to the document first and then the logic is applied for releasing patterns. This means that even if a document is closed by a field set as Final that was checked first, ink present in other fields will still be applied to the document. From version 7.
PAGE 488

l l l l l l CapOpenDate: The date at which the document was created by the Capture Field Generator. CapPatternSequence: The value of the pattern sequence assigned to the document.
PAGE 489

l l l l l l l Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the Pattern Sequence to be used. ICR Settings group l l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. Perform ICR Recognition: Triggers the PlanetPress Capture ICR engine. For more information, see PlanetPress Capture ICR.
PAGE 490

another split generates an error, it also triggers the On Error tab. Examples & Use Cases This task is put into effect in the following use cases and example processes: l Basic Functional Capture Workflow l Capture Web Manager Workflow On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 491

l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow 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.
PAGE 492

action, which should be the Capture Fields Processor task. Note that using the Capture PGC Splitter will cause your process to take more time, since each PGC must pass through the Capture Fields Processor and then the Get Capture Document task. Technical Due to the fact that the Capture PGC Splitter task modifies the original PGC, in some cases the legality of the PGC signature may be compromised.
PAGE 493

l l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the pattern sequence to be used. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777.
PAGE 494

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 Workflow 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.
PAGE 495

Extract ICR Data The Extract ICR Data task retrieves the ICR data from the specified document ID from the Capture Database and adds this information to the current Metadata in the process, at the specified level. 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.
PAGE 496

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. Action: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 497

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 498

Processing This task connects to the Capture database and looks up all available documents that meet the criteria specified in the plugin. Then it does further processing to retrieve relevant information about each document and places the information in the data file it generates. Output The data file generated by this task is an XML structure containing the data about each document.
PAGE 499

l l l l l l l Pen user (by description): The description of the pen, as entered in the "PlanetPress Capture Pen Management Tool" on page 745. Generally, this is the name of the owner of the pen. Pen user (by serial number): The serial number of the pen (aka Pen ID) Pattern Sequence: The Pattern Sequence in which a document is entered. Template name: The name of the PlanetPress Design document used to generate the Capture document. This is set in the document's properties, in PlanetPress Design.
PAGE 500

l l l l l l l l l Before: Date comparison, documents of which the date is previous to the specified value are included (Date Generated and Date Closed filters only). After: Date comparison, documents of which the date is closer than the specified value are included (Date Generated and Date Closed filters only). Last: Date comparison, documents of which the date is within the specified interval are included (Date Generated and Date Closed filters only).
PAGE 501

l Capture Post Processing Workflow l Capture Web Manager Workflow On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 502

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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 503

used, the data file and metadata are completely ignored by this task's condition rules, and the database information is used instead. Processing One PDF, corresponding to the information present either in the metadata or specified in the task, is extracted from the Capture database. When retrieving documents from the database, the PDF from which the document is obtained will remain in the database until each document contained in it is retrieved from it.
PAGE 504

Properties General Tab l Document Origin group: l Document to process: Determines where the document information is read l l l l l From Specific ID: Select to specify an exact Document ID from the database. This document does not need to be loaded as a data file or its metadata manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database.
PAGE 505

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. Lists any process of which the initial input task is the Input Error Bin task.
PAGE 506

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 507

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.
PAGE 508

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 509

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata Tasks Metadata tasks are plugins that can create or edit metadata for a job file.
PAGE 510

reflect those defined in the document, including separation for Group and Document, metadata fields, etc. l l In PDF emulation, the size and orientation attributes for each page are set in the metadata. In all other emulations, those attributes remain blank. In XML emulation, the metadata file is always created as if the user had specified the "Second Level" parameter in PlanetPress Design. If the "Do not use document (passthrough)" option is used, no PlanetPress Design document is used.
PAGE 511

l Daily Sales Report from PDF Files On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 512

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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 513

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.
PAGE 514

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 515

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata Fields Management The Metadata Fields Management task can be used to add new fields into your metadata, either for every element or through conditions. Note This task will automatically loop through the metadata and repeat its action for each of your metadata's datapages. This task should not be placed after a Metadata Sequencer. Input Any data file with accompanying metadata.
PAGE 516

l 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. Output The original data file is outputted, along with the modified metadata. Properties General tab l Action: Select the type of Metadata Field Management action to perform. Five action types are available: l l l l l l Add/Replace: Create a new metadata field.
PAGE 517

the [...] button. This button opens the Data Selector, which allows to specify a data selection as the field's value. Note that when adding a metadata field, if you perform a multi-line data selection on a PDF region, only the first line of that region will be set to the metadata field. 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.
PAGE 518

the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration. 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. If the task is not on a branch, the entire process will be stopped.
PAGE 519

the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata File Management The Metadata File Management action task is used to execute actions on Metadata files. This task does not modify the data, job infos, variables or any other part of your process. Input This task takes any file as input and does not modify it.
PAGE 520

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 521

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 522

tasks that uses metadata afterward. Output The original data file is output, along with the modified metadata. Properties General Tab l Filter levels: Rules for deselecting nodes at the Group, Document or Data page level. Note that currently unselected nodes are ignored. 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).
PAGE 523

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 524

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 525

Example of a process with the Metadata Level Creation task Given a document input (created with metadata), this task can be used to regroup the PDF pages of the received print stream in logical (metadata) documents, based on the keyword “Page 1 of” printed on the pages, and then treat each newly created document individually in the rest of the process The process begins with the following tasks: 1. WinQueue Input: Intercepts a printed data file sent to a Windows printer queue. 2.
PAGE 526

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 l Delimiter defines if the Condition parameter is triggering the beginning or the end of a Group or Document. If the delimiter option is set to None, the action is not performed.
PAGE 527

l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
PAGE 528

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 529

Input Any data file with accompanying metadata. Processing A loop is established and the metadata is separated into chunks, as defined in the rules set forth in the task properties. Output The original data file is output once per chunk, along with this chunk's metadata. Note that *all* the metadata is in each of the sequence, but anything not part of the sequence is disabled and is ignored by all tasks using metadata afterwards.
PAGE 530

Metadata Sorter The Metadata Sorter action task allows metadata to be sorted sequentially on three different levels, alphabetically or numerically. It also allows sorting in ascending and descending order. Input Any data file with accompanying metadata. Processing The order of the metadata is changed in accordance with the rules set forth in the task's properties. Output The original data file is output, along with the modified metadata. General Tab l Group: Sorts the metadata by group.
PAGE 531

any non-numeric value is found in the field or attribute, in any instance of the level, the task raises an error. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 532

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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 533

Processing The metadata is read and PDF indexes are located. These indexes are defined in the PlanetPress Design document as data selections, in which the Archive / Email / Fax properties define the data as an index with a name. When all the indexes are collected, a PDI file is generated with those indexes. 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.
PAGE 534

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 535

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata-Based N-Up The Metadata-based N-Up action task works in conjunction with the PlanetPress Design tool's N-Up functionality.
PAGE 536

Output The original data file is output, along with the modified metadata. General Tab l l Number of virtual pages that appear on each physical page: This is equivalent to the N in N-Up. This number should be equal to the total number of virtual pages in your PlanetPress Design document. For example, a 2 horizontal x 3 vertical is 6-up, so this number should be 6.
PAGE 537

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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 538

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. OL Connect Send Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application. It is in fact an application with two components. The first is a Windows printer driver while the other is a group of Workflow plugins (Job Processor, Get Job Data and Get Data). These two components work together indiscriminately, each needing the other to function.
PAGE 539

Properties General Tab Filter options Filters are required for: l Start and end date (down to minutes) l Domain(s) l User(s) l Machine name(s) Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: l Workflow variables l Job variables l Names. Tip No spaces are allowed around the listed names, respectively before or after a semicolon. Operators l Searches are case-insensitive.
PAGE 540

This would look for all entries, where the user name is either: l as currently stored in the global Workflow variable User l "helen" l as stored in the job variable number 1 l equals "george napier" (case insensitive). These search criteria are combined with OR. Example 2 The domain name entered in the Filter Domains field is objmtl.objectiflune.com and the user name entered in the Filter Users field is rentel.
PAGE 541

Results For each job that matches the search criteria, the following information will be put into the resulting data file: l Job UID l Date/Time stamp l Number of Copies l Number of pages l User name l Original file name l Original file size l Domain (workgroup) name l Domain / Workgroup Indicator l Machine name l Machine GUID. Results File Format The following result file formats are selectable: l XML l JSON l CSV (Separator = semicolon (0x3B), string indicator = quote (0x22)).
PAGE 542

l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Date/Time stamp: This is the time when the matching job was initially created in the database. It is stored in UTC format plus time zone indicator inside the database. It will differ from the time stamp logged by the OL Connect Send Printer Driver as well as by the OL Connect Send Job Processor. Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value.
PAGE 543

l l l Domain / Workgroup Indicator: This domain name is the real domain name or only a workgroup name. For explanations about domains, domain names, users, user names, user domains, logged on users vs. application running users, machine names etc. please refer to the respective Windows help pages or ask your system administrator. Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API.
PAGE 544

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 545

The plugin appears in the Plug-in Bar of Workflow under OL Connect Send. Typically, it is used in the OL Connect Send interaction process, just after the initial HTTP Server Input plugin. The Get Job Data plugin gets all relevant information for the dedicated print job using the Unique Job ID. Whenever an OL Connect Send Printer Driver is sending a print job to the OL Connect Send Job Processor plugin, it creates a unique ID string composed from 10 upper- and lowercase letters and digits e.g. “ri0zZdluLp”.
PAGE 546

processing. l Read from Variable: When selecting this option, any existing Workflow variable can be chosen via the drop-down field. In this case, the plugin reads the Job ID from that variable. Select Returning Type Depending on this setting the plugin gets status information about the job before it has arrived or it gets information after the job has been completely received.
PAGE 547

l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Date/Time stamp: This is the time when the matching job was initially created in the database. It is stored in UTC format plus time zone indicator inside the database. It will differ from the time stamp logged by the OL Connect Send Printer Driver as well as by the OL Connect Send Job Processor. Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value.
PAGE 548

l l l Domain / Workgroup Indicator: This domain name is the real domain name or only a workgroup name. For explanations about domains, domain names, users, user names, user domains, logged on users vs. application running users, machine names etc. please refer to the respective Windows help pages or ask your system administrator. Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API.
PAGE 549

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 550

Input The Job Processor plugin must be added to a Workflow job transfer process that starts with an HTTP Server Input. The Job Processor plugin is the only other task in that process. The action name of the HTTP Input task must match the last part of the URL for print job submission, set in the OL Connect Send Printer Driver installer. By default this is olcs_transfer.
PAGE 551

Timeout During a job transfer from the OL Connect Send Printer Driver to Workflow, a timeout could occur (indicated by a log entry like “ERROR: sendBinaryContents: Could not open request. Reason: 12002”). In this case, the timeout for the HTTP service in Workflow needs to be increased. It is recommended to use a value of more than 10 minutes (>600 seconds). Additionally, the timeout in the browser on the client side should be enhanced. Please see the help pages for your browser about how to do this.
PAGE 552

“%CommonProgramFiles(x86)%\Objectif Lune\\Plugins\CPD”. By adding the entry “DBPort = ” under [HSQLDBSETTINGS] and then restarting the service, the communication port is changed. Note that Workflow has to be restarted after such a modification. Output The plugin stores the incoming print job in the target folder with the file name specified in the plugin. If no extension is defined by the user for the file name, the default “.
PAGE 553

To facilitate using job related information for the creation of the target folder and file name/s, the Job Processor plugin maps job relevant information to the standard Workflow variables (%1 to %8). The following mappings apply: Information Workflow Variable When licensed When unlicensed Job ID %1 Job ID Job ID License status for this job %2 "Licensed" "Unlicensed" Username 1 %3 The user name "na" IP Address 1 %4 The IP address The IP address No.
PAGE 554

Any OL Connect Send Printer Driver can communicate with any plugin, as long as this third version number part is identical. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 555

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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 556

It exchanges less data with the server than the separate plugins do and it has multi-threading support: it can produce the data set and content items in parallel. The task is build with 3 tabs that represent the 3 main steps of the creation of a Print Output: Data Mapping, Content Creation and Output Creation. In a Print process built with separate plugins, the Job Creation task comes between Content Creation and Output Creation.
PAGE 557

l Source: Indicates the source of the Record Set metadata: l Data Mapping Configuration: Executes data mapping on the appropriate source. Select the appropriate data mapping configuration in the list: l l l l l "None": Select to execute default, basic data mapping on the input PDV/VT file. "%o": Select to use a dynamic data mapping configuration name. Click on %o to change the expression that determines the name of the data mapping configuration to use.
PAGE 558

l l l l l l l l Delete the selected condition: Click to delete the currently selected conditions in the list. Clear the rule: Click to delete all rules in the list. Note: This cannot be undone. 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.
PAGE 559

l Template: Select the appropriate template or option to execute it: 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. Template Names: Select the appropriate template name from the list. Adding templates is done from the Send to Workflow option in the Designer Module.
PAGE 560

l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l 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 in the" Task Properties Dialog" on page 777.
PAGE 561

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 562

l Sort items based on: Lists the different sorts to apply to the entities. l l l Name: Click and enter the name for the Value or the Property to sort on. Type: Select whether the Name option refers to a Property or a Value within the entity. Order: Select how to sort, either Ascending or Descending alphabetical order. l Add: Click to add a new line to the sort list. l Remove: Click to remove the currently selected line in the sort list.
PAGE 563

If the input is JSON, the task performs a REST call to the /rest/serverengine/workflow/contentcreation/email/{templateId}} endpoint on the Connect Server. For more information see the REST API Cookbook. Processing This task loops through each record in a Record Set or through each JSON object in an array. For each record or JSON object, an HTML Email is generated using that record's or object's data. The output generated is then sent via an SMTP server with the email address set by the template.
PAGE 564

l JSON: l JSON String: a JSON object or an array of JSON objects representing records (see "JSON" on page 562) or a JSON Record Data List (see the REST API Cookbook). This option requires that keys in the JSON data have matching field names in the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data.
PAGE 565

l l Web Content as HTML page: Check to generate the active Web section in the template as an HTML page and send it with the email as an attachment Test SMTP settings: Validates the format of the sender's address and mail host and tries to send a test email. This won't work when the option Start TLS is checked. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks.
PAGE 566

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 567

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Job The Create Job action task prepares a series of print content items for output generation.
PAGE 568

Properties General Tab l Job Preset file: Select which Job Preset to use to generate the job. To be used in this dialog, a preset must have been sent to PlanetPress Workflow using the Package File function in PlanetPress Connect. l l l Default: The IDs in the metadata are used instead of a job preset file. Select this option if the Print Content Set is the result of the Retrieve Items task. "%o": Select to use a dynamic preset name.
PAGE 569

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.
PAGE 570

error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not 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.
PAGE 571

Processing The job is sent to the OL Connect Server for processing. Output Depending on the options set, either a simple metadata file with information about processing is returned, or the actual output file created by the server. Properties The Create Output task properties are as follows: General Tab l Output Preset file: Select which Output Preset to use to generate the output.
PAGE 572

Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l 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.
PAGE 573

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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
PAGE 574

Create PDF/VT The Create PDF/VT, similar to the Create PDF task, creates PDF/VT files from a PlanetPress Document (created with PlanetPress Design). 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.
PAGE 575

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.
PAGE 576

error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not 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.
PAGE 577

The Datamapper tab can have one of the following source options: l Data mapping configuration sets the data source to a data mapping configuration. l l l %o: Select this to use a dynamic data mapping configuration name. Click on %o to change the expression that determines the name of the data mapping configuration to use. Alternatively, select a configuration name. Adding configurations to this list is done through the Send to Workflow option in the Designer module.
PAGE 578

Note This option requires that keys in the JSON string have matching field names in the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data). l Metadata uses existing metadata, generally the output of a Create Record Set or a Retrieve Items task set to retrieve a record.
PAGE 579

JSON string samples The following JSON string samples show various techniques to incorporate data in a JSON string.
PAGE 580

[1]',Value,KeepCase,NoTrim)" } A JSON string that contains nested data: { "name":"Peter Parker", "email":"parkerp@localhostcom", "ExtraData":"foobar", "detail": [{"id":"inv123","ExtraData":"hello"}, {"id":"456","ExtraData":"world"}] } Content Creation tab The Create Preview PDF plugin creates a preview PDF from a template selected on the Content Creation tab, using the record that results from the data source selected on the Datamapper tab.
PAGE 581

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 582

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 583

JSON The Create Print Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string samples" on page 579. A JSON Record Data List (see the REST API Cookbook).
PAGE 584

OL Connect Database. Properties General Tab l Template File: l l l l "None" File name: Select to accept a PDF/VT file as an input and automatically create content items based on the PDF/VT. "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template. Adding a template to the resources is done through the Send to Workflow option in the Designer Module.
PAGE 585

OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent 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 OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server.
PAGE 586

iteration. 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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 587

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Web Content The Create Web Content task generates the output of the HTML Context of a specified template for a single record and returns the HTML code to PlanetPress Workflow for further processing and return to the requester. Generally, this task is placed within an HTTP Server Workflow. This task can be added as an Action task (see "Action Tasks" on page 268) or as an Output task.
PAGE 588

Note that only the first JSON object is processed, as the endpoint generates HTML output for a single record. 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.
PAGE 589

the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data.) Warning The JSON format is not validated by the plugin; it is passed as is to the server. Note Only the first record or JSON object is processed, since this task can only generate HTML output for a single record.
PAGE 590

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 591

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 592

Note AFP input requires the CDP library. The library licence allows PlanetPress Connect to run up to 4 instances of that library on a given machine at a given time. Processing The task executes the selected data mapping configuration on the appropriate data source, or converts the PDF/VT into a Record Set directly. If the data mapping configuration expects a database data source, the Data Source option is ignored and the database is accessed instead.
PAGE 593

l l Output records in Metadata: Select to output the full Record table (no Details table) as metadata in the task. It is then possible to sort and filter the metadata using the regular metadata tools, as long as the Update Records from Metadata option is used in further tasks to use the modified metadata. Output results in XML data file: Select to output an XML structure containing the full Record Set including all details table.
PAGE 594

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 595

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 596

Properties General Tab l File name/ID: The name or the ID of the file to delete. The ID is the ID OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent 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.
PAGE 597

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 598

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 599

Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l 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.
PAGE 600

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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
PAGE 601

Input The task always takes the current Job File as input file. If you want to upload an external file, first use the "Load External File" on page 325 plugin to load that file as the Job File. Processing The task tries to upload the current job file to the OL Connect File Store by making a call to the /rest/serverengine/filestore/DataFile REST endpoint; see File Store Service: Upload File in the REST API Cookbook.
PAGE 602

Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l 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.
PAGE 603

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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
PAGE 604

Mark Connect Sets for Deletion The Mark Connect Sets for Deletion task indicates that an item in the Connect Database should be deleted the next time the Database Cleanup runs. This means that whatever item is set for deletion will no longer be available from the database. Input The task requires a valid metadata file containing items for deletion, including Job Sets, Content Sets and Data Sets. These can be created by the Execute Data Mapping, Create Print Content and Create Job tasks.
PAGE 605

l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l 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 in the" Task Properties Dialog" on page 777.
PAGE 606

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 Workflow 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. However, the ID is not visible in the PlanetPress Workflow log file.
PAGE 607

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. Properties General Tab l Metadata file: Enter the full path to a valid Job Metadata file, or use the Browse button to browse to a valid location.
PAGE 608

loop may log the error, terminate the current iteration and proceed with the next iteration. 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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
PAGE 609

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Retrieve Items The Retrieve Items action task locates and extracts items from the OL Connect Database so they can be used with further tasks. The items are retrieved using a set of conditions working together. Since this task can retrieve items at any level, it can be used to generate metadata or JSON data used in multiple tasks.
PAGE 610

allows for easy handling of the results through scripting in Workflow or in the Designer.
PAGE 611

"id": 3678079, "fields": { "ItemTotal": "29.99", "ItemShipped": 1.0, "ItemOrdered": "false" } }], "detail2": [{ "id": 3678080, "fields": { "ItemUnitPrice": "1150.00", "ItemOrdered": 2 } }, { "id": 3678081, "fields": { "ItemUnitPrice": "29.99", "ItemOrdered": 1 } }] } } ] The values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.details[0].fields.ID; Properties General Tab l Entity to retrieve: Use the drop-down to select which items to retrieve.
PAGE 612

l l l l l l l l l l l Job: Retrieves one or more Jobs, including all their content items ready to be printed. Output similar to the "Create Job" on page 567 task. Condition: Select entities based on one or more conditions, the value of a metadata field for example. Record ID: Select records based on their Record ID. This option is only available when the entity to retrieve is a Record. Multiple records can be retrieved by entering multiple Record ID's, each on a new line.
PAGE 613

Commingling (available only with the appropriate license) is a method by which Print Content Items are merged together to create mail pieces going to each recipient. For instance, retrieving a letter, an invoice and a notice within the same mail piece, which presumably could be added within the same envelope. Batching is the same principle when all the Print Content Items are generated using the same Template file.
PAGE 614

l 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 in the" Task Properties Dialog" on page 777. 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.
PAGE 615

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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 616

l Move Up: Click to move the currently selected line up one position in the list. l Move Down: Click to move the currently selected line down one position in the list. l Validate Names: Click to check the each of line in the list against the currently active Metadata. Metadata must be loaded in the Data Selector or through the use of the Debugging feature. Set Properties The Set Properties action task defines properties for entities saved in the OL Connect Database (Records, Content, and Jobs).
PAGE 617

l Properties: Add all the properties to be added l Name: The name of the property. l Value: The value to apply to the property. l Add entry: Click to add another line to the Properties list. l Remove entry: Click to delete the currently selected line in the Properties list. l Move entry up: Click to move the currently selected line up in the Properties list. l Move entry down: Click to move the currently selected line down in the Properties list.
PAGE 618

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 619

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 620

Send to Folder tasks, which are considered as action and output tasks, are documented in the current chapter. Delete Delete output tasks simply delete the job files they receive. They are often used after conditions to get rid of those files that did not meet the requirements of the condition. Input Any data file, with optional metadata. Processing The data file is either deleted directly or sent to the Windows Recycle Bin.
PAGE 621

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 622

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 623

Properties General tab l FTP Server: Enter the IP address or host name of the FTP server. l Port number: Set the plugin to use a specific port number. l l Use FTP Client default port number: Use the value as specified in the Preferences (port 21 is the default value). FTP Port: Enter the specific port number to use when Use FTP Client default port number is unchecked. Enter a value between 1 and 9999. Note: There is no validation to ensure the port is available.
PAGE 624

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 625

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 626

If firewalls control communication between the SOAP client and the Web servers, they must be configured so as not to block client-server communication. In the case of "string" type data, SOAP Client plugin tasks normalize all line endings to a single line feed character. 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.
PAGE 627

l l l l l Name: Displays the name of the arguments associated with the selected method. Note that you may also manually enter new arguments, change or delete existing ones, as well as change their order if needed. Type: Displays the argument type. Value: Lets you enter fixed or variable values. To exchange variable information between the Web service and PlanetPress Workflow, you must use job information variables %1 to %9 or variable %c (which contains the entire job file).
PAGE 628

l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
PAGE 629

Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 630

Properties General Tab l l l l Printer queue: Select the queues to which you want to send the output. Note that this is a variable property box, so you can use various schemes to use printer queue names that change with each job at run-time. Properties: Click to change the current printer queue properties.
PAGE 631

Note Known issue: If a data file with metadata is resubmitted to such a process, the from / to page values set by the user in the Resubmit interface are ignored. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 632

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 Workflow 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.
PAGE 633

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. The output may be an Optimized PostScript Stream or a Printer Centric stream (data file + trigger). If the data file is any file and the Pass-through option is selected, the file is sent as-is to the selected printer queue. Whether the queue will properly output depends on the capabilities of the queue and its target.
PAGE 634

copies. l Load balancing group (Options from this group are only valid if multiple printer queues were selected.) l l l l l l l Split job: Split job means that jobs will be split according to the criteria set in the Page delimiter group (see below) and that an equal share of the job file will be sent to each one of the selected printer queues. For a hundred page job, for example, if two queues were selected, each one will get 50 pages.
PAGE 635

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 636

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 637

Input Any data file. Processing While an email is always sent by this task (or at least attempted to be sent), the contents of the file and presence of attachments depends on the selected option. Refer to the properties' descriptions below to know what each option does. Once the contents of the file and attachments is determined, the email (and attachments) is either sent directly to the selected SMTP server, or is deposited in the "Outbox" folder of the local Microsoft Outlook account.
PAGE 638

Note Different email clients have different support for various features, especially with HTML emails. In most cases, if you want to send your email as an HTML message, your very first line should start with or . It should not be any other character). Also note that it is not currently possible to send both an HTML and plain-text version of your message.
PAGE 639

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. Emails generated by PlanetPress Workflow appear in the outbox before being sent by Outlook whenever it is set to send emails. Use SMTP mail: Select to use Simple Mail Transfer Protocol (SMTP) to send the emails (and attachments).
PAGE 640

On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 777. 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.
PAGE 641

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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
PAGE 642

Processing The file is saved in the location specified, as the file name specified. Properties General tab l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names. As with any variable property box, you can use any combination of text, variables and data selections.
PAGE 643

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: In the initial input tasks, this group is disabled and defaults to Stop Process.
PAGE 644

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 is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
PAGE 645

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. First, they contain information on any job file that comes out of the initial input task or any secondary input tasks. The number of job infos as well as their definition can be seen in the Other tab of any input task.
PAGE 646

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.
PAGE 647

Variable Name Example value when interpreted Extension %y Current Year 2010 %m Current Month (numeric) 06 %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 13char string 0ZIS4CW8U47VI00 Page 647
PAGE 648

Variable Name Example value when interpreted (will be different every time it is used) %t Current Temporary Folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool\6.tmp\ %e Current Metadata Filename job00ZAIZ2C4FXON16CE6C566.dat.meta %E Current Metadata Path and Filename C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool\5.tmp\job00ZAIZ2C4FXON16CE6C566.dat.
PAGE 649

Initial input tasks do not modify the value of %i. However, the following tasks do trigger the variable: l Barcode scan l Capture Field Processor l All Splitters (Including the Metadata Sequencer) l Get Capture Document l Loop l Capture PGC Splitter l 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.
PAGE 650

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.taskindex} The position of the task in the process % {error.errormsg} The error message, as entered in the OnError tab of the task. This is the same message as appears in PlanetPress Workflow Log file. %{error.errorid} The error ID, as entered in the OnError tab of the task.
PAGE 651

When the process ends, the local variable forgets whatever value was given to it by the process and goes back to its default value. Local variables are generally used to keep information that is useful for the process itself but not to any other process or instance of the process. For example, you could store the current order ID for the process, a name or an email. You can have as many local variables as you want in any given process.
PAGE 652

l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 350. You can use Scripts. See the chapter "Using Scripts" on page 91. Variables may be used as variable properties in variable property boxes (see Variable Properties). Manipulate Global Variables Note For information about Local Variables see Local Variables. Global Variables are set at the level of the configuration file and are shared between all processes and tasks.
PAGE 653

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. Click OK to save the new value.
PAGE 654

Variables may be used as variable properties in variable property boxes (see Variable Properties). 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.
PAGE 655

To create a new configuration, choose New from the PlanetPress button. If the active watch file is currently opened, and if it includes unsaved modifications, PlanetPress Workflow asks you whether to send the configuration to the PlanetPress Watch service before creating the new configuration. Select the Always send without prompting for confirmation option to automatically send the edited version of the configuration.
PAGE 656

Saving and Sending Saving and Sending a Configuration The core of the PlanetPress Suite workflow tools is the PlanetPress Watch service which, once started, constantly runs in the background to perform the tasks included in its current configuration file. PlanetPress Workflow lets you create, edit and save configuration files. As you are working on your configuration, you can save that configuration file as a file on your local hard drive.
PAGE 657

When you use the Send command, the PlanetPress Workflow Configuration program uses the currently opened configuration to overwrite PlanetPress Workflow service's current configuration. 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 PlanetPress Workflow Configuration to the local server: 1.
PAGE 658

Exit PlanetPress Workflow Configuration Program Once you are done using PlanetPress Workflow, you can close the configuration program. It is important to note that closing PlanetPress Workflow Configuration Program does not stop any of PlanetPress Workflow services or stop processing. You may exit PlanetPress Workflow Configuration Program in any of the following ways: l From the PlanetPress Workflow button, choose Exit.
PAGE 659

Although you can manually start and stop any service running on your computer, most of the basic services used by the system are started and stopped automatically. In the case of PlanetPress Workflow and their related services, you typically use a command included in your PlanetPress Workflow Configuration program to start and stop most services. Opening and closing your PlanetPress Workflow Configuration program has no effect on these services.
PAGE 660

Available Output services Output services are used to output jobs. The output services used by PlanetPress Workflow are: l l l l l l l FTP Output service: Places output jobs on a server via the FTP protocol. LPR (Line Printer Requester) Output service: Sends jobs to an LPD server or LPD compatible printers. The LPD/LPR printing protocol is a common way to send print jobs that, in turn, use the TCP/IP protocol to communicate through the network.
PAGE 661

Note The current PlanetPress Workflow status is always displayed in the lower-right corner of the PlanetPress Workflow Configuration program window. To start PlanetPress Workflow services via PlanetPress Workflow Configuration program: 1. Click Tools in the PlanetPress Workflow Ribbon. 2. Click Start Service in the Services Status group. A progress bar is displayed while your PlanetPress Workflow is being started. To stop your PlanetPress Workflow services via PlanetPress Workflow Configuration program: 1.
PAGE 662

To resume your PlanetPress Workflow service after pausing it: 1. Click Tools in the PlanetPress Workflow Ribbon. 2. Click Resume in the Services Status group. The PlanetPress Workflow Tool service starts performing jobs again.
PAGE 663

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 672. 2. The Quick Access Toolbar. See " The Quick Access Toolbar" on page 785. 3. The Ribbon Tabs. See "The PlanetPress Workflow Ribbon" on page 786.
PAGE 664

4. A Group within the Ribbon 5. The Process area. See " The Process Area" on page 773. 6. A specific link (aka a "component", "button" or "link"). 7. The Dockable panels including "The Plug-in Bar" on page 728, " The Object Inspector Pane" on page 727 and "The Debug Information Pane" on page 725. 8. The status bar. This displays your current software version and status of the PlanetPress Service. 9. The Configuration Components pane. See "The Configuration Components Pane" on page 674. 10.
PAGE 665

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.
PAGE 666

Show or Hide Areas of the Program Window You can choose to hide or display any of the customizable areas in PlanetPress Workflow program. Hidden areas will still contain the same information but will not be visible. To show or hide a Program window area: l In the PlanetPress Workflow Ribbon, click the View tab. l 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).
PAGE 667

button when the shape of a tab appears at the 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.
PAGE 668

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.
PAGE 669

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 To maximize a vertically attached area, click the upward pointing arrow on its title bar. l To restore a vertically attached area, click the downward pointing arrow on its title bar.
PAGE 670

Page 670
PAGE 671

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.
PAGE 672

To change the language used by the PlanetPress Workflow Configuration program: 1. Click the PlanetPress Workflow button, then click Select Language. The Select Language dialog box appears. This box lists all the languages that can be used by PlanetPress Workflow as well as the Use System Default Locale check box. 2. Select the desired language. 3. Use System Default Locale: Select to mirror your language settings, as defined in the Regional and Language Options of the Windows Control Panel.
PAGE 673

l l l Save: Saves the current configuration. If the file is new and has not yet been saved, or if the configuration is the loaded directly from the service, the Save As dialog is displayed instead. See "Saving and Sending" on page 656. Save As: Saves the current configuration under a new name. It does not overwrite any existing configuration file, unless an existing file is selected and overwritten manually by the user.
PAGE 674

The Configuration Components Pane The Configuration Components pane displays processes, subprocesses, variables, documents and printer queues. It also lets you add any of these components using the rightclick menu. Components Area Sections l Processes: Displays a list of processes in your configuration. Right-click on a process to access a drop-down menu that offers these choices: l l Insert Startup Process: Inserts a new process as a Startup Process.
PAGE 675

l l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties for error handling. 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 Insert Global Variable: Creates a new global variable l Cut, Copy, Paste: Controls the clipboard. l Delete: Deletes the global variable from the configuration.
PAGE 676

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 Cut, Copy, Paste: Controls the clipboard. Delete: Deletes the document from the configuration, as well as the Workflow Tools Working Folders. l Refresh: Regenerates a PostScript Cache from the original document's PTK file. l Group, Ungroup: Triggers grouping functionality.
PAGE 677

Processes and Subprocesses The Processes component displays a list of processes in your configuration while the Subprocesses component displays a list of subprocesses. Process Properties To have access to the properties of a process or subprocess: l Right-Click on the Process in the Configuration Components Area. l Select Properties. You can also double-click on the process to show its options.
PAGE 678

l l l l l As soon as possible: Select to have the process run continuously. Clear to enable the Time Grid to fine-tune the schedule of the process. 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.
PAGE 679

The Time Grid The PlanetPress Workflow Process Options dialog box includes a time grid that lets you set exactly when you want a process to run. The grid is composed of blocks that represent time periods on a given day. To activate the Time Grid, the "As soon as possible" option must be unchecked. 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.
PAGE 680

l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two. l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
PAGE 681

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.
PAGE 682

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 734 screen.
PAGE 683

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}).
PAGE 684

l Type in the new name of the variable, then press Enter on your keyboard. 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.
PAGE 685

Convert a Branch to a Subprocess To allow for maximum flexibility and backward compatibility with the subprocess feature, the Convert to subprocess option lets users transform existing processes easily. This option is available whenever a Branch task is selected; right-clicking on it will display the contextual menu, which holds the Convert to subprocess option.
PAGE 686

it's name preceded by "global." and surrounded by curly brackets (for example: % {global.myGlobalVariable}). Global variables are generally used to keep information that applies to multiple locations but need to be changed easily. For example, a lot of uses use them to set a server's IP, a printer name, or folder location that is used by multiple processes.
PAGE 687

l Right-click on the variable name in the Configuration Components Area and click Delete. To rename a variable: l Right-click on the variable name in the Configuration Components Area. l Click Rename l Type in the new name of the variable, then press Enter on your keyboard. 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.
PAGE 688

Internet Explorer). l l l l Sample Data File(s): Displays a list of sample files that are included in the data mapping configuration. Double-click on a file to use it as a sample data file for the active process. Document Templates: Displays a list of templates that can be used in content creation tasks: "Create Email Content" on page 562, "Create Web Content" on page 587 and "Create Print Content" on page 582.
PAGE 689

l datamapper contains archives of the data mapping configurations (.OL-datamapper) l jobcreation contains archives of the Job Presets (.OL-jobpreset) l outputcreation contains archives of the Output Presets (.OL-outputpreset) l template contains archives of the templates (.OL-template) l workflow contains archives of Workflow configurations received by the server. The archives are saved using the template named followed by a timestamp.
PAGE 690

Document Properties Options Identification Tab The information here is read-only and gives you information on the document. l l l l l Document: The file name of the document, as entered in PlanetPress Design. This is the name of the file saved in PlanetPress Design, or the name you give it when you add a printer-resident document in your PlanetPress Workflow Configuration.
PAGE 691

l Document location group (enabled only when using Printer-Centric mode) l l l l l On printer hard disk: Select if the PlanetPress Design document is on the printer's hard drive. In printer flash memory: Select if the PlanetPress Design document is on the printer's flash memory. RAM: Select if the PlanetPress Design document is on the printer's RAM (Random Access Memory).
PAGE 692

Data Files When sending a PlanetPress Design Document from PlanetPress Design to PlanetPress Workflow, all data files used in the document are automatically sent to PlanetPress Workflow along with the Design Document. These data files appear under the Documents section of the Configuration Components. To set an attached data file as a sample data file in a process: 1. Make sure the Documents section is visible by clicking the 2. Expand the document (name.ptk) by clicking the button if it appears. button.
PAGE 693

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. Use Attached Document Preview When sending a PlanetPress Design Document from PlanetPress Design to PlanetPress Workflow, a PDF Preview of the job's output is automatically sent to PlanetPress Workflow along with the Design Document. This preview appears under the Documents section of the Configuration Components.
PAGE 694

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. Note that the name you enter must exactly match the actual document name or PlanetPress Workflow will not be able to use it on the printer or remote PlanetPress Workflow server. 3. Click OK.
PAGE 695

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 689 for more details. l Double-click on the document located within a printer queue. The Document Properties dialog appears.
PAGE 696

Copy Mouse Pointer Prohibited Mouse Pointer Moving Configuration Components Using Drag & Drop: l Click on the component and hold the mouse button. l Move the component to the location where you want to drop it. l Let go of the mouse button. Using the clipboard buttons: l Click on the component you want to move. l Go to the Home tab of the ribbon. l Click the Cut button in the Clipboard group. l Click on the new location where you want the component.
PAGE 697

l Click on the new location where you want the component. l Do CTRL+V (paste) on your keyboard. 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.
PAGE 698

Rename Objects in the Configuration Components Pane You can rename processes, groups, and printer queues in the Configuration Components pane. PlanetPress Design Documents (ptk/ptz files) are different and cannot be renamed or modified using PlanetPress Workflow. You can, on the other hand, change the name of printerresident documents. Note Names cannot begin with a number.
PAGE 699

To reorder selected objects in the Configuration Components pane: 1. Click an object or group. 2. In the PlanetPress Workflow ribbon, go to the View tab then click Order in the Arrange group, then select one of the following: l l l l Up One Level to move the item one level up in the hierarchy. If the item is already the top object in the category, or within a group, this command has no effect. Down One Level to move the item one level down in the hierarchy.
PAGE 700

To add a group in the Configuration Components pane: l In the Configuration Components pane, click a category and choose View | Arrange | Group. A new group is added at the end of the category. To add objects to an existing group: l Drag-and-drop the objects onto the group. The objects are added as the last objects in the group. To remove objects from a group: l Drag-and-drop the objects out of the group. The objects are removed from the group.
PAGE 701

Delete Objects and Groups from the Configuration Components Pane To delete a process, document, or printer queue: l Click a process, document, or printer queue, then press DELETE. In the case of processes and printer queues, the object is deleted. If there is only one process in the configuration, you cannot delete it; there must be at least one process in the configuration. If you delete the last configured process, a process with two unknown tasks remains.
PAGE 702

Note Printer activations are normally given to you by the activations department electronically, including a file that will automatically add all your printers in this dialog. To display the Activate a Printer dialog, click the button from the Help menu. The printer list displays the following information l l l License Number: Reference number of the activation, linked to your customer account. Magic Number: The magic number generated by the printer.
PAGE 703

themselves using a local or network account. The first time you start the PlanetPress Workflow Configuration program, the application automatically asks you to choose an account (see procedure below). You can also manually start this procedure from the PlanetPress Workflow Tools by following this procedure: 1. Click on the Tools tab in PlanetPress Workflow Ribbon, then click Configure Services. 2.
PAGE 704

l l l Password: Enter the password for the user account you specified in the user name box. Confirm password: Enter the password you entered in the Password box. Services start automatically: Select to start the required PlanetPress Workflow automatically. 3. Click OK.
PAGE 705

Options General tab l l 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. Startup process: Select to make this process a startup process. Self-Replicating Process: Check this if you want the process to replicate itself in the background when multiple input files are received simultaneously.
PAGE 706

l Select Date to display dates on the grid’s top ruler. l Select any of the other options to display days on the top ruler. l Select All weeks to have the process run every week. l l l l Select First, Second, Third or Fourth to have the process run on the first, second, third or fourth week. Select Last to have the process run only on the last week. Time division: Select the duration of each daily segment in the time grid.
PAGE 707

l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two. l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
PAGE 708

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.
PAGE 709

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 The left part displays the available tables in your database. Click the Show Tables button to display them.
PAGE 710

jobs to the server. 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 Design. 2. In the Ribbon, go in Tools | Managers | Access Manager. The Access Manager dialog box is displayed.
PAGE 711

Page 711
PAGE 712

To manually add a new entry in the list l Open the Access Manager l Make sure you are in the Messenger tab. l In the IP address box, enter the IP address of the remote machine. l Click on the l Add the necessary permissions l Click OK l Restart the Messenger service. button.
PAGE 713

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.
PAGE 714

does not continue processing after it has found an "Allow" checkmark. There is no concept of "Deny", meaning if any "Allow" permission is given, there is no way to later remove it for certain IPs or IP ranges. l l l 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.
PAGE 715

Console. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each user name entered in this dialog can have access to one or more processes. To add a new SOAP user 1. Click on the button. 2.
PAGE 716

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. Administrator: Choose the permission type l l l User: Can access none, some, or all of the processes, selected individually in the Permissions section. Admin: Has access to all processes and features.
PAGE 717

PDF Viewer The PDF Viewer, introduced in PlanetPress Tools 7.3 in some areas and expanded for use throughout the configuration tool, displays any PDF used in the configuration or process. Because this PDF viewer is integrated with the suite, it is not necessary to have any third-party tools such as Adobe Acrobat installed on the operating system. Technical The PDF Viewer is not currently standalone and cannot be used to display PDFs outside of PlanetPress Workflow.
PAGE 718

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.
PAGE 719

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. This will show the current data file in the viewer (assuming it is a PDF). If the viewer is opened during debugging, the current state of the PDF will be displayed (instead of the original data file).
PAGE 720

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.
PAGE 721

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. Click in the Messages area of the Service Console, and from the right-click menu choose Save to file. The Save As dialog box appears. 2. Navigate to a location, enter a file name, then click OK. The complete content of the Messages area is saved.
PAGE 722

Accessing the Data Repository Manager To access the Data Repository Manager: l Open PlanetPress Workflow l Go to the Tools tab. l Click the Data Repository Manager button in the Managers group. Warning Any change made within the Date Repository Manager is Immediate, and Irreversible. Deleting data from this interface may impact running processes if such processes access the data saved in the repository. This includes clearing a group, or clearing the repository.
PAGE 723

the values then click OK. The KeySet will display in the right part of the repository manager. l l Update section l l l Edit KeySet: Click to edit the currently selected KeySet. Opens a dialog which each key and their value, which can be edited. Double-clicking a row has the same effect as clicking the Edit KeySet button. Refresh: Click to load any changes made to the repository since it was last opened or refreshed.
PAGE 724

Repository Structure Pane This section of the Data Repository display a tree view of all groups in the data repository as well as all the keys under each of those groups. Group KeySets Pane This section of the Data Repository displays the current KeySets in the group. Each horizontal row is a KeySet, and each vertical row is a key defined in the group. l To edit a KeySet, double-click on it. l To delete a KeySet, press the Del key. l To add a new KeySet, press CTRL+N.
PAGE 725

PlanetPress Workflow 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.
PAGE 726

You can use the Evaluate Expression section to see the result of any combination of variable properties (see Variable Properties). To add a new expression, simply right-click in the window and select Add Expression. 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.
PAGE 727

l Messages in Gray are job info and variable changes. l Messages in Black are debug information and processing information. There are various actions you can execute in the Message area. Here they are: l l l l l l l Click any line to select it. While a line is selected, press Delete on your keyboard or right-click on the line and select Delete to delete the line. 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.
PAGE 728

To edit properties of processes, documents, and printers in the Object Inspector: l l l In the Configuration Components pane, select a process, a document (either a document in the Documents category or a document assigned to a printer queue) or a printer queue. The selected object’s properties appear in the Object Inspector. In the Object Inspector, click an editable property.
PAGE 729

referred to, in this documentation, as tasks, except in the specific case of importing a new plugin or customizing the Plug-in Bar. Categories The default categories list plugins according to what type of task they achieve.
PAGE 730

much are displayed as icon only. Move the bar up to display more full-width categories, or down to display them more as icons. Furthermore, the Plug-in Bar can be customized using the popup indicator control ( ). Customizing the Plug-in Bar is mostly used for third party or legacy plugins. Using the contextual menu displayed by the popup indicator, you can: l Insert, delete and rename custom categories. l Move categories up or down. l Import third party or legacy plugins.
PAGE 731

l l l Appearance: l "General appearance preferences" on the next page l "Object Inspector appearance preferences" on page 733 l "Configuration Components Pane appearance preferences" on page 733 Behavior: l "Default Configuration behavior preferences" on page 734 l "Notification Messages behavior preferences" on page 735 l "Sample Data behavior preferences" on page 737 l "Network behavior preferences" on page 738 l "PlanetPress Capture preferences" on page 739 l "OL Connect preferences"
PAGE 732

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 702. You can change the appearance of the Run Script and XSLT Editor through the Editor Options dialog. General appearance preferences Ribbon Color Scheme l Blue: Sets the general interface color scheme to a blue color.
PAGE 733

Object Inspector appearance preferences Colors 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. Options l l l l Vertical line 3D: Select to display the vertical line between property names and their values using a 3-dimensional effect. Use groups: Select to organize the display of properties into groups.
PAGE 734

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).
PAGE 735

Notification Messages behavior preferences Notification Messages behavior preferences control the display of certain messages and prompts within PlanetPress Workflow. Preferences 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.
PAGE 736

l l l l l l l l l l l Nothing to configure: Select to have PlanetPress Workflow notify you when you try to set properties for a task that does not have any properties. For example, the Error Bin input has no properties because it only inputs jobs sent to it through On Error properties of tasks in other processes. When you attempt to edit its properties, it displays the "nothing to configure" message when this option is selected.
PAGE 737

l l l l l Prompt on Emulation Change: Select to have PlanetPress Workflow prompt when the default process emulation is being changed. The last emulation selected when debugging a process is the one the process begins with. Prompt on Form Refresh: Select to have PlanetPress Workflow prompt for confirmation when recompiling the PostScript (PSx) version of a PlanetPress Connect Document. Refreshing PlanetPress Connect Documents that are currently in use can lead to unexpected results.
PAGE 738

Network behavior preferences Network behavior preferences let you configure NetWare® Login user options, so that PlanetPress Workflow can access your Novell® NetWare network. The following procedure also lets you choose the Universal Naming Convention (UNC), which removes inconsistencies when accessing paths on Novell and other networks. Preferences l NetWare Login: Check to enable the options PlanetPress Workflow requires to access NetWare resources.
PAGE 739

Note You can leave the Context box empty if there is a single root context on your NDS tree, if you can perform a context-free log in, or if you enter a server name in the Server box. PlanetPress Workflow and PlanetPress Image use the same security context when connected to a NetWare server and they each use one connection. Also note that using erroneous Tree or Context information may cause PlanetPress Workflow and its services to crash.
PAGE 740

l l Manage Pens...: Click to open the "PlanetPress Capture Pen Management Tool" on page 745 dialog. License Manager...: Click to open the "PlanetPress Capture License Management" on page 747 dialog. PlanetPress Capture Server/Client PlanetPress Capture can be set to be either in Server or Client mode from the PlanetPress Capture User Options. In Server mode, all pen licenses are stored locally. Other clients can connect to this server to validate pens. This allows all pen licenses to be managed locally.
PAGE 741

l l l l l l l l l Document Title: Search in document title as specified in the Capture Field Generator task. Production date (YYYY-DD-MM): Search using the date at which the document was generated using the Capture Field Generator task. Pen user (by description): Search using the description field in the Pen Database. Pen user (by serial number): Search using the pen's serial number in the Pen Database. Pattern Sequence: Search using the Pattern Sequence in the Document Database.
PAGE 742

Manage Documents Group l Document list: Displays the results from the search in 3 columns: 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. More info: A variable column that displays additional information about the search results, such as the Pen ID or Pattern ID. l Select all: Click to select all the documents in the list.
PAGE 743

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.
PAGE 744

Database Considerations (ODBC) Technical On 64-bit operating systems, the ODBC Data Sources created by the Data Source (ODBC) icon in the Administrative Tools will not appear here, as PlanetPress Suite is 32bit and cannot access the 64-bit 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 .
PAGE 745

l l l l MySQL's performance has been slower than SQL Server and SQL Server Express during our tests. By default, MySQL is configured not to allow any SQL request larger than 16 megs. In the event where 2 requests are made simultaneously on the same record, MySQL will queue one of the requests and execute it once the first one is done. In extremely rare cases this may cause a timeout on very large requests.
PAGE 746

Pen Data List: Displays a list of registered pens and those pens you just added. l l l Pen ID: The serial number of pen, as written on the Anoto Digital Pen. You can doubleclick this area to edit the Pen ID if necessary. Pattern Sequence: The pattern sequence the pen is assigned to. You can double-click this area and edit the pattern sequence as required. User ID: The name of the user assigned to this pen. You can double-click this area to edit the user ID. This can also be custom information.
PAGE 747

Multiple pens can be registered at once simply by writing on the registration pattern and then docking each pen before clicking the Read PGC File button. If the pen that is being registered already exists in the pen database, the Replace User ID (Description) dialog appears, with the following options: l Pen ID: Displays the Pen ID (serial number) to identify the pen l Old desc.: Displays the content of the User ID field for the pen as it is now. l New desc.
PAGE 748

Options and Controls PlanetPress Capture Pen Licenses Group l l Import License...: Click to open the Import License dialog. Browse to a PPLIC (PlanetPress License) file on your computer and open it to import the license. The PPLIC overwrites your current license, however it may contain more than one Pen Pack (your previous one and one you just purchased) and will display them individually. License List: Displays the licenses that have been added to this system.
PAGE 749

l l l 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. Warning The password cannot contain any special character that is normally present in a URL, for example @, :, /, =, +. l Email Creation Settings l l Mail Host: Enter the default SMTP Server host or IP Address.
PAGE 750

Warning The default values are generally correct for the greatest majority of PDF data files. Only change these values if you understand what they are for. Delta Width Defines the tolerance for the distance between two text fragments, either positive (space between fragments) or negative (kerning text where letters overlap). When this value is at 0, the two fragments will need to be exactly one beside the other with no space or overlap between them.
PAGE 751

At 0, the font size must be exactly the same between two fragments. At 1, a greater variance in font size is accepted. Accepted values range from 0 to 1. The default value is 0.65, recommended values are between 0.60 and 1.00. Gap Defines how spaces between two fragments are processed. If the space between two fragments is too small, the text extraction will sometimes eliminate that space and count the two fragments as a single word. To resolve this, the Gap setting can be changed.
PAGE 752

l l l Add time stamp to all processes events: Adds a time stamp to each log entry for a process event. Delete log files after: Select how many days log files are kept before being deleted. Maximum numbers of replicated processes: Set the maximum number of times a process may be replicated. Messenger plugin preferences Apart from enabling communication between the various parts of PlanetPress Workflow, the PlanetPress Workflow Messenger also manages local instances of the PlanetPress Workflow Alambic.
PAGE 753

HTTP Server Input 1 plugin preferences HTTP server input 1 plugin preferences control the server protocol aspects of the PlanetPress WorkflowHTTP Server Input tasks. This is where you enable and configure secure communication for the HTTP Server. 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.
PAGE 754

l l Password: Enter the password (or passkey) for the Private Key File. Please note that this password is encrypted within PlanetPress Workflow server and is not saved in plain text. Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. Note When SSL is enabled and a user sends a query prefixed with https://, then this specific communication will be sent through port 443, which cannot be changed in Workflow.
PAGE 755

Technical PHP Arrays This is an example of the new "Use PHP Arrays" option introduced in Workflow 8.5. HTML Example: PAGE 756
HTTP Server Input 2 plugin preferences The HTTP Server Input 2 plugin preferences are used to enable serving static HTTP resources, as part of an HTTP Server workflow. These resources are referred to within the HTML response file and do not pass through a process to get served so the process is very quick.
PAGE 757

LPD Input plugin preferences LPD input plugin 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.
PAGE 758

property is 7200 seconds (2 hours). On a time-out, partially received data files are not passed to the rest of the process; the LPD input resets and is ready to receive further data files. Log messages include the time-out duration. Serial Input plugin preferences Serial input plugin 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.
PAGE 759

l l l Time-out: Set the time in seconds the PlanetPress Workflow process waits for the transfer of bytes in the data file before ending the transfer of this file. On a time-out, partially received data files are not passed to the rest of the process; the Serial input resets, ready to receive further data files. Job delimiters: Enter the strings that tell PlanetPress Workflow the data file being retrieved through the Serial input is complete.
PAGE 760

given computer, only that computer is affected. So you should consider changing the PlanetPress Fax user options on the computer that actually performs the PlanetPress Workflow Fax output tasks. The changes you make to the PlanetPress Workflow Fax plugin preferences are stored in the PlanetPress Fax configuration file. They will be applied when PlanetPress Fax is started. Preferences l l Delete log after: Enter the number of days after which to delete the PlanetPress Fax service log.
PAGE 761

- Raster resolution: 196 dpi l Windows Fax Service l l l l l l Report Failures: Select to have PlanetPress Fax generate a report whenever the maximum number of retries for a single fax is exceeded. The error generated by the Windows Fax Service is also logged in the report. Note that when PlanetPress Fax is unable to send a fax because an empty fax number is used as the only recipient for a document, a failure will not be reported but an error will be logged.
PAGE 762

when PlanetPress Fax is unable to send a fax because an empty fax number is used as the only recipient for a document, a failure will not be reported but an error will be logged. l l l l Report Successes: Select to have PlanetPress Fax generate a report whenever one of the faxes in the PlanetPress Fax Job reaches its destination successfully or at least as far as the Windows Fax service is concerned. Folder: Enter or select the location of the report file.
PAGE 763

l l l Check for updates: Click to access the Objectif Lune website to search for updates to PlanetPress Image. You are guided through the updating process with the PlanetPress Workflow Update Service wizard. About: Click to display an About dialog box for PlanetPress Fax. This dialog box contains information such as the version number, whether the software is activated or the number of days remaining in the trial.
PAGE 764

PlanetPress Image preferences PlanetPress Image user options control certain functions of the PlanetPress Image service, which in turn has a direct impact on all PlanetPress Image output tasks performed on a given computer. These include error and logging options, PlanetPress Search database options, as well as networking and email options.
PAGE 765

of the job is created in the Error folder, which is located in the PlanetPress Workflow installation folder. l l l l l l Name or address not resolved: Select to send an email to the administrator when a name or address in the document selected to be used in PlanetPress Image cannot be resolved. Delete log after: Enter the number of days to wait before deleting the log of the generated PlanetPress Image output.
PAGE 766

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.
PAGE 767

l Use SMTP mail group: Check to activate this group’s options and to use Simple Mail Transfer Protocol (SMTP) to send the error messages to the administrators. Note that if you select this option, you will be required to enter information in the Name, Email address and Outgoing mail (SMTP) boxes. l l l l l l Name: Enter the name of the user sending the error messages to the administrators. Organization: Enter the name of the organization of the user sending the error messages to the administrators.
PAGE 768

yyyymmdd numerical format. Note that changing this option also affects the log displayed in the PlanetPress Workflow Service Console. l l l l No source port range restriction: Select to remove any restrictions on the port PlanetPress Workflow uses to send the job file via the LPR/LPD protocol. Clear to restrict the port used to send the job to one in the range between 721 and 731. Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service.
PAGE 769

The available preferences are as follows: l l User name: Enter the user name of a valid PrintShop Web user, mostly operators. Password: Enter the password associated with the user name on the PrintShop Web server. Note It is also mandatory to send your configuration to your PlanetPress Workflow service since the PrintShop Web credentials are included in the *.
PAGE 770

l l l l l l l l l l Optimal fill: Select to optimize the indent of every auto-indented line by minimizing the number of space and/or tab characters it uses. You must select both Auto indent mode and use tab character to use this option. Backspace unindents: Select to move the insertion pointer to the previous indentation level when you press BACKSPACE.
PAGE 771

portion of code, or by double-clicking to highlight the word or line under the pointer (the Double click line option determines whether a word or line highlights). You can cut, copy, paste, and print selections. If you also select Enable dragging, you can drag selections to reposition them in the code. l l l l l l l Enable dragging: Select to permit dragging and dropping a selection to reposition it in the program. This option works only if you also select Enable selection.
PAGE 772

l l l l Use monospace fonts only: Select to display only fixed width fonts in the Editor font drop-down list. Every character in a fixed width font occupies the same amount of space. Sample: Displays a preview of the font selected in the Editor font option, at the size selected in the Size option. Margin and Gutter Group l l l l l l l Size: Use to select the font size the Editor uses to display the program code. A preview of the selected font, at the selected size, appears in the Sample box.
PAGE 773

includes pre-set color values and attributes for each script element as listed in the Elements list box. After selecting a mapping, you can edit individual elements to change their pre-sets by selecting them in the Element list box and editing their values. l l l l Element list box: Select a script element in the Element list box, then edit the background and foreground color with which it is displayed, and/or its formatting attributes.
PAGE 774

l " Adding Branches" on the facing page l " Edit a Task" on the facing page l " Replacing Tasks, Conditions or Branches" on page 776 l " Remove Tasks or Branches" on page 776 l " Task Properties Dialog" on page 777 l " Cutting, Copying and Pasting Tasks and Branches" on page 778 l " Moving a Task or Branch Using Drag-and-Drop" on page 781 l " Ignoring Tasks and Branches" on page 782 l " Resize Rows and Columns of the Process Area" on page 782 l " Selecting Documents in Tasks Links" on pag
PAGE 775

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. Depending on where you place your mouse, you may see that you can replace or insert existing tasks, or not place it at that location at all. 5.
PAGE 776

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. Replacing Tasks, Conditions or Branches You can replace existing tasks either by dropping a new task on it, or by pasting another task over it.
PAGE 777

l l 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. Note You cannot use the Delete option to remove an input or output task, but you can rightclick on them and click Cut instead.
PAGE 778

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.
PAGE 779

To cut and paste tasks or branches: 1. In PlanetPress Workflow Process area, select the task or branch you want to cut and paste. 2. From the Home tab in the Ribbon, choose Cut (or right-click and select Cut from the drop-down menu). 3. To paste the task or branch to a different process, select that process. 4. Select the task or branch crossing above which you want the task or branch to be pasted. 5. From the Home tab in the Ribbon, choose Paste (or right-click and select Paste from the drop-down menu).
PAGE 780

l Tasks and branches will always appear on top (in other words, before) the task or branch where you paste it. The only exceptions are input and output tasks which can only be pasted on top of Unknown Task. Note Instead of pasting the actual task or branch, you can simply paste the properties of the task or branch. To copy and paste Properties of a task or branch: 1. Copy or Cut a task or branch of which you want to have the properties. 2.
PAGE 781

Moving a Task or Branch Using Drag-and-Drop When you want to move a given task or branch, the simplest way is to use drag-and-drop. Using the mouse, you can drag and drop tasks and branches only within a given process. To move tasks and branches between different processes, see Cutting, Copying and Pasting Tasks and Branches. When you move a task or branch using drag and drop, it typically moves from its original location to a position immediately preceding the target onto which you dropped it.
PAGE 782

dropped over an unknown initial input task will replace it. The same is true of an output task that is dragged and dropped over an unknown output task. Ignoring Tasks and Branches PlanetPress Workflow lets you ignore individual tasks, branches or conditions. l l When a task is disabled, it is not executed when the process is run in debug mode (see About the Debug Mode) or by PlanetPress Workflow Service.
PAGE 783

Selecting Documents in Tasks Links The Properties dialog box of some action and output tasks let you select documents. Depending on where the document selection list appears you will have access to all the documents or only the documents installed on a printer queue. In most cases, you have three options: l l l You can choose not to use any document (only in certain cases). This means no document is merged with the data and the job file is sent as is.
PAGE 784

Highlight a Task or Branch The Highlight command lets you toggle the background color of selected tasks and branches. Note that the highlight color may be changed via the PlanetPress Workflow Configuration preferences. To highlight a Process Area square: l Use the mouse pointer to select a given square. l In the PlanetPress Workflow button, click the View tab. l Select Highlight from the Navigate group. To remove the highlight, repeat the procedure.
PAGE 785

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. Right-Click on the button. 3. Select Add to Quick Access toolbar.
PAGE 786

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.
PAGE 787

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 Debug tab includes the Data, Debug and Debug Messages groups.
PAGE 788

l l l l The Document Manager button opens the PlanetPress Capture Document Manager. The Pen Manager button opens the PlanetPress Capture Pen Management Tool. The Test Page group contains: l l l The Service Console button opens the The PlanetPress Workflow Service Console, allowing to monitor real-time information on the configuration execution.
PAGE 789

Additional Information You can find additional information that complement the user manual about PlanetPress Workflow in the knowledge base.
PAGE 790

Copyright Information Copyright © 1994-2018 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.
PAGE 791

Legal Notices and Acknowledgements PlanetPress Workflow, Copyright © 2018, 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 Adobe PDF Library which is either a registered trademark or trademark of Adobe Systems Incorporated in the United States and\or other countries. Adobe XMP Core Copyright © 1999 - 2010, Adobe Systems Incorporated.
PAGE 792

l l l l l l l l l l l l Jacob Java Com Bridge which is licensed under the terms of the GNU Lesser General Public License Version 2. The source code for this can be obtained from the following location: http://sourceforge.net/projects/jacob-project/files/jacob-project/ JavaCraft JSch Copyright © 2002 - 2012 Atsuhiko Yamanaka, JCraft Inc. All rights reserved. JavaSysMon Copyright © 2009 ThoughtWorks, Inc. All rights reserved.
PAGE 793

l l l l l l l l l l l Relique CSV Driver which is licensed under the terms of the Lesser General Public License Version 2.0. This can be obtained from the following location: http://sourceforge.net/p/csvjdbc/code/ci/master/tree/ Rhino 1.6R7 and 1.7R2 which are licensed under the terms of the Mozilla License Version 1.1. The source code for this can be obtained from the following location: https://developer.mozilla.
PAGE 794

Portions of certain libraries included in this application which are distributed under the terms of the Mozilla Public License have been modified. To obtain copies of the modified libraries please contact your local Objective Lune Support team. This application also uses the following components which are distributed under the terms of the Apache Software License Version 2.
PAGE 795

l Apache OpenCMIS l Apache POI l Apache ServiceMix l Apache Tomcat l Apache WSS4J l Apache Xalan l Apache Xerces2 Java Parser l Apache XMLGraphics l Apache XML-RPC l Barcode4j l Google Collections l Google GSON l Jetty l LMAX Disruptor l OPS4J Pax Web l org.json.simple l Spring Dynamic Modules l StAX l XMLBeans Eclipse Technology: This Software includes unmodified Eclipse redistributables, which are available at www.eclipse.org.
PAGE 796

l freemarker/ext/jsp/web-app_2_2.dtd l freemarker/ext/jsp/web-app_2_3.dtd l freemarker/ext/jsp/web-app_2_4.xsd l freemarker/ext/jsp/web-app_2_5.xsd l freemarker/ext/jsp/web-jsptaglibrary_1_1.dtd l freemarker/ext/jsp/web-jsptaglibrary_1_2.dtd l freemarker/ext/jsp/web-jsptaglibrary_2_0.xsd l freemarker/ext/jsp/web-jsptaglibrary_2_1.