2020.2

Manuals Brands Objectif Lune Manuals Applications PRes Workflow

Table Of Contents

Summary of content (906 pages)

PAGE 1
PAGE 2
PAGE 3

User Guide Version 2020.2 Last Revision: 2021-09-29 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-2021. 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 2020.
PAGE 5

About Workflow Configurations Creating a new configuration Open a PReS Workflow configuration file Saving and sending a Workflow Configuration Exit PReS Workflow Configuration program Workflow Configuration resource files Connect resources PlanetPress Design documents PrintShop Mail documents About data About documents and variable data Job file Job file names and output file names Data selections About data emulation Sample Data Metadata Working with JSON Data Repository Structure Accessing the Data Reposi
PAGE 6

Send to Folder printer queue Load balancing Associating PlanetPress Design documents and PReS printer queues Triggers Objectif Lune Printer Driver (PS) About processes and subprocesses Processes Startup processes Subprocesses Creating a process Importing processes Activating or deactivating a process Process properties About branches and conditions Converting a branch to a subprocess Running a process on desktop Using Scripts Run Script task APIs The Script Editor and XSLT Editor SOAP Server API Reference T
PAGE 7

Copy() Cut() DatapageCount() Delete() DocumentCount() FieldByIndex(Integer Index) FieldByName(const String Name) FieldByNameIndex(const String Name, Integer Index) IndexInDocument() IndexInGroup() IndexInJob() Item(Integer Index) PageCount() Paste() PasteAt(Integer Index) Select(TSelectWhat SelectWhat) SelectedDatapageCount() SelectedDocumentCount() SelectedIndexInDocument() SelectedIndexInGroup() SelectedIndexInJob() SelectedPageCount() Sort(const String Name, optional TSortFlags Flags, optional const Stri
PAGE 8

Parameters Returns Exceptions Parameters Returns Exceptions AlambicEdit API reference Stopping execution Special workflow types HTTP Server workflow PDF Workflow PlanetPress Capture Workflow Workflow processes in a Connect Send solution About Tasks Adding tasks Editing a task Task properties Masks Selecting a resource file in task properties Input tasks Action tasks Data splitters Process logic tasks Connector tasks PlanetPress Capture Metadata tasks OL Connect Send OL Connect tasks Output tasks Document Ma
PAGE 9

Unknown tasks About variables Job Info variables System variables Local variables Global variables Variable task properties Workflow add-ons PlanetPress Capture Capture OnTheGo (COTG) About PReS Fax About PReS Image OL Connect Send ZUGFeRD About related programs and services Available Input services Available Output services Start and stop PReS Workflow Service Users and configurations Workflow Services Preferences Other preferences and settings General appearance preferences Object Inspector appearance pre
PAGE 10

PlanetPress Capture ODBC Settings PlanetPress Capture Pen Management Tool PlanetPress Capture License Management OL Connect preferences PDF text extraction tolerance factors General and logging preferences Messenger plugin preferences Preferences HTTP Server Input plugin preferences 1 Preferences HTTP Server Input plugin preferences 2 LPD Input plugin preferences Preferences NodeJS Server Input plugin preferences 1 NodeJS Server Input plugin preferences 2 NodeJS Server Input plugin preferences 3 Testing the
PAGE 11

Combine and attach areas Resize the program window areas Change the Interface language PReS Workflow Button Options Configuration Components pane Components Area Sections PlanetPress Design document properties Moving and copying configuration components Renaming objects in the Configuration Components Pane Reordering objects in the Configuration Components pane Grouping Configuration Components Expanding and collapsing categories and groups in the Configuration Components pane Deleting something from the Co
PAGE 12

Settings and customization The Process area Cutting, copying and pasting tasks and branches Highlight a task or branch Disabling tasks and branches Moving a task or branch using drag-and-drop Redo a command Removing tasks or branches Replacing tasks, conditions or branches Resize the rows and columns of the Process area Collapse and expand branches and conditions Undo a command Zoom in or out within the Process Area The Quick Access Toolbar Adding buttons Removing buttons Moving the toolbar The PReS Workflo
PAGE 13

Welcome to PReS Workflow 2020.2 This PDF documentation covers version 2020.2. 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 14

Warning Information that is potentially critical to using PReS Workflow.
PAGE 15

Installation and setup The installation procedure for Workflow is described in the topic Installing Workflow. The following topics describe the different considerations that are important in regards to the installation and use of PReS Workflow. l "System requirements" below l "Environment considerations" on page 18 l "Setting up the working environment" on page 21 l "Known Issues" on page 25 System requirements These are the recommended system requirements for PReS Workflow 2020.2.
PAGE 16

Note The NodeJS Server installed with Workflow is not supported in an x86 environment. Virtual environments PReS Workflow supports the following virtual environments: l l VMWare Environments. This includes VMWare Player, VMWare Workstation as well as VMWare ESX Server. VMWare VMotion. This means the virtual machine hosting PReS Workflow can be automatically moved from one ESX server to another in a clustered installation. l Microsoft Hyper-V/Azure infrastructure environments.
PAGE 17

l RAM: 6GB l Disk Space:At least 10GB*1 *1: Requirements will depend upon the amount of data you process through PReS Workflow. For instance, a PostScript file containing several thousands of documents could easily take up several GBs. Recommended hardware requirements Due to its versatility, OL Connect is used for a wide variety of applications. Consequently, it is difficult to determine which hardware configuration will produce the best results for any given implementation.
PAGE 18

l l l l The Connect Workflow module requires less RAM but fast hard drive access. It also benefits from fast multi-core CPUs, in order to run processes in parallel. The Connect Server module requires more RAM and benefits from fast multi-core CPUs. Disk access speed is less of a concern. The Connect Designer module requires more RAM and fast disk access to provide a responsive user-experience.
PAGE 19

l l VMWare Environments. This includes VMWare Player, VMWare Workstation as well as VMWare ESX Server. VMWare VMotion. This means the virtual machine hosting PReS Workflow can be automatically moved from one ESX server to another in a clustered installation. l Microsoft Hyper-V/Azure infrastructure environments. l Amazon Web Services (AWS) PReS Workflow is not officially supported on any other virtual machines such as Virtual PC, Parallels, Bochs, Xen, etc.
PAGE 20

Warning Disabling any antivirus scanning permanently on any folder or program is not recommended, and Objectif Lune cannot be held reliable for any consequence of disabling your antivirus or whitelisting the folders or executables listed here, or any other change in your antivirus protection setup! l On Windows 7/2008 and later: l l l l C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\ C:\Users\[user]\AppData\Local\Temp\ (where [user] is the user under which Workflow is configured) C:\Users\[user]\C
PAGE 21

l TelnetService.exe l ppNode.exe l PPFaxService.exe l PPImageService.exe l MessengerService.exe Backup software For similar reasons, it is important to know that backup software can also access files while copying them to a remote backup location, so you should make sure that no PReS Workflow process is working during your backups. Microsoft Office compatibility The Microsoft Office 2010 line of products, other than Pro and Enterprise, has not been certified for use with PReS Workflow.
PAGE 22

implications in regards to PReS Workflow. To change the service log on information, see "Workflow Services" on page 763. Local and network rights Programs, such as PReS Workflow and all its services, must identify themselves in order to be granted permission to perform operations on the computer on which they run as well as on other computers accessible via a network connection. On a given workstation, you can configure your PReS Workflow to use either the local system account or any specific user account.
PAGE 23

user, you will not have access to this mapped drive while running as a service unless you log off, and then have PReS Workflow Tools map the drive using a Run Script action inside a Startup Process. In addition, the use of network shared drives can cause issues when attempting to capture files from those locations since the notification process for folder changes on network shares may be different than that of local folders.
PAGE 24

Component Protocol Local Port Remote Port FTP Input TCP Default1 21 Telnet Input TCP Default1 9100 (configurable) FTP Output TCP Default1 21 Email Output (SMTP mode) TCP Default1 25 Email Output (Outlook mode) TCP See Email Input (Outlook mode) See Email Input (Outlook mode) Send to Folder Windows Queue Output TCP Default1 Standard Windows file and printer sharing ports2: l l 137, 138 and/or 139 (NetBIOS over TCP/IP (NetBT)) 445 (SMB Over TCP/IP) LPR Output TCP Default or 721
PAGE 25

SMB over TCP/IP. The operating system may use additional ports. Refer to the Windows documentation for further information. 3 If the “No source port range restriction” option is checked (recommended), see footnote 1. If the option is unchecked, the local port will be chosen from a range going from 721 to 731. 4 Contact your DBMS vendor to determine which ports are used by the ODBC driver for accessing a network database.
PAGE 26

l l l Rename the processes so that they are no longer subsets of each other. Add a Polling interval to each process. This deactivates the trigger processes but adds a delay in the processing of requests. Re-order the processes, e.g. declare "ActionA" before "Action". This issue will be fixed in a later release. Some plugins fail when communication to Connect Server is not secure With OL Connect version 2020.
PAGE 27

Workarounds l l For the Lookup in Microsoft Excel Documents plugin (found in the Connectors tab of the plugin bar): Open the original .xls file and save it with the .xlsx format. That will force the Excel Lookup plugin to switch drivers. For the Database Query plugin (found in the Actions tab of the plugin bar) and when using Excel/Access in PlanetPress Design: Change the ODBC driver used for Excel files from JET to ACE (change the Data Source).
PAGE 28

Other known issues l l l l l l l l l l l Custom plugins cannot be permanently removed from the Plug-In Bar through the Workflow tool's user interface. Anoto Pen Director 2.8 is not supported on Windows Server 2012 and Windows 10. 22356: Using the PT-PT setting to perform ICR on AlphaNumeric fields may not work properly. If you encounter the issue, use the PT-BR setting instead, or use another PlanetPess Field in your document design.
PAGE 29

l l l l l After the initial installation, the PReS Workflow Configuration tool may display an error message the first time you launch it if you had already sent a PReS Workflow Document to it. You can safely ignore this message, you will simply have to manually start the PlanetPress Messenger service from the Workflow console for this one time only. To avoid getting the error altogether, make sure you launch the PReS Workflow tool once before sending any document to it.
PAGE 30

that isn't displayed. The only way to resolve this situation is to kill the PReS Workflow service. To avoid these types of issues from occurring, it is imperative that the configuration for the WordToPDF task be tested thoroughly in Debug mode prior to sending it into production. In particular, the connection to the database must be validated. l l l l l The WordToPDF task requires the default system printer to be set to a queue that uses the PlanetPress printer driver.
PAGE 31

Basics PReS Workflow is a tool to automate the processing, distribution and printing of your business documents. Once installed on the server, it can be set up to automate all tasks related to document processing (see "Setting up the working environment" on page 21). When you're all set up, you can start using the Workflow Configuration tool, assuming that you have already done research on the processes that need to be automated. Working with Workflow implies the following basic steps: 1.
PAGE 32

The product-specific files need to be sent to, or imported into, Workflow before they can be used in conjunction with a task (see "Workflow Configuration resource files" on page 39). They become visible in the "Configuration Components pane" on page 828.
PAGE 33

Features PReS Workflow configurations are input driven applications designed to output data in a variety of ways through diverse means to various applications and devices. PReS Workflow can 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 34

versatile automated processes to print jobs as well as generate other types of output (emails, web pages, files...). Note A PReS Workflow configuration must be composed of at least one process, but it may include as many as 512. 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 35

By default, when you create a new configuration, PReS Workflow automatically creates a process that includes a "Folder Capture" on page 322 initial input task and a "Send to Folder" on page 677 output task by default. You can then edit and save your new configuration. The default input task and output task depend on your preferences ("Default configuration behavior preferences" on page 770).
PAGE 36

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

Workflow when it is started. To change any currently active configuration, you must use the Send Configuration command. When you use the Send command, the PReS Workflow Configuration program uses the currently opened configuration (Any_name.OL-workflow) to overwrite the PReS Workflow Service's current configuration (ppwatch.cfg). 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.
PAGE 38

4. Put a checkmark next to each server where the configuration should be sent. 5. Click OK. If a server is grayed out, this may mean you do not have access to send a configuration remotely to it. For more information, please see "Access Manager" on page 841. Note If PReS Workflow service is paused when you send a new configuration, it will not stop and restart.
PAGE 39

If the default configuration does not include any active process, the PReS Workflow Configuration program asks you whether to continue. If a file different from the default configuration file is currently opened, and if it includes unsaved modifications, the PReS Workflow Configuration program asks you whether to save the configuration before exiting. Select the Always save without prompting for confirmation option to automatically save any unsaved work before exiting.
PAGE 40

them: 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). Sample Data File(s): Displays a list of sample files that are included in the data mapping configuration. (See also: "Sample Data" on page 70.) Tip Double-click on a sample data file to use it as a sample data file for the active process.
PAGE 41

Importing Connect resource files Connect resource files are added by using the Send to Workflow option from the PReS Connect Designer's File menu; see Sending files to Workflow in Connect's Online Help. They can also be imported into PReS Workflow as follows: 1. Click the PReS Workflow button. 2. Choose Import, then Import Connect Content. The Import dialog box appears. 3. In the File type box, select the desired file type. 4. Navigate to the document you want to import, select it and click Open.
PAGE 42

Note Package files are not saved anywhere. The individual resources contained within the package are extracted and placed in the folders noted above. Tip To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. 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
PAGE 43

You can drag-and-drop a resource on a process to add the appropriate task. When dropped on a process: l A data mapping configuration adds an "Execute Data Mapping" on page 627 task. If you agree to use the first sample file in the data mapping configuration as the process's sample data file, the process's emulation will be changed accordingly. l A Job Creation Preset creates a "Create Job" on page 604 task. l An Output Creation Preset creates a "Create Output" on page 607 task.
PAGE 44

3. Double-click on the data file to open the data selector (see "The Data Selector" on page 852). Note Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file. Clicking Cancel instead of OK after viewing will prevent this action from being taken. Saving an attached data file to disk 1. Make sure the Connect Resources section is visible by clicking the appears. 2. Expand the document by clicking the button if it button. 3.
PAGE 45

For information about the options in the selection list, see "Selecting a resource file in task properties" on page 308. Printer-centric printing PlanetPress Design lets you send documents to printers as well as to PReS Workflow servers. l l l If you send a document to printers only and not to any PReS Workflow server, you will not be able to see this document in the PReS Workflow Configuration program.
PAGE 46

1. In the PReS WorkflowConfiguration Components pane, right-click PPS/PSM Documents and choose Insert > 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 47

Design document. These data files appear under the document in the PPS/PSM Documents section of the Configuration Components. Setting an attached data file as a sample data file in a process The attached data file can be used as a sample data file in a process. This sets the emulation of the process ("About data emulation" on page 60) and makes it possible to debug it (see "Debugging your PReS Workflow process" on page 106). 1. Make sure the PPS/PSM Documents section is visible by clicking the appears. 2.
PAGE 48

Metadata When a Design document uses Metadata, it can also be attached with the document. One Metadata file is generated for each data file attached to the Design document. Metadata does not appear in the Configuration Components pane but it follows the data file and can be viewed from the Metadata tab whenever the data file is viewed through the Data Selector.
PAGE 49

l l In the Configuration Components pane, under PPS/PSM Documents, click any Design document (under PPS/PSM Documents) to display its properties in the Object Inspector. In the Configuration Components pane, under PPS/PSM Documents, double-click any Design document to display its properties in the PlanetPress Design Document Options dialog box. For a list of all properties, see "PlanetPress Design document properties" on page 831.
PAGE 50

3. Navigate to the document you want to import, select it and click Open. 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. Tip To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. For help on importing PrintShopMail Connect templates, see "Connect resources" on page 39.
PAGE 51

Note Null characters present in the data may not be displayed properly when using the PReS Workflow Configuration tool, and they may also be printed differently by different printers. To ensure consistency, you should consider filtering out such characters. About documents and variable data "Variable data" is data that is meant to be merged with a document or template. In PReS Connect, variable data is usually retrieved from a data file (the job file) using the OLConnect Execute Data Mapping task.
PAGE 52

It is important to note that job files may be used as a helpful debugging resource (see "Debugging and error handling" on page 98). Job file names are generated automatically and stored in the %f system variable (see "Job file names and output file names" below). Actual data and sample data The actual data is the dynamic data captured by PReS Workflow at run-time. The sample data file is a static sampling of the run-time data (see "Sample Data" on page 70).
PAGE 53

l l For the benefit of users who must identify files, be it in a folder or on a printer queue, consider using names that are as meaningful and as precise as possible. Some devices or applications may use file name extensions to know what to do with incoming files. Since variable properties can be entered in the boxes where you specify the folder and file names, you can use variables (see "About variables" on page 713), data selections (see "Data selections" below) and static text.
PAGE 54

open the Data Selector (see "The Data Selector" on page 852) or Get Repository Location to open the Data Repository Manager (see "Data Repository Manager" on page 849). Note The Get (...) Value options will also open the Data Selector or the Data Repository Manager, but once selected, the value becomes static and does not change between each data page and job file. After opening a sample of the data (see "Choosing a sample data file" on page 71) and/or Metadata, you can easily make a selection.
PAGE 55

Text-based data selections Text-based selections are used for text data files such as Line Printer, ASCII and Channel Skip emulations. The selection refers to a rectangular selection that may contain multiple lines, rows, columns on a given page. Syntax @(page number, from line, to line, from column, to column, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l l @(): Always surrounds a data selection.
PAGE 56

l field(): Always surrounds database field selections. l Record Set Number: The data page (or "record") of the data selection. l Child Number: Line Number in the record (if there are multiple lines returned for one single record). l Field Name: The name of the field you want to retrieve. l Case Option: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent.
PAGE 57

PDF data selections These selections are used for PDF data files. The selection refers to a specific area of any given page of the PDF by using precise region coordinates (in inches). Note that when adding a metadata field, if you perform a multi-line data selection on a PDF region, only the first line of that region will be set to the metadata field.
PAGE 58

a task in the process. Open the metadata viewer and save the metadata file to use it as a metadata sample file in the Data Selector. Syntax GetMeta(Field Name [, Option Flags, Metadata Path]) Here is a breakdown of the syntax: l l GetMeta(): Always surrounds metadata selections. Field/Attribute Name: specifies the name of the field (or attribute, if the GetAttribute option flag is set) to retrieve (see "Metadata" on page 75).
PAGE 59

Name Value Behavior (defaults to Page level when path argument is empty), instead of default behavior, which recursively goes up from the Page level to the Job level. FailIfNotFound 4 Raise an error and crash the job is the specified name is not found instead of returning an empty string. SelectedNodesOnly 8 Returns values from selected nodes only (i.e. ignores unselected nodes). XML data selections XML data selections are used to retrieve an element's name, value or count from an XML file.
PAGE 60

About data emulation An emulation specifies how to interpret a data file. It is basically the method through which PReS Workflow parses and displays the data. If the emulation is set to CSV (comma separated values), for instance, commas encountered in the data will typically be considered as value separators. The way data selections are made depends on the emulation (see "Data selections" on page 53).
PAGE 61

The Hex Viewer can be useful in helping determine the control characters that appear at the head of the data stream. (To open the Hex Viewer, select Debug > View as Hex, in the menu.) Note that you cannot add characters in a CSV. Further note that if you remove characters in a CSV emulation, you should ensure that you do not inadvertently remove field or text delimiters.
PAGE 62

l "Database emulation" on page 65 l "Line printer emulation" on page 67 l "PDF emulation" on page 67 l "XML Emulation" on page 69 Emulations in PlanetPress Design The Data Selector in Workflow is essentially the same as the one used in PlanetPress Design. When you create a document in PlanetPress Design, you choose a sample data file and specify the emulation to use for the chosen data.
PAGE 63

Using an ASCII file on a printer If an ASCII file gets sent to a printer (which is possible in a PlanetPress Suite solution), you need to know if your printer supports binary mode as this is the recommended mode for ASCII emulation. On printers that support binary mode, you can switch the printer to binary mode using the printer keypad or by sending the appropriate PostScript code to the printer.
PAGE 64

Note that if a given value is used for multiple channels, the result may be different at design time, or when a PlanetPress Design document is previewed or printed. Also note that Split on FormFeed (FF) is not supported with the Channel Skip emulation in Optimized PostScript Stream mode or when printing using a Windows driver. Note Channel skip emulation is only used when merging line printer data with a PlanetPress Design document.
PAGE 65

of a record. The process reads the data stream one line at a time and puts each field of the database record on a separate line in the data page buffer, until the buffer is full. You can force a new data page for each record when you set up the emulation. Note that a double text delimiter within a field is not considered a normal character when not using the Optimized PostScript Stream option or when printing using a Windows printer driver.
PAGE 66

When generating output from the design tool (which is the Designer in Connect, or Design in PlanetPress suite) one can open the document and then use the Data Selector to select a database. By making a connection to the database, its structure can be accessed and it becomes possible to determine how data is to be pulled into the document. In a Workflow process, the database query has to be performed automatically. This can be performed by the "Database Query" on page 403 Action task.
PAGE 67

Note for PlanetPress Suite users: For information about setting up a database emulation in a Design document, please see the relevant page in the PlanetPress Design User Guide. Line printer emulation Line printer emulation tells the process to treat the input data as data destined for a line printer. In this emulation, a form feed signals the end of a data page. If no form feed occurs in the data stream, the emulation adds lines to the data page buffer until the buffer is full.
PAGE 68

PDF emulation options The PDF emulation does not have any options - that is, there is nothing to set up when opening a PDF data file. In the Preferences there is a number of options that affect how words, lines and paragraphs are detected in the PDF when creating data selections. You will find these options when you select Workflow > Preferences > PDF Text Extractor. For more information see "PDF text extraction tolerance factors" on page 785.
PAGE 69

l l l l l Lines per page: Enter the number of lines each data page contains, or use the spin buttons to increment or decrement the value. A higher value means more lines will be displayed on each data page. Note that increasing the value for this setting increases the amount of RAM used by the application and may exceed the system’s capacity. Since the Show used cells option also uses up some RAM, consider removing this option (see "Data Selector display preferences" on page 857) to reduce system load.
PAGE 70

Note Characters referenced using the ϧ syntax are limited to values ranging from 000 (�) to 256 (Ā). Note When XML data is merged with PlanetPress Design documents on a printer DOCTYPE and ENTITY tags are ignored. XML emulation options l Cache XML data: When this option is selected, PReS Workflow Server only reloads the data if the size or modified date of the XML file changes.
PAGE 71

Choosing a sample file sets the process's emulation to the chosen format (see "About data emulation" on page 60). The only other way to change a process's emulation is by inserting a "Change Emulation" on page 394 task in it. Changing the emulation is particularly important if you want to make a data selection in a file after it has been converted to another format or when the job file has changed (see "Data selections" on page 53).
PAGE 72

1. Expand the relevant resource files folder (Connect Resources or PPS/PSM Documents) by clicking the button. 2. Expand the file by clicking the button. 3. Right-click on the data file, then click Set as sample data file or simply double-click on the data file. For example, to use a sample data file included in a Connect data mapping configuration: select Connect Resources > Data Mapping Configurations > [your data mapping configuration], right-click a data file and choose Set as sample data file.
PAGE 73

l ODBC Data Source: In ODBC Data Source, click to connect to an ODBC Data Source. Use the Select Data Source dialog box that appears to select an existing Data Source or set up a new one. When you exit the Select Data Source dialog box, the Database box updates to display the connection string it uses to connect to the database, and the Table/query name box updates to reflect the tables and queries available in the selected database.
PAGE 74

Entering an SQL query 1. In the Database Connection dialog box, click Edit SQL. 2. If necessary, click Show Tables to display, in the Tables area, a list of the tables available in the database. 3. In the SQL Query Entry area, enter the SQL query. The following two sample queries both retrieve all the fields in the Orders table. The second sorts the resulting records on the Date field. SELECT * FROM [Orders] SELECT * FROM [Orders] ORDER BY [Date] 4.
PAGE 75

Metadata Metadata is a hierarchical structure describing a job. Simply put, Metadata is data about data or, in other words, information tagged to data. Depending on the type of job, the Metadata includes information about the job, the data file, items in the Connect database, a PlanetPress Design document, 'User defined information' (sometimes created by regular tasks) and in some cases page properties and page counts. Some of the Action and Output tasks produce, alter, or use the Metadata.
PAGE 76

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

Note: Metadata in OL Connect jobs In PlanetPress Suite, all levels in the Metadata hold information about an actual job. In Connect, that isn't the case. The Metadata file created and maintained by OL Connect tasks looks the same, but 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 in the Connect database and a Document has information about one record in that set.
PAGE 78

Metadata Tools in PlanetPress Design PlanetPress Suite includes a complete set of Metadata-related functionality, which can be referred to as Metadata Tools. These tools can be used to generate Metadata, retrieve or define Metadata elements, and build the Metadata structure of a PlanetPress Design document. For information about these tools see the Design user guide: PlanetPress Design 7.6 User Guide.
PAGE 79

l l l l l l "Run Script" on page 481 tasks can modify Metadata using the "Metadata API" on page 197 (see "Using Scripts" on page 141). "Create PDF" on page 398 has the option to reset your Metadata according to the new PDF file. "OL Connect tasks" on page 591 can add information, such as record IDs, a record set ID or a print job ID, to the Metadata. They put it under 'User defined information' on the Job, Group or Document level.
PAGE 80

page 665). l The "Create PDF" on page 398 task also takes the Metadata into account. Output issues caused by Metadata, and how to avoid them A Branch, Loop (the "PDF Splitter" on page 465, for instance, or the Loop task) and Condition don't reset the Metadata. This can cause confusing issues if they are used in combination with a task that takes the Metadata into account.
PAGE 81

l l l l l l Step 2 splits the PDF whenever it encounters a new Invoice Number on the Top Right corner of a page. From this point on, the rest of the process applies to each split (i.e. each invoice). Step 3 checks if the first page is a separator (presumably by looking for some kind of keyword on the page). If a separator page was found, step 4 creates Metadata for the split PDF… ...
PAGE 82

l l l The process moves back up to Task 2 in order to process the second split of the original PDF. The Metadata file still exists in the process! So far, it doesn't impact the rest of the process… but wait… Let's say in step 3 no separator page is found on page 1 of the second split PDF. Step 7 prints that second split PDF… but page 1 is unselected in the Metadata (because the Metadata was carried over from the last split!) so at the very least, you will be missing one page.
PAGE 83

Metadata Attributes reference An Attribute is a read-only, system-defined element which holds certain information about a certain node in the "Metadata" on page 75 structure. This information can be static (e.g. the size of a physical page) or evaluated on-the-fly (e.g. the number of documents in a group). Attributes are non-repetitive (i.e. name is unique) and do not persist through Metadata recreation.
PAGE 84

In the following table, the last 5 columns indicate at which level the corresponding attribute is available. This also depends on the type of job, however. Note In the Metadata file created for an OL Connect job: l l Only three levels are filled with actual data about the job: Job, Group and Document. Only Index and Count attributes are used. Attribute Description Categor y Jo b Grou p Docum ent DataEncoding (optional) Name of the character encoding.
PAGE 85

Attribute Description Categor y Jo b Grou p Docum ent Title Title of the source document. Producti on X X X Producer Name of the software that created the Metadata. Producti on X X X 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.
PAGE 86

Attribute Description Categor y point values separated by a colon indicating the media size in typographical points (ex: 612:792). g Orientation "Rotate0", "Rotate90", "Rotate180" or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape. Finishin g 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.
PAGE 87

Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e Duplex "None", "DuplexTumb le" or "DuplexNoTu mble"; indicates a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source. Finishin g X X X X X OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedependent color of the media.
PAGE 88

Attribute Description Index Categor y Jo b Index/C ount IndexInDocument Returns the Absolute index of the node within all the nodes under the parent Document. Index/C ount 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 89

Attribute Description Categor y Jo b Grou p Docum ent PageCount Index/C ount X X X SelectedCount Index/C ount X X X SelectedDocume ntCount Index/C ount X SelectedDatapag eCount Index/C ount X X SelectedPageCo unt Index/C ount X X SelectedIndexInD ocument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInG roup Returns the Absolute index of the node within all the selected nodes under the parent Group.
PAGE 90

Attribute Description Categor y ob Absolute index of the node within all the selected nodes under the parent Job. ount NumCopies Indicates how many times the job is set to execute, as set when printing using a Windows driver. Index/C ount Jo b Grou p Docum ent Datapa ge Pag e X Working with JSON In online processes, it is common to send data to and retrieve data from a server. That data is often exchanged in JSON format. JSON is short for JavaScript Object Notation.
PAGE 91

l l l l The "XML/JSON Conversion" on page 450 task converts an XML job file to JSON or a JSON job file to XML. The following OL Connect tasks accept JSON data as input: "Create Email Content" on page 600, "Create Print Content" on page 616, "Create Web Content" on page 620, "Render Email Content" on page 640, and the "Create Preview PDF" on page 611 task.
PAGE 92

"last": "Parker" } A JSON string with references to local variables and a Job Info variable (see "About variables" on page 713): { "first":"%{first}", "last":"%{last}", "email":"%2" } A JSON string containing a local variable and various Data Repository selections (see "Data Repository lookups" on page 56): { "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}
PAGE 93

{ "name":"Peter Parker", "email":"parkerp@localhostcom", "ExtraData":"foobar", "detail": [{"id":"inv123","ExtraData":"hello"}, {"id":"456","ExtraData":"world"}] } JSON Record Data List example A JSON Record Data List describes a list of data fields (as name/value pairs), a data table schema and nested data records (if any) for one or more data records. Below is an example of such a JSON Record Data List.
PAGE 94

"detail": [{ "id": 3678078, "fields": { "ItemTotal": "2300.00", "ItemShipped": 2.0, "ItemOrdered": false } }, { "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 } }] } } ] Values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.detail[0].fields.
PAGE 95

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. This feature was introduced in version 8.5. The Data Repository is especially useful in situations where data needs to be kept in between processes. A few examples: An HTTP-based authentication process, once it has validated user credentials, could store session information (unique ID, user name, session starting time) into the repository.
PAGE 96

Feature Name Description Equivalent Database Terminology bytes. KeySet A group may contain as many KeySets (rows), which contain variable data, as necessary. A KeySet is inserted using the "Push to Repository" on page 431 task. Row/Record Lookup A method of retrieving one or more KeySets from a group in the data repository.
PAGE 97

For the Value_To_Match parameter, the single-quotes surrounding the value are mandatory even if the value is dynamic. This function may also be used anywhere else where the contextual menu gives access to it. You could, for example, use it on the General tab of the Create File task, to fill in the value of a key/value pair in a JSON string. Tip The Data Repository Manager displays, at the bottom left, the syntax used for accessing a specific value.
PAGE 98

It is also possible to create a Repository at a custom location; see ConnectionString. Debugging and error handling This chapter touches on two subjects that are intrinsically linked, though their use is different. Debugging is the act of running through your process, either step by step or as a whole, directly from the PReS Workflow Configuration tool, in order to detect and resolve issues with your process.
PAGE 99

Using the On Error tab Whenever an error is triggered either during debugging or when a process runs in production, the settings specified in the On Error tab of the task that generated the error will be used to determine a course of action. On Error Tab The On Error tab is common to all tasks and processes. It can be found in the"Task Properties dialog" on page 876.
PAGE 100

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 101

You can have as many error processes as you can normal processes - that is, you are limited to 512 processes, subprocesses, startup processes and error processes combined. Information available in an Error process The following information is available from within your Error process when it is triggered. l A series of variables containing information about the error, the task that triggered it and the process that contained it (see below). These are "System variables" on page 715.
PAGE 102

Variable Name %{error.errorid} The error ID, as entered in the OnError tab of the task. This is the same ID that appears in the Windows Event Viewer. %{error.errorlog} A string containing the logged error message(s) from a task. Multiple error messages are delimited by a "|" (vertical bar) character. Accessing the Logs If your process is running live in the PReS Workflow Service, you have two ways of seeing what is happening now or what has happened in the past.
PAGE 103

Note The information that is displayed here is the same as in PReS Workflow logs and depends on the logging level that you set in the "General and logging preferences" on page 787 and on the 'Minimal logs' option in the "Process properties" on page 864. Viewing logs for jobs that have already processed The logs for jobs that have already processed are available in the following folder: C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\Log You can access this folder more quickly by using
PAGE 104

But if, for a given input task, you did select this option and something goes wrong and an original input file is lost or corrupted, you will have the option to use the Resubmit Job command to pull the backed up input file into the process. Granted that you have backup copies of the files polled by an Input task, you may resubmit them as required.
PAGE 105

3. From the Task index box, select the index level to which you want the data to be sent. The index is the position in the process where you want to submit the job file. The numbers on the left in the Process area indicate the task index. 4. In the list of backed up input files, select the file you want to resubmit (see "Knowing what to resubmit" below). 5. Using the From page and To page boxes, select the data pages that you want to resubmit.
PAGE 106

page numbers in a Connect template, please see PlanetPress Design User Guide or Connect Online Help, respectively. Debugging your PReS Workflow process After designing a process, which is to add the different tasks, branches and conditions to the process and configuring them (see "About processes and subprocesses" on page 125), you can test whether or not the process and configuration actually work.
PAGE 107

l Any task is executed with the permissions of the user that is currently running the PReS Workflow Configuration tool. When running in Service mode, the user configured in the Configure Services dialog is used instead. If the credentials are different, a job that runs in debug mode may fail at run-time if the permissions are not available to the Service. Please see "Workflow Services" on page 763 for more details.
PAGE 108

l l l l l l l Click on View as Text in the Data group of the Debug tab to view the current job file using a text editor (Notepad by default). Click on View as PDF to view the current job file in Adobe Acrobat if it is present (this will work only for PDF job files). Click on View Metadata to open the data selector and see the current state of the process' Metadata. Click on View as Hex to view the current job file in the internal Hex editor. Click on the Stop button to stop the debugging process.
PAGE 109

l l l l l Step through the process in Debug mode until you reach the emulation or data change. Click on View as Text (or View as PDF if your data is PDF at this point) in the Data group of the Debug tab. In the viewer that appears, save the file to a location on your hard drive. Stop the process, and select the file you saved as your process's sample data file (see "Choosing a sample data file" on page 71).
PAGE 110

only supported with PlanetPress Design documents, and requires that this feature be available on the printer. OL Connect print jobs There are two OL Connect tasks designed to create print output based on a Connect Designer template: the "Create Output" on page 607 task, and the "All In One" on page 591 task, which combines 4 different OL Connect tasks, including the Create Output task, within a single one.
PAGE 111

Using a Printer Queue requires creating the appropriate Printer Queue in the Workflow Configuration tool first. In the Output to Printer Queue task, select No document to let the spool file pass through it. PlanetPress Suite print jobs In PlanetPress Suite, the printer model and settings are defined in the Design document itself (see "PlanetPress Design documents" on page 44). Print output is normally generated by an Output task that merges a PlanetPress Design document with a data file (i.e.
PAGE 112

dispatch spool files to printer queues, you have to create queues in Workflow and set each one’s properties. Printer Queue types The PReS Workflow Configuration program lets you create four types of printer queues: 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 114. LPR Output printer queues are used to send print jobs to printers via the LPR/LPD protocol. See "LPR Output Printer Queue" on page 115.
PAGE 113

Shared printer queue properties The options on a printer queue’s Advanced properties tab are common to all printer queues. They include the printer’s speed and any special pre- or post-job commands required for printer specific reasons. Pre-job commands are added right before the data in the data file, while postjob commands are placed at the end of the data file. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue.
PAGE 114

Character name: Character code: Typical use in printing context: Horizontal Tab \t Adds a horizontal tab Line Feed \012 Moves to the next line Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape character New Line (CRLF) \n Goes to a new line Windows Output printer queue Windows output printer queues send print jobs to local or network pr
PAGE 115

Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing. 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.
PAGE 116

l Data type: Select the proper data type. Select: l l l (f) Formatted text to interpret the first character of each line of text as a standard FORTRAN carriage control character. l (d) DVI file if the job file contains data in the TeX DVI format. l (o) PostScript file if the job file is a PostScript file. l (n) Ditroff format if the job file contains data in device independent troff. l (t) Troff format if the job file contains data in troff.
PAGE 117

Commands box. Use the right-click menu for a list of standard printer control characters. (See also: "Frequently used printer control characters" on page 113.) Note If you plan to use an LPR output printer queue to send PlanetPress Design documents generated using the Optimized PostScript Stream option, you should not enter data selections in the Printer address and Queue name variable property boxes.
PAGE 118

l l Active: Select to prompt the FTP client to use active mode when sending files to the FTP server. Passive: Select to prompt the FTP client to use passive mode when sending files to the FTP server. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing.
PAGE 119

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. To prevent each new file from overwriting the previous one, you should use variable names. This variable property box lets you use a combination of text, variables and data selections.
PAGE 120

Load balancing PReS Workflow offers various load balancing options to distribute the printing load and to make the process faster and more efficient. Print jobs may, for example, be split equally among several printers, or they may be split according to each printer’s capacity and speed. Load balancing can only be used for jobs sent to Printer Queue output tasks and it only applies when multiple Workflow Printer Queues are selected.
PAGE 121

Breaking the association between documents and a Workflow printer queue To break the association between a PlanetPress Design document and a given Workflow printer queue: l Select the document as displayed under the printer queue in question and press Delete. To break the association between a PlanetPress Design document and multiple Workflow printer queues: 1. Select the document as displayed under one of the printer queues in question and from the right-click menu choose Delete Instances.
PAGE 122

l l When the server running PReS Workflow sends a PlanetPress Design document along with the data to the printer, it adds a trigger before the document (trigger+document+data). When the server running PReS Workflow only sends the data to the printer, because the document is already present on the printer, it adds a trigger before the data (trigger+data). PReS Workflow adds the trigger code automatically, but you may want to use custom triggers.
PAGE 123

4. Enter a Name for the printer queue. 5. Click OK. Every new Windows printer queue using the Objectif Lune Printer Driver (PS) is shared by default. Once such a shared queue is created, end-users can install it on their own computer by going through the same steps they would when installing a new remote printer in their Operating System. By default, connecting to a shared printer will automatically result in the Objectif Lune Printer Driver being downloaded to the connecting host.
PAGE 124

Data Capture from PReS Workflow Once a shared Windows printer queue using Objectif Lune Printer Driver (PS) is installed on both the server and the client sides, data capture can be achieved the same way as with any other Windows printer queues. 1. Open your PReS Workflow Configuration program. 2. Insert a new process. 3. Select WinQueue Input from the Plugin Bar and insert it in the new process. 4.
PAGE 125

About Metadata Metadata files are files containing information on the job itself rather than containing the job per se. A job sent to the Objectif Lune Printer Driver (PS) creates its own Metadata, allowing users to retrieve relevant information, such as, for instance, the time and date the print request was sent and how many pages it contains. For more on this, see the Metadata documentation pages ("Metadata" on page 75).
PAGE 126

l l Subprocesses can be called by any other process (see "Subprocesses" on the next page). Error processes can only be used in the On Error tab of a task in your process (see "Creating and using Error processes" on page 100). Self-replicating processes are in fact regular processes that replicate themselves in the background when multiple input files are received simultaneously.
PAGE 127

Subprocesses Subprocesses are special processes that can be called by any other process. Subprocesses act exactly as subroutines in programming languages, allowing users to reuse existing processes by sharing them to the whole configuration file.
PAGE 128

Adding a startup process You may create a startup process in two different ways. 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 > Insert Startup Process. In addition, you may convert a regular process into a startup process: l Right-click a regular process and select Startup to convert the process into a startup process.
PAGE 129

Processes can be deleted, duplicated, renamed, disabled, grouped etc. via the Configuration Components pane. For a list of all operations that can be performed on processes in the Configuration Components pane, please refer to "Configuration Components pane" on page 828. Special workflow types PReS Workflow supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility.
PAGE 130

4. In the list, select the components you want to import. The PReS Workflow Configuration program lets you open and import any of the following: l l Complete PlanetPress Watch 4 to 6 configurations, as well as PReS Workflow 7 and 8 configurations. Specific processes from Version 6, 7 and 8 configurations, including their local variables. l Specific subprocesses from any PReS Workflow 7 and 8 Tools configurations. l Specific global variables from PReS Workflow 7 and 8 Tools configurations.
PAGE 131

An inactive process will display in the Configuration components as red and strike-through. Inactive processes can be useful for designing new processes in a live configuration. As the process does not execute there is no danger of submitting it to a PReS Workflow Service. To activate or deactivate a process: 1. Right-click the process in question in the Configuration Components pane 2. Click Active to disable or enable the process. 3. Send the configuration.
PAGE 132

Options General tab 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: Select to make this process a startup process (see: "Startup processes" on page 126). This option is not available for self-replicating processes and error processes.
PAGE 133

l Polling interval: Enter the frequency (in seconds) at which the process should verify if there are new jobs to process. The polling interval also applies to scheduled tasks that only run on certain times. For example, if your process polls every 30 seconds on a task that's only scheduled to run one hour per week, it will capture the input 120 times during that period.
PAGE 134

l Minimal logs: With this option enabled, the process will only log its Start time and the End time (along with the Time Spent), if no error was encountered during execution of the process. In case of an error, the entire process information is logged. 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 poll. The grid is composed of blocks that represent time periods on a given day.
PAGE 135

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 136

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 137

On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings. The Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
PAGE 138

condition results in a "true" or "false" value. If the result is true, it goes in the branch, processes all tasks up to the output, and the process finishes. If the result is false, it goes down the main trunk and continues processing until the process finishes.
PAGE 139

Converting 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 140

where PReS Workflow is installed. These dialogs cannot be displayed on any other computer. Toggling a process’s Run on Desktop property To toggle a process's Run on Desktop property: 1. Select an active process in the Configuration Components pane. 2. In the Object Inspector Pane, change the Run on desktop property from False to True, or vice versa.
PAGE 141

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. Note 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 142

Note l l The JScript engine is Microsoft’s JScript 5.8, which is the equivalent of JavaScript 1.5 (ECMA-262 3rd edition + ECMA-327 (ES-CP) + JSON). Enhanced JScript allows the use of more recent JavaScript syntax. Many methods - basic methods like Date.now(), String.trim(), btoa()/atob() and more advanced methods like Array.forEach() - are added to the JScript engine via the polyfill.js library.
PAGE 143

The Script Editor and XSLT Editor The Script Editor is used to edit scripts in Run Script tasks and the XSLT Editor is used to edit scripts in Open XSLT action tasks. You can open either editor using the Open Editor button from the task's Properties dialog. When you do so, the script currently displayed in the dialog box is pasted to the editor’s scripting box. Both editors are visually identical and share almost exactly the same commands.
PAGE 144

Importing a script To import a script: 1. In the editor, choose File > Import. The Open dialog box appears. 2. To import a script that uses a different scripting language or that was saved under a different file format, make a selection in the Files of type drop-down list. 3. Navigate to the script you want to import and select it. 4. Click OK. The script is imported, displayed and formatted according to the syntax of the language selected in the editor.
PAGE 145

1. Choose Search | Find, or press CTRL+F. The Find Text dialog box appears. The last used string is displayed in the Text to find drop-down list box. 2. Set the search settings and options. 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. Case sensitive: Select to limit the search to instances of text with the same case as the text in the Text to find box.
PAGE 146

4. To find the next matching string, choose Search | Find Again or press F3. Find and replace Strings in a Script The Replace With dialog box lets you search for and replace text strings in the editor. The available options help you limit the search, making replacements quicker and easier. To find and replace strings in a script: 1. Choose Search | Replace, or press CTRL+R. The Replace With dialog box appears. The last used strings are displayed in the Text to find and Replace with boxes. 2.
PAGE 147

reaches the end of the script or script selection, the search finishes. It does not loop back to the beginning. l l l Backward: Select to search the script backward, from the location of the cursor or from the end of the script, depending on what you choose for the origin (From cursor begins where the cursor is currently located in the script, Entire scope begins from the beginning of the script or beginning of script selection).
PAGE 148

2. Enter a new line number in the Enter new line number box or select one from drop-down list. 3. Click OK. Bookmarks in a script Bookmarks help you identify and jump to specific places within your script. Bookmarks are displayed in the editor’s gutter, so you will not be able to see them unless the gutter is both visible and sufficiently wide. If line numbers are also displayed in the gutter, bookmarks may be harder to see. To control line number and gutter display, see "Editor Options" on page 812.
PAGE 149

SOAP Server API Reference PReS Workflow offers a SOAP Server API Reference allowing jobs to be submitted from a third party application using the SOAP protocol. SOAP is short for Simple Object Access Protocol. While there are multiple possibilities for solutions using a SOAP server implementation, the SOAP Server API Reference is specifically for submitting jobs from a SOAP client. It implements methods that will allow SOAP clients to submit jobs and get information from PReS Workflow executing them.
PAGE 150

"SubmitJobInfStruc" on page 156 Structure containing any required information to prepare the file for a valid insertion into a PReS Workflow process. Note With the SOAP API reference, new SOAP plugins have been introduced. The old plugin, which could be used as an Input, Action or Output task, was renamed Legacy SOAP Client and has become obsolete.
PAGE 151

Note To obtain access to the complete list of processes for all users, the end-user must have administrator privileges. GetProcessTaskList The GetProcessTaskList function will allow a user (a SOAP client) to remotely request the tasks list of a process. This will be useful with the PostJob method since it needs a TaskIndex. Syntax GetProcessTaskList (ProcessName, user name, Password) : GetProcessTaskListResult Parameters l ProcessName: The Name of the PReS Workflow process.
PAGE 152

Note The TaskNames array will be sorted by the execution order of the process with the primary input of the process having an index of 1. GetSOAPProcessList 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 SOAP API method since it requires a SOAPActionName.
PAGE 153

Note If a user has administrator privilege, he will have access to all processes and therefore he will see all the processes. PostJob The PostJob method allows a user (a SOAP client) 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.
PAGE 154

Note The task index can be retrieved by using the GetProcessTaskList method. See point GetProcessTaskList for details. Note The PostJob method can never return a file to the calling application. PostJobInfoStruc Structure containing any required information to prepare the file for resubmission into a PReS Workflow process using a SOAP client. l VariableList: Array of complex type, containing pairs of variable names and variables value. The list also contains the Job Info variables.
PAGE 155

Syntax SubmitJob (File, SubmitJobInfStruc , ReturnJobFile, user name, Password) : SubmitJobResult Arguments l l l File – base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64). SubmitJobInfStruc – Structure containing any required information to prepare the file for a valid insertion into a PReS Workflow process (see "SubmitJobInfStruc" on the next page). ReturnJobFile – Boolean value. When true, PReS Workflow SOAP server returns the job file.
PAGE 156

Note The SubmitJob method only returns a file if the PReS Workflow process contains a SOAP Input task. Note If ReturnJobFile is set to true, the schedule options of the process should be set to a pooling lower than four seconds, so the client application gets a timely response. Note To return the file, the process must be completed before the timeout of the server occurs. The Timeout option can be set in your PReS Workflow preferences.
PAGE 157

Note While the functions here are in mixed case to simplify reading, it's important to note that 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).
PAGE 158

Variable Name Description Example Usage (VBScript) containing any variable available to Watch, including data selections. Example usage: var watchDate = Watch.ExpandString ("%y-%m-%d"); "Watch.GetConnectToken" on page 164 Uses the default Connect Server host as defined in the Workflow preferences to log into the Connect Server and retrieve an authorization token. Example usage: var tokenConnect = Watch.GetConnectToken(); "Watch.
PAGE 159

Variable Name Description Example Usage (VBScript) Example usage: var s = Watch.GetMetadataFileName(); "Watch.GetOriginalFileName" on page 168 Retrieves a string containing the job's original path and filename. Note: this filename is generally no longer available if it has been captured by Watch. Example usage: var s = Watch.GetOriginalFileName(); Watch.GetPDFEditObject Is used to manipulate PDF files using the AlambicEdit API.
PAGE 160

Variable Name Description Example Usage (VBScript) "Watch.Log" on page 171 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.Log("Hello, World!", 3); "Watch.SetJobInfo" on page 172 Writes the value of a string to a numbered job info. Example usage: Watch.SetJobInfo(9, "Job info 9 Value"); "Watch.SetVariable" on page 173 Writes the value of a string to a local or global variable by name.
PAGE 161

Syntax Watch.ExecuteExternalProgram const CommandLine: WideString; const WorkingDir: WideString; ShowFlags: Integer; WaitForTerminate: WordBool: integer; const CommandLine The command line to execute as a widestring. const WorkingDir The working directory for the execution of the command line as a widestring. ShowFlags Integer value representing the flag to use during the execution of the command line. These flags have an effect on the execution window opened by the ExecuteExternalProgram procedure.
PAGE 162

VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true Python Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, True) Perl $Watch->ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true); Watch.ExpandResourcePath The Watch.ExpandResourcePath method expands a Connect resource file name (e.g. invoice.OL-template) to its fully qualified path (e.g. C:\ProgramData\Objectif Lune\PlanetPress Workflow\Do
PAGE 163

Perl $Watch->ExpandResourcePath("invoice.OL-template"); Watch.ExpandString Provides access to the emulated job file and to all variables. This function returns a string that is the expanded version of the input string. Syntax Watch.ExpandString(StringToExpand) StringToExpand A regular parseable string that may contain system variables (%u, %f), user variables (%1 to %9), octal codes, and data selections.
PAGE 164

Watch.GetConnectToken The Watch.GetConnectTokenmethod uses the default Connect Server host as defined in the Workflow preferences (see "OL Connect preferences" on page 784) to log into the Connect Server and retrieve an authorization token. Syntax Watch.GetConnectToken() Return value The method returns a JSON structure like the following: { "host": "localhost", "port": 1234, "token": "fdjhfds89r378cm034573890mc3y893r092p", "method": "basic" } where: l host is the host or IP address of the server.
PAGE 165

Watch.GetConnectTokenEx The Watch.GetConnectTokenEx method uses the arguments passed to it to log into the Connect Server and retrieve an authorization token. Syntax Watch.GetConnectTokenEx(host, port, username, password) The arguments contain the Connect Server settings (see "OL Connect preferences" on page 784), in the form of strings (host, username and password) and a number (port). Return value The method returns a JSON structure containing the host, port, token and authentication method.
PAGE 166

Perl $Watch->GetConnectTokenEx("localhost",1234,"myUser","secret"); Watch.GetJobFileName Returns the complete path and file name of the job. This method is the same as PW_ GetJobFileName. getjobfilename() obtains the file name of a PReS Workflow process. This is useful for manipulating the job file, for example to replace data within it. If your script writes to this file, the modified contents will be used by the next plugin in your process.
PAGE 167

Example JavaScript var s; s = Watch.GetJobInfo(3); Watch.Log("Jobinfo 3's value is: " + s, 2); VBScript Dim 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.GetMetadataFilename Returns the complete path and file name of the metadata file associated with the current job file. Example JavaScript Watch.
PAGE 168

Watch.GetOriginalFileName Returns the original name of the file, when it was captured. This method is the same as PW_ GetOriginalFileName. Example JavaScript Watch.GetOriginalFileName(); VBScript Watch.GetOriginalFileName Python Watch.GetOriginalFileName() Perl $Watch->GetOriginalFileName(); Watch.GetResources The Watch.GetResources method retrieves a specific type of Connect resources when it is passed a file extension (e.g. "OL-template") or all Connect resources when it is passed an empty string.
PAGE 169

VBScript Watch.GetResources "OL-template" Python Watch.GetResources("OL-template"); Perl $Watch->GetResources("OL-template"); 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 JavaScript var s; s = Watch.GetVariable("MyVariable"); Watch.Log("MyVariable's value is: " + s, 2); s = Watch.GetVariable("global.MyVariable"); Watch.
PAGE 170

Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("global.MyVariable's value is: " . $s, 2); Watch.InstallResource The Watch.InstallResource(path) method copies or unpacks a resource, such as a Connect Designer template, Data Mapping Configuration, or package file, from the supplied path to the Connect resources folder (%PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\OLConnect). If a file already exists, it will be overwritten.
PAGE 171

Perl $Watch->InstallResource("c:\\myfile.ol-package"); Watch.Log Creates messages that are added to PReS Workflowwatch.log file. The PReS Workflow watch.log file is located in the following folder: %PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\Log View error messages in the Services Console while PReS Workflow is in Run mode by choosing Tools | Services | Service Console. In the Service Console, error messages appear with colors that correspond to the message level.
PAGE 172

Level Description 2 The message is logged as a Warning in the log file. 3 The message is logged as Information in the log file. 4 The message only appears when the application runs in Debug mode. Examples In the following example, log() will write an information entry in the watch log that says "this is a log" VBScript Watch.Log "this is a log", 3 JavaScript Watch.Log("this is a log", 3); Python Watch.Log("this is a log",3) Perl $Watch->Log("this is a log",3); Watch.
PAGE 173

VBScript Watch.SetJobInfo 3, "Job info 3 Value" Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); 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 JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); VBScript Watch.
PAGE 174

enabled and you must be logged on as the same user as the PlanetPress Watch Service. Examples In the following example, showmessage() displays a dialog box saying “test message”. JavaScript Watch.ShowMessage("test message"); VBScript Watch.ShowMessage("test message") Python Watch.ShowMessage("test message") Perl $Watch->ShowMessage("test message"); 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.
PAGE 175

Perl $Watch->Sleep(1000); Script.ReturnValue Set this variable to 1 (true) or 0 (false) in order to return a true or false status to PReS Workflow, when using your script as a conditional branch. This variable will have no effect if the script is run as an action. If the property is not set, the default value is false. Example This example will always return true, as the condition is static. It is, after all, simply an example. You get the idea.
PAGE 176

Perl $everythingOK = 1; if ($everythingOK) { $Script->{ReturnValue} } else { $Script->{ReturnValue} } = 1; = 0; 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 95) and at design time via the "Data Repository Manager" on page 849.
PAGE 177

Note Group and key names are case-insensitive. 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.
PAGE 178

repoObject.AddGroup("MyGroup","['FirstKey', 'SecondKey']"); Many methods require using the JSONStringArray type but JSON is not natively supported in VB Script. Therefore, for those methods, only JavaScript sample code is provided. There are many resources on the Web that propose ways of implementing JSON parsing in VB Script so you can implement whichever you see fit. However, using JavaScript is highly recommended.
PAGE 179

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

Name Description "RemoveKey" on page 191 Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised. All values for the key, in all keysets for the group, are removed. Note that when the Group contains a large number of KeySets, this operation may take a while. "RenameKey" on page 194 Renames key oldName to newName in group GroupName.
PAGE 181

Name Description SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note that KeyName must exist in GroupName, otherwise an error is raised. The method returns an array of the keyset ID's that were updated ( [1,2] ), or an empty array ( [] ) if no keysets were updated. "SetValueByID" on page 196 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.
PAGE 182

Name Description an asterisk * is passed as the Keys parameter, all keys are retrieved. When Condition is left empty, all keysets are retrieved. "RemoveKeySets" on page 193 Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. Condition may be left empty, in which case all keysets in GroupName are deleted. The method returns the number of keysets that were deleted.
PAGE 183

AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. 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 177). JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.
PAGE 184

repoObject.AddKey("Users", "email"); VB Script repoObject.AddKey "Users", "email" 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 185

var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); repoObject.AddKeySets("customers", '[{"CustomerID": "CUJS123456", "FirstName": "John","LastName": "Smith"}, {"CustomerID": "CURD654321", "FirstName": "Richard", "LastName": "Doe"}]'); 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 188 and "SetValueByID" on page 196).
PAGE 186

CheckRepository Verifies the integrity of the repository and recovers unused space left by deleted keysets. Similar to packing a database, the operation is non-destructive but it does require exclusive 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.
PAGE 187

When Condition is left empty, all keysets are retrieved, which is useful for reports, cleanup, or custom filters based on more complex conditions. GetKeySets() converts the results coming from the Repository from UTF8 to Ansi, in order to make results with special characters like 'éèêë?æ' compatible with scripting. To obtain the UTF8 value, without conversion, use GetKeySetsW().
PAGE 188

By replacing the last option from GetKeySets (the filter on CustomerID) with an asterisk, you can get all the rows from the data repository.
PAGE 189

LastName='Smith' "); /* retrieves email for first user named Smith */ var myValue = repoObject.GetValue("Users", "email", ""); /* retrieves email for first user */ VB Script myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" AND FirstName=""John"" ") /* retrieves email for John Smith */ myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" ") /* retrieves email for first user named Smith */ myValue = repoObject.
PAGE 190

Repository Object" on page 177). JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListGroups()); for (var i=0; i
PAGE 191

Sample return value '{"ID": "meta", "FirstName": "string", "LastName": "string", "email": "string", "DateC": "meta", "DateM": "meta"}' As shown in the sample, the value associated with each key name is actually the data type for that key. Only two values are currently possible: string and meta, where meta denotes an internally generated key. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys.
PAGE 192

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 177). JavaScript repoObject.RemoveKey("Users", "email"); VB Script repoObject.RemoveKey "Users", "email" RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise.
PAGE 193

/* both methods perform the same task */ repoObject.RemoveKeySetByID "Users", 10 repoObject.RemoveKeySets "Users", "ID=10" RemoveKeySets Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. The method returns the number of keysets that were deleted. When passing 'ID' as the Condition, all keysets in GroupName will be deleted.
PAGE 194

RenameGroup Renames group oldName to newName. While this operation has no impact on the data stored in the specified group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Syntax RenameGroup(oldName, newName: 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 177). JavaScript repoObject.
PAGE 195

VB Script repoObject.RenameGroup "Users", "LastName", "SurName" SetValue Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition. The condition is specified using basic SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note that KeyName must exist in GroupName, otherwise an error is raised.
PAGE 196

Gender=""F"" AND MaritalStatus=""Married"" " repoObject.SetValue "Users", "FormOfAddress", "Miss", " Gender=""F"" AND MaritalStatus="""" " 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. The KeySet ID can be retrieved with GetValue() ("GetValue" on page 188).
PAGE 197

/* both methods perform the same task */ repoObject.SetValueByID "Users", "FormOfAddress", "Mr.", 10 repoObject.SetValue "Users", "FormOfAddress", "Mr.", "ID=10" Updating a row There is currently no 'update' feature in the API for a whole KeySet. This JavaScript example retrieves the KeySet ID, which is then used to update values in the row. /* Get KeySet ID */ var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var keySetID = repoObject.
PAGE 198

page 207 objects. In turn, MetaDocument objects hold "MetaDatapage" on page 211 objects, which have "MetaPage" on page 214 objects. In addition, a Node contains a collection of "Attributes" on page 233 and can contain any number of "Fields" on page 234. All of these objects are contained in a "MetaFile" below object, and they are obtained, directly or indirectly, through methods of this object.
PAGE 199

The current job's Metadata file name can be obtained using the Watch.GetMetadataFilename method (see "Watch.GetMetadataFilename" on page 167) when using the "Run Script" on page 481 task. Note that the exact syntax may vary according to the selected script language. When writing a plugin using the plugin SDK the current job's Metadata file name can be obtained by calling the IWatchJob::MetadataFilename method from within IWatchPlugin::Execute.
PAGE 200

LoadFromFile(const String Filename ) Loads a Metadata file from the file system. This function throws an error when the Metadata file is invalid or when it can't be found. Note that this error should be caught in a try-catch block. Filename Name of the file to load. Exceptions l EOleException: Invalid Metadata file or other error while loading. SaveToFile(const String Filename) Saves the current Metadata structure in a file. Filename Name of the file to save into.
PAGE 201

MetaJob Properties Name Type Description "Attributes" on page 233 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 83.) "Count" on page 218 Integer Returns the number of child nodes. "Fields" on page 234 MetaCollection Returns the node's field collection. "NodeType" on page 219 TNodeType Returns the node type of the current Node. Note that the TNodeType type is not defined in an Active Script environment, such as the Run Script task.
PAGE 202

Methods Name Return type Description "Add(Integer Index)" on page 221 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 222 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 222 String Returns the value of the attribute of the specified name. "Clear()" on page 222 Deletes all the child nodes as well as the attributes and fields.
PAGE 203

"PageCount()" on page 227 Integer Returns the total number of pages present underneath this node. "Paste()" on page 227 Node Inserts the clipboard's content as the last child of the current node. "PasteAt(Integer Index)" on page 228 Node Inserts the clipboard's content as a child node at the specified index. "Select(TSelectWhat SelectWhat)" on page 228 Selects the child nodes according to the SelectWhat parameter.
PAGE 204

MetaGroup Properties Name Type Description "Attributes" on page 233 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 83.) "Count" on page 218 Integer Returns the number of child nodes. "Fields" on page 234 MetaCollection Returns the node's field collection. "Index" on page 219 Integer Gets the index of the node in its parent. "NodeType" on page 219 TNodeType Returns the node type of the current Node.
PAGE 205

1: The node is selected but one of its parents is not. 2: The node and all of its parents are selected. Methods Name Return type Description "Add(Integer Index)" on page 221 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 222 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 222 String Returns the value of the attribute of the specified name.
PAGE 206

page 225 specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 225 String Returns the value of the N'th field of the specified name. "IndexInJob()" on page 226 Integer Returns the index of this page in the job, taking all the pages from all the datapages from all the documents from all the groups into account. "Item(Integer Index)" on page 227 Node Returns the child (node) item located at the specified index.
PAGE 207

"SelectedDatapageCount()" on page 229 Integer Returns the number of datapages selected to be output that are underneath this node. "SelectedPageCount()" on page 230 Integer Returns the number of pages selected to be output that are underneath this node. "SelectedIndexInJob()" on page 230 Integer Index of the page among all the selected pages in the Job.
PAGE 208

an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use. "Parent" on page 220 Node Returns the parent node of the current node. "Selected" on page 220 Bool Indicates whether or not the Node is set to be printed. "SelectedCount" on page 220 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 217.
PAGE 209

well as the attributes and fields. "Copy() " on page 223 Places a copy of the node in the metadata clipboard. "Cut()" on page 223 Removes the node and places it in the metadata clipboard. "Delete()" on page 223 Deletes the node. "FieldByIndex(Integer Index)" on page 224 String Returns the specified field's value. "FieldByName(const String Name)" on page 225 String Returns the value of field of the specified name.
PAGE 210

node. "Paste()" on page 227 Node Inserts the clipboard's content as the last child of the current node. "PasteAt(Integer Index)" on page 228 Node Inserts the clipboard's content as a child node at the specified index. "Select(TSelectWhat SelectWhat)" on page 228 Selects the child nodes according to the SelectWhat parameter. The TSelectWhat type is not defined in an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use.
PAGE 211

MetaDatapage Properties Name Type Description "Attributes" on page 233 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 83.) "Count" on page 218 Integer Returns the number of child nodes. "Fields" on page 234 MetaCollection Returns the node's field collection. "Index" on page 219 Integer Gets the index of the node in its parent. "NodeType" on page 219 TNodeType Returns the node type of the current Node.
PAGE 212

1: The node is selected but one of its parents is not. 2: The node and all of its parents are selected. Methods Name Return type Description "Add(Integer Index)" on page 221 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 222 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 222 String Returns the value of the attribute of the specified name.
PAGE 213

"IndexInDocument()" on page 226 Integer Returns the index of this page in its parent document, taking all the pages from all the datapages into account. "IndexInGroup()" on page 226 Integer Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account. "IndexInJob()" on page 226 Integer Returns the index of this page in the job, taking all the pages from all the datapages from all the documents from all the groups into account.
PAGE 214

values to use. "SelectedIndexInDocument()" on page 229 Integer Index of the page among all the selected pages in its parent Document. "SelectedIndexInGroup()" on page 230 Integer Index of the page among all the selected pages in its parent Group. "SelectedIndexInJob()" on page 230 Integer Index of the page among all the selected pages in the Job.
PAGE 215

values to use. "Parent" on page 220 Node Returns the parent node of the current node. Methods Name Return type Description "AttributeByIndex(Integer Index)" on page 222 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 222 String Returns the value of the attribute of the specified name. "Copy() " on page 223 Places a copy of the node in the metadata clipboard. "Cut()" on page 223 Removes the node and places it in the metadata clipboard.
PAGE 216

"IndexInGroup()" on page 226 Integer Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account. "IndexInJob()" on page 226 Integer Returns the index of this page in the job, taking all the pages from all the datapages from all the documents from all the groups into account. "Item(Integer Index)" on page 227 Node Returns the child (node) item located at the specified index.
PAGE 217

Properties and methods All Node objects share a number of properties and methods that are common to all Node object types. There are also properties and methods that are either unique to a specific Node object type, or shared between only a few of them. Each Node object type provides methods to access its children (in other words, Nodes that are located underneath that Node item in the tree structure). The method's name varies to match the type of Node.
PAGE 218

Attributes and Fields In addition to being a collections of objects, a Metadata Node also contains two types of elements, called "Attributes" on page 233 and "Fields" on page 234. These are name/value pairs, where the name is case-insensitive. l l An Attribute is a read-only, system-defined element which holds certain information about a certain node in the Metadata structure. This information can be static (e.g. the size of a physical page) or evaluated on-the-fly (e.g.
PAGE 219

Returns the number of child nodes in the current node. Fields Returns the field collection (MetaCollection) of the current node. See "Fields" on page 234. Index Not available in MetaJob Gets the index of the node in its parent. Returns: The index (0-based) at which the current node is found in the parent's node list. Exception: l EOleException: Index is lower than 0 or higher than Count-1. NodeType Returns a value representing the type (TNodeType) of the current node.
PAGE 220

Parent Not available in MetaPage Returns the parent node of the current node. Selected Not available in MetaPage Indicates whether or not the node is set to be printed (see "Including or excluding nodes from the output" on page 217). If a node has its Selected property set to true, all of its child that also have their own Selected property set to true will print. If Selected is false, its child will not print, regardless of their Selected status.
PAGE 221

Returns: Returns an integer indicating the selected state of the node. If the node and all of its parents are selected, the method returns ssTrue (2). If the node is selected but one of its parents is not, the return value is ssDisabled (1). If the node is not selected, the return value is ssFalse (0). Return value State 0 False: The node is not selected. 1 Disabled: The node is selected but one of its parents is not. 2 True: The node and all of its parents are selected.
PAGE 222

Exception: l EOleException: The value of Index is invalid. AttributeByIndex(Integer Index) Returns the value of the Metadata attribute at the specified index. Parameters: Index 0-based index of the attribute value to retrieve. The index of the first element is 0 and the index of the last is Count-1. Returns: The value of the attribute as a string. Exception: l EOleException: Index is lower than 0 or higher than Count-1.
PAGE 223

Copy() Not available in MetaJob Places a copy of the current node, along with all of its children, attributes and fields, in the metadata clipboard. Modifying the original node after the copy is made does not modify the copy in the clipboard. Cut() Not available in MetaJob Places a copy of the current node, along with all of its children, attributes and fields, in the metadata clipboard and immediately removes the original from the Metadata structure. Warning The node being cut is removed immediately.
PAGE 224

Removes the current node, along with all of its children, attributes and fields, from the metadata structure. Warning The node being deleted is removed immediately. Any reference to it or its child nodes becomes invalid. The results of calling methods of such references is undefined. DocumentCount() MetaJob only Returns the number of MetaDocument in all child nodes.
PAGE 225

FieldByName(const String Name) Returns the value of the Metadata Field of the specified name. (See: "Fields" on page 234.) If more than one field has the same name, this method returns the value of the first one it finds, starting at the first field in the list. Parameters: Name Name of the field to retrieve. Returns: The value of the field as a string. If an field named Name is not found, an empty string is returned.
PAGE 226

IndexInDocument() MetaPage and MetaDatapage only Returns the index of this page in its parent document, taking all the pages from all the datapages into account. Returns: Absolute index (integer, 0-based) of the page within all the pages under the parent document. IndexInGroup() MetaDocument, MetaDatapage and MetaPage only Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account.
PAGE 227

Item(Integer Index) Group ( Integer Index ) MetaJob only Document ( Integer Index ) MetaGroup only Datapage ( Integer Index ) MetaDocument only Page ( Integer Index ) MetaDatapage only Returns the child node located at the specified index. Parameters: Index 0-based index of the node to retrieve. The index of the first node is 0 and the index of the last is Count-1. Returns: Reference to the specified node. Exception: l EOleException: Index is lower than 0 or higher than Count-1.
PAGE 228

Inserts the contents of the metadata clipboard as the last child node of the current node. This removes the node from the clipboard, making it empty after the paste operation. Returns: Reference to the top node being pasted. Exception: l EOleException: The node type of the clipboard and the current node don't match. For example, trying to paste a MetaGroup in a MetaGroup or a MetaPage in a MetaDocument.
PAGE 229

Changes the "selected" status of the current node as well as all of its child nodes according to the SelectWhat parameter. Parameters: SelectWhat Indicates what to select. The value swNone changes the Selected property of the current node and all child nodes to false, while swAll changes it to true. Script users: use 0 for swNone, 1 for swAll. SelectedDatapageCount() MetaJob and MetaGroup only Returns the number of datapages under the current node that are set to be part of the output, i.e.
PAGE 230

Returns the index of this page in its parent document, taking only the selected pages into account. Returns: Absolute index (0-based) of the page within all the selected pages under the parent document. If the page is not set to be output (i.e. its SelectedState is different than ssTrue), it returns -1. SelectedIndexInGroup() MetaDocument, MetaDatapage and MetaPage only Returns the index of this page in its parent group, taking only the selected pages from all the datapages from all documents into account.
PAGE 231

Returns: The number of such nodes, if any. If the current node is not selected or one of its parents is not, it returns 0. Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3) Not available in MetaJob Sorts the sub-nodes contained in the node according to a number of sort criteria.
PAGE 232

or a numeric sort is performed and one of the values is not numeric (i.e. consists of only decimal characters, no thousand or decimal separator allowed), the method will fail. If a sub-node contains multiple occurrences of fields with the specified name, only the first occurrence will be considered. String comparisons are done without regards to the case (case-insensitive) using the Windows Win32 API function CompareString(LOCALE_USER_DEFAULT, NORM_IGNORECASE, ...).
PAGE 233

Exceptions: l l l EOleException: Specified field or attribute does not exist in one of the sub-nodes. EOleException: A numeric sort is specified and one of the fields or attributes does not contain a valid numeric integer value. EOleException: An error occurred while comparing two strings. Attributes An Attribute is a read-only, system-defined element: a name/value pair, where the name is case-insensitive. It holds certain information about a certain "Node" on page 216 in the Metadata structure.
PAGE 234

Methods Name Return type Description "Add(const String Name, const String Value)" on page 236 Adds a new element to the collection or overwrites its value. Clear() Clears all elements from the collection. "CountByName(const String Name)" on page 238 Integer "Delete(Integer Index)" on page 238 Returns the number of elements with the specified name. Deletes the element at the specified index. "Item(Integer Index)" on page 238 String Returns the value of the element stored at the specified index.
PAGE 235

Properties Name Type Description Count Integer Returns the number of elements in the collection. Methods Name Return type Description "Add(const String Name, const String Value)" on the next page Adds a new element to the collection or overwrites its value. "Add2(const String Name, const String Value, TAddFlags Flags, Integer Index (optional))" on the next page Adds a new element with a customizable behavior if the name already exists.
PAGE 236

on page 239 "Name(Integer Index)" on page 240 String Returns the name of the element stored at the specified index. Attributes and Fields methods This topic lists the methods of the "Attributes" on page 233 and "Fields" on page 234 collection container objects. Note that the Add2() and the ItemByNameIndex() functions are only available with Fields. Fields support multiple entries with the same name, which is forbidden with Attributes.
PAGE 237

Parameters Name Name of the field to add. The name must adhere to this syntax rules: start with a letter, followed by zero or more letters, numbers, underscore or dash. The name is not casesensitive. Value Value of the element. There is no restriction on the content, although binary is discouraged. Flags Additional flags for the method. This determines how the method behaves when the specified name already exists.
PAGE 238

l EOleException The index is invalid. l EOleException An index is specified but afReplace is not specified. CountByName(const String Name) Returns the number of attributes or fields (integer) with the specified name. Parameters Name Name of the element to count. Returns Number of occurrences of elements with the specified name. Note that when counting an attribute by name, the only possible values are 1 and 0 because attributes can only occur once.
PAGE 239

0-based index of the element to delete. The first element in the collection is at index 0 and the last is at Count-1. Returns The value of the specified element as a string. Exceptions l EOleException Index is lower than 0 or higher than Count-1. ItemByName(const String Name) Returns the value of the element of the specified name. Parameters Name Name of the element to retrieve. Returns The value of the element as a string. If no element is found, an empty string is returned.
PAGE 240

Ordinal of the field to retrieve. To retrieve the value of the first field named Name, use 0. For the second field, use 1, and so on. Returns The value of the specified field as a string. If an field named Name is not found, or Index is higher or equal to the number of fields named Name (in other words, you specify 4 to get the fifth but there are only three), an empty string is returned. Exceptions l EOleException Index is lower than 0.
PAGE 241

To create a StringSort object, use CreateObject("MetadataLib.StringSort") or the {A07730B74100-457E-91E2-31BFF24E1EC4} CLSID. Although the object is published by the metadata library, it is completely independent of the metadata and can be used in any script, including those run outside of PlanetPress Suite. Methods Name Returns Description "Add(const String Key, Integer Value)" on the next page Integer Adds a new item in the sort list.
PAGE 242

Add(const String Key, Integer Value) Adds a new string key in the list, with an optional associated integer Value. Key String on which the sort will be performed. Value (optional) Integer associated with the string. This value is not used and will not be changed by the sort class. If the string goes to another position in the list after the sort, this value will move as well to the new index of the string. Return value: 0-based index (integer) of the newly added string.
PAGE 243

Return value: 0-based index (integer) of the string. If the string is not found, the method returns -1. Key(Integer Index) Returns the key at the specified index. Index 0-based index (integer) of the string to retrieve. Return value: String. Value of the key at the specified index. Exceptions l EOleException Index is lower than 0 or higher than Count-1. Sort() Sorts the items in the list according to their key. The sort performed is a simple alphabetical string sort: 30 comes after 200.
PAGE 244

AlambicEdit API reference The AlambicEdit library allows Workflow to access, create or modify PDF files. It does so by wrapping Adobe PDF Library API calls in an object-oriented COM API. The use of COM as the underlying technology allows Workflow's scripting environment to create an instance of that COM object through the Watch.GetPDFEditObject method (see "The Watch Object" on page 156). The object's hierarchy is modeled on the PDF document structure: l l l The PDF object implements the IPDF interface.
PAGE 245

Methods Syntax RETURN_VALUE_TYPE methodName( [ARGUMENT_TYPE arg1[, ARGUMENT_TYPE arg2[,...]]] ) Methods with a RETURN_VALUE_TYPE of VOID do not have a return value. In case of failure, methods raise an exception. Examples VOID Open( STRING fileName, BOOLEAN doRepair ) STRING GetXYML() JavaScript implementation: myPDF.Open("C:\\PDFs\\SomeDocument.pdf", false); var myXYML = myPDF.GetXYML(); Note: In JavaScript, all method calls must include parentheses, even for methods that do not require arguments (e.g.
PAGE 246

VBScript implementation: currentOrientation = myPDF.Pages(0).Orientation myPDF.Pages(0).Orientation = 180; Structures Syntax STRUCT_NAME { FIELD_TYPE fieldName1[, FIELD_TYPE fieldName2[, ...]] } Examples IPDFRect { LONG left, LONG top, LONG right, LONG bottom } JavaScript implementation: var pdfRect = myPDF.Pages(0).Size(); var pageWidth = pdfRect.right - pdfRect.left; VBScript implementation: set pdfRect = myPDF.Pages(0).Size pageWidth = pdfRect.right - pdfRect.
PAGE 247

VBScript implementation: set myPDF = Watch.GetPDFEditObject IPDF methods Name Return type Description "Close()" on page 249 Closes the PDF file. If changes were made but not saved, they are silently lost. All IPage objects must be released before closing a PDF. "Create(filename)" on page 250 Creates a new empty PDF file. "GetInfos()" on page 250 "IPdfInfos" on page 274 "GetVersion(*major, *minor)" on page 251 Retrieves the contents of the Document Information Dictionary from the PDF.
PAGE 248

"MergeWith2(pdfFilename, xnum, ynum, xoffset, yoffset, scaleFactor)" on page 252 Overlays each page of pdfFilename (the source) onto pages of the current PDF (the destination) in a grid whose size is specified by xnum and ynum. The pages are laid from left to right and then from top to bottom. "Open(filename, doRepair)" on page 253 Opens an existing PDF, optionally repairing it. "OpenEx(filename, password, doRepair)" on page 254 Opens an existing, password-protected PDF, optionally repairing it.
PAGE 249

"setTolerances (tolerableDeltaWidth, tolerableDeltaHeight, tolerableDeltaFontHeight, tolerableGap)" on page 257 Sets the floating point values for the tolerable factors. "SetVersion (major, minor)" on page 257 Sets the version of the underlying PDF file format. This is applied when the file is saved. "SetXMP(xmpPacket)" on page 258 Sets the XMP attachment by replacing the existing one with xmpPacket. IPDF methods reference Close() Closes the PDF file.
PAGE 250

If you run the above code without calling the CollectGarbage() method, the Close() method will error out. Create(filename) Creates a new empty PDF file. See also: "Save()" on page 256. Syntax VOID Create (STRING filename) filename Name of the file to create. The file is not physically written to disk until IPDF.Save() is called.
PAGE 251

Return value An "IPdfInfos" on page 274 structure containing the PDF properties. Cannot be NULL. GetVersion(*major, *minor) Returns the version of the underlying PDF file format. Note: This method is not available in all scripting environments. Syntax GetVersion(LONG *major, LONG *minor) major Pointer to a LONG that receives the major version number. minor Pointer to a LONG that receives the minor version number. GetXMP() Retrieves the XMP attachment embedded in the PDF.
PAGE 252

IsProtected(filename) Returns True if the PDF file is password-protected. When a file is password-protected, the OpenEx() method must be used instead of the Open() method. See also: "OpenEx(filename, password, doRepair)" on page 254. Syntax BOOL IsProtected (STRING filename) filename Name of the file to check for password-protection. Return value True if the file is password-protected, False otherwise.
PAGE 253

In PlanetPress Suite, this method is useful for n-Up imposition. For example, (xnum=1, ynum=1, scaleFactor=1.0) means that each source is overlaid on the corresponding destination page, 1 on 1, 2 on 2, 3 on 3, etc. Having (xnum=3, ynum=2) with xoffset, yoffset and scaleFactor set accordingly results in a 3x2 mosaic looking like this: 1 2 3 4 5 6 There is no separator between the source pages on the destination page. A space can be obtained by using an offset bigger than the size of the scaled source page.
PAGE 254

VOID Open (STRING filename, BOOL doRepair) filename Name of the file to open. doRepair Boolean. If true, the software automatically attempts to repair the file if it is found to be damaged or corrupt. Otherwise, the operation fails if the file is damaged. OpenEx(filename, password, doRepair) Opens an existing, password-protected PDF, optionally repairing it. See also: "IsProtected (filename)" on page 252. Syntax VOID OpenEx (STRING filename, STRING password, BOOL doRepair) filename Name of the file to open.
PAGE 255

Print(printername) Prints a range of PDF pages to the specified Windows printer with default options. See also: "PrintEx(printername, *PdfPrintParams)" below. Syntax VOID Print ( STRING printerName, LONG fromPage, LONG toPage ) printerName (optional) Name of the printer to print to. The default options of the printer will be used. If NULL, the default printer is used. fromPage 0-based index of the first page to print. toPage 0-based index of the last page to print.
PAGE 256

Pointer to an "IPdfPrintParams" on page 275 structure that specifies various print options. If NULL , default values are used. Save() Saves changes to the PDF file. The version of the PDF file format is the highest possible for a newly created file and is unchanged when saving an existing file, unless the SetVersion method was called in which case the file format used will be the one set by SetVersion. See also: "SetVersion (major, minor)" on the facing page.
PAGE 257

setTolerances(tolerableDeltaWidth, tolerableDeltaHeight, tolerableDeltaFontHeight, tolerableGap) Sets the floating point values for the tolerable factors. Syntax VOID setTolerances ( FLOAT tolerableDeltaWidth, FLOAT tolerableDeltaHeight, FLOAT tolerableDeltaFontHeight, FLOAT tolerableGap ) tolerableDeltaWidth Tolerable delta width factor value. tolerableDeltaHeight Tolerable delta height factor value. tolerableDeltaFontHeight Tolerable delta font height factor value.
PAGE 258

SetXMP(xmpPacket) Sets the XMP attachment by replacing the existing one with xmpPacket. Syntax VOID SetXMP ( STRING xmpPacket ) xmpPacket New XMP attachment to use instead of the existing one. Pages collection object The Pages collection object implements the IPages interface. This interface defines methods to add, import, move or delete pages as well to access individual Page items. It is accessed via the "PDF object" on page 246.
PAGE 259

srcIndex, srcCount, destIndex)" on page 261 "InsertFrom2 (srcPages, srcIndex, srcCount, destIndex)" on page 261 "Item(index)" on page 262 Inserts pages from another IPages object into this one. All relevant resources are copied with the pages. IPage (see "Page object" on page 263) "Move(index, count, offset)" on page 262 Returns a Page object from the PDF. Note that sinceItem() is the collection's default method, it can be omitted altogether (e.g. IPages(0) is the same as IPages.Item(0)).
PAGE 260

0-based index of the page to delete. ExtractTo(destFilename, srcIndex, srcCount, optimize) Extracts pages from the PDF and creates a new file with these pages. All relevant resources are copied with the pages. If the target file already exists, it is overwritten. Syntax VOID ExtractTo ( STRING destFilename, LONG srcIndex, LONG srcCount, BOOL optimize ) destFilename Name of the PDF to create with the specified pages. srcIndex 0-based index of the first page to copy.
PAGE 261

0-based index at which to insert the page. The page is inserted *before* the page at index "index ". To insert a page at the end, use IPages.Count(). mediaSize "IPdfRect" on page 276 structure containing the rectangular dimensions of the new page, in points. Cannot be NULL. InsertFrom(srcFilename, srcIndex, srcCount, destIndex) Inserts pages from another PDF file into this one. All relevant resources are copied with the pages. See also: "Count()" on page 259.
PAGE 262

VOID InsertFrom2 ( IPages srcPages, LONG srcIndex, LONG srcCount, LONG destIndex ) srcPages IPages collection from which the pages are retrieved. srcIndex 0-based index of the first page to copy. srcCount Number of contiguous pages starting from srcIndex to insert. If srcCount is -1, all pages from srcIndex up to the end are inserted. destIndex 0-based index of the position where to insert the pages. They will be inserted before the page at index destIndex. To insert the pages at the end, use IPages.
PAGE 263

VOID Move ( LONG index, LONG count, LONG offset ) index 0-based index of the first page of the range. count Number of contiguous pages to move. offset Number of hops to move the pages. If negative, the pages are moved towards the beginning of the file. If positive, towards the end. Page object The Page object implements the IPage interface. This interface defines methods to retrieve information from a page or modify it.
PAGE 264

separated by a CR-LF pair. "ExtractText2(left, top, right, bottom)" on page 268 String Returns the text located inside the region bounded by the left, top, right and bottom parameters. If multiple lines are found, they are separated by a CR-LF pair. "MediaSize()" on page 269 "IPdfRect" on page 276 Returns the size of the actual media, i.e. the sheet of paper. "setIncludeBorders (pbIncludeBorders)" on page 269 Sets whether or not borders are included for IPage.ExtractText2().
PAGE 265

left, top, rotateAngle, scaleFactor, layerName)" on page 273 "Size()" on page 274 () but allows to put the source page as a layer (aka an Optional Content Group). "IPdfRect" on page 276 Returns the size of the rectangle that is used to clip (crop) the content of the page before applying it to the medium, in points. IPage methods reference Draw(context, scale, offsetX, offsetY) Draws the page onto the device context.
PAGE 266

Vertical offset from the top edge of the DC surface, in *device* units, at which to start the drawing. The drawing is done in PDF user space units (72th of an inch). In order to have a smooth drawing of the page, the device context must have its mapping mode set to MM_TEXT with a 1:1 mapping between logical space (SetWindowExtEx) and device space (SetViewportExtEx).
PAGE 267

Warning This method is subject to many limitations (see below) and exists for backwardcompatibility and debugging purposes only. For production purposes, use ExtractText2() instead. Syntax VOID ExtractText ( FLOAT left, FLOAT bottom, FLOAT right, FLOAT top ) left Distance in inches of the left limit of the region from the left edge of the /CropBox. bottom Distance in inches of the bottom limit of the region from the bottom edge of the /CropBox.
PAGE 268

l l Horizontal moveto is not considered as a space. /CropBox size is not taken into account (an object whose left is at 144 is considered to be 2 inches from the edge even if the /CropBox starts at 72). l Only horizontal text is supported; vertical or rotated text is undefined. l Rotated pages are unsupported. l /UserUnit is not supported. ExtractText2(left, top, right, bottom) Returns the text located inside the region bounded by the left, top, right and bottom parameters.
PAGE 269

MediaSize() Returns the size of the physical medium on which the page is intended to be placed, in points. This corresponds to the /MediaBox entry of the /Page object in the PDF. See also: "Size()" on page 274. Syntax IPdfRect MediaSize ( ) Return value An "IPdfRect" on page 276 structure containing the dimensions, in points, of the media size. Cannot be NULL. setIncludeBorders(pbIncludeBorders) Sets whether or not borders are included for IPage.ExtractText2().
PAGE 270

Tolerable delta width factor value. tolerableDeltaHeight Tolerable delta height factor value. tolerableDeltaFontHeight Tolerable delta font height factor value. tolerableGap Tolerable gap between words factor value. Merge(imageFile, left, top, rotateAngle, scaleFactor) Inserts an image file and places it on the page at a specific location. Supported image types are: JPG and PNG. It calls MergeToLayer internally.
PAGE 271

scaleFactor Scale at which to display the image. For bitmaps, this is based on a 72 dpi resolution. Use 1.0 for the nominal size. Merge2(srcPage, left, top, rotateAngle, scaleFactor) Transparently places a PDF page on top of the current page at a specific location. The source page can be either from the same PDF or another opened file. If the source is from the same PDF file, the source page is not modified. This allows to have the same behavior as IPDF.
PAGE 272

MergeToLayer(imageFile, left, top, rotateAngle, scaleFactor, layerName) This method behaves the same as Merge() but allows to insert the image as a layer (aka an Optional Content Group). Supported image types are JPG and PNG. If the input file is a PNG with an alpha channel, the PNG is alpha blended with the page underneath. Monochrome PNG files are drawn transparently, with the white used as the transparent color.
PAGE 273

Name of an Optional Content Group in which to put the layer containing the image. The string cannot be empty but can be NULL if no layer is required. MergeToLayer2(srcPage, left, top, rotateAngle, scaleFactor, layerName) This method behaves the same as Merge2() but allows to put the source page as a layer (aka an Optional Content Group). Syntax VOID MergeToLayer2 ( IPage srcPage, FLOAT left, FLOAT top, FLOAT rotateAngle, FLOAT scaleFactor, BSTRlayerName ) srcPage IPage object to overlay on the current page.
PAGE 274

Name of an Optional Content Group in which to put the layer created from the source page. The string cannot be empty but can be NULL if no layer is required. layerName Name of an Optional Content Group in which to put the layer created from the source page. The string cannot be empty but can be NULL if no layer is required. Size() Returns the size of the rectangle that is used to clip (crop) the content of the page before applying it to the medium, in points.
PAGE 275

Structure iPdfInfos { STRING Title The document's title. STRING Author The name of the person who created the document. STRING Subject The subject of the document. STRING Keywords Keywords associated with the document. Multiple keywords a separated with semi-colons. STRING Creator If the document was converted to PDF from another format, name of the application that created the original document from which it was converted.
PAGE 276

Structure IPdfPrintParams { STRING docName Name of the document; this is the name displayed in the Wi spooler window. STRING pageRange Pages to print and/or page ranges separated by commas; e.g "0,3,5-12". Page numbers are 0-based. Leave empty to print all pages. LONG copies Number of copies to print. BOOL shrinkToFit If true, the page will be resized (shrunk or expanded) and rotated to fit to the physical media on which it is being printed. BOOL printAnnotations If true, annotations will be printed.
PAGE 277

All values are expressed in points (72 points per inch). NOTE: the PDF's coordinate system has its origin on the bottom left corner of the page, extending up and to the right. Therefore, a Letter-sized page has the following rectangular values: 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 (see "Using the On Error tab" on page 99).
PAGE 278

If (s = "") Then Err.Raise 449 ' Raises Error #449: "Argument is not optional" Err.Raise 1999,"My Plugin","Custom error" ' Raises error #1999: "Custom error" Else ' Do something with Job Info 9! Watch.Log "Job Info 9's value is: " + s, 4 End If ' JavaScript JavaScript uses the throw statement to create an exception which, if not nested inside a catch () construct, will cause the script execution to stop and the On Error tab to be triggered. var s; s = Watch.
PAGE 279

$s = $Watch->GetJobInfo(9); if ($s eq "") { eval {die "Value cannot be empty!"}; } else { # Do something with Job Info 9! $Watch->Log("Job Info 9's value is: ${s}",4); } Special workflow types PReS Workflow supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility. However, some types of processes like PDF and HTTP processes, and processes related to another product, are important enough to pay some attention to them.
PAGE 280

OL Connect Send (see "OL Connect Send" on page 757) needs one Workflow process to handle the job transfer, and in licensed mode it needs at least one other process to interact with the user. Reports about the use of OL Connect Send might be produced in yet another Workflow process. For examples of these processes see "Workflow processes in a Connect Send solution" on page 299.
PAGE 281

l 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. PReS Workflow can serve both static and dynamic resources to a web browser, however it is not meant to be used as a fully featured web server, as it is not built for responsiveness nor guaranteed uptime.
PAGE 282

type http://www.objectiflune.com/ in my browser, it is actually accessing the address http://www.objectiflune.com:80/ , but port 80 is always hidden. The reason port 8080 is used by default is to prevent any interference with existing web servers installed or activated on the same server as PReS Workflow. l l l Time-out (seconds): This determines how long the HTTP Server service will wait for the process to finish, before returning a time out error back to the client browser.
PAGE 283

You also need to take into consideration the options inside each of your processes that start with the HTTP Server Input task, as they will greatly impact how this process responds. In the process's properties, the following options will modify HTTP behavior: l l l Self-Replicating Process: This option is critically important when dealing with HTTP processes.
PAGE 284

successful or an HTML page with an error message, it will not attempt to send an HTML with a PDF mime type (which, obviously, would cause confusion). l There is no HTTP Server Output task (see below on how to end your process) Request/process/response cycle Once a process using the HTTP Server Input task is created, it is important to understand the cycle that is triggered when such a process runs.
PAGE 285

the Imaging. Similarly, ending a process with the Delete task does not return an empty file, it returns the actual data file. Actually the most used way of returning a response is this: generate an HTML file using either "Create File" on page 314 or "Load External File" on page 423, then use the "Delete" on page 653 task as a last output. The HTML is thus returned to the client.
PAGE 286

Process illustration Task breakdown 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 478. The condition returns "true" if the file is not found: c:\PReS\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value
PAGE 287

Tip Instead of creating a web page from scratch, you could create a web page from a Connect Web template; use the "Create Web Content" on page 620 task. l If, however, the file is found, then it is loaded with the "Load External File" on page 423 task, and then deleted (for the same reasons).
PAGE 288

l A condition checks whether the form has been submitted, by verifying that one of the required fields is empty. If it is, it means this is the initial request, so the condition becomes true. l l l l l If this is the initial request, an HTML page is created which contains a form asking the client for a required full name and email, and optional company name. A checkmark also offers to subscribe to a newsletter (it is unchecked by default!).
PAGE 289

Things to keep in mind while working with Metadata are set forth in another topic: "Working with Metadata" on page 78. Note In Connect it is also possible to group, sort and split PDF data using "OL Connect tasks" on page 591. Example: Daily sales report from PDF files This workflow makes heavy use of PDF tasks and Metadata, and assumes that you are using PReS Workflow version 7.3 or higher.
PAGE 290

l l l l l l The "Metadata Filter" on page 567 follows by removing any invoice that is not in the US. Note that the Metadata filter is an *inclusive* filter, meaning that the filter includes the parts of the Metadata where the result of the filter is true, and filters out anything else. The "Metadata Sorter" on page 572 then re-orders the Metadata documents by Rep ID, so that all of the invoices for any particular sales representative are all together.
PAGE 291

l "Security Considerations" on page 733 l "20,000 Patterns" on page 734 l "PlanetPress Capture Implementation Restrictions" on page 742 There are also 2 external tools that are used to communicate the pen's data to PReS Workflow: l "Anoto penDirector" on page 740 l "PlanetPress Mobile Application" on page 742 Creating a Capture-Ready document This is done when creating your PlanetPress Design document.
PAGE 292

l l l l The "Capture Fields Processor" on page 546, 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 538 task to do post-processing using the Capture Fields data. A "Get Capture Document" on page 556 action task to retrieve each document in the database and output a PDF file Any existing output such as Output to Folder, email, ftp, etc.
PAGE 293

l A "PGC to PDF Converter" on page 558 task converts the PGC to a PDF l Any existing output is used here, for example an email notification. The Examples l "Basic Functional Capture Workflow" below l "Capture Post Processing Workflow" on the next page l "Capture Web Manager Workflow" on page 298 Basic Functional Capture Workflow This workflow is the most basic and simple workflow that you can use with PlanetPress Capture.
PAGE 294

l "Capture Fields Generator" on page 543 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 295

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. Otherwise, the document is simply archived.
PAGE 296

l 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. l l In the branch, Get Capture Document retrieves a PDF version of the document and sends it as an attachment to an email sent directly to a manager using Send Email. Otherwise, Get Capture Document is used again, but this time the PDF is stored in a SharePoint Server using the Output to SharePoint connector.
PAGE 297

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 298

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 299

5. Click the PReS Workflow button (File menu) and go in Preferences. 6. In the HTTP Server Input 2 section, check the Serve HTTP resources option, change the Resource action name box to static , and the Resource folder to c:\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 761). 9. Open your browser and point it to http://127.0.0.
PAGE 300

the user. Reports about the use of OL Connect Send might be produced in yet another Workflow process. Each OL Connect Send solution will require the Workflow processes to be configured differently, but certain plugins will always be part of the solution. Job transfer process The Workflow process that handles the job transfer starts with an HTTP Input task.
PAGE 301

Sample project The Ad Hoc Mail Consolidation sample project may help you understand the Workflow processes for OL Connect Send and configure your own. l l Watch the sample in action on demo.objectiflune.com. Under Ad Hoc Mail Consolidation, click Demo and follow the instructions. (If you have already installed the printer driver, you don't have to do that again.) Add a Connect Send printer with the given settings and print the provided Word file to that printer.
PAGE 302

l "Input tasks" on page 311 l "Action tasks" on page 381 l "Data splitters" on page 452 l "Process logic tasks" on page 472 l "Connector tasks" on page 490 l "PlanetPress Capture" on page 727 l "Metadata tasks" on page 560 l "OL Connect tasks" on page 591 l "OL Connect Send" on page 757 l "Document Management tasks" on page 678 l "Output tasks" on page 652 l "Unknown tasks" on page 712 Note Completely empty files (0 bytes) cannot be processed by Workflow.
PAGE 303

3. Using your mouse, click and drag the task in your process at the place you want to insert it. 4. Depending on where you place your mouse, you may see that you can replace or insert existing tasks, or not place it at that location at all. 5. 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.
PAGE 304

Task properties Any task you add to your PReS Workflow process must be configured using its Properties dialog. It appears as soon as you add a task to a process, or when you double-click on a task. Each task's Properties dialog will give you the options to configure that specific, individual task. Properties of one task do not directly affect the properties of another task, however there are some software preferences that may affect tasks in one way or another (see "Preferences" on page 766).
PAGE 305

Variable properties may include: l Static data. l System variables. See "System variables" on page 715. l Local and Global Variables. See "Local variables" on page 720. l Job Infos. See "Job Info variables" on page 714. l Data and Metadata Selections. See "Data selections" on page 53. l Printer Control Characters. See "Shared printer queue properties" on page 113. These are normally only used in printer outputs.
PAGE 306

l l l l l l l l 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. This information becomes static and does not change between each datapage and job file.
PAGE 307

Masks Certain tasks, such as the Folder Capture Input task and the File Name Condition task, allow for entering a mask instead of a file name. See "Masks" below. Date and Time Format To simplify things and to prevent errors, date and time formats have been standardized. l l Dates are entered and displayed as yyyy/MM/dd (2007/06/13, for example). Times are entered and displayed using the 24 hour format as HH:mm:ss (3:38:54 PM, for example, is entered and displayed as 15:38:54).
PAGE 308

l l Literal characters: Any alphanumerical character is considered a 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 309

In most cases, you have three options: l l l You can choose a specific file from the list of installed documents (see "Workflow Configuration resource files" on page 39); these will be either Connect resources, or PlanetPress Design documents, depending on the task. You can choose a variable file (see below). You can choose not to use any document (only in certain cases).
PAGE 310
PAGE 311

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 task, 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 312

This is an important consideration when scheduling a task, as the Folder Capture task 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 313

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 Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864.
PAGE 314

The SFTP Input task also appears in the Input category when it is installed. (It isn't installed by default.) Create File Create File input tasks are different from other input tasks in that they do not pull in data from a source location. The data that this task passes along to other task is its own: text or values from variables entered when the task was created or last edited.
PAGE 315

Task properties General Tab l l l Create File: Enter the text to use as the data. The Create File box is a Variables Properties box, so you can use any of the variables, control characters or data selections as noted in "Variable task properties" on page 724. 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.
PAGE 316

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Email Input The Email Input task retrieves email data through a Microsoft Outlook or POP3 connection. Note If Microsoft Outlook connection is used, Microsoft Outlook 2000 or higher must be installed on the computer where PReS Workflow is located.
PAGE 317

Task properties General Tab l Data Location group l l l Message body: Select to use the data found in the body of the email. Attached file: Select to use the data found in the email’s attachment. If both the Message body and Attached files options are selected, the message’s body and the message’s attachment are treated as separate data files and processed one after the other. Unzip attached file: Select to unzip the attached files.
PAGE 318

Login Tab l Use Microsoft Outlook: Select to use the Microsoft Outlook email account of the current user to receive emails. The current user is the one defined in PReS Workflow Service Logon. l l Move message after processing to folder: Enter the name of an Outlook Folder to keep copies of the emails taken by this email input task. You should enter only the name of the folder as it appears in Outlook’s Folder List area, regardless of whether it is a child of another folder.
PAGE 319

CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864. l l Backup filename: Enter the file name 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 320

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Count File Count tasks check if a target folder contains a specified number of files. They can be used as Condition task or as Input task. When used as Input task, the task triggers the process to run only when the condition is true. As long as the condition is false, it does nothing (except log any errors).
PAGE 321

selections; see "Variable task properties" on page 304. l Masks: Enter a single or multiple file names or use file name masks (see "Masks" on page 307). Multiple filters are separated by a semicolon (e.g. *.csv;.xls*). This is a variable property field. (See "Variable task properties" on page 304.) l Treat as regular expressions: When ticked, the contents of the Mask field are deemed to be a regular expression .
PAGE 322

"Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864. l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory.
PAGE 323

Warning If you create a Folder Capture input task that takes any file it finds in the root folder of one of your hard disks, then PReS Workflow will try to remove all the files located in that folder, including all the system and hidden files. So when using a Folder Capture, be aware of where you are capturing. Processing Each file capture by the input is sent down through the process, one at a time.
PAGE 324

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. l l l l l l l Sort files by: Select a given sorting method to prompt PReS Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order).
PAGE 325

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 Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864.
PAGE 326

Processing Folder Listing loops through the files and, for each file, generates an XML node with information about the file. Output The output is an XML file containing information about each file. If the Sub-directories option was checked, the structure of the XML also contains the folder structure as it is present on the drive. Here is a sample of the XML that is generated: C:\Samples\ invoice.
PAGE 327

Note The tag is independent of the OS locale, language or settings. The format is always YYYY/MM/DD 23:59:59. Task properties General Tab l l l l Input folder: Enter the path of the folder that contains the files you want listed. Sorted by: Select either Name or Modified date, depending on how you want the list top be sorted. File mask: Edit the default file name mask (*.*) if you want only some of the files present in the folder to appear in the list. See "Masks" on page 307.
PAGE 328

Job Information definitions l %1- Folder: Contains the full path of the base folder from which the files are listed. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. FTP Input FTP Input tasks retrieve files from FTP sites using the FTP protocol. Masks are typically used to select multiple files to be retrieved from the server.
PAGE 329

l l l Password: If account named in the User name box is password protected, enter the password here. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another PReS Workflow task. Directory (optional): Enter the path of the folder to poll on the FTP server.
PAGE 330

Job Information definitions l l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically. %2 - FTP Server: Contains the FTP address of the server from which the files were retrieved. %3 - Source file name: Contains the name of the current file that was retrieved from the server. %4 - Folder: Contains the FTP folder from which the current file was retrieved.
PAGE 331

Task properties General Tab 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 (see "Variable task properties" on page 304). Note that when PReS Workflow connects to a secure page, an SSL (Secure Socket Layer) connection is automatically used. Note The connection to remote HTTPS is done through TLS v1 encryption. Prior to version 2019.2, this was done through SSL v2.
PAGE 332

CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864. l l Backup filename: Enter the file name 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 333

Note Athough Workflow can serve both static and dynamic resources to a web browser, it is not meant to be used as a fully featured web server as it is not built for responsiveness nor guaranteed uptime. It is recommended to use a common web server (for example, IIS or Apache) to serve your contents and to let Workflow process things only it can do. For more information on how to serve HTML and PDF generated by Connect through IIS, watch the Connect with Evie - IIS series.
PAGE 334

Note By default, the request XML also contains a CDATA section which contains the raw input data, effectively doubling the size of the incoming file. Due to technical restrictions, the incoming XML file cannot be more than 400MB, which because of CDATA is reduced to around 200MB. To help in this situation, you may elect to omit from the attachment, which can be changed in HTTP Server Input User Options.
PAGE 335

Task properties General Tab l l l HTTP action: Enter the name of the action requested of PReS Workflow by the client. This name corresponds to the URL that the client will be accessing. For example, if you enter "MakePDF" here, you could trigger the process by accessing http://127.0.0.1:8080/MakePDF . This is also what your HTML Form's action should be. MIME Type: Select the MIME type of the file that will be returned by the plugin.
PAGE 336

Note The response code must start with 3 digits, followed by a space and then the error message. If the first few characters can't be converted to a valid number, the server automatically returns "500 Internal Server Error", regardless of the actual response code provided by the process. l Variable containing the response code: The contents of the job information or local variable selected in this drop-down, presumed to be a valid response code, will be returned in the response header.
PAGE 337

l Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l %1 - Client IP Address: Contains the IP address of the HTTP client requesting a response. %2 - Request Header: Contains the headers of the request, which can contain information such as the Browser and Operating System, languages, etc.
PAGE 338

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 339

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 Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864.
PAGE 340

The Input SOAP Task only responds to a single SOAP action by the client: SubmitJob. Within this request however, a secondary action (SubmitSOAPActionName) can be specified - this is what the SOAP Action corresponds to in this task properties. 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.
PAGE 341

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 Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864.
PAGE 342

Input This task does not poll an input, it sits there and waits for a job file to be sent through the LPR port. Processing When the job is received through LPR, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. Task properties General Tab l l l LPD queue names: Enter the queue name (or names, one per line) specified in the printer queue on the remote computer or computers.
PAGE 343

"Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864. l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory.
PAGE 344

The Merge PDF Files Input task performs just like any other Input task: once the process has completed, control is transferred back to the Input task one last time to check if new files meeting the mask have come in. This means that the merging of PDF files that are not all present at the start of the process may take several passes, which may have an adverse effect on the overall performance and the size of the resulting PDF.
PAGE 345

l l l l Capture files in sub-directories also: Select to capture files from child folders of the source folder as well. When this option is selected, the chosen Sort order is applied to each separate folder, not across folders. The subfolders themselves are always processed in alphabetical order, regardless of the sort order. Sort directories first: If you selected a sorting method in the Sort files by box, and if you want the folders present in the source folder to be sorted first, select this option.
PAGE 346

l l Backup filename: Enter the file name 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 - PDF Directory: Contains the folder from which the data was captured. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 347

properties" on page 864) and it will capture the emails as long as there is unread email in the selected inbox. Processing The task accesses Inbox folders in the organization through the Microsoft Graph API (subject to that organization's IT policies) . Filtering is done at the mail server. Only the first unread email matching the conditions is retrieved from the mail server, along with its attachments. Captured emails can either be deleted or marked as read.
PAGE 348

Body C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0106HBKO3IODK3F\ 0106HBKO3IODK40.html Attachment C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0106HBKO3IODK3F\ 0106HBKO3X2KK41.pdf Attachment C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Wat
PAGE 349

l l l l l %2 - Sender's name: Contains the name of the sender as defined by the sender himself (or, if the sender is using Exchange, by the name defined in his Exchange server). %3 - Sender's address: Contains the email address of the sender as defined by the sender. %4 - Subject: Contains the subject of the received email (may be blank). %5 - Recipients:Contains a list of the names of all the recipients of the email, separated by a semicolon (;).
PAGE 350

l l Tenant ID: Enter the Tenant ID as specified in Azure. This value is static and cannot contain variables. User ID: This is the user's ID or email address. This value is dynamic. You can use any combination of text, variables and data selections; see "Variable task properties" on page 304. Post-processing l Select what to do when an email is processed: mark as read or delete the captured email from the account's Inbox.
PAGE 351

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Microsoft 365 OneDrive Input Microsoft 365 OneDrive Input tasks allow the processing of files from any of the organization's Microsoft 365 OneDrive accounts. This task uses the Microsoft Graph API. For this task to function correctly, Workflow needs to be granted application permissions for Microsoft Graph in the organization’s Azure instance. It needs read access to the Users category (User.
PAGE 352

error after 15 unsuccessful attempts. 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. Job Information definitions l l l %1 - User. This is the OneDrive user's ID. %2 - Source File Name. Contains the file name (excluding path but including extension) of the file name that is captured. Equivalent to using the %o system variable.
PAGE 353

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. Connection l l l l Application ID: Enter the application ID provided by Azure for this specific application.
PAGE 354

CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864. l l Backup filename: Enter the file name 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 355

not started by Workflow; it can still be started manually, but will only serve static resources and redirect requests to other servers. Note The NodeJS Server installed with Workflow is not supported in an x86 environment.
PAGE 356

page 864. Note The NodeJS Server Input plugin is not compatible with PlanetPress Capture. Input The NodeJS Server Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received. Actually, it is the NodeJS service that receives the requests and places them in a specific location on the drive. When a request is received, the NodeJS Server Input polls that location and finds the requests and all attachments.
PAGE 357

Processing Depending on the options chosen in the NodeJS Server Input task properties, the task may choose to ignore some of the files. For example, using the "Do not include XML envelope" means that only the POST attachments will be used in the process; the XML file will be discarded. Attachments are always saved on disk in a specific location, which is accessible either directly in the XML or directly as a data file through the "Loop each attachment as data file" option.
PAGE 358

Note You can serve static resources through PReS Workflow, which is especially useful for images, CSS and JavaScript files. See "NodeJS Server Input plugin preferences 2" on page 798. Task properties General Tab l HTTP action: Enter the name of the action requested of PReS Workflow by the client. This name corresponds to the URL that the client will be accessing. For example, if you enter "MakePDF" here, you could trigger the process by accessing http://127.0.0.1:9090/MakePDF.
PAGE 359

original attribute of the file tag in the request XML. Note If form data are submitted from HTML files that are made with the OL Connect software, you can expect them to be UTF-8 encoded. Warning Don't use any non-ASCII characters in Workflow's working directories path (in the V8WorkingDirectory registry key). Combined with the UTF-8 Form Data Encoding setting, this might make it impossible for Workflow to retrieve files from that path, depending on the actual path name and the system locale.
PAGE 360

l Send immediate response to client: Do not wait for the process to finish and send a static HTML or Text file back to the client instead. This prevents any timeout from occurring. l l Response file: Select which file to return. Note that the file name doesn't have to be static. You can use any combination of text, variables and data selections; see "Variable task properties" on page 304.
PAGE 361

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 Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool.
PAGE 362

operators selecting Generate Output in the PrintShop Mail Web Order Manager, providing an easy way to send jobs toward the PrintShop Web Connect Input task, in order to take full advantage of PReS Workflow's built-in automation tasks. Note PrintShop Mail Web and PReS Workflow must be installed on the same server in order to make the PrintShop Web Connect Input task available in your PReS Workflow.
PAGE 363

Send Configuration button. General Tab l l All documents: Lists, in a hierarchical view (Company -> Publication Types -> Documents), the PrintShop Mail documents already existing on the PrintShop Web server. Refresh: Click to update the list of PrintShop Mail documents available on the PrintShop Web server. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables are automatically created by the input task.
PAGE 364

Secure Email Input The Secure Email Input task captures a POP3 or IMAP email message with SSL (2.0, 2.3 or 3.0) or TLS (1.0, 1.1 or 1.2) encryption. Note that this plugin cannot be used on a Windows instance that uses a multi-byte language (e.g. Japanese, Chinese). The workaround is to either use a different Windows language or use the standard Email Input/Output plugins.
PAGE 365

Output Once the plugin is done processing, an XML file is created with the email’s details and location of the body and any attachments. The encoding of the XML file is Windows-1252. The body and attachments are located in the job's Temp folder of Workflow. Within the same process, those files must be moved to another location, otherwise they will be deleted at the end of the process (as expected for all files in the Temp Workflow folder).
PAGE 366

The most pertinent information is located at the top level, under . The sub node contains all the files for the email. For each file, the type (body or attachment), folder and filename is provided. A file of type Body is always present and contains the body of the email. The information is the same for all files and is repeated to facilitate the selection when using an "XML Splitter" on page 469.
PAGE 367

values may be different for some implementations or may change in the future. Note that emails retrieved using POP3 are always deleted from the server. l Enter the account credentials: the email account name on the mail server, and the password required to unlock the selected account. Note By default, GMail may not allow Workflow to access the account’s mail boxes unless that account specifically allows automated systems to access the inbox.
PAGE 368

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 Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 864.
PAGE 369

Task properties General Tab l Since Serial Input tasks have no specific task configurable properties, this section contains no property information. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables 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.
PAGE 370

SFTP Input The SFTP Input task retrieves files from a secure FTP site through an encrypted connection. Masks are typically used to select multiple files to be retrieved from the server. The SFTP Input and "SFTP Output" on page 661 tasks are part of a separate installer and are not included in the Workflow installer. The SFTP plugin installer can be downloaded from the Resource Center, under 'Plugins' in PReS Connect.
PAGE 371

l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH). l FTPS: Select if the FTP server uses FTPS (SSL/TSL) Port Number Group l l l Use default port: Check to use the default port used by the protocol selected above. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another PReS Workflow task.
PAGE 372

Security Tab This tab defines the certificates used to connect to the secured FTP servers. l l l l Accept all certificates: Check this option to automatically accept the certificates returned by the FTP server. Otherwise, in order for a connection to work, you have to establish a connection first and then accept a certificate from the List of known servers up to the Approved server list.
PAGE 373

l l Backup filename: Enter the file name 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 l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically.
PAGE 374

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. Input The SMTP Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received.
PAGE 375

and /ppemail[1]/body[1]/@html respectively. With %t%O\xmlget('/ppemail[1]/body [1]/@html',Value,KeepCase,NoTrim) and %t%O\xmlget('/ppemail[1]/@rawemail',Value,KeepCase,NoTrim) we get both the body and the whole raw email. l Attachments: The input task loops through each attachment and sends them down through the process. While the Envelope is not available, the Job Infos contain pretty much all of the information you would get from it.
PAGE 376

l “To” contains: Select to limit those messages used by this task to those that are sent to a specific address. The address you enter in the box below can include variables and wildcards. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables 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.
PAGE 377

return). l %9 - Body: Contains the body text of the message. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Telnet Input The Telnet Input task (also known as the Raw Socket Printing Input) receives files sent to a specific port. If you want PReS Workflow to receive data using multiple ports, you must use multiple Telnet input tasks.
PAGE 378

l Description: PReS Workflow displays the name of the service or process assigned to the port number entered in the Port box. Note that these are standard Internet Assigned Numbers Authority (IANA) descriptions. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables 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.
PAGE 379

Note Before configuring this task, 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 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 380

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 447). 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 exact data that the computer receives (and is not converted in any way). l Create PDF (With Metadata): Select to output a PDF.
PAGE 381

Job Information definitions l l l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user un which a software sending the job was logged in under. %2 - Host computer: Contains the name of the computer from which the job was sent. %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.
PAGE 382

l "Database Query" on page 403 l "Decompress File(s)" on page 408 l "Digital Action" on page 409 l "Download to Printer" on page 419 l "External Program" on page 421 l "Load External File" on page 423 l "Mathematical Operations" on page 424 l "Open XSLT" on page 426 l "PDF/A-3 Attachments" on page 428 l "PDF to Bitmap" on page 638 l "Push to Repository" on page 431 l "Rename" on page 433 l "Run Script" on page 481 l "Search and Replace" on page 436 l "Send Images to Printer" on
PAGE 383

Processing This task takes the PostScript version of the document (.ps7), adds the trigger and then the active data file to it. If Metadata is present, the output is based on this Metadata (unselected data pages will not generate output, the sort order will be respected, etc). Otherwise the complete data file is merged. Output The output is a PostScript job that can be sent to any output task in "passthrough" mode, for example Create PDF, PReS Image, etc. Metadata is not generated by this task.
PAGE 384

Input Any text-based file can be used in this task, even formats that are not directly compatible with PReS. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task. Processing The selected operation (adding or removing lines, text or pages) is made on the data file. Output The modified data file is output from this task. Metadata is not modified in any way if it is present.
PAGE 385

l l l Characters: Enter the string of characters to be added to the job file. This box is only displayed when the Characters option is selected in the Content box. Lines: Enter the lines of text to be added to the job file. This box is only displayed when the Lines option is selected in the Content box. Remove: Enter the number of characters or lines to be removed from the job file.
PAGE 386

Task properties General tab l Search mode group: Select your chosen search mode within this group. l l l l l Search whole file: Select if you want the entire data stream to be searched as if it were a single string of text. When this option is selected, PReS Workflow loads the entire file in memory. It offers more flexibility, since search expressions may span across multiple lines and may result in more successful hits. Note that since this option uses more memory, it may affect performance.
PAGE 387

l l l l l At the beginning of a line: Select to indicate that the search string must be the first string on the line. At the end of a line: Select to indicate that the search string must be the last string on the line. At column: Select to indicate that the search string must be in a specific column. Specify the column number (the value must be greater then 0) in the Column value box below. Between specific words: Select to indicate that the search string must be between specific words.
PAGE 388

Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Barcode Scan The Barcode Scan task is used to convert barcode data from multiple image formats into textreadable information. This information is placed in the Metadata and can be used by the rest of the process.
PAGE 389

Output This task outputs the original data file but with modified (or created) Metadata. The format should be the same as the input. Supported barcode types The following types of barcodes are supported: Barcode types Description EAN13 EAN13 symbology. Used with consumer products internationally, 13 characters. 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.
PAGE 390

Barcode types Description PDF417 Portable Data File is a 2-dimensional barcode (also known as matrix code) used in a variety of applications, including Transport, Identification cards, and Inventory management. It is best suited for cases where information needs to move with an item or document. DataMatrix DataMatrix is a two-dimensional barcode which can store from 1 to about 2,000 characters.
PAGE 391

Settings l l Force checksum validation: Select to define whether the checksum validation is required for symbologies in which a checksum character is optional. The goal of checksum is to detect accidental modification such as corruption to stored data or errors in a barcode values. By default it is set to false.
PAGE 392

intensity greater than 128 will be considered as white, while those less than 128 will be considered black. The value 0 means that the color threshold level will be calculated automatically depending on the image. By default Threshold level [0..255] is 0. This parameter is ignored with binary images (black and white images). Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 393

l l l l l l l l l BarcodeCount:: Metadata field representing the number of barcodes on the page. Barcode_1_Value: Metadata field representing the value of the first barcode on the page. Note that this field (Barcode_1_Value) contains the same value as the first occurrence of BarcodeValue. BarcodeBase64_1_Value: Metadata field containing the value of the first barcode, encoded in Base64. Barcode_1_Type: Metadata field containing the type of the first barcode (ex. EAN13, UPCA …).
PAGE 394

l When using a secondary input, a known issue of the Workflow Tool can cause some unexpected behavior, like having the same Metadata file reused instead of a new one being created for each data file captured. To work around this issue, simply add a Rename action task to set a unique file name (Ex. %u) to each new file before the Barcode Scan task, after each secondary input.
PAGE 395

General Tab Add/remove characters: Enter the number of characters to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add characters; negative values remove characters. This is useful when one or more characters of input data precede the start of the first data page. Note that certain control characters can be problematic.
PAGE 396

Emulation. The available emulations are: l Line printer. (Nothing to configure.) l ASCII. l l l l Tab on CR: Select to have the document insert a tab after each carriage return character it encounters. Set the number of spaces in the tab using the Number of spaces in the tab box. This option is available only if you selected the Read in binary mode option. If you cleared Read in binary mode, the printer replaces any end of line characters (CR, LF, or CRLF) it encounters with a LF.
PAGE 397

l Channel skip. l l l l Skip page: Enter the channel skip code that, in your data, signals the start of a new data page. In standard channel skip emulation, a 1 (one) signals the start of a new data page. If a 1 appears in the first column of your data, it is likely the channel skip codes are standard, and that only minor adjustments to the other codes, if any, will be necessary.
PAGE 398

l Go to column: Use this to enter the channel skip code in your data that tells the document to advance to a specific column. Enter the code in the Char box to the left of the Go to column label, and use the box on the right of the Go to column label to set the column number. This is useful when your data contains redundant lines that were originally created to bold a line on a line printer.
PAGE 399

Alternatively this task may be part of a "PDF workflow": a workflow in which both input and output are PDF and in which Metadata tasks are used to group, sort and sequence (split) the PDF data. (See "PDF Workflow" on page 288 for more information on this.) The Create PDF task will apply the active Metadata to the PDF data file. PDFs created with the Create PDF action task will effectively replace the current data file in any given process using such a task.
PAGE 400

l l Options 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 the PDF RIP. Note that some features, such as the Time and Date require that this option be selected. Add job information to the document: Select to add the available Job Info variables in the “header” of the generated output file. Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized.
PAGE 401

l Font group l l l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded. If a font is not embedded in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font.
PAGE 402

PReS Image" on page 756). l PDF version: 1.
PAGE 403

l Open options: l Zoom factor: Fit in window l Default view: Page only Database Query The Database Query action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format. Database Query action tasks are not considered input tasks as such, because they cannot be used to start a process.
PAGE 404

Input Any data file. The data file will be discarded by the task. Processing A connection to the selected database is made, the data is retrieved, and an output in the selected emulation format is generated. Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and Job Info variables are not modified in any way.
PAGE 405

l l l l Output file emulation: Select the emulation corresponding to the type of output file you want the PReS Workflow Database action task to generate. CR-LF replacement: If you want CR-LF (Carriage Return-Line Feed) characters within the data file to be replaced by another character, use this box to indicate which character to use. You may select the replacement character from the list or type your own.
PAGE 406

l l l l Default width: This box is used to set the default width for all fields. It is set to 60 by default, but can be set to any value between 1 and 65535. This value is applied to all the fields in the generated file. To set different widths for each field, use the Configure Width button. Doing this disables the Default width box. Configure Width: Click to set the width of each field in the generated file.
PAGE 407

l l l l Alternate syntax: Select to prevent automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the Advanced SQL Statement dialog box. The alternate syntax may be required for some database types. Edit SQL: Click to create and test an advanced SQL query; see "Advanced SQL Statement Dialog" on page 848.
PAGE 408

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 409

Output This task outputs the data file it received with no modification. Metadata and job files are not touched either. Task properties General Tab l l l l l l l Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Output folder: Enter the name of the folder in which you want the decompressed files to be stored.
PAGE 410

image files they generate are always saved, along with their index files (if any), to an archive folder. Note 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 Digital Action is an Action task and cannot be the last task in a branch or process.
PAGE 411

that in the latter case, you must be certain that the documents that will be chosen at runtime will in fact be available locally or at the selected host. 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 Printer centric: Select to send the document along with the trigger and data to PReS Image.
PAGE 412

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 413

(“Statement.%y.%m.@(1,1,1,1,25,KeepCase,Trim)” or ”Job.%f”). Otherwise, when the file 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.
PAGE 414

Note PDF/A output created from a template that uses CMYK colors will be much bigger than PDF/A output created from a template that uses RGB colors, because PDF/A needs to contain a color profile and the CMYK color profile is rather big compared to a RGB color profile. If the output size matters it is recommended to avoid using CMYK colors. l General group l l l l l l l ASCII format: Select to create the PDF file using ASCII characters (instead of the usual 8-bit binary format).
PAGE 415

contain parentheses, you should use a Run script action task (see Run Script Action Task Property) with a Strip() function to strip them out. l l Monochrome images group l l l Keywords: You may enter keywords for the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time. Monochrome compression: Select the compression to use for the monochrome images.
PAGE 416

that are less smooth. Select Bicubic to use a weighted average to determine pixel shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l l Color images group l l l l Grayscale resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. Color compression: Select the compression to use for the color images.
PAGE 417

l l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files. PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files. Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128).
PAGE 418

pages. Select Full screen to hide all screen contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen. l Font group l l l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded.
PAGE 419

l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server). Connection time-out: Enter the time, in seconds, that the connection to the database is maintained while no action is taking place before the connection is severed. Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory.
PAGE 420

For images you should rather use Send Images to Printer action tasks (See "Send Images to Printer" on page 438), as they provide image quality and conversion options. Input Any file that you wish to upload to the printer. Note that this task does not attempt to verify that the type of file being sent is compatible with the printer, or is in a supported file format. Processing The currently active data file is converted into PostScript.
PAGE 421

Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. External Program External Program action tasks are used to launch and execute other programs, which can be useful when you wish to process your job file in a way that is not possible with the standard PReS Workflow tasks.
PAGE 422

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. Task properties General Tab l Program group l l l l l Parameters: Enter parameters that will be passed to the external program when it is launched.
PAGE 423

generated by the program which will indicate whether its execution was a success or if errors were encountered. l l l l Verify return value: Check to enable the group and react whenever specific exit codes are returned by the software. If exit code is: Use the drop-down to select how to compare to the exit code. This numerical comparison is either equal, greater than or lower than. Value: The numerical exit code that will be verified.
PAGE 424

Output The loaded file is output. Metadata is not modified in any way, neither are Job Info variables. Task properties General Tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 425

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. Task properties General Tab l Mathematical Expression: Variable data field containing the expression to be evaluated. This expression may combine any combination of standard PReS Workflow variables and VBScript mathematical expressions.
PAGE 426

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 rearrange 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 427

l l l l l l Delete: Delete the current selection (only available if there is selected text in the editor). Select All: Select all of the contents of the editor. l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog. 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.
PAGE 428

PDF/A-3 Attachments The PDF/A-3 Attachments task is used to add external files as attachments to a PDF/A-3 job file, or to attach files - the job file and/or other files - to an external PDF/A-3 file. Optionally, some e-invoicing metadata can be added. Several e-invoicing standards, such as ZUGFeRD in Germany and Factur-X in France, require the (XML) invoice data to be attached to a PDF/A-3 file.
PAGE 429

Properties General Tab l Target PDF/A-3: Specify the file to which the attachments and (optional) metadata must be added. l l l Job file: When this option is checked the attachments are added to the current job file. The job file should be PDF/A-3 compliant. External file: Adds the attachments to an external file. Use the Browse button to select a PDF/A-3 compliant file. Note that the task doesn't verify that the target file is PDF/A-3 compliant.
PAGE 430

Warning If the target PDF already has an attachment with the same name, the existing attachment will be replaced without any error. l l Mime Type: Enter the mime type of the attachment, e.g. text/xml, image/gif. Relationship: Specifies what the attachment is in relation to the (entire) PDF document: l l l l l Alternative: An alternative representation of the PDF document; for instance, an XML version of the invoice in the PDF.
PAGE 431

l l l Extension schema: Select the standard to which the PDF and the XML invoice data conform. The standard's extension schema specifies which properties should be added as metadata. Uri: The value of the namespace URI in the selected extension schema (read-only). Properties: l l The DocumentFileName, DocumentType and Version are read-only. ConformanceLevel: Each standard specifies a number of different levels a file can conform to.
PAGE 432

Task properties General tab l l Group: Use the drop-down to select into which group the KeySet is inserted, or in which group the KeySet should be updated. Key set: Displays a list of keys for the selected group. l l l l l l l Key: Displays the key name in the group. Value: Enter a value for the key, which will be inserted in the KeySet. This value can be dynamic, including data selections, metadata selections, variables and other data. Update: Check to update the key with new data.
PAGE 433

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 434

The Run Script task can be used either as an Action or a Condition. When dragging and dropping a Run Script task on a given process, you select whether to use this task as an Action or a Condition from a contextual menu. (See also: "About branches and conditions" on page 137.) For more information on scripts, what languages are supported and how to write scripts and conditions, please see the related chapter, "Using Scripts" on page 141. Input Any data file, in any format. Processing The script is executed.
PAGE 435

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

l Script filename and path: Either the full path of the script, or click the Browse button to navigate to the file. This option is only available if you choose external script file in the Script running from option. Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties.
PAGE 437

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 l l Find: Enter the string of data for which to search. You can use any combination of text, variables and data selections; see "Variable task properties" on page 304. Replace with: Enter the string of data to use as a replacement.
PAGE 438

Send Images to Printer The Send Images to Printer Action task is used to send images to a printer so they can be used as resources by PlanetPress Suite (Design) documents run on the printer. It is comparable to the Download to Printer Action task (see "Download to Printer" on page 419), but includes image specific options. Furthermore, this task can be used to send images not only to printers, but also to the virtual drive of other computers running PReS Workflow applications.
PAGE 439

Select Top to bottom for images that will be printed in a rotated orientation on a portrait oriented page, or in a rotated orientation on a portrait oriented page. Note that images that are meant to be printed in various ways can be stored twice on the printer as two identical copies of the same file that bear different names (Image_Original.tif and Image_ Rotated.tif, for example).
PAGE 440

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

l l Concatenate files: If this option is selected, when PReS Workflow tries to save a file under a given name, if a file under that same name already exists, instead of overwriting 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. Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected.
PAGE 442

l Value: Enter the value that you want to associate with the selected Job Info variable or custom variable. l button: Adds a new line and lets you define the variable and value to set. l button: Removes the line that is currently selected (highlighted). l button: Moves the line up so it is processed before. l button: Moves the line down so it is processed after. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 443

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. Task 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 444

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 445

compatible printers. These characters, like other printer control characters that control how printers interpret and print jobs, are not meant to be printed. If your print job is bound for an HP compatible printer, it may include these characters even when printing to a PostScript printer that does not recognize them. PReS Workflow provides an easy way to automatically filter these characters through its Standard Filter task.
PAGE 446

Translator Translator action tasks can convert your data from its current encoding to a different encoding. The same data may be converted back and forth as required. The Translator action task is useful for data files using foreign languages, as well as to convert Unicode data files so that they can be manipulated within Workflow. Note that if Workflow's only job is to pass the data file to a task, there's no need to convert the data file. The OL Connect Server does support Unicode data files.
PAGE 447

Task properties General Tab l l l l Source encoding: Select the current data encoding. Note that the source encoding is not selected automatically and you must therefore select the proper encoding from this list in order for the conversion process to be performed successfully. Target encoding: Select the encoding to which you want the data to be converted.
PAGE 448

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" on page 67 data file. Output A Line Printer file. Metadata, Job Info variables and other variables are not changed.
PAGE 449

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 450

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 451

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 452

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Data splitters Splitter action tasks are used to split single data files into multiple data files. Splitters initiate a recurring cycle that stops only when the original file has been completely processed. When a given splitter creates a file, it hands it down to the task that follows, and all the tasks on the same branch are performed until the output task.
PAGE 453

de-emulated. Most times, the emulation/de-emulation process is completely transparent. However, in some cases, there may be minute differences. When using the ASCII or Channel Skip emulation, if there are missing line feed characters (when lines end with a single carriage return in ASCII, or when lines start with a No line feed channel in Channel Skip), the output data will be different from the input data, but the change will not be significant.
PAGE 454

Database Splitter The Database Splitter is used to split database files into multiple data files that are passed to subsequent tasks in the process. Input Database data (see "Database emulation" on page 65). 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 455

l l l l l l l l l l Operator: Select the condition to fulfill for the condition to be true and thus for the splitting process to take place. Value: Enter the condition value. Note that you can use the popup menu's Get Data command to select the value and populate this box automatically Match case: Select to force the splitter to match the character casing when resolving the Field value change or Field value condition.
PAGE 456

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Emulated Data Splitter Emulated Data Splitter action tasks are used to split emulated data files (with the exception of XML and database data files - refer to "XML Splitter" on page 469 or "Database Splitter" on page 454) into multiple data files that are passed to subsequent tasks in the process.
PAGE 457

Task properties General Tab l Split data file on emulated page group: Select to split the data file based on pages (rather than on a word found within the emulated data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place. l l Page(s) per output: Enter the number of pages to include in the file generated by the splitter in this edit box below or use the spin buttons.
PAGE 458

l l Trim selection: Select to force the splitter to strip empty trailing characters. When this option is not selected, blank trailing characters, if any, are considered in the matching process, so the word “DAY” will not be considered as matching the word “DAY”. Note that this setting applies only to the Word change option. Where to split: By default, the task splits the file at the beginning of the line on which the condition is met (the default value is 0).
PAGE 459

Warning The Generic Splitter, while seemingly more feature-rich, is slower than the other splitters by an order of magnitude. Whenever encountering the Generic Splitter, it is always recommended to replace it with a more appropriate splitter instead. Input Any data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process.
PAGE 460

l l l 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. Get: Click to get a static string of characters from the sample data file. If you use this button, the coordinates of the data you will select will be added to the Word is between lines and Word is between columns groups below.
PAGE 461

l 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. The coordinates of the selected region will be added to the Word is in line box and the Word is between columns group below. The Generic Splitter will look for changes in the string of characters appearing in that region. Word is in line: Enter the line on which to search for the word change.
PAGE 462

l l l Pages per output file: Enter a number of pages after which to split the file. If you enter 3, for example, the Generic Splitter will split the file every time it has counted three pages. A 10 page file would be split in 4 files, the first three being three pages long and the last one only 1 page long. View data file: Click to view the sample data file and to cycle through the pages.
PAGE 463

l l Split when condition found: You may not want to split the file every time the string of characters entered in the Value box is found, but only every other time, or every third time. If so, enter the number of times in this box. A database field change: If you choose A database field change in the Split data file on list box (the Use emulation option must be selected), the following box is displayed. l l l Field name: Enter the name of the field that the Generic Splitter must check.
PAGE 464

In-Stream Splitter In-Stream Splitter action tasks are used to split non-emulated data files into multiple data files that are passed to subsequent tasks in the process. Note Performing the splitting process on raw, non-emulated data speeds up the splitting process.
PAGE 465

l l l l l l To column: Enter a value corresponding to the last column in which the splitter must start searching for the word. Match case: Select to force the splitter to match the character casing of the string of characters entered above with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”.
PAGE 466

In the case of Connect Print output, using Print Presets to separate the output is preferable to using the PDF Splitter. How to separate Print output in Connect is explained in the Connect Online Help: How to split print output into multiple files. Input A PDF data file (see "PDF emulation" on page 67). 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.
PAGE 467

l l l l l l l l l l l Get button: Click to go to the Data Selector and select the location associated with the On region 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. You may also use the Get Data button to get a static string of characters from the sample data file.
PAGE 468

l l 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. Split PDF file based on Metadata group: l l Metadata Level: Determines on which level of the Metadata the split occurs. This can be Group, Document to Data page.
PAGE 469

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. Note that the XML Splitter cannot process files larger than 30 megabytes.
PAGE 470

split whenever this node is encountered or whenever the information in this node changes, see the Condition group below. l l l l l l l l l l 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. When condition node is found: Select if you want the file to be split whenever the node selected in the Condition node path box is encountered.
PAGE 471

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 472

Process logic tasks A process is like a flowchart. The data files captured by the Input tasks become job files (see "Job file" on page 51) that travel down the process. Many processes include multiple process logic tasks. In the Process area, conditional branches appear with their associated condition, allowing you to understand the logic of the whole process at a glance.
PAGE 473

even if a branch does a backup of Job Info variables and the data file, it does not back up the metadata. Keep this in mind when designing a process.
PAGE 474

main branch. Note that if the secondary branch ends with a Delete output task, the main branch will receive the job file in the state it was just before the delete. If the secondary branch includes a splitter task, the main branch will receive the last part of the job file (as split by the splitter task). If the secondary branch ends with a PReS Fax or PReS Image output task, the main branch will receive a PostScript file.
PAGE 475

Comments do not open, modify or otherwise process the job file in any way, and are simply ignored at run-time. They do not have an On Error tab because of this, since they cannot generate an error in any situation. Comments have a single property in the General tab, which is the box where you enter the comment itself. This box does not process variables (it is not a "variable property"), since that would be of no use at run-time.
PAGE 476

Task properties General Tab l l Target folder: Enter the full path of the folder from which the input files are to be taken, or use the Browse button to select it. Note that subfolders are not processed. This is a variable property field. You can use any combination of text, variables and data selections; see "Variable task properties" on page 304. Masks: Enter a single or multiple file names or use file name masks (see "Masks" on page 307). Multiple filters are separated by a semicolon (e.g. *.csv;.
PAGE 477

"Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables 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 Workflow Tools working folders under the "Backup" folder.
PAGE 478

Advanced properties Right-click the task in the Workflow process and select Advanced Properties... to make settings on the On Error and Miscellaneous tabs. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 479

This task is put into effect in the following example process: l "HTTP PDF Invoice Request" on page 285 Task properties General Tab l l l File size is: Select whether the condition is to check if the job file is smaller (less than) or larger (more than) than the specified value. Kbytes: Enter the minimum (more than) or maximum (less than) size setting in kilobytes. Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa).
PAGE 480

Task properties 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. Once the subprocess completes its execution, the main process will retrieve the original job information values.
PAGE 481

Task properties General Tab l l l l Number of iterations: The number of times the loop should be repeated. Every task after the Loop action task will be repeated this number of times. The number may be static, or use a variable (see "Variable task properties" on page 724). Store current iteration in Job Info #: The Job Info in which the loop's iteration should be stored. Useful for sequential file names or conditions based on the iteration.
PAGE 482

For more information on scripts, what languages are supported and how to write scripts and conditions, please see the related chapter, "Using Scripts" on page 141. Input Any data file, in any format. Processing The script is executed. The script can modify anything such as the data file, Job Info variables, Metadata, or even other files on the operating system. Output Whatever file the Run Script action generates, Metadata it modifies or creates, etc.
PAGE 483

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. Language: Select the language in which your script is written. Choices are VBScript, JavaScript, Perl or Python.
PAGE 484

Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties. 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. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 485

Task properties General Tab l Process: The name of the target process to send the current job to. Note that startup processes 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. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 486

manufacturers. They are based on a standard known as Abstract Syntax Notation One (often referred to as the ASN.1 standard). Task properties General Tab l Parameters group l l l l l l l Community: Enter the community name for the printer or other SNMP compliant device you want to monitor. A community acts like a combination of a user and password granting you access to an SNMP device. Depending on the community name, the device knows what rights to grant, for example, read-only or read-write.
PAGE 487

l l l l Printer status: Select Idle or Printing to test whether the printer is currently idle or printing. Select Do not test if you only want to test the printer’s alert status (below). Alert status: Select No alert to make the condition False whenever an alert situation is detected, regardless of its type or severity. Select No critical alert to make the condition False whenever a critical alert is detected, regardless of its type.
PAGE 488

l To compare two strings. As with the test above, this test can also be used to search for a string in a given location. The difference with this test is that it gives you comparison options. Using the “Contains” operator, you can test the presence of the string “Gold member” at a given location in the job file (using a data selection), but the other operators can be used to test whether or not the first string is equal to the second one, whether it is equal or lower than the second one, etc.
PAGE 489

l l l l l Location: You can only enter a location when either ”Is found” or ”Is not found” is selected in the Operator box. If you select “at”, you also have to enter a specific line and column. If you select “on line”, you have to enter a given line. If you select “in area”, you have to enter a range of lines and columns. If you select “on the page”, the search area will cover the whole data page (as defined below).
PAGE 490

Task properties General Tab l l l l l Month: Select All months if you want the selected time blocks to be valid every month of the year. Select a specific month if you want the selected time blocks to be valid only on that month. Week of month / by date: Select Date if you want the selected time blocks to be valid only on specific dates. Select All weeks if you want the selected time blocks to be valid every week of the month.
PAGE 491

Available Connector tasks l "Create MRDX" below l "Laserfiche Repository Output" on page 497 l "Lookup in Microsoft® Excel® Documents" on page 499 l "Microsoft® Word® Documents To PDF Conversion" on page 502 l "Output to Capture OnTheGo" on page 505 l "PReS Fax" on page 512 l "PReS Image" on page 513 l "PReS Print Controls" on page 523 l "PrintShop Mail" on page 527 l When installed, the "ZUGFeRD plugin" on page 529 also appears in the Connector category.
PAGE 492

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

Output When used as a Condition task, the success of the delete operation determines whether the task returns True or False. Task properties General Tab The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document. l Server URL: Select the address of the COTG Server that you want the plugin to communicate with. (This option is only available if more than one COTG Server address has been defined.
PAGE 494

l Microsoft SharePoint 2007 l Microsoft SharePoint 2010 l Windows SharePoint Services 3.0 SP2 l SharePoint Foundation 2010 l SharePoint 2013 It may work but has not been certified with other SharePoint server versions. Note Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PlanetPress 7.5 and higher only. Licensing This plugin requires the OL Connect Workflow Imaging license.
PAGE 495

Task 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 496

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 497

Laserfiche Repository Output The Laserfiche Repository Output task publishes files - and optionally sets index values into a Laserfiche server. This task uploads any documents in a Laserfiche repository, optionally filling the index information on the Laserfiche server with dynamic information that can be taken from PReS Workflow PDI files (for PReS Workflow archives only). Note The Laserfiche Repository Output requires the Laserfiche run-time version 8.1 or higher and will not work with previous versions.
PAGE 498

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. Note: If the Folder field is empty, the documents will be exported by default to the root folder Import Format group l l l l l l l Laserfiche Pages: Converts all images files (*.bmp, *.gif, *.jpeg, *.pcx, *.png, *.tif, *.tiff, *.
PAGE 499

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. l Test Connection: Click to verify that the information entered in this tab is correct and the server accepts it.
PAGE 500

data retrieved is based on existing data in your Metadata, and it will either be added to your Metadata or will append or replace your existing Metadata if it exists. Fields on any level (Page, Datapage, Document, Group, Job) can be used, and the result field will be added on the same level as the lookup field. Note This task will automatically "loop" through the Metadata and repeat its action for each of your Metadata's data pages.
PAGE 501

Input Any compatible data file. This task requires Metadata to be present. Processing The task parses each level of the Metadata and, for each field of the specified name it finds, a lookup is made. If a field of the same name appears on multiple levels, the lookup will happen for all fields, on all levels, individually. Output The original data file is unchanged. Metadata is updated according to the specified criteria.
PAGE 502

l l l l l l Replace field value: Replaces any existing field with the new content. Only the last result will be displayed. If the field does not exist, it will create it. Append field value: Ads the data to the existing field within the same one. No "separator" is added. If the field does not exist, it will create it. Result Field: The Metadata field name in which the result should be stored. This field will appear in the same Metadata level as the Lookup Field.
PAGE 503

l Microsoft Word must not be currently opened when the automation task runs. l Microsoft Word 2003 and up are supported. l l l l l While debugging this task, the printer shows the message that the document can not be printed. This message is normal and will not appear when running a live configuration.
PAGE 504

l A PDF file accompanied with basic PDF metadata. This is the default output. The Metadata contains one Document level, and one Data page (and Page) level for each PDF page generated by the document. When Mail Merge is not selected, this is the only available choice. Note The Objectif Lune Printer Driver will naturally add a margin to the PDF generated by this task. If your PDF is full bleed you will not get the desired results using this option.
PAGE 505

Microsoft Access and Excel data files. You can use the Test Connection button to test the SQL and connection string. l l Test connection: Checks if the Connection String and SQL Statement are valid, and if the resulting recordset is understood by the Microsoft® Word® document. This is optional, though highly recommended. Output Type: l l .PDF File (with metadata): The result will be a PDF file with the number of pages generated by the combination of the template and record set.
PAGE 506

Processing This task does not process the data or Metadata file. The information entered in the Deposit tab of this task is sent to the repository configured in the Repository tab. Output The output that this task produces is the information sent to the Capture OnTheGo online repository (the document ID). Task properties Repository Tab The Repository tab is where you enter the connection information necessary to create the link between OL Connect or PReS and CaptureOnTheGo.
PAGE 507

l l Document Information group: In this group, you enter information that will help users identify the document. It is mandatory to enter valid information in all the boxes included in this group. l l Cover Image: Enter the path to a cover image that is shown in the repository and library list, as well as the document property. The maximum image size is 512x512 px and it is required to be in JPG or PNG format. Use the Browse button to locate an image on the local drive.
PAGE 508

are not present on the Capture OnTheGo Server, the process will go through and the listed categories will be added to the Server. Advanced Tab The Advanced tab is where you specify the document's time to live either in the repository or the user's device. l Document Handling Options group: l l l l Customize: You must check this box if you want the options included in this group to be used. When this option is not checked, the other boxes included in this group are faded.
PAGE 509

that the date you enter will automatically be reflected in the For box above. l l Document Tracking: l l l Time zone: When you enter a number of days in the For box or a date in the Until box above, the computer’s time zone appears in this box. You may select a different time zone if required. Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server. This tracking is done through the COTGDefaul.mdb database located in %ProgramData%\Objectif Lune\PReS Workflow 8\PRe
PAGE 510

Workflow Imaging is an add-on license bundle for OL Connect Workflow that includes the Image and Fax plugins; see "About PReS Image" on page 756 and "About PReS Fax" on page 755. Without a valid Imaging license, the plugin will fail with an error. In the trial version, the plugin will work. Input Any data file, with optional Metadata. Processing The task connects to the selected Document store and uploads the current data file.
PAGE 511

Configure SharePoint Metadata Fields dialog This dialog lets you setup the information you want to assign to the SharePoint Metadata information. It contains one line for each field present in the SharePoint document library. l l l l Field Name: Name of the field as set in SharePoint Document Library. Field Information: The information to enter in the SharePoint Document's Metadata for this field. Use PDF/A: Check to use the information contained within an PDF.
PAGE 512

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 log-on 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 513

Output A TIFF in the CCITT Group 4 compression, and information for the FAX server to know where to send the file. Task properties General Tab l l l l l Host: Select the IP address of the PReS Fax host to which you want the request to be sent. The Fax configuration is set in the PReS Fax User Options on the target host. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box.
PAGE 514

given computer (see "PReS Image preferences" on page 807). Note that those options are specific to each PReS Image installation and that they are immediately applied. The following describes the properties specific to PReS Image Output tasks. Note In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PReS Workflow is running, so emails are not sent out automatically.
PAGE 515

l l If the data file and a document are selected, and Optimized PostScript Stream mode is used, the data file is merged with the document and the resulting OPS job is sent to the PReS Image host to produce output. If the data file is a postscript file and either mode is used, the postscript file is sent to the PReS Image host which generates output (since this is already Optimized PostScript, it is not regenerated).
PAGE 516

l l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Output type: Select the output file type that you want. l l l l l l 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. PDF: The output will be a PDF file.
PAGE 517

TIFF G4, monochrome (1 bpp) is the only Color depth option you can select. This property is enabled for all output types except PDF. l l l l l l l l Multi-page: Select to generate a single file containing multiple pages. When this option is not selected, PReS Image creates a file for each page included in the output file. This property is enabled for all output types except PDF and JPEG. Add page number: Select to put a page number on each page included in the output file.
PAGE 518

l l l PDI: Select if you want this task to add a PDI index file to the generated document. XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document. Use Title as FormName for PDF/VT document: Check to use the Title (defined on the Job Options tab) as the PDF's FormName in the PDI, instead of the incoming PDF/VT document's dc.title meta data tag. If the Title is empty, a warning is logged and the FormName is not changed.
PAGE 519

l l l l 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. Note that if you use a data selection in this box, you must be sure that the data that will be selected at run-time will not contain any parentheses, as this would cause the task to fail.
PAGE 520

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. The Grayscale 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 shades in each sample area and to replace the entire area with a pixel of the average shade.
PAGE 521

l 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. l Allow changing the document: Select to let users edit the generated PDF files. l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files.
PAGE 522

choose a percentage of the actual document size. l Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty. Select Bookmarks and page to display the contents of the Bookmarks tab (you use data selection objects to create bookmarks in PReS) alongside the PDF pages.
PAGE 523

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). l Password: Enter the password required to access the database. l Test Connection: Click to verify that PReSImage can connect to the specified database. l Enforce global table creation: Select this option, as it ensures that all database users are granted access to the database.
PAGE 524

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. If the PReS Classic job selected is an uncompiled PReS Classic script (PDS), it will first be compiled on the fly and then run using the selected data file.
PAGE 525

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; see "Variable task properties" on page 304. 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 526

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 l Log level: Specifies the verboseness of messages returned by job processing.
PAGE 527

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 528

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. PrintShop Mail 7 can also output PDF/VT and PPML/VDX. Note that the Preflight output type doesn't actually produce printable or viewable output. The Preflight option does a cursory verification of the job and will generate an XML file that contains a list of all warnings and errors.
PAGE 529

l l l l l l l 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. Windows Printer: Select the print driver of the printer to which you want the print job to be sent. This option is only available when Direct to Printer/Windows PostScript driver is selected in the Output type box.
PAGE 530

For general information on the Plugin, see "ZUGFeRD" on page 758. Input A PDF file that is PDF/A compliant. The PDF/A conformity level doesn't matter. It may be 1, 2 or 3. Processing The plugin first checks that the PDF is PDF/A compliant, and doesn't already contain ZUGFeRD data. If it is, then the PDF is processed. Output A PDF/A-3 file with the selected ZUGFeRD data included.
PAGE 531

l l Workflow Jobdatei: Use the incoming Workflow Job File. Datei: Specify a specific PDF. Use the browse button the file path and name into the edit box. to select a file, or paste The file path and name can be given and defined via variables, so the file selection can be dynamic. Note The PDF selected must already be PDF/A compliant. The conformity level doesn't matter (it may be 1, 2 or 3).
PAGE 532

Any other formatting will lead to a run-time error. l Lieferant group contains all the required values and information related to the seller, delivery and/or the invoicing party. l l l Name: The individual or company name. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Adresse: The postal address (sans post code and city entries). Two address lines can be included in this entry.
PAGE 533

Note The plugin does not check if a given country code is in the list of valid country codes. It is the responsibility of the user to ensure that only valid country codes are entered. This field can be set via Workflow data and/or variables. l l Art der Steuernummer: The two letter code for the tax identity number. Select from the drop down list box. The choices are either "VA" (Umsatzsteueridentifikationsnummer (UStID)) or "FC" (Steuernummer (national)).
PAGE 534

Note No postal code validation is done by the plugin, so it is up to the user to make sure that the postal code entry is valid and in the correct format for the indicated country. This field can be set via Workflow data and/or variables. l l Ort: The postal address city/town. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Ländercode: A 2-letter country code as defined by the industry standard ISO 31661 alpha-2.
PAGE 535

l Zahlungsinformationen group contains payment related information. l l Zahlungsreferenz: The payment reference, purpose, or payment number serving as identifier for the payment. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Währung: This is a 3-letter currency code, as defined in the ISO 4217 3A standard. The plugin offers some predefined common currency codes in the pull down list box. Other codes can be entered manually or via variables.
PAGE 536

standard), a 2-character (letter or digits) location code and an optional 3-character (letter or digits) branch code. Note The plugin does not validate bank IBAN/BIC codes. It is the responsibility of the user to ensure that valid codes are entered. This field can be set via Workflow data and/or variables. l Allgemeine steuerliche Informationen group contains taxation related general information. l Steuerart: The trade tax code following the international UNCL 5153 standard.
PAGE 537

l Detaillierte steuerliche Informationen group contains detailed taxation information. l l l l l l Gesamtbetrag der Positionen: The total amount. This entry should be a numeric currency entry, which can be set via Workflow data and/or variables. Bruttosumme: The grand total amount. This entry should be a numeric currency entry, which can be set via Workflow data and/or variables. Gesamtbetrag der Zuschläge: The charge amount.
PAGE 538

PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Suite Production. It is not available in older versions, nor is it available in the Office and Watch versions of PlanetPress Suite. PlanetPress Capture is not compatible with OL Connect Designer templates. PlanetPress Capture is a set of tools available in PReS Workflow that enable output and input for interaction with an Anoto Digital Pen.
PAGE 539

page 546 or "Find Capture Documents" on page 552 task. However, it is also possible to directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and Metadata are completely ignored by this task's condition rules, and the database information is used instead. Processing The condition is evaluated using the specified rules, combination (condition is true when...) and scope (condition scope).
PAGE 540

l l l l Document is empty: Condition will be true if the document is open but no Capture Field is filled. Document is on error: Condition will be true if a logical error was triggered while processing the PGC. 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.
PAGE 541

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 542

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. Operators are available for the comparison (such as Equal, Not Equal, Lower or Higher Than, Contains and etc).
PAGE 543

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Capture Fields Generator The Capture Fields Generator action task is used to generate Capture patterns in your job, which will then be printed for use with an Anoto Digital Pen. It also interacts with the Capture database and does some operations.
PAGE 544

If using the Metadata Sequencer it is generally recommended to place the Sequencer and the Capture Fields Generator tasks within a branch and, within the Capture Field Generator's On Error properties tab, to set it to stop the branch if any errors occur. This is to ensure that if such an error occurs most of your document sequences will get generated and you will not have to start the job over from the beginning.
PAGE 545

l Document Title group: Determines a Title for the document. This title is accessible in the Capture Database and can be used to search for a document or retrieve a list of document using other tasks. l l l l l l Custom: Use the title in the input field as set by the user. The field is variable so the title can be set on a per-document basis using data or metadata selections.
PAGE 546

CN1595440, SE517445, RU2256225, and AU773011. Capture Fields Processor The Capture Fields Processor action task is used to update the Capture database using information received from an incoming PGC file, which generally originates from a communication by the Anoto penDirector.
PAGE 547

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. The inks that are relevant to logical errors are still added to the PDF document, but they are added on a separate "error" layer.
PAGE 548

l Page Level: l CaptureField: Information on each capture field on the page. Repeated for each capture field that is present. Note There is no method of obtaining the information from a PGC except through a successful processing of this task, or via the use of the PlanetPress Capture API within a Script (see "Using Scripts" on page 141).
PAGE 549

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. When out of bounds ink is found, the document will be set in the "Error" status.
PAGE 550

Splitter will cause your process to take more time, since each PGC must pass through the Capture Fields Processor and then the Get Capture Document task. Note Due to the fact that the Capture PGC Splitter task modifies the original PGC, in some cases the legality of the PGC signature may be compromised. This depends on your country or region's laws, so if your implementation of Capture requires signatures to be authenticated please consult a legal advisor for more details.
PAGE 551

l l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the pattern sequence to be used. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 552

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. Task 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 553

panel. This task is put into effect in the following use cases and example processes: l Capture Post Processing Workflow l Capture Web Manager Workflow Input Because this task in an Input task, it does not use the current job file in your process, even when used as a secondary input task. Processing This task connects to the Capture database and looks up all available documents that meet the criteria specified in the plugin.
PAGE 554

l Condition Grid: Displays the list of current condition criteria that were set for document retrieval. l Filter: The selected filter type. This can be any of the following: l l l l l l l l l l Document Name: The name of the document, as specified in the Document Name property of the "Capture Fields Generator" on page 543. Date Generated: The date, in YYYY-MM-DD format, when the document was generated through the Capture Field Generator.
PAGE 555

l l l l l l l l l l l l l l Less Than: Numerical comparison, where anything lower than the specified value is included. Greater Than: Numerical comparison, where anything higher than the specified value is included. Less than or equal to: Numerical comparison, where anything lower or equal to than the specified value is included. Greater than or equal to: Numerical comparison, where anything higher or equal to than the specified value is included.
PAGE 556

l Create Advanced Data File: Click to retrieve additional information about each document in the result list. These information include each field, the presence of ink on each of them, time stamps, etc. Please refer to Find Capture Document for an example of the XML file. Warning The Advanced Data File option will generate a high number of queries into the Capture Database, and will be slower than a regular data file by orders of magnitude.
PAGE 557

Processing One PDF, corresponding to the information present either in the Metadata or specified in the task, is extracted from the Capture database. When retrieving documents from the database, the PDF from which the document is obtained will remain in the database until each document contained in it is retrieved from it. For example, if a 10-page PDF contains 5 documents, the 10 pages remain in that PDF until all 5 documents have received ink, been closed and retrieved from the database.
PAGE 558

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

Note When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False. This task is put into effect in the following use cases and example processes: l PlanetPress Capture Workflow Input A PGC file received from an Anoto digital pen.
PAGE 560

Properties... Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata tasks Metadata tasks are plugins that can create or edit metadata for a job file. For more information about the metadata structure and elements, see "Metadata" on page 75.
PAGE 561

l "Example: Daily sales report from PDF files" on page 289 l Basic Functional Capture Workflow l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Input A data file in any supported emulation (see "About data emulation" on page 60).
PAGE 562

Task properties General Tab l l Documents: Select the Do not use a document (passthrough) option to create Metadata based on the data file alone. Alternatively, as a PlanetPress Suite user you can select a specific PlanetPress Design document to be merged with the data file. Only the Metadata generated by this merge will be retrieved.
PAGE 563

If the Extract option is used, Metadata present inside of the PDF file is extracted from it. If no Metadata is embedded, the task generates an error: W3976. Output The PDF file with embedded Metadata (the Metadata is not deleted from the PDF File on extraction, so this task will always output a PDF with embedded Metadata).
PAGE 564

Input Any data file with accompanying Metadata. Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties. If the field is present in a level that repeats (for example, the data page level), this task loops so that the action may take place on each of the occurrences of that level. Updating all nodes For a given Metadata Field Management action, all nodes of a given level might be updated with a New Field value.
PAGE 565

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. Sum: Calculate the sum of all values found in all fields of a given name, at a given level. The resulting number is formatted by default with the dot decimal separator.
PAGE 566

l l ,: Treat every value with the comma (",") decimal separator. Dots (".") are treated as thousand separator. Rule: Define criteria for the Metadata Field Management action execution. The condition must be TRUE for the action to execute. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action. See the "Rule Interface" on page 869 page for more details. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 567

Properties l Chose an action group l l l l l Load metadata file: Loads an external Metadata file that was previously saved. This can be useful in Error processes if you have previously saved the Metadata to file (ErrorBin outputs do not transfer Metadata). Save the current metadata file: Saves the current Metadata to a specified location. Useful as a backup or for use in Error processes. Delete the current metadata file: Removes the active Metadata from the process.
PAGE 568

Processing Any Metadata that does not correspond to the rules set forth by the filter are removed from the active Metadata. Note that the 'removed' Metadata is still present in the file, but is unselected: they are disabled and ignored on all tasks that use Metadata afterward (except the Metadata Sorter task). Output The original data file is output, along with the modified Metadata. Task properties General Tab l Filter levels: Rules for deselecting nodes at the Group, Document or Data page level.
PAGE 569

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. Filter rules cannot be based on the following metadata attributes: SelectedIndexInJob, SelectedIndexInGroup, SelectedIndexInDocument and SelectedIndex. Metadata Level Creation The Metadata Level Creation task conditionally creates new Metadata groups or documents.
PAGE 570

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. Metadata Sequencer: Splits the data file on each Metadata document node level.
PAGE 571

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. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action.
PAGE 572

Output The original data file is output once per chunk, along with this chunk's metadata. Note that all the Metadata is in each of the sequence, but anything not part of the sequence is disabled and is ignored by all tasks using Metadata afterwards. Task properties General Tab l Metadata level: Select the Metadata level to process.
PAGE 573

Processing The order of the Metadata is changed in accordance with the rules set forth in the task's properties. The Metadata Sorter task works on all nodes, regardless of their selected state. 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).
PAGE 574

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata to PDI The Metadata to PDI task takes the active metadata and generates a PDI using the information in that metadata. It is generally used in conjunction with a PDF data file and is used to generate the PDI file which is used by PReS Search when building, refreshing or rebuilding its database. For more information about Metadata see "Metadata" on page 75.
PAGE 575

l Index Group: l l PDI: Only generate a PDI file. PDI and XML: Generate both the PDI and an XML equivalent (not used by PReS Search). Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata-Based N-Up The Metadata-based N-Up action task works in conjunction with the PlanetPress Design tool's N-Up functionality.
PAGE 576

Also see Output Creation Preset and Print Options in Connect's Online Help. Input Any data file with accompanying Metadata. Processing The Metadata is re-arranged and/or duplicated in order to correspond to the options set forth in this task's properties. Output The original data file is output, along with the modified Metadata. Task properties General Tab l l Number of virtual pages that appear on each physical page: This is equivalent to the N in N-Up.
PAGE 577

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 578

Note The Get Data plugin gets data from the OL Connect Send database which means it only works when Connect is in LICENSED mode. 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.
PAGE 579

Example 1 A valid user name search string, entered in the Filter Users field, would be: %\{global.User};helen;%1;george napier 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.
PAGE 580

and minute is a colon) It is possible to define the same date for From Date/Time as for To Date/Time. However, entering the same info (without time information) would lead to getting no entries.
PAGE 581

Returned information For each job received by the OL Connect Send Job Processor plugin the following values will be available. l l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Status ID: The status ID shows in which stage the job currently is: 0 = undefined; 1 = idle; 2 = transfer; 3 = chunk; 4 = concatenate; 5 = unzip; 6 = done. A value of 6 indicates a fully processed job. Any value between 2 and 5 (inclusive) means that the job is still in progress.
PAGE 582

l l l l l l Original file name: This is the "file name" as sent from the application to the Windows spooling system. It is taken from the name as it arrives in the spooler. Some applications add info to the name (like Notepad++) while others don’t (like Adobe Reader). OL Connect Send can only use what it gets from the spooler. It does not interact with the applications itself. Original file size: The size of the print job - NOT the size of the document file.
PAGE 583

OL Connect Send Job Processor plugin, it creates a unique ID string composed of 10 upperand lowercase letters and digits e.g. “ri0zZdluLp”. This Unique Job ID is used in any communication between the Printer Driver and the plugin and is the leading identification element for this particular job. All job related information is stored in the underlying database and linked together by this Unique Job ID.
PAGE 584

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. l l Immediately: By choosing this option, the Get Job Data plugin will return as quickly as it can, providing it can find a matching Job ID in the database. It is important to know that it will wait until any information about the job is available.
PAGE 585

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

logged on users vs. application running users, machine names etc. please refer to the respective Windows help pages or ask your system administrator. l l l Domain / Workgroup Indicator: Indicates whether the field "Domain (workgroup) name" is a domain name or a workgroup name. The possible values are 0 (false) for a workgroup, or 1 (true) for a domain. Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API.
PAGE 587

possible. Processing The Job Processor plugin receives a compressed PostScript file sent by the OL Connect Send Printer Driver and communicates with the Printer Driver to ensure that all data has been received correctly. If the Printer Driver has split the job into multiple chunks, the plugin combines the chunks into one PostScript file. License mode Each incoming print job is checked against the license to determine if it can be handled in licensed mode or in unlicensed mode.
PAGE 588

HTTPS Communication The OL Connect Send Printer Driver can be set to use HTTPS for any job transfer. To do this, Workflow must also be set to use HTTPS. Job Origin Each print job will include unique information about the machine it has been sent from. This unique machine ID is calculated with a proven method and will be transferred, encrypted and enhanced. The enhancement will result in a different encrypted machine ID per print job, so that spoofing can be detected.
PAGE 589

Metadata In addition to the print job, the plugin creates a metadata file with basic information. The values originate from the client machine. In unlicensed mode, the user name, machine name and domain/workgroup name will not be available through the metadata. Properties General tab l Data Output l Output Folder: Enter the target folder for the incoming print jobs. l Output File Name: Enter the file name for the incoming print jobs.
PAGE 590

Information Workflow Variable When licensed When unlicensed Username 1 %3 The user name "na" IP Address 1 %4 The IP address The IP address No. of Pages 1 %5 Number of pages of the job Number of pages of the job No. of Copies 1 %6 Number of copies set by the user Number of copies set by the user Domain Name 1 %7 The Domain Name "na" Machine Name 1 %8 The Machine Name "na" 1) These values originate from the Printer Driver machine.
PAGE 591

OL Connect tasks OL Connect tasks are available in PReS Workflow 8.0 and up. They are used specifically to communicate with the Server component of PlanetPress Connect or PReS Connect and for such purposes as creating record sets, generating contents and generating output. For more information about the Workflow processes in which these tasks are used, see the Connect Online Help.
PAGE 592

This task is a combination of the 4 different OL Connect tasks that are normally used in conjunction to generate Print output: "Execute Data Mapping" on page 627, "Create Print Content" on page 616, "Create Job" on page 604, and "Create Output" on page 607. Combining them in a single task makes creating Print content easier and faster, as the task is optimized for this specific purpose.
PAGE 593

l l l "%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. Right-click it to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53). Configuration Names: Select the appropriate data mapping configuration. Adding configurations is done through the Send to Workflow option in the DataMapper Module.
PAGE 594

runtime parameters that may occur in the data mapping configuration. If a runtime parameter is defined in a data mapper configuration, but not set in the task properties, an error will be raised. Note Backslashes (\) and double quotes (") in a JSON string must be escaped with a backslash (\\, \") if the JSON string is passed via a global, local, or Job Info variable. If the JSON is entered directly in the runtime parameter field, the plugin adds the necessary backslashes.
PAGE 595

l l Rule Viewer: Displays a text-based view of the condition using operators and parentheses. Sort contents: Defines how records are sorted. l l l Sort items based on: Displays the current sorting method. To modify the sorting method, click on the [...] button at the right of the box to open the "Sort Parameters" on page 599 dialog.
PAGE 596

contains the name) and set the value of all runtime parameters that may occur in the template. If a runtime parameter is defined in a template, but not set in the task properties, an error will be raised. Note that it is not possible to change a parameter's type here; that can only be set in the template itself. At runtime, Workflow passes the parameter values as strings, and the type defined in the template will be used to try and parse the input parameter value.
PAGE 597

the list below. l l Preset Names: Select the appropriate Job Preset file. Listed are the Job Presets that are present in the Connect Resources (see "Connect resources" on page 39). Runtime Parameters: The Runtime Parameters defined in the selected Job Creation Preset are displayed and their values can be edited here. Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53).
PAGE 598

l Output Preset: Select the appropriate Output Creation Preset to use: l l l l "%o": Select to use a dynamic Output Preset name. Click on %o to change the expression that determines the name of the Preset to use. Preset Name: Select the appropriate Output Preset to create output with. Listed are the Output Presets that are present in the Connect Resources (see "Connect resources" on page 39). Output Management group: l l l "None": Select to prevent the execution of Output Creation.
PAGE 599

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. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 600

Create Email Content The Create Email Content task generates a set of email content items from a template's Email Context, which are then sent directly to the recipient set in each record.
PAGE 601

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. Note Content creation may be aborted by a script in a Connect template that raises a fatal error. This triggers the On Error tab of the Content Creation task. See Designer Script API.
PAGE 602

l Data Source (see "Input" on page 600): l Metadata: l l Update Records from Metadata: If the process metadata has been modified by any of the "Metadata tasks" on page 560, check this option to update the records in the Connect database with the metadata and use the updated records. Otherwise, only the ID of the current job is sent, and the unchanged records are used.
PAGE 603

work: Boolean values need to be entered as either “true” or “false”. (When the comparison actually occurs, it will be a full Boolean comparison. Thus it can compare this runtime parameter with Boolean data values that are stored as 0/1 in data fields.) Numeric string values need to be parseable as a number (either a whole integer or decimal value). Dates should be in an ISO8601 compatible format (e.g. 2019-10-15) or use the current Windows Locale date settings options.
PAGE 604

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 preferences" on page 784. 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 605

For information about Job Creation Presets, see Job Creation Preset in Connect's Online Help. Input The task expects to have a valid Print Content Set, output from the "Create Print Content" on page 616 task, or the result of the "Retrieve Items" on page 645 task set to retrieve either Content Items or a Content Set. Note The result of a Retrieve Items task cannot be used with a Job Creation Preset. Use the IDs in the metadata instead (see the Properties below).
PAGE 606

l l l Preset Names: Select the appropriate preset to generate output. Listed are the Job Presets that are present in the Connect Resources (see "Connect resources" on page 39). Unselect unused Content Items in metadata: When this option is checked, only Content Items that were actually included in the Job are set to "selected" in the Metadata (see "Metadata" on page 75).
PAGE 607

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. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 608

Tip Drag-and-drop an Output Creation Preset from the "Connect resources" on page 39 in the Configuration Components pane on a process to add this task . For more information about Output Creation Preset files see Output Creation Preset in Connect's Online Help. Input The task requires a valid Job Metadata file, normally output from a "Create Job" on page 604 or "Merge Jobs" on page 637 task. Processing The job is sent to the OL Connect Server for processing.
PAGE 609

l Output Management group: l l l As defined by Output Preset: Select to send the output of the job to the location set in the Print Preset (file, printer, etc). Through Workflow: Select to replace the current job file with the output produced by the server. Every option in the Output Preset is still used, except for the output location.
PAGE 610

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create PDF/VT The Create PDF/VT, similar to the "Create PDF" on page 398 task, creates PDF/VT files from a PlanetPress Suite Document (created with PlanetPress Design). This PDF/VT is compatible with the "Create Print Content" on page 616 task directly without the use of a Connect Template (PDF/VT mode). Input Any data file supported by the selected PlanetPress Document.
PAGE 611

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 612

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

l JSON string sets the data source to a JSON string (see "Working with JSON" on page 90). A text area is shown allowing the user to enter the JSON string. The JSON string may contain local and global variables, Job Infos and data selections (see "JSON string examples" on page 91). A single variable can be used, assuming that the respective variable contains a JSON string. In case the JSON string is not a valid JSON object, the plugin will error out with an explicit message.
PAGE 614

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. A template name: Select the appropriate template name from the list. Adding templates to this list is done from the Send to Workflow option in the Designer module. A preview will be displayed of the output generated by the Print context of the selected template. (Not available for a dynamic template name).
PAGE 615

Note Backslashes (\) and double quotes (") in a JSON string must be escaped with a backslash (\\, \") if the JSON string is passed via a global, local, or Job Info variable. If the JSON is entered directly in the runtime parameter field, the plugin adds the necessary backslashes. Note It is not currently possible to specify Runtime parameters on the Content Creation tab if, on the Datamapper tab, the source has been set to "Data mapping configuration".
PAGE 616

Create Print Content The Create Print Content task generates a set of printable content items from a template's Print Context, and saves those content items in the database until output creation is requested. This task also accepts a PDF/VT file as input (see "Create PDF/VT" on page 610), allowing the task to be used without a Connect Template.
PAGE 617

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 604 plugin (the next task in a print process) cannot use a Job Creation Preset. The Create Print Content task doesn't create a record set based on the provided data, like the "Execute Data Mapping" on page 627 task does.
PAGE 618

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 619

of OL Connect.) Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53). If the template name is dynamic, you must enter the name (or select a variable that contains the name) and set the value of all runtime parameters that may occur in the template. If a runtime parameter is defined in a template, but not set in the task properties, an error will be raised.
PAGE 620

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 Web 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" on page 280.
PAGE 621

"JSON string examples" on page 91. l A JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 93). When the "Execute Data Mapping" on page 627 or "Retrieve Items" on page 645 task is set to output Records in JSON, it outputs this kind of JSON data. If the input is JSON data, the task makes a call to the REST workflow/contentcreation/html/ {templateId} endpoint on the Connect Server. For more information see the REST API Cookbook.
PAGE 622

l l l Template Names: Select the appropriate template. Adding template is done through the Send to Workflow option in the Designer Module. Section: Enter the section name that will generate output. Only one section can be output. If no section is defined or if the section name is invalid, the default section will be output. Data Source (see "Input" on page 620): l Record ID: l l l Enter a valid Record ID, or 0 to provide no data. The record must be valid for the template used.
PAGE 623

Note Only the first record or JSON object is processed, since this task can only generate HTML output for a single record. l l Embed all resources: Check this option to download the resources and embed them in the HTML file. Do not alter HTML: Check this option to prevent that the Create Web Content task modifies the HTML. It is recommended to use this option if the template's resources are all hosted outside of the template (for instance, on a CMS repository).
PAGE 624

be set in the template itself. At runtime, Workflow passes the parameter values as strings, and the type defined in the template will be used to try and parse the input parameter value. In order to make this work: Boolean values need to be entered as either “true” or “false”. (When the comparison actually occurs, it will be a full Boolean comparison. Thus it can compare this runtime parameter with Boolean data values that are stored as 0/1 in data fields.
PAGE 625

Download EML Messages The Download EML Messages task downloads one EML file from the Connect File Store. Saving EML messages in the File Store is an option in the "Render Email Content" on page 640 task. EML files can be stored in an ERP/ECM system for archiving purposes. Use the "Metadata Sequencer" on page 571 plugin, followed by the Download EML Messages plugin and the "Send to Folder" on page 440 plugin, to download multiple EML files and save them to disk.
PAGE 626

Storing EML messages in the File Store is an option in "Render Email Content" on page 640 task. That task outputs information about the email messages that it pre-rendered either in the current Metadata or in the form of a JSON structure. The Download EML Messages task expects UTF-8 encoded JSON job data files. Note Make sure that other components in the Workflow configuration working on the job data handle UTF-8 encoded files correctly.
PAGE 627

Note Information about the Connect Server (host, user name etc.) is taken from the Workflow Preferences (see "OL Connect preferences" on page 784). Advanced Properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 628

Note To open a Microsoft Access database, you have to use the Load External File task just before the Execute Data Mapping task. Note AFP input is dependent on a third party library (CDP), which only allows PReS Connect to run up to 4 AFP input processes on a given machine at a given time. Processing The task executes the selected data mapping configuration on the appropriate data source, or converts the PDF/VT into a Record Set directly.
PAGE 629

l l l l "None": Select to execute default, basic data mapping on the input PDF/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. Right-click it to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53). Configuration Names: Select the appropriate data mapping configuration.
PAGE 630

l l index: The position of the record in the job. This value is 1-based. Note that this is not a record ID, since the record is never stored in the database. error: The error message, or an empty string when no errors have been reported for this record. Document nodes with an error are selected, while those without an error are unselected, to make looping through all errors easy.
PAGE 631

Note Backslashes (\) and double quotes (") in a JSON string must be escaped with a backslash (\\, \") if the JSON string is passed via a global, local, or Job Info variable. If the JSON is entered directly in the runtime parameter field, the plugin adds the necessary backslashes. 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 preferences" on page 784.
PAGE 632

Input The task requires either the name of the file in the OL Connect File Store or its File Store ID. The name of a file is chosen and its File Store ID is returned when uploading it with the "File Store - Upload File" on page 634 task. Processing The task requests removal of the file by performing a call to the /rest/serverengine/filestore/delete/{fileId} REST endpoint; see File Store Service: Delete File in the REST API Cookbook. Output This task has no impact on the current Job File.
PAGE 633

Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Store - Download File The File Store - Download File task downloads a file from the OL Connect File Store, using either a file name or File Store ID. Input The task requires either the name of the file in the OL Connect File Store or its File Store ID.
PAGE 634

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. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 635

Task properties General Tab l l l Filename: Enter the file name or a JobInfo, local or global variable that contains the file name, to use when saving the file in the OL Connect File Store. The default is %f, the name of the job file. Right-click the field to select another variable. When you specify %o as the file name, the file in the OL Connect File Store will have the same name as the original file.
PAGE 636

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

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 preferences" on page 784. 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 638

Output The task outputs a merged Metadata Job File which can be used in the "Create Output" on page 607 task. Task properties General Tab l Metadata file: Enter the full path to a valid Metadata file containing an OL Connect Job, or use the Browse button to browse to a valid location. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 639

Note As of OL Connect version 2020.2 the PDF to Bitmap plugin requires the OL Connect Server to produce output. This could cause problems when running older configurations. To cure such issues, set the Connect Server connection settings within Workflow (see "OL Connect preferences" on page 784). Output This task outputs the PDF file it received with no modification. Properties The General tab has the following options: l l l Output format: The output format can be either PNG or JPG.
PAGE 640

OL Connect Proxy Tab l Server Connect Settings l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340. User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 641

Input This task must receive either Metadata containing information regarding a valid Record Set, or JSON data. Metadata The "Execute Data Mapping" on page 627 task and the "Retrieve Items" on page 645 task output Metadata containing information regarding a Record Set. Note The plugin takes the entire Metadata file as its input, even when it is placed after a "Metadata Sequencer" on page 571 task.
PAGE 642

Note Make sure that other components in the Workflow configuration working on the job data handle UTF-8 encoded files correctly. 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, the task generates an HTML email using that record's or object's data. Note Content creation may be aborted by a script in a Connect template that raises a fatal error. This triggers the On Error tab of the Content Creation task.
PAGE 643

{"attachments":[ {"name":"att0307c655-e14e-4400-8f90365032648aed.png","disposition":"inline"}, {"name":"myPDF.pdf","disposition":"attachment"}, ], "subject":"Take action now", "to":"recipient@gmail.com", "from":"sender@yourdomain.com", "folder":8768, "eml":"c5f97db0-45ca-4f1d-be4d-473d000c92bd.eml", "body":"07decd87-d03c-4969-bc2a-7527cc594878.html", "text":"7a4e5217-0103-487f-a4f8-77d37d0c1087.
PAGE 644

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. l Output Method (see "Output" on page 642): Select how to output information about the emails that were created, including the email addresses (to, from, etc.
PAGE 645

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 (see "Metadata" on page 75) or JSON data used in multiple tasks.
PAGE 646

Task properties General Tab l Entity to retrieve: Use the drop-down to select which items to retrieve. l l l l l l l Record Set: Retrieves one or more Record Sets, including all their records. Output similar to the "Execute Data Mapping" on page 627 task. Content Item: Retrieves one or more Content Items, whether or not they are part of a Content Set. Output similar to the "Create Print Content" on page 616 or "Create Web Content" on page 620 tasks.
PAGE 647

l l l l l Clear the rule: Click to delete all rules in the list. Note: This cannot be undone. Import a rule: Click to open the Browse dialog and load a Rules file. This will load its rules into the list. Export the rule: Click to open a Save dialog and save the Rules file to disk. Rule Viewer: Displays a text-based view of the condition using operators and parentheses. Output Type group: l l l Metadata - IDs only: Select to only output minimal metadata containing the entity IDs.
PAGE 648

l Sort items based on: Use the [...] to open the "Sort Parameters" on page 599 dialog and define how documents are sorted within the group, for example by Zip Code. 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 preferences" on page 784. Note Defaults are not used unless the configuration is sent to the Workflow service.
PAGE 649

l Remove: Click to remove the currently selected line in the list. 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 (see "Metadata" on page 75). Metadata must be loaded in "The Data Selector" on page 852 or through the use of the Debugging feature.
PAGE 650

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 651

Each of the OL Connect Content Creation tasks can do the same, if the Update Records from Metadata option is enabled for that task. The Update Data Records task can be useful when data needs to be updated multiple times before actually generating content, for instance when Postal Address Cleansing and Sorting is a two-pass process. Input The current Job File is not used by this task.
PAGE 652

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. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 653

Action task, for example, PReS Workflow will consider the task completed only once the image file has actually been created. This means that no other task from the same process can be performed in the meantime. For more information on those tasks, refer to "Action tasks" on page 381. Send to Folder tasks, which are considered as Action and Output tasks, are documented in the current chapter.
PAGE 654

Note that Capture can only be used with PlanetPress Suite. Input Any data file, with optional metadata. Processing The data file is either deleted directly or sent to the Windows Recycle Bin. Task properties General tab l Move to recycle bin: Select to send the deleted files to the Windows recycle bin. When this option is not selected, files are deleted permanently. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 655

Task 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 656

Microsoft 365 Email Output The Microsoft 365 Email Output task can send emails on behalf of any user in an organization's Microsoft 365 accounts, without having to specify that user's credentials. This way privacy is maintained while allowing a process to send email messages and attachments on behalf of any user. The task communicates through HTTPS. However, the real protection scheme (like certificates) is configured in Azure Active Directory by the IT administrators.
PAGE 657

Note The MS Graph REST API is limited to a certain number of requests within a certain period of time. This is called throttling. When throttling comes into play, the plugin receives HTTP response 429. The plugin will log the error and retry, but it exits with an error after 15 unsuccessful attempts. Output This task doesn't have any output other than the email that is sent to the recipient(s).
PAGE 658

code is entered or pasted in this box, percent (%) and slash (/) HTML characters must be doubled, otherwise they will be disregarded. Note Different email clients have different support for various features, especially with HTML emails (see HTML Email challenges in the PReS Connect Online Help). 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.
PAGE 659

l l Tenant ID: Enter the Tenant ID as specified in Azure. This value is static and cannot contain variables. User ID: This is the user's ID or email address. This value is dynamic and may include variables. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 660

When a communication error occurs while uploading a file to OneDrive, some temporary "~." files may remain on the server; however, these files will eventually be cleaned up automatically. Note The MS Graph REST API is limited to a certain number of requests within a certain period of time. This is called throttling. When throttling comes into play, the plugin receives HTTP response 429. The plugin will log the error and retry, but it exits with an error after 15 unsuccessful attempts.
PAGE 661

Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SFTP Output The SFTP Output task sends job files to other computers using a secured FTP protocol.
PAGE 662

l l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH). l FTPS: Select if the FTP server uses FTPS (SSL/TSL) Port Number Group l l l Password: If the account named in the User name box is password protected, enter the password here. Use default port: Check to use the default port used by the protocol selected above. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available.
PAGE 663

l l Server: The name of the server the certificate belongs to. l Fingerprint: The RSA fingerprint of the server. l Approve: Click to add the server to the list of approved servers. Refresh: Click to refresh the list of known servers Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 664

In the case of "string" type data, SOAP Client plugin tasks normalize all line endings to a single line feed character. Task 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).
PAGE 665

as change their order if needed. l l l l 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). Note that return values (arguments which are used to return information to the SOAP Client) are displayed in bold font. Namespace: Displays the namespace of the arguments associated with the selected method.
PAGE 666

The Print Using a Windows Driver Output task requires a PReS Workflow license, otherwise this plugin will cause a watermark. Note This type of output task does not support PDF transparency and duo-tone features, so you should not use it with PlanetPress Design documents that use those features. Input This task can accept either a data file with a correct emulation (see "About data emulation" on page 60), which is then merged to a PlanetPress Design document, or a PDF file which is to be printed natively.
PAGE 667

Note This option is not functional when natively printing PDFs (without a PlanetPress Design document). l Documents: Select a specific PlanetPress Design document if you want all the jobs to be printed with that document. l l Natively print PDF file: This special option can be used if your job file is a PDF. The job will .
PAGE 668

You can select multiple Printer Queues in a Printer Queue Output task and choose exactly how your jobs will be dispatched to the selected printers. The task can create print output as well, by merging the data file with a PlanetPress Design document (see "PlanetPress Design documents" on page 44). This requires at least one PlanetPress Design document to be associated with a Workflow printer queue (see "Associating PlanetPress Design documents and PReS printer queues" on page 120).
PAGE 669

chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections. To enable the dynamic document name box, click inside it. To disable it, press Enter. Note that in the later case, you must be certain that the documents that will be chosen at run-time will in fact be available locally or at all the selected printer. Note that PReS Workflow will not specify a given document version number, so the latest version will be used by default.
PAGE 670

l l l l l Round robin: Round robin means that complete jobs will be sent in turn to each one of the selected Workflow printer queues. For example, Queue_1 will get the first job, Queue_2 will get the second job, and so forth. Page delimiter group: These options are enabled when you choose Split job or Queue balancing load balancing options. They are used to determine how each job is to be split before being sent to the Workflow printer queues.
PAGE 671

Secure Email Output The Secure Email Output task sends SMTP email messages with SSL (2.0, 2.3 or 3.0) or TLS (1.0, 1.1 or 1.2) encryption. Note that this plugin cannot be used on a Windows instance that uses a multi-byte language (e.g. Japanese, Chinese). The workaround is to either use a different Windows language or use the standard Email Input/Output plugins. Also note that this task doesn't merge data records with a PReS Connect template, like the "Create Email Content" on page 600 task does.
PAGE 672

Note When specifying multiple recipients for the To, CC and BCC fields, separate the e-mail addresses with semi-colons (;). l To: Enter the email address(es) of the recipient(s). l Cc: Specify addresses to which a copy of the generated emails are to be sent. l l l Bcc: Specify discreet addresses (other recipients will not be able to see these addresses) to which a copy of the generated emails are to be sent. Subject: Enter the subject of the email.
PAGE 673

l l l l Attach input job file: Select to attach the current job file to the email that the task sends. Rename to: Check this option to rename the job file before attaching it to the email, and enter a name. You may use text, variables and data selections (see "Variable task properties" on page 304). File: Select additional or more additional files to include as attachments. You may enter the file name directly and use text, variables and data selections (see "Variable task properties" on page 304).
PAGE 674

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

see "Variable task properties" on page 304. l l l l Cc: Specify addresses to which a copy of the generated emails are to be sent. Bcc: Specify discreet addresses (other recipients will not be able to see these addresses) to which a copy of the generated emails are to be sent. Subject: Enter the subject of the emails generated by PReS Image for this task.
PAGE 676

l l l l l Attach: Lists the files that will be attached to the messages sent from PReS Workflow for this task. Selecting the Attach output file(s) option adds these files at the top of the list. Any other file that may have been added using the File box (above) is also listed here. Zip mode: Select how you want the files checked in the Attach box to be zipped. Select Zip individually to have PReS Workflow create a zip file for each file.
PAGE 677

l l l Server requires authentication: Select if the outgoing server mentioned above requires authentication. To use authentication you must enter information in the Account name and Password boxes below. Account name: Enter the name of the account that PReS Workflow is to use to send emails via the mail server. Password: Enter the password associated with the account name entered above. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 678

l l Concatenate files: If this option is selected, when PReS Workflow tries to save the job file under an existing name, it appends the content of the new job file to that of the existing file, instead of overwriting it. In the case of a PDF, this will act like the "Merge PDF Files" on page 343 input task, merging the PDF logically. Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected.
PAGE 679

DocuWare DocuWare is an Enterprise Content Management (ECM) system that is widely used in industry. It provides mechanism for storing, versioning and sharing files across an organization. See https://start.docuware.com/ for more details about DocuWare. The Workflow DocuWare solution is based on two plugins: l The "Connection tab" on page 681 plugin for downloading files from DocuWare server. l The "Connection tab" on page 686 plugin for uploading files to DocuWare server.
PAGE 680

Once imported, the DocuWare Download plugin will appear in the Uncategorized category within the Plug-In Bar. To be able to use this plugin you need a working DocuWare installation and user account with appropriate permissions. Input The input of this plugin can be a file of any type. Processing After establishing a connection with the DocuWare system, the plugin will try to download the specified file from the selected File Cabinet. The plugin won't modify the downloading file in any way.
PAGE 681

Task properties Connection tab The Connection tab fields set the connection parameters. You can use static text and/or Workflow variables, data and lookup functions. Right-clicking a field opens the contextual menu that allows to add variables, data and lookup functions (see "Data selections" on page 53), where available. DocuWare Server Enter the DocuWare Host address. For example https://mycompany.docuware.cloud Organization Enter registered Organization name.
PAGE 682

Test Connection This button tests the connection details entered in the Connections tab. If a successful connection is made, then Connection Success will appear as the current status. When a successful connection is made, the Cabinet and Index data for this login will be downloaded and stored locally. This allows configuring the Docuware Download plugin in Workflow configurations offline as well as online, without requiring a constant live connection.
PAGE 683

Alternatively, you can enter the File Cabinet entry directly. If the File Cabinet specified in the text box does not exist at runtime, the plugin will replace it with the first File Cabinet name on the previously extracted Cabinet list. The File Cabinet entry is case-sensitive. l Retrieve By ID / Retrieve By Search selection: Choose between these two document selection options.
PAGE 684

You can Add ( ) or Remove ( ( ) within the table. ) or down ( ) individual entries, as well as move them up At any point you can verify the accuracy of the selected Index options by selecting the Validate ( ) button. Index entries that are duplicated appear in orange text, and index entries that do not match available options appear in red. Note If more than one document is found based upon the selected search criteria, the download will fail. l Response section.
PAGE 685

Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved. DocuWare Upload The DocuWare Upload plugin uploads a single file of any file type to a dedicated DocuWare CRM system with related index information. DocuWare is organized in so called "File Cabinets", where each cabinet can have its own, specific set of index fields. This plugin allows defining of the target File Cabinet and respective index values.
PAGE 686

locally. This allows authoring of Workflow configurations without requiring a constant live connection. Warning The plugin is not designed to be run in multi-threaded, multi-process or auto-replicate environments. It has not been designed for parallellization in regards to internal resource usage, file and data access, or logged-on users. Output The output of this task is the unchanged Job File. Task properties Connection tab The Connection tab fields set the connection parameters.
PAGE 687

Password Enter the password associated with the selected DocuWare login Username. Use the password Hide/Show button to either display or obscure the password. Clicking this option will display the password. Clicking this option will obscure the displayed password. Note When the password is set via a variable, it is important to know that the password might be visible. It is the user's responsibility to protect the passwords in such cases.
PAGE 688

File to upload This frame holds all the elements on the file which is to be uploaded to DocuWare. The plugin can upload either the incoming Job file, or a file from the file system (External file). Select either: 1. Job file: Select this option to upload the current Workflow Job file (the equivalent of using %F). 2. External file: Select this option to upload a file from the file system. Selecting this option activates the file selection input field.
PAGE 689

"Data selections" on page 53, to assist with this. If the File Cabinet specified in the text box does not exist at run time, the plugin will replace it with the first File Cabinet name on the previously extracted Cabinet list. The File Cabinet entry is case-sensitive. Note Each cabinet has a default document name, which is configured in the DocuWare preferences. The current document name will be highlighted in the read only Document name field screen entry, whenever a new Cabinet is selected.
PAGE 690

l Value. Add the value to apply. You can use static text and/or Workflow variables, data and lookup functions. Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 53). Note If more than one document is found based upon the selected search criteria, the update will fail. Index Data Select whatever Index fields you want to add via this index table.
PAGE 691

l l l l Strings: String values will be uploaded to Docuware "as-is", without modifications. Strings are Unicode-aware, so that non-ASCII characters can be entered as well, like Chinese, Japanese, etc.. Numeric values: Numeric values must be entered using only digits 0-9, a preceding - or + sign and the dot as decimal separator. Any other characters are prohibited and using them will lead to an error.
PAGE 692

organization. See https://www.m-files.com for more detail about M-Files. The Workflow M-Files solution is based on two plugins: l l The "Advanced properties" on page 695 plugin for downloading files from an M-Files server. The "Advanced properties" on page 699 plugin for uploading files to an M-Files server. These plugins are not initially installed with Workflow. available for download on the (help.objectiflune.com). After downloading the .
PAGE 693

Input The input of this plugin can be any file, since it isn't used by the plugin. Processing The M-Files Download plugin starts by sending a login request to the M-Files Server. Once the connection is established, it tries to download a copy of the specified file from the Vault that it is connected to. If the search for files results in multiple files being found, then only the first file is downloaded. The downloaded file is not removed from the M-Files Server.
PAGE 694

Download Tab l Source: l l Class: Document Classes are defined (per Vault) on the M-Files server. Select the Class of the document to download from the drop-down list. Select whether to retrieve a document by ID or to search for a document by property. l Retrieve by ID: l l l l Document ID: Specify the Document ID. Version (optional): Specify the version of the document (at the root level of the Vault). If the version is not given, the latest version of the document will be retrieved.
PAGE 695

Response: Select whether to store the file name, response or document index data that the plugin gets from the M-Files server in a variable, and specify the name of the variable to use. l Response: Select which result you wish stored, and which Workflow variable is to be used to store the result. l l l Store file name in variable: Stores the name of the downloaded file in a variable. Store response in variable: Stores the success/failure response in a variable.
PAGE 696

M-Files Upload The M-Files Upload plugin uploads a single file to an M-Files system (see "M-Files" on page 691). This Action plugin is not initially installed with Workflow. It is available for download on the Resource Center (help.objectiflune.com). After downloading the .PPK file, you have to import it into Workflow; see Importing a plugin. Once installed, the plugin will appear in the Document Management category in the Plug-In Bar.
PAGE 697

determined whenever the process runs (see Variable task properties). Connection Tab The plugin needs your M-Files Server's credentials and a Vault name in order to start communicating with the M-Files Server. l l l l M-Files Server: Enter the address of the M-Files Server (e.g. https://mycloud.sample.com/m-files). Vault: Enter the name of the desired Vault. This is required. The uploaded file will be stored in this Vault.
PAGE 698

l l l Search Field: Select a property of the existing document. Properties are defined in the Metadata Structure of the respective Vault on the M-Files server. Value to be searched: Enter the value of the given property. Note that this should uniquely identify the document. When multiple documents are found, this will result in an error. Index data: Specify properties that must be set in M-Files as metadata for the uploaded file. Any existing values will be replaced with the given value.
PAGE 699

Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 700

Licensing This plugin requires the OL Connect Workflow Imaging license. Workflow Imaging is an add-on license bundle for OL Connect Workflow that includes the Image and Fax plugins; see "About PReS Image" on page 756 and "About PReS Fax" on page 755. Without a valid Imaging license, the plugin will fail with an error. In the trial version, the plugin will work.
PAGE 701

l l l l l l Document Library: The document library where you want to retrieve the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously. Folder: The folder in the document library where your files are located. You can click the Browse button to display your folder structure. In the Browse Folders dialog, click on the folder you want to use and click OK.
PAGE 702

"Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables 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 Workflow Tools working folders under the "Backup" folder.
PAGE 703

Licensing This plugin requires the OL Connect Workflow Imaging license. Workflow Imaging is an add-on license bundle for OL Connect Workflow that includes the Image and Fax plugins; see "About PReS Image" on page 756 and "About PReS Fax" on page 755. Without a valid Imaging license, the plugin will fail with an error. In the trial version, the plugin will work. Input Any data file, with optional Metadata. Processing The task connects to the selected Document store and uploads the current data file.
PAGE 704

l l Mark the document as checked in: Sets the "Checked in" property of the document on the SharePoint server. Configure Fields: Opens the Configure SharePoint Metadata Fields dialog. Configure SharePoint Metadata Fields dialog This dialog lets you setup the information you want to assign to the SharePoint Metadata information. It contains one line for each field present in the SharePoint document library. l l l l Field Name: Name of the field as set in SharePoint Document Library.
PAGE 705

Note Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PReS Workflow 7.4 and higher only. Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted. Domain: The active directory domain for the log-on credentials.
PAGE 706

Note In order to use one of these tasks, you will need to have an account that allows you to send email through the respective Email Service Provider. Mailjet Note l l The Mailjet plugin is not installed by default. It is available for download on the Resource Center (help.objectiflune.com). Make sure that the version number of Workflow and the plugin are the same, to avoid compatibility issues. To be able to send email using the Mailjet plugin, you need a Mailjet account, API key and Secret API key.
PAGE 707

function correctly. All existing instances of the plugin in Workflow processes must also be replaced by the new version. You can now find the M-Files in the PluginCategory category of the Plug-In Bar. Note No third party system resources are incorporated directly into this OL product. This means that while the plugin was tested against the associated third party systems when initially released, they may behave differently with later versions of that system. Use at your own risk.
PAGE 708

or a Connect File Store ID ("fileid"), for example: [{"fileid":100034, "disposition":"attachment"}] Optionally, you may provide a name ("name") to override the name that the plugin creates for an extra attachment. Examples: [{"fileid":100034,"name":"example.pdf","disposition":"attachment"}] [{"url":"file:///C:/Terms-andConditions.pdf","name":"terms.pdf","disposition":"attachment"}] All attachments should be combined in one array: [{"url":"file:///C:/Terms-andConditions.
PAGE 709

l l l Custom Campaign: Each e-mail going through Mailjet is attached to a campaign. Specify the campaign name here. If the campaign doesn't already exist it will be automatically created in the Mailjet system. When sending email through Mailjet's Web API it is allowed to send multiple emails with the same campaign name to the same contacts. Headers (optional): A JSON object containing one or more key/value pairs of header names and the value to substitute for them:.
PAGE 710

SendGrid Note l l The SendGrid plugin is not installed by default. It is available for download on the Resource Center (help.objectiflune.com). Make sure that the version number of Workflow and the plugin are the same, to avoid compatibility issues. To be able to send email using the SendGrid plugin, you need a SendGrid account and API key. The SendGrid plugin allows you to: l l l Tag the emails with category names, which help organize your email analytics (see About categories).
PAGE 711

All attachments should be combined in one array: [{"url":"file:///C:/Terms-andConditions.pdf","disposition":"attachment","name":"Terms.pdf"},{"name":"Take action Mandie.pdf","disposition":"attachment"}] The order of the key/value pairs is not important.
PAGE 712

encoded. Custom header names normally start with "x-". The following headers are reserved and cannot be used as custom header: x-sgid, x-sg-eid, received, dkim-signature, Content-Type, ContentTransfer-Encoding, To, From, Subject, Reply-To, CC, BCC. l Debug settings: l l Send all messages to the Test Address: When this option is checked, SendGrid will only send the emails to the given Test Address.
PAGE 713

additional plugins and re-opening the configuration will restore the plugins and their properties. l Opening a configuration that contains plugins only available in PReS Workflow (such as Create PDF) from a PReS Watch installation will cause these plugins to be replaced by Unknown tasks. Opening the configuration in a PReS Production or Office installation or upgrading PReS Watch to PReS Workflow and re-opening the configuration will restore the plugins and their properties.
PAGE 714

Job Info variables Job Infos contain information on any job file that comes out of the initial input task or any secondary input tasks. There are only 9 Job Infos available numbered from 1 to 9. They can be accessed directly anywhere where variable properties are accepted, by using the number of the variable preceded by a percent sign, for example, %2 or %9. Not all available Job Infos will actually be used by input tasks.
PAGE 715

Note that Job Infos don't change whilst the task executes. Consequently, the value of the field that contains the Job Info will be the same in each of the records in the resulting record set.
PAGE 716

Variable Name Example value when interpreted %F Job file path and name C:\Program Files\PReS Workflow 7\PlanetPress Watch\Spool\job1D80328.dat %f Job file name including the file extension job1D80328.dat %z Job file size in bytes 34134 %o Original file name invoice_june2nd.
PAGE 717

Variable Name Example value when interpreted (short text) %h Current hour 18 %n Current minute 03 %r Run mode (0: runtime, 1:debug) 0 %s Current second 41 %v Current millisecond 24 %u Unique 13-char string (will be different every time it is used) 0ZIS4CW8U47VI00 %U Unique 36character string consisting of 32 alphanumeric, lower case characters and four hyphens. Format: xxxxxxxx-xxxxxxxx-xxxxxxxxxxxxxxxx (8-4-4-4-12 characters).
PAGE 718

Variable Name Example value when interpreted %t Current temporary folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PReS Workflow 7\PlanetPress Watch\Spool\6.tmp\ %e Current Metadata file name job00ZAIZ2C4FXON16CE6C566.dat.meta %E Current Metadata path and file name C:\Documents and Settings\All Users\Application Data\Objectif Lune\PReS Workflow 7\PlanetPress Watch\Spool\5.tmp\job00ZAIZ2C4FXON16CE6C566.dat.
PAGE 719

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 error handling variables are read only and are filled by the On Error mechanism.
PAGE 720

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 721

1. Select the process where you want to add the variable. 2. Now you can use one of two methods: l l Click on the Home tab of the PReS Workflow Ribbon, then click Local Variable in the Variables group. Right-click on the process in the Configuration Components area, then click on Insert Local Variable. Deleting a variable l Right-click on the variable name in the Configuration Components pane and click Delete. Note Deleting a variable does not delete any reference to it.
PAGE 722

l You can use Scripts. See the chapter "Using Scripts" on page 141. Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" on page 724). Global variables Global variables are set at the level of the configuration file and are shared between all processes and tasks. To refer to a global variable, for example in a variable task property (see: "About Tasks" on page 301), use its name preceded by "global." and surrounded by curly brackets, for example: % {global.
PAGE 723

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. (Rightclicking then clicking Properties also works.) 2. Enter the new value for your global variable. 3. Click OK to save the new value.
PAGE 724

l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 441. You can use Scripts. See the chapter "Using Scripts" on page 141. Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" below). Variable task properties When you edit tasks, you may notice that some of the properties that you can modify have a red (or more precisely, a maroon) title.
PAGE 725

Variable properties can also be mixed, meaning you can combine, within a single variable property box, any number and order of variable types. You can, for example, do the following for an output file name: %O_@(1,1,1,30, KeepCase,Trim)_%y-%m-%d.txt. This would translate in the original file name, followed by part of the first line of a text data file, then the current date.
PAGE 726

You can quickly identify variable information that is already present in your variable properties as such: l l l l l A percentage sign identifies system variables, as well as standard and custom job info variables — %f, for example. A backslash indicates a control character — \004, for example. An at sign (@) indicates a data selection for emulations other than database — @ (1,1,1,1,17,KeepCase,Trim), for example.
PAGE 727

PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Suite Production. It is not available in older versions, nor is it available in the Office and Watch versions of PlanetPress Suite. PlanetPress Capture is not compatible with OL Connect Designer templates. PlanetPress Capture is a set of tools available in PReS Workflow that enable output and input for interaction with an Anoto Digital Pen.
PAGE 728

Anoto Functionality Statement Statement ('Paper featuring Anoto functionnality') that is automatically placed on the page when a PlanetPress Capture field is present. The statement can also include the Trace Code Anoto Pattern A series of dots placed in a pattern that is unique to each page where the pattern is printed. The Anoto Digital Pen identifies this pattern and its location on the page.
PAGE 729

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

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

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

l Microsoft Access l l l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database file (mdb) must be local to the PReS Workflow computer. It cannot be located on a network drive or another server. Database can be in any location, but performance will depend on the speed of the connection between PReS and the MySQL server.
PAGE 733

this case. This can be fixed by configuring the max_allowed_packet setting in the MySQL Configuration (Reference). l l Also in MySQL, if a timeout occurs on simultaneous record access, resubmitting the PGC for processing should resolve the issue. In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue.
PAGE 734

access to your PGC storage folder, they may be able to read the signatures, checkmarks and other information contained in it and reproduce them on a document of their choice. It is always better to secure this folder properly. You could also use third-party encryption software to secure the files, and decrypt them as necessary for reprocessing. l l l l The transfer between the Anoto penDirector and PReS Workflow is not encrypted due to a limitation of penDirector which does not support SSL connections.
PAGE 735

The Numbers First and foremost, the 20,000 patterns is a fixed number - PReS can only generate 20,000 unique patterns as this is the number of patterns that we license through Anoto. The 20,000 patterns are, however, not all available when generating documents. There are 8 "demo" patterns that are used to generate documents when PlanetPress Capture is in demo mode (no license activated), and react the same way that the bulk of the 20,000 patterns.
PAGE 736

Example Say you print 19,000 pages containing a pattern, every day. You may think you'll "run out of patterns" after a single day. But if 18,900 of these documents are being written to and processed within the day, at the end of the day you only have a 100 page difference, possibly due to mistakes, lost pages, or errors during processing. In this specific example, you would run out of patterns only after 10 days, assuming the numbers remained completely static.
PAGE 737

Using Pattern Sequences In the event where a single location generates all the patterns and this output *can* be split into multiple logical zones, Pattern Sequences can be used. A Pattern Sequence is basically a "tag" that is added after the pattern's identification (Pattern ID). When a Pattern Sequence is used, each Pattern Sequence can re-use each of the 20,000 available patterns.
PAGE 738

As you may have figured out by now, we are still not actually printing more than 20,000 patterns. The only distinction here is that we are re-using patterns in separate "zones" (or, well, sequences) and as long as pens and pages using capture patterns are not exchanged between these zones, they act independently with their own 20,000 pattern limitation.
PAGE 739

Second, contamination can happen in method 1) above if a pen or paper is moved from one location to another. Similarly to the previous contamination example, if there exists a document in the Capture Database where the "wrong" data is processed, it will update a document where it does not belong. Again, neither the pen nor PReS Workflow have any idea that this causes an error until it's too late.
PAGE 740

l l l When necessary, patterns can be extended using multiple servers or Pattern Sequences (as long as these are used in separate physical locations). It is extremely critical that contamination be avoided at all costs. Whenever possible, always avoid using pattern sequences unless it is absolutely necessary to do so. Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc.
PAGE 741

To pair penDirector with an Anoto Digital Pen: 1. Make sure that a Bluetooth dongle is present and enabled on the computer where penDirector is installed. 2. Note down the PIN of the Anoto Digital Pen, by docking the pen and going in the Pen settings tab of penDirector and looking at the Pen access group at the bottom of the dialog. The default PIN is 0000. 3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4.
PAGE 742

PlanetPress Mobile Application The PlanetPress Mobile application can be installed on some mobile phones and enable fast and direct connectivity between the Anoto Digital Pen and PReS Workflow. The connectivity between the pen and the mobile phone is done through Bluetooth, while the connectivity between the mobile phone and PReS Workflow is through the currently active data plan (either wifi or the cell phone company's data plan, such as 3G).
PAGE 743

Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
PAGE 744

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 745

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 746

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 747

l l l l In PlanetPress Design, a Capture Field Object must be added and the Perform ICR option must be activated (See the Capture Field page in the PlanetPress Design User Guide). This must be either a Multi-Area Field or a Text Field. The Capture Fields Processor must have the Perform ICR Recognition option checked, and language needs to be selected. Once the ICR data is available, do something with it.
PAGE 748

the pen, its movement speed as well as the overall shape of each character to determine which character was written. 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.
PAGE 749

Using the Most Restrictive Mask l l Target: Form designer. What: In the Capture Options tab of a Capture object, the mask type indicates the type of character to be recognized. There are 3 possible selections: numeric, alphabet and alphanumeric. The alphabetic mask type allows you to select the letter case.
PAGE 750

How: Use the following options from the Capture options tab under Mask Type and Case option to filter the expected data. 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.
PAGE 751

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. In order to do so, you must make sure that the fields are big enough and have enough space between each one. The best practice is to make sure that there is a boundary surrounding the field where ink marks are to be written.
PAGE 752

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 753

l Write an additional line under the number 1. l Write an additional line across the number 7. l l l The ICR functionality of PlanetPress Capture cannot recognize dotted letters where there are circles instead of dots (like i , j). This would be analyzed as an i AND o. Therefore, dots should be as such and not circles. In French, the ç is somewhat sensitive. You must apply yourself and draw the letter carefully. In most cases, it is recognized, but attention must be paid. Number 8 is also sensitive.
PAGE 754

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

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. How: Allow for a special process (possibly manual handling) in the case the automated process didn’t reach a high confidence level in its analysis of the ink marks. Use the plugin Capture condition that includes the ICRContent option. This can be configured to be a true condition if the confidence level is greater than a certain value.
PAGE 756

every computer where PReS Workflow is running, but you may also choose to run it on computers more or less dedicated to PReS Fax. Since the faxing program must always be running and ready to receive requests from PReS Workflow, it should be included in the Windows Startup group. PReS Fax can associate a different fax number with each page it sends via the faxing software.
PAGE 757

PReS Image can be installed on any computer on your network and can process requests coming from tasks performed by PReS Workflow on other workstations. You may choose to run it on every computer where PReS Workflow is running, but you may also choose to run it on computers more or less dedicated to PReS Image. Note that in the case of Digital Action tasks, PReS Workflow and the PReS Image service must be running on the same computer.
PAGE 758

OL Connect Send tasks l "Get Data" on page 577 l "Get Job Data" on page 582 l "Job Processor" on page 586 ZUGFeRD The ZUGFeRD plugin provides a way to enrich German PDF invoices with data specific to the invoice. This is done by embedding the data in a standardized XML format within the PDF itself. ZUGFeRD is an acronym for Zentraler User Guide des Forums elektronische Rechnungen Deutschland. In English this translates to Central User Guidelines of the Forum for Electronic Billing in Germany.
PAGE 759

Plugin language The plugin is only available in German, as its application is only really relevant to documents created for the German market. Plugin usage For help on how to use the ZUGFeRD plugin, see "ZUGFeRD plugin" on page 529. Plugin Legal Notices and Acknowledgments Copyright © 2021, Objectif Lune Inc. All rights reserved. The ZUGFeRD name and logo are protected under copyright and used with permission of the Arbeitsgemeinschaft für wirtschaftliche Verwaltung e.V. in Germany. The Objectif Lune Inc.
PAGE 760

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 763. Available Input services Input services are used to pull in data files. The input services used by PReS Workflow are: l l l l l LPD (Line Printer Daemon) Input service: Inputs data sent from an LPR client.
PAGE 761

instances of the PReS Fax service on your network, and have PReS Workflow send 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 PReS Fax" on page 755. l l l PrintShop Mail: Used to generate documents using PrintShop Mail databases and documents.
PAGE 762

Note If you send a new configuration when PReS Workflow is paused, it will continue using the old configuration when you resume processing until you stop and restart it. See also: "Saving and sending a Workflow Configuration" on page 36. l Click Resume to resume the service after pausing it. The PReS Workflow Tool service starts performing jobs again. Users and configurations When a user opens a session on a computer, they typically need to log in.
PAGE 763

PReS Workflow and all its services have the same rights on all computers and that it is therefore able to perform all the actions defined it needs to on every computer on your network. A less permissive solution is to create an administrator local account for PReS Workflow and to replicate it on each computer where PReS Workflow and its services are likely to perform operations, such as get files, store files, or run applications and perform operations.
PAGE 764

Set the PReS Workflow applications permissions as required: l l l l Local System account: Select to run all the PReS Workflow Services (including PReS Workflow, PReS Fax, and PReS Image) under the Local System account. The Local System account is distinct from the Administrator account. It requires no user name or password, and its privileges may exceed those of the user currently logged in.
PAGE 765

The PReS Workflow Configuration program does not test user names and passwords, but merely associates them with the services that require them. If you enter a bad user name or password, these services will be denied access to the selected account. The account you choose will be used by PReS Workflow and all its services, as well as by PReS Fax and PReS Image.
PAGE 766

Preferences PReS Workflow Configuration program lets you configure a variety of options, from how the application itself looks or behaves, to plugin specific options. Most of PReS Workflow preferences are located in the PReS Workflow Preferences window, accessible through the Preferences button in the PReS Workflow button, or the key combination Ctrl+Alt+P.
PAGE 767

l "Telnet Input plugin preferences" on page 802 l "PReS Fax plugin preferences" on page 803 l "FTP Output Service preferences" on page 806 l "PReS Image preferences" on page 807 l "LPR Output preferences" on page 810 l "PrintShop Web Connect Service preferences" on page 812 Note Preferences are saved automatically and applied immediately.
PAGE 768

l l Highlighted tasks and branches: Select the background color for highlighted tasks and branches in the Process Area’s invisible grid. Disabled tasks and branches: Select the background color for disabled tasks and branches in the Process Area’s invisible grid. Inactive process l Color: Select the color to use to identify inactive processes in the Configuration Components pane. l Bold: Select to use a bold font to display inactive processes.
PAGE 769

l Reset to default button: Click to reset all the Object Inspector options to their default values. Configuration Components pane appearance preferences Colors This window lets you set the color of individual Configuration Components pane elements. To change the color of a given element, select it in the list box above and then choose a color from the drop-down list below.
PAGE 770

Default configuration behavior preferences l Use default configuration: Check to use default input and output tasks when you create a new process. If this group is not selected, each new process you will add will begin and end with unknown tasks. l l l l l l l l Default input task: Select an input task to use as the default input task when you add a new process. Click the Configure button located to the right of this box to set the properties of the selected input task.
PAGE 771

Note l l The JScript engine is Microsoft’s JScript 5.8, which is the equivalent of JavaScript 1.5 (ECMA-262 3rd edition + ECMA-327 (ES-CP) + JSON). Enhanced JScript allows the use of more recent JavaScript syntax. Many methods - basic methods like Date.now(), String.trim(), btoa ()/atob() and more advanced methods like Array.forEach() - are added to the JScript engine via the polyfill.js library.
PAGE 772

l l l l l l l l l l l Invalid name: Select to have PReS Workflow warn you when you try to rename an object in the Configuration Components incorrectly. Names can include letters, numbers, and underscores; the first character of a name cannot be a number. Printer queues update: Select to have PReS Workflow prompt you when adding a document to a group under the Documents category in the Configuration Components pane.
PAGE 773

l l l l l l l l l l Prompt on overwrite of a document: Select to have PReS Workflow prompt for confirmation when a document that is being imported using File | Import Document is about to overwrite an existing document. Prompt on Document overwrite when service is running: Select to have PReS Workflow prompt for confirmation when a document that is being imported using File | Import Document is about to overwrite an existing document.
PAGE 774

configuration file. Imported components can overwrite existing components, or be renamed automatically with unique names. Sample Data behavior preferences Sample Data behavior preferences control the way theData Selectordisplays the sample data file. Preferences l l l Select Font button: Click to access the Font dialog box to select the font in which the Data Selector displays the sample data file.
PAGE 775

l l l l Password: Enter the NetWare password corresponding to the user name you entered in the previous text box. Tree: Enter the NetWare Directory Services (NDS) tree where the user resides. This is the user you entered in the user name text box. Click Trees to navigate to the desired tree. You must enter a value for the Tree text box. Context: Enter the context on the NDS tree where the user you enter in the user name text box resides.
PAGE 776

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. See PlanetPress Capture Server/Client. l Port: Select the port used to connect two servers together. The default value is 5864. l Document and Pattern Database group l l l Use ODBC Database: Check to ignore the default location for the Microsoft Access database (MDB) and use an ODBC connection to your own database location instead.
PAGE 777

selected. Note that this validation occurs for every ink file (i.e. PGC file) the local system processes, which may cause a slight delay for the operation depending on the connection speed and latency between the two systems. Note The Server/Client mode is only used for managing pen licenses and has no impact on the Capture Database itself. The database can be stored locally or remotely, regardless of the Server/Client mode specified.
PAGE 778

l l Content Status: Search using the status of the document, whether it is Open, Closed, Complete, Partial or in Error. Operator: Select how to do the comparison l Equal: The mask and database information are exactly the same. l Not equal: The mask and database information are different. l l l l l l Less than: If the mask and database information are both numbers, the mask will be a smaller number.
PAGE 779

l Close documents: Click to close the document and release the pattern it uses. Warning This will prevent the document to be further updated, may cause errors when docking any pen that signed the printed version of the document. This cannot be undone. PlanetPress Capture ODBC Settings This dialog is used to set up the connection to a PlanetPress Capture Database through an ODBC connection. To access this dialog, See "PlanetPress Capture preferences" on page 775.
PAGE 780

l l l 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. Password: If the database is secured with a user name and password, enter the password here.
PAGE 781

l l l 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. MySQL l l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PReS Workflow through an ODBC connection on the local network.
PAGE 782

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. PlanetPress Capture will read the serial number from the PGC file and register the pen. Print Pen Activation File: Click to print a page containing a special pattern. Any pen that writes on this pattern and is then docked will be registered in the database.
PAGE 783

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. Click on the Read PGC File button in the top toolbar of this dialog. 6. If necessary, enter an optional pattern sequence and User ID for each pen.
PAGE 784

Technical To add a pen pack, PlanetPress must be activated using a PlanetPress Production license. if PlanetPress Production is in trial mode, no pen pack can be added because the Pen Pack uses the serial number. Options and Controls PlanetPress Capture Pen Licenses Group l l Import License...: Click to open the Import License dialog. Browse to a PPLIC (PlanetPress License) file on your computer and open it to import the license.
PAGE 785

The available OL Connect user options define the default behavior of OL Connect tasks' OL Connect Proxy tab. These values are used unless they are overwritten in a task's properties: l Server Connect Settings l l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server.
PAGE 786

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

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

l l l l l l 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. Details can include why tasks fail and how successful tasks are executed. All events with details: Select to log everything that happens in PReS Workflow.
PAGE 789

The Messenger service uses the SSL 2.3 protocol. Preferences l PReS Alambic options group l l l Let me set up how many instances to run: Select this option if you want to limit the number of instances of the Alambic that PReS Workflow can run. Then enter the number of instances, a value ranging from 1 to 32, in the box below. When this option is not selected, PReS Workflow starts a minimum of three instances and a maximum of eight, based on the number of CPUs available on the server.
PAGE 790

Preferences l l l Port: Select the port to use. The default port is 8080, the official HTTP alternate port, so as not to interfere with the standard HTTP port (80). To block any regular HTTP traffic (for example if only using HTTPS connections) the port can be set to 0. Note that it is possible to use both the NodeJS Server and the standard HTTP Server simultaneously, provided that they are not set to listen to the same port. See "NodeJS Server Input plugin preferences 1" on page 797.
PAGE 791

This password is encrypted within PReS Workflow server and is not saved in plain text. l Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. The service uses SSL 2.3 or TLS 1.0. Note When SSL is enabled and a user sends a query prefixed with https://, then this specific communication will be sent through port 443, which cannot be changed in Workflow.
PAGE 792

l l Use enhanced PHP-like Arrays: Like the previous option, but in this case, the value between the first pair of square brackets is expected to consist of two parts, separated by an underscore (e.g. row_0). The first part is considered to be the element's name. All content after the first underscore (preferably an integer) will be used as index, which is given as an attribute of the element (e.g. ; also see "PHP arrays example" below).
PAGE 793

Resulting XML Structure with PHP-like arrays email@example.
PAGE 794

HTTP Server Input plugin preferences 2 The second set of HTTP Server Input plugin preferences is 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 795

l Form Data Encoding: Specifies how form data, which was sent to the web server, should be interpreted. Even though it is strongly recommended to use the element in web pages, some might use another encoding or not have the element at all, affecting the character set used by the browser to send the parameters and file names. l l System language: Sets the encoding attribute in the request XML file to the system codepage (e.g. Windows-1252).
PAGE 796

Preferences l Protocol options group l l l l l Log all Winsock and network messages: Select to have PReS Workflow keep a log of all Winsock and other network messages that occur through the LPD service. These are messages related to jobs being sent from other systems through LPR, and being received by PReS Workflow via LPD. Since these messages can accumulate, you have the option of not logging them. Log files are kept in the Log folder, which is located in the PReS Workflow installation folder.
PAGE 797

NodeJS Server Input plugin preferences 1 The first set of NodeJS Server Input plugin preferences controls the server protocol aspects of the PReS Workflow NodeJS Server Input tasks. This is where you enable and configure secure communication for the NodeJS Server. Click the PReS Workflow button and then the Preferences button, to open the Preferences dialog. The NodeJS Server Input 1 preferences page can be found under Plug-in. Note Workflow's NodeJS and ppNode folders can be found in %PROGRAMFILES%\Object
PAGE 798

be forwarded to the target specified in the proxy list (see "NodeJS Server Input plugin preferences 2" below). l l l l l l l HTTPS Port: Select the port to use. The task's default HTTPS port is 8443, so as not to interfere with the standard HTTPS port (443). Port numbers > 9999 are possible. Root certificate: Enter the absolute path to the Root Certificate, or click the Browse button and select the file in the Browse dialog. The file generally ends with a .crt extension.
PAGE 799

l Proxy List: The proxy list is used to setup end points for redirecting requests to another server. l l Mount point: Specify a path name for which requests should be redirected to another site, for example: /myrest. Different mount points can point to the same remote site. Use the buttons below the list to add or delete mount points and to change the order of the mount points in the list. Remote site: Type the address of the server to which the request should be redirected.
PAGE 800

l ActiveDirectory Server: Enter the address of the ActiveDirectory Server. l Domain: Enter the domain for authentication.
PAGE 801

The two files that you need are located here: C:\Program Files (x86)\Objectif Lune\ppnode\src\html Be careful; errors in these files can lead to unpredictable behavior! Setting the duration of the authentication When a user has logged in, that user's authentication is valid for the duration of the session. There is no option in the Workflow Preferences that allows you to set a different behavior for the duration of the authentication. However, you can manually edit the file named: C:\Program Files (x86)\O
PAGE 802

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 803

l Use Job Delimiters: Check this option if your Telnet input is a single stream that can contain multiple jobs. The box lets you enter one or more possible delimiters (separated 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/.
PAGE 804

and area code, and fax number to the ones it receives from PReS Fax. If any of the values it receives from PReS Fax are empty, it uses its own default values. For example, if the data selection did not contain a dialing prefix, WinFax PRO uses its default dialing prefix. Select Dial as entered to limit 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.
PAGE 805

(\\servername\sharename\path\filename). This naming convention works well with Windows operating systems, Novell NetWare, and other operating systems when using a local naming system (such as the DOS naming system in Windows) would result in “File not found” error messages. 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.
PAGE 806

Captaris RightFax options l l l l l RightFax Printer: Select a RightFax printer. A RightFax printer is a fax driver that makes it possible to send faxes automatically. This printer will output faxes without prompting the user for fax addressing information. For more information, refer to Captaris RightFax documentation. Activation: Click to enter activation codes for the PReS Image service installed on the same computer as PReS Workflow.
PAGE 807

Console. l l l Interval: Select the interval (in seconds) at which the FTP service is to dispatch jobs from the ftpPut folder to the FTP sites. Back up job on error: Select to move the job file to a local folder ftpPut\error if an error occurs while sending a job via the FTP output. This folder is relative to your install folder. FTP Port: Select the port number that you want PReS Workflow to use for all FTP output tasks. The recommended port is 21 (the default setting).
PAGE 808

log is sent to all addresses you enter in the Administrator’s address(es) text box. l l l l l l l l Error log: Select to send an email that includes the current error log to the administrator when an error occurs. The error log is sent to all addresses you enter in the Administrator’s address(es) text box. Error file: When enabled, sends an e-mail with an attachment of the offending file when an error occurs in the PReS Image output task.
PAGE 809

l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server). Connection time-out: Enter the time, in seconds, that the connection to the database is maintained while no action is taking place before the connection is severed. Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory.
PAGE 810

be running Outlook, and PReS Workflow must have access to Outlook. Outgoing emails appear in the outbox of Outlook, and is sent whenever Outlook is set to send email. l Use SMTP mail group: Check to activate this group’s options and to use Simple Mail Transfer Protocol (SMTP) to send the error messages to the administrators. Note that if you select this option, you will be required to enter information in the Name, Email address and Outgoing mail (SMTP) boxes.
PAGE 811

Options l Protocol options group l l l l l Print banner pages between jobs: Select to print banner pages between each job processed and output from the LPR output. The banner page includes details of the job being printed, including the job file name and the user name on the host computer running the LPR output client. 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.
PAGE 812

l Polling interval (seconds): Select the period of time—the default is 4 seconds—for which PReS Workflow is to wait when it finishes dispatching jobs to the LPR printer queues before polling the LPR output folder again. PrintShop Web Connect Service preferences PrintShop Web Connect service preferences control the credentials to log into the PrintShop Web server. The available preferences are as follows: l l User name: Enter the user name of a valid PrintShop Web user, mostly operators.
PAGE 813

l Editor l l l l l l l l l Auto indent mode: Select to automatically position the insertion pointer under the first non-blank character of the preceding line when you press ENTER. Insert mode: Select to use Insert mode and clear to use Overwrite mode. In Insert mode, when you enter text, existing text shifts to accommodate it. In Overwrite mode, text you enter overwrites existing text. You can also press INSERT to toggle between the two modes.
PAGE 814

l l l l l l l l l l Cursor beyond EOL: Select to make it possible to position the pointer beyond the end of the line. Clear to prevent this. Keep trailing blanks: Select to preserve any blank spaces occurring at the end of a line. Clear to remove those blank spaces. Persistent blocks: Select to have any text you enter immediately after selecting a block of code appended to that block of code as part of the selection.
PAGE 815

l l Tab stops: Use to set the number of spaces to advance when you enter a tab character or to set a series of tab stops. Enter a single integer to set the number of spaces to advance with each tab. Enter a sequence of two or more integers, each separated by a space, to specify tab stops. The sequence must be in ascending order. Tab stops are measured in number of space characters. For example, a value of 20 places the tab stop at the 20th space character.
PAGE 816

l l l l Gutter width: Enter the width, in pixels, of the gutter. Use the drop-down list to select a previously-entered gutter width. Line numbers on page: Select to display code line numbers at the left edge of the Code area. If you clear both this and the Line numbers on gutter option, no line numbers appear alongside the lines of code. Line numbers on gutter: Select to display code line numbers in the gutter between the Commands and Code areas.
PAGE 817

The user 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: l "PReS Workflow Button" on page 827. l " The Quick Access Toolbar" on page 891. This toolbar is customizable. l The ribbon tabs; see "The PReS Workflow Ribbon" on page 892. l "The Process area" on page 883 l "Configuration Components pane" on page 828.
PAGE 818

Customizing the Workspace You can combine and attach the Configuration Components pane, Messages area and Object Inspector into a single secondary window that can be docked to and undocked from the main PReS Workflow Configuration program window. Combining and attaching areas can facilitate the management of your screen real estate. It lets you reposition multiple areas in a single operation.
PAGE 819

above it (undocked position). You dock a window when you attach it to the Program window, and you undock it when you detach it from the Program window. 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.
PAGE 820

the Messages area. The area will jump from an undocked to a docked position and viceversa. 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: 1. In the PReS Workflow Ribbon, click the View tab. 2. From the Show/Hide group, click on any area name to hide or display it.
PAGE 821

a tab appears at the bottom of the rectangle. Switching between combined areas 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. Image: The left and right arrows let you show hidden tabs. Reordering tabs in a combined area At the bottom of the combined area, click the tab of the area you want to move, drag it to the left or right and drop it at the desired position.
PAGE 822

Taking an area out of a combined area 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.
PAGE 823

Image: 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. Maximize or restore attached areas 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 824

Image: A) Click to maximize this area. B) Click to restore this currently maximized area.
PAGE 825

Image: C) Click to maximize this area. D) Click to restore this currently maximized area. Taking an attached area out of a group 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. Release the mouse button when the rectangle is away from the group.
PAGE 826

To resize a program window area: 1. Move the pointer to an edge of the area that you want to resize, to display the resize pointer. 2. Then click and drag to resize the area. Change the Interface language PReS Workflow can be used in multiple languages, and the list of available languages grows as we translate the software. The first time you use PReS Workflow, it starts in the language used for the installation. To change the language used by the PReS Workflow Configuration program: 1.
PAGE 827

Japanese. PReS Workflow Button The PReS Workflow button provides access to the File menu options. Options l l l l l New: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. See "Creating a new configuration" on page 34. Open: Displays the dialog to open an existing configuration file. Save: Saves the current configuration.
PAGE 828

l l l l l Close: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. Closing the current configuration is the same as creating a new one. Recent Documents: Displays a list of the 9 most recently opened configuration files. Click on any of them to open it. Select Language: Click to display the language selection dialog, which changes PReS Workflow interface language. See " Change the Interface language" on page 826.
PAGE 829

l Delete: Deletes the process from the configuration. l Rename: Renames the process. l l l Startup: Triggers whether the process is a startup process (runs before any other process). l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties, for scheduling and error handling. Subprocesses: Displays a list of subprocesses in your configuration (see: "About processes and subprocesses" on page 125).
PAGE 830

l l Properties...: Displays the properties, which lets you set a default value for the global variable. Connect Resources: Displays a list of PReS Connect resources that can be used in processes (see: "Connect resources" on page 39). Different resources are divided into subfolders: l Data Mapping Configurations: Displays a list of data mapping configurations used with the Execute Data Mapping task.
PAGE 831

l l Properties...: Displays the properties, which lets you see the form information and select its default printing behaviors. Printer Queues: Displays a list of printer queues in your configuration (see: "PReS Workflow printer queues" on page 111). Right-click on a printer queue to access a dropdown menu that offers these choices: l l Insert Printer Queue: Creates a new printer queue in your configuration. Replace Printer Queue By: Replaces the currently selected printer queue with a new one.
PAGE 832

PReS Workflow Configuration programs let you view a number of the properties associated with the PlanetPress Design documents you use, but most of those properties are set in PlanetPress Design and cannot be edited using PReS Workflow Configuration program. The Document name of printer-resident documents can be changed using PReS Workflow Configuration program simply because it is initially set using that program. The properties available via the Printer Settings tab define how documents are printed.
PAGE 833

Printer Settings Tab l l l Trigger Type: Select whether you want a normal trigger configuration to be used, or a custom trigger that you manually enter. Custom Trigger Box (appears only when Custom Trigger is selected in Trigger type): Lets you enter the exact trigger you want to use. This trigger must absolutely be in standard postscript language.
PAGE 834

l l Update Instances: Clicking this button brings up a dialog box that lets you manually update any document on any printer. Printer-Specific folder: This option lets you enter a manual location where the documents should reside in the printer's memory. This option is only available if the document is Printer Centric, and the Document location is either On printer hard disk or In printer flash memory.
PAGE 835

Moving Configuration Components You can move components in the Configuration Components pane in a number of ways; see below. Note that moving a configuration component does not change the order in which the components are used. However they can affect your process if, for example, you move a local variable from one process to another and the local variable is still used in the first process.
PAGE 836

Using the contextual menu l Right-click on the component you want to move. l Click on Cut in the contextual menu. l Right-click on the new location where you want the component. l Click on Paste in the contextual menu. Using the keyboard shortcuts l Click on the component you want to move. l Do CTRL+X (cut) on your keyboard. l Click on the new location where you want the component. l Do CTRL+V (paste) on your keyboard.
PAGE 837

Renaming objects in the Configuration Components Pane You can rename processes, groups, and printer queues in the Configuration Components pane. Resource files cannot be renamed or modified using PReS Workflow. You can, on the other hand, change the name of printer-resident PlanetPress Design 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 838

1. Click an object or group. 2. In the PReS Workflow Ribbon, go to the View tab. Then click Order in the Arrange group, and select one of the following: l l l l Move up to move the item one step up in the category or group. If the item is already the top object in the category or group, this command has no effect. Move down to move the item one step down in the category or group. If the item is already the bottom object in the category or group, this command has no effect.
PAGE 839

Tip Groups can be copied and moved using the Clipboard and Drag & Drop; see "Moving and copying configuration components" on page 834. Grouping objects To add a group in the Configuration Components pane: l l l Select one or more processes and/or groups in the same group and choose View > Group. Right-click one or more selected processes and/or groups and select Group from the contextual menu. Select one or more processes or groups in the same group and press CTRL+G.
PAGE 840

Expanding and collapsing categories and groups in the Configuration Components pane You can expand and collapse the Processes, Global Variables, PPD/PSM Documents and Printers Queues categories, and groups, in the Configuration Components pane. To do this, click the Expand / Collapse button to the left of the item. Deleting something from the Configuration Components pane To delete a process, document, or printer queue: l Click a process, document, or printer queue, then press the Delete key.
PAGE 841

and check the desired Prompt on (...) deletion options. Dialogs Dialogs are either accessible from the preferences or from different parts of PlanetPress Workflow. Access Manager The Access Manager controls what rights are granted to other machines (clients and servers) on the same network. It grants access to functions such as sending documents and jobs to the server. To open the Access Manager: 1. Open PReS Workflow. 2. In the Ribbon, go in Tools > Managers > Access Manager.
PAGE 842

Messenger access Manually adding new entries to the list To grant access to the Messenger service you can manually add new entries to 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 843

Note The format of the IP address must be one of the following: l l l l 127.0.0.1: The local computer. Typically this IP should have all the accesses checked. 255.255.255.255: Everyone on the same subnet. This is equivalent to hard-coding the current subnet, such as 192.168.1.255 or 10.0.0.255. 192.168.0.42: A single IP address. This can be any valid address on the same subnet. 10.0.255.255: Any IP in the 10.0.X.X range.
PAGE 844

Warning The following considerations are to be understood when using the Access Manager to configure IP limitations: l l l l Each permission type (column) is evaluated from top to bottom (column per column) in the order in which they are visible in the Access Manager window. This means that wide ranges should always be at the top to increase performance. For example, if you accept HTTP connections from any IP, the first entry should be 255.255.255.255 with the Allow checkmark in the HTTP Input box.
PAGE 845

l l Send Document: Grants access to the remote computer to send new or updated Connect files (templates, data mapping configurations, print presets), or PlanetPress Design Documents, to this server. Send Config:Grants access to the remote computer to overwrite the configuration on the local PReS Workflow service Note In order for the changes made here to be effective, you will need to restart the PReS Messenger service. This can be done via the PReS Workflow Service Console.
PAGE 846

Adding a new SOAP user To add a new SOAP user: 1. Click on the button. 2. Enter the following information under the Username column for the new entry that was created: l l l User name: An alphanumerical user name for the user. Password: A password to protect the user. Note that the password will always revert to ******** (8 stars) when clicking outside of this box - that is normal and is meant to protect the length of the password as much as its contents.
PAGE 847

Note In order for the changes made here to be effective, you will need to restart the PReS Messenger service. This can be done via the PReS Workflow Service Console. Activate a printer The Activate a Printer dialog lists the existing activated printers on the system and lets you add new activations.
PAGE 848

l Printer Name (Optional): Name and/or model of the printer. l Comments (Optional): Comments about the printer. The following buttons are available in this dialog: l Add: Brings up the Printer Activation dialog. This dialog lets you enter the information for the printer (see previous section), then click OK to save the new activation. l Delete: Removes the currently selected activation from the list. l Web Activation: Click to access the online activation manager on our website.
PAGE 849

Note MySQL, using ODBC 5.0, must be set to use a client-side cursor. Microsoft Access will always work better when using a Server-Side cursor. 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. Test SQL button: Verify the SQL statement's validity.
PAGE 850

keys cannot be removed or edited. l l l l DateC is the creation date of the key set. l DateM is the date at which the key set was last modified. Delete Group: Click to delete the currently selected group. Warning: This action cannot be undone. Add Key: Click to add a key to the currently selected group. Enter a key name and click OK. If adding a key to a group with existing data, the key will be empty for all existing key groups. Delete Key: Click to remove the currently selected key in the group.
PAGE 851

l l l Clear All Data: Click to delete every key set of every group in the Repository. Warning: This action deletes all your data and cannot be undone. Clear Repository: Click to delete every group in the repository, including all their data. Warning: This action deletes all your data and cannot be undone. Show/Hide System Keys: Click to show or hide the ID, DateC (creation date) and DateM (modification date) keys.
PAGE 852

l To add a key set, press Insert. The Add Key Set dialog will appear. Use the arrow buttons to browse through the keys in the key set and add values to them. This dialog has a button at the bottom to add another key set. Navigating with the keyboard Though of course the mouse is the easiest way to navigate through the Data Repository, the keyboard can be used as well. l Press Tab to switch between the Repository Structure, Group Key Sets, Lookup Function Syntax and the Close and Help buttons.
PAGE 853

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

The Data Selector is essentially the same as the one used in PlanetPress Design. 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 458) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks.
PAGE 855

PDF Emulation l l l If you use a PDF emulation, the Data pane displays the data as you would see it in any PDF reader. A new zoom drop-down list is displayed to let you set the zoom in percentage or fit the PDF to the window or the width of the window. A new status bar, displaying the (Left, Top) and (Right, Bottom) coordinate pairs, is shown under the Data pane. XML Emulation l XML data is represented in a tree structure which corresponds to the data in the XML file.
PAGE 856

on page 57). This expression is editable, which allows you to customize the string returned by the Metadata selector. Tip The wildcard parameter '?' indicates that the function operates on all nodes (not just one) of a given level; see "Wild card parameter "?"" on page 54. The Enable search on multiple levels option is available when a Metadata is selected under Production information or User defined information. If it is not selected, the option flag includes NoCascade (+2).
PAGE 857

Data Selector display preferences The Data Selector Preferences are accessible through the Selector Options tab in the Data tab of the Data Selector. It controls how text-based data files (such as Line Printer, ASCII and Channel Skip) are displayed in the data selector.
PAGE 858

1. In the Data Selector, click the Selector Options tab. 2. Change the options that modify the appearance and behavior of the Data pane: l l l l l l l View size: Use to adjust the size of each cell in the Data Pane, and the amount of visible data that is visible. Show used cells: Select this to display in green all cells that contain data.
PAGE 859

Font To set the font the Data Selector uses for all emulations except XML and PDF: 1. In the Data Selector, click the Selector Options tab. 2. Click Select Font. 3. In the Font dialog box, set the font you want PReS Workflow to use to display the sample data file in the Data Pane. l Font: Select the font you want to use to display the sample data file in the Data Pane. l Font style: Select a weight for the font. l Size: Select the point size for the font.
PAGE 860

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 861

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 862

l l l l l l l Printer Password: If the printer requires a password, enter it here. Max form cache: Set the size, in bytes, of the PostScript printer form cache. This sets the cache size for all documents that execute on the printer. You base the setting for this option on the number of images in your documents, their sizes, and how frequently each image repeats in a document.
PAGE 863

Print Status Page The Print Status Page option sends a command to print information to the selected printer(s), notably: l The serial number and the full version number of the copy of Workflow making the request. l Printer information (printer name, firmware version, etc.). l Information on the current job (paper type, paper tray used, etc.). l Information on the installed devices (printer hard disk, flash drive, etc.). l Memory size information.
PAGE 864

Send to File If the Send to File option is checked, a prompt for each of the selected Printer Utilities options will appear in Workflow so the PostScript commands can be saved to disk. This makes it possible to send the commands to the printer at another time and independent from Workflow. Process properties To have access to the properties of a process or subprocess: l Right-click on the process in the Configuration Components pane. l Select Properties.
PAGE 865

again once it has completed itself and replicates again as necessary, until all files have been processed. 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 788. For example if the maximum number of threads is 10 and you specify 50% here, a maximum of 5 replications will occur (the original process + 4 copies).
PAGE 866

l Week of month / by date: Select the desired option for the time grid. Note that any selection you make in this box will be interpreted based on the selection made in the Month box. If you chose All months in the Month box and Last in the Week of month / by date box, then the process will run on the last week of every month. If you chose January in the Month box and First in the Week of month / by date box, then the process will run only on the first week of January.
PAGE 867

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 868

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 869

On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings. The Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
PAGE 870

l IS EQUAL TO OR LESS THAN (<=) l IS CONTAINED IN l IS NOT CONTAINED IN l CONTAINS l IS GREATER THAN l IS LOWER THAN l STARTS WITH l ENDS WITH l VALUE CHANGED Note When "VALUE CHANGED" is selected in the condition, the second parsed field is not considered. Expressions The first expression can either be a custom list or a parsable edit field. The second expression is always a parsable edit field.
PAGE 871

l The following rule: (GetMeta(SelectedIndexInDocument[0], 11, Job.Group[?].Document [?].Datapage[?]) Equal 0 loops through all datapages in a job, comparing their index in the document to a value. Index/Count values When using Index/Count values in a rule, please note that these values are zero-based: the first element in any collection has an index of 0 and the last element's index corresponds to the collection's length minus 1.
PAGE 872

3. Define condition B. 4. Select condition B and choose Add Sub Condition. This will indent condition B and allow to define the condition C. Specify the logical operator OR. 5. Define condition C. 6. Right click on the first AND operator (the one right after condition A) and choose Add Condition. Specify the logical operator AND. This will create a condition at the same level as A. 7. Define condition D.
PAGE 873

To start a stopped service: 1. Right-click on the service. 2. Click on Start. 3. Look in the Log window on the right to see the service starting. To stop a service that is running: 1. Right-click on the running service. 2. Click on Stop. If the service is currently processing a file (if a process is running, output is being generated, job being received, etc), the service will wait for this action to complete before stopping. To pause a service temporarily: 1. Right-click on the running service. 2.
PAGE 874

the view in real time. When a service is selected on the left pane, its log file (if any exists for the current day) is displayed. The log displays in a tree fashion. The log itself is the root, and each session (the time between the start and stop of a service) is listed. Under each session, each time a process runs, a new branch is created and it can be expanded to see each action within that process.
PAGE 875

Browsing log files Select File > Browse logs, to open a folder that contains either Workflow or Connect log files. This is useful when you need to delete a log file or open it in another editor because it has reached a larger size than the Service Console can handle. With this option you cannot open a log file in the Service Console. Note For Connect log files, the browser opens the current user's default Connect logs location.
PAGE 876

Task Properties dialog Any task you add to your PReS Workflow process must be configured using its Properties dialog. It appears as soon as you add a task to a process, or when you double-click on a task. Each task's Properties dialog will give you the options to configure that specific, individual task. Properties of one task do not directly affect the properties of another task, however there are some software preferences that may affect tasks in one way or another (see "Preferences" on page 766).
PAGE 877

l Printer Queue: Displays in which printer queue the document is present. l Printer Group: If available, displays in which printer group the document is located. l Document: Displays the name of the document. l Location: Displays the location (printer or Workflow) of the document. Select any document in the list (use CTRL+Click or SHIFT+Click to select multiple document or use the Select All button) and click OK to update these documents.
PAGE 878

The Debug Information pane The Debug Information pane displays the current values of variables and other information useful in debugging processes (see "Debugging and error handling" on page 98). It is divided in 4 sections: l l l l Job Information: Displays the Job Info variables, as well as the job's file name, size, last edit date and presence of metadata (see "Job Info variables" on page 714). Local Variables: Displays all the variables local to this process (see "Local variables" on page 720).
PAGE 879

Warning Deleting an expression or clearing the expression list cannot be undone! The Message Area Pane The Messages area is used in Debug mode to indicate the status of your PReS Workflow process as the sample data file is processed and used to generate output. When your PReS Workflow runs in Debug mode, the Messages area displays useful processing and error information. Messages are displayed in different colors (debug levels) in the Message area.
PAGE 880

The Message Area will only display information while running in Debug mode. It does not display information from other running services, and will not display the log of any process running in a live configuration (submitted to PReS Workflow Service). To learn more about debugging a process, refer to "Debugging and error handling" on page 98.
PAGE 881

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 Plug-in Bar PReS Workflow offers a constantly increasing number of plugins, while always allowing third party plugins to be installed and set up to be used by PReS Workflow.
PAGE 882

l OL Connect; see "OL Connect tasks" on page 591. l Document Management; see "Document Management tasks" on page 678. l Outputs; see "Output tasks" on page 652. 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 fall into such a category.
PAGE 883

l Revert to the default Plug-in Bar by selecting Reset to default. Custom plugins will remain as installed. Importing a plugin 1. Click on the popup control ( ). 2. Click on Import Plugin. 3. Browse to the location of the plugin DLL file or PPK file. 4. Select the desired file type: .DLL or .PPK. 5. Select the file and click on Open. Plugins downloaded from the Resource Center will be placed in the appropriate category in the Plug-In Bar.
PAGE 884

l "Adding tasks" on page 302 l "Adding a branch or condition" on page 138 l "Cutting, copying and pasting tasks and branches" below l "Disabling tasks and branches" on page 886 l "Editing a task" on page 303 l "Moving a task or branch using drag-and-drop" on page 887 l "Replacing tasks, conditions or branches" on page 889 l "Removing tasks or branches" on page 888 In the Process area you can also: l "Undo a command" on page 891 l "Redo a command" on page 888 l "Highlight a task or branc
PAGE 885

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. From the Home tab in the Ribbon, choose Paste (or right-click and select Paste from the drop-down menu).
PAGE 886

Copying the On Error Properties of a task or branch Instead of pasting all properties, you can paste only the properties of the On Error tab of any task or branch on another one: 1. Copy or cut a task or branch from which you want the On Error properties. 2. Select the task or branch where you want to paste the On Error properties. 3. From the Home tab in the Ribbon, choose Paste On Error (or right-click and select Paste On Error from the drop-down menu).
PAGE 887

l l When a task is disabled, it is not executed when the process is run in Debug mode (see "Debugging your PReS Workflow process" on page 106) or by the PReS Workflow Service. When a branch is disabled, the whole branch including the tasks inside that branch is 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.
PAGE 888

1. In the 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. The dropped task or branch is moved above the item over which it was dropped. When you move a branch, all its tasks are also moved. When you move a conditional branch, all the tasks appearing on the True side of the condition are also moved.
PAGE 889

l l l Click on the task or branch you want to delete, go to the Home tab of PReS Workflow Ribbon and click on the Delete button in the Clipboard group. Click on the task or branch you want to delete, and press the Delete (or "Del") key on your keyboard. Right-click on the task or branch you want to delete, and select Delete from the menu. When you remove a branch, all the tasks located in that branch are also deleted. When you delete a task, only that task is deleted.
PAGE 890

Warning When you replace a task, you lose all the properties you set in this task. Resize the rows and columns of the Process area The rows and columns of PReS Workflow Process area in which tasks are located can be resized to better visualize the organization of your process. To resize rows and columns of the PReS Workflow Tools Process area: 1. In the PReS Workflow Tools Process area, place your cursor over the separator line dividing each section of row or column rulers. 2.
PAGE 891

l l From the View tab in the Ribbon select Collapse or Expand. Press the + key on the numeric keypad to expand the Branch or Condition, or the key to collapse it. To collapse or expand all Branches and Conditions: l l Right-click the icon of a Branch or Condition or the right corner of its line, and select Collapse all or Expand all. From the View tab in the Ribbon, select Collapse all or Expand all.
PAGE 892

Adding buttons To add a new button to the Quick Access Toolbar: 1. Locate the button you want to add in one of the tabs of the Ribbon. 2. Right-click on the button. 3. Select Add to Quick Access toolbar. Note The Quick Access Toolbar buttons cannot be moved or reordered. If you wish to reorder them, you will need to remove all the buttons and re-add them in the desired order. Removing buttons To remove a button from the Quick Access Toolbar: 1.
PAGE 893

commands that are frequently used and convenient to keep close at hand. You can minimize the Ribbon, and choose the position of the Quick Access Toolbar, as well as the commands it displays. l You can minimize the Ribbon by right-clicking on it and selecting Minimize the Ribbon. l You can also customize the Ribbon's color scheme in the Preferences window. The PReS Workflow Ribbon has five tabs: the Home tab, the View tab, the Debug tab, the Tools tab and the Help tab.
PAGE 894

Child/Go to Parent to move around a given process logical nodes (branches or conditions) and a Collapse/Expand, Collapse All and Expand all to collapse or expand branches and conditions in a process. l l The Debug tab includes the Data, Debug and Debug Messages groups. l l l l The Show/Hide group contains four controls to display or hide any of the four panes; the Configuration Components pane, the Object Inspector pane, the Message pane, the Debug Info pane and the Plug-in Bar.
PAGE 895

l l l l The Document Manager button opens the " PlanetPress Document Manager" on page 777. The Pen Manager button opens the "PlanetPress Capture Pen Management Tool" on page 781. The Test Page group: l l l The Service Console button opens the "The PReS Workflow Service Console" on the next page, allowing to monitor real-time information on the configuration execution.
PAGE 896

changed in the Comments tab. The PReS Workflow Service Console The PReS Workflow Service Console is a centralized service console and log viewer in one. You can use it to individually start and stop PReS Workflow services, as well as to view current and past log files for each service. Note The Service Console has changed greatly since version 7.4. If you are still using an older version of PReS, please see the user manual for your version instead.
PAGE 897

To pause a service temporarily: 1. Right-click on the running service. 2. Click on Active to remove the checkmark. If the service was currently processing a file, the service will wait for this action to complete before pausing. Once paused, the service is still "started" but will wait until it is activated again before processing jobs. This is very useful if you want to receive jobs from external services (such as with the LPD Server) but not process them right away. To kill (force quit) a service: 1.
PAGE 898

1. In the File menu, click on Open. 2. Browse to the location of the log file you want to open 3. Click on the log file and click Open. The log file is added, by name, at the end of the list of PReS Workflow services. Clicking on it opens the log file in the viewer. Right-clicking on the file brings a menu from which the log file can be refreshed, or removed from the list. The log viewer for existing log files does not refresh automatically since log files for older days do not generally change.
PAGE 899

Knowledge Base You can find extra information in Connect Knowledge Bases which complement the information contained in this manual. The PReS Workflow Knowledge Base can be found here.
PAGE 900

Legal Notices and Acknowledgments Warning: PReS Workflow is protected by copyright law and international treaties. Unauthorized reproduction or distribution of this program, via any means, in part or in whole, may be prosecuted to the full extent of the law. The license agreements for the associated open source third party components can be found in the following installation folder: C:\Program Files\Objectif Lune\OL Connect\Legal Notices This application uses the following third party components: l l l
PAGE 901

l Hamcrest Matchers Copyright © 2000-2006, www.hamcrest.org. All rights reserved. l HyperSQL, Copyright © 2001-2010, The HSQL Development Group. All rights reserved. l l l l l l l l l l l IcoMoon. Connect uses unmodified icons from IcoMoon (https://icomoon.io/#iconsicomoon) which have been made available under the Creative Commons By 4.0 license (https://creativecommons.org/licenses/by/4.0). ICU4J 4.4.2 Copyright © 1995-2013 International Business Machines Corporation and others.
PAGE 902

l l l l l l l l l l l Logback which is distributed under the terms of the Eclipse Public License (EPL) Version 1.0. The source code for Logback can be obtained from the following location: https://logback.qos.ch/download.html Mchange Commons Java which is licensed under the terms of the Lesser General Public License (LGPL) Version 2.1. The source code can be obtained from the following location: https://mvnrepository.com/artifact/com.
PAGE 903

l l l l l l Tern which is distributed under the terms of the Eclipse Public License (EPL) Version 1.0. The source code for tern can be obtained from the following location: https://github.com/angelozerr/tern.java Web Services Description Language for Java which is distributed under the terms of the Common Public License v 1.0. The source code for this can be obtained from the following location: http://wsdl4j.cvs.sourceforge.
PAGE 904

l Apache Commons IO l Apache Commons JCS Core l Apache Commons Lang l Apache Commons Logging l Apache Commons Pool l Apache Commons Text l Apache Commons Validator l Apache Derby l Apache Felix and dependencies l Apache Geronimo l Apache HttpClient Mime l Apache POI l Apache ServiceMix l Apache Xerces2 Java Parser l Apache XML Graphics l Apache XML Beans l Barcode4j l Google Collections l Google GSON l Hibernate Validator l Jackson JSON processor l Jetty l Liqui
PAGE 905

l Spring Dynamic Modules l UCanAccess l Woodstox Eclipse Technology: This Software includes unmodified Eclipse redistributables, which are available at www.eclipse.org. The Eclipse redistributables are distributed under the terms of the Eclipse Public License - v 1.0 that can be found at https://www.eclipse.org/legal/epl-v10.html. VSS Java FreeMarker: This product includes software developed by the Visigoth Software Society (http://www.visigoths.org/).
PAGE 906

license from Oracle. “Commercial Features” means those features identified Table 1-1 (Commercial Features In Java SE Product Editions) of the Java SE documentation accessible at http://www.oracle.com/technetwork/java/javase/documentation/index.html. Further Components: l l l This product includes software developed by the JDOM Project (http://www.jdom.org/). Portions of this software are copyright © 2010 The FreeType Project (www.freetype.org). All rights reserved.