2020.2

Manuals Brands Objectif Lune Manuals Applications PlanetPress Workflow

Table Of Contents

Summary of content (894 pages)

PAGE 1
PAGE 2
PAGE 3

User Guide Version 2020.2 Last Revision: 2020-12-08 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-2020. 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

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 find the Data Repository Debugg
PAGE 6

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 Repository API M
PAGE 7

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 Name2, opt
PAGE 8

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 tasks Conn
PAGE 9

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 appearance preferences
PAGE 10

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 Setting the duration of the authenticatio
PAGE 11

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 Components pane Dialogs Access Manager
PAGE 12

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 PlanetPress Workflow Service Console Controlling
PAGE 13

Welcome to PlanetPress Workflow 2020.2 This PDF documentation covers version 2020.2. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow is the heart of all of our solutions.
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 25 System requirements These are the recommended system requirements for PlanetPress Workflow 2020.2.
PAGE 16

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

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

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

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

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

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

Local and network rights Programs, such as PlanetPress Workflow and all its services, must identify themselves in order to be granted permission to perform operations on the computer on which they run as well as on other computers accessible via a network connection. On a given workstation, you can configure your PlanetPress Workflow to use either the local system account or any specific user account.
PAGE 23

In addition, the use of network shared drives can cause issues when attempting to capture files from those locations since the notification process for folder changes on network shares may be different than that of local folders. Network ports used by each service The port configuration for each PlanetPress Workflow Input task or Output task is described in the following table. The port number assignments comply with Internet standards.
PAGE 24

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

4 Contact your DBMS vendor to determine which ports are used by the ODBC driver for accessing a network database. Known Issues Issues with Secure Email tasks in multi-byte languages Neither the Secure Email Input nor the Secure Email Output tasks are able to save or read their configuration when running on a Windows instance that uses a multi-byte language. The plugins appear to save the configuration correctly, but when the plugins are executed or the task reopened, then no configuration is available.
PAGE 26

Excel Lookup plugin to switch drivers. l For the Database Query plugin (found in the Actions tab of the plugin bar) and when using Excel/Access in PlanetPress Design: Change the ODBC driver used for Excel files from JET to ACE (change the Data Source). As an example: in Windows 10: Change the Excel File ODBC driver from ODBCJT32.dll to ACEODBC.dll. (Naming may vary from versions of the OS but the basics stay the same.
PAGE 27

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

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

PlanetPress Workflow configuration file from another PC that includes an instance of the WordToPDF task, you must review the properties of each instance of the task and click OK to validate its contents. A new printer queue will be created if required and the default printer will be reset properly. If you do not perform these steps, running the configuration will result in several error messages being logged and the task failing.
PAGE 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 818.
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 316 initial input task and a "Send to Folder" on page 668 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 760).
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 831. 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

Importing Connect resource files Connect resource files are added by using the Send to Workflow option from the PlanetPress Connect Designer's File menu; see Sending files to Workflow in Connect's Online Help. They can also be imported into PlanetPress Workflow as follows: 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.
PAGE 41

package are extracted and placed in the folders noted above. Tip To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. Resource archives From version 8.2, 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 ma
PAGE 42

l A data mapping configuration adds an "Execute Data Mapping" on page 618 task. If you agree to use the first sample file in the data mapping configuration as the process's sample data file, the process's emulation will be changed accordingly. l A Job Creation Preset creates a "Create Job" on page 595 task. l An Output Creation Preset creates a "Create Output" on page 598 task.
PAGE 43

Note Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file. Clicking Cancel instead of OK after viewing will prevent this action from being taken. Saving an attached data file to disk 1. Make sure the Connect Resources section is visible by clicking the appears. 2. Expand the document by clicking the button if it button. 3. Right-click on the data file, then click Save sample data file.
PAGE 44

Printer-centric printing PlanetPress Design lets you send documents to printers as well as to PlanetPress Workflow servers. l l l If you send a document to printers only and not to any PlanetPress Workflow server, you will not be able to see this document in the PlanetPress Workflow Configuration program.
PAGE 45

2. Enter the document’s name. Note that the name you enter must exactly match the actual document name or PlanetPress Workflow will not be able to use it on the printer or remote PlanetPress Workflow server. 3. Click OK. Importing PlanetPress Design documents This procedure describes how to import PlanetPress Design documents into PlanetPress Workflow. Importing documents can be useful when transferring configurations between PlanetPress Workflow installations.
PAGE 46

Setting an attached data file as a sample data file in a process The attached data file can be used as a sample data file in a process. This sets the emulation of the process ("About data emulation" on page 59) and makes it possible to debug it (see "Debugging your PlanetPress Workflow process" on page 104). 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.
PAGE 47

not appear in the Configuration Components pane but it follows the data file and can be viewed from the Metadata tab whenever the data file is viewed through the Data Selector. Document Preview When sending a PlanetPress Design document from PlanetPress Design to PlanetPress Workflow, a PDF Preview of the job's output is automatically sent to PlanetPress Workflow along with the Design document. This preview appears under the PPS/PSM Documents section of the Configuration Components pane.
PAGE 48

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

the documents to the Documents folder relative to the install folder of PlanetPress Workflow. Tip To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. For help on importing PrintShopMail Connect templates, see "Connect resources" on page 38. About data Data is what drives your business, and our software. We define data as anything that is obtained through an Input task and used within the process itself.
PAGE 50

different printers. To ensure consistency, you should consider filtering out such characters. About documents and variable data "Variable data" is data that is meant to be merged with a document or template. In PlanetPress Connect, variable data is usually retrieved from a data file (the job file) using the OLConnect Execute Data Mapping task. This task uses a data mapping configuration file, created with the DataMapper, to produce a record set. A data mapping configuration contains a data model.
PAGE 51

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

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

(maroon, by default). Right-click the property field and choose Get Data Location or Get Metadata Location to open the Data Selector (see "The Data Selector" on page 842) or Get Repository Location to open the Data Repository Manager (see "Data Repository Manager" on page 839). Note The Get (...) Value options will also open the Data Selector or the Data Repository Manager, but once selected, the value becomes static and does not change between each data page and job file.
PAGE 54

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

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

SELECT [return key] FROM [group] WHERE [lookup key] = [lookup value]; PDF data selections These selections are used for PDF data files. The selection refers to a specific area of any given page of the PDF by using precise region coordinates (in inches). Note that when adding a metadata field, if you perform a multi-line data selection on a PDF region, only the first line of that region will be set to the metadata field.
PAGE 57

option View Metadata gets enabled. This happens when metadata have been created by a task in the process. Open the metadata viewer and save the metadata file to use it as a metadata sample file in the Data Selector. Syntax GetMeta(Field Name [, Option Flags, Metadata Path]) Here is a breakdown of the syntax: l l GetMeta(): Always surrounds metadata selections.
PAGE 58

Name Value Behavior NoCascade 2 Search only the level specified by the path argument (defaults to Page level when path argument is empty), instead of default behavior, which recursively goes up from the Page level to the Job level. FailIfNotFound 4 Raise an error and crash the job is the specified name is not found instead of returning an empty string. SelectedNodesOnly 8 Returns values from selected nodes only (i.e. ignores unselected nodes).
PAGE 59

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Note: Metadata in OL Connect jobs In PlanetPress Suite, all levels in the Metadata hold information about an actual job. In Connect, that isn't the case. The Metadata file created and maintained by OL Connect tasks looks the same, but contains less information. Only the first three levels in the Metadata hold information about the job: Job, Group and Document. A Group has information about a record set in the Connect database and a Document has information about one record in that set.
PAGE 77

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

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

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

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

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

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 74 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 83

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

Attribute Description Categor y J o b Gro up Docum ent Title Title of the source document. Producti on X X X Producer Name of the software that created the Metadata. Producti on X X X Creator Name of the software that created the source of the Metadata. Producti on X X X TargetDevice Name of the device for which the Metadata and associated data is intended.
PAGE 85

Attribute Description Categor y point values separated by a colon indicating the media size in typographical points (ex: 612:792). g Orientation "Rotate0", "Rotate90", "Rotate180" or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape. Finishin g Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent.
PAGE 86

Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicates a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source. Finishin g X X X X X OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedependent color of the media.
PAGE 87

Attribute Description Index Categor y J o b Index/C ount IndexInDocument Returns the Absolute index of the node within all the nodes under the parent Document. Index/C ount IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group. Index/C ount IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
PAGE 88

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

Attribute Description Categor y J o b Index/C ount X Gro up Docum ent Datap age Pa ge of the node within all the selected nodes under the parent Job. NumCopies Indicates how many times the job is set to execute, as set when printing using a 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.
PAGE 90

l l l The following OL Connect tasks accept JSON data as input: "Create Email Content" on page 590, "Create Print Content" on page 606, "Create Web Content" on page 611, "Render Email Content" on page 630, and the "Create Preview PDF" on page 601 task. When the OL Connect "Execute Data Mapping" on page 618 task or the OL Connect "Retrieve Items" on page 635 task is set to output Records in JSON, it outputs a JSON Record Data List (see "Types of JSON in Workflow" below).
PAGE 91

A JSON string with references to local variables and a Job Info variable (see "About variables" on page 703): { "first":"%{first}", "last":"%{last}", "email":"%2" } A JSON string containing a local variable and various Data Repository selections (see "Data Repository lookups" on page 55): { "jobid":"%{jobid}", "account":"lookup(OLCS_jobs, account, jobid, '%{jobid}')", "datafile_name":"lookup(OLCS_jobs, datafile_name, jobid, '% {jobid}')", "pages":"lookup(OLCS_jobs, pages, jobid, '%{jobid}')", "documents":"l
PAGE 92

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

"ItemShipped": 2.0, "ItemOrdered": false } }, { "id": 3678079, "fields": { "ItemTotal": "29.99", "ItemShipped": 1.0, "ItemOrdered": "false" } }], "detail2": [{ "id": 3678080, "fields": { "ItemUnitPrice": "1150.00", "ItemOrdered": 2 } }, { "id": 3678081, "fields": { "ItemUnitPrice": "29.99", "ItemOrdered": 1 } }] } } ] Values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.detail[0].fields.
PAGE 94

The Data Repository is especially useful in situations where data needs to be kept in between processes. A few examples: An HTTP-based authentication process, once it has validated user credentials, could store session information (unique ID, user name, session starting time) into the repository. All other related processes could then look into the repository to determine if a new request is received from an already authenticated user, if the session has expired, what the user name is, etc.
PAGE 95

Feature Name Description Equivalent Database Terminology to Repository" on page 423 task. Lookup A method of retrieving one or more KeySets from a group in the data repository. Query Accessing the Data Repository Via plugins Storing data in the Data Repository Data can be stored in the Data Repository using the Push to Repository task (see "Push to Repository" on page 423).
PAGE 96

Tip The Data Repository Manager displays, at the bottom left, the syntax used for accessing a specific value. Note Lookup()returns NODATA when the group and/or key does not exist. In previous versions of the software, trying to do a look-up in a non-existent group and/or key would cause an error. This change in behavior may affect any Workflow configuration that uses an on error process related to invalid groups/keys.
PAGE 97

Debugging is the act of running through your process, either step by step or as a whole, directly from the PlanetPress Workflow Configuration tool, in order to detect and resolve issues with your process. Error handling, on the other hand, occurs when your configuration has been sent to PlanetPress Workflow services, and are running in "production" mode. The automated handling of errors within your processes will have a large impact on recovering from errors as they happen during production.
PAGE 98

ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and Output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
PAGE 99

error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. All error codes are listed in the knowledge base of PlanetPress Workflow. Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress Workflow itself. Some examples would be W3813, W3830, W3991, W4005.
PAGE 100

Note Local variables in the process are not sent to error processes, even if the error process has a variable of the same name. Error handling variables The error handling variables are read only and are filled by the On Error mechanism. They can be accessed anywhere, but they only appear in the contextual menu of a task property field when the current process is an error-handling process (that starts with the Error Bin Input task). See also: "Variable task properties" on page 714.
PAGE 101

Accessing the Logs If your process is running live in the PlanetPress Workflow Service, you have two ways of seeing what is happening now or what has happened in the past. Viewing running processes To view what processes are running and processing data as it happens: 1. In the PlanetPress Workflow Ribbon, click on the Tools tab, then select Service Console in the Services group. The PlanetPress Workflow Service Console opens. 2.
PAGE 102

C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\Log You can access this folder more quickly by using this procedure: 1. Open the Workflow Configuration tool and then press CTRL+SHIFT+ALT+F4 simultaneously. This macro keyboard shortcut opens the PlanetPress Workflow working folders. 2. Double-click on the folder called Log. 3. There are multiple logs displayed here, including: l ppwYYYYMMDD.
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 702 in the process. l A sample data file must be selected; see "Choosing a sample data file" on page 70.
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 43). 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 656 Output task, or the "Printer Queue Output" on page 658 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 471 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 274. 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

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. Note that any selection you make in this box will be interpreted based on the selection made in the Month box.
PAGE 133

the period set in the time grid. The "Folder Listing" on page 319 plugin in combination with a "Time of Day Condition" on page 481 could be used to prevent further processing of those files. 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.
PAGE 134

l l l l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click. 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.
PAGE 135

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 136

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 137

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 138

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 139

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 140

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 141

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 142

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 143

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 144

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 145

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 146

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 802.
PAGE 147

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 148

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 149

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 150

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 151

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 152

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 153

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 154

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 155

Variable Name Description Example Usage (VBScript) "Watch.GetJobFileName" on page 162 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 164 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 156

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

Variable Name Description Example Usage (VBScript) c:\\myfile.ps", "c:\\", 0, true); "Script.ReturnValue" on page 171 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. The AlambicEdit library allows Workflow to access, create or modify PDF files. "Watch.
PAGE 158

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 159

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 160

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 161

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 162

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

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

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 165

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 166

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 167

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 168

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 169

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 704.) 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 170

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 171

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 172

} 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 173

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 174

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 175

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

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

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

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 183 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 179

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 180

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

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 182

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

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 184

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 185

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

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

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

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

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 191

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

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 193

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 173). 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 194

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

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 197 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 196

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 197

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

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

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

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

on page 216 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 217 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 217 String Returns the specified attribute's value.
PAGE 202

"FieldByName(const String Name)" on page 220 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 221 String Returns the value of the N'th field of the specified name. "IndexInJob()" on page 222 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 203

underneath this node. "SelectedPageCount()" on page 226 Integer Returns the number of pages selected to be output that are underneath this node. "SelectedIndexInJob()" on page 226 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 226 Sorts the sub-nodes according to a number of criteria.
PAGE 204

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

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

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

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

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

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

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

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

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 213

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 214

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 197, "MetaGroup" on page 200, "MetaDocument" on page 203, "MetaDatapage" on page 206, and "MetaPage" on page 210. Properties Attributes Returns the attribute collection (MetaCollection) of the current node. See "Attributes" on page 228.
PAGE 215

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 216

(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 217

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 218

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 219

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 220

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 230.) 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 221

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 222

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 223

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 224

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 225

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 226

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 227

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 228

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 229

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 231 Adds a new element to the collection or overwrites its value. Clear() Clears all elements from the collection.
PAGE 230

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 212 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 228. As is the case with the different types of Nodes, both collections share a number of methods and properties.
PAGE 231

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

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 233

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 234

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 235

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 236

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 237

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

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 239

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 240

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 241

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 242

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 243

"IsProtected(filename)" on page 247 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 247 Merges the pages of pdfFilename (the source) with the pages of the current PDF (the destination).
PAGE 244

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

} 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 251. 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 246

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

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 249. 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 248

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 249

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 250

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 251

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 270 structure that specifies various print options. If NULL , default values are used. Save() Saves changes to the PDF file.
PAGE 252

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 253

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 242.
PAGE 254

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

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 256

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

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 258

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 259

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

rotateAngle, scaleFactor, layerName)" on page 267 Optional Content Group). Supported image types are JPG and PNG. "MergeToLayer2 (srcPage, left, top, rotateAngle, scaleFactor, layerName)" on page 268 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 269 "IPdfRect" on page 271 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 261

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 262

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 263

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 264

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

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 266

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 267

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 268

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 269

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 270

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 271

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 272

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 273

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 274

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

OL Connect Send (see "OL Connect Send" on page 747) 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 294.
PAGE 276

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 277

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 278

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 854 for more details.
PAGE 279

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 280

Example HTTP Workflows l "HTTP PDF Invoice Request" below (GET) l "HTTP brochure request" on page 282 (Customer Information+ POST) l "Capture Web Manager Workflow" on page 292 (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 281

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

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

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 284

Things to keep in mind while working with Metadata are set forth in another topic: "Working with Metadata" on page 77. Note In Connect it is also possible to group, sort and split PDF data using "OL Connect tasks" on page 582. 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 285

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

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

l l l l l An "HTTP Server Input" on page 325 task or "Folder Capture" on page 316 task that receives the PGC. The "Capture Fields Processor" on page 537, 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 529 task to do post-processing using the Capture Fields data.
PAGE 288

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

l Any input task l "Create Metadata" on page 551 l "Capture Fields Generator" on page 534 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 290

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

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 292

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 285 and "HTTP Server workflow" on page 275.
PAGE 293

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 294

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 295

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 296

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 297

l "Output tasks" on page 643 l "Unknown tasks" on page 702 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 298

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 299

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 300

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 433. l In Scripts. See the chapter on "Using Scripts" on page 139. l In the Create File Input Task. See "Create File" on page 308. l Within a PlanetPress Design Document, using the ExpandString() function. See the PlanetPress Design User Guide and PlanetPress Talk Reference Guide.
PAGE 301

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 302

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 303

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 304

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 305

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 306

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 307

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 308

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 309

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 310

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 311

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 312

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 313

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 314

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. Output Job Information definitions When used as Input task, the File Count task sets the following Job Info variables. l %1 - FolderName. The target folder. l %2 - Mask. The specified mask.
PAGE 315

option is ticked. The percent sign, the curly brackets and the period are all key elements of the RegEx syntax, therefore they cannot be mixed and matched with Workflow variable data syntax (e.g. %1, ${global.myvar}, etc.). Also, there is no validation of the RegEx being specified. l l File count: Select whether the condition is to check if the file count is equal to, less than, greater than, less than or equal to, or greater than or equal to the specified value. Value: Enter the desired file count.
PAGE 316

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Folder Capture Folder Capture input tasks retrieve files corresponding to a specified file mask, from a specified folder. Input Folder Capture retrieves all files corresponding to the specified mask. These files may be of any format, even formats that are not readable by PlanetPress Workflow.
PAGE 317

Task properties General Tab l l Folder list: Enter the full path of the folder from which the input files are to be taken. Masks: Enter a single or multiple file names or use file name masks. See "Masks" on page 302. l Treat as regular expressions: When ticked, the contents of the Mask field are deemed to be a regular expression . You can specify multiple masks based on regular expressions, separating the regular expressions by a semicolon. The checkbox is not ticked by default.
PAGE 318

option is selected, the chosen Sort order is applied to each separate folder, not across folders. The subfolders themselves are always processed in alphabetical order, regardless of the sort order. l l Include hidden files: Select if you want any hidden folders or files present in the source folder to be taken as well. Include empty files: Select if you want any empty folders or files present in the source folder to be taken as well.
PAGE 319

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

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

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 322

Task properties General Tab 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 Password: If account named in the User name box is password protected, enter the password here. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available.
PAGE 323

l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically.
PAGE 324

Output HTTP Client Input will output a single file which was retrieved from the web. Metadata is not generated by this task. Task properties General Tab l URL: Enter the URL of the HTTP server from which the file must be downloaded. Since this is a variable property box, variables may be used, as well as the Get Data and Select Data commands (see "Variable task properties" on page 299).
PAGE 325

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

as the initial input, as it is triggered when PlanetPress Workflow HTTP Server receives a request and passes it on to the correct task. Note Athough Workflow can serve both static and dynamic resources to a web browser, it is not meant to be used as a fully featured web server as it is not built for responsiveness nor guaranteed uptime. It is recommended to use a common web server (for example, IIS or Apache) to serve your contents and to let Workflow process things only it can do.
PAGE 327

The request can contain one or more files, one being an XML file containing the request information as well as any GET or POST variables that were received within this request. Other files are POST attachments. Note By default, the request XML also contains a CDATA section which contains the raw input data, effectively doubling the size of the incoming file. Due to technical restrictions, the incoming XML file cannot be more than 400MB, which because of CDATA is reduced to around 200MB.
PAGE 328

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

occurring. When checking this option, the field under the option is used to select which file to return. l Use custom HTTP server response code: When the process ends and a response is sent to the requesting client, a custom response code can be specified depending on how the process goes. While in previous versions the "200 OK" code was always used, this option overrides it to, for example, "404 Not Found" or "401 Unauthorized".
PAGE 330

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 331

generate its own job infos! No Metadata is received by this task, and none is generated. The following error information is generated by the Input Error Bin starting version 7.5, and is accessible throughout the process: l l %{error.process}: the process name where the error occurred. %{error.tasktype}: the type of the failed task, can be Action, Input, Output, Printer, Comment and Branch. l %{error.taskname}: the name of the plugin (the Display Name as seen in the plugin bar). l %{error.
PAGE 332

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 333

The Input SOAP Task only responds to a single SOAP action by the client: SubmitJob. Within this request however, a secondary action (SubmitSOAPActionName) can be specified - this is what the SOAP Action corresponds to in this task properties. Input This task does not poll any location by itself. It sits there waiting for requests coming in through WSDL (SOAP communication) and, when it receives a request, runs the process and returns the last output generated by the process to the client.
PAGE 334

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 335

Processing When the job is received through LPR, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. Task properties General Tab l l l LPD queue names: Enter the queue name (or names, one per line) specified in the printer queue on the remote computer or computers. Allow empty queue names: Check this option to accept LPR jobs that don't specify a queue name.
PAGE 336

l Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user for which a software sending the job was logged in under. %2 - Host computer: Contains the name of the computer from which the job was sent.
PAGE 337

Processing Once all PDF files are captured, their original copies are deleted from the input folder (or tagged as Archive if this option is selected) and they are merged into a single PDF. This is done in a single operation, not incrementally, meaning the file is built once and, if the option is chosen, optimized once. Output A single PDF containing as many pages as all the combined input PDFs is generated. If the option is selected, this PDF is optimized.
PAGE 338

l l Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized. Optimization can lead to a significant reduction in the size of the PDF, but it may also add a certain amount of time to the process. This option should only be unchecked if the timing of the process is critical and needs to be done quickly, but keep in mind that the resulting PDF may be much larger than it should be and may even be too large for PlanetPress Workflow to handle.
PAGE 339

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 Email Input The Microsoft 365 Email Input task allows the processing of emails from any of the organization's Microsoft 365 accounts, without having to specify a user's credentials. This way, privacy is maintained while allowing a process to handle email messages and attachments for any user.
PAGE 340

Filtering is done at the mail server. Only the first unread email matching the conditions is retrieved from the mail server, along with its attachments. Captured emails can either be deleted or marked as read. Note The MS Graph REST API is limited to a certain number of requests within a certain period of time. This is called throttling. When throttling comes into play, the plugin makes two more attempts. It exits with an error after three unsuccessful attempts.
PAGE 341

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\ 0106HBKO4J5U342.jpg The most pertinent information is located at the top level, under .
PAGE 342

counted as 1 attachment. Some embedded images may be counted as attachment. The body of the email does not count as an attachment. Task properties General Tab Condition Enter the condition(s) that must be met for an unread email to be captured. l l First found (no conditions): When no conditions are specified, the first unread email that is found will be processed (for each iteration of the plugin). In any other case, all conditions must be met for the email to get processed.
PAGE 343

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. "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 344

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.All permission is required so that the task can create the folder if it doesn't already exist.
PAGE 345

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 346

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 347

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 348

Server Input plugin preferences 2" on page 788 and "NodeJS Server Input plugin preferences 3" on page 789. 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.
PAGE 349

Server Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received first. 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.
PAGE 350

and to convert the XML to a JSON object. For an example see "Incoming HTML" on page 782 and "Resulting XML structure with Enhanced PHP-like arrays" on page 783. 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 351

Note The following characters are not allowed in an action name: $ * ? #, spaces, and any characters that are not permitted in Windows folder names, such as \ / : ? ” < > | . 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.
PAGE 352

l Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the NodeJS 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 353

message. If the first few characters can't be converted to a valid number, the server automatically returns "500 Internal Server Error", regardless of the actual response code provided by the process. l l Variable containing the response code: The contents of the Job Info variable or local variable (see "About variables" on page 703) selected in this drop-down, presumed to be a valid response code, will be returned in the response header.
PAGE 354

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 355

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 356

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 357

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 358

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 359

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 299. 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 360

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 361

preferences" on page 791). 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 362

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 363

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 364

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 365

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

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 367

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 368

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 369

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 792).
PAGE 370

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

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 372

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 373

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 374

l "Open XSLT" on page 418 l "PDF/A-3 Attachments" on page 419 l "PDF to Bitmap" on page 628 l "Push to Repository" on page 423 l "Rename" on page 425 l "Run Script" on page 473 l "Search and Replace" on page 428 l "Send Images to Printer" on page 430 l "Send to Folder" on page 432 l "Set Job Infos and Variables" on page 433 l "SOAP Client plugin" on page 654 l "Standard Filter" on page 436 l "Translator" on page 438 l "Windows Print Converter" on page 439 Add Document The Add Doc
PAGE 375

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 43).
PAGE 376

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 377

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 378

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 379

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 380

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 381

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 382

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 383

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 384

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 385

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 386

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 387

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 388

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 389

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 390

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 391

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 392

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 393

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 394

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 395

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 305).
PAGE 396

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 397

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 398

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 399

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 838. 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 400

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 401

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 402

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 403

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 404

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 405

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 406

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 407

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 408

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 409

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 410

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 411

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 412

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 413

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 414

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 415

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 416

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 417

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 418

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 419

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 420

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 746 and "About PlanetPress Fax" on page 745. Without a valid Imaging license, the plugin will fail with an error.
PAGE 421

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 422

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 423

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

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

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

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

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

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

Processing The appropriate changes are made to the data file (replacing text). Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General Tab l l l Find: Enter the string of data for which to search. You can use any combination of text, variables and data selections; see "Variable task properties" on page 299. Replace with: Enter the string of data to use as a replacement.
PAGE 430

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 411), but includes image specific options. Furthermore, this task can be used to send images not only to printers, but also to the virtual drive of other computers running PlanetPress Workflow applications.
PAGE 431

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

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send to Folder Send to Folder Action tasks send the files they receive to a local folder. They perform the same function as Send to Folder Output tasks, with the only difference being that in this case PlanetPress Workflow will wait for the task to be completed before going on to the next task in the configuration.
PAGE 433

l l Concatenate files: If this option is selected, when PlanetPress Workflow tries to save a file under a given name, if a file under that same name already exists, instead of overwriting it, PlanetPress Workflow will append the content of the new file to that of the existing file. This appending process will go on until the file is removed from the folder. Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected.
PAGE 434

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

If firewalls control communication between the SOAP client and the Web servers, they must be configured so as not to block client-server communication. In the case of "string" type data, SOAP Client plugin tasks normalize all line endings to a single line feed character. Task properties General Tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the drop-down list. Note The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.
PAGE 436

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

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

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

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

Note Although it is more common to perform both phases in a single pass, each phase can be performed selectively, as required. Input A print job in EMF format, generally captured from a WinQueue input task. Processing The EMF job is converted into a text-only, "Line printer emulation" on page 66 data file. Output A Line Printer file. Metadata, Job Info variables and other variables are not changed.
PAGE 441

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

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

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

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

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

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

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

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

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

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

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

l l l Word: Enter the string of characters to search for as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. Get: Click to get a static string of characters from the sample data file. If you use this button, the coordinates of the data you will select will be added to the Word is between lines and Word is between columns groups below.
PAGE 453

l A word change: If you choose A word change in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l l Get: Click to select a search region. The coordinates of the selected region will be added to the Word is in line box and the Word is between columns group below. The Generic Splitter will look for changes in the string of characters appearing in that region. Word is in line: Enter the line on which to search for the word change.
PAGE 454

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

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

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

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

In the case of Connect Print output, using Print Presets to separate the output is preferable to using the PDF Splitter. How to separate Print output in Connect is explained in the Connect Online Help: How to split print output into multiple files. Input A PDF data file (see "PDF emulation" on page 66). Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process.
PAGE 459

l l l l l l l l l l l Get button: Click to go to the Data Selector and select the location associated with the On region change option. Specific word: Enter the word to use as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. You may also use the Get Data button to get a static string of characters from the sample data file.
PAGE 460

l l When condition is found: By default, the task splits the file every time the condition is met (the default value is 1). If you want the task to split the file only when the condition has been met twice, for example, enter the number 2 in this box. Split PDF file based on Metadata group: l l Metadata Level: Determines on which level of the Metadata the split occurs. This can be Group, Document to Data page.
PAGE 461

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. XML Splitter XML Splitter action tasks use the XSLT language to split XML data files into multiple XML data files that are passed to subsequent tasks in the process. The XML splitter includes options to add a new root node within the generated files, as well as to change the original file’s encoding to UTF8. Note that the XML Splitter cannot process files larger than 30 megabytes.
PAGE 462

node changes, see the Condition group below. l l l l l l l l l l Condition group: Use this group to indicate whether you want the file to be split whenever this node is encountered or whenever the information in this node changes. When condition node is found: Select if you want the file to be split whenever the node selected in the Condition node path box is encountered.
PAGE 463

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

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

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

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

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

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

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

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

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

Task properties General Tab l l l l l Subprocess: Drop down list containing all the available subprocesses in the current configuration. Backup job file: Select if you want to use identical copies of the job file for the main process and the subprocess. Backup job information: Select if you want to use identical copies of the job file information for the main process and subprocess. Once the subprocess completes its execution, the main process will retrieve the original job information values.
PAGE 473

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

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

l l l l l Select All: Select all of the contents of the editor. l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog. Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Language: Select the language in which your script is written. Choices are VBScript, JavaScript, Perl or Python.
PAGE 476

Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties. The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from within your script. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 477

Task properties General Tab l Process: The name of the target process to send the current job to. Note that startup processes and subprocesses are not available. You can either enter the name of a process (or use variable properties) or use the drop-down to list existing processes. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 478

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

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

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

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

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

Available Connector tasks l "Create MRDX" below l "Laserfiche Repository Output" on page 488 l "Lookup in Microsoft® Excel® Documents" on page 491 l "Microsoft® Word® Documents To PDF Conversion" on page 494 l "Output to Capture OnTheGo" on page 496 l "PlanetPress Fax" on page 503 l "PlanetPress Image" on page 504 l "PReS Print Controls" on page 514 l "PrintShop Mail" on page 518 l When installed, the "ZUGFeRD plugin" on page 520 also appears in the Connector category.
PAGE 484

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

Task properties General Tab The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document. l Server URL: Select the address of the COTG Server that you want the plugin to communicate with. (This option is only available if more than one COTG Server address has been defined.) l Repository ID: Enter a valid Capture OnTheGo Repository ID.
PAGE 486

l SharePoint Foundation 2010 l SharePoint 2013 It may work but has not been certified with other SharePoint server versions. Input Any data file present on a SharePoint document store, even those not compatible with PlanetPress Workflow emulations, and the properties of these files. Processing The task connects to the selected Document store and retrieves a copy of files according to the specified rules.
PAGE 487

l l l l l Folder: The folder in the document library where your files are located. You can click the Browse button to display your folder structure. In the Browse Folders dialog, click on the folder you want to use and click OK. Input Rule: Lets you define rules to filter incoming files on certain variables, for example the file name, size, etc. Clicking the ... button brings up the "Rule Interface" on page 859.
PAGE 488

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 489

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

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

l l l If the output repository folder does not have access rights to read and create documents, the task will not be able to export documents to the selected Laserfiche folder. If you intend to use PDI for number type, your decimal separator in both your Regional and Language Options and in PlanetPress Index (PDI) numbers should be a dot ("."). The Laserfiche output task will only work if an activated PlanetPress Image is found, either locally or on the network.
PAGE 492

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

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

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

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

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

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

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

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

removed from the repository based on this setting. Note that any positive number you enter will automatically be reflected in the Until box below. l l l Time zone: When you enter a number of days in the For box or a date in the Until box above, the computer’s time zone appears in this box. You may select a different time zone if required.
PAGE 501

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

l l l l Field Name: Name of the field as set in SharePoint Document Library. Field Information: The information to enter in the SharePoint Document's Metadata for this field. Use PDF/A: Check to use the information contained within an PDF. This PDF must have been created with PlanetPress Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library.
PAGE 503

l l l Domain: The active directory domain for the log-on credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries. Password: The correct password for the user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 504

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 505

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 506

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 507

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 508

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 509

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 510

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 511

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 512

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 513

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 514

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 515

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 516

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 299. 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 517

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 518

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 519

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 520

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 521

For general information on the Plugin, see "ZUGFeRD" on page 748. 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 522

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 523

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 524

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 525

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 526

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 527

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 528

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 529

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 530

page 537 or "Find Capture Documents" on page 543 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 531

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 532

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 533

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 534

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 535

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 536

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 537

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 538

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 539

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 139).
PAGE 540

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 541

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 542

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 543

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 544

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 545

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

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 547

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 548

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 549

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 550

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 551

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 74.
PAGE 552

l "Example: Daily sales report from PDF files" on page 284 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 59).
PAGE 553

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 554

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 555

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 556

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 557

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

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 559

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 560

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 561

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 562

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 859 page for more details.
PAGE 563

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 564

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 565

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 74. Input This task can use any data file, as long as it is accompanied by metadata.
PAGE 566

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 567

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 568

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 569

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 570

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 571

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 572

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 573

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 574

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 575

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 576

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 577

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 578

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 579

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 580

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 581

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 582

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 583

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

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

with a backslash (\\, \") if the JSON string is passed via a global, local, or Job Info variable. If the JSON is entered directly in the runtime parameter field, the plugin adds the necessary backslashes. l Filter: Retrieves records from the Connect Database. This is identical to using the "Retrieve Items" on page 635 task. l Filter type: Determines at which level to retrieve the records: l l l l l l l l l Record Set: Retrieves one or more Record Sets, including all their records.
PAGE 586

the sorting method, click on the [...] button at the right of the box to open the "Sort Parameters" on page 590 dialog. l l Metadata: Uses existing Metadata, generally the output of a "Execute Data Mapping" on page 618 or a "Retrieve Items" on page 635 task set to retrieve Records or Record Sets. This source has no options as it expects valid Metadata. PDF/VT with Content Creation: Expects a PDF/VT file as an input and executes basic data mapping on the file.
PAGE 587

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

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). o Dates should be in an ISO8601 compatible format (e.
PAGE 589

l l 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\Administrator\Connect\filestore\3836.2859982401376467470\template_ 0001.pdf,C:\Users\Administrator\Connect\filestore\3836.2859982401376467470\
PAGE 590

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 635 task, or the Filter source in the "All In One" on page 582'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 591

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

Output Within the Workflow process, the output to this task is only modified metadata indicating that the task is complete. It is the Server component that outputs the emails themselves and sends them to each recipient. 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.
PAGE 593

the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data.) Warning The JSON format is not validated by the plugin; it is passed as is to the server. l Runtime Parameters: The runtime parameters defined in the selected template are displayed and their values can be set here.
PAGE 594

l l l l l Mail host: Enter the address of the SMTP server through which emails should be routed. The address can include a port number. This information should be available from your IT staff. Send emails to sender (test mode): Check to ignore the email address from each record and send all emails to the address entered in the Sender Address field instead. Precedence to template address: If the sender's address is given in the template, that address gets precedence over the one specified here.
PAGE 595

l l User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Job The Create Job action task prepares a series of print content items for output generation.
PAGE 596

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 598 task for printing. Task properties General Tab l Job Preset file: Select which Job Preset to use to generate the job.
PAGE 597

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). o Dates should be in an ISO8601 compatible format (e.g. 2019-10-15) or use the current Windows Locale date settings options.
PAGE 598

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. 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 373) or as an Output task (see "Output tasks" on page 643).
PAGE 599

Output Depending on the options set, either a simple metadata file with information about processing is returned, or the actual output file created by the server. Properties The Create Output task properties are as follows: General Tab l Output Preset file: Select which Output Preset to use to generate the output. To be used in this dialog, a preset must have been sent to PlanetPress Workflow using the Package File function in PlanetPress Connect.
PAGE 600

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 774. 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 601

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

To make the rendering process as fast as possible, the generated PDF isn't optimized for print production purposes. Note Content creation may be aborted by a script in a Connect template that raises a fatal error. This triggers the On Error tab of the Content Creation task. See Designer Script API.
PAGE 603

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

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

If on the Datamapper tab, the source has been set to Metadata or JSON, the following option is also available. Runtime Parameters: The runtime parameters defined in the selected template are displayed and their values can be set here. (See Runtime parameters in the Online Help of OL Connect.) Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 52).
PAGE 606

Note It is not currently possible to specify Runtime parameters on the Content Creation tab if, on the Datamapper tab, the source has been set to "Data mapping configuration". There is, however, an easy workaround: insert an Execute Data Mapping task immediately before the Create Preview PDF task, configure it to output either Metadata or JSON and adjust the settings on the Datamapper tab of the Create Preview PDF task accordingly.
PAGE 607

Tip Drag-and-drop a template from the Connect resources in the Configuration Components pane on a process to add this task or one of the other OL Connect tasks that create content from a template: a "Create Email Content" on page 590 task, a "Create Preview PDF" on page 601 task, or a "Create Web Content" on page 611 task. Input This task can receive either Metadata containing information regarding a valid Record Set, or JSON data, or a PDF/VT File (see "Create PDF/VT" on page 600).
PAGE 608

create a record set based on the provided data, like the "Execute Data Mapping" on page 618 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). For each record or JSON object, one or more pages are generated using the record's data and these pages are saved as a content item in the database.
PAGE 609

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 a template to the resources is done through the Send to Workflow option in the Designer Module.
PAGE 610

will be raised. Note that it is not possible to change a parameter's type here; that can only be set in the template itself. At runtime, Workflow passes the parameter values as strings, and the type defined in the template will be used to try and parse the input parameter value. In order to make this work: Boolean values need to be entered as either “true” or “false”. (When the comparison actually occurs, it will be a full Boolean comparison.
PAGE 611

Create Web Content The Create Web Content task generates the output of the Web Context of a specified template for a single record and returns the HTML code to PlanetPress Workflow for further processing and return to the requester. Generally, this task is placed within an "HTTP Server workflow" on page 275. This task can be added as an Action task (see "Action tasks" on page 373) or as an Output task (see "Output tasks" on page 643).
PAGE 612

Items" on page 635 task is set to output Records in JSON, it outputs this kind of JSON data. If the input is JSON data, the task makes a call to the REST workflow/contentcreation/html/ {templateId} endpoint on the Connect Server. For more information see the REST API Cookbook. Note that only the first JSON object is processed, as the endpoint generates HTML output for a single record. Processing For a single record, this task generates the output for the Web Context of the specified template.
PAGE 613

l l Section: Enter the section name that will generate output. Only one section can be output. If no section is defined or if the section name is invalid, the default section will be output. Data Source (see "Input" on page 611): l Record ID: l l l Enter a valid Record ID, or 0 to provide no data. The record must be valid for the template used. By default, the record ID is pre-filled with the first record in the metadata.
PAGE 614

l l Embed all resources: Check this option to download the resources and embed them in the HTML file. Do not alter HTML: Check this option to prevent that the Create Web Content task modifies the HTML. It is recommended to use this option if the template's resources are all hosted outside of the template (for instance, on a CMS repository). Note By default, the Create Web Content task inserts a meta tag in the generated HTML, specifying a default URL and target for all links on the web page.
PAGE 615

values need to be parseable as a number (either a whole integer or decimal value). Dates should be in an ISO8601 compatible format (e.g. 2019-10-15) or use the current Windows Locale date settings options. The latter is not recommended as it requires all computers in the cluster have the same locale data format. 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 616

As an alternative to the Download EML Messages task you could use the "File Store Download File" on page 623 task to download an EML file from the File Store. In that case you need the folder ID and EML file name found in the output of the "Render Email Content" on page 630 task. This information can be retrieved from the Metadata using the following data selection methods: GetMeta(_vger_prop_folder[0], 10, Job.Group[0].Document[0]) GetMeta(_vger_prop_eml[0], 10, Job.Group[0].Document[0]).
PAGE 617

Note Make sure that other components in the Workflow configuration working on the job data handle UTF-8 encoded files correctly. 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 630. Output The task outputs the EML file as the Job File. The Metadata are unchanged.
PAGE 618

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. Execute Data Mapping The Execute Data Mapping action task generates a record set by executing a data mapping configuration on a data source.
PAGE 619

If the data mapping configuration expects a database data source, the Data Source option is ignored and the database is accessed instead. If a PDF/VT file is used, the data mapping configuration option is optional - if one is present, it must be able to read the PDF/VT. Output The output to this task is twofold. On the OL Connect Server side, a Record Set containing multiple records is created and saved.
PAGE 620

l l l l Metadata: Select to output the full Record table (no Details table) as Metadata in the task. It is then possible to sort and filter the Metadata using the regular Metadata tools, as long as the Update Records from Metadata option is used in further tasks to use the modified Metadata. XML: Select to output an XML structure containing the full Record Set including all detail tables. This option cannot be used with other OL Connect tasks.
PAGE 621

is greater than 0, immediately after the task (see "Conditions" on page 135). l Runtime Parameters: Runtime parameters pass information from the Workflow process to the data mapping configuration (see Properties and runtime parameters in the Online Help of OL Connect). Set the source of the value for any runtime parameters that are defined in the selected data mapping configuration.
PAGE 622

l l User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Store - Delete File The File Store - Delete File task deletes a file from the OL Connect File Store, using either a file name or File Store ID.
PAGE 623

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 774. 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 624

Output The downloaded file becomes the current job file and retains the file name that it had in the OL Connect File Store. Task properties General Tab l Filename or File Store ID: Enter the name of the file in the OL Connect File Store or its File Store ID. A File Store ID refers to a file or folder in the File Store. 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 625

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

Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 627

Task properties General Tab l Set types to mark for deletion based on metadata content: l l l Job Set: Tag any Job set created by the "Create Job" on page 595 task or the "Retrieve Items" on page 635 task set to retrieve Job Sets. Content Set: Tag any Content set created by the "Create Print Content" on page 606 task or the "Retrieve Items" on page 635 task set to retrieve Content Sets.
PAGE 628

Merge Jobs The Merge Jobs Action task merges an external Metadata file containing an OL Connect Job with the current Job File. Input The task must receive a Metadata Job File, which is output from the "Create Job" on page 595 task. The selected Metadata file must also be the output of a Create Job task. Processing The current Metadata Job File is merged with the selected external Metadata file. Output The task outputs a merged Metadata Job File which can be used in the "Create Output" on page 598 task.
PAGE 629

Processing The PDF to Bitmap plugin converts PDF pages to bitmaps, optionally scaling them. Invalid pages or ranges generate an error; in this case, no bitmap is produced. If the specified output folder doesn't exist, it will be created. If the folder cannot be created, an "Error creating directory" message is logged. If the plugin can't connect to the OL Connect Server it will return an error message. Note As of OL Connect version 2020.
PAGE 630

Example: 1, 7-10, 13, 15- means the task will convert pages 1, 7, 8, 9, 10, 13, and 15 until the end of the file. l Output folder and file name: Specify where the bitmaps are saved; %t%O means: save the bitmaps to the current temporary folder, using the PDF's original file name. If no extension is specified, the selected output format is used to add the extension automatically. When multiple pages are saved, the index of each page is appended to the output file name (e.g. mybitmap1.jpg, mybitmap2,jpg, etc.
PAGE 631

licensed for sending emails. It is not available for users with Demo, Test or Reseller licenses. Note For the Render Email Content task in PlanetPress Workflow 2020.1 to function correctly, the version 2020.1 SendGrid and Mailjet plugins are required. They are available for download on the Resource Center (help.objectiflune.com). Input This task must receive either Metadata containing information regarding a valid Record Set, or JSON data.
PAGE 632

Items" on page 635 task is set to output Records in JSON, it outputs this kind of JSON data. If the input is JSON, the task performs a REST call to the /rest/serverengine/workflow/contentcreation/email/{templateId} endpoint on the Connect Server. For more information see the REST API Cookbook. The Render Email Content task expects UTF-8 encoded JSON job data files. Note Make sure that other components in the Workflow configuration working on the job data handle UTF-8 encoded files correctly.
PAGE 633

Output The output of this task is twofold. On the OL Connect Server's side, pre-rendered email messages are saved in the OL Connect File Store along with their attachments (and, optionally, also in EML format). On Workflow's side, information about the pre-rendered email messages become available to the process via the current Metadata or via a JSON data structure that replaces the active Job File. Here is an example of the JSON structure. In this case there's only one email message in the Content Set.
PAGE 634

l Data Source (see "Input" on page 631): l l Metadata: The Metadata must contain information regarding a valid Record Set, or JSON data. This can be the output of the "Execute Data Mapping" on page 618 task or "Retrieve Items" on the facing page task. JSON String: a JSON object or an array of JSON objects representing records (see "JSON string examples" on page 90) or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 92).
PAGE 635

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

Output The task outputs Metadata that is equivalent to the output of the appropriate task that would normally create the items, or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 92). Note The result of a Retrieve Items task can be used with the "Create Job" on page 595 task if it is a Content Item or Content Set, but it cannot be used in combination with a Job Preset. Note Content Creation tasks accept Metadata as well as JSON data as input.
PAGE 637

l Retrieve by: l l l l l l l l l ID: Depending on the option selected under Entity to retrieve this is a Record ID, Record Set ID, Content Item ID, Content Set ID, Job ID or Job Set ID. IDs can be entered directly; when entering multiple IDs, put each on a new line. Alternatively, they can be passed via variables (see "Variable task properties" on page 299), or as a JSON array, e.g. [6001,6002,6003]. A JSON array may contain variables, e.g. [%1, 75001].
PAGE 638

the same mail piece, which presumably could be added within the same envelope. Batching is the same principle when all the Print Content Items are generated using the same Template file. This tab is only available if the Content Item option is selected in the General tab's Entity to retrieve drop-down. To modify any of the following options, click in the Parameters box and then click the [...] button that appears. l Document contents: Defines the Document ("Mail Piece") level and how they are built.
PAGE 639

l l User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
PAGE 640

Processing The task sets the chosen properties to all entities present in the Metadata. These properties are added to the entities on the OL Connect Server. Note that the properties are calculated only once, and are applied identically to all entities. If each entity should have different properties (such as record-level properties), the Metadata should be split using the "Metadata Sequencer" on page 562 task first. Output The task outputs Metadata that is identical to the input Metadata.
PAGE 641

Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
PAGE 642

Output The Job File is not changed by this task. Task properties General Tab l Update Source: Select the data source from which the records in the Connect database will be updated. l l Metadata: Select this option to use the current content of the Metadata. JSON: Enter a JSON string, or a variable containing JSON. (See "Variable task properties" on page 299.) The task expects a JSON Record Data List; see: "Types of JSON in Workflow" on page 90.
PAGE 643

Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Output tasks Output tasks are exits from PlanetPress Workflow processes. They can be used to send data to specific devices, such as printers, applications, such as email software, or locations, such as folders. A single process can include multiple branches, each one terminated by an Output task, and so a single process may generate output via a variety of Output tasks.
PAGE 644

l "PlanetPress Image" on page 504 l "Print using a Windows driver" on page 656 l "Printer Queue Output" on page 658 l "Secure Email Output" on page 661 l "Send Email" on page 664 l "Send to Folder" on page 668 l "SOAP Client plugin" on page 654 The SFTP Output task also appears in the Output category when it is installed. (It isn't installed by default.) Delete Delete output tasks simply delete the job files they receive.
PAGE 645

Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. FTP Output FTP Output tasks send job files to other computers using the FTP protocol. It is similar to the Sent To Folder output task but sends to an FTP connection instead of a local drive. The following describes the properties specific to FTP Output tasks.
PAGE 646

l l l l Password: Enter a password associated with the FTP server user name entered above. 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 647

Input Any data file. Processing The task uses the Microsoft Graph API to access accounts in the organization (subject to that organization's IT policies). 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.
PAGE 648

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

Attachments Use this tab to specify what files to attach to the e-mail. l l l l Attach input job file: Select to attach the current job file to the email that the task sends. Rename to: Check this option to rename the job file before attaching it to the email, and enter a name. File: Select additional or more additional files to include as attachments. Enter the file name, or use the Browse button to navigate and select the file.
PAGE 650

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

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 299. 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 299.
PAGE 652

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 362 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 653

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 654

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 655

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 656

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 657

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 658

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 659

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 59) 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 660

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 661

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 662

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 663

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 664

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 299. 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 665

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 666

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 667

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 668

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 669

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 690 l "Output to SharePoint" on page 693 The following plugins are not initially installed with Workflow but they are available for download on the Resource Center (help.objectiflune.com).
PAGE 670

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 671

If any issue is detected during a file download, the log messages and the related file and its index values will be stored. Warning The plugin is not designed to be run in multi-threaded, multi-process or auto-replicate environments. It has not been designed for parallellization in regards to internal resource usage, file and data access, or logged-on users. Output The output of this task - the Job File - is either the downloaded file, or the document index data in XML or JSON format.
PAGE 672

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. It is the user's responsibility to protect the passwords in such cases.
PAGE 673

Download tab The Download tab provides the controls for defining the file to be Downloaded, included related index values. The plugin window is expandable, which helps to display all the information at once when field names are quite long. Note You can use static text and/or Workflow variables, data and lookup functions in all of the fields on this tab. Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 52).
PAGE 674

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

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

To be able to use this plugin you need a working DocuWare installation and user account with appropriate permissions. Input The input of this plugin can be a file of any type. Processing After establishing a connection with the DocuWare system, the plugin will try to upload the specified file (either the Job File, or an external file) with the given index values to the selected File Cabinet. The plugin won't modify the uploading file in any way.
PAGE 677

Right-clicking a field opens the contextual menu that allows to add variables, data and lookup functions (see "Data selections" on page 52), where available. DocuWare Server Enter the DocuWare Host address. For example https://mycompany.docuware.cloud Organization Enter registered Organization name. For example MyCompany Platform Enter the DocuWare platform. For example docuware/platform Username Enter the DocuWare login Username.
PAGE 678

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

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

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

) or Remove ( ) individual entries, as well as move them up ( ) or down ( ) within the table. At any point you can verify the accuracy of the selected Index options by selecting the Validate ( ) button. Index entries that are duplicated appear in orange text, and index entries that do not match available options appear in red. Note The Document name field entry will appear in italics in the table. All index values must be entered in a unified format.
PAGE 682

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

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

be downloaded separately. The response that the plugin gets from the M-Files Server is then stored in a variable (if specified). Task properties All of the task's General properties are dynamic. 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). Connection Tab The plugin needs your M-Files Server's credentials and a Vault name in order to start communicating with the M-Files erver.
PAGE 685

specific properties (Definition entries). Enter the properties under Index data. l l Field: The property to search for. Enter a property, or click the button between the Field and Value columns to select one of the properties defined for this particular Document Class in the Metadata Structure of the Vault on the M-Files server. Value: The value to search for. Use the Index data buttons to: l l l l , Add and removeproperties. , Change the order of the properties by moving them up or down.
PAGE 686

XML/JSON output file includes a URL to the document so that it can be downloaded separately. In the Response variable field you can enter the Workflow variable in which the file name or status information should be stored. (Right-click and select Variables > Local variables > yourvariable.) This is optional. If the variable exists, it will be used. The M-Files plugin searches for the variable by name and sets the selected response into the variable.
PAGE 687

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

send a login request to the M-Files Server. The user should have the appropriate rights. l Test Connection: Click this button to establish a connection with the M-Files Server and retrieve the Document Classes of the selected Vault. This information is used on the Upload tab. Upload Tab l File to upload: l l l l Job file: Click this option to upload the current Job File (see "Job file" on page 50). External file: Click this option to upload an external file. Specify a full file name.
PAGE 689

Note The plugin will fail if a required property is missing from the Index data, or if the Index data contains a property that does not exist for the chosen Class. Use the Index data buttons to: l l l l l Add and remove properties. Change the order of the properties by moving them up or down. This is for convenience only; to the M-Files Server, this order is not important. Validate properties and check for duplicates.
PAGE 690

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

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 692

Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted. Domain: The active directory domain for the logon credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries.
PAGE 693

Output to SharePoint The Output to SharePoint action task can be used to send files to an existing Microsoft SharePoint server. This task is put into effect in the following use cases and example processes: l Capture Post Processing Workflow Note that Capture is only available with PlanetPress Suite. Input Any data file, with optional Metadata. Processing The task connects to the selected Document store and uploads the current data file.
PAGE 694

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

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

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

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

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

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

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

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

id, x-sg-eid, received, dkim-signature, Content-Type, ContentTransfer-Encoding, To, From, Subject, Reply-To, CC, BCC. l Debug settings: l l Send all messages to the Test Address: When this option is checked, SendGrid will only send the emails to the given Test Address. This allows you to review the result and to test ESP specific options like open rates and click through statistics. Log email messages: Check this option to get a copy of each message in the Messages window of Workflow.
PAGE 703

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

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

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

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

Variable Name Example value when interpreted (short text) %h Current hour 18 %n Current minute 03 %r Run mode (0: runtime, 1:debug) 0 %s Current second 41 %v Current millisecond 24 %u Unique 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.
PAGE 708

Variable Name Example value when interpreted xxxx-xxxxxxxxxxxxxxxxxxxx (8-4-4-4-12 characters). %t Current temporary folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool\6.tmp\ %e Current Metadata file name job00ZAIZ2C4FXON16CE6C566.dat.meta %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.
PAGE 709

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 710

Variable Name {error.process} % {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 711

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

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

2. Click Global Variable in the Variables group. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To set the value of a global variable from the Configuration Components pane: 1. Double-click on the global variable in the Configuration Components pane. (Rightclicking then clicking Properties also works.) 2. Enter the new value for your global variable. 3. Click OK to save the new value.
PAGE 714

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

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

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

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 718

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

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

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

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

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

l l Also in MySQL, if a timeout occurs on simultaneous record access, resubmitting the PGC for processing should resolve the issue. In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue. Security Considerations PlanetPress Capture introduces new and efficient methods for digitally capturing the contents of ink laded out on physical paper.
PAGE 724

document of their choice. It is always better to secure this folder properly. You could also use third-party encryption software to secure the files, and decrypt them as necessary for reprocessing. l l l l The transfer between the Anoto penDirector and PlanetPress Workflow is not encrypted due to a limitation of penDirector which does not support SSL connections.
PAGE 725

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

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

"tag" that is added after the pattern's identification (Pattern ID). When a Pattern Sequence is used, each Pattern Sequence can re-use each of the 20,000 available patterns. "Zones", in this case, could refer to a specific region within a city, or a whole city or a province, whatever fits your needs. Pattern Sequences can be handled in 2 different ways: by attaching a Pattern Sequence to a specific pen, or by attaching it to a specific PlanetPress Workflow process.
PAGE 728

Note The mobile phone application, "PlanetPress Mobile", which uses Bluetooth communication to receive pen data and transmit it to PlanetPress Workflow, can still be used with both pattern sequence methods, as it is the equivalent of a docking station on the web. PlanetPress Mobile was added to PlanetPress Capture in version 7.4. Contamination The single but critical danger with any implementation that deals with PlanetPress Capture is "Contamination".
PAGE 729

Third, contamination (the most common one) can happen if pattern sequences get mixed up, if pens or paper gets swapped between users, etc. For example, again using a shipping company (with example 2-A), if two of the drivers were to meet for a coffee and exchange their pens inadvertently (we hope, anyways), the pens would be signing the "wrong" documents all day and, when docked, would update the wrong documents in the database.
PAGE 730

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

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

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

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

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 735

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 736

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 737

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 738

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 739

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 740

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 741

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 742

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 743

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 744

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 745

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 746

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 747

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 748

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 294. OL Connect Send tasks l "Get Data" on page 568 l "Get Job Data" on page 573 l "Job Processor" on page 577 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 749

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 520. Plugin Legal Notices and Acknowledgments Copyright © 2020, 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 750

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 753. 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 751

PlanetPress Image can generate PDFs or images and dispatch them from the host on which it runs. See "About PlanetPress Image" on page 746. 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 752

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 753

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 754

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 755

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 756

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 757

l "Telnet Input plugin preferences" on page 792 l "PlanetPress Fax plugin preferences" on page 793 l "FTP Output Service preferences" on page 796 l "PlanetPress Image preferences" on page 797 l "LPR Output preferences" on page 800 l "PrintShop Web Connect Service preferences" on page 802 Note Preferences are saved automatically and applied immediately.
PAGE 758

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 759

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 760

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 761

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 762

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 763

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 764

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 765

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 766

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 767

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 768

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 769

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 765.
PAGE 770

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 771

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 772

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 773

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 774

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 775

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 776

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 777

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 778

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 779

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 780

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 786.
PAGE 781

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 782

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 783

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 784

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 785

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 786

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 787

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 788

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 789

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 790

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 791

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 792

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 793

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 794

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 795

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 796

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 797

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 798

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 799

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 800

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 801

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 802

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 803

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 804

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 805

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 806

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 807

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 817. l " The Quick Access Toolbar" on page 878. This toolbar is customizable. l The ribbon tabs; see "The PlanetPress Workflow Ribbon" on page 879. l "The Process area" on page 870 l "Configuration Components pane" on page 818.
PAGE 808

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 809

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 810

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 811

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 812

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 813

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 814

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

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 816

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 817

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 818

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 819

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 820

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 821

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 822

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 823

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 824

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 825

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 826

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 827

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 828

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 829

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

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 831

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 832

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 833

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 834

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 835

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 836

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 837

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 838

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 839

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 840

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 841

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 842

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 843

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 844

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

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 846

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 847

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 848

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 849

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 850

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 851

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 852

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 853

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 854

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 855

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 778. 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 856

l Week of month / by date: Select the desired option for the time grid. Note that any selection you make in this box will be interpreted based on the selection made in the Month box. If you chose All months in the Month box and Last in the Week of month / by date box, then the process will run on the last week of every month. If you chose January in the Month box and First in the Week of month / by date box, then the process will run only on the first week of January.
PAGE 857

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 858

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 859

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 860

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 861

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 862

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 863

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 864

Virtual Drive Manager When you use the "Send Images to Printer" on page 430 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 865

l l Global Variables: Displays all the variables global to this configuration (see "Local variables" on page 710). 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 714). To add a new expression, simply rightclick in the window and select Add Expression.
PAGE 866

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 867

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 868

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 869

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 870

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 296). 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 871

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 872

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 873

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 757).
PAGE 874

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 871.
PAGE 875

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 876

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 297.
PAGE 877

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 878

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 879

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 880

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 43). 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 881

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 831, 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 882

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 883

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 884

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 885

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 886

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

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 888

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 889

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 890

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 891

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 892

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 893

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-2020 Objectif Lune Inc. All Rights Reserved.
PAGE 894