8.8

Manuals Brands Objectif Lune Manuals Applications PRes Workflow

Table Of Contents

User Guide

Version:8.8

Summary of content (790 pages)

PAGE 1

User Guide Version: 8.
PAGE 2
PAGE 3

User Guide Version 8.8 Last Revision: 5/23/2019 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-2019. 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 PReS 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 PReS Workflow Process The Plug-in Bar Categories Settings & Customization About Printing PReS Workflow Printer Queues Shared Printer Queue Properties Windows Output Printer
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 PReS 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 PReS Workflow Button Options The Configuration Components Pane Components Area Sections Processes and Subprocesses Manipulate Global Variables Connect Resources PPS/PSM Documents Associate Documents and PReS Printer Queues Using the Clip
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 PReS Workflow Ribbon The Task Comments Pane Additional Information 772 774 775 776 776 777 778 778 778 779 782 783 Copyright Information 784 Legal Notices and Acknowledgements 785 Page 9
PAGE 10

Welcome to PReS 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 PReS Connect, PReS Capture, CaptureOnTheGO, PReS Imaging, PReS 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 PReS Workflow. Pay close attention.
PAGE 12

System Requirements These are the system requirements for PReS 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 PReS Workflow.
PAGE 13

l 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 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. This is unlikely to occur, but it could, for instance, happen when importing a Version 7 configuration file into Version 8.
PAGE 15

l l l l The preferences for the PrintShop Mail Web connector may not be saved properly if you set them and close the PReS Workflow Configuration tool without first sending the configuration to the service. Make sure you send the configuration before exiting from the Configuration tool. 13009: With Outlook 2010, the Send Email functionality requires that the service be run with administrative credentials in the domain.
PAGE 16

Basics PReS 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 PReS Workflow. 1. Defining the printer (see Activate Your Printers). 2. Configure PReS Workflow Services (see Workflow Services).
PAGE 17

To add a PReS 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. Considerations l l l l l While your configuration is limited to a maximum of 512 processes, any given process can have as many tasks as necessary.
PAGE 18

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

Features PReS Workflow are input driven applications designed to output data in a variety of ways through diverse means to various applications and devices. PReS 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 PReS Workflow services to set up versatile automated processes to print jobs as well as generate other types of output.
PAGE 20

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 21

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 PReS 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 22

package are extracted and placed in the folders noted above. Resource Archives From version 8.2, PReS Workflow maintains an archive of previous versions of resources, in the following location: %PROGRAMDATA%\Objectif Lune\PReS Workflow 8\PReS Watch\OLConnect\Archive , each in their own folder: 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 (.
PAGE 23

Note Null characters present in the data may not be displayed properly when using PReS Workflow Configuration program, and that they may also be printed differently by different printers. To ensure consistency, you should consider filtering out such characters. Data File and Job File Whichever source it may come from, a serial port, an e-mail message, or an LPR request, for instance, and whatever its format, data entering a PReS Workflow process via an input task is always referred to as a data file.
PAGE 24

Job File Names and Output File Names When an input task sends a new data file down a process, it gives it an internal file name referred to as the job file name (associated with the %f variable). The new job file typically keeps the same name until the end of the process. l l If the job file comes to a branch in the process, PReS Workflow makes a copy of the job file and give the new file a new job file name.
PAGE 25

example, will generate three JPEGs or TIFFs called Invoice0, Invoice1 and Invoice2. Note that this does not apply to multiple TIFFs, which can include multiple images in a single file. Note You can change the name of a previously named file using a Rename action task (see "Rename" on page 330). Data selections A data selection could be compared to an address. It indicates a location within a data file or database (the job file, metadata file, or Data Repository).
PAGE 26

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.51041,KeepCase,NoTrim) In this case “?” represents the current physical data page processed by the task.
PAGE 27

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. l LowerCase: Converts all letters to their lowercase equivalent. Trim Option: Can either be "Trim" if you want to trim empty spaces before and after the data selection or "NoTrim" if you want to retain the extra spaces.
PAGE 28

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. return key: The name of the key where the information you want to retrieve is located. Does not need to be surrounded by quotes. lookup key: The name of the key in the group with which to look up the value.
PAGE 29

l l Case Option: This can be one of three options: 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. Trim Option: Can either be "Trim" if you want to trim empty spaces before and after the data selection or "NoTrim" if you want to retain the extra spaces.
PAGE 30

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'. Name Value Behavior GetAttribute 1 Search for the name argument in the attribute collection instead of the default field collection. See: "Metadata" on page 37.
PAGE 31

l l 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 32

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 33

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. Open the metadata viewer and save the metadata file to use it as a sample file.
PAGE 34

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 PReS Workflow . However, when these settings are made in PReS Design 7, they will function as expected in PReS Workflow 8.8. About Data Emulation Emulations are like filters that can be used to read the data.
PAGE 35

Warning PDF Emulation, also called Document Input, is only available in PReS 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. It is displayed when doing a data selection from the Generic Splitter task (see "Generic Splitter" on page 373) with the Use Emulation option unchecked.
PAGE 36

Note You can also use the PReS Workflow Database action task to get data form a database, and output in multiple different formats such as CSV. See "Database Query" on page 295. Choosing a Sample Data File In order to create your PReS Workflow Process, the sample data you are going to use has to correspond precisely to the job files that will be treated by that process, at least in terms of structure.
PAGE 37

Metadata Metadata is a hierarchical structure describing a job. Simply put, metadata is data about data or, in other words, information tagged to data. Metadata includes information about the data file itself, the document, custom user fields and in some cases page properties and page counts. PReS Workflow provides a whole series of plugins to create and edit Metadata within processes (see "Metadata Tasks" on page 505).
PAGE 38

remove pages, alter the data, etc.) makes the metadata obsolete and so it must be recreated or refreshed. Metadata in OL Connect tasks Although the metadata file created and maintained by OL Connect tasks looks the same as the metadata file produced by other tasks, it is in fact different: it contains less information. Only the first three levels in the metadata hold information about the job: Job, Group and Document. A Group has information about a record set and a Document about one record.
PAGE 39

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 40

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 41

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 42

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 43

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 44

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 45

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 46

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 47

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 48

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 49

Metadata in document properties Page 49
PAGE 50

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 51

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 52

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 326). 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 53

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 PReS Workflow by PlanetPress Design and is used to produce an output when merged with data.
PAGE 54

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 PReS 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 PReS Workflow installations. To import documents into PReS Workflow: 1. Click the PReS Workflow button.
PAGE 55

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. Most of the tasks, branches and conditions included in your process can have their own error handling behavior, with the exception of Comments, the Input Error bin task, and older legacy tasks from previous versions of PReS Workflow that did not have error handling.
PAGE 56

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 57

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. For example, you could place the job file in a specific folder, then send an email to a supervisor indicating that a job has failed. Or you could update a database with an error status so that it appears on a customer's online order.
PAGE 58

2. Click on the service you want to check, including: l PReS Workflow l LPD Server l Telnet Capture l Serial Capture l HTTP/SOAP Server l LPR Client l FTP Client l PReS Image l PReS Fax l PReS Messenger 3. When any job or file is processed by the selected service, the processing logs will be displayed in the window on the right.
PAGE 59

3. There are multiple logs displayed here, including: l l ppwYYYYMMDD.log - PReS Workflow logs, including the year, month and day of the log (from midnight to midnight). FTP, LPD, LPR, ??? (to be verified) Note The PReS Image and PReS Fax logs are available in different folders. From the Watch folder, go up one level then go in either folders, under which you will find the Log folder for that specific software within the suite.
PAGE 60

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 PReS 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 61

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

Debugging your PReS 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 63

Note The sample job file should generally be the exact same format as the data that you will receive when PReS Workflow is processing the job at run-time. For more information on how to capture your sample data file properly, please refer to the PReS 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 64

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 65

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, PReS 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 66

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 PReS 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 67

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 68

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 625. PReS Workflow provides you with three main printing scenarios: l l Send output data to be printed as is: PReS Workflow sends a file containing only the data to the selected queue.
PAGE 69

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 71. LPR Output printer queues are used to send print jobs to printers via the LPR/LPD protocol. See "LPR Output Printer Queue" on page 72. FTP Output printer queues are typically used to send print jobs to FTP sites. See "FTP Output Printer Queue" on page 73. Send to Folder printer queues are typically used to send print jobs to local or network folders.
PAGE 70

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 71

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 PReS 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 72

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 73

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 74

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 75

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 76

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 PReS Workflow, a trigger is typically a two line piece of PostScript code placed just before the data.
PAGE 77

Objectif Lune Printer Driver (PS) Introduction The Objectif Lune Printer Driver (PS) allows end-users to print directly to PReS Workflow from any Windows application, by using the familiar File|Print option. At the other end, PReS Workflow specifically can capture the incoming stream and convert it internally into a PDF file along with its metadata.
PAGE 78

PostScript, or PDF. Note that PReS 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. l This format is usually reserved for use with the Windows Print Converter action plugin. l This format can be obtained using PReS Workflow.
PAGE 79

6. Send the configuration and start your PReS 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 PReS Workflow is not yet started. This is because every Windows printer queue using Objectif Lune Printer Driver (PS) is paused by default. Once the service has started, it captures every queued job.
PAGE 80

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 81

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 82

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 746. 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 83

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 PReS Workflow Process Options dialog box includes a time grid that lets you set exactly when you want a process to run.
PAGE 84

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 85

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 86

Activate or Deactivate a Process All processes are Active by default, but you may make any PReS 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 PReS 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 87

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 PReS Workflow configuration file without having to import the contents of the entire configuration file.
PAGE 88

both include a startup process, the one in the imported configuration will become a standard process. Important considerations l l When importing a PReS Workflow configuration file, your PlanetPress Design and PrintShop Mail document are not physically imported as they are not part of the configuration file itself. In order for the documents to be available, you will need to send each document from PlanetPress Design and PrintShop Mail (see their respective documentation for details).
PAGE 89

Using Scripts Scripts can be used to perform various operations, such as to manipulate data, for example. PReS 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 PReS Workflow, its focus is to inform you about the features, variables and functions unique to this environment.
PAGE 90

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 117 variable. If the return value is zero (the default), the condition is false. Otherwise, it is true.
PAGE 91

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 92

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 93

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 94

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 95

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 96

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

implements five methods that will allow SOAP clients to submit jobs and get information from PReS Workflow executing them. Note PReS 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 98

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 99

Description The PostJob method allows users to remotely submit files to PReS 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). PostJobInfStruc – Structure containing any required information to prepare the file for resubmission into a PReS Workflow process.
PAGE 100

SOAP API - GetProcessList Syntax GetProcessList (user name, Password) : GetProcessListResult Description The GetProcessList function allows SOAP clients to request the list of available PReS 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 101

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 PReS Workflow process. l user name – String containing the user name. l Password – String containing the password. This is case sensitive.
PAGE 102

Description The GetSOAPProcessList function will allow users to request the list of PReS 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 103

l VariableName – String l VariableValue – String l ProcessName – String - Name of the PReS 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 104

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 105

Variable Name Description Example Usage (VBScript) Example Usage: str = Watch.getvariable("Varname") "Watch.ExpandString" on page 114 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 115 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 106

Variable Name Description Example Usage (VBScript) World!" "Watch.Sleep" on page 117 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 117 Returns a boolean True or False value to a Workflow scripted condition Example Usage: Script.returnvalue = 1 Watch.
PAGE 107

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 108

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 109

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

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 111

You must enable the “Run on desktop” option for the PReS Workflow process whose script calls Watch.InputBox. Otherwise PReS 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 106. VBScript s = Watch.
PAGE 112

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 113

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 114

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 115

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 116

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 PReS 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 117

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 118

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 119

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 50) and at design time via the "Data Repository Manager" on page 716. 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 120

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 121

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 122

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 123

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 124

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 125

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 120). JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.AddGroup("Users", ''); VB Script repoObject.AddGroup "Users", "[""FirstName"", ""LastName""]" repoObject.
PAGE 126

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 127

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 130 and "SetValueByID" on page 137). 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 128

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 129

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 120). JavaScript repoObject.GetKeySets("Users", '["FirstName","LastName"]', "Gender='M'"); VB Script myKeySet = repoObject.
PAGE 130

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 131

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 132

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 133

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 120). 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 134

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 135

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 120). 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 136

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 137

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 120). JavaScript repoObject.SetValue("Users", ); repoObject.SetValue("Users", AND MaritalStatus='Married'" repoObject.SetValue("Users", AND MaritalStatus=''" ); "FormOfAddress", "Mr.", "Gender='M'" "FormOfAddress", "Ms.
PAGE 138

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 120). 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 139

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 140

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 141

presented, which is a weekly sales report sent to all the sales associates of a particular company branch. See the "PDF Workflow" on page 183 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. See "PlanetPress Capture Workflow" below for more details.
PAGE 142

l "Capture Information" on page 144 l "Database Considerations (ODBC)" on page 148 l "Security Considerations" on page 150 l "20,000 Patterns" on page 151 l "PlanetPress Capture Implementation Restrictions" on page 158 There are also 2 external tools that are used to communicate the pen's data to PReS Workflow: l "Anoto penDirector" on page 156 l "PlanetPress Mobile Application" on page 158 Creating a Capture-Ready document This is done when creating your PlanetPress Design document.
PAGE 143

l l l l l An "HTTP Server Input" on page 224 task or "Folder Capture" on page 209 task that receives the PGC. The "Capture Fields Processor" on page 482, which converts each PGC in an EPS layer, adds this layer to the PDF in the database, releases patterns and closes documents. Optionally, a "Capture Condition" on page 472 task to do post-processing using the Capture Fields data.
PAGE 144

l The "Input Error Bin" on page 229 input task is triggered when the process sends data to the error process. l A "PGC to PDF Converter" on page 502 task converts the PGC to a PDF l Any existing output is used here, for example an email notification.
PAGE 145

Capture Condition PReS Workflow task that is used for post-processing of documents after they have been processed by the Capture Fields Processor. Conditions can be made on the document status or the presence (or absence) of ink on any of the Capture Fields on the document. Capture-Ready Document A PReS Connect document (*.pp7) that contains at least one Capture Field on at least one page. Capture Document Manager A tool that lets a user search through the available documents in the Capture Database.
PAGE 146

sequence being used such as when a pen is docked in the wrong location or if two pens are swapped. ICR (Intelligent Character Recognition) Recognizing text that has been hand-written with the Anoto Digital Pen. This feature is currently not implemented in PlanetPress Capture, but will be in the (near) future. Ink Data The pen stroke information contained within the PGC file. This is the actual data applied to the document (lines, signatures, text, etc).
PAGE 147

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. Pidget Type of PlanetPress Capture object. Page element used to give instructions to the Anoto pen, as opposed to recording ink. PlanetPress Capture Database A database containing the list of patterns, sequences, registered pens and documents.
PAGE 148

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 PReS Suite is 32-bit and cannot access the 64-bit data sources. In order to create an ODBC connection visible by PReS, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\odbcad32.exe .
PAGE 149

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 150

concerns about security and privacy. Are signatures secure? Could their transmission be intercepted? How can the contents of the Anoto digital pen be protected from malicious users? Before addressing these concerns, it must be pointed out that these security issues are not introduced by this new technology.
PAGE 151

l l l The PlanetPress Capture database, since it can be external to PReS Workflow such as on a MySQL server, will be dependent on your own database security. The Anoto Digital Pens, since they may contain critical information, are just like physical sheets of signed paper and must be kept secured. This is best done through training employees handling the pens to be aware of its value and contents and act accordingly.
PAGE 152

In a typical PlanetPress Capture implementation, a process in PReS Workflow generates output (generally, this output is directly printed) and, at the same time, will "lock" one pattern for each page that it generates, if that page contains a pattern. PReS Workflow also stores a copy of each document in the Capture Database, in PDF format.
PAGE 153

The example above actually uses numbers that are much higher than our typical PlanetPress Capture user. That is to say, a vast majority of our users will never have to worry about reaching the pattern limitation, unless their implementation is missing important parts, such as the "cleanup" process. But this also means a smaller minority of our users may require more than 20,000 patterns, so let's deal with this now.
PAGE 154

sequence, and each pen is tagged (with a label) as being for use with a specific pattern sequence also. Each morning, as drivers are attributed a route, they pick up the correct pen and stack of paper that belong to their route before leaving. Note It's very important to note here that the Anoto Digital Pen has absolutely no concept of Pattern Sequences. When "attributing" a sequence to a pen, this is fully on the PReS Workflow side, in the Capture Database.
PAGE 155

and in different situations, and can have devastating effects in some of those cases so please pay special attention to this section. First, contamination is not limited to implementations that extend their patterns through methods 1) and 2) above. Any time that a pen writes on a "wrong" document, it is considered contamination. A simple example in a basic implementation would be to print a document with a pattern on it, put this paper aside (or lose it on a desk somewhere) and forget about it.
PAGE 156

Safeguards There are certain safeguards against contamination: l l PlanetPress Capture checks for pattern size and placement. If the data contains ink for a specific pattern but the ink location does not correspond to the Capture Fields of the document it's updating, it will fail. Errors can be set to stop and revert the whole current batch. If a single error occurs during the pen data processing, it is possible for this processing to be stopped and all changes the Capture Database reverted.
PAGE 157

To configure this communication: 1. Open penDirector setup by right-clicking on its icon in the Windows System Tray, and selecting penDispatcher. 2. Double-click on the PlanetPress Capture entry. 3. Change the PGC Storage folder or PGC POST URL settings to your liking. 4. Click OK, then OK again. The PGC POST URL should correspond to your server name or IP, Port and the HTTP Action task of your HTTP Input, if that is what you are using. Example: http://127.0.0.
PAGE 158

Warning Because the Bluetooth configuration only handles a single route, it is not possible to use the Design preview patter, or the special registration pattern, using Bluetooth connectivity. To use the preview Pattern in PlanetPress Design or use the special registration pattern, the pen's docking station must be used. To specify where to send the PGC files received through Bluetooth: 1. Open penDirector. 2. Go to the Bluetooth tab 3. Click on the paired pen that you want to configure 4.
PAGE 159

Black ink close to patterns Because the Anoto Pen & Paper technology relies on infrared to read pure-black dots on the paper, it is imperative that no other black ink interfere with this reading. Though it is possible to print Capture documents on a black & white laser printer as long as there is no other ink on top of, or close to, the patterns, this is not recommended. A color laser printer should be used, and any elements placed close to, or on top of, the Capture Patterns should be printed in color.
PAGE 160

Pattern sizes The absolute minimum required for an Anoto Digital Pen to read the pattern and know it's position on the page is 7mm (1/4"). Any pattern smaller than this will not be readable. However, at 7mm width and height, the pen can only recognize a single dot within that pattern, at the top of the field. This is because the pen's camera (which captures the position of the pen) is located under the pen tip and must fully see the pattern.
PAGE 161

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 162

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 163

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 164

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 165

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 166

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 167

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 168

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 169

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 170

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 171

l Any input task l "Create Metadata" on page 505 l "Capture Fields Generator" on page 477 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 172

Post-Processing is generally done using the "Capture Condition" on page 472 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 173

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 174

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 175

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 176

the Resource action name box to static , and the Resource folder to c:\PReS\http . Then, click OK. 7. Send the configuration to your local PReS Workflow server. 8. Start PReS Workflow services (see "Start and Stop PReS Workflow Service" on page 656). 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 177

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 PReS Workflow using either a POST or GET command. The application or server then waits for a response from PReS Workflow Tools.
PAGE 178

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 PReS Workflow.
PAGE 179

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 224 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 180

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 181

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 182

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

l l Open HTTPBrochureRequest.pw7 and send the configuration to your local PReS 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 184

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 PReS Workflow, you can easily merge, split, print and take parts of the PDF file as required.
PAGE 185

l l l l "Run Script" on page 404 tasks can also modify metadata using the Metadata API (See "Using Scripts" on page 89). The "Barcode Scan" on page 275 task can add information to the existing metadata, and creates it if there is none. The "Capture Fields Generator" on page 477, "Capture Fields Processor" on page 482, "Get Capture Document" on page 498 and "Find Capture Documents" on page 493 tasks generate their own metadata.
PAGE 186

l l l l l l l l The "Metadata Level Creation" on page 520 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 510 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 187

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 545). 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 188

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 189

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 PReS 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. The Output to PReS Workflow plugin is on the Connectors tab in Workflow.
PAGE 190

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 191

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 192

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 193

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 PReS 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 194

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 195

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 642. l Local and Global Variables. See "Manipulate Local Variables" on page 678. l Job Infos. See "Job Info Variables" on page 641. l Data and Metadata Selections. See "Data selections" on page 25. l Printer Control Characters. See "Shared Printer Queue Properties" on page 69.
PAGE 196

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. Control Characters: Contains a list of control characters that can be used in printers. Get Data Value: Brings up the Data Selector, retrieves the value you select and places it in the variable properties box.
PAGE 197

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. See Cutting, Copying and Pasting Tasks and Branches Creating a new branch will create an unknown output task in that branch. See Adding Branches. Using Branch From Here... will create an unknown output task below that branch. See Adding Branches.
PAGE 198

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*.txt would pick up any file starting with file and any characters: file1.txt, filetest.txt. Question Mark (?): Supports a single character. file?.txt would pick up File1.
PAGE 199

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 200

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 201

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 PReS 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 202

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 203

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 204

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 PReS 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 205

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 206

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 207

"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 PReS Suite Workflow Tools working folders under the "Backup" folder.
PAGE 208

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

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 210

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 211

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 212

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 PReS 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 213

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 214

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 215

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 216

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

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 218

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 PReS 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 219

"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 PReS Suite Workflow Tools working folders under the "Backup" folder.
PAGE 220

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 221

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 PReS 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 222

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 PReS 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. l user name: A user name known to the Web server.
PAGE 223

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 224

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 PReS 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 225

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 226

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

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 228

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

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 230

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 231

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 771.
PAGE 232

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 233

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 234

"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 PReS Suite Workflow Tools working folders under the "Backup" folder.
PAGE 235

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 236

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 237

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 238

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 239

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 PReS 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 240

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 241

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 PReS Workflow to handle.
PAGE 242

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

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 PReS 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 244

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 245

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

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 247

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 248

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 249

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 250

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 251

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 PReS 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 252

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 253

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 254

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 255

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 256

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 257

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

multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see "Telnet Input plugin preferences" on page 753). 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 259

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 771.
PAGE 260

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 261

Note Before you go through the following procedure, on the computer running PReS 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 PReS Workflow queue remain in the spool folder, the printer queue must be paused. Input The WinQueue input regularly polls the selected printer queue for new jobs.
PAGE 262

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 357). 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 263

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 771.
PAGE 264

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 PReS 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 265

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 PReS Workflow.
PAGE 266

l "Windows Print Converter" on page 357 l "XML/JSON Conversion" on page 360 Add Document The Add Document action task prepares a printer-centric PostScript job by adding a PostScript version of a selected PReS 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 267

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 268

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 PReS 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 269

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 270

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

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 272

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 273

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 274

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 771.
PAGE 275

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 276

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 277

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 278

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 279

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 280

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

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 282

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 283

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 284

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 285

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 286

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 287

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 288

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

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 290

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 PReS 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 291

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 PReS Workflow to handle.
PAGE 292

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 293

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 294

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 295

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

table. Note that you can import a database connection configuration that you previously exported from PlanetPress Design (when you created a document) or from PReS Workflow (when you set up a sample data file for a process). l You can use dynamic properties (properties that include variables or data available at run-time). This option lets you create a dynamic database connection string as well as an SQL statement that changes based on the data processed by PReS Workflow.
PAGE 297

l Range group l l l 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. Note that this option is intended mostly for testing purposes, since in real life scenarios, you typically want to use all the records stored in a database.
PAGE 298

l 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). Fixed Length Columns Emulation: If you selected Fixed length columns in the Output file emulation box, the following options are available: l l l l Field separator: Select the field separator to be used in the generated file.
PAGE 299

wanted each data page to contain several records in the Create data pages as follows box. l l l l l XML for PrintShop Mail: This emulation is specifically for use with merging your data with a PrintShop Mail document, using the PrintShop Mail task (see PrintShop Mail). No options are offered, as this format is static and should not be modified.
PAGE 300

not doubled will be disregarded. l l l Expect record set: Check if you are expecting a result from the database after executing the SQL query. If the query is expecting a record set in return and does not return one, the task will trigger an error. Database connection string: Enter a variable connection string in this box. To do this you may begin by clicking to create an ODBC connection string to the data source and paste the string automatically to this box.
PAGE 301

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 302

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Decompress File(s) Decompress file action tasks decompress zipped job files (files compressed as zip files). Input This task only accepts ZIP Files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself. Processing Every file in the ZIP is extracted to the specified location.
PAGE 303

l l Force directories: Select if you want to allow the system to create new folders when required. If this option is not select and the Decompress file action task tries to save a file to a folder that does not exist, the task will fail. Overwrite existing files: Select if you want decompressed files that have the same name as existing files to overwrite the existing files. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 771.
PAGE 304

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 PReS 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 305

Technical The Digital Action task requires a PReS Image license to be present on the same IP Subnet as PReS Workflow, either on the same server or a different one with PReS Image installed and activated. Differences between Digital Action and Image tasks: l l l Digital Action is an action task and cannot be the last task in a branch or process. Image is an output task, and has to be placed at the end of a process or branch. In PReS Workflow 7.2.
PAGE 306

compatible with the PReS Image output if the PostScript was not generated by merging a design document with data in PReS Workflow. In order to generate an image in passthrough mode with external PostScript, please use the Digital Action task. l l List only documents using VDX compilation: Check to ensure that only documents that are compatible with the VDX compilation method are shown in the list, if producing VDX output.
PAGE 307

l l l l DPI: Enter the dots per inch (dpi) resolution of the output image. This property is enabled for all output types except PDF. Color depth: Enter the color depth of the output image in bits per pixel (bpp). The color depth is measured in bits, because each pixel of the output image can be described with a varied number of bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images.
PAGE 308

is saved, anything appearing after the last dot is replaced by the file’s extension characters (and the file name thus becomes Statement.2005.pdf instead of Statement.2005.255842.pdf, or Job.tif instead of Job.544872.tif). Failing to add the quotation marks may result in files being overwritten. l l l Automatically Add Extension: Check if you want the correct extension for the image type to be appended to the filename automatically, rather than having to add it in the Filename box.
PAGE 309

elements with large areas of single colors or repeating patterns, as well as on blackand-white elements that contain repeating patterns. l l l l l l l Auto-rotate pages: Select to automatically rotate pages based on the orientation of the text or DSC comments. Optimize for fast web view: Select to minimize file size and facilitate page downloading. Title: Enter a title for the document. If you leave this box empty, the document’s name will be used as the document’s title.
PAGE 310

l Grayscale images group l l l l Grayscale compression: Select the compression to use for the grayscale images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs.
PAGE 311

l l l Color down sampling: Select the down sampling option. down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels. The Color resolution you enter in the following box is used to control the down sampling process. Select None to prevent grayscale down sampling. Select Average to average pixel color in each sample area and to replace the entire area with a pixel of the average color.
PAGE 312

in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font. l l Initial view group l 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.
PAGE 313

l Initial view group l l Zoom factor: Select the magnification at which you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to open the generated PDF. Choose the Fit in window option to display the entire page using the available screen space, or choose a percentage of the actual document size. Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty.
PAGE 314

l l Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database. User ID: Enter the user id required to access the database to which you are adding new PDI files from the generated PDF files. If you are using an SQL database, enter the login name you chose when you configured the SQL database (refer to the “Using PReSSearch with an SQL Server Database” section of the PReS Search User Guide).
PAGE 315

Properties General tab l l l l l Hard disk name and path (as required): Enter the name and path of the hard disk to which the file is to be saved (enter “%disk0%/PPFiles/Resources”, for example, to save the file to the folder [ROOT]/PPFiles/Resources located on a hard disk identified internally as “disk0”). Leave blank to save the printer’s default hard disk and path. File name: Enter the name under which you want the file to be saved.
PAGE 316

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 317

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 318

Processing The external program is executed using the parameters provided. Note that the current data file is not "sent" to the executable file, however you can refer to the full path of the data file using %F. Output If the external program modifies the job file using the full path, the modified file is the output of this software. Otherwise, the output is the same as the input. Metadata is not modified in any way. Job Infos may be modified, depending on the options set in the task's properties.
PAGE 319

l l Store the program output in variable: Use the drop-down to select which variable or job info to will be used to store the program output. Exit Code group l l l l l Store the exit code in job info: Use the drop-down to select which variable or job info will be used to store the program's exit code. The exit code is a numerical value generated by the program which will indicate whether its execution was a success or if errors were encountered.
PAGE 320

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 321

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. Load External File Load External File action tasks are used to replace the current job file by the designated text file. Loading an external file does not delete the original file or modify it in any way. Input The current data file in the process will be discarded.
PAGE 322

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 323

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 PReS 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 324

VBSCript Math Operators. Input Any active data file, in any format. This data file is ignored by the task and is not modified in any way. 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.
PAGE 325

Note This task was built using a custom plugin system and does not display the On Error tab in the regular view. To access the On Error tab, right-click on the task and select "Advanced Properties...". Open XSLT The Open XSLT action task takes an XML file as input and executes the XSLT code as parameter to rearranges the content of the XML file. XSLT (or XSL Transformation) is a style sheet that describes how an XML document is to be transformed into another XML document.
PAGE 326

l l l l l 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. Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. 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.
PAGE 327

established first. The Push to Repository task can also be used to update an existing KeySet if a lookup is provided. Input Any data file, in any format. Processing A new KeySet is added to the Data Repository, or updated, using the data provided. 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.
PAGE 328

with this task is sent to a new Workflow server that does not contain this group or is missing keys, the task will create them automatically. l l l Update based on: Check this option to update an existing KeySet instead of creating a new one. The value of the Condition field is used to filter the KeySets to only obtain one or more.
PAGE 329

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 330

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Rename Rename action tasks are used to rename the job files they receive. Note that you can see how each file is renamed via the Object Inspector when stepping through a process in Debug mode. Input Any job file, in any format. Processing The task renames the job file to the desired name, and changes the value of %f and %F to reflect the new name.
PAGE 331

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 332

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 PReS 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 333

Output Whatever file the Run Script action generates, metadata it modifies or creates, etc. Note When using Run Script as a condition, the output of the task can be within the branch or on the main trunk. To control the output, use the "Script.ReturnValue" on page 117 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.
PAGE 334

l l l Language: By default, the task expects a VB Script. You can set another language as the default for the Run Script task in the the Workflow preferences (Behavior > Default Configuration). 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.
PAGE 335

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

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 337

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. Properties General Tab l l l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Replace with: Enter the string of data to use as a replacement.
PAGE 338

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 339

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 PReS 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 340

Processing The currently active image data file converted to postscript. The image's resolution, scan orientation, and quality can be modified, depending on the selected option. All files are converted into PostScript format for storage on the printer. If a virtual drive, the file is automatically sent to it. Output A postscript file containing the necessary code to save the data file on the hard drive.
PAGE 341

images by 75% when it converts those image to PostScript. The default compression level is 70%. l l l l Send to Virtual Drive of: Select the computers and / or printers to which the images are to be sent. Refresh: Click to prompt PReS Workflow to look again for available printers and computers. Hard disk name and path: You may enter the name and path of the hard disk to which you want to send the images.
PAGE 342

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 PReS 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 PReS Workflow log file. You can use any variables available in PReS Workflow to customize the message.
PAGE 343

Send to Folder Send to Folder action tasks send the files they receive to a local folder. They perform the same function as Send to Folder output tasks, with the only difference being that in this case PReS Workflow will wait for the task to be completed before going on to the next task in the configuration. 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.
PAGE 344

it, PReS Workflow will append the content of the new file to that of the existing file. This appending process will go on until the file is removed from the folder. l Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 771.
PAGE 345

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 PReS 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 346

Processing This task assigns the defined values to each local or global variables or job information. It does not modify the data file nor the metadata. Output The original data file, metadata and job infos are not modified, they are passed on to the next task. Set Job Infos and Variables action task properties are as follows: General tab l l Var/Info#: Lists all job infos, local variables in the current process and global variables in the configuration. Click on the variable you want to change.
PAGE 347

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 348

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. SOAP Client plugin SOAP Client plugin tasks can be used as input, output and action tasks, although their basic function is to generate output.
PAGE 349

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 PReS Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l l l l l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
PAGE 350

l l Namespace: Displays the namespace of the arguments associated with the selected method. Use returned raw SOAP packet as new data file: Check to use the complete SOAP packet (including the passed parameters) instead of the parameters only. This option overrides any return value set to %c in the Arguments box. You should use this option when the SOAP Client plugin is not able to fully support the syntax of the response. Advanced tab l Domain: Enter the domain for the authentication on the SOAP server.
PAGE 351

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 352

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Standard Filter Standard Filter action tasks can be used to remove HP Escape characters from data files, as well as to eliminate spacing problems caused by LF-CR end-of-line sequences. HP escape characters are used in the Hewlett Packard Printer Control Language (HP PCL) to communicate basic page formatting and font selection information from print jobs to HP or HPcompatible printers.
PAGE 353

spacing. l Remove and convert HP escape characters: Select to filter HP escape character sequences from the job file. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 771. 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 354

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 PReS 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 355

Technical You can create your own translation matrix files for the Translation Action Task by adding them to the following folder: %CommonProgramFiles%\Objectif Lune\PReS Workflow 7\Plugins\Translator Two examples are already present, converting ASCII to and from IBMEBCDIC.
PAGE 356

they will be simply stripped from the data, so you may consider using a space as a place holder for unidentified characters. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 771. 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 357

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 PReS 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 358

Note Although it is more common to perform both phases in a single pass, each phase can be performed selectively, as required. Input A print job in EMF format, generally captured from a WinQueue input task. Processing The EMF job is converted into a text-only, Line Printer Emulation data file. Output A Line Printer file. Metadata, job infos and variables are not changed. Properties General tab l EMF to XY group: Select this option if the file received by this task is a Windows print file.
PAGE 359

maximum to minimum font size (in points), that is less than 0.60, two text passages are not recognized as belonging together. For example, if two text passages are formatted with different font sizes. Passage 1 with 10, passage 2 with 18 point. The ratio 0.56 is smaller than the adjusted value 0.60. Therefore those two text passages are recognized as not belonging together.
PAGE 360

factor the font's height and size is multiplied with. The value for the font's height therefore is taken from the corresponding font's attributes. For example, if the height of that font example in 10 point size is 0.32 cm. There is a passage found that is positioned 0.15 cm above - which means 0.15/0.31 = 0.48 < 0.50 - the previous text passage. So the two passages are not recognized as belonging together. l Windows Print Converter: Select this option if the task is to generate a Line Printer file.
PAGE 361

If the current job file isn't JSON or XML (depending on the type of conversion requested), or if the conversion fails for any reason, the task raises an error and the current job file and metadata remain unchanged. JSON to XML conversion When a JSON source file contains a single JSON object, that object's key will be used as the root node name in the resulting XML file, and the root node will be populated with the data inside of the JSON object.
PAGE 362

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

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 364

If the process merges the split data with a document, the splitter must not alter the structure of the data file. In other words, each split file must have the same structure as the original files, otherwise the PlanetPress Design documents to which they will be sent will not be able to extract the data correctly and the merging process will fail. Warning Splitters do not modify the metadata that is currently active within your process.
PAGE 365

But when opened with PlanetPress Design or a PReS Workflow using the ASCII emulation, the data in the generated file would look exactly like the data in the original. The same would hold true for the Channel Skip emulation. Note the following details about emulations and their options: l l l l With most emulations, if a file is split on a form feed, the form feed will not be appended to the output file.
PAGE 366

l l l Field value condition: Select if you want the file to be split based on a condition set for the values of a selected database field (the value in the Order field equals 1, for example). Field count: Select if you want the file to be split whenever a given number of pages or data pages has been reached. The following options are only displayed when the Field value change or the Field value condition option has been selected at the top of the dialog box.
PAGE 367

Times box if you want to split the file every time the condition is met, but enter a value of 2, for example, if you want to split the file every second time the condition is met. l l l Time(s): Enter the number of times the condition must be met before the file is to be split. The following options are only displayed when the Field count option has been selected at the top of the dialog box. Maximum records per file: Enter the maximum number of records to include in each file. Enter 0 for no limit.
PAGE 368

l l l l l l Log Message: Check this option to enable logging a custom error message in the PReS 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 PReS Workflow log file. You can use any variables available in PReS 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.
PAGE 369

page 365) into multiple data files that are passed to subsequent tasks in the process. The data received by the process is typically prepared for a given output device using a pre-set emulation. In some cases, the data’s original emulation may also have been changed by a Change Emulation action task (See "Change Emulation" on page 283). Using an emulation to format the data before splitting provides the most splitting options, but slows down the process.
PAGE 370

l l l l l l l l l l Word change: Select if you want the data file to be split when the word found at a given location changes. Get: Click to go to the Data Selector and select the location associated with the Word change option. Specific word: Enter the word to use as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these.
PAGE 371

l l l After: 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 after the line on which the condition is met. When condition is found: By default, the task splits the file every time the condition is met (the default value is 1). If you want the task to split the file only when the condition has been met twice, for example, enter the number 2 in this box.
PAGE 372

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 373

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Generic Splitter The Generic Splitter is a legacy task which is kept for backwards compatibility purpose. In previous versions of PReS Workflow, it was the only splitter available. While this splitter seems to have more options than the other ones, this is only because it contains combined features from these other splitters.
PAGE 374

specific number of lines, or a chain of characters. See below for detailed information on any of these splitting methods. l l l l A word: If you choose “A word” in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. Word: Enter the string of characters to search for as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these.
PAGE 375

l l Split when word found: You may not want to split the file every time the string of characters entered above is found, but only every other time, or every third time. If so, enter the number of times in this box. A Word change: If you choose A word change in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l l Get: Click to select a search region.
PAGE 376

l l A Page Number: If you choose A page number in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l l Split when word changed: You may not want to split the file every time the string of characters entered above changes, but only every other time, or every third time. If so, enter the number of times in this box. Pages per output file: Enter a number of pages after which to split the file.
PAGE 377

l l l Before or after: In the previous box, you entered where you wanted to split the file. Here is where you specify whether you want the Generic Splitter to split the file X number of pages or records before or after the string. Choose 5 in the Pages or records box and “Records after” in this box, for example, to split the file 5 records after the record that matches the condition.
PAGE 378

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 379

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 PReS 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 380

l l l Page breaks on a number of lines: Select if you want start a new data page whenever a given number of lines has been counted. Enter the number of lines in the edit box below or use the spin buttons. Page(s) per output: Select if you want the file generated by the splitter to include multiple data pages. Enter the number of pages in the edit box below or use the spin buttons.
PAGE 381

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

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 383

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

l l l l l l l l Bottom: Enter a value corresponding to the bottom coordinate on which the splitter must start searching for the region. Match case: Select to force the splitter to match the character casing. Note that this setting applies both to the On region change and Specific word options. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Trim selection: Select to force the splitter to strip empty trailing characters.
PAGE 385

l l l l The following number of sequences in the job: Divides the metadata into a set number of sequences and equally distributes the number of levels between the sequences. For example, it the Metadata level is set to Document, and this value is set to 5, a 100 document job file will be divided into 5 sequences of 20 documents each. The following rule: Determine if a new sequence starts or if the current one ends.
PAGE 386

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 387

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. XML Splitter XML Splitter action tasks use the XSLT language to split XML data files into multiple XML data files that are passed to subsequent tasks in the process. The XML splitter includes options to add a new root node within the generated files, as well as to change the original file’s encoding to UTF8.
PAGE 388

l l l l l l l l l l l Condition node path: In the tree view, select the XML node to consider to determine when to split the file. To indicate whether you want the file to be split whenever this node is encountered or whenever the information in this node changes, see the Condition group below. Condition group: Use this group to indicate whether you want the file to be split whenever this node is encountered or whenever the information in this node changes.
PAGE 389

l l Refresh XSLT button: Once you have made all the required settings using the Standard XML splitter option, click this button to display the XML code generated by the XML splitter. You can then use the box below to edit the code as required. {WATCHTEMPFOLDER} file separator: Use this box to edit the default XML file separator (/). Alternate XSLT Engine tab This tab lets you choose the splitter settings for your own XSLT engine.
PAGE 390

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 391

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 PReS 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 392

if a branch does a backup of jobinfos and the data file, it does not back up the metadata. Keep this in mind when designing a process. 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" below.
PAGE 393

selected, the job file information that reaches the output task located at the end of the secondary branch is used for the main branch. Any modification performed on the secondary branch thus has an impact on the main branch. l l Backup emulation: Select if you want PReS Workflow to use the emulation selected when the job file reaches the secondary branch for the main branch as well.
PAGE 394

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 395

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Comment Comments can be used to clarify your process either for yourself or others, to explain branches and scripts, or add information for anyone editing the configuration in the future. Comments do not open, modify or otherwise process the job file in any way, and are simply ignored at run-time.
PAGE 396

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 397

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 PReS 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 398

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

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 400

subprocess from any GoSub action, in order to avoid circular referencing (aka an infinite loop). General tab l l l l l Subprocess: Drop down list containing all the available subprocesses in the current configuration. Backup job file: Select if you want to use identical copies of the job file for the main process and the subprocess. Backup job information: Select if you want to use identical copies of the job file information for the main process and subprocess.
PAGE 401

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 402

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. Loop Loop action tasks are used to repeat those tasks that are located after it on a given process branch.
PAGE 403

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 404

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 PReS 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 405

Processing The script is executed. The script can modify anything such as the data file, job infos, metadata, or even other files on the operating system. Output Whatever file the Run Script action generates, metadata it modifies or creates, etc. Note When using Run Script as a condition, the output of the task can be within the branch or on the main trunk. To control the output, use the "Script.ReturnValue" on page 117 variable in your script.
PAGE 406

l Search 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. l l l Language: By default, the task expects a VB Script. You can set another language as the default for the Run Script task in the the Workflow preferences (Behavior > Default Configuration). l VBScript: Select if your script is written in VBScript. l JavaScript: Select if your script is written in JavaScript.
PAGE 407

in your process and clicking Advanced Properties. The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from within your script. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 771.
PAGE 408

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 PReS 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 409

In either case, the called process will ignore the input task along with its job infos and schedule, and use the job file, job infos, metadata and variables from the current process. General tab l Process: The name of the target process to send current job to. Note that startup and subprocesses are not available. You can either enter the name of a process (or use variable properties) or use the drop-down to list existing processes. On Error Tab The On Error tab is common to all tasks.
PAGE 410

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 411

PReS Workflow uses the SNMP protocol in the form of an SNMP Condition, in to ways: l l To check the status of printers on your network against values you set in a condition, and to return a true or false value. This is called setting a Printer condition in the SNMP condition's Properties dialog box. To check different values of printers or other SNMP compatible devices against conditions you set, to return a true or false value.
PAGE 412

l l Printer Queue group (displayed when Printer Queue is selected in the Condition Type box) l l l l Condition type: Select Printer Queue to test a standard printer status condition or User Defined to test a status identified using a printer specific identification code. Bear in mind that the failure to comply with any of the test conditions selected below will make the whole condition False. Printer status: Select Idle or Printing to test whether the printer is currently idle or printing.
PAGE 413

manufacturers. They are based on a standard known as Abstract Syntax Notation One (often referred to as the ASN.1 standard). On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 771. 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 414

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 PReS 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 415

can be used to test whether or not the first string is equal to the second one, whether it is equal or lower than the second one, etc. The logic of text conditions can sometimes be tricky, especially if it includes variable strings, so you should test it thoroughly. Properties General tab 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.
PAGE 416

l l l l Compare to string: You cannot enter a comparison string when either “Is found” or “Is not found” is selected in the Operator box. Enter the second string of the comparison in this box. As with the String box, you can enter a static string, a variable or a data selection in this box. Page range: Select Any page if you do not want to specify a precise data page. Select Pages to specify individual pages or page ranges.
PAGE 417

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 PReS 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 PReS Workflow log file. You can use any variables available in PReS Workflow to customize the message.
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 PReS 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

every week of the month. Select a specific week of the month if you want the selected time blocks to be valid only on that week (the first, second or last week of the month, for instance). l l l Time division: Select the desired time interval. Each block in the grid corresponds to the selected time interval. Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). Grid: Select separate or contiguous time blocks. Click a block to toggle it on or off.
PAGE 421

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 422

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Connector Tasks A Connector, as the name implies, is a task that connects to something outside of PReS Workflow itself. In some cases those are other parts of the PReS Workflow, but in other cases we offer connectors for third-party applications or systems.
PAGE 423

Properties General Tab l Register Job to the SureTrac Server group: Check this option to enable the group. l l l l l Process Verification Job Name: The SureTrac job that this PDF should fall under. Use the button next to the list to retrieve a list of available SureTrac jobs from the server. Mailrun ID: A unique identification for the current job. This ID must never be the same between two mail runs - we suggest using either %f or %u , which are both always unique as they are based on date and time.
PAGE 424

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 425

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 426

l Repository ID: Enter a valid Capture OnTheGo Repository ID. l Password: Enter the password that corresponds to the Repository ID entered above. l Document ID: Enter the ID of the document to delete from the Repository. l Invert result: When the task is used as a Condition task, the success of the delete operation determines whether the condition returns True or False. Check this option to invert the result. On Error Tab The On Error tab is common to all tasks.
PAGE 427

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 428

When the Input from SharePoint task runs, it first lists all of the files to download then runs the process once for each file in the list. If any new files are added during the process, they will not be touched until the next time the process is scheduled. This task can work with many of the available SharePoint servers: l Microsoft SharePoint 2007 l Microsoft SharePoint 2010 l Windows SharePoint Services 3.
PAGE 429

Properties General Tab Note For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab. l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files.
PAGE 430

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. Domain: The active directory domain for the logon credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries.
PAGE 431

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 432

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 PReS 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 433

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. Task Properties General Tab l Laserfiche configuration group l l Folder: Enter the Laserfiche client repository folder where the documents will be exported. The user can specify the remote folder by clicking the Browse… button.
PAGE 434

l The indexes in the PlanetPress Design document must match the ones in the Laserfiche server. Connection Tab l Server Name: The server name or IP address of the server you wish to connect to. l Repository: The name of the repository you wish to send the files to. l user name: A user name in Laserfiche that has access to the above repository. l Password: The password for the above user name.
PAGE 435

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 PReS 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 PReS Workflow log file. You can use any variables available in PReS Workflow to customize the message.
PAGE 436

l To use the “Use PReS PDF/A archives” option, make sure to: l l l l l l l Check the field as Multiple, select CHAR type and enter the width fields in Laserfiche administration console as long as your PReS fields. Insert a folder path to your PDI source files in the PReS Image archive folder. If a field is checked as Required in Laserfiche administration console, fill the field value.
PAGE 437

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. Metadata is updated according to the specified criteria. Properties General Tab l Excel group l l l l Excel workbook: The full path and file name of a Microsoft® Excel® workbook (.xls or .xslx file).
PAGE 438

l l l l Result Field: The metadata field name in which the result should be stored. This field will appear in the same metadata level as the Lookup Field. Result Column: The name of the column where the information you want to retrieve is located. For example, this could be a client email or full name. button: Ads a new lookup line. You can have as many lines as you want. The lines will be executed in order from top to bottom, so you can rely on a previous line to bring additional information.
PAGE 439

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 440

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Use Cases Use Case 1: Send Personalized Emails with Promotional Document Attached A PlanetPress Design document takes as input a PDF file as the input data file, and reproduces it exactly as it enters. The document also contains a custom data selection set to hold an email address. The data selection's value is given by a Metadata Field called 'Email'.
PAGE 441

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. This is the same technique used in the "WinQueue Input" on page 260 when generating PDF files. Output One of: l By default, a PDF file accompanied with basic PDF metadata.
PAGE 442

DOC file was moved or sent to someone else. l l l l l Use custom settings: Override the mail merge settings in the Microsoft® Word® document and lets you specify your own. Connection String: The connection string to any ODBC database supported by PReS Workflow. You can use the Browse button to open an existing File DSN, or use the Database Button to open the ODBC connection interface.
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. Notes l Microsoft Word must be installed on PReS Workflow system.
PAGE 445

Output to Capture OnTheGo The Output to Capture OnTheGo task sends document information to the Capture OnTheGo online repository. These documents can then be retrieved by the Capture OnTheGo mobile application. This task can be added as an Action task (see "Action Tasks" on page 264) or as an Output task. Adding it as an Action task enables the process or branch to continue after this task. An Output task is always located at the end of a process or branch.
PAGE 446

Deposit Tab In the Deposit tab, you enter information regarding the document you are making available to Capture OnTheGo users. l Document to Publish group: This is where you specify the document location and type. It is mandatory to enter valid information in all the boxes included in this group. l l l l File Type: Select the appropriate document type. HTML for forms that users can fill out, and PDF for documents users can read.
PAGE 447

l l Categories: Enter at least one valid Capture OnTheGo document category in this box. Capture OnTheGo documents are listed by categories (Reference, Delivery bills, Satisfaction Polls, for instance) on Capture OnTheGo app. These categories are typically managed via the Capture OnTheGo Repository Management page. Note that there cannot be any spaces before or after each category name and that the names are case insensitive. Click the button marked with a plus sign to add a category to this list box.
PAGE 448

l l l l Until: If you want the document to remain in the repository until a given date, select this option and enter a date in the corresponding box (the date format must be “YYYY-MM-DD” - note that you can use the date picker). The date entered corresponds to the last day of validity (the document is valid until 11:59:59 PM on the date you entered). If you leave the box empty, the document will not be removed from the repository based on this setting.
PAGE 449

Processing The task connects to the selected Document store and uploads the current data file. If the file already exists, it will be overwritten and, if this option is selected, marked as "checked in". The information accompanying the file (the SharePoint metadata) is either updated or created. Output The output of this task is the original data file. Properties General Tab l l l SharePoint Site: The name of the SharePoint site where you want to send the files.
PAGE 450

name corresponds exactly to the Field Name in the SharePoint Document Library. If this option is checked, the Field Information will change to "Use PReS Index (PDF/A)". l Field Type: The type of field as set in the SharePoint Document Library. The following SharePoint field types are supported by the SharePoint output task: l Single line of text: This type may contain a string of any type of characters. This is the most flexible type of field.
PAGE 451

Examples & Use Cases This task is put into effect in the following use cases and example processes: l Capture Post Processing Workflow On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 771. 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 452

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 PReS 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 453

Input Any data file with a valid Emulation. Metadata is optional and can be used to specify the fax number and information to send the file. Alternatively, a TIFF file in the proper page size and compression (CCITT Group 4) can be used. Processing If a data file with metadata is used, the data file is merged with the selected PlanetPress Design document, converted into a multi-page TIFF file with CCITT Group 4 compression, and sent to the PReS Fax host specified in the properties.
PAGE 454

PReS Image PReS Image output tasks are used to make request to PReS Image, which creates image files which it then archives or emails. Since this task is an output, it is not possible to immediately act on the generated image before continuing. When necessary to immediately retrieve the generated file, "Digital Action" on page 304 should be used instead.
PAGE 455

Processing & Output Multiple things can happen, depending on the options chosen and the type of data this task receives: l l l If the data file and a document are selected, and Printer Centric mode is used, the data file is sent to the PReS Image host which merges the data and document to produce output.
PAGE 456

task. l l List only documents using VDX compilation: Check to ensure that only documents that are compatible with the VDX compilation method are shown in the list, if producing VDX output. Run mode group l l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PReS Image. Note that some features, such as the Time and Date functions, require that this option be selected.
PAGE 457

l l l l l l l Color depth: Enter the color depth of the output image in bits per pixel (bpp). The color depth is measured in bits, because each pixel of the output image can be described with a varied number of bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images.
PAGE 458

l l Automatically Add Extension: Check if you want the correct extension for the image type to be appended to the file name automatically, rather than having to add it in the Filename box. The Output Type determines the extension to be used. Index group: This group lets you specify which type of index must be created for each document generated by this task. PDI files are used by PReS Search as indexing information.
PAGE 459

l l l l l Author: You may enter the name of the author of the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time. Subject: You may enter the subject of the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time.
PAGE 460

compression. Select Auto to let the application choose the best compression method automatically. Note that configurations that were created with an earlier version of PReS Workflow and that included tasks set not to use any compression will by default be set to use the Flate compression method. l l l Downsampling: Select the down sampling option. Down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels.
PAGE 461

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 Resolution: Select the resolution to use for color images. Note that this setting has an impact on the color down-sampling process. Security group l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files.
PAGE 462

l Initial view group l l Zoom factor: Select the magnification at which you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to open the generated PDF. Choose the Fit in window option to display the entire page using the available screen space, or choose a percentage of the actual document size. Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty.
PAGE 463

l l Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database. User ID: Enter the user id required to access the database to which you are adding new PDI files from the generated PDF files. If you are using an SQL database, enter the login name you chose when you configured the SQL database (refer to the “Using PReSSearch with an SQL Server Database” section of the PReS Search User Guide).
PAGE 464

Input A PReS Classic job and the resources it needs. These resources include the data file to run against the job, plus any graphic or font resources the jobs needs, along with any required PReS Classic specific resources, such as TRF or PDI files. Processing The selected data file is merged with the selected PReS Classic job to create a print output stream.
PAGE 465

Note The use of pre-compiled PReS Classic jobs is heavily recommended, as this greatly reduces the scope for run-time errors. l Data File: The data file to use in the run. This file can be explicitly selected, or it could be set via a Connect Workflow variable. Note Note: If the Data File selection does not include the data file folder path, then the folder entered into the Working Folder entry will be used for determining the path.
PAGE 466

l PDL Type: Select the desired PReS Classic output type for the job. Note Not all PReS Classic jobs can be swapped between output types. Jobs designed for certain output types (such as AFPDS) will likely have settings specific to the original output type. Changing the output type at this point will likely lead to errors or require job modifications to suit the changed output type. l Log level: Specifies the verboseness of messages returned by job processing.
PAGE 467

Note It is heavily recommended that this setting be left as ‘Auto’, as PReS Classic licenses being assigned to different PRNx instances is extremely rare. l Time-out: The time in seconds that the Connect Workflow waits for a response from the PReS Print Control to make sure it is running. If Connect Workflow does not receive a response in the allotted time it will terminate the Print Control and continue to the next step in the workflow.
PAGE 468

Processing The data file is merged with the selected PrintShop Mail Design document, producing the number of records selected in the task properties. This merging uses the PrintShop Mail engine (PSMail.exe) to generate the output. Output The output produced by this task is dependent on the options selected: it can be PDF, a Windows EMF print job, a PostScript print job or a JPG file. Note that the Preflight output type doesn't actually produce printable or viewable output.
PAGE 469

l l l l l l l l PDF Type: Select Preview or Print to select which type of PDF should be generated. This option is only available when PDF is selected in the Output type box. PostScript Driver: Select which driver to use to generate the job. This should be the same as the printer selected in your PrintShop Mail document when designing it. This option only appears in the PDF and Produce PostScript output types.
PAGE 470

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 471

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 PReS 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 472

Capture Condition The Capture Condition checks the status or field contents of a capture document that has been processed by the Capture Field Processor action task. Input A data file in PGC or PDF format that is accompanied by valid Metadata. This metadata must contain Capture information and is generally available after a "Capture Fields Processor" on page 482 or "Find Capture Documents" on page 493 task.
PAGE 473

l l l l l l l Document is closed: Condition will be true if the document is closed (all relevant Capture Fields are filled). Document is complete: Condition will be true if the document is still open, but all appropriate Capture Fields are filled. Document is partial: Condition will be true if the document is still open but only part of the appropriate Capture Fields are filled. Document is empty: Condition will be true if the document is open but no Capture Field is filled.
PAGE 474

its name to the Field Name box. l Condition: Defines what should trigger the condition: l Ink is Present: Triggered by the presence or absence of ink in the field. l l l l l l l l l l All: Ink should be present in all fields of this name in your document. Index: The specified index of the capture field of this name should contain ink. The Index property is generated when a Capture Field object is repeated or is part of a runpage. This index is 1-based.
PAGE 475

l Complete: The field contains ink and no error was detected. l Empty: No ink was found in the field. l l l l Error: A logical error was detected in the field. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc. ICR Value: Triggered when the value given by the ICR engine compares with the specified value.
PAGE 476

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 771. 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 477

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 PReS 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 478

with Capture Fields, you must review and understand the Critical PlanetPress Capture Implementation Restrictions. Input The Capture Field Generator action task expects to receive a regular data file that corresponds to the Capture-Ready document that uses it, along with Metadata generated using the same data file and document. This means that this task must be preceded by at least the Create Metadata task.
PAGE 479

Note If any error occurs during processing, such as running out of patterns while generating the job, every action made by this task will be rolled back as if they hadn't happened. Output The Capture fields Generator action task will output either a PDF and Metadata, or an Optimized PostScript Stream file without Metadata.
PAGE 480

l l Fail if document doesn't contain at least one capture field: If the static or dynamic document that tries to pass through this task does not contain any capture fields, an error will be generated. Simulate pattern area on final document: When retrieving the document from the database with the Get Capture Document, each Capture Field is simulated using a grey box.
PAGE 481

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 482

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011.
PAGE 483

even those documents that were processed before will revert. It is strongly suggested to backup your PGC file before using this task and to create an error handling process to capture these errors. Logical errors do not cause this task to exit. For example, if a List Item Capture Field is set to only accept a single option but contains ink in more than one option, or if a Capture Field that does not accept re-writing receives more ink, the task will still complete.
PAGE 484

l l CapTemplateName: Name of the PReS Connect document used to generate the document. Page Level: l CaptureField: Information on each capture field on the page. Repeated for each capture field that is present.
PAGE 485

For example, accented letters are not correctly recognized in the English ICR database. l l l l Fail if new ink is found on non-rewritable fields: Check to trigger the On Error tab if and when a field set as Disable Rewriting receives ink in a new session. Ignore out of bounds ink data: Check to continue processing even if receiving a PGC that causes ink to be outside of any Capture Field to appear. This may happen if updating the wrong document.
PAGE 486

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 487

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 PReS 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 488

Processing The PGC file is split by document, if a document can be matched for each pattern ID found in the PGC. The match is made by comparing each Pattern ID with the information found in the Capture database. If more than one pattern is used in a document (pattern on multiple pages of the document), all of the information for this document (more than one Pattern ID) is sent down as a split. Patterns that do not match any document are sent individually, one Pattern ID per split.
PAGE 489

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 490

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 PReS 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 491

Output The original data file is output by this task, along with the original Metadata file that has been enhanced with the ICR data at the selected level. Properties General Tab l l Document ID: A variable data field that corresponds to the database ID of the document from which you want to retrieve ICR data. The Document ID is generated by the system through the Capture Fields Generator. The ID must correspond to a document in the Capture database, or the task will fail with an error.
PAGE 492

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 493

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Find Capture Documents The Find Capture Document task retrieves a list of pertinent information about Capture documents present in the Capture database according to a specified set of rules. This task is most often useful as the beginning of an automated process using a series of Capture documents, for example one that removes old documents to unlock patterns.
PAGE 494

Properties General Tab l Document-ID Based Condition: Select this option for this task to filter its results using a specific Document ID. l l Document ID: Enter the ID on which you want to filter. The Document ID is a unique identifier of the document when it is stored in the database. It is attributed to the job metadata when the "Capture Fields Generator" on page 477 ads it to the Capture database.
PAGE 495

l l Content Status: The status of the document as a whole. A document can be Empty (no ink), Partial (some ink but still open), Complete (all mandatory ink is present) or in Error (logical or process error). Operator: The choice of the condition operator. The available choices are variable depending on the filter but will be part of the following choices: l l l l l l l l l l l l Equal: Inclusive filter, where anything equal (either by string or numeric comparison) is included in the results.
PAGE 496

l l l l l Condition: The condition or value the document needs to meet. The condition is variable dependent on the chosen filter. It can be a drop-down of values, an alphanumerical or numerical value. Add button: Click to add a condition row to the grid. Remove button: Click to remove the currently selected condition from the grid. To select a row, simply click on any of its 3 components.
PAGE 497

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 498

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 PReS 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 499

Technical Performance-wise, when this plugin retrieves a document from a 10,000 page PDF in the database, it will take more time then if it retrieved it from a 100 page PDF. Output The Get Capture Document action task is a loop that outputs a PDF version of the Capture Document. The PDF contains the original document, any ink added by the "Capture Fields Processor" on page 482 action task.
PAGE 500

l l l Get closed documents only: Get only the documents that have been closed in this process, according to the metadata. Close document after retrieval: Once the task has retrieved the document from the Capture database, the document will be closed even if it is incomplete. Annotate PDF: Add annotations to the PDF that describe each Capture field and the ink that is included in those fields. Note that not all PDF readers support annotations.
PAGE 501

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 502

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. PGC to PDF Converter The PGC to PDF Converter tasks extracts the digital ink located in a PGC file and adds it to a blank PDF, creating one page per document in the PGC. It's main use is to process PGCs that generated errors when processing them, as part of an Error Handling process.
PAGE 503

Note This task was built using a custom plugin system and does not display the On Error tab in the regular view. To access the On Error tab, right-click on the task and select "Advanced Properties...". Examples & Use Cases This task is put into effect in the following use cases and example processes: l PlanetPress Capture Workflow On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 771.
PAGE 504

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 PReS 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 PReS Workflow log file. You can use any variables available in PReS Workflow to customize the message.
PAGE 505

Metadata Tasks Metadata tasks are plugins that can create or edit metadata for a job file. For more information about the metadata structure and elements, see "Metadata" on page 37.
PAGE 506

If the "Do not use document (passthrough)" option is used, no PlanetPress Design document is used. The metadata will contain a single Job, Group and Document level, as many data page levels as there are records (pages in a PDF, XML levels, etc) in the file, and one page level per data page. Technical In PlanetPress Design, this step is equivalent to a &metamode variable value of 1. Output The original data file is output, along with the newly generated metadata file. Job infos are not changed.
PAGE 507

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 508

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. If your process continues after the 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.
PAGE 509

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. Embed metadata from PDF job file: the current metadata file is inserted in the current data file, which is assumed to be a PDF file.
PAGE 510

l l l l l l Log Message: Check this option to enable logging a custom error message in the PReS 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 PReS Workflow log file. You can use any variables available in PReS 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.
PAGE 511

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. Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties.
PAGE 512

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. If the name already exists, the value is overwritten with the new one. Duplicate: Create a new metadata field. If the field already exists, a new instance is created. Append: Append the new value at the end of the current one. If no field with that name exists, a new one is created.
PAGE 513

l l l l Auto-detect: Interpret automatically the value. This option is ideal for documents using mixed decimal separators. Note that the auto-detect option encountering the value 1,000 (with a comma separator), interprets it as a thousand while interpreting 1.000 (with a dot separator), as one. .: Treat every value with the dot (".") decimal separator. Commas (",") are treated as thousand separator. ,: Treat every value with the comma (",") decimal separator. Dots (".
PAGE 514

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 PReS 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 PReS Workflow log file. You can use any variables available in PReS Workflow to customize the message.
PAGE 515

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. Process This task does not execute any change to the process, its files or variables. It only executes the selected action on Metadata. Output This task outputs the exact same data that was given to it.
PAGE 516

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 517

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 PReS 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 518

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). Datapage: Select the metadata Datapage nodes (the nodes only) based on the specified rule(s).
PAGE 519

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 520

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. Special Considerations l l The task CANNOT re-select unselected nodes if the condition is false for those nodes.
PAGE 521

“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. Metadata Level Creation: Begins a new document node when “Page 1 of” is found on a data page. l Action: Document l Delimiter: Begins when l Rule: (@(?,1,1,1,9,KeepCase,NoTrim) IS EQUAL TO Page 1 of) 3.
PAGE 522

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. Rules enable the user to define on which criteria the action must to be performed. The condition must be TRUE to execute the action. If the condition is not met at least once, the rule is not applied.
PAGE 523

l l l l l l Log Message: Check this option to enable logging a custom error message in the PReS 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 PReS Workflow log file. You can use any variables available in PReS 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.
PAGE 524

level is required before evaluating the condition. For example, in a PDF emulation, the format of a selected region would look like this: region(?,0.59375,2.21875,1.85416,2.51041,KeepCase,NoTrim) where "?" represents the current page. Using this expression, if the metadata structure has 3 data pages, then the task will proceed 3 times sequentially, with ?=1 for the first data page, ?=2 for the second and ?=3 for the third and last data page index from the metadata structure.
PAGE 525

and is ignored by all tasks using metadata afterwards. Properties General Tab l Metadata level: Select the metadata level to process. l Sequencing is based on l l l The following number of occurrences of the level: Determine a sequence based on the number of instances found for the metadata level currently processed.
PAGE 526

Output The original data file is output, along with the modified metadata. General Tab l Group: Sorts the metadata by group. l Document: Sorts the metadata by document. l Data page: Sorts the metadata by data page. For each parameter, three columns are available: Sort By, Then by, Then by (again). This lets you sort your document level in three different orders sequentially. Sorts are always done from left to right, top to bottom, giving you a total of 9 sorting possibilities.
PAGE 527

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 528

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 PReS 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 529

Output The output is the same as the input, no modification is done to either the data file or the metadata. However, a PDI file is generated and saved in the location specified in the task. Metadata to PDI Task Properties are as such: l l l Archive Folder: Specifies where the PDI file should be saved. This should be the same location as the PDF file that the PDI refers to. Filename: The file name for the PDI. This name should correspond exactly with the name of the PDF that the PDI file refers to.
PAGE 530

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 531

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. It allows to specify how many virtual pages will appear on each physical page of the PlanetPress Design template to be used with the current data file.
PAGE 532

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 533

l l l l l l Log Message: Check this option to enable logging a custom error message in the PReS 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 PReS Workflow log file. You can use any variables available in PReS 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.
PAGE 534

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. Connect Send can be used in unlicensed mode and licensed mode.
PAGE 535

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 536

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 537

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 538

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 539

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 540

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 541

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 542

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 543

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 544

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 545

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 546

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 547

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 548

“%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 549

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 550

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 771. 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 551

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 PReS 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 552

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. With the All In One, Job Creation is implied and equivalent to a single created job; it isn't possible to use a Job Preset. Tip If you do need to use a Job Preset, set the All-In-One’s Output Creation options to None.
PAGE 553

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. Configuration Names: Select the appropriate data mapping configuration. Adding configurations is done through the Send to Workflow option in the DataMapper Module.
PAGE 554

l l l l l l Import a rule: Click to open the Browse dialog and load a Rules file. This will load its rules into the list. Export the rule: Click to open a Save dialog and save the Rules file to disk. Rule Viewer: Displays a text-based view of the condition using operators and parentheses. Sort contents: Defines how records are sorted. l l Clear the rule: Click to delete all rules in the list. Note: This cannot be undone. Sort items based on: Displays the current sorting method.
PAGE 555

l l Template Names: Select the appropriate template name from the list. Adding templates is done from the Send to Workflow option in the Designer Module. Preview: Displays a preview of the output generated by the Print context of the selected Template. Not available for the PDF/VT or dynamic template names. By default the entire Print context is printed. Printing selected Print sections can only be achieved with a Control Script in the template (see Control Scripts in the Designer Help).
PAGE 556

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 771. 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 557

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 PReS 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 558

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. l Move Up: Click to move the currently selected line up one position in the sort list. l Move Down: Click to move the currently selected line down one position in the sort list. l Validate Names: Click to check the each of line in the sort list against the currently active Metadata. Metadata must be loaded in the Data Selector or through the use of the Debugging feature.
PAGE 559

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. Output Within the Workflow process, the output to this task is only modified metadata indicating that the task is complete.
PAGE 560

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. Email Info tab l l l l l Sender Address: Enter the email address that appears in the "From" field of the email.
PAGE 561

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 562

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 563

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. A Job is not actual contents but simply a collection of content items ready to be printed.
PAGE 564

l l "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below. Preset Names: Select the appropriate preset to generate output. 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.
PAGE 565

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 566

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 567

General Tab l Output Preset file: Select which Output Preset to use to generate the output. To be used in this dialog, a preset must have been sent to PReS Workflow using the Package File function in PReS Connect. l l l "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below. Preset Names: Select the appropriate preset to generate output.
PAGE 568

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 771. 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 569

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 PReS 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 570

Output The output is a PDF/VT with default quality settings. The metadata embedded within the PDF/VT is the one generated by the PlanetPress Document. Properties The Create PDF/VT action task properties are as follows (note that the Connect Proxy tab is not present as this task does not communicate with the OL Connect Server module): General Tab l l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document.
PAGE 571

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 572

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 Preview PDF The Create Preview PDF plugin generates a PDF preview for a single record as fast as possible. This preview is typically used for previews embedded in web pages. The plugin retrieves the resulting PDF from the file store and makes it available to the process as the job data file. The job file name extension is .pdf.
PAGE 573

l No storing or post-processing of the data records (faster): This option prevents data from being written to the database. Instead, records are streamed directly into the Content Creation process for immediate merging. Turning this feature on can improve data mapping performance significantly, as well as the time required for the cleanup process. However, since the data is not written to the database, there is no way to do post-processing on the extracted data.
PAGE 574

database before creating the preview PDF. Note The Metadata option requires that entries in the metadata have matching field names in the data model of the template. When they have, the 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 575

"email":"%2" } A JSON string containing a local variable and various lookups: { "jobid":"%{jobid}", "account":"lookup(OLCS_jobs, account, jobid, '%{jobid}')", "datafile_name":"lookup(OLCS_jobs, datafile_name, jobid, '% {jobid}')", "pages":"lookup(OLCS_jobs, pages, jobid, '%{jobid}')", "documents":"lookup(OLCS_jobs, documents, jobid, '%{jobid}')", "recordsetid":"lookup(OLCS_jobs, recordsetid, jobid, '%{jobid}')" } An example where the entire JSON string is provided in Job Info 1: %1 A JSON string constructed
PAGE 576

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. The record is then merged with the template to create a preview PDF. Select the appropriate template or option: l l %o: Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use.
PAGE 577

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 578

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 PReS 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 579

l A JSON Record Data List (see the REST API Cookbook). When the "Retrieve Items" on page 605 task is set to output Records in JSON, it outputs this kind of JSON data. If the input is JSON, the task performs a REST call to the /rest/serverengine/workflow/contentcreation/{templateId} endpoint on the Connect Server. For more information see the REST API Cookbook. Note When JSON data is used as input, the "Create Job" on page 563 plugin (the next task in a print process) cannot use a Job Creation Preset.
PAGE 580

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 581

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 582

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 583

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 PReS 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 264) or as an Output task.
PAGE 584

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 585

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 586

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

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 588

instances of that library on a given machine at a given time. Using AFP input in a Server Clustering setup requires you to purchase one additional copy of the library per Server Extension (slave). On each computer you can run up to 4 instances of the CDP library 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.
PAGE 589

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 590

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 591

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 PReS 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 592

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 593

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 594

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 595

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 596

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 PReS 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 PReS Workflow log file. You can use any variables available in PReS Workflow to customize the message.
PAGE 597

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 321 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 598

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 599

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 PReS 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 PReS Workflow log file. You can use any variables available in PReS Workflow to customize the message.
PAGE 600

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 601

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 771.
PAGE 602

l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS 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 PReS Workflow log file.
PAGE 603

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 604

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 605

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 606

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

"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 608

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 563 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 609

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 610

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 771. 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 611

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 PReS 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 612

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 613

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 614

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 615

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 PReS 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 616

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 617

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 618

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 PReS 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 619

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 620

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 621

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 PReS 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 622

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 PReS Workflow SOAP server is the following: http://127.0.0.
PAGE 623

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 PReS Workflow, you must use job information variables %1 to %9 or variable %c (which contains the entire job file).
PAGE 624

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 625

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 626

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 627

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 771. 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 628

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 PReS 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 629

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 630

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 631

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

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 633

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 634

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 635

to Outlook. Emails generated by PReS Workflow appear in the outbox before being sent by Outlook whenever it is set to send emails. l l l l l l l l l l Use SMTP mail: Select to use Simple Mail Transfer Protocol (SMTP) to send the emails (and attachments). To use SMTP you must enter information in the Name, Email Address and Outgoing Mail (SMTP) boxes below. Name: Enter the sender’s name that will be used in emails sent by PReS Workflow for this task.
PAGE 636

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 637

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 PReS 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 638

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 639

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 640

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. Working With Variables A Variable is basically a keyword that points to specific location in your computer's memory.
PAGE 641

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 642

Standard Variables Standard Variables, also known as "system variables", are variables that are created and managed directly by PReS Workflow. Those variables are read-only and cannot be modified. They provide information about the job, process, and PReS Workflow environment. Available Standard Variables Variable Name Example value when interpreted %c Content of your job file in its original format. n/a %F Job File Path and Name C:\Program Files\PReS Workflow 7\PlanetPress Watch\Spool\job1D80328.
PAGE 643

Variable Name Example value when interpreted %M Current Month (text) June %L Current Month (short text) JUN %d Current Day (numeric) 16 %D Current Day (text) Monday %l Current Day (short text) MON %h Current Hour 18 %n Current Minute 03 %s Current Second 41 %v Current Millisecond 24 %u Unique 13char string (will be different every time it is used) 0ZIS4CW8U47VI00 %t Current Temporary Folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PReS Workflow 7\
PAGE 644

Variable Name Example value when interpreted %e Current Metadata Filename job00ZAIZ2C4FXON16CE6C566.dat.meta %E Current Metadata Path and Filename C:\Documents and Settings\All Users\Application Data\Objectif Lune\PReS Workflow 7\PlanetPress Watch\Spool\5.tmp\job00ZAIZ2C4FXON16CE6C566.dat.meta %w Current process name. My Process %i Current Loop Iteration Index (always the innermost loop) 2 The %i Loop Count Variable In version 7.4, the %i variable is introduced.
PAGE 645

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 PReS Workflow 7.4 and are not available in previous versions.
PAGE 646

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 PReS Workflow Log file. %{error.errorid} The error ID, as entered in the OnError tab of the task.
PAGE 647

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 648

l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 345. You can use Scripts. See the chapter "Using Scripts" on page 89. 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 649

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 650

Variables may be used as variable properties in variable property boxes (see Variable Properties). About Configurations PReS Workflow configuration files are defined as a set of processes, subprocesses, variables, documents and printer queues, that work together within PReS Workflow Service. PReS Workflow cannot work without a valid configuration and a PReS Workflow session running on a given computer can only use one configuration at a time.
PAGE 651

If the active watch file is currently opened, and if it includes unsaved modifications, PReS 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 652

PReS 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. Saving a configuration file never replaces the current PReS Watch service configuration. To do this, you must use the Send Configuration command. Saving a Configuration Files created and edited using PReS Workflow can be saved as PReS Workflow configuration files anywhere on your computer or even a network location.
PAGE 653

1. Open the configuration you want to use as PReS Workflow’s new configuration. 2. Edit the configuration, if required. 3. When the configuration is ready to be used, from the PReS Workflow button, choose Send Configuration, then Send Local. To send a PReS Workflow Configuration to a remote server: 1. Open the configuration you want to use as PReS Workflow’s new configuration. 2. Edit the configuration, if required. 3.
PAGE 654

l Right-click on PReS Workflow Configuration Program button in your task bar, and select Close. If the default configuration file is currently opened, and if it includes unsaved modifications, the PReS Workflow Configuration program asks you whether to send the configuration to the PReS Workflow service before exiting. Select the Always send without prompting for confirmation option to automatically send the edited version of the configuration before exiting.
PAGE 655

Local System Account, which is granted access to all the system’s resources. All input and output services used by PReS Workflow run under the same account. For more information on services and system permissions, refer to Windows documentation. For more information on how to configure the account used by the services, See "Workflow Services" on page 697. Available Input services Input services are used to pull in data files.
PAGE 656

l l l l PReS Fax: Outputs jobs as faxes. You use PReS Fax as an interface to WinFax PRO or Windows Fax, to send faxes you create from documents. You can install multiple instances of the PReS Fax service on your network, and have PReS Workflowsend jobs to one or more of these instances. Each instance of PReS Fax can generate faxes and dispatch them from the host on which it runs, using a local faxing program, such as WinFax PRO, Captaris RightFax or Windows Fax. See About Fax.
PAGE 657

processes, but it keeps on performing tasks until all the files which are currently under process have been completely processed. To pause your PReS Workflow Tools service via the PReS Workflow Configuration program: 1. Click Tools in the PReS Workflow Ribbon. 2. Click Pause in the Services Status group. The PReS Workflow service temporarily stops performing jobs.
PAGE 658

The Interface This chapter centers on the PReS Workflow Configuration program, which you use to create and edit your configurations. The basic user interface elements are as follows: 1. The PReS Workflow button. See "PReS Workflow Button" on page 667. 2. The Quick Access Toolbar. See " The Quick Access Toolbar" on page 778. 3. The Ribbon Tabs. See "The PReS Workflow Ribbon" on page 779.
PAGE 659

4. A Group within the Ribbon 5. The Process area. See " The Process Area" on page 767. 6. A specific link (aka a "component", "button" or "link"). 7. The Dockable panels including "The Plug-in Bar" on page 723, " The Object Inspector Pane" on page 722 and "The Debug Information Pane" on page 720. 8. The status bar. This displays your current software version and status of the PReS Service. 9. The Configuration Components pane. See "The Configuration Components Pane" on page 669. 10. The Messages Pane.
PAGE 660

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 661

Show or Hide Areas of the Program Window You can choose to hide or display any of the customizable areas in PReS 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 PReS 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). A dim (blue) button means the area is hidden.
PAGE 662

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 663

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 664

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 665

Page 665
PAGE 666

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 667

To change the language used by the PReS Workflow Configuration program: 1. Click the PReS Workflow button, then click Select Language. The Select Language dialog box appears. This box lists all the languages that can be used by PReS 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 668

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

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 670

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 671

l PPS/PSM Documents: Displays a list of PReS Connect and PrintShop Mail Design document that have been imported into PReS 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 672

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 673

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 674

The Time Grid The PReS 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 675

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 676

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 677

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 729 screen.
PAGE 678

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 679

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 680

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 681

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 682

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 683

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 558, "Create Web Content" on page 583 and "Create Print Content" on page 578.
PAGE 684

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. A maximum of 30 of each instance of a resource is kept (meaning if you have 10 different templates, a maximum of 300 files will be present in the archive\template folder).
PAGE 685

Document Properties Options Identification Tab The information here is read-only and gives you information on the document. 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 PReS Workflow Configuration. It may have a PTK extension (if it has been sent to PReS Workflow from PlanetPress Design), or a PS extension (if it is printer-resident).
PAGE 686

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 687

Data Files When sending a PlanetPress Design Document from PlanetPress Design to PReS Workflow, all data files used in the document are automatically sent to PReS 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. 3.
PAGE 688

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

To add a resident document in the Configuration Components pane: 1. In the PReS 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 PReS Workflow will not be able to use it on the printer or remote PReS Workflow server. 3. Click OK.
PAGE 690

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

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 692

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 693

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 PReS Workflow. You can, on the other hand, change the name of printerresident documents. Note Names cannot begin with a number. They can only contain the following ASCII characters: underscore, upper and lower case letters of the alphabet, all digits 0 through 9.
PAGE 694

To reorder selected objects in the Configuration Components pane: 1. Click an object or group. 2. In the PReS 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 695

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 696

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 697

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 698

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

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 PReS Workflow automatically. 3. Click OK.
PAGE 700

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 PReS 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 701

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 702

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 703

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 704

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 705

jobs to the server. Technical Messenger communications (between different part of the PReS Workflow) is limited to within the same Class C subnet. This means that PReS Workflow on 192.168.1.23 cannot send a job to a PReS Image on 192.168.100.54. This limitation has been removed in PReS 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 706

Page 706
PAGE 707

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 708

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 709

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 710

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. Enter the following information under the Username column for the new entry that was created: l l User name: An alphanumerical user name for the user. Password: A password to protect the user.
PAGE 711

l 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. When this option is selected, the Permissions section is grayed out an all options are selected in it. Disabled: Has access to nothing. The result is the same as not having this user defined at all, but has the advantage that a disabled user can be reactivated with a simple click. 3.
PAGE 712

Technical The PDF Viewer is not currently standalone and cannot be used to display PDFs outside of PReS Workflow.
PAGE 713

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 714

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 715

To open the PReS Workflow Service Console via the PReS Workflow Configuration program: l Choose Tools | Service Console. A) The PReS Workflow services monitored by the PReS Workflow Service Console. B) The run-time information provided by the console. Note The log window only displays the 1000 most recent lines. Older lines are hidden as new ones appear to replace them. To view the log messages generated by a service: l Click the service in question in Services pane, on the left hand side.
PAGE 716

To clear the Messages area of the PReS 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 PReS 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 717

l Open PReS 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. Toolbar Buttons l Group section l l l l ID is a unique number that identifies a Key Set in the Data repository.
PAGE 718

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. Management section l l l l l Delete KeySet: Click to delete the currently selected KeySet in the Group. Warning: This action cannot be undone.
PAGE 719

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. Navigating with the Keyboard Though of course the mouse is the easiest way to navigate through the Data Repository, the keyboard can be used also.
PAGE 720

To add images to the virtual drive, use either of the following methods: l Send a single resource file to the printer: see "Download to Printer" on page 314. l Send one or more images to the printer: see "Send Images to Printer" on page 339. l Use PlanetPress Design: see the PlanetPress Design User Guide. To delete images from your virtual drive: 1. In the PReS Workflow Ribbon, Go to the Tools tab, then click on Virtual Drive Manager. The Virtual Drive Manager dialog box is displayed.
PAGE 721

Click in the box on the left to edit the expression and add any variable properties or static text you want, and click outside of the box to save it. Once saved, the Value column displays the expression's result. The contextual (right-click) menu displays the following items when at least one expression is present: l Copy Value (only when right-clicking an existing expression): Places the resulting value of the expression in your clipboard. l Revalue all: Refreshes the value of all the expressions.
PAGE 722

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. Press CTRL+C on your keyboard or right-click on the line and select Copy to place a copy of the line in the clipboard.
PAGE 723

Note If you select multiple objects in the Configuration Components window, some properties that are shared between those objects can be changed in the Object Inspector. Changing a property changes it for all the selected objects. The Object Inspector also displays information about the Job File while it is being processed in Debug mode. Seeing how files change as they travel down a process can provide valuable debugging information.
PAGE 724

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 PReS 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 725

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 726

l l "OL Connect preferences" on page 742 l "PDF Text Extraction Tolerance Factors" on page 744 Plug-in: l "General and logging preferences" on page 745 l "Messenger plugin preferences" on page 746 l "HTTP Server Input 1 plugin preferences" on page 747 l "HTTP Server Input 2 plugin preferences" on page 750 l "LPD Input plugin preferences" on page 751 l "Serial Input plugin preferences" on page 752 l SMTP Input l "Telnet Input plugin preferences" on page 753 l "PReS Fax plugin preference
PAGE 727

General appearance preferences Ribbon Color Scheme l Blue: Sets the general interface color scheme to a blue color. l Silver: Sets the general interface color scheme to a silver (gray) color. l Black: Sets the general interface color scheme to a black (coal) color. Colors l l l l Variable properties: Select a color for the labels identifying variable property boxes. Debug: Select the color applied to the PReS Workflow Process area background when in debug mode.
PAGE 728

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. Clear the selection to display properties in alphabetical order. When the Object Inspector displays properties in groups, it displays an expand/collapse button to the left of the name of the group for expanding or collapsing the group.
PAGE 729

l l l Show Grid Lines: Check to choose whether or not to display grid lines between each object in the Configuration Components pane. Hot track: Check to choose whether or not to display the object in the Configuration Components pane under the mouse cursor as being underlined. Reset To Defaults button: Click to reset all the Configuration Components pane appearance options to their default values.
PAGE 730

Preferences l l l l l l l l l l l l User mismatch: Select to have PReS 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 PReS Workflow prompt for confirmation when deleting a document.
PAGE 731

l l l l l l l l l l l No registry: Select to have PReS Workflow notify you if it cannot find an install location in the registry. In such cases, the path of the currently running software executable is used as the install path. PReS Watch 3 documents and job commands transfer: Select to have PReS Workflow display a prompt when you import a configuration from PReS Watch 3 that allows you to transfer documents and job commands.
PAGE 732

l l l l Prompt on Form Refresh: Select to have PReS Workflow prompt for confirmation when recompiling the PostScript (PSx) version of a PReS Connect Document. Refreshing PReS Connect Documents that are currently in use can lead to unexpected results. Prompt on Saving with Unknown Task: Select to have PReS Workflow prompt for confirmation when saving a configuration file or sending the configuration to the PReS Watch service, when any process contains Unknown Tasks.
PAGE 733

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 PReS Workflow requires to access NetWare resources. When you select this option, you must enter values in the Username and Password fields, and in the NDS options group (these properties are optional) below to properly log in to NetWare. l l l l l Username: Enter your NetWare user name.
PAGE 734

or Context information may cause PReS Workflow and its services to crash. PlanetPress Capture preferences PlanetPress Capture behavior settings lets you change the PlanetPress Capture options relative to your Workflow server. This is where you set up your server and database and where you manage pens, documents and licenses. The available PlanetPress Capture user options are: l Mode: Choose between Server and Client mode. Client and Server mode are used for multi-server architectures.
PAGE 735

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. In client mode, no pen license information is stored locally. All pens are therefore validated against the server specified in the Host address field displayed when the Client option is selected.
PAGE 736

l l l l l l 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. Template Name: The name of the document, corresponding to the name entered in the PlanetPress Design document properties. Pattern ID: Search using the pattern's identification number. This can be printed on each document next to the Anoto Statement (see PlanetPress Design User Guide).
PAGE 737

l 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. l Select none: Click to deselect all of the documents in the list. l l View documents: Click to view all the documents along with any ink already present on them. Each PDF is opened, in sequence, in the "PDF Viewer. Close documents: Click to close the document and release the pattern it uses.
PAGE 738

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 739

l l l l l It is recommended to create an IT process that backs up the database regularly. The recommended ideal setup is a dedicated SQL Server PC, accessed by PReS Workflow through an ODBC connection on the local network. Database file (mdb) must be local to the PReS Workflow computer. It cannot be located on a network drive or another server. 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.
PAGE 740

PlanetPress Capture Pen Management Tool The Pen Management Tool screen is used to manage the pens that are registered in the PlanetPress Capture Database. The number of Anoto Digital Pens you may register on this screen depends on the licenses available within your PlanetPress Capture License. Options and Controls Top Toolbar l l l Read PGC File: Click to display a File Open dialog. Browse to an existing PGC file, and open it.
PAGE 741

To register a new pen manually 1. Click on the icon 2. Enter the Pen ID (located on the pen after the word "Serial: ") 3. If necessary, enter an optional pattern sequence and User ID (identifier of who will use the pen). To register a pen using the registration pattern 1. Click on the Print pen activation file button in the top toolbar of this dialog. 2. Use the Windows Print dialog to print to the desired printer. 3. Write or make a line on the printed pattern. 4. Dock the pen in its cradle. 5.
PAGE 742

of pens that can be registered in the Capture Database. When the number of pens have been reached, new pens can no longer be registered. If no pen pack is available, PlanetPress Capture functions in Demo Mode. In Demo mode, only one (1) pen can be registered in the pen management window. Also, the "Capture Fields Generator" on page 477 will be unable to produce more than 8 documents with a pattern instead of the full 20,000 patterns.
PAGE 743

Warning OL Connect User Options are not applied immediately. In order for these changes to be applied, the Workflow Configuration must be submitted to the Workflow Service. Otherwise, these options will not be accounted for in Debug mode. The available OL Connect user options define the default behavior of OL Connect tasks' OL Connect Proxy tab.
PAGE 744

PDF Text Extraction Tolerance Factors When extracting text from a PDF (for example, through a data selection), a lot more happens in the background than what can be seen on the surface. Reading a PDF file for text will generally return text fragments, separated by a certain amount of space. Sometimes the text will be shifted up or down, spacing will be different, etc. In some cases, every letter is considered to be a different fragment.
PAGE 745

character's height) will be accepted and the more vertical distance between fragments are accepted. Exponents, for example, are higher and lower. When this value is 0, no vertical shift is accepted between two fragments. When the value is 1, the second text fragment can be shifted by as much as the height of the first fragment. Accepted values range from 0 to 1. The default value is 0.15, recommended values are between 0.00 and 0.50.
PAGE 746

Changing the plugin preferences also affects the logs displayed in the PReS Workflow Service Console. l Log level group l l l l l l l Startup and shutdown: Select to only track when the PReS Workflow service is started and stopped. Task failure: Select to only track when tasks in the processes running in a PReS Workflow configuration fail. Task success and failure with details: Select to track when the tasks in processes running in PReS Workflow succeed and fail, with details.
PAGE 747

l l Close inactive instances after: If you want the PReS Workflow Messenger to close inactive instances of the Alambic after a given number of minutes, enter a value in this box. Enter a value of ”0” if you do not want the Messenger to terminate idle instances of the Alambic. Logging options group l l Delete log files after: Enter the number of days after which to delete the Messenger service logs.
PAGE 748

l l l l l Root certificate: Enter the absolute path to the Root Certificate. The file generally ends with a .crt extension and is obtained from a Certificate Provider such as Thawte or Verisign. If the Root Certificate and Certificate file are identical, this is considered a self-signed certificate, which is considered unsecured by most browsers. Certificate: Enter the absolute path to the site Certificate. The file generally ends with a .
PAGE 749

l l Use PHP Arrays: Select to process incoming POST request with input arrays correctly. In the source HTML, input elements with names such as name="chat[input][name]" or name="items[][partnum]" will be correctly split as a single XML node along with each part of the array as children. Omit attachments as CDATA node in the XML envelope: Select to remove any attachments from the actual XML data file. Generally the attachments are both saved on disk and included within the XML envelope.
PAGE 750

dent 361 341 dent 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 751

l Capture OnTheGo group l l Authentication Key: Enter the authentication key for the COTG repository. This key can be found in the Settings section of the COTG Web Administration Panel. Cross-Origin Resource Sharing (CORS) l Allowed Origins: Enter an origin (everything in a URL before the path, e.g. http://www.example.com). The Workflow server will add this value to the AccessControl-Allow-Origin header, which signals to the browser that it is allowed to make the request.
PAGE 752

l l l Strict RFC 1179 control file: Select to disable control file extensions the LPD service implements for some flavors of UNIX and LPR. This enforces the basic Line Printer Daemon protocol. Enable BSD compatibility mode: Select to have the LPD service emulate a BSD UNIX server. Although RFC 1179 is supposed to describe the BSD LPD/LPR protocol, and the LPD input in PReS Workflow is RFC1179-compliant, there are some incompatibilities between the RFC and the BSD implementation.
PAGE 753

bits is required. If an eighth bit is used, it must have a value of 0. If the data is based on the extended ASCII character set, eight bits must be used. l l l l l Parity: Select the type of parity used for error detection. The parity transfers through the serial connection as a single bit. It is used to verify that each set of data bits transfers correctly. It is then stripped away before the data file passes through the rest of the PReS Workflow process.
PAGE 754

by a line return), either a direct string (such as %%EOJOB) or an ASCII character (\001). For a list of ASCII characters, see http://www.asciitable.com/. PReS Fax plugin preferences PReS Workflow Fax plugin preferences control certain functions of the PReS Fax service, which in turn has a direct impact on all PReS Workflow Fax output tasks performed on a given computer.
PAGE 755

PReS Fax to removing any spaces or parentheses that appear in the data selection, and sending the result to WinFax PRO. WinFax PRO dials the result exactly as it receives it from PReS Fax. Note WinFax Pro scales fax pages with the following minimum settings: - Raster width: 1728 dpi - Raster height: 2158 dpi - Raster resolution: 196 dpi l Windows Fax Service l l l l Report Failures: Select to have PReS Fax generate a report whenever the maximum number of retries for a single fax is exceeded.
PAGE 756

l l Dialing options button: Click to set the appropriate options as required. Since these options are specific to the faxing program, refer to the faxing program’s documentation for more information. Captaris RightFax l l l l l Report Failures: Select to have PReS 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.
PAGE 757

l l l l Activation: Click to enter activation codes for the PReS Image service installed on the same computer as PReS Workflow. If you have already activated the PReS Image service from its Control Panel applet, this is reflected when you open the Activation dialog box by clicking this button. Check for updates: Click to access the Objectif Lune website to search for updates to PReS Image. You are guided through the updating process with the PReS Workflow Update Service wizard.
PAGE 758

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

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 PReS Image cannot be resolved. Delete log after: Enter the number of days to wait before deleting the log of the generated PReS Image output. Each log file covers a single 24-hour period and is kept in the Log folder, which is located in the PReS Workflow installation folder.
PAGE 760

l l l l 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. Use default database: Select to use the default database associated with your user profile on that SQL Server or Oracle database. Clear to enter the name of the database in the box that appears. Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database.
PAGE 761

l l l l Email address: Enter the email address of the user sending the error messages to the administrators. Reply address: Enter the reply address that recipients use to reply to the error messages. Outgoing mail (SMTP): Enter the IP address of the server that PReS Workflow uses to send the emails via SMTP. Server requires authentication: Select if the outgoing server used to send the emails via SMTP requires authentication.
PAGE 762

l l l Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service. Error handling group l l l l No source port range restriction: Select to remove any restrictions on the port PReS 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. Max.
PAGE 763

Note It is also mandatory to send your configuration to your PReS Workflow service since the PrintShop Web credentials are included in the *.cfg file (See "Send your Configuration" on page 17), which is updated every time the configuration is sent to the service via the Send Configuration button. Editor Options The Script Editor is used to edit scripts used in Run Script and the XSLT Editor is used to edit scripts used in Open XSLT action tasks. Most of the options listed below are valid for both editors.
PAGE 764

indentation level to enter the body of the for loop, then press BACKSPACE to enter the end for statement. You must select Auto indent mode to use this option. l l l l l l l l l Cursor through tabs: Select to move one by one through the spaces of tabs using the left or right arrow keys. Clear to have the arrow keys treat the tab as a single character. You must select Use tab character to use this option.
PAGE 765

l l l l l l Enable search highlight: Select to highlight the search term match found in the code when you perform a search. Clear to prevent the highlighting. In both cases, the pointer appears after the last character of the search term match. Double click line: Select to highlight the complete line of code when you doubleclick that line. Clear to highlight only the word under the pointer. Find text at cursor: Use to set the behavior of the Find dialog box.
PAGE 766

l Margin and Gutter Group l l l l l l l Right margin: Select to display a vertical gray bar as a right margin indicator. Use the Right margin position drop-down list to set the position of this indicator. This indicator is an on-screen visual reference only. It does not print, and does not enforce word wrap on lines that exceed the number of characters set for it.
PAGE 767

attributes. Each element recognized for each scripting language, for example, a URL in a JavaScript script, is displayed with the properties you set. l l l Foreground: Select the color that the element highlighted in the Element list box is displayed with in the Script Editor. Background: Select the background color that the element highlighted in the Element list box is displayed with in the Script Editor. The color is used to highlight the element as if it was selected with the cursor.
PAGE 768

l " Cutting, Copying and Pasting Tasks and Branches" on page 772 l " Moving a Task or Branch Using Drag-and-Drop" on page 774 l " Ignoring Tasks and Branches" on page 775 l " Resize Rows and Columns of the Process Area" on page 776 l " Selecting Documents in Tasks Links" on page 776 l " Highlight a Task or Branch" on page 777 l " Undo a Command" on page 778 l " Redo a Command" on page 778 Zoom In or Out within Process Area You can do a zoom out in the PReS Workflow Process area to see more t
PAGE 769

5. When you drop the task in the desired location, a dialog box containing the available task properties is displayed. 6. Set the task properties as required and click OK to close the dialog box. There are a few things to keep in mind when dropping tasks: l l You can insert input tasks anywhere in the process except in output task locations. When you add an output task, a new branch leading to that new task is added above the selected task or branch, except when replacing an existing output task.
PAGE 770

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. To replace an existing task with a new task, see Adding Tasks. To replace an existing task with another existing task or its properties, see Cutting, Copying and Pasting Tasks and Branches.
PAGE 771

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. This replaces the task with an unknown task (see Unknown Tasks) To delete the path below a branch crossing (instead of the path to the right of the branch): l Press Shift+CTRL+Delete.
PAGE 772

l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
PAGE 773

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

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. Select the task or branch where you want to paste the properties 3. From the Home tab in the Ribbon, choose Paste Properties (or right-click and select Paste Properties from the drop-down menu). Note You can only paste the properties of an input task on the initial input task of your process. Similarly you can only paste the properties of an output task on another output task.
PAGE 775

The same will happen if you drag an output task over an unknown output task. Note that it is impossible to drag-and-drop any task over a configured initial input or output task. To move a task or branch using drag and drop: 1. In PReS Workflow Process area, click the icon of the task or branch you want to move. 2. While holding down the mouse button, drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item.
PAGE 776

l When a branch is disabled, the whole branch including the tasks inside that branch are ignored and not executed. In the case of conditional branches, this means that the tasks appearing on the True side are not executed. A task, branch or condition that was previously disabled out can be re-enabled at any time. To disable or enable a task or branch: 1. In the PReS Workflow Process area, click the icon of a task or branch. 2. From the Debug tab in the Ribbon, click Ignore.
PAGE 777

l l You can choose a specific document from the list of installed documents. The document is merged with the data to generate output. You can choose a variable document (see below) Variable Document Name The Variable Document feature is used to dynamically determine which document is merged with the data in your output. The document name can come from any of the variable properties (see Variable Properties). Note If the data contains an extension, it will be replaced by .ptk.
PAGE 778

Undo a Command The undo command lets you undo most commands performed with the PReS Workflow Configuration program. To undo a command: l From the Quick Access Toolbar, choose Undo. Redo a Command The Redo command can be used to redo commands that were just undone using the Undo command. For example, if you used the Undo command three times in a row and immediately thereafter decided to redo those commands, you could use the Redo command three times in a row to redo those commands.
PAGE 779

To remove a button from the Quick Access Toolbar: 1. Locate the button you want to remove in the Quick Access Toolbar. 2. Right-click on the button. 3. Select Remove From Quick Access toolbar. To move the Quick Access Toolbar below or above the Ribbon: 1. Right-click on the Quick Access Toolbar, or click on the downwards arrow at the rightmost end of the Quick Access Toolbar. 2. Click on Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon, depending on where you want it.
PAGE 780

l l l l l l The Processes group contains workflow controls, allowing to insert new processes of any type as well as controls to converts, activate or branches processes. The Variables group contains two controls to insert either a Global variables available throughout the entire configuration, or Local variables available to the current process only. The Documents group contains the document controls, used to insert, refresh, update or delete documents and document instances.
PAGE 781

l l The Debug Messages group contains two controls to either clear or save the contents of the Messages pane. The Tools tab includes the Managers, Services and Test Page groups. l The Managers group contains: l l l l l l l l The Access Manager control loads the Access Manager, allowing to grant/remove permissions to hosts. The Check for updates control, used to update the current PReS Workflow version. The Launch Upgrade Wizard control, used when migrating from a previous PReS Workflow version.
PAGE 782

l l The Text Test Page control allows to print a raw text test page for the selected Printer Queue. Note that if no printer queue is selected in the Configuration Components pane, the control is disabled. The Help tab includes the Help, Activation and License groups. l l l The Help group contains the User Guide, the Reference Guide and the About controls, used to access online documentation and version information.
PAGE 783

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

Copyright Information Copyright © 1994-2019 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 785

Legal Notices and Acknowledgements PReS Workflow, Copyright © 2019, 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 786

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 787

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 788

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 789

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 790

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.