2020.1

Manuals Brands Objectif Lune Manuals Applications PlanetPress Workflow

Table Of Contents

Summary of content (888 pages)

PAGE 1
PAGE 2
PAGE 3

User Guide Version 2020.1 Last Revision: 2021-01-04 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 PlanetPress Workflow 2020.
PAGE 5

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

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

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 String Name
PAGE 8

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 Management ta
PAGE 9

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

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 server Changing the Log in page S
PAGE 11

Resize the program window areas Change the Interface language PlanetPress 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 Configuration Compon
PAGE 12

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 PlanetPress Workflow Ribbon The Task Comments Pane The P
PAGE 13

Welcome to PlanetPress Workflow 2020.1 This PDF documentation covers version 2020.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.
PAGE 14

Tip Information that may help you use PlanetPress Workflow better or that suggests an easier method. Warning Information that is potentially critical to using PlanetPress 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 PlanetPress Workflow. l "System requirements" below l "Environment considerations" on page 18 l "Setting up the working environment" on page 21 l "Known Issues" on page 24 System requirements These are the recommended system requirements for PlanetPress Workflow 2020.1.
PAGE 16

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

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. The following specs should therefore be viewed as a general guideline that is most likely to produce expected results for most implementations. You should, however, keep in mind that it may not represent the optimal setup for your particular application.
PAGE 18

Environment considerations This page provides technical information about the environment in which PlanetPress Workflow is intended to run. Terminal Services PlanetPress Workflow does not support Terminal Services environment as possible under Windows 2000, 2003 and 2008. This is to say, if Terminal Services is installed on the server where PlanetPress Workflow is located, unexpected behaviors may occur and will not be supported by our company.
PAGE 19

Warning The PlanetPress Workflow End-User License Agreement (EULA) specifies that a PlanetPress Workflow software license may only be used on a single virtual or physical PC at a time. While copying a virtual machine for backup purposes is acceptable, running two instances of the same machine, using the same serial number, is strictly prohibited. 32-bit or 64-bit? PlanetPress Suite version 7.1.3 and higher, as well as PlanetPress Connect, support a 64-bit operating system.
PAGE 20

l l 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 risks on your computer. However, PlanetPress Workflow may use this folder as temporary storage, especially in the case of creating PDF files. We do not recommend disabling scan on this folder, unless you notice performance issues when generating PDFs, and then only as a test. l Processes: l FTPPutService.
PAGE 21

Microsoft Office compatibility The Microsoft Office 2010 line of products, other than Pro and Enterprise, has not been certified for use with PlanetPress Workflow. Some of its products may not be compatible with the connectors included in OL Connect. Setting up the working environment After installation, the working environment needs to be set up before you start using Workflow. This involves: l l Configuring PlanetPress Workflow Services (see "Workflow Services" on page 746).
PAGE 22

the lower right corner of PlanetPress Workflow Configuration program: . The icon reminds you that the logon information is different for the PlanetPress Workflow services, and that some network resources may not be accessibly by PlanetPress Workflow when running a live configuration. Account requirements PlanetPress Workflow and its services require administrator rights to run on any given computer and must therefore be associated with an account that has such rights.
PAGE 23

Component Protocol Local Port Remote Port Email Input (POP3 mode) TCP Default1 110 Email Input (Outlook mode) TCP see Remote Port See Network Ports Used by Key Microsoft Server Products (https://msdn.microsoft.com/enus/library/cc875824.
PAGE 24

Component Protocol Local Port Remote Port l l 137, 138 and/or 139 (NetBIOS over TCP/IP (NetBT)) 445 (SMB Over TCP/IP) LPR Output TCP Default or 721 to 7313 515 PlanetPress Database TCP or UDP Unknown4 Unknown4 SNMP Condition UDP Default1 161 1 Value is greater than 1024 and is assigned by Windows XP. This is the default. 2 Windows NT 4.
PAGE 25

Condition task. This issue only occurs in version 2020.1 and will be fixed in version 2020.2. HTTP Server Input triggers all trigger-based processes In order to wake up a trigger-based process that starts with the HTTP Server Input task the server issues a signal to all trigger-based processes, not just those that start with an HTTP Server Input task. This means that some processes may get woken up when they do not need to. This issue only occurs in version 2020.1 and will be fixed in version 2020.2.
PAGE 26

ACE, install the latest MS Access Database Engine 2016 Redistributable (https://www.microsoft.com/en-us/download/details.aspx?id=54920). Otherwise, using ACE in one or more self-replicating processes in a Workflow configuration can cause Workflow to crash. In the meantime Objectif Lune would like to apologize to any customers affected by this problem and for any inconvenience caused. For more information, please contact your local support team.
PAGE 27

workaround for the problem, therefore PlanetPress Workflow cannot circumvent the issue. l l l l l l l l l Under Windows 2000, the SharePoint output task does not work with SharePoint 2010. Under the same OS, the PlanetPress Capture ICR does not work due to the .NET 3.5 requirement. 21465: The SharePoint Output task does not validate the field contents. That's Sharepoint's responsibility. 20143: The Metadata to PDI task encodes the XML using the default system encoding, not the document's.
PAGE 28

Version 8. To circumvent the issue, open the output task's properties, make sure you reselect the proper printer, close the task and send the configuration again. l l The HTTP/SOAP service may fail when both it and the Workflow service are logged on using 2 non-local users or 2 local users with different privileges. To resolve the issue, make sure both services use the same logon credentials.
PAGE 29

configuration to the service. Make sure you send the configuration before exiting from the Configuration tool. l l l 13009: With Outlook 2010, the Send Email functionality requires that the service be run with administrative credentials in the domain. In addition, both Outlook and the PlanetPress Workflow Configuration tool must *not* be running while the service is. The Microsoft Office 2010/2013/2016 and 365 line of products has not been certified for use with PlanetPress Workflow.
PAGE 30

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

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 38). They become visible in the "Configuration Components pane" on page 811.
PAGE 32

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

versatile automated processes to print jobs as well as generate other types of output (emails, web pages, files...). Note A PlanetPress Workflow configuration must be composed of at least one process, but it may include as many as 512. PlanetPress Workflow cannot work without a valid configuration, and a PlanetPress Workflow session running on a given computer can only use one configuration at a time.
PAGE 34

By default, when you create a new configuration, PlanetPress Workflow automatically creates a process that includes a "Folder Capture" on page 318 initial input task and a "Send to Folder" on page 664 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 753).
PAGE 35

Saving and sending a Workflow Configuration The core of the PlanetPress Suite workflow tools is the PlanetPress Watch service which, once started, constantly runs in the background to perform the tasks included in its current configuration file. The PlanetPress 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 36

PlanetPress 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 PlanetPress Workflow Configuration program uses the currently opened configuration (Any_name.OL-workflow) to overwrite the PlanetPress Workflow Service's current configuration (ppwatch.cfg). Note .OL-workflow files are equivalent to .pp7 files made with older versions of PlanetPress Workflow.
PAGE 37

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 824. Note If PlanetPress Workflow service is paused when you send a new configuration, it will not stop and restart.
PAGE 38

If the default configuration does not include any active process, the PlanetPress 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 PlanetPress 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 39

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 69.) Tip Double-click on a sample data file to use it as a sample data file for the active process.
PAGE 40

1. Click the PlanetPress 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. When you select a package file, the individual resources contained within that package will be imported. Tip You can import multiple files at once.
PAGE 41

Resource archives From version 8.2, PlanetPress Workflow maintains an archive of previous versions of resources, in the following location: %PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\OLConnect\Archive , each in their own folder: l datamapper contains archives of the data mapping configurations (.OL-datamapper) l jobcreation contains archives of the Job Presets (.OL-jobpreset) l outputcreation contains archives of the Output Presets (.
PAGE 42

1. Make sure the Connect Resources section is visible by clicking the appears. button if it 2. Expand the data mapping configuration (name.OL-datamapper) by clicking the button. 3. Right-click on the data file, then click Set as sample data file. Viewing an attached data file 1. Make sure the Connect Resources section is visible by clicking the appears. button if it 2. Expand the data mapping configuration (name.OL-datamapper) by clicking the button. 3.
PAGE 43

For more information about PlanetPress Design documents, please see the PlanetPress Design User Guide. Generating output with PlanetPress Design documents PlanetPress Design documents are typically selected in certain Output tasks designed to merge data with a Design document, but they can also appear in other tasks that produce formatted data such as the Digital Action task and the Add Document task.
PAGE 44

Adding printer resident documents to the Configuration Components Pane By default, the Documents group displayed in Configuration Components pane of the PlanetPress Workflow Configuration program includes all those documents that are available on your local PlanetPress Workflow server.
PAGE 45

Tip To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. Using files attached to PlanetPress Design documents Data files When sending a PlanetPress Design Document from PlanetPress Design to PlanetPress Workflow, all data files used in the document are automatically sent to PlanetPress Workflow along with the Design document.
PAGE 46

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 PPS/PSM Documents section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Right-click on the data file, then click Save sample data file. Metadata When a Design document uses Metadata, it can also be attached with the document.
PAGE 47

Saving the Document Preview to disk 1. Make sure the PPS/PSM Documents section is visible by clicking the appears. button if it 2. Expand the document (name.ptk) by clicking the button. The Document Preview has the same name as the document but with a PDF extension. 3. Right-click on the Document Preview, then click Save PDF File.
PAGE 48

PrintShop Mail documents PrintShop Mail documents are documents made with PrintShop Mail (Suite, not Connect). These documents may be imported into Workflow to create output with the "PrintShop Mail" on page 522 task. Importing PrintShop Mail documents This procedure describes how to import variable content documents created in PrintShop Mail (Suite, not Connect) into PlanetPress Workflow. 1. Click the PlanetPress Workflow button. 2. Choose Import, then Import PrintShop Mail Document.
PAGE 49

originates from many different sources (as many as the input tasks support), parts of it can be stored in variables, and it is always accessible by the task that currently handles it. Data is referred to in tasks using data selections; see "Data selections" on page 52. Data selections let you use data in file names, for example, or store them in a variable or in the Data Repository for use later on.
PAGE 50

Job file Whichever source it may come from, a serial port, an e-mail message, or an LPR request, for instance, and whatever its format, data entering a PlanetPress Workflow process via an Input task is always referred to as a data file. When a data file enters a process, it becomes the job file. 'Job file' however is a more general term, that can refer to data files as well as other types of files traveling through a process.
PAGE 51

l If the job file is processed by a Splitter action task, the task typically creates a number of new files which are all given new job file names. Since these files are generated and managed by PlanetPress Workflow, you should not actually pay too much attention to their names. Many Output tasks, on the other hand, let you determine exactly how you want the files they generate to be named.
PAGE 52

Note You can change the name of a previously named file using a Rename action task (see "Rename" on page 428). Data selections A data selection could be compared to an address. It indicates a location within a data file or database: the job file (see "Job file" on page 50), Metadata file (see "Metadata" on page 73), or "Data Repository" on page 93.
PAGE 53

Data selections can also be used in a PlanetPress Design document that is being merged with the data (for example in a printed output); for more information, see PlanetPress Design User Guide. Wild card parameter "?" Data/Metadata selection functions accept a wildcard parameter "?", indicating the function operates on all nodes (not just one) of a given level. Examples l In a PDF emulation, the format of a selected region could be: region(?,0.59375,2.21875,1.85416,2.
PAGE 54

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

l Trim Option: Can either be "Trim" if you want to trim empty spaces before and after the data selection or "NoTrim" if you want to retain the extra spaces. Data Repository lookups The Data Repository selections are made through the lookup function. Selections are done from the data located in the "Data Repository Manager" on page 832. The lookup function returns the value of a single key, which is always a string.
PAGE 56

l region(): Always surrounds PDF data selections. l Page: The page of the PDF from which to retrieve the data. l Left: Exact horizontal position (in inches) that defines the left of the selection region. l Top: Exact vertical position (in inches) that defines the top of the selection region. l Right: Exact horizontal position (in inches) that defines the right of the selection region. l Bottom: Exact vertical position (in inches) that defines the bottom of the selection region.
PAGE 57

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

Here is a breakdown of the syntax: l xmlget(): Always surrounds a data selection. l Value Options: l l l Count: The number of elements on the same level in the same node that have the same name. l Name: The element's name. l Value: The element's value. Case Options: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase characters as they are. l LowerCase: Converts all characters to their lowercase equivalent.
PAGE 59

Note Even during debugging, selecting a sample data file with a different format will cause the emulation of a process to change. In order to avoid errors, change the emulation back to the format of the original input file before using the process again. Stabilizing data All emulations, except the database, PDF and XML emulations, let you perform operations on the data to stabilize it. The following options are available in both the "Change Emulation" on page 387 task and "The Data Selector" on page 835.
PAGE 60

as they appear in the data stream and does not perform any substitution. A printer that does not support binary mode or is not running in binary mode replaces any CR, LF, or CRLF that appears at the end of a line of data with a LF. Note, however, that it replaces a line feed followed by a carriage return (LFCR) with two LFs. Binary mode is the recommended printer mode when you use an ASCII emulation.
PAGE 61

For more information about emulations in PlanetPress Design see PlanetPress Design User Guide. ASCII emulation ASCII emulation tells the process to treat the input data as a stream of ASCII characters. The data stream is read one character at a time, a line is constructed, and that line is added to the data page buffer. In this emulation, you can define how to handle carriage returns that are not followed by line feeds and how to handle tabs.
PAGE 62

l l l Number of spaces in the tab: Enter the number of spaces you want the application to use when an isolated carriage return character is found within the data. This number typically corresponds to the maximum column number. If your data is formatted so as to occupy a maximum of 120 characters on each line, enter a value of 120 in this box, so when an isolated CR character is found, the data following the CR character will appear starting from column 121.
PAGE 63

character (\) as a delimiter, you must precede it with another backslash character (thus you would enter \\). You can also specify an ASCII character using its octal value preceded by a backslash (for example, \041 is the exclamation mark character [!]). l l l Force one record per page: Select to force a single record per data page. If you clear the selection, a record may be split across data pages if necessary.
PAGE 64

l l l Force one record per page: Select to force a single record per data page. If you clear the selection, a record may be split across data pages if necessary. If you want to avoid splitting a record across data pages, yet have several records in the buffer, select Force one record per page, and set the Pages in buffer option to the number of records you want the buffer to hold. Delimiter: Enter the character that separates the fields of each record in the input data.
PAGE 65

l l l l The person or plugin performing the query must have full access to the database. The data is extracted at the time of the query. A new query must be performed whenever the data needs to be updated. Any changes to the structure of the database may have an impact on automated data querying tasks. You must have the proper ODBC driver installed to use this emulation.
PAGE 66

Line printer emulation options The line printer emulation does not have any options other than the general text-based emulation options (see "Text-based emulation" below). PDF emulation The PDF emulation allows you to capture data from fully composed documents in a PDF format.
PAGE 67

you stabilize your data, you also need to consider the internal structure of each data page. The internal structure of each data page must also be stable to make the data selections you use reliable (see "Data selections" on page 52). Ideally, a given piece of data occupies the same position across all data pages, or provides some stable characteristic that makes it possible to locate it on every data page.
PAGE 68

spacing caused by LFCR character pairs found within the data. Use it with the ASCII emulation and with the Tab on carriage return option to fix problems related to data formatting caused by isolated CR characters found within the data. This option can only be used with the ASCII emulation. Note for PlanetPress Suite users: You cannot select this option if the Design document is to be installed on a printer that cannot run in binary mode.
PAGE 69

For information about XML emulation options in PlanetPress Design documents, see the PlanetPress Design user guide. Sample Data This topic covers issues relating to the sample data used in your PlanetPress Workflow configuration. A sample data file makes it possible to: l l Create a process that retrieves dynamic data from a data file. Once a sample data file is available, you can use it to make data selections in a process (see "Data selections" on page 52).
PAGE 70

you may want to detect, or data used for a specific condition. For example, if you wanted to filter out any data for clients in Canada, you would want to use a data file that has at least one client from Canada, to test whether your process filters it out correctly. To choose a sample data file: 1. Click the Debug tab in the PlanetPress Workflow Ribbon. 2. Click on Select in the Data group. 3. Use the Data Selector to choose your sample data file and emulation options (see "The Data Selector" on page 835).
PAGE 71

1. Open the Data Selector (see "The Data Selector" on page 835). 2. From the Emulation drop-down list, select Database. 3. Next to the Sample data file field, click the Configure Database button. 4. Associate a database. l l Microsoft Access Database or dBase file: In Database, enter the path of the Microsoft Access database or dBase file, or click the Browse button to the right of the box to navigate to, the database file. Recall that a Microsoft Access database file bears the extension .
PAGE 72

set when the value of a specific field changes, and you want to sort the records before applying that condition. l Maximum records per record set: Set either the number of records in each record set, or the maximum number of records in a record set. An individual record set can contain a maximum of 4000 records. 7. Set the number of records you want to include in the sample data file.
PAGE 73

Opening a previously used data file PlanetPress Workflow also keeps the last 9 used data files in memory, which you can reopen to use in the same process, or in a different one. To reopen a sample data file: 1. Click the Debug tab in the PlanetPress Workflow Ribbon. 2. Click on Reopen Data File in the Data group. 3. Click on one of the data files in the list. 4. Use the Data Selector to change the emulation options if necessary. 5. Click OK on the Data Selector.
PAGE 74

Warning When a user-defined emulation (created in PlanetPress Design) is used with Metadata, results and behavior are unknown and unsupported. For instance, refreshing the Metadata file may cause the document to crash and/or corrupt. For this reason, it is strongly advised to create backup copies of your documents beforehand. Metadata structure The hierarchical structure of the Metadata is composed of a number of basic levels for adding information to a job.
PAGE 75

Note Any operation that modifies the data with regards to the structure (ex: remove pages, alter the data, etc.) makes the Metadata obsolete and so it must be recreated or refreshed; see "Working with Metadata" on the facing page. 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.
PAGE 76

Metadata Attributes and Fields Each Metadata node (i.e. Job, Group, Document, etc.) is described with a series of elements, that is, system-defined attributes or user-defined fields holding static or dynamic information about the node they are attached to. Each element has a name and a value. Here is a definition of these 2 types of elements: l l Attribute: A read-only, system-defined element which holds certain information about a certain node in the Metadata structure. This information can be static (e.
PAGE 77

How data and Metadata influence each other When Metadata are created, they are based upon a data file. However, modifying one file doesn't automatically change the other, and Metadata aren't reset by default in a Branch, Condition or Loop. l l l Modifying Metadata does not immediately modify the data. This is one of the benefits of Metadata because you can sort it, filter it, sequence it, add data to it, without ever modifying the data file itself.
PAGE 78

l l The "Capture Fields Generator" on page 538, "Capture Fields Processor" on page 541, "Get Capture Document" on page 551 and "Find Capture Documents" on page 547 tasks generate their own Metadata. The "Lookup in Microsoft® Excel® Documents" on page 494 enhances Metadata fields with information from an Excel spreadsheet, but does not otherwise change its structure. How Metadata affects the output By default the data file is not affected when the Metadata are modified.
PAGE 79

Example Here is an example of an issue that occurs when Metadata is not re-created in a Loop. In the following process, the Job file is a PDF that contains several invoices. Some (but not all) of those invoices start with a separator page that you don't want to print. Invoices that don't have a separator page should be printed as-is. The process would look something like this (by default): l l Step 2 splits the PDF whenever it encounters a new Invoice Number on the Top Right corner of a page.
PAGE 80

Page, in effect "hiding" it from the Print Output task). l l Step 6 prints the PDF to a printer. When printing a PDF file in passthrough mode, the Metadata is inspected to determine which pages should print or not. In this case, Page 1 is unselected in the Metadata, therefore the printer receives the job starting from Page 2, which is exactly what you want. Step 7 prints the entire PDF since no separator page was found.
PAGE 81

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 73 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 82

l Finishing attributes describe the finishing intent (e.g. page dimensions, page orientation, duplex mode, etc.). Note The presence of some finishing attributes depends on the PlanetPress Design document and target device used when producing the job. l Index/Count attributes are not part of the original Metadata file. They are evaluated dynamically, based on the content of the Metadata.
PAGE 83

Attribute Description Categor y J o b Gro up Docum ent DataEncoding (optional) Name of the character encoding. Producti on X X X DataFile (optional) Path and name of the data file used by the PlanetPress Design Document. Producti on X X X Date Date the Metadata was created in ISO format. Producti on X X X Time Time the Metadata was created in ISO format. Producti on X X X Title Title of the source document.
PAGE 84

Attribute Description Categor y J o b Gro up Docum ent X X Datap age Pa ge source of the Metadata. TargetDevice Name of the device for which the Metadata and associated data is intended. Producti on X Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input. Producti on X Dimension Two floatingpoint values separated by a colon indicating the media size in typographical points (ex: 612:792).
PAGE 85

Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape. Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent. Finishin g X Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicates a change of the duplex status.
PAGE 86

Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge media source. 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. Finishin g X X X X X MediaType Devicedependent type of the media.
PAGE 87

Attribute IndexInJob Description Categor y Absolute index of the node within all the nodes under the parent Group. ount Returns the Absolute index of the node within all the nodes under the parent Job.
PAGE 88

Attribute Description SelectedPageCoun t Categor y J o b Gro up Docum ent Index/C ount X X X SelectedIndexInDo cument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInGro up Returns the Absolute index of the node within all the selected nodes under the parent Group. Index/C ount SelectedIndexInJob Returns the Absolute index of the node within all the selected nodes under the parent Job.
PAGE 89

Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Windows driver. 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. It is a way to store information in a structured and easy-to-read format. It is often referred to as "XML without nodes" and it is designed for exchanging data.
PAGE 90

Types of JSON in Workflow Workflow tasks that support JSON accept or output one or two of the following types of JSON: l l a regular JSON string, containing a JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string examples" below. a JSON Record Data List (see the REST API Cookbook).
PAGE 91

{jobid}')", "pages":"lookup(OLCS_jobs, pages, jobid, '%{jobid}')", "documents":"lookup(OLCS_jobs, documents, jobid, '%{jobid}')", "recordsetid":"lookup(OLCS_jobs, recordsetid, jobid, '%{jobid}')" } An example where the entire JSON string is provided in a Job Info variable: %1 A JSON string constructed with information retrieved from an XML job data file (see "XML data selections" on page 57): { "first":"xmlget('/request[1]/values[1]/first [1]',Value,KeepCase,NoTrim)", "last":"xmlget('/request[1]/values[1]/l
PAGE 92

}, "tables" : { "detail": { "columns": { "ItemTotal": "CURRENCY", "ItemShipped": "FLOAT", "ItemOrdered": "BOOLEAN" } }, "detail2": { "columns": { "ItemUnitPrice": "CURRENCY", "ItemOrdered": "INTEGER" } } } }, "id": 3678077, "datasetid": 2392921, "fields": { "ID": "CU19762514", "Date": 1331096400000 }, "tables": { "detail": [{ "id": 3678078, "fields": { "ItemTotal": "2300.00", "ItemShipped": 2.0, "ItemOrdered": false } }, { "id": 3678079, "fields": { "ItemTotal": "29.99", "ItemShipped": 1.
PAGE 93

"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.ItemTotal; 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.
PAGE 94

Structure As can be seen in the "Data Repository Manager" on page 832, the Data Repository consists of Groups, Keys and KeySets. Feature Name Description Equivalent Database Terminology Group A Group is defined by its Keys (columns), and may contain 0 or more KeySets (rows) within it. Table Key A Key is defined only by its name. The Data Repository only supports STRING values and any data inserted into it is converted to string automatically. The maximum size of a single key is 1 billion bytes.
PAGE 95

Retrieving data from the Data Repository In any Workflow task where variable data is allowed (recognisable by the maroon field labels), information can be retrieved from the Data Repository using a Lookup function. Right-click a field with a maroon label and select Get Repository Location. This will bring up the "Data Repository Manager" on page 832. Select a Group, Key and KeySet entry to determine which value or values should be retrieved at runtime; then click OK.
PAGE 96

Scripts In a script you can access the Data Repository using the "Data Repository API" on page 174. For a quick start, turn to this How-to: Interacting with the Data Repository API. Data Repository Manager At design-time, the Data Repository Manager may be used to insert or remove Groups, Keys and KeySets; see "Data Repository Manager" on page 832.
PAGE 97

When such an error occurs, in most cases you would want to be aware of it and to take certain actions in order to correct or report the error. This is where our error handling features come in handy. Most of the tasks, branches and conditions included in your process can have their own error handling behavior, with the exception of Comments, the Input Error bin task, and older legacy tasks from previous versions of Workflow that did not have error handling.
PAGE 98

the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration. l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. If the task is not on a branch, the entire process will be stopped.
PAGE 99

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

Variable Name % {error.process} Name of the process where the error was triggered. % {error.tasktype} The type of task that triggered the error % {error.taskname} The name of the task that triggered the error % {error.taskindex} The position of the task in the process % {error.errormsg} The error message, as entered in the OnError tab of the task. This is the same message as appears in PlanetPress Workflow Log file. %{error.errorid} The error ID, as entered in the OnError tab of the task.
PAGE 101

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

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

In the above image, the Folder Capture task is on level 1 and the Text condition is on level 4. Here's how to resubmit backed up input data files. Note The resubmit option is triggered through the Workflow configuration tool, but the job being resubmitted is actually handled by the Workflow Service, using that service's credentials. The service must therefore be running in order to resubmit jobs. 1. In the PlanetPress Workflow Ribbon, go to the Tools tab then click Resubmit Job in the Services group.
PAGE 104

Warning The From page and To page boxes are only useful for Printer Queue (or printer capture) Input tasks. They will not function for other types of inputs. In these cases, the complete backup job is submitted. 6. Click Send to resubmit the data. 7. To resubmit backed up input files for the same process or for a different one, repeat step 2 to step 6. 8. To close the File Resubmission dialog box, click Close.
PAGE 105

Once you have created and fully debugged all your processes, you will be ready to send it to PlanetPress Workflow service. See "Saving and sending a Workflow Configuration" on page 35. Prerequisites Before you can start debugging, these are the prerequisites. l There must not be any "Unknown tasks" on page 696 in the process. l A sample data file must be selected; see "Choosing a sample data file" on page 69.
PAGE 106

l l l From the Debug tab, click on Run. This executes the complete process, step by step, until it is completed. From the Debug tab, click on Step. This executes only the first task in the process and waits for further action. While stepping through a process (using Step, not Run), breakpoints may be used and given steps may be passed, using the buttons on the Debug ribbon (see below). Right-click on any task in the process and click Run from Here or Step from Here.
PAGE 107

l l l Click on the Stop button to stop the debugging process. If you use Run, Step or Skip after stopping the process, debugging starts over from the top. Use the Set Breakpoint button to tag the currently selected task, branch or condition as a breakpoint. When you click Run in your process, the process will execute every task until it reaches a breakpoint and will stop just before the task that is set as a breakpoint.
PAGE 108

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

Both tasks can produce many different types of files and distribute them to many different printers, or to a folder. Print options The file type, printer model, output type (a folder, LPR queue or Windows printer), and print options and settings are normally contained in an Output Creation Preset. Output Creation Presets are created in the Connect Designer and can be used with any Connect template (see Output Creation Preset and Print Options in Connect's Online Help).
PAGE 110

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 42). Print output is normally generated by an Output task that merges a PlanetPress Design document with a data file (i.e. the job file). This can be either the "Print using a Windows driver" on page 652 Output task, or the "Printer Queue Output" on page 654 Output task.
PAGE 111

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

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 113

Character name: Character code: Typical use in printing context: 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 printer queues set up in the Windows session in which PlanetPress Workflow is running.
PAGE 114

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

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. l l l (v) Sun raster file if the job file contains raster images. This ensures that the printer uses the correct filter to interpret the data. Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used. You may use a different variable, but you may not use a data selection. This information may be used for the printer’s banner page.
PAGE 116

generated using the Optimized PostScript Stream option, you should not enter data selections in the Printer address and Queue name variable property boxes. If you do need to use information stored in the data to configure the LPR output printer queue, you should first use Job info variables to store the information, and then use these variables in the Printer address and Queue name variable property boxes.
PAGE 117

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 118

print job under an existing name, it appends the content of the new print job file to that of the existing file, instead of overwriting it. l Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected. 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 119

In the General tab of the Printer Queue Output Properties dialog box, you may select multiple printers, and in the Advanced tab, you can set the load balancing options for the selected printers. Associating PlanetPress Design documents and PlanetPress printer queues One of the resources stored in a PlanetPress Workflow printer queue is the list of PlanetPress Design documents associated with it. Also stored in the printer queue are the properties of each document associated with the queue.
PAGE 120

2. In the Printer Queue list, select all those Workflow printer queues for which you want unlink the document. 3. Click OK. Modifying Design document settings To modify the settings of a PlanetPress Design document assigned to a Workflow printer queue: l Double-click on the document located within a printer queue. The Document Properties dialog appears.
PAGE 121

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

Printer Properties setup PlanetPress Workflow WinQueue Input task can be configured to set a Windows printer queue using Objectif Lune Printer Driver (PS) to produce one of 3 different types of data files: EMF, PostScript, or PDF. Printer properties settings Spool Print Jobs in EMF Format l This will create an EMF data file. l This format is usually reserved for use with the Windows Print Converter action plugin.
PAGE 123

Printer Driver (PS) from the drop-down list. 5. Click OK. 6. Send the configuration and start your PlanetPress Workflow service. 7. Start the windows application from which you want to capture data. 8. Open your selected document. 9. Click File | Print. 10. Choose the same Windows print queue as in step 4. Note Steps 6-8 can be performed at any time, even if PlanetPress Workflow is not yet started. This is because every Windows printer queue using Objectif Lune Printer Driver (PS) is paused by default.
PAGE 124

About processes and subprocesses Processes A process is a single workflow within a configuration (see "About Workflow Configurations" on page 32). A process begins with a single input task, contains one or more tasks and/or branches, and terminates with one or more output tasks. In its simplest form, a process can retrieve data from a given folder and save it in a different folder.
PAGE 125

replicating process polls its source once, determines the number of files to process, then replicates itself up to the maximum allowed and treats the files simultaneously. The initial process runs again once it has completed itself and replicates again as necessary, until all files have been processed.
PAGE 126

To call a subprocess from another process, use the "Go Sub" on page 475 Process logic task. Whenever a process calls a subprocess, the main process (the caller) will wait for the called subprocess to finish its execution before carrying on with its own. This means the subprocess feature is synchronous with the main process. This also means the calling process actually appends the subprocess to its own workflow.
PAGE 127

l Right-click a regular process and select Startup to convert the process into a startup process. Note that a self-replicating process can't be converted into a startup process. Adding a subprocess To add a PlanetPress Workflow subprocess: l l In the Ribbon, go to the Home tab and click the Subprocess button in the Processes group. In the Configuration Components pane, right-click on the Subprocesses folder and select Insert > Insert Subprocess.
PAGE 128

and at least one example of an implementation that uses them in the chapter: "Special workflow types" on page 276. Importing processes You can import individual processes or groups of processes from another PlanetPress Workflow configuration file without having to import the contents of the entire configuration file. The PlanetPress Workflow Configuration tool imports everything necessary to run the processes, including configured tasks and some configuration components.
PAGE 129

l l References to specific PlanetPress Design or PrintShop Mail documents. Note that the documents themselves must be imported separately. Specific printer queues. 5. Check Overwrite existing components with same name if you want processes with existing names to be overwritten by those in the imported configuration, or uncheck it to duplicate those processes under a new automatically generated name. 6. Click OK to start the import.
PAGE 130

have to send the edited configuration to your PlanetPress Workflow Service (see "Sending a configuration" on page 35). Note If you try to send a configuration that contains only inactive processes, the PlanetPress Workflow Configuration program will ask you to confirm the operation (this can be changed in the Notification User Options). 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 131

l l l Self Replicating: Check this if you want the process to replicate itself in the background when multiple input files are received simultaneously. When this is checked, the input task polls its source once, determines the number of files to process, then replicates itself up to the maximum allowed and treats the files simultaneously. The initial process runs again once it has completed itself and replicates again as necessary, until all files have been processed.
PAGE 132

that's only scheduled to run one hour per week, it will capture the input 120 times during that period. Note The polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to process. l l Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked.
PAGE 133

The Time Grid The PlanetPress Workflow Process Options dialog box includes a time grid that lets you set exactly when you want a process to poll. The grid is composed of blocks that represent time periods on a given day. To activate the Time Grid, the "As soon as possible" option must be unchecked. In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not poll.
PAGE 134

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 135

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 136

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 137

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 138

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 139

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

Using Scripts Scripts can be used to perform various operations, such as to manipulate data, for example. PlanetPress Workflow can perform scripts written in four different scripting languages and also provides an interface for editing scripts. Note While this chapter provides some very useful and detailed information about scripting within PlanetPress Workflow, its focus is to inform you about the features, variables and functions unique to this environment.
PAGE 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 795.
PAGE 149

SOAP Server API Reference PlanetPress 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.
PAGE 150

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. GetProcessList The GetProcessList function allows SOAP clients to request the list of available PlanetPress Workflow processes, based on their authentication credentials. Syntax GetProcessList (user name, Password) : GetProcessListResult Parameters l user name: String containing the user name.
PAGE 151

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

working with the SubmitJob SOAP API method since it requires a SOAPActionName. Syntax GetSOAPProcessList (user name, Password) : GetSOAPProcessListResult Description Parameters l user name: String containing the user name. l Password: String containing the password. This is case sensitive. Return Value l GetSOAPProcessListResult: Structure containing the following information: l Success: Integer indicating the system-defined Success/Error level of the operation.
PAGE 153

Syntax PostJob (File, PostJobInfStruc , user name, Password) : PostJobResult Description Parameters l l File: base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64). PostJobInfStruc: Structure containing any required information to prepare the file for resubmission into a PlanetPress Workflow process (see "PostJobInfoStruc" on the next page). l User name: String containing the user name. l Password: String containing the password. This is case sensitive.
PAGE 154

PostJobInfoStruc Structure containing any required information to prepare the file for resubmission into a PlanetPress 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. l VariableName: String l VariableValue: String l ProcessName: String: name of the PlanetPress Workflow process. l TaskIndex: Integer: 1 based index of the task where the resubmission should start.
PAGE 155

l ReturnJobFile – Boolean value. When true, PlanetPress Workflow SOAP server returns the job file. When false, there no file is returned to the SOAP client. (For example: when submitting a job for print, there is no need to return a file) l user name: String containing the user name. l Password: String containing the password. This is case sensitive.
PAGE 156

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 PlanetPress Workflow preferences. SubmitJobInfStruc Structure containing any required information to prepare the file for a valid insertion into a PlanetPress Workflow process using SOAP. l l VariableList: Array of complex type, containing pairs of variable name and variable value. The list also contains the JobInfo variables.
PAGE 157

Variable Name Description Example Usage (VBScript) "Watch.GetJobFileName" on page 164 Retrieves a string containing the job path and file name located in the job spool folder. Example Usage: var s = Watch.GetJobFilename(); "Watch.GetOriginalFileName" on page 166 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.
PAGE 158

Variable Name Description Example Usage (VBScript) ("%y-%m-%d"); "Watch.Log" on page 169 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.ShowMessage" on page 172 Displays a popup dialog box to the user (user has to be logged on). Example Usage: Watch.ShowMessage("test message"); "Watch.SetJobInfo" on page 171 Writes the value of a string to a numbered job info.
PAGE 159

Variable Name Description Example Usage (VBScript) c:\\myfile.ps", "c:\\", 0, true); "Script.ReturnValue" on page 173 Returns a boolean True or False value to a Workflow scripted condition Example Usage: Script.ReturnValue = 1; Watch.GetPDFEditObject Is used to manipulate PDF files using the AlambicEdit API; see the "AlambicEdit API reference" on page 241. The AlambicEdit library allows Workflow to access, create or modify PDF files. "Watch.
PAGE 160

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 161

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 162

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 163

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 164

The arguments contain the Connect Server settings (see "OL Connect preferences" on page 767), 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 165

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

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 167

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 38).
PAGE 168

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 169

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 38). Syntax Watch.
PAGE 170

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. Note that the text of the message must use the locale encoding of the system where the PlanetPress Workflow software will be running, otherwise it will be unreadable. Level An integer between 1 and 4, specifying the severity level of the error message. Set message levels as follows.
PAGE 171

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 697.) Syntax Watch.SetJobInfo(Index: Integer; Value: String) Example JavaScript Watch.SetJobInfo(3, "Job info 3 Value"); VBScript Watch.SetJobInfo 3, "Job info 3 Value" Python Watch.
PAGE 172

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.SetVariable("MyVariable", "Desired value") Watch.SetVariable("global.MyVariable", "Desired value") Perl $Watch->SetVariable("MyVariable", "Desired value"); $Watch->SetVariable("global.MyVariable", "Desired value"); Watch.
PAGE 173

Watch.Sleep Pauses the process for the specified number of milliseconds. This can be used while waiting for something else to happen when the delay is known. Syntax Watch.Sleep(milliseconds: integer) Example In the following example, Sleep() pauses the process for 1 second (1000 milliseconds) JavaScript Watch.Sleep(1000); VBScript Watch.Sleep 1000 Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.
PAGE 174

} else { Script.ReturnValue = 0 } VBScript Dim everythingOK everythingOK = true if (everythingOK = true) then Script.ReturnValue = 1 else Script.ReturnValue = 0 end if Python everythingOK = True if everythingOK: Script.ReturnValue = 1 else: Script.
PAGE 175

Warning All operations on the Repository must be performed through this API - rather than directly accessing the physical file - since the Repository's underlying file structure may change over time. This API is guaranteed to remain compatible with future versions of the Data Repository. It is used by all Workflow tasks dealing with the Repository. Data repository structure The table below lists the different levels in the repository and what their names corresponds to: The term ... ...
PAGE 176

In each example in this documentation, the object repoObject is deemed having been obtained through the above call to the COM object. The default Repository is always stored at the same location (see "Where to find the Data Repository" on page 96). The ConnectionString property allows to create an instance of the Repository at another location; see ConnectionString.
PAGE 177

Name Description "ClearRepository" on page 185 Deletes all groups, keys and keysets from the repository, returning it to a blank state. Use with caution! "ClearGroupData" on page 184 Deletes all keysets inside GroupName while retaining the existing key structure. "ClearAllData" on page 184 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.
PAGE 178

Key Methods Name Description "AddKey" on page 181 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 page 183 for information on how to set a value for a key. "ListKeys" on page 188 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 179

Name Description the ID of the newly created KeySet. "GetValue" on page 186 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 193 Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition.
PAGE 180

Name Description 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 185 Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all keys are retrieved. When Condition is left empty, all keysets are retrieved.
PAGE 181

Name Description 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. The keyNames parameter may be empty.
PAGE 182

"AddValue" on the facing 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.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 175). JavaScript repoObject.AddKey("Users", "email"); VB Script repoObject.
PAGE 183

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. However, in some cases you might want to script it for simplicity's sake.
PAGE 184

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 175). JavaScript repoObject.AddValue("Users", "LastName", "Smith"); VB Script repoObject.
PAGE 185

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 186

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 187

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 175). JavaScript var myValue = repoObject.
PAGE 188

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

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 175). 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 190

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 191

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 175). 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 192

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 193

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 175). JavaScript repoObject.RenameKey("Users", "LastName", "SurName"); VB Script repoObject.
PAGE 194

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 195

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 175). 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 196

Metadata API The "Metadata" on page 73 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 555), but you can also manipulate the Metadata in your process via scripts using the Metadata API.
PAGE 197

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 199 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 198

Job() Returns the "MetaJob" on the facing 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 199

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 230 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 81.) "Count" on page 216 Integer Returns the number of child nodes.
PAGE 200

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 219 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 219 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 220 String Returns the value of the attribute of the specified name.
PAGE 201

located at the specified index. Group(Integer Index), see "Item(Integer Index)" on page 224 Node Returns the MetaGroup at the specified index. "PageCount()" on page 225 Integer Returns the total number of pages present underneath this node. "Paste()" on page 225 Node Inserts the clipboard's content as the last child of the current node. "PasteAt(Integer Index)" on page 225 Node Inserts the clipboard's content as a child node at the specified index.
PAGE 202

optional const String Name3, optional TSortFlags Flags3)" on page 228 MetaGroup Properties Name Type Description "Attributes" on page 230 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 81.) "Count" on page 216 Integer Returns the number of child nodes. "Fields" on page 232 MetaCollection Returns the node's field collection. "Index" on page 216 Integer Gets the index of the node in its parent.
PAGE 203

on page 218 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. Methods Name Return type Description "Add(Integer Index)" on page 219 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 219 String Returns the specified attribute's value.
PAGE 204

"FieldByName(const String Name)" on page 222 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 223 String Returns the value of the N'th field of the specified name. "IndexInJob()" on page 224 Integer Returns the index of this page in the job, taking all the pages from all the datapages from all the documents from all the groups into account.
PAGE 205

underneath this node. "SelectedPageCount()" on page 228 Integer Returns the number of pages selected to be output that are underneath this node. "SelectedIndexInJob()" on page 228 Integer Index of the page among all the selected pages in the Job. "Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3)" on page 228 Sorts the sub-nodes according to a number of criteria.
PAGE 206

"Parent" on page 217 Node Returns the parent node of the current node. "Selected" on page 217 Bool Indicates whether or not the Node is set to be printed. "SelectedCount" on page 218 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 215.) "SelectedState" on page 218 Integer Returns an integer indicating whether the node is selected or not, taking its parents into account. 0: The node is not selected.
PAGE 207

in the metadata clipboard. "Delete()" on page 221 Deletes the node. "FieldByIndex(Integer Index)" on page 222 String Returns the specified field's value. "FieldByName(const String Name)" on page 222 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 223 String Returns the value of the N'th field of the specified name.
PAGE 208

"Select(TSelectWhat SelectWhat)" on page 226 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. "SelectedPageCount()" on page 228 Integer Returns the number of pages selected to be output that are underneath this node. "SelectedIndexInGroup()" on page 227 Integer Index of the page among all the selected pages in its parent Group.
PAGE 209

"Fields" on page 232 MetaCollection Returns the node's field collection. "Index" on page 216 Integer Gets the index of the node in its parent. "NodeType" on page 217 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 217 Node Returns the parent node of the current node.
PAGE 210

page 219 "AttributeByName(const String Name)" on page 220 value. String Returns the value of the attribute of the specified name. "Clear()" on page 220 Deletes all the child nodes as well as the attributes and fields. "Copy() " on page 220 Places a copy of the node in the metadata clipboard. "Cut()" on page 220 Removes the node and places it in the metadata clipboard. "Delete()" on page 221 Deletes the node. "FieldByIndex(Integer Index)" on page 222 String Returns the specified field's value.
PAGE 211

into account. "Item(Integer Index)" on page 224 Node Page(Integer Index), see , see "Item(Integer Index)" on page 224 Returns the child (node) item located at the specified index. Returns the MetaPage at the specified index. "Paste()" on page 225 Node Inserts the clipboard's content as the last child of the current node. "PasteAt(Integer Index)" on page 225 Node Inserts the clipboard's content as a child node at the specified index.
PAGE 212

MetaPage Properties Name Type Description "Attributes" on page 230 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 81.) "Fields" on page 232 MetaCollection Returns the node's field collection. "Index" on page 216 Integer Gets the index of the node in its parent. "NodeType" on page 217 TNodeType Returns the node type of the current Node.
PAGE 213

"Cut()" on page 220 Removes the node and places it in the metadata clipboard. "Delete()" on page 221 Deletes the node. "FieldByIndex(Integer Index)" on page 222 String Returns the specified field's value. "FieldByName(const String Name)" on page 222 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 223 String Returns the value of the N'th field of the specified name.
PAGE 214

Node Node objects are items in the Metadata's single-rooted tree-like structure. Each Node item is a collection of its lower level Node type.
PAGE 215

Selected property set to true will print. If Selected is false, its children will not print, regardless of their Selected status. Methods like Count, Index or PageCount work on all nodes, regardless of their Selected attributes. Methods whose names start with "Selected" however are meant to work with selected nodes. In other words, "Selected..." methods only consider nodes that are set to be part of the output.
PAGE 216

Node properties and methods reference This topic gives detailed information about all properties and methods of the Node object. The availability of a property or method with an actual Node object, however, depends on the type of the Node: "MetaJob" on page 199, "MetaGroup" on page 202, "MetaDocument" on page 205, "MetaDatapage" on page 208, and "MetaPage" on page 212. Properties Attributes Returns the attribute collection (MetaCollection) of the current node. See "Attributes" on page 230.
PAGE 217

NodeType Returns a value representing the type (TNodeType) of the current node. Return value Node type 0 Job 2 Group 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.
PAGE 218

(writing) Parameters: Select True to mark as selected to be printed, false if it is not to be printed. SelectedCount Not available in MetaPage 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.
PAGE 219

Methods Add(Integer Index) Not available in MetaPage Adds a new Node as a child of the current node. 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.
PAGE 220

AttributeByName(const String Name) Returns the value of the metadata attribute of the specified name. Parameters: Name Name of the attribute to retrieve. 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.
PAGE 221

Warning The node being cut is removed immediately. Any reference to it or its child nodes becomes invalid. The results of calling methods of such references is undefined. DatapageCount() MetaJob and MetaGroup only 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.
PAGE 222

Returns: Total number (integer) of MetaDocument nodes found under the current node. FieldByIndex(Integer Index) Returns the value of the Metadata Field at the specified index. (See: "Fields" on page 232.) Parameters: Index 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.
PAGE 223

FieldByNameIndex(const String Name, Integer Index) Returns the value of the n'th metadata field of the specified name. This method can be used to retrieve the value of a specific field when more than one field has the same name. Parameters: Name Name of the field to retrieve. Index 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.
PAGE 224

Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account. Returns: Absolute index (integer, 0-based) of the page within all the pages under the parent group. IndexInJob() Not available in MetaJob Returns the index of this page in the job, taking all the pages from all the datapages from all the documents from all the groups into account. Returns: Absolute index (0-based) of the page within all the pages in the job.
PAGE 225

Exception: l EOleException: Index is lower than 0 or higher than Count-1. PageCount() MetaJob, MetaGroup and MetaDocument only Returns the number of MetaPage in all child nodes. This methods recursively goes through all child nodes to count the total number of MetaPage that are contained underneath the current node. Returns: Total number of MetaPage found under the current node. Paste() Not available in MetaPage Inserts the contents of the metadata clipboard as the last child node of the current node.
PAGE 226

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 top node being pasted. Exceptions: l l EOleException: The node type of the clipboard and the current node don't match.
PAGE 227

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. SelectedDocumentCount() MetaJob only Returns the number of documents 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 228

SelectedIndexInJob() Not available in MetaJob Returns the index of this page in the job, taking only the selected pages from all the datapages from all the documents from all the groups into account. Returns: Absolute index (0-based) of the page within all the selected pages in the job. If the page is not set to be output (i.e. its SelectedState is different than ssTrue), it returns -1.
PAGE 229

Value Meaning 1 The name refers to an Attribute rather than a field. 2 The sort is done in descending order (i.e. the highest to the lowest). 4 The field is an integer numeric value. Note In an Active Script environment, such as the Run Script task, you must work with the numerical values. In environments where the flags are defined, you may instead use sfAttribute (= 1), sfDescending (= 2), and sfNumeric (= 4). All the parameters to this method except for the first one are optional.
PAGE 230

Flags2 (optional) Set of flags that modify how the sorting on Name2 is done. Name3 (optional) Name of the field or attribute contained in each sub-node whose value will be used as the third sort criteria. If it is an attribute instead of a field, this needs to be specified in the Flags3 parameter. Flags3 (optional) Set of flags that modify how the sorting on Name3 is done. Exceptions: l l l EOleException: Specified field or attribute does not exist in one of the sub-nodes.
PAGE 231

Warning Attributes are intended for system-defined data. Please restrict user-defined data to Fields, and do not modify the Attributes. 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 page 233 Adds a new element to the collection or overwrites its value. Clear() Clears all elements from the collection.
PAGE 232

Fields A Field is a read-write, user-defined element: a name/value pair, where the name is caseinsensitive. It holds custom information about a certain "Node" on page 214 in the Metadata structure. Fields are repetitive (i.e. the same field may appear multiple times) and persist through Metadata recreation. Fields are stored in a collection container object, just like "Attributes" on page 230. As is the case with the different types of Nodes, both collections share a number of methods and properties.
PAGE 233

"Delete(Integer Index)" on page 235 Deletes the element at the specified index. "Item(Integer Index)" on page 236 String Returns the value of the element stored at the specified index. "ItemByName(const String Name)" on page 236 String Returns the value of the element of the specified name. "ItemByNameIndex(const String Name, Integer Index)" on page 236 String Returns the value of the n'th element of the specified name.
PAGE 234

Exceptions l EOleException The name is empty or invalid. Add2(const String Name, const String Value, TAddFlags Flags, Integer Index (optional)) Fields only Adds a new field to the collection. The behavior of the method when the specified name already exists in the collection is determined by the Flags argument. 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.
PAGE 235

Instance of the field to modify. This must be a numeric value equal to 0 or greater and can only be used with the afReplace flag. Exceptions l EOleException The name is empty or invalid. l EOleException The flags value is invalid. l EOleException The name already exists and the afFail flag was specified. l EOleException The index is invalid. l EOleException An index is specified but afReplace is not specified.
PAGE 236

Exceptions l EOleException Index is lower than 0 or higher than Count-1. Item(Integer Index) Returns the value of the element at the specified index in the collection. Parameters Index 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.
PAGE 237

Returns the value of the n'th field of the specified name. This method can be used to retrieve the value of a specific field when more than one field has the same name. Parameters Name Name of the field to retrieve. Index 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.
PAGE 238

Exceptions l EOleException Index is lower than 0 or higher than Count-1. StringSort StringSort is a convenience class that provides a generic sorting class for ActiveScriptcompatible languages. It is a non-trivial task to sort data in scripting, especially in VBScript where there is no equivalent for the JScript sort function. It is designed as a list of strings. Each string in the list is a key based on which the sort is done.
PAGE 239

"Sort()" on the next page Sorts the list. "SortByValue()" on the next page Sorts the list based on the value instead of the key. "Value(Integer Index )" on the next page Integer Returns the value at the specified index. 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.
PAGE 240

Exceptions l EOleException Index is lower than 0 or higher than Count-1. Find(const String Key) Finds a string and returns its position in the list. Key String to find. 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.
PAGE 241

0-based index (integer) of the value to retrieve. Return value: The integer value at the specified index. Exceptions l EOleException: Index is lower than 0 or higher than Count-1. 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.
PAGE 242

example Stamping one PDF file on another PDF file. Syntax conventions The syntax for methods, properties and structures is as follows. 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.
PAGE 243

Examples INTEGER Orientation JavaScript implementation: var currentOrientation = myPDF.Pages(0).Orientation; myPDF.Pages(0).Orientation = 180; 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.
PAGE 244

PDF object The PDF object implements the IPDF interface. This interface defines methods to open, close and save files, as well as to access meta information such as the XMP attachment. The interface also implements a Pages collection object to access the list of pages in the PDF. To instantiate the PDF object, call the Watch.GetPDFEditObject method in Workflow's scripting environment. Javascript implementation: var myPDF = Watch.GetPDFEditObject(); VBScript implementation: set myPDF = Watch.
PAGE 245

"IsProtected(filename)" on page 249 BOOL Returns True if the PDF file is passwordprotected. When a file is password-protected, the OpenEx() method must be used instead of the Open() method. "MergeWith (pdfFilename)" on page 249 Merges the pages of pdfFilename (the source) with the pages of the current PDF (the destination).
PAGE 246

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. "SetInfos(Infos)" on page 253 Sets the contents for the PDF's Document Information Dictionary. "setTolerances (tolerableDeltaWidth, tolerableDeltaHeight, tolerableDeltaFontHeight, tolerableGap)" on page 254 Sets the floating point values for the tolerable factors.
PAGE 247

} objPage=null; objPages=null; CollectGarbage(); objPDF.Close(); 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 253. 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 248

GetInfos() Retrieves the contents of the Document Information Dictionary from the PDF. Syntax IPdfInfos GetInfos () Return value An "IPdfInfos" on page 271 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.
PAGE 249

STRING GetXYML () Return value A string containing the complete text of the PDF in XYML format. 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 251. 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 250

MergeWith2(pdfFilename, xnum, ynum, xoffset, yoffset, scaleFactor) Merges the pages of pdfFilename (the source) onto the pages of the current PDF (the destination). Each page of the source is overlaid transparently onto a destination page 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. The resulting file is not optimized. In PlanetPress Suite, this method is useful for n-Up imposition. For example, (xnum=1, ynum=1, scaleFactor=1.
PAGE 251

Scale at which to draw on source pages on the destination. Use 1.0 to draw the page at its nominal size. Open(filename, doRepair) Opens an existing PDF, optionally repairing it. Syntax 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.
PAGE 252

IPages Pages () Return value An IPages collection object. Each page in the zero-based collection can be accessed through the IPages.Item() method. Note that since Item() is the collection's default method, it can be omitted altogether (e.g. IPages(0) is the same as IPages.Item(0)). Print(printername) Prints a range of PDF pages to the specified Windows printer with default options. See also: "PrintEx(printername, *PdfPrintParams)" below.
PAGE 253

printerName (optional) Name of the printer to print to. The default options of the printer will be used. PdfPrintParams , if non-NULL, may override some of them. If NULL, the default printer is used. PdfPrintParams (optional) Pointer to an "IPdfPrintParams" on page 272 structure that specifies various print options. If NULL , default values are used. Save() Saves changes to the PDF file.
PAGE 254

cacheSize Maximum number of IPage pointers that the cache can hold, between 1 and 1000. 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.
PAGE 255

Minor version number. 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 244.
PAGE 256

"InsertFrom (srcFilename, srcIndex, srcCount, destIndex)" on page 258 Inserts pages from another PDF file into this one. All relevant resources are copied with the pages. "InsertFrom2 (srcPages, srcIndex, srcCount, destIndex)" on page 258 Inserts pages from another IPages object into this one. All relevant resources are copied with the pages. "Item(index)" on page 259 IPage (see "Page object" on page 260 ) "Move(index, count, offset)" on page 259 Returns a Page object from the PDF.
PAGE 257

Syntax VOID Delete ( LONG index ) index 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 258

index 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 273 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 256.
PAGE 259

Syntax 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 260

Syntax 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 261

parameters. If multiple lines are found, they are separated by a CR-LF pair. "ExtractText2(left, top, right, bottom)" on page 265 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 266 "IPdfRect" on page 273 Returns the size of the actual media, i.e. the sheet of paper.
PAGE 262

rotateAngle, scaleFactor, layerName)" on page 269 Optional Content Group). Supported image types are JPG and PNG. "MergeToLayer2 (srcPage, left, top, rotateAngle, scaleFactor, layerName)" on page 270 This method behaves the same as Merge2() but allows to put the source page as a layer (aka an Optional Content Group). "Size()" on page 271 "IPdfRect" on page 273 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 263

Horizontal offset from the left edge of the DC surface, in *device* units, at which to start the drawing. offsetY 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 264

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 265

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 266

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

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 268

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 269

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 270

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 271

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 272

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 273

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 274

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 97).
PAGE 275

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 276

$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 PlanetPress 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 277

OL Connect Send (see "OL Connect Send" on page 740) 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 296.
PAGE 278

l HTTP Data Submission: A custom application or a server sends the request to PlanetPress Workflow using either a POST or GET command. The application or server then waits for a response from PlanetPress Workflow. PlanetPress 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 279

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 PlanetPress 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 280

l l l Self-Replicating Process: This option is critically important when dealing with HTTP processes. Basically, this means that when HTTP requests are received, the process will duplicate itself up to the specified maximum number, in order to simultaneously (and asynchronously) handle multiple requests. See "Process properties" on page 847 for more details.
PAGE 281

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. Note that this is the process when the default HTTP Server Input task options are used (more on how that behavior changes later): 1. A request is received by the HTTP service. 2. This request is converted into an XML request file along with one or more attachments when present. 3.
PAGE 282

Example HTTP Workflows l "HTTP PDF Invoice Request" below (GET) l "HTTP brochure request" on page 284 (Customer Information+ POST) l "Capture Web Manager Workflow" on page 294 (Capture + HTTP) HTTP PDF Invoice Request This straightforward workflow simply receives a GET request from a browser, loads an existing PDF invoice from a folder on the hard drive, and returns it to the browser.
PAGE 283

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

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

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 286

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

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

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

l l l l l An "HTTP Server Input" on page 328 task or "Folder Capture" on page 318 task that receives the PGC. The "Capture Fields Processor" on page 541, 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 533 task to do post-processing using the Capture Fields data.
PAGE 290

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

l Any input task l "Create Metadata" on page 555 l "Capture Fields Generator" on page 538 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 292

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

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

Capture Web Manager Workflow This example is both a more involved workflow for Capture, and an interesting implementation of an HTTP Workflow. Before looking at this example, it would be best to become familiar with both "PlanetPress Capture Workflow" on page 287 and "HTTP Server workflow" on page 277.
PAGE 295

The example is too complex to display as images in this guide, so it is rather available for download. Resources l Capture Web Manager Workflow Configuration (PW7) l Capture Web Manager PlanetPress Design Document (PP7) Note This example is compatible with PlanetPress Workflow 7.4 and higher and will not work in older versions. Installation 1. Download both resource files 2. Create a folder on your disk called c:\PlanetPress 3. Import the invoice.
PAGE 296

integrates into the workflow in general and what to keep in mind when doing an actual implementation of such a process. Considerations l l l The workflow itself is a standalone system that does not interact with any third-party systems, which of course does not correspond to real customer implementation. A client will most likely need to communicate with both an ERP system that generates documents as well as an archive software to store completed documents.
PAGE 297

Interactive process When a job is received in licensed mode, an interactive process is started. This process, which may consist of several Workflow processes, serves web pages to the customer and handles the customer's response, changing (settings for) the print job. A few of the key components in this process are: l l l l The HTTP Server Input plugin. The interactive process start with this plugin.
PAGE 298

About Tasks A task is a plugin or a block that is used to build PlanetPress Workflow processes. Tasks can do multiple things depending on the type of task and where they are placed. You can add as many tasks as you like to your processes and order them in any way you can. There are different types of tasks: l l l Input Task: Will either capture data from a specific location, or wait for input from a service or other computer to start processing.
PAGE 299

l "Output tasks" on page 639 l "Unknown tasks" on page 696 Note Completely empty files (0 bytes) cannot be processed by Workflow. In fact, the PlanetPress Workflow plugin based architecture enables almost limitless customization. You can create or purchase compatible plugins, drop them in PlanetPress Workflow's Plug-In Bar and use them to perform other operations. Adding tasks You can add as many tasks as you want to your process by using the Plug-in Bar in PlanetPress Workflow program.
PAGE 300

l Dropping a task on top of another one replaces it. l Dropping a task between two tasks will insert it at that location. l You cannot add a task above the initial input task of a process, since new tasks are always added above a selected task or branch. Editing a task To edit a task, you simply need to access and change its properties (see "Task properties" below). You may even do it while your process is in Debug mode (See "Debugging your PlanetPress Workflow process" on page 104).
PAGE 301

l l l l Most tasks have the General tab which lets you configure the main task properties for that specific task. All tasks except for the InputErrorBin, Run Script, Open XLST and Comment tasks have an On Error tab that lets you manage errors generated by the task. For a description of the options that it contains, see "Using the On Error tab" on page 97.
PAGE 302

Variable properties can also be used in these special locations: l In the Set Job Infos and Variables Action Task. See "Set Job Infos and Variables" on page 436. l In Scripts. See the chapter on "Using Scripts" on page 141. l In the Create File Input Task. See "Create File" on page 310. l Within a PlanetPress Design Document, using the ExpandString() function. See the PlanetPress Design User Guide and PlanetPress Talk Reference Guide.
PAGE 303

l l l l Get Metadata Value: Brings up the Data Selector with only the Metadata tab visible and lets you select the value (contents) of a Metadata attribute or field. The result is static and does not change between jobs. Get Metadata Location: Brings up the Data Selector with only the Metadata tab visible and lets you select the location of the data. The result is variable and changes between jobs.
PAGE 304

Masks A file name that includes characters meant to be replaced at run-time is referred to as a mask. Masks can be used in many edit boxes and can be used, for instance, to select multiple files. File selection is typically limited by fixed characters or special wildcard characters. If you create a Folder Capture Input task and enter *.* in the Masks box, the Input task will grab all the files that are put in the source folder. If you enter *.
PAGE 305

l l Ranges: [1-5] , [a-d] define ranges between the characters. file[1-5].txt would pick up file1.txt and file4.txt but not file6.txt or file13.txt. Negative Ranges: Negative ranges such as [!2-4] are also possible. Note File names containing brackets can be a hassle when attempting to capture them with a mask and using sets or ranges. You can capture a set that contains an opening bracket ( [[] ) , but not a closing bracket as the closing bracket always ends the set or range.
PAGE 306

1. Click on the %o entry in the document list 2. Right-click to insert variables using the contextual menu, or type the variables. 3. Click OK on the dialog. Note At run-time, if PlanetPress Workflow cannot find the document name generated by those variables, the task will fail.
PAGE 307

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 308

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 309

l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress 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. 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 310

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 311

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 312

Note If Microsoft Outlook connection is used, Microsoft Outlook 2000 or higher must be installed on the computer where PlanetPress 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.
PAGE 313

message’s attachment are treated as separate data files and processed one after the other. l Unzip attached file: Select to unzip the attached files. l l Zip password: Enter the password required to unzip the attached files (if any). Note that you can use variables and data selections. Conditions group l “Subject” contains: Select to limit those messages used by this task to those with a specific subject. The subject you enter in the box below can include variables.
PAGE 314

Outlook (perhaps a child of the Deleted Items folder named Watch) and then using that folder as your backup folder. l Use POP3 mail group l l l l Select this option to use a POP3 mail server and to activate this group. Note that emails retrieved via POP3 are always deleted from the server. Incoming mail (POP3): Enter the address of the incoming POP3 mail server. This box is only enabled when the Use POP3 mail option is selected. Account name: Enter the email account name on the POP3 mail server.
PAGE 315

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

Note When used as an Input task, the File Count task does not apply the process polling interval. Once the condition is true, it triggers the process repeatedly, as if the polling interval were 0. To work around this, start the process with a Create File task followed by a File Count as Condition task. This issue only occurs in version 2020.1 and will be fixed in version 2020.2. Processing At run time, the number of files in the folder is compared to the specified value, using the specified operator.
PAGE 317

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

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 319

Processing Each file capture by the input is sent down through the process, one at a time. When the file is finished, the process goes back to the input which feeds another file down, as long as there are files in the queue. Once all the files are gone, the task polls the input folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. Output The output to this task is a series of individual files, one after the other.
PAGE 320

l l l l l l Sort order: If you selected a sorting method in the Sort files by box, select the order in which you want the files to be sorted. Use archive attribute: Select to turn on the archive attribute of the data files found in the source folder and to leave them in their original location (i.e. to take copies of the source files). Note that PlanetPress Workflow never takes source files that have their archive attribute turned on (so the source files will not be taken again and again).
PAGE 321

Job Information definitions l l %1 - Source File Name. Contains the file name (excluding path but including extension) of the file name that is captured. Equivalent to using the %o system variable. %2 - Folder: Contains the folder from which the data was captured. 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 322

invoice.pdf C:\Samples\ 2012/06/01 16:14:40 81452 test1.pdf C:\Samples\ 2013/01/17 09:13:50 20197 C:\Samples\manuals\ usermanual.pdf C:\Samples\manuals\ 1999/10/06 09:52:04 644037 Note The tag is independent of the OS locale, language or settings.
PAGE 323

"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 PlanetPress Workflow Tools working folders under the "Backup" folder.
PAGE 324

Processing Each file capture by the input is sent down through the process, one at a time. When the file is finished, the process goes back to the input which feeds another file down, as long as there are files in the queue. Once all the files are gone, the task polls the FTP folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. Output The output to this task is a series of individual files, one after the other.
PAGE 325

"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 PlanetPress Workflow Tools working folders under the "Backup" folder.
PAGE 326

HTTP Client Input HTTP Client Input tasks use the HTTP protocol to issue HTTP GET commands (queries) to HTTP servers. Replies received from the HTTP servers are used as jobfiles and are thus passed on to following tasks. Input This initial input task retrieves a single file as specified in the URL option. This file may be of any format, even formats that are not readable by PlanetPress Workflow. Processing No processing is done by this task. The file retrieved is not changed in any way.
PAGE 327

Indication (SNI). Disabling SNI through the server's site bindings configuration will allow proper SSL connection through the HTTP Input Client. l Server requires authentication: Check this option if the HTTP server requires user authentication. This enables the following options. l User name: A user name known to the Web server. l Password: The password associated with the user name entered above.
PAGE 328

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. HTTP Server Input HTTP Server Input tasks are used to receive HTTP requests made via GET or POST commands and to send replies to the servers from which the requests were made. The HTTP server supports both HTTP and HTTPS. For HTTPS Support information, see "HTTP Server Input plugin preferences 1" on page 772.
PAGE 329

Examples This task is put into effect in the following example processes: l HTTP PDF Invoice Request l HTTP Brochure Request l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Known issue In order to wake up a trigger-based process that starts with the HTTP Server Input task the server issues a signal to all trigger-based processes, not just those that start with an HTTP Server Input task. This means that some processes may get woken up when they do not need to.
PAGE 330

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

l Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the HTTP Server Input task loop through each attachment. Each data file is an XML with the accompanied file. 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.
PAGE 332

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. This is the value that is present at the end of the process, not the beginning. Note In order to make the Capture OnTheGo app delete the submitted form from the device's library upon successful transmission of the data, the Workflow process must return status code 291.
PAGE 333

l l %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 (zero based; when processing the request file, the Attachment Index is 0; with the first attachment it is 1, etc.). When the option Loop each attachment as a data file is not checked, the Attachment Index is 0.
PAGE 334

Processing No processing is done by this task. Output The output of this task is the same as the input - a data file and job infos that are sent from a task that generated an error. Task properties General Tab l The Input Error Bin task does not have any specific properties unique to it, since it only receives input directly from tasks in other processes when an error is generated. For more information, see the chapter on "Debugging and error handling" on page 96.
PAGE 335

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. Input SOAP The Input SOAP task is used to answer calls from a remote SOAP client and to return a response to that request. It is similar in functionality to the "HTTP Server Input" on page 328 task. Note SOAP communication is non-trivial and requires a certain understanding of XML and the SOAP protocol.
PAGE 336

Task properties General Tab l SOAP Action: The SOAP action is used with the SubmitJob action. It’s the equivalent of the process name. The difference is that more than one processes can share the same SOAP action. That way more than 1 CPU can be used to process all the incoming requests however this means that all process sharing the same SOAP action must be identical because there is no way to decide the execution order of all the process.
PAGE 337

LPD Input LPD (Line Printer Daemon) Input tasks retrieve data in the form of print files sent from remote computers using the LPD/LPR protocol. The PlanetPress Workflow LPD server starts automatically when a configuration that includes at least one active LPD Input task is started. To prevent conflicts between competing LPD servers, you must not run any other LPD server than the PlanetPress Workflow LPD server on PlanetPress Workflow workstation.
PAGE 338

l l l l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress 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 339

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 340

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 PlanetPress 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, PlanetPress Workflow removes data files from the source location.
PAGE 341

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

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 847) 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 343

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

l l l %4 - Subject: Contains the subject of the received email (may be blank). %5 - Recipients:Contains a list of the names of all the recipients of the email, separated by a semicolon (;). %6 - Attachment count: Contains the number of attachments of the email. A ZIP file is counted as 1 attachment. Some embedded images may be counted as attachment. The body of the email does not count as an attachment.
PAGE 345

combination of text, variables and data selections; see "Variable task properties" on page 301. Post-processing l Select what to do when an email is processed: mark as read or delete the captured email from the account's Inbox. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties.
PAGE 346

Microsoft 365 OneDrive Input Microsoft 365 OneDrive Input tasks allow the processing of files from any of the organization's Microsoft 365 OneDrive accounts. This task uses the Microsoft Graph API. For this task to function correctly, Workflow needs to be granted application permissions for Microsoft Graph in the organization’s Azure instance. It needs read access to the Users category (User.Read.All) so that the task can identify the users in the organization. In addition, the Files.ReadWrite.
PAGE 347

Job Information definitions l l l %1 - User. This is the OneDrive user's ID. %2 - Source File Name. Contains the file name (excluding path but including extension) of the file name that is captured. Equivalent to using the %o system variable. %3 - Folder: Contains the folder from which the data was captured. Task properties General Tab l l Folders: Enter the full path of a folder from which the input files are to be taken. The first / refers to the root folder.
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 OneDrive user's ID. This value is dynamic.
PAGE 349

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. NodeJS Server Input NodeJS Server Input tasks are used to receive HTTP requests and to send replies to the servers from which the requests were made. Essentially this task does the same as the HTTP Server Input task, but it uses a NodeJS Server (version 12.13.1, installed by Workflow) instead of Workflow's custom server component.
PAGE 350

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 351

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 352

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 353

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 354

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 355

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 696) 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 356

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 357

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 PlanetPress Workflow Button | Preferences | PrintShop Web Connect, allows to provide operator credentials to your PlanetPress Workflow configuration.
PAGE 358

l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress 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. 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 359

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 360

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 361

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 301. 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 362

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 363

preferences" on page 784). 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. Output The task outputs the job file as is, with no evaluation or modification.
PAGE 364

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

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 l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH).
PAGE 366

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. Connection mode group: This group is only relevant to the FTPS protocol and appears when it is selected. SFTP uses a single connection to download all files. l l l Masks: Enter a single file name mask. Multiple entries are not allowed in this box.
PAGE 367

"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 PlanetPress Workflow Tools working folders under the "Backup" folder.
PAGE 368

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. In order for this task to receive files, the SMTP Server (also called "Outgoing Email Server") in the email client must point to PlanetPress Workflow server's IP or hostname.
PAGE 369

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). The message body and attachments are available through specific XML attributes. These files do not have the full path, but you can use the %t%O variable to get the current temporary folder where they are located.
PAGE 370

l Conditions: Defines a filter on capturing files from the SMTP Service's hot folder. When a condition is added, only files that match this filter are captured, the rest remain untouched. “Subject” contains: Select to limit those messages used by this task to those with a specific subject. The subject you enter in the box below can include variables and wildcards. l l l l Nothing: Select to limit those messages used by this task to those that do not specify any subject.
PAGE 371

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Telnet Input The Telnet Input task (also known as the Raw Socket Printing Input) receives files sent to a specific port. If you want PlanetPress Workflow to receive data using multiple ports, you must use multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see "Telnet Input plugin preferences" on page 785).
PAGE 372

"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 PlanetPress Workflow Tools working folders under the "Backup" folder.
PAGE 373

print jobs. This queue can be shared, so as to be able to receive jobs sent from local as well as remote users. To ensure that the spooled files created by PlanetPress Workflow remain in the spool folder, the printer queue must be paused. Input The WinQueue input regularly polls the selected printer queue for new jobs. When a new job is available, it is captured automatically by this task. Processing The print job, by default, is in EMF format.
PAGE 374

l Spool Print Jobs in RAW Format: Select to output in RAW format, which is the exact data that the computer receives (and is not converted in any way). l Create PDF (With Metadata): Select to output a PDF. l l Optimize Resulting PDF: The resulting PDF is optimized for size and caching options are enabled. This reduces the size of the PDFs (depending on some factors), but may take more time to output the PDF. Include empty files: Check to process empty incoming jobs.
PAGE 375

l %4 - Document name: Contains the name of the job as seen in the printer queue from which it is captured. This name is defined by the software that creates the print job. 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. Action tasks Use action tasks in PlanetPress Workflow to perform a wide variety of operations.
PAGE 376

l "Open XSLT" on page 420 l "PDF/A-3 Attachments" on page 421 l "PDF to Bitmap" on page 425 l "Push to Repository" on page 426 l "Rename" on page 428 l "Run Script" on page 477 l "Search and Replace" on page 431 l "Send Images to Printer" on page 433 l "Send to Folder" on page 435 l "Set Job Infos and Variables" on page 436 l "SOAP Client plugin" on page 650 l "Standard Filter" on page 440 l "Translator" on page 441 l "Windows Print Converter" on page 442 Add Document The Add Doc
PAGE 377

Output The output is a PostScript job that can be sent to any output task in "passthrough" mode, for example Create PDF, PlanetPress Image, etc. Metadata is not generated by this task. Task properties General tab l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be merged with that document (see "PlanetPress Design documents" on page 42).
PAGE 378

Processing The selected operation (adding or removing lines, text or pages) is made on the data file. Output The modified data file is output from this task. Metadata is not modified in any way if it is present. 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.
PAGE 379

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

as an individual data stream (lines are separated by Line Feed characters). It minimizes memory requirements but may also limit hits, since lines are considered separately. Note that it is not possible to use search expressions that specify multiple data lines when this option is selected. l l l l String to search: Enter your search string or regular expression in this variable property box.
PAGE 381

l l l At column: Select to indicate that the search string must be in a specific column. Specify the column number (the value must be greater then 0) in the Column value box below. Between specific words: Select to indicate that the search string must be between specific words. Specify these words in the Word before and Word after boxes below. Occurrence related: Select to indicate that the search string must be found a specific number of times before a string replacement is performed.
PAGE 382

Barcode Scan The Barcode Scan task is used to convert barcode data from multiple image formats into textreadable information. This information is placed in the Metadata and can be used by the rest of the process.
PAGE 383

Barcode types Description EAN13 EAN13 symbology. Used with consumer products internationally, 13 characters. EAN8 EAN8 symbology. Short version of EAN-13, 8 characters. UPCA UPCA symbology. Used with consumer products in U.S., 12 characters. UPCE UPCE symbology. 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.
PAGE 384

Barcode types Description manufacturing. QRCode The QR Code (Quick Response Code) is a 2-dimensional matrix code. It can encode up to 2509 numeric or 1520 alphanumeric characters. PostNet PostNet symbology. Used by the United States Postal Service to assist in directing mail. RM4SCC RM4SCC symbology. Used by the Royal Mail. Note The fewer barcode types are selected, the faster the plugin performs. Selecting only the expected barcodes is therefore a good practice.
PAGE 385

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

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata implementation The Barcode Scan task reads each scanned file and outputs the values read from barcode(s) on the page(s) into Metadata depending of the selected Process by option: l l If the selected option is process by page, then the Metadata file is created and overwritten for each new scanned page.
PAGE 387

l l l l l Barcode_1_Orientation: Metadata field containing the orientation of the first barcode. Barcode_1_Top: Metadata field providing the distance (in pixels) from the top of the page to the top of the first barcode. Barcode_1_Bottom: Metadata field providing the distance (in pixels) from the top of the page to the bottom of the first barcode. 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.
PAGE 388

tasks do not perform any operation as such on the data, but rather they modify the way subsequent tasks process the data they receive. Change Emulation action tasks are typically used when a secondary input task brings new data that is not structured like the initial data into the process. By default, every task included in a process uses the emulation associated with the sample data file to structure the data before processing it.
PAGE 389

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. Add/remove lines: Enter the number of lines to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add lines; negative values remove lines.
PAGE 390

spaces in the tab box. This option is available only if you selected the Read in binary mode option. If you cleared Read in binary mode, the printer replaces any end of line characters (CR, LF, or CRLF) it encounters with a LF. 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. CSV (comma separated values).
PAGE 391

be necessary. l l l l No line feed: Enter the channel skip code that tells the document to ignore any line feed character (LF) that appears at the end of the line. This causes the next line to print over the current line, and is a technique impact printers use to print a line, or elements of a line, in bold or with underlining.
PAGE 392

value that is greater than the width of the data page, you can remove the second line by shifting the contents of the second line outside the data page. l Database. (Nothing to configure.) l XML. l l Cache XML data: When this option is selected, PlanetPress Watch/Server only reloads the data if the size or modified date of the XML file changes. When this option is not selected, the XML data will be reloaded into memory every time that a plugin works on the data file.
PAGE 393

PDFs created with the Create PDF action task will effectively replace the current data file in any given process using such a task. Input Any data file supported by PlanetPress Workflow, or a PostScript file. 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.
PAGE 394

l Options group l l l l Add job information to the document: Select to add the available Job Info variables in the “header” of the generated output file. 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 395

Adobe Acrobat and Adobe Reader are never embedded. If a font is not embedded in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font. l l 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 396

l General: l Compress text and line art l Auto-rotate pages l Optimize for fast web view l Author: PlanetPress l Keywords: PlanetPress; 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 co
PAGE 397

Database Query The Database Query action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format. Database Query action tasks are not considered input tasks as such, because they cannot be used to start a process. Although they cannot be used to get the process’s initial input, they can be used to gather secondary input (see "Input tasks" on page 307).
PAGE 398

Processing A connection to the selected database is made, the data is retrieved, and an output in the selected emulation format is generated. Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and Job Info variables are not modified in any way. 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.
PAGE 399

l l l CR-LF replacement: If you want CR-LF (Carriage Return-Line Feed) characters within the data file to be replaced by another character, use this box to indicate which character to use. You may select the replacement character from the list or type your own. Emulation options group: Options from this group change based on the selected output file emulation.
PAGE 400

l l l l l l l Configure Width: Click to set the width of each field in the generated file. The displayed Configure Width dialog box lists all the fields in the file that will be generated and indicates their widths. To change the indicated widths, simply click the values displayed in the Width column and enter new values. Click OK when you are done to close the dialog box. You will then no longer be able to use the Default width box.
PAGE 401

Advanced SQL Statement dialog box. The alternate syntax may be required for some database types. l l l Edit SQL: Click to create and test an advanced SQL query; see "Advanced SQL Statement Dialog" on page 831. Import Config: If you previously created and exported a PlanetPress Workflow Database Connection configuration, click this button to import it. This saves you the trouble of configuring the connection every time.
PAGE 402

l l Database connection string: Enter a variable connection string in this box. To do this you may begin by clicking to create an ODBC connection string to the data source and paste the string automatically to this box. Note that if a login name and password are required to connect to the database, a dialog box is displayed and the information you enter is saved in the configuration of the PlanetPress Workflow Database action task.
PAGE 403

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

Note The Digital Action task requires a PlanetPress Image license to be present on the same IP Subnet as PlanetPress Workflow, either on the same server or a different one with PlanetPress Image installed and activated. Differences between Digital Action and Image tasks l l Digital Action is an Action task and cannot be the last task in a branch or process. Image is an Output task, and has to be placed at the end of a process or branch. Digital Action can accept PDF/VT and PostScript (.
PAGE 405

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

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

Statement.2005.255842.pdf, or Job.tif instead of Job.544872.tif). Failing to add the quotation marks may result in files being overwritten. l l l Automatically Add Extension: Check if you want the correct extension for the image type to be appended to the filename automatically, rather than having to add it in the Filename box. The Output Type determines the extension to be used. Add PDF to PlanetPress Search database: Check to update the PlanetPress Search database with each new PDF generated.
PAGE 408

l l l l l l l l Compress text and line art: Select to compress the text and line work in the file using the Flate compression filter. Flate is a compression method that works well on elements with large areas of single colors or repeating patterns, as well as on blackand-white elements that contain repeating patterns. Auto-rotate pages: Select to automatically rotate pages based on the orientation of the text or DSC comments.
PAGE 409

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

method automatically. Note that configurations that were created with an earlier version of PlanetPress Workflow and that included tasks set not to use any compression will by default be set to use the Flate compression method. l l l 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.
PAGE 411

l Font 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. Note that if more than 35% of the characters included in a font are used in the document, the entire font is embedded. This option often produces smaller PDF files and ensures proper PDF display.
PAGE 412

actually used in the document. This option can only be used if the Embed all fonts option is selected. Note that if more than 35% of the characters included in a font are used in the document, the entire font is embedded. This option often produces smaller PDF files and ensures proper PDF display. 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.
PAGE 413

l l l l l l l Data source name: Enter the name of the computer on which the database runs. This option is available only when you select SQL Server database or Oracle database in the Database type box. Use default database: Select to use the default database associated with your user profile on that SQL Server or Oracle database. Clear to enter the name of the database in the box that appears.
PAGE 414

Input Any file that you wish to upload to the printer. Note that this task does not attempt to verify that the type of file being sent is compatible with the printer, or is in a supported file format. Processing The currently active data file is converted into PostScript. Output A PostScript file containing the necessary code to save the data file on the hard drive.
PAGE 415

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. External Program External Program action tasks are used to launch and execute other programs, which can be useful when you wish to process your job file in a way that is not possible with the standard PlanetPress Workflow tasks. Note As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources.
PAGE 416

Task properties General Tab l Program group l l l l l Parameters: Enter parameters that will be passed to the external program when it is launched. Each parameter should be enclosed in quotation marks and separated by a space ("Param1" "Param2" "Param3") except command line options (such as -f, /n). The exact parameters accepted are unique to the executable and defined in its documentation if it exists. Start in: Enter the folder in which the external program is to run.
PAGE 417

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

Task properties General Tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 419

Output The input data file is returned with no modifications. Metadata is not modified. A single job info or variable is modified by this task. Task properties General Tab l Mathematical Expression: Variable data field containing the expression to be evaluated. This expression may combine any combination of standard PlanetPress Workflow variables and VBScript mathematical expressions. For example, to multiply Job Info 9 by 2, the expression would be %9*2 .
PAGE 420

Open XSLT The Open XSLT action task takes an XML file as input and executes the XSLT code as parameter to rearrange the content of the XML file. XSLT (or XSL Transformation) is a style sheet that describes how an XML document is to be transformed into another XML document. The reason to transform an XML document into another XML document is simply to rearrange the information it contains in order to make the data structure more convenient for your needs. Input A valid XML file.
PAGE 421

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 XSLT Version l XSLT 1.0: Select if you will be entering or pasting XSLT version 1.0 code. l XSLT 2.0: Select if you will be entering or pasting XSLT version 2.0 code. Tools l l Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Editor Options...
PAGE 422

version that is suitable for long term storage, and alternate forms and/or the source document can be added as attachments. 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 PlanetPress Image" on page 739 and "About PlanetPress Fax" on page 738. Without a valid Imaging license, the plugin will fail with an error.
PAGE 423

l l l Job file: When this option is checked the attachments are added to the current job file. The job file should be PDF/A-3 compliant. External file: Adds the attachments to an external file. Use the Browse button to select a PDF/A-3 compliant file. Note that the task doesn't verify that the target file is PDF/A-3 compliant. If it is a PDF file that is non-PDF/A-3 compliant, the task will add the attachments to it, but it will not convert the file into a PDF/A-3 compliant file.
PAGE 424

l l Mime Type: Enter the mime type of the attachment, e.g. text/xml, image/gif. Relationship: Specifies what the attachment is in relation to the (entire) PDF document: l l l l l Alternative: An alternative representation of the PDF document; for instance, an XML version of the invoice in the PDF. Data: Data that is visually represented in the PDF; a CSV file with the detail lines of the invoice, for example. Source: The source that the PDF was created from.
PAGE 425

l Properties: l l The DocumentFileName, DocumentType and Version are read-only. ConformanceLevel: Each standard specifies a number of different levels a file can conform to. For information about these levels please refer to the specifications of the standard. 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. PDF to Bitmap The PDF to Bitmap plugin converts PDF pages to bitmaps.
PAGE 426

l l l Output format: The output format can be either PNG or JPG. Resolution: Specify the resolution of the bitmaps (pixels per inch). The minimum is 12, the maximum is 1200. For example, with the minimum of 12, a PDF page that is 8,5 inch wide is converted into a bitmap of 102 pixels wide, which could be used as a thumbnail on a web page. Page range: An asterisk (*) means: convert all pages.
PAGE 427

Processing A new KeySet is added to the Data Repository, or updated, using the data provided. Output The unmodified input file. This task does not change the data file in any way. The only modification is a single variable or Job Info variable, if the Store Result option is selected. Task properties General tab l l Group: Use the drop-down to select into which group the KeySet is inserted, or in which group the KeySet should be updated. Key set: Displays a list of keys for the selected group.
PAGE 428

l l Add KeySet when condition is false: If the update condition above is false, a new KeySet is added to the group. If unchecked, no data is changed in the repository. Store the result ID in variable: Select a variable or Job Info in which an array of inserted or updated IDs will be placed. The array of IDs in the form of [1, 2, 3, 4, 2443, 532, 5457, ...] Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 429

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" on page 415). However, they can be slower to execute. The Run Script task can be used either as an Action or a Condition.
PAGE 430

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 431

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 432

Input Any text-based file can be used in this task, even formats that are not directly compatible with PlanetPress. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task. Processing The appropriate changes are made to the data file (replacing text). Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General Tab l l l Find: Enter the string of data for which to search.
PAGE 433

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send Images to Printer The Send Images to Printer Action task is used to send images to a printer so they can be used as resources by PlanetPress Suite (Design) documents run on the printer. It is comparable to the Download to Printer Action task (see "Download to Printer" on page 413), but includes image specific options.
PAGE 434

Task properties General Tab l l l l l l l l Scan orientation: Select Side to side for images that will be printed in their original orientation on a portrait oriented page, or in a rotated orientation on a landscape page. Select Top to bottom for images that will be printed in a rotated orientation on a portrait oriented page, or in a rotated orientation on a portrait oriented page.
PAGE 435

l Print confirmation page: Select to print a confirmation page on each one of the selected printers after an image has been successfully received. 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. Send to Folder Send to Folder Action tasks send the files they receive to a local folder.
PAGE 436

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

Output The original data file, Metadata and other Job Info variables are not modified, they are passed on to the next task. Task properties General Tab l l Var/Info#: Lists all Job Info variables, local variables in the current process and global variables in the configuration. Click on the variable you want to change. Value: Enter the value that you want to associate with the selected Job Info variable or custom variable. l button: Adds a new line and lets you define the variable and value to set.
PAGE 438

In order to access and successfully use Web services, client applications must know how to get them, what operations they support, what parameters they expect, as well as what they return. SOAP servers make this information available via WSDL (Web Service Description Language) files.
PAGE 439

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 440

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

l Remove and convert HP escape characters: Select to filter HP escape character sequences from the job file. 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.
PAGE 442

Processing The characters in the data file are converted from the old encoding to the new one. 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.
PAGE 443

The full conversion process is performed in two phases: 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 444

belonging together. Additionally, you can control text passages whose horizontal distance has been recognized as out of the tolerance, but whose type size difference and vertical 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.
PAGE 445

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 446

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 447

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 448

In OL Connect jobs, data is normally extracted from a data file using the "Execute Data Mapping" on page 617 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 449

But when opened with PlanetPress Design or a PlanetPress 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 450

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 451

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 452

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 453

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 454

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 PlanetPress 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 455

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 456

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 457

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 458

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 459

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 460

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 461

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 462

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 463

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 464

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 853. 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 465

Task properties General Tab This tab lets you choose the splitter settings for the default PlanetPress 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 466

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 467

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 468

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 480 and "Go Sub" on page 475 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 469

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 136. Task properties Backup Tab l l l l Backup job file: Select if you want PlanetPress Workflow to use identical copies of the job file for the main and secondary branches.
PAGE 470

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 471

interval were 0. To work around this, start the process with a Create File task followed by a File Count as Condition task. This issue only occurs in version 2020.1 and will be fixed in version 2020.2. Processing At run time, the number of files in the folder is compared to the specified value, using the specified operator. 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.
PAGE 472

regular expressions, separating the regular expressions by a semicolon. 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. The percent sign, the curly brackets and the period are all key elements of the RegEx syntax, therefore they cannot be mixed and matched with Workflow variable data syntax (e.g. %1, ${global.myvar}, etc.). Also, there is no validation of the RegEx being specified.
PAGE 473

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. 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/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.
PAGE 474

Task properties General Tab l l File name mask: Enter one file name mask or multiple masks separated by a semicolon (;). See "Masks" on page 304. The condition will be tested True only in the case of an exact match, so consider using wildcard characters. Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 475

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess (see "About processes and subprocesses" on page 124). When a process encounters a GoSub action, it halts its own execution, start the subprocess and waits for it to complete before resuming its workflow with the next task.
PAGE 476

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. 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 78.
PAGE 477

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. 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 415). However, they can be slower to execute.
PAGE 478

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

l Tools l l Editor Options...: Opens the "Editor Options" on page 795. 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 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 480

Send to Process The Send to Process task transfers job file(s), job information and all related files (Metadata, sorted Metadata, etc.) to a selected process. This Action task is asynchronous, meaning the current process will continue running in parallel to the process chosen in this task and will not wait for it to finish. This task is dual-purpose: it can be used either as an Action task, or as an Output task.
PAGE 481

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

l l l l l l Get info: Click to retrieve information corresponding to the IP address you entered. If the information is successfully retrieved and it corresponds to a printer, the Host name and Description of the printer (or other device) appears in the corresponding boxes. Host name: When you click Get info, if PlanetPress Workflow is able to communicate with the device, it displays its name here.
PAGE 483

l l Value: Enter a specific object status. Vendors of SNMP compliant devices sometimes list possible object states in their documentation. Invert condition result: Select to toggle the result of the whole SNMP condition (true becomes false and vice versa). 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 484

PlanetPress Workflow will search the job file and retrieve the string found at the referenced location before performing the comparison. l l l l l l l l l Operator: Select the desired operator. Note that neither the “Is found” nor the “Is not found” operator can be used to test XML data. Convert data to uppercase before comparison: This option is only displayed when either “Is found” or “Is not found” is selected in the Operator box.
PAGE 485

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. Time of Day Condition Time of Day Condition tasks test the current time and day. Using a time and day grid, you can select blocks that correspond to time and day coordinates. Various settings can be used to change time intervals, for instance, that range from 15 minutes to 24 hours.
PAGE 486

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

Create MRDX The Create MRDX Action task is used to register a job on a SureTrac server using an MRDX file. The MRDX contains information about the job and its finishing, as well as integrity features use by SureTrac. This task requires a PDF file as an input, along with metadata generated through a document that contains PitneyBowes Scan Codes. Task properties General Tab l Register Job to the SureTrac Server group: Check this option to enable the group.
PAGE 488

Delete Capture OnTheGo Document The Delete Capture OnTheGo Document deletes a document from a Capture OnTheGo Repository, which stores documents that can then be retrieved by the Capture OnTheGo mobile application. It can be used, for example, to delete a document that has its expiration date set in the distant future but needs to be deleted as soon as an app user has submitted it. This task can be added as an Action task (see "Action tasks" on page 375) or as a Condition Task.
PAGE 489

l Invert result: When the task is used as a Condition task, the success of the delete operation determines whether the condition returns True or False. Check this option to invert the result. 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 490

Output The output to this task is a series of individual files, one after the other. Task properties General Tab Note For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab. l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files.
PAGE 491

l Download the document and delete it from SharePoint: Download the document and delete it from the SharePoint server. Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted. Domain: The active directory domain for the logon credentials. This is not necessary if the SharePoint server is not part of a domain.
PAGE 492

Job Information definitions l l %1 - Source file name: Contains the name of the current captured file. %2 - Directory: Contains the name of the SharePoint director from which the current file was captured. Laserfiche Repository Output The Laserfiche Repository Output task publishes files - and optionally sets index values into a Laserfiche server.
PAGE 493

Task Properties General Tab l Laserfiche configuration group l l Folder: Enter the Laserfiche client repository folder where the documents will be exported. The user can specify the remote folder by clicking the Browse… button. Note: If the Folder field is empty, the documents will be exported by default to the root folder Import Format group l l l l l l l Laserfiche Pages: Converts all images files (*.bmp, *.gif, *.jpeg, *.pcx, *.png, *.tif, *.tiff, *.
PAGE 494

Connection Tab l Server Name: The server name or IP address of the server you wish to connect to. l Repository: The name of the repository you wish to send the files to. l User name: A user name in Laserfiche that has access to the above repository. l Password: The password for the above user name. l Test Connection: Click to verify that the information entered in this tab is correct and the server accepts it.
PAGE 495

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

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

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

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

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

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

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

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

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

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

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. Task properties General Tab l l l SharePoint Site: The name of the SharePoint site where you want to send the files.
PAGE 506

l l Use PDF/A: Check to use the information contained within an PDF. This PDF must have been created with PlanetPress Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library. If this option is checked, the Field Information will change to "Use PlanetPress Index (PDF/A)". Field Type: The type of field as set in the SharePoint Document Library.
PAGE 507

l l User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries. Password: The correct password for the user name. 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. PlanetPress Fax PlanetPress Fax Output tasks are used to make request to PlanetPress Fax, which creates faxes and sends them to a faxing program.
PAGE 508

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

Note that those options are specific to each PlanetPress Image installation and that they are immediately applied. The following describes the properties specific to PlanetPress Image Output tasks. Note In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PlanetPress Workflow is running, so emails are not sent out automatically.
PAGE 510

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

l l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Output type: Select the output file type that you want. l l l l l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PlanetPress Image. Note that some features, such as the Time and Date functions, require that this option be selected. PDF: The output will be a PDF file.
PAGE 512

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

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 514

l l l l Subject: You may enter the subject of the document. Since this is a variable property box, you may use variables and data selections and let PlanetPress Workflow interpret this information at run-time. Note that if you use a data selection in this box, you must be sure that the data that will be selected at run-time will not contain any parentheses, as this would cause the task to fail.
PAGE 515

l l l Resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. Color images group l l l l Downsampling: Select the down sampling option. Down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels. The Grayscale resolution you enter in the following box is used to control the down sampling process. Select None to prevent grayscale down sampling.
PAGE 516

l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files.
PAGE 517

l Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty. Select Bookmarks and page to display the contents of the Bookmarks tab (you use data selection objects to create bookmarks in PlanetPress) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages.
PAGE 518

PlanetPressSearch with an SQL Server Database” section of the PlanetPress Search User Guide). l l l Password: Enter the password required to access the database. Test Connection: Click to verify that PlanetPressImage can connect to the specified database. Enforce global table creation: Select this option, as it ensures that all database users are granted access to the database. This option is available only when you select SQL database in the Database type box.
PAGE 519

These resources include the data file to run against the job, plus any graphic or font resources the jobs needs, along with any required PReS Classic specific resources, such as TRF or PDI files. Processing The selected data file is merged with the selected PReS Classic job to create a print output stream. If the PReS Classic job selected is an uncompiled PReS Classic script (PDS), it will first be compiled on the fly and then run using the selected data file.
PAGE 520

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

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

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 523

Output The output produced by this task is dependent on the options selected: it can be PDF, a Windows EMF print job, a PostScript print job or a JPG file. PrintShop Mail 7 can also output PDF/VT and PPML/VDX. Note that the Preflight output type doesn't actually produce printable or viewable output. The Preflight option does a cursory verification of the job and will generate an XML file that contains a list of all warnings and errors.
PAGE 524

l l l l l l l PostScript Driver: Select which driver to use to generate the job. This should be the same as the printer selected in your PrintShop Mail document when designing it. This option only appears in the PDF and Produce PostScript output types. Windows Printer: Select the print driver of the printer to which you want the print job to be sent. This option is only available when Direct to Printer/Windows PostScript driver is selected in the Output type box.
PAGE 525

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

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

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

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

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

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

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

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

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 PlanetPress Workflow that enable output and input for interaction with an Anoto Digital Pen.
PAGE 534

page 541 or "Find Capture Documents" on page 547 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 535

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 536

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 537

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 538

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 539

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 540

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 541

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 542

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 543

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 544

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 545

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 546

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 547

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 548

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 549

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

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 551

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 552

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 553

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 554

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 555

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 73.
PAGE 556

l "Example: Daily sales report from PDF files" on page 286 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 58).
PAGE 557

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 558

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 559

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 560

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 561

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

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 563

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

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. This task is only functional if Metadata already exists for the current job.
PAGE 565

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 566

Group or Document. If the delimiter option is set to None, the action is not performed. l 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. See the "Rule Interface" on page 853 page for more details.
PAGE 567

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 568

Processing The order of the Metadata is changed in accordance with the rules set forth in the task's properties. Output The original data file is output, along with the modified Metadata. General Tab l Group: Sorts the Metadata by group. l Document: Sorts the Metadata by document. l Data page: Sorts the Metadata by data page. For each parameter, three columns are available: Sort By, Then by, Then by (again). This lets you sort your document level in three different orders sequentially.
PAGE 569

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 PlanetPress Search when building, refreshing or rebuilding its database. For more information about Metadata see "Metadata" on page 73. Input This task can use any data file, as long as it is accompanied by metadata.
PAGE 570

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 PlanetPress 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 571

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 572

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 573

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 574

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 575

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 576

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 577

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 578

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 579

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 580

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 581

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 582

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 583

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 584

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 585

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 586

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

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 617, "Create Print Content" on page 607, "Create Job" on page 597, and "Create Output" on page 600. Combining them in a single task makes creating Print content easier and faster, as the task is optimized for this specific purpose.
PAGE 588

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

l Filter type: Determines at which level to retrieve the records: l l l l l l l l l l Add a condition: Click to add a new condition line. This adds the line to the current condition level, by default with an AND operator. Switch conditions: Click to swap two conditions on the same level, or two groups of conditions. Delete the selected condition: Click to delete the currently selected conditions in the list. Clear the rule: Click to delete all rules in the list. Note: This cannot be undone.
PAGE 590

Note Once the All In One plugin has been executed with this option selected, any task that attempts to access records in the database will fail. Content Creation Tab The Content Creation step generates Content Items either by merging a Record Set with a Template, or by processing a PDF/VT file into individual content items. l Template: Select the appropriate template or option to execute it: l l l l "None": Select to skip Content Creation completely. "%o": Select to use a dynamic template name.
PAGE 591

l 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 38). 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 52).
PAGE 592

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. Note that when the output is separated, the current job file is not replaced with the actual output files but with a CSV file that lists the paths to the outputted files (e.g. “C:\Users\Administrat
PAGE 593

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Sort Parameters The Sort Parameters define how to sort the entities retrieved from the Connect Database using either the "Retrieve Items" on page 631 task, or the Filter source in the "All In One" on page 586's Data Mapper task. l Sort items based on: Lists the different sorts to apply to the entities. l l l Name: Click and enter the name for the Value or the Property to sort on.
PAGE 594

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

Note If sending email is not included in the license, the emails will be sent to the sender instead of to the intended recipients. Properties General Tab l Template l l 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. 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.
PAGE 596

Warning The JSON format is not validated by the plugin; it is passed as is to the server. Email Info tab l l l l l l Sender Address: Enter the email address that appears in the "From" field of the email. Alternatively you may enter the sender's name and email address in the following format: John Smith . It depends on the email client which information gets displayed: the sender's name or email address, or both.
PAGE 597

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

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). Processing The task prepares the content items or content sets for printing, tagging them as printable. Only the content items that are part of the job will generate output. Output The task outputs a Print Job ready to be sent to the "Create Output" on page 600 task for printing.
PAGE 599

in the Job Creation Preset will be used to try and parse the input parameter value. In order to make this work: o 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.) o Numeric string values need to be parseable as a number (either a whole integer or decimal value).
PAGE 600

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Output The Create Output task generates Print output in a format specified by a Connect Print Preset and sends this output to the appropriate target location. See also: "About printing" on page 108. This task can be added as an Action task (see "Action tasks" on page 375) or as an Output task (see "Output tasks" on page 639).
PAGE 601

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

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 603

General Tab l l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. Recipient Node: Use the drop-down to select which level of the metadata is used as the "Recipient" node. The Recipient node defines each Record in the output when used with the "Create Print Content" on page 607 task. Add job information to document: Check to add the 9 Job Info variables to the PDF/VT metadata at the root level.
PAGE 604

Properties Datamapper tab The Create Preview PDF plugin gets one record from the source selected on the Datamapper tab. This record is then merged with the template (selected on the Content Creation tab) to create a preview PDF. The Datamapper tab can have one of the following source options: l Data mapping configuration sets the data source to a data mapping configuration. l l l %o: Select this to use a dynamic data mapping configuration name.
PAGE 605

Instead it uses the default values set up in the Preprocessor of the data mapping configuration. To work around this issue you could either convert the posted data file into JSON, add the variables and use the JSON string option in the Create Preview PDF plugin, or you could add the variables to the data file and let the data mapping configuration extract them. Another alternative would be to use the "All In One" on page 586 task.
PAGE 606

Note The Metadata option requires that entries in the metadata have matching field names in the data model of the template. When they have, the values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data).
PAGE 607

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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 602), allowing the task to be used without a Connect Template.
PAGE 608

Note When JSON data is used as input, the "Create Job" on page 597 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 617 task does. Job Creation Presets need such a record set to group, sort and filter items. Processing In the case of a record set or a JSON object/array and template, this task loops through each record (or object) in the set (or array).
PAGE 609

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 610

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

Record ID A valid Record ID can be retrieved from various data sources. By default, when the Record ID input option is selected, the metadata is used as input. The "Execute Data Mapping" on page 617 task and the "Retrieve Items" on page 631 task output metadata containing information regarding records. JSON The Create Web Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records.
PAGE 612

Output The task outputs HTML code as a job file. Within this HTML code, references to external resources point to the local OL Connect Server and are served to the requester directly when the HTML file is opened in a browser. Properties General Tab l Template File: l l 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. Template Names: Select the appropriate template.
PAGE 613

Adding Variable Data.) Warning The JSON format is not validated by the plugin; it is passed as is to the server. Note Only the first record or JSON object is processed, since this task can only generate HTML output for a single record. 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.
PAGE 614

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

selection methods: GetMeta(_vger_prop_folder[0], 10, Job.Group[0].Document[0]) GetMeta(_vger_prop_eml[0], 10, Job.Group[0].Document[0]). The "Mailjet" on page 689 and "SendGrid" on page 693 plugins offer the possibility to add extra attachments to a rendered email message via Workflow. Note that any such attachments will not be part of the EML file produced by the Render Email Content task. Note With PlanetPress Workflow version 2020.1, using the Download EML Messages task requires the version 2020.
PAGE 616

Processing The plugin communicates with the Connect Server to retrieve the EML file that was stored in the Connect File Store by the "Render Email Content" on page 627. Output The task outputs the EML file as the Job File. The Metadata are unchanged. Properties General Tab l Data Source (see "Input" on the previous page): l l Metadata: Metadata containing information about an email message.
PAGE 617

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Execute Data Mapping The Execute Data Mapping action task generates a record set by executing a data mapping configuration on a data source. It can also automatically create a record set from a PDF/VT file without using a data mapping configuration. Input Optional. Both main options can refer to external files, but either one can be the active data file using %F.
PAGE 618

Properties General Tab l Data Mapping Configuration: Executes data mapping on the appropriate source. Select the appropriate data mapping configuration in the list: 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.
PAGE 619

validationresult entry on the Group[0] level of the Metadata. (For the structure of the JSON object, see the REST API Cookbook: JSON Data Mapping Validation Result.) The JSON's result and recordcount fields are also stored at the Group[0] level. Each Document node contains the following fields: 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.
PAGE 620

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

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

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 623

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 624

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 625

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 626

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

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

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

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 630

"eml":"c5f97db0-45ca-4f1d-be4d-473d000c92bd.eml", "body":"07decd87-d03c-4969-bc2a-7527cc594878.html", "text":"7a4e5217-0103-487f-a4f8-77d37d0c1087.txt"} ], "contentSet":8769} Properties General Tab l l l Template: Click the Browse button to select a template from the resources (see "Connect resources" on page 38), or enter a dynamic template name. Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 52).
PAGE 631

Email output settings in the Email context and sections) and EML file (see below). l l l Metadata: Write the information to the current Metadata. JSON Data in Job Data File: Return the information in a JSON structure that replaces the current Job File. This allows you to manipulate the output in a "Run Script" on page 477 task before sending it to an Email Service Provider (ESP).
PAGE 632

Input The task requires no input file, but any input information such as Metadata, Job Info variables, a data file or a JSON array can be used to specify which items to retrieve. Processing The task requests the items on the OL Connect Server using the conditions set in the task properties. Only the condition information and the returned Metadata or JSON are exchanged. Note that the order in which the requested items are returned cannot be guaranteed.
PAGE 633

l l l l l l Job: Retrieves one or more Jobs, including all their content items ready to be printed. Output similar to the "Create Job" on page 597 task. Job Set: Retrieves one or more Job Sets, including all their content items ready to be printed. Output similar to the "Create Job" on page 597 task. Condition: Select entities based on one or more conditions, the value of a metadata field for example.
PAGE 634

l Output Type group: l l l Metadata - IDs only: Select to only output minimal metadata containing the entity IDs. Metadata: Select to output IDs as well as record details in the metadata, useful for further sorting and filtering of the metadata. JSON: Select to output a JSON Record Data List (see "Output" on page 632). Commingling/Batching Tab Commingling is a method by which Print Content Items are merged together to create mail pieces going to each recipient.
PAGE 635

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

l Validate Names: Click to check the each of line in the list against the currently active Metadata (see "Metadata" on page 73). Metadata must be loaded in "The Data Selector" on page 835 or through the use of the Debugging feature. Set Properties The Set Properties Action task defines properties for entities saved in the OL Connect Database (Records, Content, and Jobs). These properties are applied to the entities and can then be used to retrieve them using the "Retrieve Items" on page 631 task.
PAGE 637

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. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks.
PAGE 638

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. In order to update values in the Connect database, the task requires that the current Metadata contains record IDs, or that the given JSON contains a JSON Record Data List (see: "Types of JSON in Workflow" on page 90). Processing The records, of which the IDs are found in the source data, are updated either from the Metadata or from JSON.
PAGE 639

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 640

Send to Folder tasks, which are considered as Action and Output tasks, are documented in the current chapter.
PAGE 641

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

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 643

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 644

Output This task doesn't have any output other than the email that is sent to the recipient(s). Task properties General Tab Nearly all of 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 301. Message information Note When specifying multiple recipients for the To, CC and BCC fields, separate the e-mail addresses with semi-colons (;).
PAGE 645

HTML emails (see HTML Email challenges in the PlanetPress 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. PlanetPress Connect has a tool to design HTML email templates: the Designer. To generate email output from a template you would use the "Create Email Content" on page 593 task.
PAGE 646

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. Microsoft 365 OneDrive Output Microsoft 365 OneDrive Output tasks allows to send files to any of the organization's Microsoft 365 OneDrive accounts. This task uses the Microsoft Graph API.
PAGE 647

Task properties General Tab General l l Folder: Enter the path of the folder to which the files are to be saved. You can use any combination of text, variables and data selections; see "Variable task properties" on page 301. File name: Enter the name of the output file generated by this task. To prevent new files from overwriting existing ones, consider using variable names. You can use any combination of text, variables and data selections; see "Variable task properties" on page 301.
PAGE 648

SFTP Output The SFTP Output task sends job files to other computers using a secured FTP protocol. It is similar to the Send to Folder output task but sends to an FTP connection instead of a local drive. The "SFTP Input" on page 364 and SFTP Output tasks are part of a separate installer and are not included in the Workflow installer. The SFTP plugin installer can be downloaded from the Resource Center, under 'Plugins' in PlanetPress Connect. Input Any data file.
PAGE 649

is available and not being monitored by another application or another Workflow task. l File Options group l l Directory: Enter the directory to which the job files are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server. File name: Enter the name under which the output job file will be saved. Consider using a dynamic name, since if you use a static name every new file will overwrite the previous one.
PAGE 650

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. A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol.
PAGE 651

Note The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below. Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found.
PAGE 652

overrides any return value set to %c in the Arguments box. You should use this option when the SOAP Client plugin is not able to fully support the syntax of the response. Advanced Tab l Domain: Enter the domain for the authentication on the SOAP server. The Domain is optional even when authentication is used. l Username: Enter the user name for the authentication, if required. l Password: Enter the password for the above user name.
PAGE 653

printed natively. Processing Either the data file is merged with the document if one is selected, or the PDF File is printed natively through the PlanetPress Printer driver (which prints the same as if one were to open the PDF in a PDF reader and print it). Task properties General Tab l l l l Printer queue: Select the queues to which you want to send the output. Note that this is a variable property box, so you can use various schemes to use printer queue names that change with each job at run-time.
PAGE 654

l Add job information to the document: Select to prompt your PlanetPress Workflow to add the available job information elements in the header of the file that will be sent to the selected printer queues. Metadata If no metadata file is found, the from / to page settings from the job and the printer's properties from the task configuration are used, with the job's settings overriding those of the printer where applicable.
PAGE 655

For more information about printing see "About printing" on page 108. Input Any data file. Processing and output If the data file is in a valid emulation (see "About data emulation" on page 58) and a PlanetPress Design document is selected, the data file and document are merged to produce a PostScript output. The output may be an Optimized PostScript Stream or a Printer Centric stream (data file + trigger). If no document was selected, the job file is sent as-is to the selected Printer Queue.
PAGE 656

Note It is not possible to select a Connect template with this task. It is however possible to send Print output produced by an OL Connect task to a Workflow Printer Queue (see "PlanetPress Workflow printer queues" on page 110). In the All in One task or the Create Output task, on the Output Creation tab, select the Output Management Through Workflow option. The Print output file returned to the Workflow process will become the new job file.
PAGE 657

l l Page delimiter group: These options are enabled when you choose Split job or Queue balancing load balancing options. They are used to determine how each job is to be split before being sent to the Workflow printer queues. l Form feed: Cuts the job file at every form feed character. l Lines per page: Cuts the job file after the specified number of lines. l l l l Round robin: Round robin means that complete jobs will be sent in turn to each one of the selected Workflow printer queues.
PAGE 658

Input Any data file. Processing While an email is always sent by this task (or at least attempted to be sent), the contents of the email and presence of attachments depends on the selected options. Once the contents of the email and attachments are determined, the email (including any attachments) is sent directly to the selected mail server. Output This task doesn't have any output other than the email that is sent to the recipient(s).
PAGE 659

l Message: Enter the content of the email message. This may be text or HTML based. Note that since this is a variable property field, its content is parsed at run-time. If HTML 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 PlanetPress Connect Online Help).
PAGE 660

Login 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 301. l l l l Enter the sender's name, organization (optional), and email address, and the reply address (optional). This information will be visible to the recipient of the email.
PAGE 661

l Capture Post Processing Workflow Note that Capture is only available to PlanetPress Suite users. Input Any data file. Processing While an email is always sent by this task (or at least attempted to be sent), the contents of the file and presence of attachments depends on the selected option. Refer to the property descriptions below to know what each option does.
PAGE 662

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

Login Tab l l l l l l l l l l l Use Microsoft Outlook: Select to use Microsoft Outlook to send emails (and attachments). The host computer must be running Outlook, and PlanetPress must have access to Outlook. Emails generated by PlanetPress Workflow appear in the outbox before being sent by Outlook whenever it is set to send emails. Use SMTP mail: Select to use Simple Mail Transfer Protocol (SMTP) to send the emails (and attachments).
PAGE 664

Send to Folder Send to Folder Output tasks send the files they receive to a local folder. They perform the same function as Send to Folder Action tasks, with the only difference being that in this case, PlanetPress Workflow will not wait for the task to be completed before going on to the next task in the configuration. Input Any data file. Processing and output The file is saved in the location specified, as the file name specified.
PAGE 665

Document Management tasks A Document Management task is a connector to a Document Services, ECM or Document Management system outside of PlanetPress Workflow itself. A few Document Management tasks are included with the installation of Workflow: l "Input from SharePoint" on page 683 l "Output to SharePoint" on page 686 The following plugins are not initially installed with Workflow but they are available for download on the Resource Center (help.objectiflune.com).
PAGE 666

Once installed, the DocuWare plugins will appear in the Document Management category in the Plug-In Bar. 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.
PAGE 667

If any issue is detected during a file Download, the log messages and the related file and its index values will be stored. The Docuware Download plugin is designed to work offline as well as online. Once a Test Connection has been established, the Cabinet and Index data will be downloaded and stored locally. This allows authoring of Workflow configurations without requiring a constant live connection.
PAGE 668

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 669

directed to. l File Cabinet: If the Test Connection was run successfully, the plugin will have a list of available File Cabinets, extracted from the DocuWare server. Select a File Cabinet from the drop-down list . Alternatively, you can enter the File Cabinet entry directly. You may also use variables, data and lookup functions. Right-clicking within the field opens the contextual menu. See "Data selections" on page 52 to assist with this.
PAGE 670

just those containing the search string. l Value. Add the value to apply. You can use static text and/or Workflow variables, data and lookup functions. Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 52). 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.
PAGE 671

Response in Variable (the success/failure response). Then select the Workflow variable to be used for the result. The DocuWare plugin searches for the variable by name and sets the selected response into the variable. So using dwresponse as the variable name would mean that DocuWare Download searches for the local variable of that name. Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved.
PAGE 672

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. If any issue is detected during a file upload, the log messages and the related file and its index values will be stored. The Docuware Upload plugin is designed to work offline as well as online.
PAGE 673

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

Upload tab The Upload tab provides the controls for defining the file to be uploaded, included related index values. The plugin window is expandable, which helps to display all the information at once when field names are quite long. File to upload This frame holds all the elements on the file which is to be uploaded to DocuWare. The plugin can upload either the incoming Job file, or a file from the file system (External file). Select either: 1.
PAGE 675

l File Cabinet: You can select a File Cabinet from the drop-down list if the Test Connection was run successfully. The plugin will have a list of available File Cabinets, extracted from the DocuWare server. Alternatively, you can enter the File Cabinet entry directly. You may also use variables, data and lookup functions. Right-clicking within the field opens the contextual menu. See "Data selections" on page 52, to assist with this.
PAGE 676

Note The pick 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 use static text and/or Workflow variables, data and lookup functions. Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 52).
PAGE 677

Note The Document name field entry will appear in italics in the table. All index values must be entered in a unified format. This means as follows: l l l l Strings: String values will be uploaded to Docuware "as-is", without modifications. Strings are Unicode-aware, so that non-ASCII characters can be entered as well, like Chinese, Japanese, etc.. Numeric values: Numeric values must be entered using only digits 0-9, a preceding - or + sign and the dot as decimal separator.
PAGE 678

the local variable of that name. If %{dwresponse} is used, Workflow will expand the variable and the contents would be used as target variable. Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved. M-Files M-Files is an Enterprise Content Management (ECM) system that is widely used in industry. It provides a metadata driven mechanism for storing, versioning and sharing files across an organization. See https://www.m-files.
PAGE 679

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). After downloading the .PPK file, you have to import it into Workflow;see see Importing a plugin.
PAGE 680

Task properties General Tab All of the properties on this tab are dynamic. This means that you can use any combination of text, variables and data selections of which the value will be determined whenever the process runs (see Variable task properties). l Connection: The plugin needs your M-Files Server's credentials and a Document Vault GUID in order to start communicating with the M-Files Server. l l l l l l VaultGUID: Specify the unique identifier (GUID) for the desired Vault. This is required.
PAGE 681

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. M-Files Upload The M-Files Upload plugin uploads a single file to an M-Files system (see "M-Files" on page 678). This Action plugin is not initially installed with Workflow. It is available for download on the (help.objectiflune.com). After downloading the .PPK file, you have to import it into Workflow; see Importing a plugin.
PAGE 682

Task properties General Tab All of the properties on this tab are dynamic. This means that you can use any combination of text, variables and data selections. The value of variables and data selections will be determined whenever the process runs (see Variable task properties). l Connection: The plugin needs your M-Files Server's credentials and a Document Vault GUID in order to start communicating with the M-Files Server.
PAGE 683

l l Value to be searched: Enter the value of the given property. Note that this should uniquely identify the document. When multiple documents are found, this will result in an error. Properties: Specify up to 5 properties that must be set in M-Files as metadata for the uploaded file. Any existing properties will be replaced with the given value. l l Property Definition ID: Enter the ID of the property. Property IDs can be found in the Metadata Structure of the Vault on the M-Files server.
PAGE 684

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

l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously. Folder: The folder in the document library where your files are located.
PAGE 686

"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 PlanetPress Workflow Tools working folders under the "Backup" folder.
PAGE 687

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. Task properties General Tab l l l SharePoint Site: The name of the SharePoint site where you want to send the files.
PAGE 688

l l Use PDF/A: Check to use the information contained within an PDF. This PDF must have been created with PlanetPress Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library. If this option is checked, the Field Information will change to "Use PlanetPress Index (PDF/A)". Field Type: The type of field as set in the SharePoint Document Library.
PAGE 689

l l User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries. Password: The correct password for the user name. 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. Email Services Email Services tasks send emails to an Email Service Provider (ESP) using the ESP's Web API.
PAGE 690

Resource Center (help.objectiflune.com). Make sure that the version number of Workflow and the plugin are the same, to avoid compatibility issues. l To be able to send email using the Mailjet plugin, you need a Mailjet account, API key and Secret API key. The Mailjet plugin allows you to: l l Specify the emails' campaign name. Each e-mail going through Mailjet is attached to a campaign, which enables you to track a campaign's performance and analyze the results.
PAGE 691

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. The plugin configuration dialog will open and show the index property page. If that works, the plugin is installed correctly and ready for use.
PAGE 692

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 693

Custom header names normally start with "x-": {"x-my-header":"myvalue"}. l 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. 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 694

l Add custom headers specifying specific handling instructions for your email. (To get an idea of what these could be used for, see SendGrid's blog post about email headers). Input Extra attachments To specify an extra attachment, you have to use the key/value pair "disposition":"attachment". To let the plugin know where it can find the attachment, you can either provide a full path ("url"), for example: [{"url":"file:///C:/Terms-and-Conditions.pdf","disposition":"attachment"}] or [{"url":"http://www.
PAGE 695

Output This task does not make any changes to the Metadata or the Job File. Properties General Tab l SendGrid API: l l l l l l API Key: Enter your API key, retrieved from SendGrid. It will be used for authentication with the SendGrid v3 Web API. A valid key is required to send email messages. Data Source (see "Input" on the previous page): Categories (optional): Enter a single category name (e.g. invoice) or an array of category names (e.g. ["invoice","brand1"]) for the messages.
PAGE 696

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. Unknown tasks An Unknown task is a task location that is not linked to any existing known task.
PAGE 697

There are four types of variables that can be used in PlanetPress Workflow: l l l l Global variables are available to all processes and tasks within the configuration, and any modification made to them affects all tasks and configurations. For more information see "Global variables" on page 705. Local variables are specific to an instance of a process.
PAGE 698

Note l l While the initial Job Infos are created by the input task, they can be overwritten by the Set Job Info and Variables Action task, by a Script, or by any secondary input task in the process. Whenever you use a job info in your process, make sure it contains the value that you want, and not one that has been overwritten by another task. Job infos are limited in quantity and are slowly being deprecated when transferring data to your documents.
PAGE 699

ExpandString() function. For more information, please see the PlanetPress Design User Guide. System variables System variables are standard variables, created and managed directly by PlanetPress Workflow. These variables are read-only and cannot be modified. They provide information about the job, process, and PlanetPress Workflow environment. Available system variables Variable Name Example value when interpreted %a Job file last modified date.
PAGE 700

Variable Name Example value when interpreted name without extension %y Current year 2010 %m Current month (numeric) 06 %M Current month (text) June %L Current month (short text) JUN %d Current day (numeric) 16 %D Current day (text) Monday %l Current day (short text) MON %h Current hour 18 %n Current minute 03 %r Run mode (0: runtime, 1:debug) 0 %s Current second 41 Page 700
PAGE 701

Variable Name Example value when interpreted %v Current millisecond 24 %u Unique 13char 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: xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx (8-4-4-4-12 characters). 123e4567-e89b-12d3-a456-426655440000 %t Current temporary folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool
PAGE 702

Variable Name Example value when interpreted %E Current Metadata path and file name C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool\5.tmp\job00ZAIZ2C4FXON16CE6C566.dat.met a %w Current process name My Process %i Current Loop iteration index (always the innermost loop) 2 The %i Loop Count variable The value of the %i variable is equivalent to the current iteration of loops inside of a process.
PAGE 703

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 704

Variable Name %{error.errorlog} A string containing the logged error message(s) from a task. Multiple error messages are delimited by a "|" (vertical bar) character. Local variables Local variables are set at the level of a process and are not shared with any other process or instance of that process. Local variables can be used anywhere where a variable is accepted by using its name, surrounded by curly brackets and preceded by a percent sign, for example: % {myLocalVariable}.
PAGE 705

refers to a variable and it is renamed, and the case of deleting a variable, any task or script that refers to it will cease to function and will generate an error. Renaming a variable l Right-click on the variable name in the Configuration Components pane. l Click Rename. l Type in the new name of the variable, then press Enter on your keyboard.
PAGE 706

To refer to a global variable, for example in a variable task property (see: "About Tasks" on page 298), use its name preceded by "global." and surrounded by curly brackets, for example: % {global.myGlobalVariable}. Global variables are generally used to keep information that applies to multiple locations but needs to be changed easily. For example, a lot of users use them to set a server's IP, a printer name, or folder location that is used by multiple processes.
PAGE 707

Note Deleting a variable does not delete any reference to it. In both the case where a script refers to a variable and it is renamed, and the case of deleting a variable, any task or script that refers to it will cease to function and will generate an error. Renaming a variable l Right-click on the variable name in the Configuration Components pane. l Click Rename. l Type in the new name of the variable, then press Enter on your keyboard.
PAGE 708

whenever your process runs, that is to say it will not remain static. This can be extremely useful when, for example, you want to determine how many copies you will print out depending on your data, or what document will be used in the printout depending on the department it came from. Variable properties may include: l Static data. l System variables. See "System variables" on page 699. l Local and Global Variables. See "Local variables" on page 704. l Job Infos.
PAGE 709

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

l l Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example. The lookup() function indicates a lookup in the "Data Repository Manager" on page 832. Workflow add-ons Here's a list of add-ons that can be used with Workflow: l l Capture (only compatible with PlanetPress Suite): a set of tools that enable output and input for interaction with an Anoto Digital Pen. See "PlanetPress Capture" below.
PAGE 711

For more information on building and using PlanetPress Capture processes, please see "PlanetPress Capture Workflow" on page 287. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011.
PAGE 712

Capture-Ready Document A PlanetPress Connect document (*.pp7) that contains at least one Capture Field on at least one page. Capture Document Manager A tool that lets a user search through the available documents in the Capture Database. The documents can be search through a few different criteria and can be displayed as PDF files, individually or as a group. Documents can also be closed or deleted from this interface.
PAGE 713

ICR (Intelligent Character Recognition) Recognizing text that has been hand-written with the Anoto Digital Pen. This feature is currently not implemented in PlanetPress Capture, but will be in the (near) future. Ink Data The pen stroke information contained within the PGC file. This is the actual data applied to the document (lines, signatures, text, etc).
PAGE 714

Pidget Type of PlanetPress Capture object. Page element used to give instructions to the Anoto pen, as opposed to recording ink. PlanetPress Capture Database A database containing the list of patterns, sequences, registered pens and documents. The Capture Database can be used by a single server, or by multiple servers in a Client/Server architecture. Session The time spent by the pen between events that trigger a new session.
PAGE 715

bit and cannot access the 64-bit data sources. In order to create an ODBC connection visible by PlanetPress, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\odbcad32.exe . The following considerations should be kept in mind while working with ODBC Databases in PlanetPress Suite. l All databases l l l l l l Minimum 100MB of database size is required as a minimum, but the space requirement depends on the implementation.
PAGE 716

l MSSQL (Microsoft SQL Server) l l l l All versions of the SQL Server are supported, including all Express versions. Database can be in any location, but performance will depend on the speed of the connection between PlanetPress Production and the SQL server. In the event where 2 requests are made simultaneously on the same record, SQL Server will drop the most complex request. Resubmitting the PGC for processing should resolve this issue. This, however, should happen only rarely.
PAGE 717

signed document has, by definition, a longer life span than the temporary storage location of the digital pen. Consequently, it is still the most vulnerable piece of the workflow and as such, it should be the first objective of any security effort. In other words, as long as the physical piece of paper bearing markings is accessible to malicious users, no amount of security protocols can protect the signed contents.
PAGE 718

l The same rules apply to PDF files as with PGC files, especially when they contain a signature from the pen. If you are already securing digital scanned copies of signed documents, the PDFs should be secured in similar ways. However, remember that as with most security concerns, in order to be a “threat”, someone would have to have a high level or working knowledge of either the Anoto SDK (which is not easily obtainable) or PlanetPress Workflow and PlanetPress Capture.
PAGE 719

and cannot be re-used. Then, when someone writes on the document and sends the pen data to PlanetPress Workflow (through a docking station or through Bluetooth), if the required conditions have been met, the document will be "closed", its pattern released and available to be used immediately. An open document can also be called a "live" document, in the sense that it is only active between the time where it is printed and the time where ink from the Anoto Digital Pen is processed and the document is closed.
PAGE 720

Extending There are actually 2 ways of dealing with extending the number of patterns using the currently available tools, each with its own advantages and disadvantages. Using separate PlanetPress Workflow servers and licenses. In a scenario where there are multiple locations that use PlanetPress Capture and where neither pen nor paper has any risk of being moved from one location to another, the easiest (but costlier) solution is to have a separate installation of PlanetPress Workflow in each location.
PAGE 721

Note It's very important to note here that the Anoto Digital Pen has absolutely no concept of Pattern Sequences. When "attributing" a sequence to a pen, this is fully on the PlanetPress Workflow side, in the Capture Database. This means that if a pen is mislabeled or someone picks up the wrong pen, this pen has absolutely no way to know that it is writing on the wrong paper. more about this in the Contamination section below.
PAGE 722

contamination. A simple example in a basic implementation would be to print a document with a pattern on it, put this paper aside (or lose it on a desk somewhere) and forget about it. Assuming proper processes were put in place, this document would eventually be closed by a manual or automatic procedure. However, the physical document with the pattern still exists even if it is closed in regards to the PlanetPress Capture database.
PAGE 723

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

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

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

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

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

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 729

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 730

Guide). This must be either a Multi-Area Field or a Text Field. l l l The Capture Fields Processor must have the Perform ICR Recognition option checked, and language needs to be selected. Once the ICR data is available, do something with it. This is done by reading the ICR data that is available in the metadata generated by the Get Capture Document task. The metadata is also readable by the Capture Condition task, including the captured text and the reliability of this text.
PAGE 731

l l l ICR Value: The alpha, numeric or alphanumeric value that was determined by the ICR engine. ICR Confidence: A percentage value that the ICR engine gives to any specific value, when comparing the pen data with it's character database. ICR Resemblance: A percentage value that defines how closely the value resembles the "average" character shape. Both the Confidence and Resemblance can be used together to make an informed decision on the contents received by ICR.
PAGE 732

The following guidelines are applicable when configuring a PlanetPress Capture object that utilizes ICR: l l l l l l l The collected data is expected to be a number, therefore the numeric mask type must be selected, or The collected data is expected to be a letter, therefore the alphabet mask type must be selected, If upper case letters are expected, select Upper case in the Case option menu. The captured characters would be immediately converted to capital letter i.e.
PAGE 733

The following diagram illustrates the available mask types. It is recommended to select the mask type that is the closest to the desired result. An alphanumeric field should be used as a last resort. Guidelines for Capture-Ready Fields l l Target: Form designer What: Only one character per Capture field can be recognized. When expecting multiple characters making up a word or phrase, you must make sure that the user only writes one character per field.
PAGE 734

Why: To avoid any ink marks that would spill over from one field to another. If both fields A and B are to close in proximity and the ink marks from field A spill over to field B, then the marks captured on field B would be considered as being part of a character written on field B. For example, if a number spills over and is written over two fields like numbers 9, 1 or 7; then the bottom tip of these numbers could be considered as number 1 in the second field.
PAGE 735

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 736

Selecting the Correct Language When Using the Capture Field Processor Task l l Target: Workflow designer. What: It is crucial that the correct language is selected when using the ICR recognition option. This will affect how the captured data is interpreted. Why: The available filters to interpret the ink marks done with the Anoto digital pen, allow you to select the engine language to be used. Doing so will give you results that are the closest match to the captured data.
PAGE 737

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 738

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 739

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

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

Workflow processes in Connect Send For help on the configuration of Workflow processes in a Connect Send solution, see "Workflow processes in a Connect Send solution" on page 296. OL Connect Send tasks l "Get Data" on page 572 l "Get Job Data" on page 577 l "Job Processor" on page 581 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.
PAGE 742

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 524. 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 743

information on services and system permissions, refer to Windows documentation. For more information on how to configure the account used by the services, see "Workflow Services" on page 746. Available Input services Input services are used to pull in data files. The input services used by PlanetPress Workflow are: l l l l l LPD (Line Printer Daemon) Input service: Inputs data sent from an LPR client.
PAGE 744

PlanetPress Image can generate PDFs or images and dispatch them from the host on which it runs. See "About PlanetPress Image" on page 739. l l l l PlanetPress Fax: Outputs jobs as faxes. You use PlanetPress Fax as an interface to WinFax PRO or Windows Fax, to send faxes you create from documents. You can install multiple instances of the PlanetPress Fax service on your network, and have PlanetPress Workflow send jobs to one or more of these instances.
PAGE 745

into its processes, but it keeps on performing tasks until all the files which are currently under process have been completely processed. l Click Pause to pause the service. The PlanetPress Workflow service temporarily stops performing jobs. Note If you send a new configuration when PlanetPress Workflow is paused, it will continue using the old configuration when you resume processing until you stop and restart it. See also: "Saving and sending a Workflow Configuration" on page 35.
PAGE 746

the lower right corner of the PlanetPress Workflow Configuration program: . This is to draw your attention to the fact that your PlanetPress Workflow may have rights that differ from your rights, and that this application and its services may therefore not be able to perform some of the actions you can perform when you create or edit a given configuration.
PAGE 747

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

PlanetPress Workflow applies the user account information to all the services (PlanetPress Workflow, PlanetPress Fax, PlanetPress Image, LPD input, Serial input, Telnet input, FTP output, LPR output, and PlanetPress Messenger), that run on this computer. The PlanetPress 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.
PAGE 749

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

l "Telnet Input plugin preferences" on page 785 l "PlanetPress Fax plugin preferences" on page 786 l "FTP Output Service preferences" on page 789 l "PlanetPress Image preferences" on page 790 l "LPR Output preferences" on page 793 l "PrintShop Web Connect Service preferences" on page 795 Note Preferences are saved automatically and applied immediately.
PAGE 751

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 752

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 753

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 754

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. l While JavaScript and VBScript are natively available on Windows operating systems, Python and Perl require third-party tools to be functional. For Perl, ActivePerl can be installed.
PAGE 755

l l l l l l l l l l l Invalid name: Select to have PlanetPress 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 PlanetPress Workflow prompt you when adding a document to a group under the Documents category in the Configuration Components pane.
PAGE 756

l l l l l l l l l Prompt on overwrite of a document: Select to have PlanetPress 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 PlanetPress Workflow prompt for confirmation when a document that is being imported using File | Import Document is about to overwrite an existing document.
PAGE 757

l Warn on Component Rename: Select to have PlanetPress Workflow prompt for action when configuration components, such as processes, are imported from an external configuration file. Imported components can overwrite existing components, or be renamed automatically with unique names. Sample Data behavior preferences Sample Data behavior preferences control the way theData Selectordisplays the sample data file.
PAGE 758

resources as configured for this user. 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 759

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 760

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 761

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 762

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 758.
PAGE 763

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 764

l l l Database file (mdb) must be local to the PlanetPress Workflow computer. It cannot be located on a network drive or another server. 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 PlanetPress Workflow through an ODBC connection on the local network.
PAGE 765

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 766

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 767

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 768

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

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

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

l l l l l l Task failure: Select to only track when tasks in the processes running in a PlanetPress Workflow configuration fail. Task success and failure with details: Select to track when the tasks in processes running in PlanetPress Workflow succeed and fail, with details. Details can include why tasks fail and how successful tasks are executed. All events with details: Select to log everything that happens in PlanetPress Workflow.
PAGE 772

Alambic. Preferences l PlanetPress 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 PlanetPress Workflow can run. Then enter the number of instances, a value ranging from 1 to 32, in the box below. When this option is not selected, PlanetPress Workflow starts a minimum of three instances and a maximum of eight, based on the number of CPUs available on the server.
PAGE 773

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

This password is encrypted within PlanetPress Workflow server and is not saved in plain text. l Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. Note When SSL is enabled and a user sends a query prefixed with https://, then this specific communication will be sent through port 443, which cannot be changed in Workflow. However, http:// requests will still be received on the port specified in http server preferences.
PAGE 775

separated by an underscore (e.g. row_0). The first part is considered to be the element's name. All content after the first underscore (preferably an integer) will be used as index, which is given as an attribute of the element (e.g. ; also see "PHP arrays example" below). This option makes it much easier to select all elements on the same level in a data mapping configuration, and to convert the XML to a JSON object.
PAGE 776

Resulting XML Structure with PHP-like arrays email@example.com Peter Parker Objectif Lune 122 253 dent 361 341 dent Resulting XML structure with Enhanced PHP-like arrays email@example.
PAGE 777

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 778

Even though it is strongly recommended to use the element in web pages, some might use another encoding or not have the element at all, affecting the character set used by the browser to send the parameters and file names. l l System language: Sets the encoding attribute in the request XML file to the system codepage (e.g. Windows-1252). UTF-8: Causes all parameters as well as file names from the request to be interpreted as a UTF-8 text stream.
PAGE 779

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

configure secure communication for the NodeJS Server. Click the PlanetPress Workflow button and then the Preferences button, to open the Preferences dialog. The NodeJS Server Input 1 preferences page can be found under Plugin. Note Workflow's NodeJS and ppNode folders can be found in %PROGRAMFILES%\Objectif Lune\. l l l Port: Select the port to use. The task's default port is 9090. Port numbers > 9999 are possible.
PAGE 781

l l l l l l l HTTPS Port: Select the port to use. The task's default HTTPS port is 8443, so as not to interfere with the standard HTTPS port (443). Port numbers > 9999 are possible. Root certificate: Enter the absolute path to the Root Certificate, or click the Browse button and select the file in the Browse dialog. The file generally ends with a .crt extension. Certificate: Enter the absolute path to the site Certificate, or click the Browse button and select the file in the Browse dialog.
PAGE 782

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

Note In the address of the server and in the domain name the following characters should not be used: , + $ @ # < > ' ; | { } ~ [ ] * " : Tip If you don’t know what your LDAP server and domain names are, you can usually obtain them by opening a CMD window and typing the following: l For the domain name: echo %USERDOMAIN% l For the LDAP Server name: echo %logonserver% Testing the server l To test the server address and domain, enter a username and password and click the Test server button.
PAGE 784

Setting the duration of the authentication When a user has logged in, that user's authentication is valid for the duration of the session. There is no option in the Workflow Preferences that allows you to set a different behavior for the duration of the authentication. However, you can manually edit the file named: C:\Program Files (x86)\Objectif Lune\ppnode\src\constants\default.js. Look for the line exports.
PAGE 785

rest of the PlanetPress Workflow process. Select None to ignore all parity bits; no error detection occurs. l l l l Stop bits: Since most serial ports operate asynchronously, the transmitted byte must be identified by start and stop bits. The start bit indicates when the data byte is about to begin and the stop bit(s) indicates when the data byte was transferred. The start bit is always 0 to mark the beginning of the byte, but the stop bit can be a single 1, or two bits each with a value of 1.
PAGE 786

PlanetPress Fax plugin preferences PlanetPress Workflow Fax plugin preferences control certain functions of the PlanetPress Fax service, which in turn has a direct impact on all PlanetPress Workflow Fax output tasks performed on a given computer.
PAGE 787

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

l l Dialing options button: Click to set the appropriate options as required. Since these options are specific to the faxing program, refer to the faxing program’s documentation for more information. Captaris RightFax l l l l l Report Failures: Select to have PlanetPress Fax generate a report whenever the maximum number of retries for a single fax is exceeded. The error generated by the Windows Fax Service is also logged in the report.
PAGE 789

documentation. l l l l Activation: Click to enter activation codes for the PlanetPress Image service installed on the same computer as PlanetPress Workflow. If you have already activated the PlanetPress Image service from its Control Panel applet, this is reflected when you open the Activation dialog box by clicking this button. Check for updates: Click to access the Objectif Lune website to search for updates to PlanetPress Image.
PAGE 790

l FTP Port: Select the port number that you want PlanetPress Workflow to use for all FTP output tasks. The recommended port is 21 (the default setting). PlanetPress Image preferences PlanetPress Image user options control certain functions of the PlanetPress Image service, which in turn has a direct impact on all PlanetPress Image Output tasks performed on a given computer. These include error and logging options, PlanetPress Search database options, as well as networking and email options.
PAGE 791

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

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

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

output. These messages are related to jobs being sent from PlanetPress Workflow to an LPD or LPD-compatible printer. Logs are kept in a Log folder relative to your install folder. They are named lprdate.log, where date is the current date in yyyymmdd numerical format. Note that changing this option also affects the log displayed in the PlanetPress Workflow Service Console.
PAGE 795

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

l l l l l l l l l Insert mode: Select to use Insert mode and clear to use Overwrite mode. In Insert mode, when you enter text, existing text shifts to accommodate it. In Overwrite mode, text you enter overwrites existing text. You can also press INSERT to toggle between the two modes. Use tab character: Select to use the tab character instead of spaces to represent tabs in the program file. Clear to use spaces to represent tabs. You must clear the Smart tab option to use this option.
PAGE 797

l l l l l l l l l l Keep trailing blanks: Select to preserve any blank spaces occurring at the end of a line. Clear to remove those blank spaces. Persistent blocks: Select to have any text you enter immediately after selecting a block of code appended to that block of code as part of the selection. When you select this option, you can also use the arrow keys to move within the code without affecting the selected code. You must select the Enable selection option to use the Persistent blocks option.
PAGE 798

spaces to advance with each tab. Enter a sequence of two or more integers, each separated by a space, to specify tab stops. The sequence must be in ascending order. Tab stops are measured in number of space characters. For example, a value of 20 places the tab stop at the 20th space character. You can also use the dropdown list to select a previously entered value. l Display l Display Options Group l l l l l Editor font: Use to select the font the Editor uses to display the program code.
PAGE 799

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

The user interface This chapter centers on the PlanetPress Workflow Configuration program, which you use to create and edit your configurations. The basic user interface elements are as follows: l "PlanetPress Workflow Button" on page 810. l " The Quick Access Toolbar" on page 872. This toolbar is customizable. l The ribbon tabs; see "The PlanetPress Workflow Ribbon" on page 873. l "The Process area" on page 864 l "Configuration Components pane" on page 811.
PAGE 801

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 PlanetPress 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 802

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 803

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 PlanetPress 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 PlanetPress Workflow Ribbon, click the View tab. 2. From the Show/Hide group, click on any area name to hide or display it.
PAGE 804

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 805

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 806

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 807

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

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 809

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 PlanetPress Workflow can be used in multiple languages, and the list of available languages grows as we translate the software. The first time you use PlanetPress Workflow, it starts in the language used for the installation.
PAGE 810

Japanese. PlanetPress Workflow Button The PlanetPress 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 33. Open: Displays the dialog to open an existing configuration file. Save: Saves the current configuration.
PAGE 811

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

l Cut, Copy, Paste: Controls the clipboard. 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 124).
PAGE 813

l l l Group, Ungroup: Triggers grouping functionality. Properties...: Displays the properties, which lets you set a default value for the global variable. Connect Resources: Displays a list of PlanetPress Connect resources that can be used in processes (see: "Connect resources" on page 38). 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 814

l l l Group, Ungroup: Triggers grouping functionality. 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: "PlanetPress Workflow printer queues" on page 110). 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.
PAGE 815

PlanetPress 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 PlanetPress Workflow Configuration program. The Document name of printer-resident documents can be changed using PlanetPress Workflow Configuration program simply because it is initially set using that program.
PAGE 816

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 817

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 818

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 819

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 820

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 PlanetPress 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 821

1. Click an object or group. 2. In the PlanetPress 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 822

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

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 824

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 PlanetPress Workflow. 2. In the Ribbon, go in Tools > Managers > Access Manager.
PAGE 825

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 826

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 827

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. PlanetPress does not continue processing after it has found an "Allow" checkmark.
PAGE 828

l Send Config:Grants access to the remote computer to overwrite the configuration on the local PlanetPress Workflow service Note In order for the changes made here to be effective, you will need to restart the PlanetPress Messenger service. This can be done via the PlanetPress Workflow Service Console. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each user name entered in this dialog can have access to one or more processes.
PAGE 829

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 830

Note In order for the changes made here to be effective, you will need to restart the PlanetPress Messenger service. This can be done via the PlanetPress 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 831

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 832

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 833

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 834

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 835

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 836

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 837

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 454) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks.
PAGE 838

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 839

on page 56). 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 53. 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 840

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 841

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 842

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 PlanetPress 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 843

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 844

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 845

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 846

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 847

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 848

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

Note The polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to process. l l Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked. Week of month / by date: Select the desired option for the time grid.
PAGE 850

periods on a given day. To activate the Time Grid, the "As soon as possible" option must be unchecked. In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not poll. Note that when multiple files are present in the input, these may continue to be processed after the period set in the time grid.
PAGE 851

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 852

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 853

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 854

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 855

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 856

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 857

l l l l Most tasks have the General tab which lets you configure the main task properties for that specific task. All tasks except for the InputErrorBin, Run Script, Open XLST and Comment tasks have an On Error tab that lets you manage errors generated by the task. For a description of the options that it contains, see "Using the On Error tab" on page 97.
PAGE 858

Virtual Drive Manager When you use the "Send Images to Printer" on page 433 Action task in a given process, you have the option of, at the same time, sending the images to the virtual drive (a local storage folder used by PlanetPress Suite applications) of any computer included in your network. You need to do this, for instance, if you plan to run PlanetPress Suite documents that contain dynamic images on those computers (using the Optimized PostScript Stream option).
PAGE 859

l l Global Variables: Displays all the variables global to this configuration (see "Local variables" on page 704). Evaluate Expression: Lets you enter a custom expression and displays its value at runtime. You can use the Evaluate Expression section to see the result of any combination of variable properties (see "Variable task properties" on page 707). To add a new expression, simply rightclick in the window and select Add Expression.
PAGE 860

l Messages in Red are critical and are normally critical errors in the plugin. l Messages in Orange are warnings. l Messages in Gray are job info and variable changes. l Messages in Black are debug information and processing information. There are various actions you can execute in the Message area. Here they are: l l l l l l l Click any line to select it. While a line is selected, press Delete on your keyboard or right-click on the line and select Delete to delete the line.
PAGE 861

The Object Inspector also displays information about the Job File while it is being processed in Debug mode. Seeing how files change as they travel down a process can provide valuable debugging information. You can even change some of the job information from the Object Inspector (such as Job Infos) while debugging. Editing properties To edit properties of processes, documents, and printers in the Object Inspector: 1.
PAGE 862

PlanetPress Workflow Plug-in Bar lists all plugins available in PlanetPress Workflow, and is divided into categories, which users can customize at will. Most of the PlanetPress plugins are installed by default, but other plugins may be added. Because the plugins are always expected to execute some sort of task, they are always referred to, in this documentation, as tasks, except in the specific case of importing a new plugin or customizing the Plug-in Bar.
PAGE 863

Settings and customization The Plug-in Bar can be customized according to your needs and the plugins you most frequently used. You can use the horizontal dark blue bar separating the plugin area and the list of categories to change how many plugin categories are displayed as the full-width bar with the title, and how much are displayed as icon only. Move the bar up to display more full-width categories, or down to display them more as icons.
PAGE 864

The Process area The Process area, which is always available and visible, holds all the tasks, branches, conditions and comments that make up the selected process (see "About processes and subprocesses" on page 124 and "About Tasks" on page 298). The Process area is built like an invisible grid divided by rows (horizontal) and columns (vertical). When adding a new Action task, a new row is added. When adding a Branch or Condition, a new column appears (unless there is already a column at that level).
PAGE 865

Cutting, copying and pasting tasks and branches Using cut and paste, and copy and paste, you can move as well as duplicate tasks and branches within a given process as well as between different processes and subprocesses. To cut and paste tasks or branches: 1. In PlanetPress Workflow Process area, select the task or branch you want to cut and paste. 2. From the Home tab in the Ribbon, choose Cut (or right-click and select Cut from the drop-down menu).
PAGE 866

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

l Right-click it and select Highlight from the contextual menu. l Double-click it, open the Miscellaneous tab and select the Highlight option. l Select a square, open the View ribbon and select Highlight from the Navigate group. To remove the highlight, repeat the procedure. Selecting a highlight color The default highlight color may be changed via the PlanetPress Workflow Configuration preferences (see "Colors" on page 750).
PAGE 868

Moving a task or branch using drag-and-drop When you want to move a given task or branch, the simplest way is to use drag-and-drop. Using the mouse, you can drag and drop tasks and branches only within a given process. To move tasks and branches between different processes, see "Cutting, copying and pasting tasks and branches" on page 865.
PAGE 869

2. While holding down the mouse button, press and hold down the CTRL key and drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item and release the CTRL key. The dropped task or branch is copied above the item over which it was dropped. Redo a command The Redo command can be used to redo commands that were just undone using the Undo command.
PAGE 870

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. Replacing tasks, conditions or branches You can replace existing tasks either by dropping a new task on it, or by pasting another task over it. To replace an existing task with a new task, see "Adding tasks" on page 299.
PAGE 871

A dashed line appears as you drag indicating the new separation. The row or column, with all its tasks, moves accordingly. Collapse and expand branches and conditions A Branch or Condition can be temporarily hidden by collapsing it. This gives a better view on other parts of the process. It doesn't disable the Branch or Condition. A collapsed Branch or Condition can be expanded at any time. When expanding any branch, all its sub-branches will be expanded as well automatically.
PAGE 872

Zoom in or out within the Process Area You can do a zoom out in the PlanetPress 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 PlanetPress Workflow Process Area: 1. Click on the View tab of the Ribbon. 2. Click on Zoom Out in the Navigate group to zoom out, and Zoom In to zoom in.
PAGE 873

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. Right-click on the Quick Access Toolbar, or click on the downwards arrow at the rightmost end of the Quick Access Toolbar. 2. Click on Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon, depending on where you want it.
PAGE 874

l l l l The Documents group contains the controls used to insert, refresh, update or delete PlanetPress Design documents and document instances (see "PlanetPress Design documents" on page 42). The Printer Queues group contains controls to set up printer queues of any type, as well as replace any existing queues (see "PlanetPress Workflow printer queues" on page 110). The View tab includes the Arrange, Navigate and Show/Hide groups.
PAGE 875

l The Tools tab includes the Managers, Services and Test Page groups. l The Managers group: l l l l l l l l The Access Manager control loads the "Access Manager" on page 824, allowing to grant/remove permissions to hosts. The Check for updates control, used to update the current PlanetPress Workflow version. The Launch Upgrade Wizard control, used when migrating from a previous PlanetPress Workflow version. The Services Status control allows to start, pause and stop PlanetPress Workflow service.
PAGE 876

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

Controlling Services The left part of the PlanetPress Workflow Service Console displays a list of the PlanetPress Workflow services and is used to control these services. 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.
PAGE 878

Viewing log files The second major role of the Service Console is to view and browse log files. The Service Console can both view existing log files, or monitor the log file for the current day and update 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.
PAGE 879

Direction), clicking Find Next will display the first result for the search term. When a search is started, using F3 on the keyboard or clicking Search then Search again will find and highlight the next available result.
PAGE 880

Knowledge Base You can find extra information in Connect Knowledge Bases which complement the information contained in this manual.
PAGE 881

Legal Notices and Acknowledgments Warning: PlanetPress 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
PAGE 882

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 883

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 884

l l l l 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.net/viewvc/wsdl4j/ XULRunner which is distributed under the terms of the Mozilla Public License Version 2.0. The source code for this can be obtained from the following location: http://ftp.mozilla.org/pub/mozilla.
PAGE 885

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 Liquibase l LMAX Disruptor l Objenesis l OpenCSV l OPS4J Pax Web l org.json.
PAGE 886

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 887

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. This product includes software developed by JSON.org (http://www.json.org/java/index.html). Copyright Information Copyright © 1994-2021 Objectif Lune Inc. All Rights Reserved.
PAGE 888