2021.1

Manuals Brands Objectif Lune Manuals Applications PRes Workflow

Table Of Contents

Summary of content (908 pages)

PAGE 1
PAGE 2
PAGE 3

User Guide Version 2021.1 Last Revision: 2021-05-07 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 2021.
PAGE 5

Features 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 Da
PAGE 6

FTP Output Printer Queue 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 Using Scripts Run Script task APIs The Script Editor and XSLT Editor SOAP Server API Reference The W
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 2021.1 This PDF documentation covers version 2021.1. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow is the heart of all of our solutions. Working in conjunction with PReS Connect, PReS Capture, CaptureOnTheGO, PReS Imaging, PReS Fax, and a variety of plugins, it helps improve your communications processes.
PAGE 14

Tip Information that may help you use PReS Workflow better or that suggests an easier method. 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 22 l "Known Issues" on page 26 System requirements These are the recommended system requirements for PReS Workflow 2021.1.
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 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. While running PReS Workflow on these virtual machines may work fine we have not tested them and cannot offer support for them. Warning The PReS Workflow End-User License Agreement (EULA) specifies that a PReS Workflow software license may only be used on a single virtual or physical PC at a time.
PAGE 20

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: 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]\Connect (where [user] is the user under which Workflow is configured) On all systems: l C:\Windows\Temp\ Note C:\Windows\Temp\ is used by multiple software which may cause
PAGE 21

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

SHOWLAUNCHPROGRAM = 0 (Do not launch Update Manager after the installation is complete) CJKFONTS= 0/1 (CJK Fonts Lib) LASERFICHELIB = 0/1 (Laserfiche Lib) ICRLIB = 0/1 (ICR LIBRARY) SP = 0/1 (Sharepoint plugin) NET40 = 0/1 (Install Microsoft .Net 4.0 redistribuable) Example The following performs a silent install of Workflow and the Image and Search modules. "c:\temp\Setup.
PAGE 23

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 24

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 25

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 26

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 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 Anoto Pen Director 2.8 is not supported on Windows Server 2012 and Windows 10. 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. Barcode scanner task may have issues reading 2-D barcodes printed/scanned with low resolution.
PAGE 29

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. l l l l In the LaserFiche connector, when selecting a different template after filling up the fields and then going back to the first template, the values entered in the fields are lost. They have to be entered again.
PAGE 30

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 22). 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 829.
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 320 initial input task and a "Send to Folder" on page 676 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 842. 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 626 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 603 task. l An Output Creation Preset creates a "Create Output" on page 606 task.
PAGE 44

3. Double-click on the data file to open the data selector (see "The Data Selector" on page 853). 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 307. 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 832.
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 853) or Get Repository Location to open the Data Repository Manager (see "Data Repository Manager" on page 850). 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 401 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 858) 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 392 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 397 has the option to reset your Metadata according to the new PDF file. "OL Connect tasks" on page 590 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 397 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 449 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 599, "Create Print Content" on page 615, "Create Web Content" on page 619, "Render Email Content" on page 639, and the "Create Preview PDF" on page 610 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 430 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 877.
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 865. 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 606 task, and the "All In One" on page 590 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 829. 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
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 813.
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 163 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 167 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 170 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

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. Flag Effect 0 Hide the execution window. 1 Display the window normally. 2 Display the window minimized. 3 Display the window maximized. 4 Makes the window visible and brings it to the top, but does not make it the active window.
PAGE 162

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\Documents\invoice.OL-template). It returns empty ('') if the resource does not exist, and will log an empty line next to the task number if logged.
PAGE 163

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

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. l port is the TCP port number. l token is the authentication token. l method is the authentication method; currently, only basic is supported. Examples JavaScript Watch.GetConnectToken(); VBScript Watch.GetConnectToken Python Watch.
PAGE 165

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. For example: { "host": "localhost", "port": 1234, "token": "fdjhfds89r378cm034573890mc3y893r092p", "method": "basic" } l host is the host or IP address of the server. l port is the TCP port number.
PAGE 166

Example In the following example, GetJobFileName() retrieves the name of the job file, which is then logged using "Watch.Log" on page 170. JavaScript var s; s = Watch.GetJobFilename(); Watch.Log("The job filename is: " + s, 3); VBScript Dim s s = Watch.GetJobFileName Watch.Log "The job filename is: " + s, 3 Python s = Watch.GetJobFileName() Watch.Log("The job filename is: " + s, 3) Perl $s = $Watch->GetJobFileName; $Watch->Log("The job filename is: " + $s, 3); Watch.
PAGE 167

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.GetMetadataFileName(); VBScript Watch.GetMetadataFileName Python Watch.
PAGE 168

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. Files in the Connect resources folder are visible in Workflow's Configuration Components pane under Connect Resources (see "Connect resources" on page 39).
PAGE 169

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.Log("Jobinfo 3's value is: " + s, 2); VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.
PAGE 170

The original resource file, which is processed by this functionality, will not be deleted or altered in any way. The Workflow process will wait for the file(s) to be unpacked or copied to the Connect resources folder, so that the next plugin in line that uses an installed resource will have the latest, up-to-date version of the file. Files in the Connect resources folder are visible in Workflow's Configuration Components pane under Connect Resources (see "Connect resources" on page 39). Syntax Watch.
PAGE 171

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. Level Type Text Color in Service Console 1 Error Red 2 Warning Orange 3 Information Black 4 Debug Grey Arguments Message A string representing the message that is logged in the log file.
PAGE 172

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.SetJobInfo Sets the job information at the specified index to a specified string value. (See also: "Job Info variables" on page 714.) Syntax Watch.SetJobInfo(Index: Integer; Value: String) Example JavaScript Watch.
PAGE 173

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.SetVariable "MyVariable", "Desired value" Watch.SetVariable "global.MyVariable", "Desired value"/ Python Watch.
PAGE 174

VBScript Watch.Sleep 1000 Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.ReturnValue Set this variable to 1 (true) or 0 (false) in order to return a true or false status to 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 175

Python everythingOK = True if everythingOK: Script.ReturnValue = 1 else: Script.ReturnValue = 0 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.
PAGE 176

The term ... ... is the same as an Excel ... ... is the same as a Database ... Group Sheet Table Key Column Field KeySet Row Record 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.
PAGE 177

Using a JSON parameter or return value Whenever a parameter or return value is defined as a JSONStringArray type, that JSON array is itself a string. Since a JSON array internally defines double quotes as the delimiter for each element, you must enclose the entire string in single quotes. Alternatively, you can escape the double quotes inside the JSON Array. For instance, the following calls to AddGroup() are correct: repoObject.AddGroup("MyGroup",'["FirstKey", "SecondKey"]'); repoObject.
PAGE 178

Name Description "ClearAllData" on page 185 Delete all keysets in all groups, while retaining the existing key structure. ConnectionString Creates/opens a Repository to read from and write to at a custom location. Set ConnectionString to a string containing a full path and file name. "Version" on page 196 Returns the version of the DLL library used by the Repository.
PAGE 179

Name Description must not already exist in the specified group. Note that this method only adds a key name to the group, not a key value. See "AddValue" on page 184 for information on how to set a value for a key. "ListKeys" on page 189 Retrieves the list of all Key names and data types in Group GroupName, stored in a JSONStringObject. You should use JSON.Parse() to convert the string into an actual JavaScript object.
PAGE 180

Name Description returns the ID of the newly created KeySet. "GetValue" on page 187 Performs a lookup in group GroupName and retrieves the first value for key KeyName that matches Condition. The condition is specified using basic SQL WHERE syntax. The Condition may be left empty in which case the very first value found for the specified KeyName is returned. "SetValue" on page 194 Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition.
PAGE 181

Name Description 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. "GetKeySets" on page 186 Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all keys are retrieved.
PAGE 182

Name Description object "RepositoryLib.WorkflowRepository" (see Obtaining an instance of the Repository Object).JavaScript/* both methods perform the same task */repoObject.RemoveKeySetByID ("Users", 10);repoObject.RemoveKeySets ("Users", "ID=10");VB Script/* both methods perform the same task */repoObject.RemoveKeySetByID "Users", 10repoObject.RemoveKeySets "Users", "ID=10"" on page 1) AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames.
PAGE 183

AddKey Adds key KeyName to group GroupName. KeyName must not already exist in the specified group. Note that this method only adds a key name to the group, not a key value. See "AddValue" on the next page for information on how to set a value for a key. Syntax AddKey(GroupName: string, KeyName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.
PAGE 184

JavaScript repoObject.AddKeySets("Users", '[{"FirstName": "John","LastName": "Smith"},{"FirstName": "Richard", "LastName": "Doe"}]'); VB Script repoObject.AddKeySets "Users"," [{""FirstName"":""John"",""LastName"":""Smith""}, {""FirstName"":""Richard"",""LastName"": ""Doe""}]" Inserting a row In most cases, you won't need to insert or update a row in a script, as this can be easily done through the the Push to Repository action task.
PAGE 185

Syntax AddValue(GroupName: string, KeyName: string, Value: string): integer64 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 176). JavaScript repoObject.AddValue("Users", "LastName", "Smith"); VB Script repoObject.
PAGE 186

ClearRepository Deletes all groups, keys and keysets from the repository, returning it to a blank state. Use with caution! Syntax ClearRepository() GetKeySets Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all keys are retrieved. To ensure backward compatibility with versions prior to 2018.1, all keys are retrieved when the Keys parameter is left empty. It is however recommended to use an asterisk instead.
PAGE 187

myKeySet = repoObject.GetKeySets("Users", " [""FirstName"",""LastName""]", "Gender='M'") Querying a single row This JavaScript example shows how to get one or more rows from the repository and use them in the process. The script gets 3 fields ("firstname", "lastname" and "email") from the CustomerID field. It assumes there's a local variable called %{CustomerID} set in the workflow process. var CustomerID = Watch.GetVariable("CustomerID"); var repoObject = new ActiveXObject ("RepositoryLib.
PAGE 188

Condition may be left empty in which case the very first value found for the specified KeyName is returned. Syntax GetValue(GroupName: string, KeyName: string, Condition: 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 176). JavaScript var myValue = repoObject.
PAGE 189

"CustomerID='CURD654321'"); /* Update Values */ repoObject.SetValueByID("customers", "FormOfAddress", "Mr.", keySetID); repoObject.SetValueByID("customers", "Country", "US", keySetID); repoObject.SetValueByID("customers", "Language", "EN", keySetID); ListGroups Retrieves the list of all group names in the Repository, stored in a JSONStringArray.
PAGE 190

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 176). JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListKeys("Internal")); for (var Property in myList) { /* Log all key names for group Users to the console */ Watch.
PAGE 191

VB Script repoObject.RemoveGroup "Users" RemoveKey Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised. 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.
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 176). JavaScript /* both methods perform the same task */ repoObject.RemoveKeySetByID("Users", 10); repoObject.RemoveKeySets("Users", "ID=10"); VB Script /* both methods perform the same task */ repoObject.RemoveKeySetByID "Users", 10 repoObject.
PAGE 193

Deleting a row This script attempts to delete a client from the rows, then returns "true" or "false" in JobInfo variable %9 as a response. var CustomerID = Watch.GetVariable("CustomerID"); var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var deletedCount = JSON.parse(repoObject.RemoveKeySets ("customers","customerID = '" + CustomerID + "'")); var answer = (deletedCount > 0) ? "true" : "false"; Watch.SetJobInfo(9, answer); RenameGroup Renames group oldName to newName.
PAGE 194

Syntax RenameKey(GroupName: string, oldName: string, 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 176). JavaScript repoObject.RenameKey("Users", "LastName", "SurName"); VB Script repoObject.
PAGE 195

repoObject.SetValue("Users", ); repoObject.SetValue("Users", AND MaritalStatus='Married'" repoObject.SetValue("Users", AND MaritalStatus=''" ); "FormOfAddress", "Mr.", "Gender='M'" "FormOfAddress", "Ms.", "Gender='F' ); "FormOfAddress", "Miss", "Gender='F' VB Script repoObject.SetValue "Users", "FormOfAddress", "Mr.", " Gender=""M"" " repoObject.SetValue "Users", "FormOfAddress", "Ms.", " Gender=""F"" AND MaritalStatus=""Married"" " repoObject.
PAGE 196

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 176). JavaScript /* both methods perform the same task */ repoObject.SetValueByID("Users", "FormOfAddress", "Mr.", 10); repoObject.SetValue("Users", "FormOfAddress", "Mr.", "ID=10" ); VB Script /* both methods perform the same task */ repoObject.SetValueByID "Users", "FormOfAddress", "Mr.
PAGE 197

Metadata API The "Metadata" on page 75 is a hierarchical structure describing the data in a job. It is composed of 5 basic levels, from top to bottom: Job, Group, Document, Datapage, and Page. There is a set of plugins that allow to edit the Metadata during a Workflow process (see "Metadata tasks" on page 559), but you can also manipulate the Metadata in your process via scripts using the Metadata API.
PAGE 198

MetaFile The MetaFile object represents the physical Metadata file and is used to load and save the Metadata from and to the file system. It also publishes the "MetaJob" on page 200 object, which is the root node of the Metadata structure. The MetaFile object is the only object that is formally published to the user. All the other objects are obtained, directly or indirectly, through methods of this object. A standalone, empty MetaFile object can be created using CreateObject ("MetadataLib.
PAGE 199

Job() Returns the "MetaJob" on the next page node, which sits at the top of the Metadata tree structure. "LoadFromFile(const String Filename )" below Loads a Metadata file from the file system. "SaveToFile(const String Filename)" below Saves a Metadata file to the file system. "Export(const String Filename, TExportFormat Format)" below Exports the Metadata in a non-native format. LoadFromFile(const String Filename ) Loads a Metadata file from the file system.
PAGE 200

Format Format in which to save the file. The only value currently supported is efXml21 (value = 0), which is an XML format corresponding to the former Metadata native file format. Exceptions l EOleException: The specified export format is invalid. MetaJob Properties Name Type Description "Attributes" on page 232 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.
PAGE 201

account. 0: The node is not selected. 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 220 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 221 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 221 String Returns the value of the attribute of the specified name.
PAGE 202

Integer Index)" on page 224 field of the specified name. "Item(Integer Index)" on page 226 Node Returns the child (node) item located at the specified index. Group(Integer Index), see "Item(Integer Index)" on page 226 Node Returns the MetaGroup at the specified index. "PageCount()" on page 226 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.
PAGE 203

"SelectedPageCount()" on page 229 Integer "Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3)" on page 230 Returns the number of pages selected to be output that are underneath this node. Sorts the sub-nodes according to a number of criteria. MetaGroup Properties Name Type Description "Attributes" on page 232 MetaCollection Returns the node's attribute collection.
PAGE 204

"Selected" on page 219 Bool Indicates whether or not the Node is set to be printed. "SelectedCount" on page 219 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 216.) "SelectedState" on page 220 Integer Returns an integer indicating whether the node is selected or not, taking its parents into account. 0: The node is not selected. 1: The node is selected but one of its parents is not.
PAGE 205

"DatapageCount()" on page 222 Integer "Delete()" on page 223 Returns the total number of datapages present underneath this node. Deletes the node. "FieldByIndex(Integer Index)" on page 223 String Returns the specified field's value. "FieldByName(const String Name)" on page 224 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 224 String Returns the value of the N'th field of the specified name.
PAGE 206

"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. "SelectedDatapageCount()" on page 228 Integer Returns the number of datapages selected to be output that are underneath this node.
PAGE 207

page 218 "Fields" on page 233 MetaCollection Returns the node's field collection. "Index" on page 218 Integer Gets the index of the node in its parent. "NodeType" on page 218 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. See the detailed reference for the numerical values to use. "Parent" on page 219 Node Returns the parent node of the current node.
PAGE 208

"Add(Integer Index)" on page 220 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 221 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 221 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. "Copy() " on page 222 Places a copy of the node in the metadata clipboard.
PAGE 209

the documents from all the groups into account. "Item(Integer Index)" on page 226 Node Returns the child (node) item located at the specified index. Datapage(Integer Index), see "Item(Integer Index)" on page 226 Node Returns the MetaDatapage at the specified index. "PageCount()" on page 226 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.
PAGE 210

"SelectedIndexInJob()" on page 229 Integer "Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3)" on page 230 Index of the page among all the selected pages in the Job. Sorts the sub-nodes according to a number of criteria. MetaDatapage Properties Name Type Description "Attributes" on page 232 MetaCollection Returns the node's attribute collection.
PAGE 211

page 219 printed. "SelectedCount" on page 219 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 216.) "SelectedState" on page 220 Integer Returns an integer indicating whether the node is selected or not, taking its parents into account. 0: The node is not selected. 1: The node is selected but one of its parents is not. 2: The node and all of its parents are selected.
PAGE 212

"Delete()" on page 223 Deletes the node. "FieldByIndex(Integer Index)" on page 223 String Returns the specified field's value. "FieldByName(const String Name)" on page 224 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 224 String Returns the value of the N'th field of the specified name.
PAGE 213

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. "SelectedIndexInDocument()" on page 229 Integer Index of the page among all the selected pages in its parent Document.
PAGE 214

"Fields" on page 233 MetaCollection Returns the node's field collection. "Index" on page 218 Integer Gets the index of the node in its parent. "NodeType" on page 218 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. See the detailed reference for the numerical values to use. "Parent" on page 219 Node Returns the parent node of the current node.
PAGE 215

"FieldByName(const String Name)" on page 224 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 224 String Returns the value of the N'th field of the specified name. "IndexInDocument()" on page 225 Integer Returns the index of this page in its parent document, taking all the pages from all the datapages into account.
PAGE 216

l "MetaDocument" on page 206 l "MetaDatapage" on page 210 l "MetaPage" on page 213 The MetaJob is a collection of MetaGroup objects, where each MetaGroup is a collection of one or more MetaDocument objects, and so on, except for the MetaPage which does not have child nodes. Properties and methods All Node objects share a number of properties and methods that are common to all Node object types.
PAGE 217

SelectedCount only considers child nodes that have their Selected property set to true, but also checks if their parents also have their Selected property to true. It is therefore possible that a node is selected but is not counted. The SelectedState property can be used to verify the effective selection state of a node, i.e. whether or not a node will be part of the output and, if not, whether it is because it is itself not selected or one of its parents is not.
PAGE 218

Properties Attributes Returns the attribute collection (MetaCollection) of the current node. See "Attributes" on page 232. Count Not available in MetaPage Returns the number of child nodes in the current node. Fields Returns the field collection (MetaCollection) of the current node. See "Fields" on page 233. 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.
PAGE 219

3 Document 5 Datapage 6 Page Note In an Active Script environment, such as the Run Script task, the return value is a numerical value. However, in environments where the TNodeType type is defined, the node types are ntJob, ntGroup, ntDocument, ntDatapage, and ntPage. 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 216).
PAGE 220

Returns the number of child nodes in the current node that are set to be output, meaning that they have their Selected property set to true, taking the parents into account. Returns: The number (integer) of child nodes that will be included in the output. If the current node and all of its parents have their Selected property set to true, this amounts to the number of child nodes that are selected. If any parent is not selected, returns 0.
PAGE 221

Parameters: Index Specifies where in the child list to add the node. The node is inserted before the node at the specified index. In other words, the node being inserted becomes the node found at Index. To add a node at the start of the collection, use 0. To add it at the end, use Node.Count. Returns: Reference to the Node that was added. Exception: l EOleException: The value of Index is invalid. AttributeByIndex(Integer Index) Returns the value of the Metadata attribute at the specified index.
PAGE 222

Returns: The value of the attribute as a string. If an attribute named Name is not found, an empty string is returned. Clear() Not available in MetaPage Deletes all the child nodes of the current node, as well as all of its attributes and fields. 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.
PAGE 223

Returns the number of MetaDatapage nodes in all child nodes. This methods recursively goes through all child nodes to count the total number of MetaDatapage that are contained underneath the current node. Returns: Total number (integer) of MetaDatapage nodes found under the current node. Delete() Not available in MetaJob 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.
PAGE 224

0-based index of the field 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 field as a string. Exception: l EOleException: Index is lower than 0 or higher than Count-1. FieldByName(const String Name) Returns the value of the Metadata Field of the specified name. (See: "Fields" on page 233.) 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.
PAGE 225

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. Exception: l EOleException: Index is lower than 0. 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.
PAGE 226

Returns: Absolute index (0-based) of the page within all the pages in the job. 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.
PAGE 227

Paste() Not available in MetaPage 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 228

Select(TSelectWhat SelectWhat) Not available in MetaPage 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.
PAGE 229

SelectedIndexInDocument() MetaDatapage and MetaPage only 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.
PAGE 230

Returns the number of pages under the current node that are set to be part of the output, i.e. that have their Selected property set to true, as well as all of their parents. 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.
PAGE 231

All the parameters to this method except for the first one are optional. If a Name is specified, it must be valid for every sub-node. If, for example, the specified field is not found in a sub-node, 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.
PAGE 232

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 215 in the Metadata structure.
PAGE 233

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

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 facing 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 facing page Adds a new element with a customizable behavior if the name already exists.
PAGE 235

page 238 "Name(Integer Index)" on page 239 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 232 and "Fields" on page 233 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 236

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 237

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 238

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 239

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 240

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 facing page Integer Adds a new item in the sort list.
PAGE 241

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 242

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 243

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 244

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 245

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 246

VBScript implementation: set myPDF = Watch.GetPDFEditObject IPDF methods Name Return type Description "Close()" on page 248 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 249 Creates a new empty PDF file. "GetInfos()" on page 249 "IPdfInfos" on page 273 "GetVersion(*major, *minor)" on page 250 Retrieves the contents of the Document Information Dictionary from the PDF.
PAGE 247

"MergeWith2(pdfFilename, xnum, ynum, xoffset, yoffset, scaleFactor)" on page 251 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 252 Opens an existing PDF, optionally repairing it. "OpenEx(filename, password, doRepair)" on page 253 Opens an existing, password-protected PDF, optionally repairing it.
PAGE 248

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

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 255. 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 250

Return value An "IPdfInfos" on page 273 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 251

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 253. 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 252

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 253

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 251. Syntax VOID OpenEx (STRING filename, STRING password, BOOL doRepair) filename Name of the file to open.
PAGE 254

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 255

Pointer to an "IPdfPrintParams" on page 274 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 next page.
PAGE 256

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 257

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 245.
PAGE 258

srcIndex, srcCount, destIndex)" on page 260 "InsertFrom2 (srcPages, srcIndex, srcCount, destIndex)" on page 260 "Item(index)" on page 261 Inserts pages from another IPages object into this one. All relevant resources are copied with the pages. IPage (see "Page object" on page 262) "Move(index, count, offset)" on page 261 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 259

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 260

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 275 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 258.
PAGE 261

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 262

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 263

separated by a CR-LF pair. "ExtractText2(left, top, right, bottom)" on page 267 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 268 "IPdfRect" on page 275 Returns the size of the actual media, i.e. the sheet of paper. "setIncludeBorders (pbIncludeBorders)" on page 268 Sets whether or not borders are included for IPage.ExtractText2().
PAGE 264

left, top, rotateAngle, scaleFactor, layerName)" on page 272 "Size()" on page 273 () but allows to put the source page as a layer (aka an Optional Content Group). "IPdfRect" on page 275 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 265

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 266

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 267

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 268

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 273. Syntax IPdfRect MediaSize ( ) Return value An "IPdfRect" on page 275 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 269

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 270

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 271

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 272

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 273

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 274

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 275

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 276

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 277

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 278

$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 279

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 298.
PAGE 280

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 281

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 282

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 283

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 284

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 312 or "Load External File" on page 422, then use the "Delete" on page 652 task as a last output. The HTML is thus returned to the client.
PAGE 285

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 286

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 619 task. l If, however, the file is found, then it is loaded with the "Load External File" on page 422 task, and then deleted (for the same reasons).
PAGE 287

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 288

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 590. 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 289

l l l l l l The "Metadata Filter" on page 566 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 571 then re-orders the Metadata documents by Rep ID, so that all of the invoices for any particular sales representative are all together.
PAGE 290

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 291

l l l l The "Capture Fields Processor" on page 545, 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 537 task to do post-processing using the Capture Fields data. A "Get Capture Document" on page 555 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 292

l A "PGC to PDF Converter" on page 557 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 facing page l "Capture Web Manager Workflow" on page 297 Basic Functional Capture Workflow This workflow is the most basic and simple workflow that you can use with PlanetPress Capture.
PAGE 293

l "Capture Fields Generator" on page 542 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 294

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 295

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 296

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 297

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 298

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 299

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 300

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 301

l "Input tasks" on page 309 l "Action tasks" on page 380 l "Data splitters" on page 451 l "Process logic tasks" on page 471 l "Connector tasks" on page 490 l "PlanetPress Capture" on page 727 l "Metadata tasks" on page 559 l "OL Connect tasks" on page 590 l "OL Connect Send" on page 757 l "Document Management tasks" on page 677 l "Output tasks" on page 651 l "Unknown tasks" on page 712 Note Completely empty files (0 bytes) cannot be processed by Workflow.
PAGE 302

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 303

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 304

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 305

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 306

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 307

l 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.txt or filea.txt, but not file13.txt or filetest.txt. Brackets: Specifies a set of supported characters, or range of characters.
PAGE 308

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). If an Output task was originally designed to merge a PlanetPress Design document with data, this means no document is merged with the data and the job file is sent as is.
PAGE 309

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 310

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 311

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 865.
PAGE 312

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 313

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

Note If Microsoft Outlook connection is used, Microsoft Outlook 2000 or higher must be installed on the computer where PReS Workflow is located. Input Email Input captures all emails and their attachments from the selected inbox, when those emails correspond to the rules defined in the General tab. If no rule is defined, all emails in the inbox are retrieved. Emails retrieved using POP3 are deleted from the server, emails retrieved from an Outlook inbox are moved to the Deleted Items folder by default.
PAGE 315

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 316

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 317

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 865. 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 318

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 319

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

"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 865. 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 321

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 322

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 323

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 865.
PAGE 324

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 325

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 306.
PAGE 326

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 327

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 328

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 329

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 303). 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 330

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 865. 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 331

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 332

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 333

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 334

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 335

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 336

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 337

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 865.
PAGE 338

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 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 865.
PAGE 340

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 341

"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 865. 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 342

Input This task captures all of the PDF files present in a specific folder, in one operation. 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.
PAGE 343

l l l l l Use archive attribute: Select to turn on the archive attribute of the data files found in the source folder and to leave them in their original location (i.e. to take copies of the source files). Note that PReS Workflow never takes source files that have their archive attribute turned on (so the source files will not be taken again and again). When this option is turned off, PReS Workflow removes data files from the source location.
PAGE 344

"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 865. 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 345

Input The Microsoft 365 Email Input task captures an email and its attachments from the selected inbox when it corresponds to the rules defined in the General tab. It will process one email at a time (unless the process is self-replicating; see "Process properties" on page 865) 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) .
PAGE 346

Your Subscription 2020-01-22T14:03:38Z someone@ca.yourcompany.com 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\ PAGE 347
Job Information definitions l l l l l l %1 - Date received. Contains the date of the reception of the email (and not the date of retrieval by PReS Workflow). The format is YYYY/MM/DD HH:MM:SS. %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.
PAGE 348

Connection l l l l Application ID: Enter the application ID provided by Azure for this specific application. This value is static and cannot contain variables. Application Password: Enter the client secret (key) for the Azure app. This value is static and cannot contain variables. 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.
PAGE 349

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. 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 350

files in the queue. Once all the files are gone, the task polls the input folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. 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 351

l Treat as regular expressions: When ticked, the contents of the Mask field are deemed to be a regular expression . You can specify multiple masks based on regular expressions, separating the regular expressions by a semicolon. The checkbox is not ticked by default. Please refer to Regular Expressions for more information. Note No Variable Data can be used inside this field if the Treat as regular expressions option is ticked.
PAGE 352

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 353

change; when it changes you’d only have to modify the proxy list instead of the configuration. l You can enable or disable authentication using users from an Active Directory server. The NodeJS Server is only started automatically by Workflow when NodeJS input plugins are detected in the configuration. If no NodeJS input plugins are present, the service ("ppNode") is not started by Workflow; it can still be started manually, but will only serve static resources and redirect requests to other servers.
PAGE 354

Note Although 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 355

The request can contain one or more files, one being an XML file containing the request information as well as any GET, POST, PUT or DELETE variables that were received within this request. Other files are POST or PUT attachments. The NodeJS Server Input task supports basic content-types: multipart/form-data, application/xwww-urlencoded, and application/octet-stream, as well as raw body content-types: l text/plain (.txt) l application/xml, text/xml (.xml) l text/html (.
PAGE 356

Output First, the output inside the process itself is, depending on the selected options, an XML request file, POST Attachments files, either one or both. If the Send Immediate Response to client option is selected, the response file is sent back right away and the involvement of the input task ends then.
PAGE 357

Action names are not case sensitive. l l MIME Type: Select the MIME type of the file that will be returned by the plugin. Form Data Encoding: Specifies how this endpoint will interpret any form data received by the web server. 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.
PAGE 358

l l Do not include XML envelope: Only active when the previous Loop option is checked. When checked, the XML file containing the request data will not be available. Only the attachment itself is sent as a data file. Respond on error: Enter a message to be sent to the client as the output file if the process encounters an error and is unable to send a reply that includes the actual output file. The information can be in any desired format such as HTML or plain text.
PAGE 359

code provided by the process. l l Variable containing the response code: The contents of the Job Info variable or local variable (see "About variables" on page 713) selected in this drop-down, presumed to be a valid response code, will be returned in the response header. This is the value that is present at the end of the process, not the beginning. Ignore global authentication settings: Disable authentication for this particular URL, regardless of the global authentication settings.
PAGE 360

l l l %2 - Request Header: Contains the headers of the request, which can contain information such as the Browser and Operating System, languages, etc. %3 - Filename: Contains the local file name of the job file created by this task (and XML file). This is equivalent to %o. %4 - Attachment Index: Contains the index number of the current attachment while looping the attachments as data files. When the option Loop each attachment as a data file is not checked, the Attachment Index is 0.
PAGE 361

Output The task outputs the job file as is, with no evaluation or modification. The format of the job is PostScript generated by PrintShop Mail Web. PrintShop Web Connect Preferences A PrintShop Web Connect preferences page, accessible via the PReS Workflow Button | Preferences | PrintShop Web Connect, allows to provide operator credentials to your PReS Workflow configuration.
PAGE 362

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 865.
PAGE 363

When using the POP3 protocol, filtering is done at the client level. The plugin loops through every single email located in the inbox, retrieves the email’s header and applies the conditional logic. The plugin stops that loop when a header corresponds to the conditions. Only at that point the email's body and attachments are retrieved, and the email that corresponds to the conditions is deleted from the mail server.
PAGE 364

8\PlanetPress Watch\Debug\0103W5GQXZR2F0A\ Body.html Attachment C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0103W5GQXZR2F0A\ Priorities.xlsx Attachment C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0103W5GQXZR2F0A\ Bill of Lading (BOL).
PAGE 365

name is Peter” will be captured. These condition fields are variable property fields. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303. The use of the characters ? and * as wildcards is not supported in these fields. Note that it is not possible to specify multiple values in any of the fields. Login Tab Specify the connection information and options.
PAGE 366

l Use temporary filenames for attachments: Check this option to save each attachment in the Temp folder with a unique temporary filename (the system variable %u is used to generate a name). You will still be able to access the original attachment names when processing them. If the original filenames are used and multiple attachments have the same name, they will be appended with a numeric suffix, for example: File.pdf, File (1).pdf, File (2).pdf.
PAGE 367

which are configured through user options (see "Serial Input plugin preferences" on page 802). Only the properties set in the Other and Error tabs are specific to individual tasks. Input This task does not poll an input, it sits there and waits for a job file to be sent through the Serial connection. Processing When the job is received through the Serial connection, it is saved as a job file. No further processing is done on the file.
PAGE 368

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 - Source file name: Contains the name of the job file as specified by the software that sent the job. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 369

Output The output of 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 FTP server. Task properties General Tab l Server Settings group l FTP Server: Enter the IP address or host name of the FTP server to poll. l User name: Enter the name of a user account on the FTP server. l Password: If account named in the User name box is password protected, enter the password here.
PAGE 370

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

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

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. SMTP Input SMTP Input tasks are used to receive SMTP requests made by any email client or other SMTP commands and can act as an SMTP proxy, processing emails before they are sent to another SMTP server.
PAGE 373

Warning Due to a technical limitation the SMTP Input task does NOT receive the BCC addresses from most emails sent to it. Processing The task reads the incoming SMTP request and provides the data within its body. Output Depending on the Data Location option, the output is different: l Envelope: The request file in XML format, including all email fields (from, to, cc, bcc, subject, body) as well as additional header fields (email client information, attachments, etc).
PAGE 374

Task properties General Tab l l Data location: Determines what files are sent into the process: l Envelope: Only the request envelope is sent to the process (see above). l Attachments: Each attachment is sent down the process (see above). Unzip attached file: Select to unzip the attached files. l l Zip password: Enter the password required to unzip the attached files (if any). Note that you can use variables and data selections.
PAGE 375

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 865. 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 376

Input This task does not poll an input, it sits there and waits for a job file to be sent through the Telnet port. Processing When the job is received through Telnet, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. Task properties General Tab l l Port: Enter the number of the port on which PReS Workflow is to listen for Raw Socket communications. The default port number is 9100.
PAGE 377

The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 865. 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 This task does not generate any job information.
PAGE 378

Processing The print job, by default, is in EMF format. If this option is selected, no action is taken on the data file. However, if the RAW format is selected, the job is converted to RAW. Furthermore, if the Create PDF option is selected, the file is converted to a PDF, including metadata. Output Either one of 3 formats is output from this task: l An EMF job format l A RAW job format l A PDF with attached metadata.
PAGE 379

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

Action tasks Use action tasks in PReS Workflow to perform a wide variety of operations. PReS Workflow includes more Action tasks then Input and Output tasks combined. Action tasks can even be used to input data and to output data. The difference between an Action task and an Input task is that an Action task can never be the first task of a process. In the same fashion, the difference between an Action task and an Output task, is that an Action task can never appear at the end of a process.
PAGE 381

l "Send to Folder" on page 438 l "Set Job Infos and Variables" on page 440 l "SOAP Client plugin" on page 662 l "Standard Filter" on page 444 l "Translator" on page 445 l "Windows Print Converter" on page 446 Add Document The Add Document action task prepares a printer-centric PostScript job by adding a PostScript version of a selected PReS Connect document and the trigger to execute it before the active data file.
PAGE 382

l Add job information to the document: Select to prompt your PReS Workflow to add the available job information elements in the header of the generated file. Note that this option is only enabled if a document was selected. 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 383

Task properties General tab l l l l l l l l Action group l Add: Select if you want the task to add content to the job file. l Remove: Select if you want the task to remove content from the job file. Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file.
PAGE 384

Advanced Search and Replace Advanced Search and Replace action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data. Contrary to Search and Replace action tasks, they allow the use of regular expressions. Using regular expressions, it is possible to search for patterns rather than specific strings. For instance, a pattern can be specified to find all valid email addresses or phone numbers within the data stream.
PAGE 385

across multiple lines and may result in more successful hits. Note that since this option uses more memory, it may affect performance. l l l Treat as regular expression: Select to specify that the string or strings entered above are to be interpreted as regular expressions rather than ordinary text strings. This option disables all position options as well as the Whole words only option.
PAGE 386

by line option is selected in the Search mode group, the search counter is reset for every line. If the Search whole file option is selected in the Search mode group, the search counter is not reset before the end of the file. Select one of the occurrence options (described below) in the list box below and enter a value in the Occurrence value box besides it. l l l l l At occurrence: The replacement will take place only when the specified number of occurrences has been reached.
PAGE 387

l Tag Image File Format (TIFF) l Portable Document Format (PDF) l Joint Photographic Experts Group (JPEG and JPG) l Portable Network Graphics (PNG) l Bitmap (BMP) Processing The task reads the image and detects the presence of the selected supported barcode types. When a barcode is detected, the data it contains is read and added to the Data Page level of the Metadata. Note This task does not recognize more than one level of the Metadata Document.
PAGE 388

Barcode types Description UPCE UPCE symbology. Short version of UPC symbol, 6 characters. Code11 Code 11 symbology. Used to identify telecommunications equipment Code39 Code 39 symbology. U.S. Government and military use, required for DoD applications Code93 Code 93 symbology. Compressed form of Code 39. Code128 Code128 symbology. Very dense code, used extensively worldwide. Codabar Codabar symbology. Used in libraries and blood banks. Inter2of5 Interleaved 2 of 5 symbology.
PAGE 389

Barcode types Description RM4SCC RM4SCC symbology. Used by the Royal Mail. Note The fewer barcode types are selected, the faster the plugin performs. Selecting only the expected barcodes is therefore a good practice. Barcode orientations Barcode orientations represent a barcode orientation on an image. For example, when the leftto-right option is checked, the task will try to read the barcode value assuming that the barcode data should be read in a left-to-right fashion.
PAGE 390

l l l l Process by File: The task will process the file once and will insert the barcode information in one Metadata file. Metadata will be created if it does not exist or will be enhanced with the values if it already exists. Replace non-printable character with: Enter a character that will be used as a replacement for all non-printable characters read from the barcode.Some barcode types like Data Matrix can store non-printable characters that Metadata does not support.
PAGE 391

l l If the selected option is process by page, then the Metadata file is created and overwritten for each new scanned page. If the selected option is process by file, then only one Metadata file will be created (or updated). Note If Metadata was created previously in the process, the task only adds new fields to the existing Metadata at the datapage level. Metadata fields The barcode values are stored at the datapage level of the Metadata.
PAGE 392

l l Barcode_1_Left: Metadata field providing the distance (in pixels) from the left of the page to the left side part of the first barcode. Barcode_1_Right: Metadata field providing the distance (in pixels) from the left of the page to the right side part of the first barcode. Accessing a barcode value from the Workflow tool One method to access a barcode value from the Workflow configuration tool is to use a VBScript with the Open Script task, using the Watch.
PAGE 393

Emulation action task. All the tasks that follow on the same branch will use the emulation chosen in the Change Emulation task. Input Any data file. Processing The emulation for the following tasks is changed to the selected emulation. Output The original data file, metadata and job infos are not modified. Only the emulation is changed.
PAGE 394

start of the first data page. Note that you cannot add lines in either a CSV or user defined emulation. Lines per page: Enter the number of lines each data page contains, or use the spin buttons to increment or decrement the value. Pages in buffer: Enter the number of data pages you want the data page buffer to contain, or use the spin buttons to increment or decrement the value. Read in binary mode (ASCII emulation only): Select to read the data file in binary mode.
PAGE 395

l l CSV (comma separated values). l l l l l Remove HP PCL escapes: Select to have the document remove any Hewlett Packard Printer Control Language (HP PCL) escape sequences it encounters. Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the document splits that data into two fields. If you want to use a backslash character (\) as a delimiter, you m
PAGE 396

the underscore characters of the underline on the following line. The first character of the line with the text is a code that tells the printer to ignore the LF at the end of that line. The result is underlined text. It is important to understand what happens when you tell the channel skip emulation in PlanetPress Design to ignore the LF at the end of a line.
PAGE 397

plugin works on the data file. Caching the XML data will make subsequent tasks run faster (as loading an XML file can take a long time) but will also use up more memory since that memory isn't released in between tasks. For single runs the performance gain is less noticeable than in loops (either through a splitter, a Loop task or a metadata filter) where the XML file would be loaded repeatedly. l PDF. (Nothing to configure.) Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 398

Processing A PostScript file can be converted straight into PDF. A regular data file needs to be merged with a PlanetPress Design document first, except for a PDF file, which may or may not be merged with a PlanetPress Design document. When a PDF file is used as-is, the Create PDF task will apply the active Metadata to the PDF data file (for more information on this see "PDF Workflow" on page 287 and "Working with Metadata" on page 78).
PAGE 399

but keep in mind that the resulting PDF may be much larger than it should be and may even be too large for PReS Workflow to handle. l l Reset Metadata according to new PDF: The Metadata is updated to include only the selected nodes from the current Metadata, and sequential indexes are recreated. Security group l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files.
PAGE 400

used in the document, the entire font is embedded. This option often produces smaller PDF files and ensures proper PDF display. l Initial view group l l Zoom factor: Select the magnification at which you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to open the generated PDF. Choose the Fit in window option to display the entire page using the available screen space, or choose a percentage of the actual document size.
PAGE 401

l Keywords: PReS; Create PDF plugin l Monochrome images: l l l l l l Compression: CCITT l Pixels per inch: 1200 Grayscale images: l Compression: Auto l down sampling: Bicubic l Pixels per inch: 300 Color images: l Compression: Auto l down sampling: Bicubic l Pixels per inch: 150 Security: l Allow printing l Allow changing the document l Allow content copying l Allow form filling Font: l Embed all fonts l Subset embedded fonts Open options: l Zoom factor: Fit in window
PAGE 402

be used to gather secondary input (see "Input tasks" on page 309). In cases where all your data comes from databases, you can use a Create File input task as a dummy task at the beginning of your process, and then use a PReS Workflow Database action task to gather your actual data. Note Database Query action tasks require version 2.5 or higher of the Microsoft Data Access Components (MDAC), including JET 4.0.
PAGE 403

Task properties Database Connection Tab l Database group l l l Table/Query: Select the table or query containing the information you need as your input data. Range group l l l Location: Enter either the path and name of the database or a database connection string in this box. You may click to navigate to the database and paste the database path and name automatically to this box. You may also click create an ODBC connection string to the data source and paste the string automatically to this box.
PAGE 404

above (Table/Query box) can contain a single record, a fixed number of records, or a variable number of records. To choose the last option, select one of the When [field name] changes listed in this box. l l l Maximum number of records per page: For data pages that contain multiple records (a fixed or variable number of records), enter a maximum number of records per page in this box. Note that this value cannot exceed 4,000.
PAGE 405

l XML Emulation: If you selected XML in the Output file emulation box, the following options are available: l l l l l l l l l Create data pages as follows: Select the option used to generate the data pages. Each data page created using the table or query selected above (Table/Query box) can contain a single record, a fixed number of records, or a variable number of records. To choose the last option, select one of the When [field name] changes listed in this box.
PAGE 406

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 Include password in config: Select to save an encrypted version of the database password (if any) within the exported configuration. Export Config: Click to export the currently displayed properties of the PReS Workflow action task. The exported configuration can then be reused on other PReS Workflow workstations.
PAGE 407

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. Decompress File(s) Decompress File action tasks decompress zipped job files (files compressed as zip files). Input This task only accepts ZIP files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself.
PAGE 408

l l l Restore path structure: Select if you want the complete file structure to be rebuilt from the output folder to the decompressed files. Force directories: Select if you want to allow the system to create new folders when required. If this option is not select and the Decompress file action task tries to save a file to a folder that does not exist, the task will fail.
PAGE 409

Task properties General Tab l l l Host: Select the IP address of the PReS Image host to which you want the request to be sent. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box. Documents: Select None (Do not use a document (passthrough) in order to generate an image with a PDF/VT or PostScript file in passthrough mode.
PAGE 410

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

This option goes with the Multiple TIFF option and is only visible if either the AutoStore, DocAccel or KYOcapture format is selected. l Data Stream group: Determines what is output by the Digital Action task: l l l l l l l l Use Digital as new data stream: Use the file generated by the task for the rest of the process. Use original data stream (without document): Use the same data file as what was input to this task.
PAGE 412

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 413

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

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

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

in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font. l l Initial view group l l l Subset: Select to embed only a subset of the Type 1 and TrueType fonts used in the document. A font subset is in fact composed of only those characters that are actually used in the document. This option can only be used if the Embed all fonts option is selected.
PAGE 417

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

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

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

Note As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the "Network considerations" on page 22 page. There are some important things to consider when using the External Program task: l l The executable file must accept so-called "command-line options" and be able to run without any sort of user interaction.
PAGE 421

run in command mode. Note that the program will be run without user interaction. Although it may display progress information, it is better if the application has no user interface. l l l l Start in: Enter the folder in which the external program is to run. This is important, for example, if the program is to generate files that are to be picked up in a specific location for further processing, or if it requires resources that are located in a specific folder.
PAGE 422

condition set will cause be considered a success and any other exit code will cause the On Error tab to be triggered. 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. Load External File Load External File action tasks are used to replace the current job file by the designated text file. Loading an external file does not delete the original file or modify it in any way.
PAGE 423

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Mathematical Operations The Mathematical Operations action task resolves a mathematical expression and stores the result in an existing Job Information or other type of variable (see "About variables" on page 713). 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.
PAGE 424

and VBScript mathematical expressions. For example, to multiply Job Info 9 by 2, the expression would be %9*2 . Note The expression itself must be written in a format understood by the VBSCript scripting language. For more information, please see Mathematical Functions in VBSCript and VBSCript Math Operators. l l Store result in: Variable data field containing the job information, local or global variable in which to store the result.
PAGE 425

Processing The XSLT is applied to the XML data file. Output The modified XML data file is output. Metadata and Job Info variables are not modified. l l File l Import: Lets you open an existing XSLT script from an XSL, XSLT or TXT file. l Export: Lets you save the current XSLT script as a file. l Print: Prints the current XSLT script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor).
PAGE 426

l Tools l l Editor Options...: Opens the "Editor Options" on page 813. Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l l l The script editor text box: This is where you enter your XSLT Script that will be used. If you use an external script file, this will display the content of the file (note however that modifying the script in this case does not modify the external file and changes are not saved).
PAGE 427

Input This task accepts any job file as input. If the job file is the target file to which the attachments must be added, it should be a PDF/A-3 file. Note, however, that the task doesn't verify that the input file is PDF/A-3 compliant. Processing The task reads each of the files that are listed as attachments and adds it to the target PDF with the name that was specified for that attachment. The target file can be either the job file or an external PDF/A-3 file.
PAGE 428

Note All of the Attachments properties can be variable (see "Variable task properties" on page 724). You can right-click on a field to open the contextual menu and select variables, data, and lookup functions. The property will be dynamically determined whenever the process runs. l Filename: The file that should be used as an attachment. You can enter %F to attach the current job file to the target file (see "System variables" on page 715). Note The target file cannot be attached to itself.
PAGE 429

l Unspecified: The relationship is not known or cannot be described using one of the other values. e-Invoicing metadata Tab Optionally, the PDF/A-3 file can be extended with metadata that describe the PDF as an invoice that conforms to a certain standard. This is either the (Thai) Electronic Tax Invoice PDFA, ZUGFeRD 1.0 or the Factur-X/ZUGFeRD 2.0 standard. The plugin doesn't verify that the resulting PDF/A-3 file and attachment conform to the chosen standard; it is up to you to ensure that it does.
PAGE 430

Push to Repository The Push to Repository Action task adds data to the PReS Workflow "Data Repository" on page 95. The task may only add one KeySet per action. If more than one insert is needed, a loop must be established first. The Push to Repository task can also be used to update an existing KeySet if a lookup is provided. Input Any data file, in any format. Processing A new KeySet is added to the Data Repository, or updated, using the data provided. Output The unmodified input file.
PAGE 431

l l l l Create Group and Key(s) if they don't exist: Check this option to force the creation of a new group and/or keys, if they do not exist. This is useful for portability: if a configuration with this task is sent to a new Workflow server that does not contain this group or is missing keys, the task will create them automatically. Update based on: Check this option to update an existing KeySet instead of creating a new one.
PAGE 432

Output The input data file is output, with the new name. Task properties General Tab l New file name: Enter the job file’s new name.You can use any combination of text, variables and data selections; see "Variable task properties" on page 303. 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 433

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. Note When using Run Script as a Condition, the output of the task can be within the branch or on the main trunk. To control the output, use the "Script.ReturnValue" on page 174 variable in your script.
PAGE 434

l Search l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog. l l l Language: Select the language in which your script is written. Choices are VBScript, JavaScript, Perl or Python. Tools l l Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Editor Options...: Opens the "Editor Options" on page 813.
PAGE 435

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. Search and Replace Search and Replace Action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data.
PAGE 436

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 303. Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies. List of words to find and replace: Lists each string to find, and its replacement. These are executed in order, from top to bottom.
PAGE 437

Output task set to 'pass-through' (No document), in order for the images to be actually sent to that printer. Note Images sent to a printer are stored in the root folder of the printer’s hard disk, while images sent to the virtual drive of another computer are stored in a sub-folder of the PReS Workflow folder. Input Any image file that you wish to upload to the printer. Processing The currently active image data file converted to PostScript.
PAGE 438

l l l l l l l l Color conversion: Select As is to keep the color information included in the images. Select Grayscale to convert color images to gray scale. Naming convention: Select ’File name, original’ to store the file under its original file name. Select ’File name, no extension’ to store the file without its original file name extension. Note that all characters are converted to uppercase and that extended characters (characters, such as é, for example) are not recommended in image file names.
PAGE 439

PReS Workflow will wait for the task to be completed before going on to the next task in the configuration. Note As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the "Network considerations" on page 22 page. Input Any data file in any format. Processing A copy of the data file is saved on the hard drive at the specified location.
PAGE 440

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. Set Job Infos and Variables Add Set Job Infos and Variables action tasks to set Job Info elements as well as custom variables (see "About variables" on page 713). You can set multiple variables and Job Info values in a single task. Be aware that lines are processed from top to bottom. Input Any data file in any format.
PAGE 441

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. SOAP Client plugin SOAP Client plugin tasks can be used as Input, Output and Action tasks, although their basic function is to generate output. SOAP (Simple Object Access Protocol) is a light protocol that defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems.
PAGE 442

Timeout By default the SoapClient plugin waits 100 seconds before returning an error if it doesn't get a response. To change the time the Soap Client plugin should wait, a Timeout registry key can be set in: HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Objectif Lune\PlanetSuite\PlanetWatch\TimeoutVal (DWORD) The value can be set to anything, in seconds. To wait indefinitely for a response, -1 can be used. However, this could cause the process to hang if the Soap Server never responds nor closes the connection.
PAGE 443

l l l l l l l Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below. As script: Click to apply the options you chose above and to display information on the chosen Web service in JavaScript format in a script viewer. You should use this option if the Web service is too complex to be interpreted correctly by the SOAP Client plugin. Name: Displays the name of the arguments associated with the selected method.
PAGE 444

Standard Filter Standard Filter Action tasks can be used to remove HP Escape characters from data files, as well as to eliminate spacing problems caused by LF-CR end-of-line sequences. HP escape characters are used in the Hewlett Packard Printer Control Language (HP PCL) to communicate basic page formatting and font selection information from print jobs to HP or HPcompatible printers.
PAGE 445

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

Output The data file in its new encoding format. Metadata, Job Info variables and other variables are unchanged. 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 447

l l The Windows print file is first converted into an XML file in which each printable character appears with its horizontal and vertical coordinates. The XML file is then converted into a standard Line Printer file. 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.
PAGE 448

distance lie within the tolerance, outputting it in one line. At the output, these text passages are separated by a tabulator (ASCII code 9). l l Font size difference: Indicates the smallest acceptable factor between maximum and minimum font size within one line. A value of 0.60 means that with a ratio from 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.
PAGE 449

l l Vertical distance: Indicates the biggest acceptable vertical distance between two text passages so that they're still recognized as belonging together. This is the 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.
PAGE 450

Input The current job file. Processing The current job file is converted from XML to JSON or from JSON to XML. When converting from JSON to XML, the encoding of the resulting XML file is always set to UTF-8 (which is the default format for JSON). The converted job file gets the appropriate extension (.JSON or .XML).
PAGE 451

Task properties General tab l Automatic detection: By default, the format of the job file is detected automatically. If the source file is a JSON file, it will be converted to XML. If it is an XML file, it will be converted to JSON. Uncheck this option to limit the task to one type of conversion. l JSON to XML: the task only converts JSON files to XML. l XML to JSON: the task only converts XML files to JSON. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 452

In OL Connect jobs, data is normally extracted from a data file using the "Execute Data Mapping" on page 626 task. That task stores the extracted data in records which can then be merged with a template. Warning Splitters do not modify the Metadata that is currently active within your process.
PAGE 453

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

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

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

Input Any emulated data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task.
PAGE 457

l l l l l l l From line: Enter a value corresponding to the first line on which the splitter must start searching for the word. To line: Enter a value corresponding to the last line on which the splitter must start searching for the word. From column: Enter a value corresponding to the first column in which the splitter must start searching for the word. To column: Enter a value corresponding to the last column in which the splitter must start searching for the word.
PAGE 458

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. Generic Splitter The Generic Splitter is a legacy task which is kept for backwards compatibility. In previous versions of PReS Workflow, it was the only splitter available. While this splitter seems to have more options than the other ones, this is only because it contains combined features from these other splitters.
PAGE 459

l l Use emulation: Check to emulate the data before splitting the file. This lets you split the file on a word, a word change, a page number, a database field value or a database field change. When this option is not checked, you can only split the file on a form feed, a specific number of lines, or a chain of characters. See below for detailed information on any of these splitting methods. With this option unchecked, data selections are done with the File Viewer.
PAGE 460

l Where to split group l l l l Pages: Enter exactly where to split the file. Enter 1 to split the file 1 page before or after the string, 2 to split the file 2 pages before or after the string, or 0 to split the file immediately before or after the string. Before or after: In the previous box, you entered exactly where you wanted to split the file, here is where you specify whether you want the split before or after.
PAGE 461

l Where to split group l l l l Before or after: In the previous box, you entered exactly where you wanted to split the file, here is where you specify whether you want the split before or after. Split when word changed: You may not want to split the file every time the string of characters entered above changes, but only every other time, or every third time. If so, enter the number of times in this box.
PAGE 462

l l Consider case: Select to force the Generic Splitter to match the character casing of the string of characters entered in the Value box with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Where to split group l l l l Pages or records: Enter exactly where to split the file.
PAGE 463

in the Pages or records box and “Records after” in this box, for example, to split the file 5 records after the record that matches the condition. l Split when condition found: You may not want to split the file every time the string of characters changes, but only every other time, or every third time. If so, enter the number of times in this box. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 464

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

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. PDF Splitter PDF Splitter Action tasks are used to split emulated PDF data files into multiple data files that are passed to subsequent tasks in the process. When using a PlanetPress Design document, the PDF Splitter will do the job quicker than the Metadata Sequencer task that can also be used to split PDFs. However, when using a PDF as input, the Metadata Sequencer might perform better.
PAGE 466

Task properties General Tab l Split on page: Select to split the data file based on pages (rather than on a word found within the PDF 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 467

l l l l 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 On region 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 468

attribute / field is compared with the one in memory. If they are different, either a new sequence starts or the current sequence is ended. The next sequence starts with the next Metadata level being processed. For details see the "Rule Interface" on page 870. l l Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized. Optimization can lead to a significant reduction in the size of the PDF, but it may also add a certain amount of time to the process.
PAGE 469

Task properties General Tab This tab lets you choose the splitter settings for the default PReS Workflow XSLT engine. If you want to use your own XSLT engine, click the Alternate XSLT Engine tab. l Split method: Use this box only if you want to edit the standard XSLT script that will be used to split the XML file. First use the Standard XML splitter option to define the standard settings. Then, to change the standard XSLT script, select Advanced XML splitter and edit the script as required.
PAGE 470

l l l l l l Encoding group: This group lets you indicate whether you want the splitter to use the file’s own encoding or the universal encoding UTF8 to process the file. Note that if the file contains no indication as to which encoding should be used, the default system encoding will be used. This may result in errors being generated or split files that contain bad data. Using the UTF8 encoding can prevent such errors. Use UTF8 encoding: Select if you want to use the UTF8 encoding to process the file.
PAGE 471

l l l l XSLT file button: Click to add the {XSLTFILE} variable to the command prompt displayed in the box above. Data file button: Click to add the {DATAFILE} variable to the command prompt displayed in the box above. Output file(s) button: Click to add the {OUTPUTFILE} variable to the command prompt displayed in the box above. Browse button: Click this button and browse to select the XSLT engine you want the XML splitter to use. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 472

variable or information from your job file, and store the iteration of the loop in a Job Info variable. The "Send to Process" on page 483 and "Go Sub" on page 478 tasks are used to send the job file to another process or subprocess and, in the case of the GoSub, to get information back from the subprocess. Note Branches, Loops and other Process logic tasks do not generally modify the job file, though some may change system variables.
PAGE 473

Branch A Branch duplicates your job file along with accompanying information. Branches do not execute in parallel - the branch is executed, and then the trunk (or the following branch) continues. For more information about branching see "About branches and conditions" on page 137. Task properties Backup Tab l l l l Backup job file: Select if you want PReS Workflow to use identical copies of the job file for the main and secondary branches.
PAGE 474

In case of the failure of a Branch task (the branch itself, not the other tasks contained within), by default the process will ignore the branch and simply go down the main trunk. You can overwrite this in the On Error tab. 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 475

If the folder or file count value is invalid and the task is used as Input task, the process does not run. If it is a Condition task, it returns False. No error is generated. Output Job Information definitions When used as Input task, the File Count task sets the following Job Info variables. l %1 - FolderName. The target folder. l %2 - Mask. The specified mask. l %3 - FileCount: The specified file count.
PAGE 476

l l File count: Select whether the condition is to check if the file count is equal to, less than, greater than, less than or equal to, or greater than or equal to the specified value. Value: Enter the desired file count. This is a variable property field. (See "Variable task properties" on page 303.) Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties.
PAGE 477

File/Folder Condition The File/Folder Condition tasks checks if the specified file or folder exists and returns true if it exists, or false if it doesn't exist. Task properties General Tab l File or folder to check: Enter one file or folder name. The name may contain text, variables and data selections (see "Variable task properties" on page 303). The Browse button allows to select a file or folder on disk. Advanced properties Right-click the task in the Workflow process and select Advanced Properties...
PAGE 478

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 Size Condition File Size conditions test the size of the job file they receive. Note that the job file may include data selections, attachments and documents that were added by other tasks. If a file does not exist, it's file size will be 0kb.
PAGE 479

Every subprocess starts with a BeginSub input task and ends with a EndSub output task, both of which have nothing to configure and cannot be replaced or deleted. The simply represents entry and exit points for the subprocess. Note While it is possible to place a GoSub action within a subprocess, doing so will hide the subprocess from any GoSub action, in order to avoid circular referencing (aka an infinite loop).
PAGE 480

Loop Loop action tasks are used to repeat those tasks that are located after it on a given process branch. The number of repeats can be fixed or variable, as required. Note The Metadata is not reset at the start of each iteration. See also: "Output issues caused by Metadata, and how to avoid them" on page 80. 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.
PAGE 481

Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" on page 419). However, they can be slower to execute. The Run Script task can be used either as an Action or a Condition.
PAGE 482

l File l l l Export: Lets you save the current script as a file. l Print: Prints the current script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l l Paste: Paste the last selection that was cut or copied in the location of the cursor in the text editor. 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.
PAGE 483

modifying the script in this case does not modify the external file and changes are not saved). l l Script running from: Choose if the script should be run from the editor text box, or from an external script file. Script filename and path: Either 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.
PAGE 484

In either case, the called process will ignore the input task along with its Job Info variables and schedule, and use the job file, Job Info variables, Metadata and variables from the current process. Note that a process called through the Send To Process plugin will not self-replicate, even if the process' preferences specify that it should. The initial Input task is being bypassed, and since it's the Input task that initiates the self-replication procedure, self-replication cannot occur.
PAGE 485

management information bases (MIB) and object identifiers (OID) that are extensible and can be vendor specific. Management Information Base Object Identifiers A Management Information Base (MIB) is a database of Object Identifiers (OIDs) that can be used to monitor device objects using SNMP. An MIB OID can point be a printer tray, cartridge or hard disk, or to modem mode.
PAGE 486

l l l Condition type: Select Printer Queue to test a standard printer status condition or User Defined to test a status identified using a printer specific identification code. Bear in mind that the failure to comply with any of the test conditions selected below will make the whole condition False.
PAGE 487

Text Condition Text Condition tasks can be used to perform two different types of tests: l l To test the presence of a string within the job file. You can, for example, search for the string “Gold member” on the first line of the job file. As another example, you could search for a variable string retrieved via a job info variable or a data selection in a given location in the job file. To compare two strings. As with the test above, this test can also be used to search for a string in a given location.
PAGE 488

comparison. If you chose an operator that compares numeric values, you should select this option. l l l l l l On numeric error: This option is only available when the Numeric comparison option is selected. Select the behavior you prefer when PReS Workflow is unable to successfully perform a numeric comparison. Select ”Return the error”, if you want the Text condition to fail altogether. Select ”Return true”, if you want the condition to be considered True.
PAGE 489

The Time of Day Condition differs from the process schedule in the fact that you could put this condition after generating some output, and you can also run tasks when the condition itself is false, which is not the case for a process outside of schedule. You can choose contiguous as well as separate time blocks as required. The condition is tested True every time the current time and date corresponds to a selected time block.
PAGE 490

Connector tasks A Connector, as the name implies, is a task that connects to something outside of PReS Workflow itself. In some cases those are other parts of the PReS Workflow, but in other cases we offer connectors for third-party applications or systems.
PAGE 491

l l l Use Job ID: Check to send the Job ID chosen in the PitneyBowes Scan Code utility along with the job. Use External MRDX and PDF: Check this option to ignore the MRDX creation and use an existing PDF and MRDX instead. l l Mailrun ID: A unique identification for the current job. This ID must never be the same between two mail runs - we suggest using either %f or %u , which are both always unique as they are based on date and time.
PAGE 492

Processing This task connects to a Capture OnTheGo Repository and requests removal of a document with a given document ID. The protocol used is SSL 2.3. 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.
PAGE 493

Input from SharePoint The Input from SharePoint task can be used to retrieve files from a SharePoint server on your network, filtering on your template fields and creating Metadata to use in your process. When the Input from SharePoint task runs, it first lists all of the files to download then runs the process once for each file in the list. If any new files are added during the process, they will not be touched until the next time the process is scheduled.
PAGE 494

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

l l l Download files from sub-directories also: Check to also look into subdirectories of the specified Folder. Do not download checked out documents: If the document is set as "Checked Out" in SharePoint, it will be ignored. Action Group l l l Download the document: Simply download the document and do not modify it in SharePoint. Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint.
PAGE 496

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 865. 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 497

Processing A connection is established with the Laserfiche server, the file is uploaded and the metadata in the Laserfiche server is generated correctly. Output The output from this task is the specified file along with the metadata within the Laserfiche server. The file is not directly modified by this task. Task Properties General Tab l Laserfiche configuration group l l Folder: Enter the Laserfiche client repository folder where the documents will be exported.
PAGE 498

files. l l If the PReS Image archive folder field is empty and the option “Use PReS PDF/A” is selected, a warning message will be displayed: "You should insert PReS Image archive folder source". The indexes in the PlanetPress Design document must match the ones in the Laserfiche server. Connection Tab l Server Name: The server name or IP address of the server you wish to connect to. l Repository: The name of the repository you wish to send the files to.
PAGE 499

l l If you intend to use PDI for number type, your decimal separator in both your Regional and Language Options and in PReS Index (PDI) numbers should be a dot ("."). The Laserfiche output task will only work if an activated PReS Image is found, either locally or on the network. Lookup in Microsoft® Excel® Documents The Lookup in Microsoft® Excel® Documents action task is used to complement your job file's Metadata by retrieving data from a Microsoft® Excel® spreadsheet on your system.
PAGE 500

Use Case 2: Translate a list of line items descriptions into a given language A PlanetPress Design document takes as input a transactional PDF file, and reproduces it exactly as it enters. Metadata fields called ItemDesc are created, one for each line item description, at the data page level. Each ItemDesc Metadata field is given the value of a line item description as found on a region of the current data page.
PAGE 501

l Metadata group l l l Lookup Field: The name of the Metadata field that will be used to determine which row should be returned. The Metadata field can be on any level. Lookup Column: The name of the column in the Microsoft® Excel® worksheet that corresponds to the contents of the Lookup Field. Action: What to do with the resulting data from the Microsoft® Excel® worksheet. This can be: l l l l l l l Add Field: Creates a new field with the data. This may cause multiple fields to be created.
PAGE 502

Microsoft® Word® Documents To PDF Conversion The Microsoft® Word® Documents to PDF Conversion action task can be used to convert a Word® document into a PDF file that can be used in your PReS Workflow process. It can also do a Mail Merge as it runs the task. Notes l Microsoft® Word® needs to be installed for this task to be functional and to test the connection. l Microsoft Word must not be currently opened when the automation task runs. l Microsoft Word 2003 and up are supported.
PAGE 503

Processing The Word document is converted into a PDF file. If a Mail Merge is made, the mail merge is done in the document before the document is converted into a PDF file. The conversion is done through the use of a printer queue - the document is printed to this queue and the print job is converted to PDF. This is the same technique as used in the "WinQueue Input" on page 377 when generating PDF files. Output The output is either: l A PDF file accompanied with basic PDF metadata.
PAGE 504

that the database, connection string or statement are still valid, especially if the DOC file was moved or sent to someone else. l l l l l Use custom settings: Override the mail merge settings in the Microsoft® Word® document and lets you specify your own. Connection String: The connection string to any ODBC database supported by PReS Workflow. You can use the Browse button to open an existing File DSN, or use the Database Button to open the ODBC connection interface.
PAGE 505

This task can be added as an Action task (see "Action tasks" on page 380) or as an Output task (see "Output tasks" on page 651). Adding it as an Action task enables the process or branch to continue after this task. An Output task is always located at the end of a process or branch. Input This task ignores the input data file and any Metadata unless data selections are used in the variable data fields. Processing This task does not process the data or Metadata file.
PAGE 506

l Document to Publish group: This is where you specify the document location and type. It is mandatory to enter valid information in all the boxes included in this group. l l l l File Type: Select the appropriate document type. HTML for forms that users can fill out, and PDF for documents users can read. Cover Image: Enter the path to a cover image that is shown in the repository and library list, as well as the document property.
PAGE 507

are typically managed via the Capture OnTheGo Repository Management page. Note that there cannot be any spaces before or after each category name and that the names are case insensitive. Click the button marked with a plus sign to add a category to this list box. To remove a category, make a selection in the list and then click the button marked with an X.
PAGE 508

removed from the repository based on this setting. Note that any positive number you enter will automatically be reflected in the Until box below. 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.
PAGE 509

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 510

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 511

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 512

Input Any data file with a valid emulation (see "About data emulation" on page 60). Metadata is optional and can be used to specify the fax number and information to send the file. Alternatively, a TIFF file in the proper page size and compression (CCITT Group 4) can be used.
PAGE 513

PReS Image PReS Image Output tasks are used to make requests to PReS Image, which creates image files which it then archives or emails. For more information about this product, see "About PReS Image" on page 756. Since this task is an Output, it is not possible to immediately act on the generated image before continuing. When necessary to immediately retrieve the generated file, the "Digital Action" on page 408 task should be used instead.
PAGE 514

document, which is not available in output generated using any other means. Note however that "Digital Action" on page 408 does have the ability, in most cases, to generate output using third-party PostScript files.
PAGE 515

enable the dynamic document name box, click inside it. To disable it, press Enter. Note 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.
PAGE 516

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

Statement.2005.255842.pdf, or Job.tif instead of Job.544872.tif). Failing to add the quotation marks may result in files being overwritten. l l Automatically Add Extension: Check if you want the correct extension for the image type to be appended to the file name automatically, rather than having to add it in the Filename box. The Output Type determines the extension to be used. Index group: This group lets you specify which type of index must be created for each document generated by this task.
PAGE 518

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

l Grayscale images group l l l l Compression: Select the compression to use for the grayscale images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs.
PAGE 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 Color resolution you enter in the following box is used to control the down sampling process. Select None to prevent grayscale down sampling. Select Average to average pixel color in each sample area and to replace the entire area with a pixel of the average color.
PAGE 521

in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font. l l Subset: Select to embed only a subset of the Type 1 and TrueType fonts used in the document. A font subset is in fact composed of only those characters that are actually used in the document. This option can only be used if the Embed all fonts option is selected. Note that if more than 35% of the characters included in a font are used in the document, the entire font is embedded.
PAGE 522

l l l l l Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory. This option is available only when you select Access database in the Database type box. Data source name: Enter the name of the computer on which the database runs. This option is available only when you select SQL Server database or Oracle database in the Database type box.
PAGE 523

l l PReS Classic 6.3.0 or higher must be installed on the same system. A valid PReS Classic license (either dongle or software based) must be available on the same system. Note All PReS Classic licenses are issued and controlled by the PReS License Server and not Connect. Thus a separate PReS Classic license is required. Input A PReS Classic job and the resources it needs.
PAGE 524

Task properties General Tab l PDC File: Select either an un-compiled PReS Classic script file (PDS) which will need to be compiled on the fly, or a pre-compiled PReS Classic job file (PDC). The job needs to be specified exactly. If you want to compile the job at run time, then you must select a PDS file. If you wish to use a pre-compiled PReS Classic job, then select the PDC file, rather than the PDS.
PAGE 525

Note If the PDC File selection contains a folder path and the Working Folder also has an entry, then the PDC File entry will be appended to the Working Folder entry. One should be very cautious doing this, as it could easily lead to errors. 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.
PAGE 526

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

Processing The data file is merged with the selected PrintShop Mail Design document, producing the number of records selected in the task properties. This merging uses the PrintShop Mail engine (PSMail.exe) to generate the output. Output The output produced by this task is dependent on the options selected: it can be PDF, a Windows EMF print job, a PostScript print job or a JPG file. PrintShop Mail 7 can also output PDF/VT and PPML/VDX.
PAGE 528

l l l l l l l l l Distilling options file: Enter the name and path of a distilling options file (or "joboptions" file) or use the Browse button to navigate to that file. This option is only available when PDF is selected in the Output type box. PDF Type: Select Preview or Print to select which type of PDF should be generated. This option is only available when PDF is selected in the Output type box. PostScript Driver: Select which driver to use to generate the job.
PAGE 529

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

including Workflow information that relates to the currently processing invoice (such as Metadata and variables) into the ZUGFeRD fields. For more information on Workflow context menu data selection options, see this page: Workflow Variable Properties l Zu verwendendes PDF group: Allows selection of the PDF file to process and enrich with the ZUGFeRD-XML information. Select from: l l Workflow Jobdatei: Use the incoming Workflow Job File. Datei: Specify a specific PDF.
PAGE 531

when the drop down icon is selected. Note The date entry must be formatted in standardized UTC format: yyyy-mm-dd 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).
PAGE 532

variables. However, the country code must always follow the standard of exactly two uppercase letters only. 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.
PAGE 533

variables. l Postleitzahl: The postal address post/ZIP code. 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.
PAGE 534

For more information on Workflow context menu data selection options, see this page: Workflow Variable Properties 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.
PAGE 535

l BIC: This is an international bank code that identifies particular banks worldwide, using the Bank Identifier Code (BIC) standard. The standard consists of a 4-letter institution or bank code, a 2-letter country code (following the ISO 3166-1 alpha-2 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.
PAGE 536

This entry should be a numeric currency entry, which can be set via Workflow data and/or variables. 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.
PAGE 537

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 538

page 545 or "Find Capture Documents" on page 551 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 539

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 540

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 541

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 542

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 543

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 544

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 545

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 546

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 547

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 548

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 549

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 550

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 551

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 552

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 553

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 542. Date Generated: The date, in YYYY-MM-DD format, when the document was generated through the Capture Field Generator.
PAGE 554

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 555

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 556

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 557

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 558

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 559

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 560

l "Example: Daily sales report from PDF files" on page 288 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 561

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 562

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 563

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 564

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 565

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 870 page for more details. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 566

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 567

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 568

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 569

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 570

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 571

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 572

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 573

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 574

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 575

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 576

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 577

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 578

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 579

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 580

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 581

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 582

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 583

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 584

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 585

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 586

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 587

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 588

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 589

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 590

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 (using TLS 1.2) 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 591

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 626, "Create Print Content" on page 615, "Create Job" on page 603, and "Create Output" on page 606. Combining them in a single task makes creating Print content easier and faster, as the task is optimized for this specific purpose.
PAGE 592

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 593

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 594

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 598 dialog.
PAGE 595

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 596

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 597

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 598

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 599

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 600

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 601

l Data Source (see "Input" on page 599): l Metadata: l l Update Records from Metadata: If the process metadata has been modified by any of the "Metadata tasks" on page 559, 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 602

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 603

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 604

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 615 task, or the result of the "Retrieve Items" on page 644 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 605

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 606

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 607

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 603 or "Merge Jobs" on page 636 task. Processing The job is sent to the OL Connect Server for processing.
PAGE 608

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 609

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 397 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 615 task directly without the use of a Connect Template (PDF/VT mode). Input Any data file supported by the selected PlanetPress Document.
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 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 611

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 612

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 613

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 614

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 615

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 609), allowing the task to be used without a Connect Template.
PAGE 616

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 603 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 626 task does.
PAGE 617

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 618

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 619

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 279.
PAGE 620

"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 626 or "Retrieve Items" on page 644 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 621

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 619): 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 622

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 623

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 624

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 639 task. EML files can be stored in an ERP/ECM system for archiving purposes. Use the "Metadata Sequencer" on page 570 plugin, followed by the Download EML Messages plugin and the "Send to Folder" on page 438 plugin, to download multiple EML files and save them to disk.
PAGE 625

Storing EML messages in the File Store is an option in "Render Email Content" on page 639 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 626

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 627

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 628

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 629

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 630

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 631

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 633 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 632

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 633

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 634

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 635

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 636

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 637

Output The task outputs a merged Metadata Job File which can be used in the "Create Output" on page 606 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 638

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 639

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 640

Input This task must receive either Metadata containing information regarding a valid Record Set, or JSON data. Metadata The "Execute Data Mapping" on page 626 task and the "Retrieve Items" on page 644 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 570 task.
PAGE 641

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 642

{"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 643

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 641): Select how to output information about the emails that were created, including the email addresses (to, from, etc.
PAGE 644

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 645

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 626 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 615 or "Create Web Content" on page 619 tasks.
PAGE 646

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 647

l Sort items based on: Use the [...] to open the "Sort Parameters" on page 598 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 648

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 853 or through the use of the Debugging feature.
PAGE 649

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 650

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 651

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 652

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 380. Send to Folder tasks, which are considered as Action and Output tasks, are documented in the current chapter.
PAGE 653

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 654

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 655

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 656

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 657

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 658

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 659

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 660

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 661

l Password: If the account named in the User name box is password protected, enter the password here. 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 Parse password: Checkbox to determine if the password should be parsed or used as a literal string. This option is checked by default (parsed) for backwards comparability with SFTP I/O plugin versions earlier than 1.3.
PAGE 662

l l List of known servers: Displays a list of servers that were connected to, whether they are approved or not. 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.
PAGE 663

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. Timeout By default the SoapClient plugin waits 100 seconds before returning an error if it doesn't get a response. To change the time the Soap Client plugin should wait, a Timeout registry key can be set in: HKEY_LOCAL_MACHINE\SOFTWARE\WOW6
PAGE 664

The following three options are only available in the Legacy SOAP Client plugin: l l l l l l l l Namespace: You may choose an available namespace to prevent ambiguity between identically named elements or attributes. You may also enter a namespace directly. Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below.
PAGE 665

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Print using a Windows driver Printing Using a Windows Driver Output tasks task lets you send a job to a local or network printer, using its own drivers. The printer does not need to be a PostScript printer. Since the printer driver itself is not necessarily PostScript, Workflow cannot optimize the print file, so this task will always generate a larger and slower print job.
PAGE 666

l l l Properties: Click to change the current printer queue properties. Note that PReS Workflow generates the job file and hands it over with the available print options to the Windows print driver, which takes the relay for the actual printing part, so there is no way for your PReS Workflow Tool to ensure that all the settings you make will be applied to the printed document. Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used.
PAGE 667

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. Printer Queue Output The Printer Queue Output task dispatches jobs to selected PReS Workflow Printer Queues (see "PReS Workflow printer queues" on page 111). Note that you must have created at least one Printer Queue in PReS Workflow before you can add your first Printer Queue Output task.
PAGE 668

place the file in the destination. Sending this same file to an LPR or Windows queue will produce no output as these queues expect valid PostScript. Task properties General Tab l l Queues: Select the queues to which you want to send the output (see "PReS Workflow printer queues" on page 111). Documents: Select None if you want the job file to be printed as is.
PAGE 669

Advanced Tab l l Copies: Enter the number of copies to be printed outputs. Since this is a variable property box, you may enter a fixed value or use a data selection. Note that load balancing options have an impact on how copies are printed as well as on the total number of printed copies. Load balancing group (Options from this group are only valid if multiple Workflow printer queues were selected.
PAGE 670

l l Add job information to the document: Includes the current "Job Info variables" on page 714 to the job output. This option is only available if a document was selected in the General tab. Use job name as Title: Uses the Job Name set in the Workflow printer queue's General tab, as the job's title, set as %%Title in the PostScript's job. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 671

Task properties Recipients Tab The fields on this tab are variable property fields, which means the values may change with each job at run-time. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303. 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).
PAGE 672

on page 599 task. Also note that it is currently not possible to send both an HTML and plain-text version of your message. Attachments Tab Use this tab to specify what files to attach to the e-mail. 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 303).
PAGE 673

and fails with a "Read time out" error if the server didn't reply anything. Defaults to 30 seconds. l l Enter the account credentials: the account name on the mail server, and the password required to unlock the selected account. Select the level of priority and sensitivity. The default value is Normal. 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 674

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

first line should start with or . It should not be any other character). Also note that it is not currently possible to send both an HTML and plain-text version of your message. Attachments Tab Use this tab to add the files received by this task (plus any other file that you may choose to attach) to the emails sent by PReS. l l l l l l l Attach input job files: Select to attach the file received by this task to the emails it will generate.
PAGE 676

l l l l l l l l l l Use SMTP mail: Select to use Simple Mail Transfer Protocol (SMTP) to send the emails (and attachments). To use SMTP you must enter information in the Name, Email Address and Outgoing Mail (SMTP) boxes below. Name: Enter the sender’s name that will be used in emails sent by PReS Workflow for this task. Organization: Enter the organization name that will be used in emails sent by PReS Workflow for this task (this is optional).
PAGE 677

Input Any data file. Processing and output The file is saved in the location specified, as the file name specified. Task properties General Tab l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303.
PAGE 678

l "Input from SharePoint" on page 699 l "Output to SharePoint" on page 702 The following plugins are not initially installed with Workflow but they are available for download on the (help.objectiflune.com). Once installed, they appear in the Document Management category.
PAGE 679

Note To be able to use this plugin you need a working DocuWare user account with appropriate permissions. Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved. DocuWare Download The DocuWare Download plugin Downloads files of any file type from a dedicated DocuWare CRM system. Installation This plugin is not installed with Workflow, but it is available for free download from the Resource Center (help.objectiflune.com). After downloading the .
PAGE 680

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 - the Job File - is either the downloaded file, or the document index data in XML or JSON format. In the latter case, the JSON/XML file includes the path to the file on the DocuWare Server.
PAGE 681

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 682

Note You can use static text and/or Workflow variables, data and lookup functions in all of the fields on this tab. Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 53). l Download section. In order to download a file the plugin needs to know from which File Cabinet it must be downloaded.
PAGE 683

Note The drop-down list display can be customized by entering a search string in the entry field atop the Field Picker box. This restricts the listed fields to just those containing the search string. l Value. Add the value to apply. You can add or remove search criteria using the following options: You can populate the table with all the available Index Field options at any time by selecting the Add missing fields ( ) button. If selected initially this will add all the available fields to the table.
PAGE 684

l Store file name in variable: Stores the name of the downloaded file in a variable. l Store response in variable: Stores the success/failure response in a variable. l Save document index data to Job as XML/JSON: Outputs the document index data to the Job File as XML or JSON (according to the selected option) and stores the status information in a variable. The downloaded document itself is stored in the Connect File Store.
PAGE 685

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 upload the specified file (either the Job File, or an external file) with the given index values to the selected File Cabinet. The plugin won't modify the uploading file in any way.
PAGE 686

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. For example MyCompany Platform Enter the DocuWare platform. For example docuware/platform Username Enter the DocuWare login Username.
PAGE 687

been established and the cabinet and file information obtained, the plugin will open upon the Upload tab when next plugin is next opened. As different users can have different permissions (such as access to different cabinets) this information is tied to both the host and username. If either the user or server is changed, then a new Test Connection will be required to re-populate the cabinets and fields for that new connection.
PAGE 688

l File type: Enter the type of file, from the list contained in the drop down box. Select Autodetect if unsure of the file type, and the plugin will then set the content-type based upon the file extension. The File type entry is directly editable so your can enter your own file type, should it be missing from the list. Destination In order to upload a file the plugin needs to know to which File Cabinet it must be directed to. The details for this are all contained in this Destination frame.
PAGE 689

highlighted in the Document name field screen entry). l Update existing document will add to an existing document of the same name on the DocuWare server, based upon the following criteria: l Search Field. Enter the Field to search on. This can be entered directly as static text, or you could use the Field picker ( ) to launch a Field selection pick list that is populated with all the available fields, and them select the desired field from there.
PAGE 690

) or Remove ( ) individual entries, as well as move them up ( ) or down ( ) within the table. 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 The Document name field entry will appear in italics in the table. All index values must be entered in a unified format.
PAGE 691

Fields with empty values will not be saved when the OK button is pressed. Response Specify an optional Workflow variable that is used to store the result. The DocuWare plugin searches for the variable by name and sets the JSON response into the variable. So using dwresponse as the variable name would mean that DocuWare Upload searches for the local variable of that name. Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved.
PAGE 692

Note To be able to use this plugin you need a working M-Files installation and a user account with appropriate permissions. Plugin legal notices and acknowledgments Copyright © 2019 Objectif Lune Incorporated. All rights reserved. M-Files Download The M-Files Upload plugin downloads a single file from an M-Files system (see "M-Files" on the previous page). This Action plugin is not initially installed with Workflow. It is available for download on the Resource Center (help.objectiflune.com).
PAGE 693

Output The output of this task - the Job File - is either the downloaded file, or the document index data in XML or JSON format. In the latter case, the JSON/XML file includes a path to the file so it can be downloaded separately. The response that the plugin gets from the M-Files Server is then stored in a variable (if specified). Task properties All of the task's General properties are dynamic.
PAGE 694

l l FileID (optional): If the file ID is not given, the first file - the root document - will be retrieved. Retrieve by search: This section allows the retrieval of files by searching for specific properties (Definition entries). Enter the properties under Index data. l l Field: The property to search for.
PAGE 695

l Save document index data to Job as XML/JSON: Outputs the document index data to the Job File as XML or JSON (according to the selected option)andstores the status information in a variable (if it exists). The downloaded document itself is stored in the Connect File Store. The XML/JSON output file includes a URL to the document so that it can be downloaded separately. In the Response variable field you can enter the Workflow variable in which the file name or status information should be stored.
PAGE 696

Note To be able to use this plugin you need a working M-Files installation and a user account with appropriate permissions. The M-Files Upload plugin is designed to be configured offline as well as online. Once a Test Connection has been established, the Vaults and properties data will be downloaded and stored locally. This allows authoring of Workflow configurations without requiring a constant live connection. Input The input of this plugin can be any file.
PAGE 697

l l Username, Password: Enter the user name and password that the plugin can use to send a login request to the M-Files Server. The user should have the appropriate rights. Test Connection: Click this button to establish a connection with the M-Files Server and retrieve the Document Classes of the selected Vault. This information is used on the Upload tab. Upload Tab l File to upload: l l l l Job file: Click this option to upload the current Job File (see "Job file" on page 51).
PAGE 698

Metadata Structure of the Vault on the M-Files server. l Value: The (new) value of the property. Note The plugin will fail if a required property is missing from the Index data, or if the Index data contains a property that does not exist for the chosen Class. Use the Index data buttons to: l l l l l Add and remove properties. Change the order of the properties by moving them up or down. This is for convenience only; to the M-Files Server, this order is not important.
PAGE 699

Input from SharePoint The Input from SharePoint task can be used to retrieve files from a SharePoint server on your network, filtering on your template fields and creating Metadata to use in your process. When the Input from SharePoint task runs, it first lists all of the files to download then runs the process once for each file in the list. If any new files are added during the process, they will not be touched until the next time the process is scheduled.
PAGE 700

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

l l l Download files from sub-directories also: Check to also look into subdirectories of the specified Folder. Do not download checked out documents: If the document is set as "Checked Out" in SharePoint, it will be ignored. Action Group l l l Download the document: Simply download the document and do not modify it in SharePoint. Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint.
PAGE 702

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 865. 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 703

Input Any data file, with optional Metadata. Processing The task connects to the selected Document store and uploads the current data file. If the file already exists, it will be overwritten and, if this option is selected, marked as "checked in". The information accompanying the file (the SharePoint Metadata) is either updated or created. Output The output of this task is the original data file.
PAGE 704

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. This PDF must have been created with PReS Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library.
PAGE 705

l l l 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. Password: The correct password for the user name. 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 706

Mailjet Note l 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. Version 2021.1.0 is backwards compatible with Workflow down to version 2020.1. In order to use HTTPS it is essential to upgrade the plugin to the 2021.1.0 version, available for download on the Resource Center (help.objectiflune.com).
PAGE 707

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. Should you encounter any issues, please contact your local Objectif Lune Support team and we will do our best to help. Testing the plugin To test the plugin, drag it from the Plug-In Bar into a process.
PAGE 708

[{"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.pdf","disposition":"attachment","name":"Terms.pdf"},{"name":"Take action Mandie.pdf","disposition":"attachment"}] The order of the key/value pairs is not important.
PAGE 709

l l Headers (optional): A JSON object containing one or more key/value pairs of header names and the value to substitute for them:. For example: {"Sensitivity":"Company-Confidential","X-Priority":"1"} If they contain Unicode characters, you must ensure that these are properly encoded. Custom header names normally start with "x-": {"x-my-header":"myvalue"}. Debug settings: l l Send all messages to the Test Address: When this option is checked, Mailjet will only send the emails to the given Test Address.
PAGE 710

l l In order to use HTTPS it is essential to upgrade the plugin to the 2021.1.0 version, available for download on the Resource Center (help.objectiflune.com). 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). Set a time at which the emails should be sent (see Scheduling parameters).
PAGE 711

Conditions.pdf","disposition":"attachment","name":"Terms.pdf"},{"name":"Take action Mandie.pdf","disposition":"attachment"}] The order of the key/value pairs is not important. Processing The plugin communicates with the Connect Server to retrieve each email message's body, any attachments and the plain text version (if available) from the File Store, using the folder ID and file names specified in the output of the Render Email Content task.
PAGE 712

id, 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. This allows you to review the result and to test ESP specific options like open rates and click through statistics. Log email messages: Check this option to get a copy of each message in the Messages window of Workflow.
PAGE 713

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. About variables A variable is basically a keyword that points to specific location in your computer's memory.
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 300), 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 440. 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 576 l "Get Job Data" on page 581 l "Job Processor" on page 585 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 803 l "PReS Fax plugin preferences" on page 803 l "FTP Output Service preferences" on page 807 l "PReS Image preferences" on page 807 l "LPR Output preferences" on page 811 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: OL Connect tasks communicate with the OL Connect Server using TLS 1.2. l l 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.
PAGE 786

Text formatting features such as kerning, bold, exponential, etc, may cause these fragments to be considered as separate even if, to the naked eye, they obviously belong together. The PDF Text Extraction Tolerance Factors is used to modify the behavior of data selections made from PDF data files from within PReS Workflow. Each factor available in this window will determine if two fragments of text in the PDF should be part of the same data selection or not.
PAGE 787

Font Delta Height Defines the tolerance for the difference in average height of fonts in the two target fragments. The higher the number, the more difference in average font heights will be accepted. The average font height is bigger in text written in uppercase than text written in lowercase. 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.
PAGE 788

process. l Log level group l l l l l l l Startup and shutdown: Select to only track when the PReS Workflow service is started and stopped. Task failure: Select to only track when tasks in the processes running in a PReS Workflow configuration fail. Task success and failure with details: Select to track when the tasks in processes running in PReS Workflow succeed and fail, with details. Details can include why tasks fail and how successful tasks are executed.
PAGE 789

Messenger plugin preferences Apart from enabling communication between the various parts of PReS Workflow, the PReS Workflow Messenger also manages local instances of the PReS Workflow Alambic. 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.
PAGE 790

To open the Preferences dialog, click the PReS Workflow button and then the Preferences button, or use the key combination Ctrl+Alt+P. The HTTP Server Input 1 plugin preferences can be found under Plug-in. 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.
PAGE 791

l l l Key: Enter the absolute path to the Private Key file. This file generally has a .key extension. Password (optional): Enter the password (or passkey) for the Private Key file. The maximum length of this password is 64 characters. This password is encrypted within PReS Workflow server and is not saved in plain text. Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. The service uses SSL 2.3 or TLS 1.0.
PAGE 792

l l l l None: No special processing is applied. Use PHP-like Arrays: When the name of form inputs contains two pairs of square brackets, the data are interpreted as an array. The result is a single XML node (named after the value between the first pair of square brackets) with each part of the array as children. See: "PHP arrays example" below.
PAGE 793

Incoming HTML PAGE 794
122 253 dent 361 341 dent 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

href="images/faces/johnsmith.jpg". l Capture OnTheGo group l l Cross-Origin Resource Sharing (CORS) l l Authentication Key: Enter the authentication key for the COTG repository. This key can be found in the Settings section of the COTG Web Administration Panel. Allowed Origins: Enter an origin (everything in a URL before the path, e.g. http://www.example.com).
PAGE 796

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 797

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

l l Time out: Set the timeout period in seconds. The default value is 120 seconds. Enable server for HTTPS requests: Check this option to accept secured, encrypted requests from web clients. The encryption protocol is TLS. Note HTTPS requires two certificates: a Root Certificate and an accompanying Certificate. These are obtained from a Certificate Provider such as Thawte or Verisign, or through the use of certificate generators such as openSSL.
PAGE 799

NodeJS Server Input plugin preferences 2 The second set of NodeJS Server Input plugin preferences is used to enable serving static HTTP resources, as part of a NodeJS 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 800

l Allowed Origins: Enter an origin (everything in a URL before the path, e.g. http://www.example.com). The Workflow server will add this value to the Access-Control-Allow-Origin header, which signals to the browser that it is allowed to make the request. This enables cross-origin resource requests, such as AJAX requests. The default setting "*" is a wildcard that allows all cross-origin resource requests.
PAGE 801

Testing the server l To test the server address and domain, enter a username and password and click the Test server button. Note The user name and password aren't part of the plugin preferences. Users will have to provide their credentials themselves and will be presented with an HTML page for that purpose. Changing the Log in page You can change the look and feel of the login window if you are familiar with the EJS templating syntax.
PAGE 802

Serial Input plugin preferences Serial input plugin preferences control certain functions of the PlanetPress Serial Capture service, which in turn has a direct impact on all Serial input tasks performed by PReS Workflow on a given computer. Preferences l Serial settings group l l l l l l Serial port: Select the port of the computer where the Serial input is connected to (COM1 through COM8). Baud rate: Select the baud rate of the Serial input.
PAGE 803

received data files are not passed to the rest of the process; the Serial input resets, ready to receive further data files. l l Job delimiters: Enter the strings that tell PReS Workflow the data file being retrieved through the Serial input is complete. Each line in the Job delimiters text box is a different delimiter. You can enter as many delimiters as you want, one per line. The three default delimiters that appear are three of the most commonly recognized end of a file delimiters.
PAGE 804

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

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

l l l l Report Successes: Select to have PReS Fax generate a report whenever one of the faxes in the PReS Fax Job reaches its destination successfully or at least as far as the Windows Fax service is concerned. Folder: Enter or select the location of the report file. PReS Fax generates report file names automatically with the file name extension PFX.
PAGE 807

l l About: Click to display an About dialog box for PReS Fax. This dialog box contains information such as the version number, whether the software is activated or the number of days remaining in the trial. Select Language: Click to select a different interface language for the PReS Fax Configuration applet. Note that this button is not displayed if you edit the PReS Fax options directly (not via PReS Workflow Configuration program).
PAGE 808

include error and logging options, PReS Search database options, as well as networking and email options. Bear in mind that Image Output tasks included in a given PReS Workflow configuration can be performed by a PReS Image installation running on a different computer, typically one that runs only PReS Image. When you change the user options on a given computer, only that computer is affected. So you should change the Image user options on the computer that actually performs the Image Output tasks.
PAGE 809

folder, which is located in the PReS Workflow installation folder. This log may be on the local computer running PReS Workflow or on another computer on your network. l l l l Activation: Click to enter activation codes for the PReS Image service installed on the same computer as PReS Workflow. If you have already activated the PReS Image service from its Control Panel applet, this is reflected when you open the Activation dialog box by clicking this button.
PAGE 810

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

l l Outgoing mail (SMTP): Enter the IP address of the server that PReS Workflow uses to send the emails via SMTP. Server requires authentication: Select if the outgoing server used to send the emails via SMTP requires authentication. Note that if you select this option, you will be required to enter information in the Account name and Password boxes below. l l Account name: Enter the account name of the user on the server to be able to send emails via SMTP.
PAGE 812

l l Error handling group l l l l Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service. Max. retry period: Select the maximum time period, in hours, within which PReS Workflow attempts to dispatch the job using the LPR output before giving up. Note that entering a maximum retry period of 0 hours disables retries altogether.
PAGE 813

Note It is also mandatory to send your configuration to your PReS Workflow service since the PrintShop Web credentials are included in the *.cfg file (See "Sending a configuration" on page 36), which is updated every time the configuration is sent to the service via the Send Configuration button.
PAGE 814

l l l l l l l l l Backspace unindents: Select to move the insertion pointer to the previous indentation level when you press BACKSPACE. This is useful when you enter a block of code such as a for loop; you enter the for statement, advance one indentation level to enter the body of the for loop, then press BACKSPACE to enter the end for statement. You must select Auto indent mode to use this option.
PAGE 815

l l l l l l l Enable dragging: Select to permit dragging and dropping a selection to reposition it in the code. This option works only if you also select Enable selection. Enable search highlight: Select to highlight the search term match found in the code when you perform a search. Clear to prevent the highlighting. In both cases, the pointer appears after the last character of the search term match. Double click line: Select to highlight the complete line of code when you doubleclick that line.
PAGE 816

l l l Sample: Displays a preview of the font selected in the Editor font option, at the size selected in the Size option. Margin and Gutter Group l l l l l l l Use monospace fonts only: Select to display only fixed width fonts in the Editor font drop-down list. Every character in a fixed width font occupies the same amount of space. Right margin: Select to display a vertical gray bar as a right margin indicator. Use the Right margin position drop-down list to set the position of this indicator.
PAGE 817

change their pre-sets by selecting them in the Element list box and editing their values. l l l l Element list box: Select a script element in the Element list box, then edit the background and foreground color with which it is displayed, and/or its formatting attributes. Each element recognized for each scripting language, for example, a URL in a JavaScript script, is displayed with the properties you set.
PAGE 818

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 828. l " The Quick Access Toolbar" on page 892. This toolbar is customizable. l The ribbon tabs; see "The PReS Workflow Ribbon" on page 893. l "The Process area" on page 884 l "Configuration Components pane" on page 829.
PAGE 819

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 820

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 821

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 822

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 823

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 824

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 825

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

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 827

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 828

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 829

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 827.
PAGE 830

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 831

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 832

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 833

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 834

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 835

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 836

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 837

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 838

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 839

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 840

Tip Groups can be copied and moved using the Clipboard and Drag & Drop; see "Moving and copying configuration components" on page 835. 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 841

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 842

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 843

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 844

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 845

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 846

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 847

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 848

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 849

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 850

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 851

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 852

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 853

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 854

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 855

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 856

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 857

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 858

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 859

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 860

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 861

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 862

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 863

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 864

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 865

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 866

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 789. 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 867

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 868

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 869

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 870

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 871

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 872

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 873

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 874

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 875

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 876

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 877

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 878

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 879

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 880

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 881

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 882

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 883

l OL Connect; see "OL Connect tasks" on page 590. l Document Management; see "Document Management tasks" on page 677. l Outputs; see "Output tasks" on page 651. 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 884

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 PKK file. 4. Select the desired file type: .DLL or .PKK. 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. The M-Files plugins, for example, will appear in the Document Management category. Third-party plugins appear in the Uncategorized category.
PAGE 885

l "Replacing tasks, conditions or branches" on page 890 l "Removing tasks or branches" on page 889 In the Process area you can also: l "Undo a command" on page 892 l "Redo a command" on page 889 l "Highlight a task or branch" on page 887 l "Collapse and expand branches and conditions" on page 891 l "Resize the rows and columns of the Process area" on page 890 l "Zoom in or out within the Process Area" on page 892 Cutting, copying and pasting tasks and branches Using cut and paste, and copy a
PAGE 886

5. From the Home tab in the Ribbon, choose Paste (or right-click and select Paste from the drop-down menu). A few notes: l l l When you cut an Input or Output task, it is replaced with an Unknown Task, that you will need to replace with another task for the process to be functional. If you cut one task or branch, then cut another one, the first one is lost and replaced by the second. Remember however that you can always undo the command to retrieve it (see "Undo a command" on page 892).
PAGE 887

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). Highlight a task or branch The Highlight command lets you toggle the background color of selected tasks and branches. There are several ways to highlight a Process area square. l Right-click it and select Highlight from the contextual menu. l Double-click it, open the Miscellaneous tab and select the Highlight option.
PAGE 888

To disable or enable a task or branch: 1. In the PReS Workflow Process area, click the icon of a task or branch. 2. From the Debug tab in the Ribbon, click Ignore. If the task or branch was enabled, it is now disabled, and vice versa. Moving a task or branch using drag-and-drop When you want to move a given task or branch, the simplest way is to use drag-and-drop. Using the mouse, you can drag and drop tasks and branches only within a given process.
PAGE 889

Duplicating a task or branch To duplicate a task or branch, the same method as for moving them applies but with a slight difference: 1. In PReS Workflow Process area, click the icon of the task or branch you want to duplicate. 2. While holding down the mouse button, press and hold down the CTRL key and drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item and release the CTRL key.
PAGE 890

Note You cannot use the Delete option to remove an input or output task, but you can rightclick on them and click Cut instead. This replaces the task with an Unknown task (see "Unknown tasks" on page 712). To delete the path below a branch crossing (instead of the path to the right of the branch): l Press Shift+CTRL+Delete. l From the right-click menu, choose Edit | Delete| Delete Below the Branch.
PAGE 891

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. When the cursor changes appearance, click and drag up or down to resize rows, or left or right to resize columns. A dashed line appears as you drag indicating the new separation. The row or column, with all its tasks, moves accordingly.
PAGE 892

Undo a command The Undo command lets you undo most commands performed with the PReS Workflow Configuration program. To undo a command: l From the Quick Access Toolbar, choose Undo. Zoom in or out within the Process Area You can do a zoom out in the PReS Workflow Process area to see more tasks at the same time. In zoom out mode, you can perform the exact same functions as in normal view mode. To zoom in or out on the PReS Workflow Process Area: 1. Click on the View tab of the Ribbon. 2.
PAGE 893

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. Locate the button you want to remove in the Quick Access Toolbar. 2. Right-click on the button. 3. Select Remove From Quick Access toolbar. Moving the toolbar To move the Quick Access Toolbar below or above the Ribbon: 1.
PAGE 894

The PReS Workflow Ribbon has five tabs: the Home tab, the View tab, the Debug tab, the Tools tab and the Help tab. Each one of these tabs contains a series of groups, each group holding a number of controls. l The Home tab includes the Clipboard, Processes, Variables, (PPS) Documents and Printer Queues groups. l l l l l l The Clipboard group contains the typical Windows-based editing controls: Cut, Copy, Paste, Select All, Delete.
PAGE 895

l The Debug tab includes the Data, Debug and Debug Messages groups. l l l l The Data group allows to associate a sample data file to the currently selected process, as well as update or replace it, and display it in its text/PDF or Hexadecimal format. The Debug group contains the debugger's controls, allowing to execute a process step by step, skipping over or ignoring certain tasks, as well as setting up breakpoints and resetting variables values.
PAGE 896

l The PlanetPress Capture group contains: l l l The Pen Manager button opens the "PlanetPress Capture Pen Management Tool" on page 781. The Test Page group: l l l The Document Manager button opens the " PlanetPress Document Manager" on page 777. The PS Test Page control allows to print a Status Page for the selected printer queue. Note that if no printer queue is selected in the Configuration Components pane, the control is disabled.
PAGE 897

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 898

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. Right-click on the running service. 2. Click on Kill. 3. Click OK to confirm on the warning. If the service is currently processing a file, execution will stop and the action will not complete.
PAGE 899

The log viewer for existing log files does not refresh automatically since log files for older days do not generally change. The display of the sessions, processes and tasks is the same. Note The log viewer as described here was introduced in version 7.4 of PReS Workflow. Though it should be able to open log files from older versions of PReS Workflow, the results are not guaranteed. Some log files may not display properly in this view.
PAGE 900

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 901

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 902

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 903

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 904

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 905

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 906

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 907

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