User Guide Version: 2019.
User Guide Version 2019.2 Last Revision: 2021-05-06 Objectif Lune, Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 +1 (514) 875-5863 www.objectiflune.com All trademarks displayed are the property of their respective owners. © Objectif Lune, Inc. 1994-2021. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc. Inc. Objectif Lune Inc. Inc.
Table of Contents Table of Contents 4 Welcome to PReS Workflow 2019.
About Workflow Configurations Creating a new configuration Open a PReS Workflow configuration file Saving and sending a Workflow Configuration Exit PReS Workflow Configuration program Workflow Configuration resource files Connect resources PlanetPress Design documents PrintShop Mail documents About data About documents and variable data Job file Job file names and output file names Data selections About data emulation Sample Data Metadata Working with JSON Data Repository Structure Accessing the Data Reposi
Send to Folder printer queue Load balancing Associating PlanetPress Design documents and PReS printer queues Triggers Objectif Lune Printer Driver (PS) About processes and subprocesses Processes Startup processes Subprocesses Creating a process Importing processes Activating or deactivating a process Process properties About branches and conditions Converting a branch to a subprocess Running a process on desktop Saving and sending a Workflow Configuration Using Scripts Run Script task APIs The Script Editor
Clear() Copy() Cut() DatapageCount() Delete() DocumentCount() FieldByIndex(Integer Index) FieldByName(const String Name) FieldByNameIndex(const String Name, Integer Index) IndexInDocument() IndexInGroup() IndexInJob() Item(Integer Index) PageCount() Paste() PasteAt(Integer Index) Select(TSelectWhat SelectWhat) SelectedDatapageCount() SelectedDocumentCount() SelectedIndexInDocument() SelectedIndexInGroup() SelectedIndexInJob() SelectedPageCount() Sort(const String Name, optional TSortFlags Flags, optional co
Returns Parameters Returns Exceptions Parameters Returns Exceptions AlambicEdit API reference Stopping execution Special workflow types HTTP Server workflow PDF Workflow PlanetPress Capture Workflow Database considerations (ODBC) 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
Connection tab Upload tab Advanced properties Advanced properties Email Services Unknown tasks About variables Job Info variables System variables Local variables Global variables Variable task properties Workflow add-ons PlanetPress Capture Capture OnTheGo (COTG) About PReS Fax About PReS Image OL Connect Send ZUGFeRD About related programs and services Available Input services Available Output services Start and stop PReS Workflow Service Users and configurations Workflow Services Preferences Other prefer
Network behavior preferences Preferences PlanetPress Capture preferences PlanetPress Capture Server/Client PlanetPress Document Manager PlanetPress Capture ODBC Settings PlanetPress Capture Pen Management Tool PlanetPress Capture License Management OL Connect preferences PDF text extraction tolerance factors General and logging preferences Messenger plugin preferences Preferences HTTP Server Input plugin preferences 1 Preferences HTTP Server Input plugin preferences 2 LPD Input plugin preferences Preference
Dock and undock areas of the Program Window Show or hide areas of the program window Combine and attach areas Resize the program window areas Change the Interface language PReS Workflow Button Options Configuration Components pane Components Area Sections Process properties 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
The Object Inspector pane Editing properties The Plug-in Bar Categories Settings and customization The Process area Cutting, copying and pasting tasks and branches Highlight a task or branch Disabling tasks and branches Moving a task or branch using drag-and-drop Redo a command Removing tasks or branches Replacing tasks, conditions or branches Resize the rows and columns of the Process area Collapse and expand branches and conditions Undo a command Zoom in or out within the Process Area The Quick Access Too
Welcome to PReS Workflow 2019.2 This PDF documentation covers version 2019.2. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow is the heart of all of our solutions. Working in conjunction with PReS Connect, PReS Capture, CaptureOnTheGO, PReS Imaging, PReS Fax, and a variety of plugins, it helps improve your communications processes.
Warning Information that is potentially critical to using PReS Workflow.
Installation and setup This chapter describes the different considerations that are important in regards to the installation and use of PReS Workflow. l "System Requirements" below l "Environment considerations" on page 18 l "Setting up the working environment" on page 21 l "Known Issues" on page 25 System Requirements These are the recommended system requirements for PReS Workflow 2019.2.
l l VMWare Environments. This includes VMWare Player, VMWare Workstation as well as VMWare ESX Server. VMWare VMotion. This means the virtual machine hosting PReS Workflow can be automatically moved from one ESX server to another in a clustered installation. l Microsoft Hyper-V/Azure infrastructure environments. l Amazon Web Services (AWS) PReS Workflow is not officially supported on any other virtual machines such as Virtual PC, Parallels, Bochs, Xen, etc.
Recommended hardware requirements Due to its versatility, OL Connect is used for a wide variety of applications. Consequently, it is difficult to determine which hardware configuration will produce the best results for any given implementation. The following specs should therefore be viewed as a general guideline that is most likely to produce expected results for most implementations. You should, however, keep in mind that it may not represent the optimal setup for your particular application.
Environment considerations This page is intended to provide technical information about the environment in which PReS Workflow is intended to run. Terminal Services PReS Workflow does not support Terminal Services environment as possible under Windows 2000, 2003 and 2008. This is to say, if Terminal Services is installed on the server where PReS Workflow is located, unexpected behaviors may occur and will not be supported by our company.
fine (they are properly detected by PlanetPress Suite 7.5.1 and higher) we have not tested them and cannot offer support for them. Warning The PReS Workflow End-User License Agreement (EULA) specifies that a PReS Workflow software license may only be used on a single virtual or physical PC at a time. While copying a virtual machine for backup purposes is acceptable, running two instances of the same machine, using the same serial number, is strictly prohibited.
Warning Disabling any antivirus scanning permanently on any folder or program is not recommended, and Objectif Lune cannot be held reliable for any consequence of disabling your antivirus or whitelisting the folders or executables listed here, or any other change in your antivirus protection setup! l On Windows 7/2008: l l l l C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\ C:\Users\planetpress\AppData\Local\Temp\ (where planetpress is the user under which Workflow is configured) C:\Users\planetpr
l TelnetService.exe l ppNode.exe l PPFaxService.exe l PPImageService.exe l MessengerService.exe Backup considerations For similar reasons, it is important to know that backup software can also access files while copying them to a remote backup location, so you should make sure that no PReS Workflow process is working during your backups. Microsoft Office compatibility The Microsoft Office 2010 line of products, other than Pro and Enterprise, has not been certified for use with PReS Workflow.
Network considerations While PReS Workflow is typically installed on a server machine that is only accessed by one single user such as an IT person, multiple users logging on to that machine is a possibility (except with terminal servers, see "Environment considerations" on page 18). Because each user may have different local and network rights, it may be important to consider the implications in regards to PReS Workflow. To change the service log on information, see "Workflow Services" on page 909.
Workflow services when running a live configuration. Furthermore, while the mapped drives are not shared, they are still limited to one map per computer, meaning if one user maps the X: drive, a different user (or a service) will not be able to map it again.
Component Protocol Local Port Remote Port FTP Input TCP Default1 21 Telnet Input TCP Default1 9100 (configurable) FTP Output TCP Default1 21 Email Output (SMTP mode) TCP Default1 25 Email Output (Outlook mode) TCP See Email Input (Outlook mode) See Email Input (Outlook mode) Send to Folder Windows Queue Output TCP Default1 Standard Windows file and printer sharing ports2: l l 137, 138 and/or 139 (NetBIOS over TCP/IP (NetBT)) 445 (SMB Over TCP/IP) LPR Output TCP Default or 721
3 If the “No source port range restriction” option is checked (recommended), see footnote a. If the option is unchecked, the local port will be chosen from a range going from 721 to 731. 4 Contact your DBMS vendor to determine which ports are used by the ODBC driver for accessing a network database.
Workarounds l l For the Lookup in Microsoft Excel Documents plugin (found in the Connectors tab of the plugin bar): Open the original .xls file and save it with the .xlsx format. That will force the Excel Lookup plugin to switch drivers. For the Database Query plugin (found in the Actions tab of the plugin bar) and when using Excel/Access in PlanetPress Design: Change the ODBC driver used for Excel files from JET to ACE (change the Data Source).
documented issue in those two Operating Systems. Microsoft has provided no reason nor workaround for the problem, therefore PReS Workflow cannot circumvent the issue. l l l l l l l l l Under Windows 2000, the SharePoint output task does not work with SharePoint 2010. Under the same OS, the PlanetPress Capture ICR does not work due to the .NET 3.5 requirement. 21465: The SharePoint Output task does not validate the field contents. That's Sharepoint's responsibility.
Version 8. To circumvent the issue, open the output task's properties, make sure you reselect the proper printer, close the task and send the configuration again. l l The HTTP/SOAP service may fail when both it and the Workflow service are logged on using 2 non-local users or 2 local users with different privileges. To resolve the issue, make sure both services use the same logon credentials.
configuration to the service. Make sure you send the configuration before exiting from the Configuration tool. l l l 13009: With Outlook 2010, the Send Email functionality requires that the service be run with administrative credentials in the domain. In addition, both Outlook and the PReS Workflow Configuration tool must *not* be running while the service is. The Microsoft Office 2010/2013/2016 and 365 line of products has not been certified for use with PReS Workflow.
PReS Fax can associate a different fax number with each page it sends via the faxing software. For this to happen, two things are required: each record must have a fax number specified in the job file and that fax number must be tagged as such in PlanetPress Design (in the PlanetPress Design User Guide, refer to the section documenting Data Selections, which includes explanations on the available PReS Fax options).
Note The minimum time required to generate a PReS Image document is approximately 10 times longer on Windows 2000 than on Windows XP/2003. Preferences In addition to the job-specific PReS Image properties that you configure in the task’s Properties dialog box, there are configurable options common to all PReS Image Outputs processed by a given computer; see "PReS Image preferences" on page 833. Note that those options are specific to each PReS Image installation and that they are immediately applied.
Basics PReS Workflow is a tool to automate the processing, distribution and printing of your business documents. Once installed on the server, it can be set up to automate all tasks related to document processing (see "Setting up the working environment" on page 21). When you're all set up, you can start using the Workflow Configuration tool, assuming that you have already done research on the processes that need to be automated. Working with Workflow implies the following basic steps: 1.
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 40). They become visible in the "Configuration Components pane" on page 855.
Features PReS Workflow configurations are input driven applications designed to output data in a variety of ways through diverse means to various applications and devices. PReS Workflow can be used as simple go between, passing along input data to output devices, but it can also perform various types of data processing. You can combine the various PReS Workflow services to set up versatile automated processes to print jobs as well as generate other types of output.
versatile automated processes to print jobs as well as generate other types of output (emails, web pages, files...). Note A PReS Workflow configuration must be composed of at least one process, but it may include as many as 512. PReS Workflow cannot work without a valid configuration, and a PReS Workflow session running on a given computer can only use one configuration at a time.
By default, when you create a new configuration, PReS Workflow automatically creates a process that includes a "Folder Capture" on page 354 initial input task and a "Send to Folder" on page 692 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 797).
Saving and sending a Workflow Configuration The core of the PReS Suite workflow tools is the PReS Watch service which, once started, constantly runs in the background to perform the tasks included in its current configuration file. The PReS Workflow Configuration tool lets you create, edit, save and send configuration files. As you are working on your configuration, you can save that configuration file as a file on your local hard drive.
Workflow when it is started. To change any currently active configuration, you must use the Send Configuration command. When you use the Send command, the PReS Workflow Configuration program uses the currently opened configuration (Any_name.OL-workflow) to overwrite the PReS Workflow Service's current configuration (ppwatch.cfg). Note .OL-workflow files are equivalent to .pp7 files made with older versions of PReS Workflow. They contain the processes and such used by Workflow.
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 872. Note If PReS Workflow service is paused when you send a new configuration, it will not stop and restart.
If the default configuration does not include any active process, the PReS Workflow Configuration program asks you whether to continue. If a file different from the default configuration file is currently opened, and if it includes unsaved modifications, the PReS Workflow Configuration program asks you whether to save the configuration before exiting. Select the Always save without prompting for confirmation option to automatically save any unsaved work before exiting.
them: l l Data Model: Displays the data model used in the data mapping configuration. Double-click on the data model to view it in your default XML viewer (generally, Internet Explorer). Sample Data File(s): Displays a list of sample files that are included in the data mapping configuration. (See also: "Sample Data" on page 71.) Tip Double-click on a sample data file to use it as a sample data file for the active process.
1. Click the PReS Workflow button. 2. Choose Import, then Import Connect Content. The Import dialog box appears. 3. In the File type box, select the desired file type. 4. Navigate to the document you want to import, select it and click Open. When you select a package file, the individual resources contained within that package will be imported. Tip You can import multiple files at once.
Resource archives From version 8.2, PReS Workflow maintains an archive of previous versions of resources, in the following location: %PROGRAMDATA%\Objectif Lune\PReS Workflow 8\PReS Watch\OLConnect\Archive , each in their own folder: l datamapper contains archives of the data mapping configurations (.OL-datamapper) l jobcreation contains archives of the Job Presets (.OL-jobpreset) l outputcreation contains archives of the Output Presets (.
1. Make sure the Connect Resources section is visible by clicking the appears. button if it 2. Expand the data mapping configuration (name.OL-datamapper) by clicking the button. 3. Right-click on the data file, then click Set as sample data file. Viewing an attached data file 1. Make sure the Connect Resources section is visible by clicking the appears. button if it 2. Expand the data mapping configuration (name.OL-datamapper) by clicking the button. 3.
For more information about PlanetPress Design documents, please see the PlanetPress Design User Guide. Generating output with PlanetPress Design documents PlanetPress Design documents are typically selected in certain Output tasks designed to merge data with a Design document, but they can also appear in other tasks that produce formatted data such as the Digital Action task and the Add Document task.
Adding printer resident documents to the Configuration Components Pane By default, the Documents group displayed in Configuration Components pane of the PReS Workflow Configuration program includes all those documents that are available on your local PReS Workflow server.
Tip To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. Using files attached to PlanetPress Design documents Data files When sending a PlanetPress Design Document from PlanetPress Design to PReS Workflow, all data files used in the document are automatically sent to PReS Workflow along with the Design document.
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 PPS/PSM Documents section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Right-click on the data file, then click Save sample data file.
the same name as the document but with a PDF extension. 3. Right-click on the Document Preview, then click Open in PDF Viewer. Saving the Document Preview to disk 1. Make sure the PPS/PSM Documents section is visible by clicking the appears. button if it 2. Expand the document (name.ptk) by clicking the button. The Document Preview has the same name as the document but with a PDF extension. 3. Right-click on the Document Preview, then click Save PDF File.
PrintShop Mail documents PrintShop Mail documents are documents made with PrintShop Mail (Suite, not Connect). These documents may be imported into Workflow to create output with the "PrintShop Mail" on page 553 task. Importing PrintShop Mail documents This procedure describes how to import variable content documents created in PrintShop Mail (Suite, not Connect) into PReS Workflow. 1. Click the PReS Workflow button. 2. Choose Import, then Import PrintShop Mail Document.
originates from many different sources (as many as the input tasks support), parts of it can be stored in variables, and it is always accessible by the task that currently handles it. Data is referred to in tasks using data selections; see "Data selections" on page 54. Data selections let you use data in file names, for example, or store them in a variable or in the Data Repository for use later on.
always referred to as a data file. When a data file enters a process, it becomes the job file. 'Job file' however is a more general term, that can refer to data files as well as other types of files traveling through a process. Image files, for example, can be passed from task to task in order to be downloaded to a printer. So files traveling within a process are referred to as job files. A single job file can be the source of multiple job files.
Since these files are generated and managed by PReS Workflow, you should not actually pay too much attention to their names. Many Output tasks, on the other hand, let you determine exactly how you want the files they generate to be named. In the case of Send to Folder output tasks, for example, output files are saved under their job file names by default (using the variable %f), but you may use a static (MyOutput.txt, for example) or variable name (%O_Invoices, for instance) of your choosing.
Data selections A data selection could be compared to an address. It indicates a location within a data file or database: the job file (see "Job file" on page 51), Metadata file (see "Metadata" on page 76), or "Data Repository" on page 96. Data selections can be used in many task property fields and are always evaluated at run-time so they are always dynamic and depend on the job file that is currently being processed.
Wild card parameter "?" Data/Metadata selection functions accept a wildcard parameter "?", indicating the function operates on all nodes (not just one) of a given level. Examples l In a PDF emulation, the format of a selected region could be: region(?,0.59375,2.21875,1.85416,2.51041,KeepCase,NoTrim) In this case “?” represents the current physical data page processed by the task.
l From Column: the leftmost character position of the data selection. l To Column: the rightmost character position of the data selection. l Case Options: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent. l LowerCase: Converts all letters to their lowercase equivalent.
Data Repository lookups The Data Repository selections are made through the lookup function. Selections are done from the data located in the "Data Repository Manager" on page 880. The lookup function returns the value of a single key, which is always a string. If the lookup operation fails to find any data, for any reason, the return value is always "NODATA".
l region(): Always surrounds PDF data selections. l Page: The page of the PDF from which to retrieve the data. l Left: Exact horizontal position (in inches) that defines the left of the selection region. l Top: Exact vertical position (in inches) that defines the top of the selection region. l Right: Exact horizontal position (in inches) that defines the right of the selection region. l Bottom: Exact vertical position (in inches) that defines the bottom of the selection region.
l Metadata Path (optional): Defines the precise path where the Metadata Field is located. Note Metadata Index/Count values are zero-based: the first element in any collection has an index of 0 and the last element's index corresponds to the collection's length minus 1. Option flags The flag value to enter should be the sum of all desired flags. So, a value of 11, which is 8+2+1, means that behavior 8, 2 and 1 are applied. A value of 0 means 'no flag'.
Syntax xmlget(XPath[, Value option, Case option, Trim option]) Here is a breakdown of the syntax: l xmlget(): Always surrounds a data selection. l Value Options: l l l Count: The number of elements on the same level in the same node that have the same name. l Name: The element's name. l Value: The element's value. Case Options: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase characters as they are.
Changing the emulation is particularly important if you want to make a data selection in a file after it has been changed to another format (see "Data selections" on page 54). Note Even during debugging, selecting a sample data file with a different format will cause the emulation of a process to change. In order to avoid errors, change the emulation back to the format of the original input file before using the process again.
Read in binary mode (ASCII emulation only): Select to read the data file in binary mode. You select this if you intend to run a PlanetPress Design document on a printer queue that is set to binary mode. In binary mode, the printer reads the end of line characters (CR, LF, and CRLF) as they appear in the data stream and does not perform any substitution.
The emulation that is used in your process can change during the process, and can be different than the one used in any PlanetPress Design document used in your process. PlanetPress Design Documents use their own emulations, as defined in the document itself from PlanetPress Design. For more information about emulations in PlanetPress Design see PlanetPress Design User Guide. ASCII emulation ASCII emulation tells the process to treat the input data as a stream of ASCII characters.
ASCII emulation options l Tab on carriage return: Select this option to fix formatting problems caused by isolated CR characters found within the data. When this option is selected, isolated CR characters are spaces, as defined in the Number of spaces in the tab box below. Note that this option is available only when the Read in binary mode option is selected.
CSV emulation options l l l l Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the data is split into two fields. If you want to use a backslash character (\) as a delimiter, you must precede it with another backslash character (thus you would enter \\).
CSV emulation options l l l l Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the data is split into two fields. If you want to use a backslash character (\) as a delimiter, you must precede it with another backslash character (thus you would enter \\).
Note You can also use the PReS Workflow Database Action task to get data from a database, and output in multiple different formats such as CSV. See "Database Query" on page 428. Bear the following in mind: l l l l The person or plugin performing the query must have full access to the database. The data is extracted at the time of the query. A new query must be performed whenever the data needs to be updated.
Note Line printer emulation is only used when merging line printer data with a PlanetPress Design document. When choosing a line printer sample data file to be merged with a Connect template, select Text emulation (see "Text-based emulation" on the next page). Line printer emulation options The line printer emulation does not have any options other than the general text-based emulation options (see "Text-based emulation" on the next page).
Text-based emulation Text-based emulations display your data in plain text in the Data Selector and the Data Pane, one line at a time, up to the limit you specify in the emulation properties (by default, 66 lines). This is especially useful for legacy systems (such as AS/400 computers) that send data as text meant for older line printers using pre-printed forms. The emulation options are used to make sure your data is stable.
Note for PlanetPress Suite users: You should also consider using the N-Up Object if you want to display multiple data pages; see thePlanetPress Design user guide. l l l Cut on FF character: Select to have a new data page when a form feed character is encountered in the data stream. If you select the Cut on FF character option, there are two conditions that signal the end of a data page: the form feed character and the number of lines set in the Lines per page option.
XML emulation options l Cache XML data: When this option is selected, PReS Workflow Server only reloads the data if the size or modified date of the XML file changes. When this option is not selected, the XML data will be reloaded into memory every time that a plugin works on the data file. Caching the XML data will make subsequent tasks run faster (as loading an XML file can take a long time) but will also use up more memory since that memory isn't released in between tasks.
the format of the original input file before using the process again. Choosing a sample data file In order to create your PReS Workflow process, the sample data you are going to use has to correspond precisely to the job files that will be treated by that process, at least in terms of structure. The sample data file should have a relatively small number of records (generally less than a hundred) in order to be processed quickly, while your actual data may be much larger and take more time to process.
Tip 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. Choosing a database sample file To choose a database sample file: 1. Open the Data Selector (see "The Data Selector" on page 883). 2. From the Emulation drop-down list, select Database. 3. Next to the Sample data file field, click the Configure Database button. 4. Associate a database.
5. Click Edit SQL to create the SQL query by hand to define the SQL query that retrieves the data your document requires. 6. Set the properties that define a record set: l l l Condition: Select the condition that signals the end of a record set. Three possibilities exist: create a new record set for each record, create a new record set after every x records, or create a new record set when the value of a specific field changes.
Alternate syntax(not recommended): Select to prevent PlanetPress Design from automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the advanced SQL Statement dialog box. 6. Client side cursor: Select to download result sets to client computer running the SQL query.
Note You can also use the PReS Workflow Database Action task to get data from a database, and output in multiple different formats such as CSV. See "Database Query" on page 428. Bear the following in mind: l l l l The person or plugin performing the query must have full access to the database. The data is extracted at the time of the query. A new query must be performed whenever the data needs to be updated.
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. In addition to that, PReS Workflow provides a whole series of plugins to create and edit Metadata during a Workflow process (see "Metadata tasks" on page 586). The things that you have to know in order to use the Metadata tasks effectively are set out in another topic: "Working with Metadata" on page 79.
When Metadata is produced for a given job, a hierarchical (i.e. tree-like) structure is created, composed of the above elements in the following order: Job > Group(s) > Document(s) > Datapage(s) > Page(s). For example: Note Any operation that modifies the data with regards to the structure (ex: remove pages, alter the data, etc.) makes the Metadata obsolete and so it must be recreated or refreshed; see "Working with Metadata" on the next page.
The Metadata related plugins (see "Metadata tasks" on page 586) can be used in conjunction with OL Connect tasks nonetheless; see "How Metadata affects the output" on page 81. Metadata Attributes and Fields Each Metadata node (i.e. Job, Group, Document, etc.) is described with a series of elements, that is, system-defined attributes or user-defined fields holding static or dynamic information about the node they are attached to. Each element has a name and a value.
How data and Metadata influence each other When Metadata are created, they are based upon a data file. However, modifying one file doesn't automatically change the other, and Metadata aren't reset by default in a Branch, Condition or Loop. l l l Modifying Metadata does not immediately modify the data. This is one of the benefits of Metadata because you can sort it, filter it, sequence it, add data to it, without ever modifying the data file itself.
l l The "Capture Fields Generator" on page 569, "Capture Fields Processor" on page 572, "Get Capture Document" on page 582 and "Find Capture Documents" on page 578 tasks generate their own Metadata. The "Lookup in Microsoft® Excel® Documents" on page 525 enhances Metadata fields with information from an Excel spreadsheet, but does not otherwise change its structure. How Metadata affects the output By default the data file is not affected when the Metadata are modified.
Example Here is an example of an issue that occurs when Metadata is not re-created in a Loop. In the following process, the Job file is a PDF that contains several invoices. Some (but not all) of those invoices start with a separator page that you don't want to print. Invoices that don't have a separator page should be printed as-is. The process would look something like this (by default): l l l Step 2 splits the PDF whenever it encounters a new Invoice Number on the Top Right corner of a page.
l l l ...and step 5 filters out the first page (which means the Metadata unselects the first Data Page, in effect "hiding" it from the Print Output task). Step 6 prints the PDF to a printer. When printing a PDF file in passthrough mode, the Metadata is inspected to determine which pages should print or not. In this case, Page 1 is unselected in the Metadata, therefore the printer receives the job starting from Page 2, which is exactly what you want.
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 76 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.
l Finishing attributes describe the finishing intent (e.g. page dimensions, page orientation, duplex mode, etc.). Note The presence of some finishing attributes depends on the PlanetPress Design document and target device used when producing the job. l Index/Count attributes are not part of the original Metadata file. They are evaluated dynamically, based on the content of the Metadata.
Attribute Description Categor y Jo b Grou p Docum ent DataEncoding (optional) Name of the character encoding. Producti on X X X DataFile (optional) Path and name of the data file used by the PlanetPress Design Document. Producti on X X X Date Date the Metadata was created in ISO format. Producti on X X X Time Time the Metadata was created in ISO format. Producti on X X X Title Title of the source document.
Attribute Description Categor y Jo b Grou p Docum ent X X Datapa ge Pag e source of the Metadata. TargetDevice Name of the device for which the Metadata and associated data is intended. Producti on X Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input. Producti on X Dimension Two floatingpoint values separated by a colon indicating the media size in typographical points (ex: 612:792).
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape. Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent. Finishin g X Duplex "None", "DuplexTumb le" or "DuplexNoTu mble"; indicates a change of the duplex status.
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e identifier of the media source. OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedependent color of the media. Finishin g X X X X X MediaType Devicedependent type of the media.
Attribute Description Categor y IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group. Index/C ount IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
Attribute Description SelectedPageCo unt Categor y Jo b Grou p Docum ent Index/C ount X X X SelectedIndexInD ocument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInG roup Returns the Absolute index of the node within all the selected nodes under the parent Group. Index/C ount SelectedIndexInJ ob Returns the Absolute index of the node within all the selected nodes under the parent Job.
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e 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. It is a way to store information in a structured and easy-to-read format. It is often referred to as "XML without nodes" and it is designed for exchanging data.
Types of JSON in Workflow Workflow tasks that support JSON accept or output one or two of the following types of JSON: l l a regular JSON string, containing a JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string samples" on page 638.
{jobid}')", "pages":"lookup(OLCS_jobs, pages, jobid, '%{jobid}')", "documents":"lookup(OLCS_jobs, documents, jobid, '%{jobid}')", "recordsetid":"lookup(OLCS_jobs, recordsetid, jobid, '%{jobid}')" } An example where the entire JSON string is provided in a Job Info variable: %1 A JSON string constructed with information retrieved from an XML job data file (see "XML data selections" on page 59): { "first":"xmlget('/request[1]/values[1]/first [1]',Value,KeepCase,NoTrim)", "last":"xmlget('/request[1]/values[1]/l
}, "tables" : { "detail": { "columns": { "ItemTotal": "CURRENCY", "ItemShipped": "FLOAT", "ItemOrdered": "BOOLEAN" } }, "detail2": { "columns": { "ItemUnitPrice": "CURRENCY", "ItemOrdered": "INTEGER" } } } }, "id": 3678077, "datasetid": 2392921, "fields": { "ID": "CU19762514", "Date": 1331096400000 }, "tables": { "detail": [{ "id": 3678078, "fields": { "ItemTotal": "2300.00", "ItemShipped": 2.0, "ItemOrdered": false } }, { "id": 3678079, "fields": { "ItemTotal": "29.99", "ItemShipped": 1.
"ItemOrdered": 2 } }, { "id": 3678081, "fields": { "ItemUnitPrice": "29.99", "ItemOrdered": 1 } }] } } ] Values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.detail[0].fields.ItemTotal; Data Repository The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes. This feature was introduced in version 8.5.
Structure As can be seen in the "Data Repository Manager" on page 880, the Data Repository consists of Groups, Keys and KeySets. Feature Name Description Equivalent Database Terminology Group A Group is defined by its Keys (columns), and may contain 0 or more KeySets (rows) within it. Table Key A Key is defined only by its name. The Data Repository only supports STRING values and any data inserted into it is converted to string automatically. The maximum size of a single key is 1 billion bytes.
Retrieving data from the Data Repository In any Workflow task where variable data is allowed (recognisable by the maroon field labels), information can be retrieved from the Data Repository using a Lookup function. Right-click a field with a maroon label and select Get Repository Location. This will bring up the "Data Repository Manager" on page 880. Select a Group, Key and KeySet entry to determine which value or values should be retrieved at runtime; then click OK.
Scripts In a script you can access the Data Repository using the "Data Repository API" on page 177. For a quick start, turn to this How-to: Interacting with the Data Repository API. Data Repository Manager At design-time, the Data Repository Manager may be used to insert or remove Groups, Keys and KeySets; see "Data Repository Manager" on page 880.
When such an error occurs, in most cases you would want to be aware of it and to take certain actions in order to correct or report the error. This is where our error handling features come in handy. Most of the tasks, branches and conditions included in your process can have their own error handling behavior, with the exception of Comments, the Input Error bin task, and older legacy tasks from previous versions of Workflow that did not have error handling.
the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration. l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. If the task is not on a branch, the entire process will be stopped.
your process, and will be triggered if the Send to Process option is checked in that tab and an Error process is selected in the drop-down list. To create an Error process, simply replace the initial input task by the InputErrorBin Input task, and that process automatically becomes able to handle error jobs sent to it. It is up to you, however, to decide how that error job will be handled.
Variable Name %{error.process} Name of the process where the error was triggered. %{error.tasktype} The type of task that triggered the error %{error.taskname} The name of the task that triggered the error %{error.taskindex} The position of the task in the process %{error.errormsg} The error message, as entered in the OnError tab of the task. This is the same message as appears in PReS Workflow Log file. %{error.errorid} The error ID, as entered in the OnError tab of the task.
l LPR Client l FTP Client l PReS Image l PReS Fax l PReS Messenger 3. When any job or file is processed by the selected service, the processing logs will be displayed in the window on the right. Note The information that is displayed here is the same as in PReS Workflow logs and depends on the logging level that you set in the "General and logging preferences" on page 814 and on the 'Minimal logs' option in the "Process properties" on page 895.
for that specific software within the suite. Resubmit backed up input files to a process Each Input task includes an option that lets you back up input files. This option is not selected by default, since it has the potential to generate a very large number of backup files.
1. In the PReS Workflow Ribbon, go to the Tools tab then click Resubmit Job in the Services group. The File Resubmission dialog box is displayed. 2. From the Process box, select the process for which you want to resubmit the backed up input files. 3. From the Task index box, select the index level to which you want the data to be sent. The index is the position in the process where you want to submit the job file. The numbers on the left in the Process area indicate the task index. 4.
In addition it may be useful to know the number of each failed page. If a job contains 1000 documents and if documents 1 to 950 were printed correctly, you might not need to resubmit the entire job, but only the input data for the 50 last documents. However this is only useful if the relationship between the input data and actual output documents is easy to determine.
Action task to actually run in the process). Do not forget, however, to remove this duplicate task before saving the configuration! l l If any task makes an operation on the system (for example, capturing files, sending data, printing, etc), it is actually executed, not simulated. Any task is executed with the permissions of the user that is currently running the PReS Workflow Configuration tool. When running in Service mode, the user configured in the Configure Services dialog is used instead.
l l l l l l l l Click on Skip to ignore the next task or branch and go to the subsequent one. The job file is not modified in any way. Click on View as Text in the Data group of the Debug tab to view the current job file using a text editor (Notepad by default). Click on View as PDF to view the current job file in Adobe Acrobat if it is present (this will work only for PDF job files). Click on View Metadata to open the data selector and see the current state of the process' Metadata.
This method does not allow you to add, remove or move tasks, however. The second method can be used when that is required. l l l l l Step through the process in Debug mode until you reach the emulation or data change. Click on View as Text (or View as PDF if your data is PDF at this point) in the Data group of the Debug tab. In the viewer that appears, save the file to a location on your hard drive.
Printing can be done locally or remotely. The spool file is sent to the printer by the Output task itself, or by Workflow if the file is placed in a Workflow Printer Queue. Printer-centric printing - which means that a document and data are merged on a printer - is only supported with PlanetPress Design documents, and requires that this feature be available on the printer.
l Easier debugging. If the output file is a PDF, for example, you can open it inside Workflow once it has been sent back to the process (see "Debugging your PReS Workflow process" on page 107). Using a Printer Queue requires creating the appropriate Printer Queue in the Workflow Configuration tool first. In the Output to Printer Queue task, select No document to let the spool file pass through it.
dispatch spool files to printer queues, you have to create queues in Workflow and set each one’s properties. Printer Queue types The PReS Workflow Configuration program lets you create four types of printer queues: l l l l Windows Output printer queues are used to send print jobs to local or network printers. See "Windows Output printer queue" on page 115. LPR Output printer queues are used to send print jobs to printers via the LPR/LPD protocol. See "LPR Output Printer Queue" on page 116.
Shared printer queue properties The options on a printer queue’s Advanced properties tab are common to all printer queues. They include the printer’s speed and any special pre- or post-job commands required for printer specific reasons. Pre-job commands are added right before the data in the data file, while postjob commands are placed at the end of the data file. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue.
Character name: Character code: Typical use in printing context: Horizontal Tab \t Adds a horizontal tab Line Feed \012 Moves to the next line Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape character New Line (CRLF) \n Goes to a new line Windows Output printer queue Windows output printer queues send print jobs to local or network pr
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.
l Data type: Select the proper data type. Select: l l l (f) Formatted text to interpret the first character of each line of text as a standard FORTRAN carriage control character. l (d) DVI file if the job file contains data in the TeX DVI format. l (o) PostScript file if the job file is a PostScript file. l (n) Ditroff format if the job file contains data in device independent troff. l (t) Troff format if the job file contains data in troff.
Commands box. Use the right-click menu for a list of standard printer control characters. (See also: "Frequently used printer control characters" on page 114.) Note If you plan to use an LPR output printer queue to send PlanetPress Design documents generated using the Optimized PostScript Stream option, you should not enter data selections in the Printer address and Queue name variable property boxes.
l l Active: Select to prompt the FTP client to use active mode when sending files to the FTP server. Passive: Select to prompt the FTP client to use passive mode when sending files to the FTP server. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing.
Properties General tab l l l l Folder: Enter the path of the folder to which the print jobs are to be saved. File name: Enter the name of the print jobs sent to this queue. To prevent each new file from overwriting the previous one, you should use variable names. This variable property box lets you use a combination of text, variables and data selections.
Load balancing PReS Workflow offers various load balancing options to distribute the printing load and to make the process faster and more efficient. Print jobs may, for example, be split equally among several printers, or they may be split according to each printer’s capacity and speed. Load balancing can only be used for jobs sent to Printer Queue output tasks and it only applies when multiple Workflow Printer Queues are selected.
Breaking the association between documents and a Workflow printer queue To break the association between a PlanetPress Design document and a given Workflow printer queue: l Select the document as displayed under the printer queue in question and press Delete. To break the association between a PlanetPress Design document and multiple Workflow printer queues: 1. Select the document as displayed under one of the printer queues in question and from the right-click menu choose Delete Instances.
l l When the server running PReS Workflow sends a PlanetPress Design document along with the data to the printer, it adds a trigger before the document (trigger+document+data). When the server running PReS Workflow only sends the data to the printer, because the document is already present on the printer, it adds a trigger before the data (trigger+data). PReS Workflow adds the trigger code automatically, but you may want to use custom triggers.
4. Enter a Name for the printer queue. 5. Click OK. Every new Windows printer queue using the Objectif Lune Printer Driver (PS) is shared by default. Once such a shared queue is created, end-users can install it on their own computer by going through the same steps they would when installing a new remote printer in their Operating System. By default, connecting to a shared printer will automatically result in the Objectif Lune Printer Driver being downloaded to the connecting host.
Data Capture from PReS Workflow Once a shared Windows printer queue using Objectif Lune Printer Driver (PS) is installed on both the server and the client sides, data capture can be achieved the same way as with any other Windows printer queues. 1. Open your PReS Workflow Configuration program. 2. Insert a new process. 3. Select WinQueue Input from the Plugin Bar and insert it in the new process. 4.
About Metadata Metadata files are files containing information on the job itself rather than containing the job per se. A job sent to the Objectif Lune Printer Driver (PS) creates its own Metadata, allowing users to retrieve relevant information, such as, for instance, the time and date the print request was sent and how many pages it contains. For more on this, see the Metadata documentation pages ("Metadata" on page 76).
l l Subprocesses can be called by any other process (see "Subprocesses" on the facing page). Error processes can only be used in the On Error tab of a task in your process (see "Creating and using Error processes" on page 101). Self-replicating processes are in fact regular processes that replicate themselves in the background when multiple input files are received simultaneously.
Subprocesses Subprocesses are special processes that can be called by any other process. Subprocesses act exactly as subroutines in programming languages, allowing users to reuse existing processes by sharing them to the whole configuration file.
Adding a startup process You may create a startup process in two different ways. l l In the Ribbon, go to the Home tab and click the Startup Process button in the Processes group. In the Configuration Components pane, right-click on any process or the Processes folder and select Insert > Insert Startup Process. In addition, you may convert a regular process into a startup process: l Right-click a regular process and select Startup to convert the process into a startup process.
Processes can be deleted, duplicated, renamed, disabled, grouped etc.and their properties, for scheduling and error handling can be edited (see "Process properties" on page 895). This can all be done via the Configuration Components pane. For a list of all operations that can be performed on processes in the Configuration Components pane, please refer to "Configuration Components pane" on page 855.
4. In the list, select the components you want to import. The PReS Workflow Configuration program lets you open and import any of the following: l l Complete PlanetPress Watch 4 to 6 configurations, as well as PReS Workflow 7 and 8 configurations. Specific processes from Version 6, 7 and 8 configurations, including their local variables. l Specific subprocesses from any PReS Workflow 7 and 8 Tools configurations. l Specific global variables from PReS Workflow 7 and 8 Tools configurations.
An inactive process will display in the Configuration components as red and strike-through. Inactive processes can be useful for designing new processes in a live configuration. As the process does not execute there is no danger of submitting it to a PReS Workflow Service. To activate or deactivate a process: 1. Right-click the process in question in the Configuration Components pane 2. Click Active to disable or enable the process. 3. Send the configuration.
Options General tab l l l l l l l l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PReS Workflow. Startup: Select to make this process a startup process (see: "Startup processes" on page 127). This option is not available for self-replicating processes and error processes.
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.
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.
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.
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.
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.
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.
Note The term "Desktop" is defined as the desktop of the user logged on to the computer where PReS Workflow is installed. These dialogs cannot be displayed on any other computer. Toggling a process’s Run on Desktop property To toggle a process's Run on Desktop property: 1. Select an active process in the Configuration Components pane. 2. In the Object Inspector Pane, change the Run on desktop property from False to True, or vice versa.
To save the current configuration: l l From the PReS button, choose Save. If you were editing the current PlanetPress Watch service configuration or if you were editing a new configuration file, you are prompted with the Save As dialog instead. To save the current configuration under a new name: l l From the PReS button, choose Save As. Browse to the location where you wanted to save the file, enter the new name of the configuration in the File name box and click Save.
Note When you send a configuration to your PReS Workflow service, all its active processes are applied; see also:"Activating or deactivating a process" on page 131. Sending a Configuration to the local server 1. Open the configuration you want to use as PReS Workflow’s new configuration. 2. Edit the configuration, if required. 3. When the configuration is ready to be used, from the PReS Workflow button, choose Send Configuration, then Send Local. Sending a Configuration to a remote server 1.
Using Scripts Scripts can be used to perform various operations, such as to manipulate data, for example. PReS Workflow can perform scripts written in four different scripting languages and also provides an interface for editing scripts. Note While this chapter provides some very useful and detailed information about scripting within PReS Workflow, its focus is to inform you about the features, variables and functions unique to this environment.
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.
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.
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.
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.
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.
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).
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 838.
SOAP Server API Reference PReS Workflow offers a SOAP Server API Reference allowing jobs to be submitted from a third party application using the SOAP protocol. SOAP is short for Simple Object Access Protocol. While there are multiple possibilities for solutions using a SOAP server implementation, the SOAP Server API Reference is specifically for submitting jobs from a SOAP client. It implements methods that will allow SOAP clients to submit jobs and get information from PReS Workflow executing them.
"SubmitJobInfStruc" on page 158 Structure containing any required information to prepare the file for a valid insertion into a PReS Workflow process. Note With the SOAP API reference, new SOAP plugins have been introduced. The old plugin, which could be used as an Input, Action or Output task, was renamed Legacy SOAP Client and has become obsolete.
Note To obtain access to the complete list of processes for all users, the end-user must have administrator privileges. GetProcessTaskList The GetProcessTaskList function will allow a user (a SOAP client) to remotely request the tasks list of a process. This will be useful with the PostJob method since it needs a TaskIndex. Syntax GetProcessTaskList (ProcessName, user name, Password) : GetProcessTaskListResult Parameters l ProcessName: The Name of the PReS Workflow process.
Note The TaskNames array will be sorted by the execution order of the process with the primary input of the process having an index of 1. GetSOAPProcessList The GetSOAPProcessList function will allow users to request the list of PReS Workflow processes that contain a SOAP Input plugin with the SOAP action name. This is useful when working with the SubmitJob SOAP API method since it requires a SOAPActionName.
Note If a user has administrator privilege, he will have access to all processes and therefore he will see all the processes. PostJob The PostJob method allows a user (a SOAP client) to remotely submit files to PReS Workflow by using the Resubmit from here feature. The main advantage of this feature is that it allows a user to specify a starting task index from which the File is to be processed.
Note The task index can be retrieved by using the GetProcessTaskList method. See point GetProcessTaskList for details. Note The PostJob method can never return a file to the calling application. PostJobInfoStruc Structure containing any required information to prepare the file for resubmission into a PReS Workflow process using a SOAP client. l VariableList: Array of complex type, containing pairs of variable names and variables value. The list also contains the Job Info variables.
Syntax SubmitJob (File, SubmitJobInfStruc , ReturnJobFile, user name, Password) : SubmitJobResult Arguments l l l File – base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64). SubmitJobInfStruc – Structure containing any required information to prepare the file for a valid insertion into a PReS Workflow process (see "SubmitJobInfStruc" on the next page). ReturnJobFile – Boolean value. When true, PReS Workflow SOAP server returns the job file.
Note The SubmitJob method only returns a file if the PReS Workflow process contains a SOAP Input task. Note If ReturnJobFile is set to true, the schedule options of the process should be set to a pooling lower than four seconds, so the client application gets a timely response. Note To return the file, the process must be completed before the timeout of the server occurs. The Timeout option can be set in your PReS Workflow preferences.
Note While the functions here are in mixed case to simplify reading, it's important to note that some languages (especially JavaScript) are case-sensitive and will require the proper case. Examples in this chapter will always use the proper case when relevant. Here is a list of the methods and functions that are available to you through the automation object (or "Watch" object).
Variable Name Description Example Usage (VBScript) "Watch.GetVariable" on page 170 Retrieves the content of a local or global variable by name. Example Usage: var s = Watch.GetVariable ("MyVariable"); "Watch.ExpandString" on page 164 Retrieves the content of any Workflow string, containing any variable available to Watch, including data selections. Example Usage: var watchDate = Watch.ExpandString ("%y-%m-%d"); "Watch.
Variable Name Description Example Usage (VBScript) "Hello World!"); "Watch.Sleep" on page 175 Pauses all processing for X milliseconds. Example Usage: Watch.Sleep(1000); "Watch.ExecuteExternalProgram" on the next page Calls and executes an external program in the command line. Example Usage: Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); "Script.
Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line. The program's execution will be directed by the appropriate flags specified as this method's parameters. Syntax Watch.ExecuteExternalProgram const CommandLine: WideString; const WorkingDir: WideString; ShowFlags: Integer; WaitForTerminate: WordBool: integer; const CommandLine The command line to execute as a widestring.
Examples JavaScript Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true Python Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, True) Perl $Watch->ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true); Watch.ExpandResourcePath The Watch.
VBScript Watch.ExpandResourcePath "invoice.OL-template" Python Watch.ExpandResourcePath("invoice.OL-template"); Perl $Watch->ExpandResourcePath("invoice.OL-template"); Watch.ExpandString Provides access to the emulated job file and to all variables. This function returns a string that is the expanded version of the input string. Syntax Watch.
Perl $s = $Watch->ExpandString("%y-%m-%d"); $Watch->Log("Current Date is: " . $s,2); Watch.GetConnectToken The Watch.GetConnectTokenmethod uses the default Connect Server host as defined in the Workflow preferences (see "OL Connect preferences" on page 811) to log into the Connect Server and retrieve an authorization token. Syntax Watch.
Python Watch.GetConnectToken(); Perl $Watch->GetConnectToken(); Watch.GetConnectTokenEx The Watch.GetConnectTokenEx method uses the arguments passed to it to log into the Connect Server and retrieve an authorization token. Syntax Watch.GetConnectTokenEx(host, port, username, password) The arguments contain the Connect Server settings (see "OL Connect preferences" on page 811), in the form of strings (host, username and password) and a number (port).
VBScript Watch.GetConnectTokenEx "localhost", 1234, "myUser", "secret" Python Watch.GetConnectTokenEx("localhost",1234,"myUser","secret"); Perl $Watch->GetConnectTokenEx("localhost",1234,"myUser","secret"); Watch.GetJobFileName Returns the complete path and file name of the job. This method is the same as PW_ GetJobFileName. getjobfilename() obtains the file name of a PReS Workflow process. This is useful for manipulating the job file, for example to replace data within it.
Watch.GetJobInfo Returns the job information corresponding to the specified index. Index is an integer from 1 to 9. (See also: "Job Info variables" on page 733.) Syntax Watch.GetJobInfo(Index: integer): string Example JavaScript var s; s = Watch.GetJobInfo(3); Watch.Log("Jobinfo 3's value is: " + s, 2); VBScript Dim s s = Watch.GetJobInfo(3) Watch.Log "Jobinfo 3's value is: " + s, 2 Python s = Watch.GetJobInfo(3) Watch.
Python Watch.GetMetadataFileName() Perl $Watch->GetMetadataFileName(); Watch.GetOriginalFileName Returns the original name of the file, when it was captured. This method is the same as PW_ GetOriginalFileName. Example JavaScript Watch.GetOriginalFileName(); VBScript Watch.GetOriginalFileName Python Watch.GetOriginalFileName() Perl $Watch->GetOriginalFileName(); Watch.GetResources The Watch.GetResources method retrieves a specific type of Connect resources when it is passed a file extension (e.g.
A string containing a file extension (e.g. "ol-template") to get a specific type of resource, or an empty string to get all resources. Examples JavaScript Watch.GetResources("OL-template"); VBScript Watch.GetResources "OL-template" Python Watch.GetResources("OL-template"); Perl $Watch->GetResources("OL-template"); Watch.GetVariable Returns the string value of the corresponding variable name. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.
Python s = Watch.GetVariable("MyVariable") Watch.Log("global.MyVariable's value is: " + s, 2) Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("global.MyVariable's value is: " . $s, 2); Watch.InstallResource The Watch.InstallResource(path) method copies or unpacks a resource, such as a Connect Designer template, Data Mapping Configuration, or package file, from the supplied path to the Connect resources folder (%PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\OLConnect).
Python Watch.InstallResource("c:\\myfile.ol-package"); Perl $Watch->InstallResource("c:\\myfile.ol-package"); Watch.Log Creates messages that are added to PReS Workflowwatch.log file. The PReS Workflow watch.log file is located in the following folder: %PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\Log View error messages in the Services Console while PReS Workflow is in Run mode by choosing Tools | Services | Service Console.
Level Description 1 The message is logged as an Error in the log file. 2 The message is logged as a Warning in the log file. 3 The message is logged as Information in the log file. 4 The message only appears when the application runs in Debug mode. Examples In the following example, log() will write an information entry in the watch log that says "this is a log" VBScript Watch.Log "this is a log", 3 JavaScript Watch.Log("this is a log", 3); Python Watch.
VBScript Watch.SetJobInfo 3, "Job info 3 Value" Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.SetVariable Sets the variable to a specified string value. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.SetVariable (Name: String; Value: String) Example JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); VBScript Watch.
enabled and you must be logged on as the same user as the PlanetPress Watch Service. Examples In the following example, showmessage() displays a dialog box saying “test message”. JavaScript Watch.ShowMessage("test message"); VBScript Watch.ShowMessage("test message") Python Watch.ShowMessage("test message") Perl $Watch->ShowMessage("test message"); Watch.Sleep Pauses the process for the specified number of milliseconds. This can be used while waiting for something else to happen when the delay is known.
Perl $Watch->Sleep(1000); Script.ReturnValue Set this variable to 1 (true) or 0 (false) in order to return a true or false status to PReS Workflow, when using your script as a conditional branch. This variable will have no effect if the script is run as an action. If the property is not set, the default value is false. Example This example will always return true, as the condition is static. It is, after all, simply an example. You get the idea.
Perl $everythingOK = 1; if ($everythingOK) { $Script->{ReturnValue} } else { $Script->{ReturnValue} } = 1; = 0; Data Repository API The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes. The Data Repository can be accessed at runtime by the Push To Repository plugin and other tasks (see "Data Repository" on page 96) and at design time via the "Data Repository Manager" on page 880.
Note Group and key names are case-insensitive. API Reference Obtaining an instance of the Repository Object The Data Repository is accessed via a COM object that exposes methods to store and retrieve data within the Repository. JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); VB Script set repoObject = CreateObject("RepositoryLib.
repoObject.AddGroup("MyGroup","['FirstKey', 'SecondKey']"); Many methods require using the JSONStringArray type but JSON is not natively supported in VB Script. Therefore, for those methods, only JavaScript sample code is provided. There are many resources on the Web that propose ways of implementing JSON parsing in VB Script so you can implement whichever you see fit. However, using JavaScript is highly recommended.
Group methods Name Description "AddGroup" on page 184 Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. "ListGroups" on page 190 Retrieves the list of all group names in the Repository, stored in a JSONStringArray.. "RemoveGroup" on page 192 Deletes the group named GroupName, along with all its keysets and keys. "RenameGroup" on page 195 Renames group oldName to newName.
Name Description "RemoveKey" on page 192 Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised. All values for the key, in all keysets for the group, are removed. Note that when the Group contains a large number of KeySets, this operation may take a while. "RenameKey" on page 195 Renames key oldName to newName in group GroupName.
Name Description SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note that KeyName must exist in GroupName, otherwise an error is raised. The method returns an array of the keyset ID's that were updated ( [1,2] ), or an empty array ( [] ) if no keysets were updated. "SetValueByID" on page 197 Updates KeyName with Value in group GroupName, where the keyset's ID matches the ID parameter. KeyName must exist in GroupName, otherwise an error is raised.
Name Description an asterisk * is passed as the Keys parameter, all keys are retrieved. When Condition is left empty, all keysets are retrieved. "RemoveKeySets" on page 194 Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. Condition may be left empty, in which case all keysets in GroupName are deleted. The method returns the number of keysets that were deleted.
AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. Syntax AddGroup(GroupName: string, keyNames: JSONStringArray) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 178). JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.
repoObject.AddKey("Users", "email"); VB Script repoObject.AddKey "Users", "email" AddKeySets Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues must exist otherwise an error is raised. However, it is not required to specify all available keys in KeyValues. Only the keys specified are updated in GroupName while unspecified keys are set to an empty string.
var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); repoObject.AddKeySets("customers", '[{"CustomerID": "CUJS123456", "FirstName": "John","LastName": "Smith"}, {"CustomerID": "CURD654321", "FirstName": "Richard", "LastName": "Doe"}]'); Tip: to update a row instead of adding it, use the GetValue() function to get the KeySet ID; then update each individual value using SetValueByID() (see "GetValue" on page 189 and "SetValueByID" on page 197).
CheckRepository Verifies the integrity of the repository and recovers unused space left by deleted keysets. Similar to packing a database, the operation is non-destructive but it does require exclusive access to the Repository. You should therefore only perform this operation when you know for sure no other process is accessing the Data Repository. Syntax CheckRepository() ClearAllData Delete all keysets in all groups, while retaining the existing key structure.
When Condition is left empty, all keysets are retrieved, which is useful for reports, cleanup, or custom filters based on more complex conditions. GetKeySets() converts the results coming from the Repository from UTF8 to Ansi, in order to make results with special characters like 'éèêë?æ' compatible with scripting. To obtain the UTF8 value, without conversion, use GetKeySetsW().
By replacing the last option from GetKeySets (the filter on CustomerID) with an asterisk, you can get all the rows from the data repository.
LastName='Smith' "); /* retrieves email for first user named Smith */ var myValue = repoObject.GetValue("Users", "email", ""); /* retrieves email for first user */ VB Script myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" AND FirstName=""John"" ") /* retrieves email for John Smith */ myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" ") /* retrieves email for first user named Smith */ myValue = repoObject.
Repository Object" on page 178). JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListGroups()); for (var i=0; i
Sample return value '{"ID": "meta", "FirstName": "string", "LastName": "string", "email": "string", "DateC": "meta", "DateM": "meta"}' As shown in the sample, the value associated with each key name is actually the data type for that key. Only two values are currently possible: string and meta, where meta denotes an internally generated key. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys.
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 178). JavaScript repoObject.RemoveKey("Users", "email"); VB Script repoObject.RemoveKey "Users", "email" RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise.
/* both methods perform the same task */ repoObject.RemoveKeySetByID "Users", 10 repoObject.RemoveKeySets "Users", "ID=10" RemoveKeySets Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. The method returns the number of keysets that were deleted. When passing 'ID' as the Condition, all keysets in GroupName will be deleted.
RenameGroup Renames group oldName to newName. While this operation has no impact on the data stored in the specified group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Syntax RenameGroup(oldName, newName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 178). JavaScript repoObject.
VB Script repoObject.RenameGroup "Users", "LastName", "SurName" SetValue Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition. The condition is specified using basic SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note that KeyName must exist in GroupName, otherwise an error is raised.
Gender=""F"" AND MaritalStatus=""Married"" " repoObject.SetValue "Users", "FormOfAddress", "Miss", " Gender=""F"" AND MaritalStatus="""" " SetValueByID Updates KeyName with Value in group GroupName, where the KeySet's ID matches the ID parameter. KeyName must exist in GroupName, otherwise an error is raised. The method returns the ID of the keyset that was updated or -1 if the keyset was not updated. The KeySet ID can be retrieved with GetValue() ("GetValue" on page 189).
/* both methods perform the same task */ repoObject.SetValueByID "Users", "FormOfAddress", "Mr.", 10 repoObject.SetValue "Users", "FormOfAddress", "Mr.", "ID=10" Updating a row There is currently no 'update' feature in the API for a whole KeySet. This JavaScript example retrieves the KeySet ID, which is then used to update values in the row. /* Get KeySet ID */ var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var keySetID = repoObject.
page 208 objects. In turn, MetaDocument objects hold "MetaDatapage" on page 212 objects, which have "MetaPage" on page 215 objects. In addition, a Node contains a collection of "Attributes" on page 234 and can contain any number of "Fields" on page 243. All of these objects are contained in a "MetaFile" below object, and they are obtained, directly or indirectly, through methods of this object.
The current job's Metadata file name can be obtained using the Watch.GetMetadataFilename method (see "Watch.GetMetadataFilename" on page 168) when using the "Run Script" on page 506 task. Note that the exact syntax may vary according to the selected script language. When writing a plugin using the plugin SDK the current job's Metadata file name can be obtained by calling the IWatchJob::MetadataFilename method from within IWatchPlugin::Execute.
LoadFromFile(const String Filename ) Loads a Metadata file from the file system. This function throws an error when the Metadata file is invalid or when it can't be found. Note that this error should be caught in a try-catch block. Filename Name of the file to load. Exceptions l EOleException: Invalid Metadata file or other error while loading. SaveToFile(const String Filename) Saves the current Metadata structure in a file. Filename Name of the file to save into.
MetaJob Properties Name Type Description "Attributes" on page 234 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 235.) "Count" on page 219 Integer Returns the number of child nodes. "Fields" on page 243 MetaCollection Returns the node's field collection. "NodeType" on page 220 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.
Methods Name Return type Description "Add(Integer Index)" on page 222 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 223 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 223 String Returns the value of the attribute of the specified name. "Clear()" on page 223 Deletes all the child nodes as well as the attributes and fields.
"PageCount()" on page 228 Integer Returns the total number of pages present underneath this node. "Paste()" on page 228 Node Inserts the clipboard's content as the last child of the current node. "PasteAt(Integer Index)" on page 229 Node Inserts the clipboard's content as a child node at the specified index. "Select(TSelectWhat SelectWhat)" on page 229 Selects the child nodes according to the SelectWhat parameter.
MetaGroup Properties Name Type Description "Attributes" on page 234 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 235.) "Count" on page 219 Integer Returns the number of child nodes. "Fields" on page 243 MetaCollection Returns the node's field collection. "Index" on page 220 Integer Gets the index of the node in its parent. "NodeType" on page 220 TNodeType Returns the node type of the current Node.
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 222 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 223 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 223 String Returns the value of the attribute of the specified name.
page 225 specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 226 String Returns the value of the N'th field of the specified name. "IndexInJob()" on page 227 Integer Returns the index of this page in the job, taking all the pages from all the datapages from all the documents from all the groups into account. "Item(Integer Index)" on page 227 Node Returns the child (node) item located at the specified index.
"SelectedDatapageCount()" on page 230 Integer Returns the number of datapages selected to be output that are underneath this node. "SelectedPageCount()" on page 231 Integer Returns the number of pages selected to be output that are underneath this node. "SelectedIndexInJob()" on page 231 Integer Index of the page among all the selected pages in the Job.
an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use. "Parent" on page 221 Node Returns the parent node of the current node. "Selected" on page 221 Bool Indicates whether or not the Node is set to be printed. "SelectedCount" on page 221 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 218.
well as the attributes and fields. "Copy() " on page 223 Places a copy of the node in the metadata clipboard. "Cut()" on page 224 Removes the node and places it in the metadata clipboard. "Delete()" on page 224 Deletes the node. "FieldByIndex(Integer Index)" on page 225 String Returns the specified field's value. "FieldByName(const String Name)" on page 225 String Returns the value of field of the specified name.
node. "Paste()" on page 228 Node Inserts the clipboard's content as the last child of the current node. "PasteAt(Integer Index)" on page 229 Node Inserts the clipboard's content as a child node at the specified index. "Select(TSelectWhat SelectWhat)" on page 229 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.
MetaDatapage Properties Name Type Description "Attributes" on page 234 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 235.) "Count" on page 219 Integer Returns the number of child nodes. "Fields" on page 243 MetaCollection Returns the node's field collection. "Index" on page 220 Integer Gets the index of the node in its parent. "NodeType" on page 220 TNodeType Returns the node type of the current Node.
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 222 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 223 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 223 String Returns the value of the attribute of the specified name.
"IndexInDocument()" on page 226 Integer Returns the index of this page in its parent document, taking all the pages from all the datapages into account. "IndexInGroup()" on page 227 Integer Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account. "IndexInJob()" on page 227 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.
values to use. "SelectedIndexInDocument()" on page 230 Integer Index of the page among all the selected pages in its parent Document. "SelectedIndexInGroup()" on page 230 Integer Index of the page among all the selected pages in its parent Group. "SelectedIndexInJob()" on page 231 Integer Index of the page among all the selected pages in the Job.
values to use. "Parent" on page 221 Node Returns the parent node of the current node. Methods Name Return type Description "AttributeByIndex(Integer Index)" on page 223 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 223 String Returns the value of the attribute of the specified name. "Copy() " on page 223 Places a copy of the node in the metadata clipboard. "Cut()" on page 224 Removes the node and places it in the metadata clipboard.
"IndexInGroup()" on page 227 Integer Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account. "IndexInJob()" on page 227 Integer Returns the index of this page in the job, taking all the pages from all the datapages from all the documents from all the groups into account. "Item(Integer Index)" on page 227 Node Returns the child (node) item located at the specified index.
Properties and methods All Node objects share a number of properties and methods that are common to all Node object types. There are also properties and methods that are either unique to a specific Node object type, or shared between only a few of them. Each Node object type provides methods to access its children (in other words, Nodes that are located underneath that Node item in the tree structure). The method's name varies to match the type of Node.
Attributes and Fields In addition to being a collections of objects, a Metadata Node also contains two types of elements, called "Attributes" on page 234 and "Fields" on page 243. These are name/value pairs, where the name is case-insensitive. l l An Attribute is a read-only, system-defined element which holds certain information about a certain node in the Metadata structure. This information can be static (e.g. the size of a physical page) or evaluated on-the-fly (e.g.
Returns the number of child nodes in the current node. Fields Returns the field collection (MetaCollection) of the current node. See "Fields" on page 243. Index Not available in MetaJob Gets the index of the node in its parent. Returns: The index (0-based) at which the current node is found in the parent's node list. Exception: l EOleException: Index is lower than 0 or higher than Count-1. NodeType Returns a value representing the type (TNodeType) of the current node.
Parent Not available in MetaPage Returns the parent node of the current node. Selected Not available in MetaPage Indicates whether or not the node is set to be printed (see "Including or excluding nodes from the output" on page 218). If a node has its Selected property set to true, all of its child that also have their own Selected property set to true will print. If Selected is false, its child will not print, regardless of their Selected status.
Returns: Returns an integer indicating the selected state of the node. If the node and all of its parents are selected, the method returns ssTrue (2). If the node is selected but one of its parents is not, the return value is ssDisabled (1). If the node is not selected, the return value is ssFalse (0). Return value State 0 False: The node is not selected. 1 Disabled: The node is selected but one of its parents is not. 2 True: The node and all of its parents are selected.
AttributeByIndex(Integer Index) Returns the value of the Metadata attribute at the specified index. Parameters: Index 0-based index of the attribute value to retrieve. The index of the first element is 0 and the index of the last is Count-1. Returns: The value of the attribute as a string. Exception: l EOleException: Index is lower than 0 or higher than Count-1. AttributeByName(const String Name) Returns the value of the metadata attribute of the specified name.
Places a copy of the current node, along with all of its children, attributes and fields, in the metadata clipboard. Modifying the original node after the copy is made does not modify the copy in the clipboard. Cut() Not available in MetaJob Places a copy of the current node, along with all of its children, attributes and fields, in the metadata clipboard and immediately removes the original from the Metadata structure. Warning The node being cut is removed immediately.
Warning The node being deleted is removed immediately. Any reference to it or its child nodes becomes invalid. The results of calling methods of such references is undefined. DocumentCount() MetaJob only Returns the number of MetaDocument in all child nodes. This method recursively goes through all child nodes to count the total number of MetaDocument nodes that are contained underneath the current node. Returns: Total number (integer) of MetaDocument nodes found under the current node.
starting at the first field in the list. Parameters: Name Name of the field to retrieve. Returns: The value of the field as a string. If an field named Name is not found, an empty string is returned. 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.
Returns the index of this page in its parent document, taking all the pages from all the datapages into account. Returns: Absolute index (integer, 0-based) of the page within all the pages under the parent document. IndexInGroup() MetaDocument, MetaDatapage and MetaPage only Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account. Returns: Absolute index (integer, 0-based) of the page within all the pages under the parent group.
Parameters: Index 0-based index of the node to retrieve. The index of the first node is 0 and the index of the last is Count-1. Returns: Reference to the specified node. Exception: l EOleException: Index is lower than 0 or higher than Count-1. 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.
PasteAt(Integer Index) Not available in MetaPage Inserts the contents of the metadata clipboard at the specified index in the current node. This removes the node from the clipboard, making it empty after the paste operation. 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.
SelectedDatapageCount() MetaJob and MetaGroup only Returns the number of datapages under the current node that are set to be part of the output, i.e. 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. SelectedDocumentCount() MetaJob only Returns the number of documents under the current node that are set to be part of the output, i.e.
Returns the index of this page in its parent group, taking only the selected pages from all the datapages from all documents into account. Returns: Absolute index (0-based) of the page within all the selected pages under the parent group. If the page is not set to be output (i.e. its SelectedState is different than ssTrue), it returns -1.
Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3) Not available in MetaJob Sorts the sub-nodes contained in the node according to a number of sort criteria. Unselected sub-nodes will be placed at the end, after all the selected sub-nodes, in the order in which they were placed prior to the sort. Each of the three sort criteria can be modified by specifying one or more flags.
String comparisons are done without regards to the case (case-insensitive) using the Windows Win32 API function CompareString(LOCALE_USER_DEFAULT, NORM_IGNORECASE, ...). Parameters: Name Name of the field or attribute contained in each sub-node whose value will be used as the first sort criteria. If it is an attribute instead of a field, this needs to be specified in the Flags parameter. Flags (optional) Set of flags that modify how the sorting on Name is done.
Attributes An Attribute is a read-only, system-defined element: a name/value pair, where the name is case-insensitive. It holds certain information about a certain "Node" on page 217 in the Metadata 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.
collection. "CountByName(const String Name)" on page 246 Integer "Delete(Integer Index)" on page 246 Returns the number of elements with the specified name. Deletes the element at the specified index. "Item(Integer Index)" on page 247 String Returns the value of the element stored at the specified index. "ItemByName(const String Name)" on page 247 String Returns the value of the element of the specified name.
Note The presence of some finishing attributes depends on the PlanetPress Design document and target device used when producing the job. l Index/Count attributes are not part of the original Metadata file. They are evaluated dynamically, based on the content of the Metadata. Note Metadata Index/Count values are one-based when viewed in the user interface: the first element in any collection has an index of 1 and the last element's index corresponds to the collection's length.
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e encoding. DataFile (optional) Path and name of the data file used by the PlanetPress Design Document. Producti on X X X Date Date the Metadata was created in ISO format. Producti on X X X Time Time the Metadata was created in ISO format. Producti on X X X Title Title of the source document. Producti on X X X Producer Name of the software that created the Metadata.
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e TargetDevice Name of the device for which the Metadata and associated data is intended. Producti on X X X Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input. Producti on X Dimension Two floatingpoint values separated by a colon indicating the media size in typographical points (ex: 612:792).
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e respectively portrait, landscape, rotated portrait and rotated landscape. Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent. Finishin g X Duplex "None", "DuplexTumb le" or "DuplexNoTu mble"; indicates a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source.
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedependent color of the media. Finishin g X X X X X MediaType Devicedependent type of the media.
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e X X X X X X X node within all the nodes under the parent Group. IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
Attribute Description Categor y SelectedIndexInD ocument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInG roup Returns the Absolute index of the node within all the selected nodes under the parent Group. Index/C ount SelectedIndexInJ ob Returns the Absolute index of the node within all the selected nodes under the parent Job.
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e a Windows driver. 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 217 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 234.
for the numerical values to use. Clear() "CountByName(const String Name)" on page 246 Deletes all the elements of the collection. Integer "Delete(Integer Index)" on page 246 Returns the number of elements with the specified name. Deletes the element at the specified index. "Item(Integer Index)" on page 247 String Returns the value of the element stored at the specified index. "ItemByName(const String Name)" on page 247 String Returns the value of the element of the specified name.
Name of the element to add. The name must adhere to this syntax rules: start with a letter, followed by zero or more letters, numbers, underscore or dash. The name is not casesensitive. Value Value of the element. There is no restriction on the content, although binary is discouraged. 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.
Note In an Active Script environment, such as the Run Script task, you must use the numerical value, since the TAddFlags type is not defined in an Active Script environment. Index (optional) 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.
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. 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.
Returns The value of the element as a string. If no element is found, an empty string is returned. Fields only: If more than one field has the specified name, the value of the first one in the list is returned. ItemByNameIndex(const String Name, Integer Index) Fields only 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.
0-based Index of the element value to retrieve. The first element in the collection is at index 0, and the last is at Count-1. Returns The name of the element as a string. 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.
"Find(const String Key)" on the facing page Integer Finds an item in the list and returns its index. "Key(Integer Index)" on the facing page String Returns the key at the specified index. "Sort()" on the facing page Sorts the list. "SortByValue()" on page 252 Sorts the list based on the value instead of the key. "Value(Integer Index )" on page 252 Integer Returns the value at the specified index.
Delete(Integer Index) Removes a single string from the list. Index 0-based index of the string to remove. 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.
SortByValue() Sorts the items in the list according to their value instead of the key. Value(Integer Index ) Retrieves the value of the optional integer at the specified index. Index 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.
"IPdfInfos" on page 282, "IPdfPrintParams" on page 283 and "IPdfRect" on page 284 are the structures used. Note In OL Connect, PDF files are normally best handled by "OL Connect tasks" on page 617. However, the AlambicEdit API can provide a solution in special situations; see for 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[,...
Properties Syntax PROPERTY_TYPE propName 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).
VBScript implementation: set pdfRect = myPDF.Pages(0).Size pageWidth = pdfRect.right - pdfRect.left 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.
"GetXMP()" on page 259 STRING Retrieves the XMP attachment embedded in the PDF. "GetXYML()" on page 260 STRING Retrieves the entire extractable text from the PDF in XYML format. "IsProtected(filename)" on page 260 BOOL Returns True if the PDF file is passwordprotected. When a file is passwordprotected, the OpenEx() method must be used instead of the Open() method. "MergeWith(pdfFilename)" on page 260 Merges the pages of pdfFilename (the source) with the pages of the current PDF (the destination).
"PrintEx(printername, *PdfPrintParams)" on page 264 Prints a range of PDF pages to the specified Windows printer with specific printer options stored in an "IPdfPrintParams" on page 283 structure. "Save()" on page 264 Saves changes to the PDF file. The version of the PDF file format is the highest possible for a newly created file and is unchanged when saving an existing file, unless the SetVersion method was called in which case the file format used will be the one set by SetVersion.
Note: Before using Close() in Javascript, you should call the CollectGarbage() global method to ensure all references to pages are properly discarded. This additional statement is not required with other languages. For instance: var objPDF = Watch.GetPDFEditObject(); objPDF.Open(Watch.GetJobFileName(), false); var objPages = objPDF.Pages(); var objPage = null; for(var i=0; i
VOID ConvertToVDX (STRING pdfFilename, STRING ppmlFilename) pdfFilename Name of the file to convert. ppmlFilename Name of the PPML file to embed. GetInfos() Retrieves the contents of the Document Information Dictionary from the PDF. Syntax IPdfInfos GetInfos () Return value An "IPdfInfos" on page 282 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.
Return value String containing the complete text of the PDF's XMP attachment. GetXYML() Retrieves the entire extractable text from the PDF in XYML format. Syntax 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 262.
Syntax VOID MergeWith (STRING pdfFilename) pdfFilename Name of the source PDF from which pages are taken to be overlaid on the pages of the destination PDF. 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.
Horizontal space to put between the top left corner of each source page, in points. yoffset Vertical space to put between the top left corner of each source page, in points. scaleFactor 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.
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. Pages() Provides access to the Pages collection of the PDF. Syntax 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.
PrintEx(printername, *PdfPrintParams) Prints a range of PDF pages to the specified Windows printer with specific printer options stored in an "IPdfPrintParams" on page 283 structure. See also: "Print(printername)" on the previous page. Syntax VOID PrintEx ( STRING printerName, IPdfPrintParams * PdfPrintParams ) 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.
Infos "IPdfInfos" on page 282 structure containing the new values. setPageCacheSize(cacheSize) Sets the maximum number of IPage objects in the cache. Calling this method flushes the cache. Syntax VOID setPageCacheSize ( UNSIGNED LONG cacheSize ) 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.
SetVersion (major, minor) Sets the version of the underlying PDF file format. This is applied when the file is saved. See also: "Save()" on page 264. Syntax VOID SetVersion ( LONG major, LONG minor ) major Major version number. minor 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.
"Delete()" on page 268 Deletes a page from the PDF. "ExtractTo (destFilename, srcIndex, srcCount, optimize)" on the next page Extracts pages from the PDF and creates a new file with these pages. "Insert(index, *mediaSize)" on page 269 Inserts a new blank page in the PDF file. "InsertFrom (srcFilename, srcIndex, srcCount, destIndex)" on page 269 Inserts pages from another PDF file into this one. All relevant resources are copied with the pages.
Syntax LONG Count ( ) Return value The number of pages in the PDF. Delete() Deletes a page from the PDF. 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.
If true, optimize (linearize and garbage-collect) the output file. Insert(index, *mediaSize) Inserts a new blank page in the PDF file. See also: "Count()" on page 267. Syntax VOID Insert ( LONG index, IPdfRect * mediaSize ) 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 284 structure containing the rectangular dimensions of the new page, in points. Cannot be NULL.
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.Count(). InsertFrom2(srcPages, srcIndex, srcCount, destIndex) Inserts pages from another IPages object into this one. All relevant resources are copied with the pages. See also: "Count()" on page 267.
IPage Item ( LONG index ) index 0-based index of the page to acquire. Return value An IPage object for the specified page. (See "Page object" below.) Move(index, count, offset) Moves a range of pages within the same PDF. 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.
Orientation Integer Gets/sets the orientation of the page, in degrees. The value is always a multiple of 90 and is the number of degrees the page should be rotated clockwise when displayed or printed. IPage methods Name Return type Description "ExtractText(left, bottom, right, top)" on page 275 String Deprecated. Returns the text located inside the region bounded by the left, bottom, right and top parameters. If multiple lines are found, they are separated by a CR-LF pair.
on page 278 Supported image types are: JPG and PNG. "Merge2(srcPage, left, top, rotateAngle, scaleFactor)" on page 279 Transparently places a PDF page on top of the current page at a specific location. "MergeToLayer(imageFile, left, top, rotateAngle, scaleFactor, layerName)" on page 280 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.
scale Scale at which to draw. To draw at the 100% size, use a scale of device_dpi / 72. Do not use the DC to do the scaling; this will result in scaling artifacts being drawn. offsetX 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).
ExtractText(left, bottom, right, top) Returns the text located inside the region bounded by the left, bottom, right and top parameters. If multiple lines are found, they are separated by a CR-LF pair. Warning This method is subject to many limitations (see below) and exists for backwardcompatibility and debugging purposes only. For production purposes, use ExtractText2() instead.
Limitations l No Unicode support. l A word is extracted only if it fits entirely in the region. l Empty lines are not supported. l A maximum of 4096 chars is returned. l A word can contain a maximum of 128 chars. l Horizontal moveto is not considered as a space. l /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.
Distance in inches of the right limit of the region from the left edge of the /CropBox. Must be between 0 and 5000. bottom Distance in inches of the bottom limit of the region from the top edge of the /CropBox. Must be between 0 and 5000. Return value A string containing the text extracted from the specified region. 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.
Syntax VOID setTolerances ( FLOAT tolerableDeltaWidth, FLOAT tolerableDeltaHeight, FLOAT tolerableDeltaFontHeight, FLOAT tolerableGap ) tolerableDeltaWidth Tolerable delta width factor value. tolerableDeltaHeight Tolerable delta height factor value. tolerableDeltaFontHeight Tolerable delta font height factor value. 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.
Coordinate at which to place the left edge of the image from the left edge of the page, in points. top Coordinate at which to place the top edge of the image from the top of the page, in points. rotateAngle Angle at which to rotate counter-clockwise the inserted image, in degrees. The rotation is done after the image is placed at (left, top) and centered around that point. 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.
rotateAngle Angle at which to rotate counter-clockwise the inserted image, in degrees. The rotation is done after the image is placed at (left, top) and centered around that point. 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. 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).
Angle at which to rotate counter-clockwise the inserted image, in degrees. The rotation is done after the image is placed at (left, top) and centered around that point. 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. layerName 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.
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. 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. 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.
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.
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.
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 100).
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.
$s = $Watch->GetJobInfo(9); if ($s eq "") { eval {die "Value cannot be empty!"}; } else { # Do something with Job Info 9! $Watch->Log("Job Info 9's value is: ${s}",4); } Special workflow types PReS Workflow supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility. However, some types of processes like PDF and HTTP processes, and processes related to another product, are important enough to pay some attention to them.
OL Connect Send (see "OL Connect Send" on page 776) 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 335.
l HTTP Data Submission: A custom application or a server sends the request to PReS Workflow using either a POST or GET command. The application or server then waits for a response from PReS Workflow. PReS Workflow can serve both static and dynamic resources to a web browser, however it is not meant to be used as a fully featured web server, as it is not built for responsiveness nor guaranteed uptime.
type http://www.objectiflune.com/ in my browser, it is actually accessing the address http://www.objectiflune.com:80/ , but port 80 is always hidden. The reason port 8080 is used by default is to prevent any interference with existing web servers installed or activated on the same server as PReS Workflow. l l l Time-out (seconds): This determines how long the HTTP Server service will wait for the process to finish, before returning a time out error back to the client browser.
You also need to take into consideration the options inside each of your processes that start with the HTTP Server Input task, as they will greatly impact how this process responds. In the process's properties, the following options will modify HTTP behavior: l l l Self-Replicating Process: This option is critically important when dealing with HTTP processes.
successful or an HTML page with an error message, it will not attempt to send an HTML with a PDF mime type (which, obviously, would cause confusion). l There is no HTTP Server Output task (see below on how to end your process) Request/process/response cycle Once a process using the HTTP Server Input task is created, it is important to understand the cycle that is triggered when such a process runs.
the Imaging. Similarly, ending a process with the Delete task does not return an empty file, it returns the actual data file. Actually the most used way of returning a response is this: generate an HTML file using either "Create File" on page 348 or "Load External File" on page 448, then use the "Delete" on page 673 task as a last output. The HTML is thus returned to the client.
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 503. The condition returns "true" if the file is not found: c:\PReS\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value
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 643 task. l If, however, the file is found, then it is loaded with the "Load External File" on page 448 task, and then deleted (for the same reasons).
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!).
Things to keep in mind while working with Metadata are set forth in another topic: "Working with Metadata" on page 79. Note In Connect it is also possible to group, sort and split PDF data using "OL Connect tasks" on page 617. Example: Daily sales report from PDF files This workflow makes heavy use of PDF tasks and Metadata, and assumes that you are using PReS Workflow version 7.3 or higher.
l l l l l l The "Metadata Filter" on page 593 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 599 then re-orders the Metadata documents by Rep ID, so that all of the invoices for any particular sales representative are all together.
l "Security Considerations" on page 752 l "20,000 Patterns" on page 753 l "PlanetPress Capture Implementation Restrictions" on page 761 There are also 2 external tools that are used to communicate the pen's data to PReS Workflow: l "Anoto penDirector" on page 759 l "PlanetPress Mobile Application" on page 761 Creating a Capture-Ready document This is done when creating your PlanetPress Design document.
l l l l The "Capture Fields Processor" on page 572, 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 564 task to do post-processing using the Capture Fields data. A "Get Capture Document" on page 582 action task to retrieve each document in the database and output a PDF file Any existing output such as Output to Folder, email, ftp, etc.
l A "PGC to PDF Converter" on page 585 task converts the PGC to a PDF l Any existing output is used here, for example an email notification. The Examples l "Basic Functional Capture Workflow" on page 328 l "Capture Post Processing Workflow" on page 330 l "Capture Web Manager Workflow" on page 333 PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Suite Production.
Anoto Digital Pen A digital pen compatible with the Anoto system. These pens contain a camera, processor and memory chip which record each stroke of the pen on a printed Anoto Pattern, and are able to send this information back to PReS Workflow. This document specifically refers to the Anoto DP-201 Digital Pen, not other equipment has been tested.
Client/Server Architecture A multi-server setup where more then one PReS Workflow server are connected as clients to a single PReS Workflow server which has a Capture Database. In this architecture, the Server contains the licenses for the pens, however the Client contains the database of documents and patterns. The Clients communicate with the server to authenticate pens. This architecture is only provided to simplify pen licensing for users with a large number of pens.
Pattern Sequence Pattern Sequences enable the multiplication of the number of available pattern by adding an extra identification to the document. A Pattern Sequence is also attributed to each Anoto Digital Pen, such as an incoming PGC file will contain the Pattern, on which the Pattern Sequence is added from the pen database. The pattern and pattern sequence refer to a specific document in the database.
General considerations Here are some general considerations in regards to PlanetPress Capture, its environment, the hardware and the software that interacts with it. Please review these considerations carefully as they may impact PlanetPress Capture and its functionality. Warning PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently.
l l Microsoft Access l l Database file (mdb) must be local to the PReS Workflow computer. It cannot be located on a network drive or another server. l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PReS Workflow through an ODBC connection on the local network.
l l l In MySQL, the 16 megs packet size limit can be an issue if the PDFs created by Capture are larger than this size; An error saying "MySQL Server has gone away" would appear in this case. This can be fixed by configuring the max_allowed_packet setting in the MySQL Configuration (Reference). Also in MySQL, if a timeout occurs on simultaneous record access, resubmitting the PGC for processing should resolve the issue.
l l l l l PGC Files, while not written in plain text, are not encrypted and are readable through either PReS Workflow (even a server that did not generate the document associated with it), or through third-party applications using the Anoto SDK. This means if someone gains access to your PGC storage folder, they may be able to read the signatures, checkmarks and other information contained in it and reproduce them on a document of their choice. It is always better to secure this folder properly.
The Numbers First and foremost, the 20,000 patterns is a fixed number - PReS can only generate 20,000 unique patterns as this is the number of patterns that we license through Anoto. The 20,000 patterns are, however, not all available when generating documents. There are 8 "demo" patterns that are used to generate documents when PlanetPress Capture is in demo mode (no license activated), and react the same way that the bulk of the 20,000 patterns.
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.
"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 PReS Workflow process.
Note The mobile phone application, "PlanetPress Mobile", which uses Bluetooth communication to receive pen data and transmit it to PReS 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".
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.
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 PReS 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 PReS Workflow. The setup will install a preconfigured version of penDirector which can be immediately used with PlanetPress Capture.
2. Note down the PIN of the Anoto Digital Pen, by docking the pen and going in the Pen settings tab of penDirector and looking at the Pen access group at the bottom of the dialog. The default PIN is 0000. 3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4. 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.
between the pen and the mobile phone is done through Bluetooth, while the connectivity between the mobile phone and PReS Workflow is through the currently active data plan (either wifi or the cell phone company's data plan, such as 3G). PlanetPress Capture Implementation Restrictions This document describes the limitations of the Anoto Digital Pen & Paper Technology, especially in regards to using it within a PReS Workflow implementation.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Why: The available filters to interpret the ink marks done with the Anoto digital pen, allow you to select the engine language to be used. Doing so will give you results that are the closest match to the captured data. Multiple cultural characters can be interpreted with ICR once the correct language is selected such as û, à, é, etc. How: This option is available from the Capture Fields Processor task.
Possibility of Interpretation Error in an Automated Process l l Target: Workflow designer What: We cannot be 100% sure that a character would be recognized by PlanetPress Capture as it should. Therefore, the analysis of a value interpreted with ICR should only occur if the level of confidence is superior to a determined level. Why: An automated process can treat the characters incorrectly due to an incorrect interpretation of a value. This occurrence should be minimized as much as possible.
l Any input task l "Create Metadata" on page 586 l "Capture Fields Generator" on page 569 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.
l "Get Capture Document" on page 582 l Archive or Print output Capture Post Processing Workflow Though the "Basic Functional Capture Workflow" on page 328 is minimal functional one, it will most likely not be enough for most actual implementations. The goal with PlanetPress Capture (and PReS Workflow in general) being to automate as much as possible, there are some tools within the PlanetPress Capture tasks that can greatly help with this goal.
Task Breakdown: l l l The HTTP Server Input receives a POST request sent either by the Anoto penDirector or the PlanetPress Mobile Application. This requests contains information sent by the pen as well as a PGC file as an attachment. Because we're only concerned about the PGC, the task is configured to ignore the XML envelope as well as loop through each attachments (of which there is only one). So, the output of the task is the PGC file alone.
After Retrieving Information from the Capture Database There are two basic ways in which the Find Capture Document task can be used. First, in an automated process that runs at specified intervals. For example, the following process which sends a daily report of all incomplete and "in error" documents to an agent who would presumably take action on each document through the document manager.
Task Breakdown l l The Find Capture Documents task queries the Capture database for documents that correspond to certain specific conditions. For example, here we would look for all documents that are either in an "Error" or a "Partial" state, which means they received ink but are not completed correctly. To do this, the "Content Status" filter and setting it "Equal to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met".
Installation 1. Download both resource files 2. Create a folder on your disk called c:\PReS 3. Import the invoice.pp7 Design document into Workflow, or open it in PlanetPress Design and send it towards your local PReS Workflow server (localhost or 127.0.0.1). 4. Open the configuration file CaptureExampleProcess.pw7 5. Click the PReS Workflow button (File menu) and go in Preferences. 6.
l The example doesn't use any advanced coding such as JavaScript, Ajax and caching. It's easier to follow, but is less optimized in its use than a complex workflow that would use such features. Workflow processes in a Connect Send solution OL Connect Send (see "OL Connect Send" on page 776) 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.
l The Create Preview PDF plugin generates a PDF preview for a single record as fast as possible. It is typically used for previews embedded in web pages. (See Create Preview PDF.) Production report process The key plugin in a process that produces reports about jobs received with OL Connect Send is the Get Data plugin. It allows to query the OL Connect Send database. (See "Get Data" on page 604.
Some tasks are multipurpose and can be used as either an input, action or output task or any combination. These multipurpose tasks are indicated as such in the task description and can be found in the most relevant section of the available tasks. All plugins can be found in "The Plug-in Bar" on page 913.
To insert a task: 1. Open the Plug-in Bar by clicking on its tab. If you can't see the Plug-in Bar tab, click on the View tab in the Ribbon and make sure the Plug-in Bar is highlighted in the Show/Hide section. 2. Locate the task you want to add to your process. You can navigate between the different task categories by clicking the icons at the bottom of the Plug-in Bar. 3. Using your mouse, click and drag the task in your process at the place you want to insert it. 4.
2. Edit the task properties as required. Click specific tabs to see all the properties associated with the task. 3. Click OK to close the dialog box and save the new properties. Note For the list of operations you can perform on tasks in a process via the Process area, please refer to "The Process area" on page 916. Task properties Any task you add to your PReS Workflow process must be configured using its Properties dialog.
Some Action, Create Content and Output tasks let you select a resource file to use with the task; for more information see "Selecting a resource file in task properties" on page 344. 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. This means that the property can be dynamically determined whenever your process runs, that is to say it will not remain static.
Inserting variables in task properties In any variable properties box, you may use the contextual (right-click) menu to add variables and control characters, as well as to get data and make data selections. The lower part of the contextual menu is divided into 4 items that provide variable properties: l Variables l System: Contains standard system variables, see "System variables" on page 735.
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. Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example.
Mask Format Here are the different mask formats available. l l Literal characters: Any alphanumerical character is considered a literal character and must appear. For example, a mask of "trigger.txt" will not capture any other files than that name. Wildcards: Two wildcards are available in masks. l l l Asterisk (*): Supports any number of characters. *.txt would pick up any text file, file*.txt would pick up any file starting with file and any characters: file1.txt, filetest.txt.
Selecting a resource file in task properties The Properties dialog of some Action, Create Content and Output tasks lets you select a file. Depending on where the selection list appears you will have access to the Connect Resources ("Connect resources" on page 40), all PlanetPress Design documents ("PlanetPress Design documents" on page 44) or only to the PlanetPress Design documents installed on a printer queue.
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.
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.
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PReS Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 895.
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. Since Create File input tasks are not dependent on data from external sources, they are performed at every polling interval and the process is thus started every time.
CSV files for example. l 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. 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.
Note If Microsoft Outlook connection is used, Microsoft Outlook 2000 or higher must be installed on the computer where PReS Workflow is located. Input Email Input captures all emails and their attachments from the selected inbox, when those emails correspond to the rules defined in the General tab. If no rule is defined, all emails in the inbox are retrieved. Emails retrieved using POP3 are deleted from the server, emails retrieved from an Outlook inbox are moved to the Deleted Items folder by default.
Task properties General Tab l Data Location group l l l Message body: Select to use the data found in the body of the email. Attached file: Select to use the data found in the email’s attachment. If both the Message body and Attached files options are selected, the message’s body and the message’s attachment are treated as separate data files and processed one after the other. Unzip attached file: Select to unzip the attached files.
Login Tab l Use Microsoft Outlook: Select to use the Microsoft Outlook email account of the current user to receive emails. The current user is the one defined in PReS Workflow Service Logon. l l Move message after processing to folder: Enter the name of an Outlook Folder to keep copies of the emails taken by this email input task. You should enter only the name of the folder as it appears in Outlook’s Folder List area, regardless of whether it is a child of another folder.
CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 895. 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.
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 PReS Workflow.
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 342. 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.
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.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Folder Listing Folder Listing input tasks list the files present in a selected folder and gives you the option to use filename masks, to sort files by name or date, and to list the files present in the selected folder’s subfolders. The lists it generates are in XML format.
test1.pdf C:\Samples\ 20197 C:\Samples\manuals\ usermanual.pdf C:\Samples\manuals\ 644037 Note The
l l l l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PReS Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool.
Processing Each file capture by the input is sent down through the process, one at a time. When the file is finished, the process goes back to the input which feeds another file down, as long as there are files in the queue. Once all the files are gone, the task polls the FTP folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. Output The output to this task is a series of individual files, one after the other.
"Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PReS Workflow Tools working folders under the "Backup" folder.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. HTTP Client Input HTTP Client Input tasks use the HTTP protocol to issue HTTP GET commands (queries) to HTTP servers. Replies received from the HTTP servers are used as jobfiles and are thus passed on to following tasks. Input This initial input task retrieves a single file as specified in the URL option. This file may be of any format, even formats that are not readable by PReS Workflow.
Secure connections (SSL) made with the HTTP Input Client are known to experience issues when connecting to site bindings using the Server Name Indication (SNI). Disabling SNI through the server's site bindings configuration will allow proper SSL connection through the HTTP Input Client. l Server requires authentication: Check this option if the HTTP server requires user authentication. This enables the following options. l User name: A user name known to the Web server.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. HTTP Server Input HTTP Server Input tasks are used to receive HTTP requests made via GET or POST commands and to send replies to the servers from which the requests were made. The HTTP server supports both HTTP and HTTPS. For HTTPS Support information, see "HTTP Server Input plugin preferences 1" on page 816.
Warning It is highly recommended to make all processes using the HTTP Server Input task selfreplicating and to reduce their polling interval in the "Process properties" on page 895. Examples This task is put into effect in the following example processes: l HTTP PDF Invoice Request l HTTP Brochure Request l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Input The HTTP Server Input task does not, by itself, capture any files.
Processing Depending on the options chosen in the HTTP Server Input task properties, the task may choose to ignore some of the files. For example, using the "Do not include XML envelope" means that only the POST attachments will be used in the process, the XML file will be discarded. Attachments are always saved on disk in a specific location, which is accessible either directly in the XML or directly as a data file through the "Loop each attachment as data file" option.
l Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the HTTP Server Input task loop through each attachment. Each data file is an XML with the accompanied file. l l 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.
COTG user or the expiry date of the form. "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.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Input Error Bin The Input Error Bin task is used specifically and only to create error management processes. These processes do not run on their own but are rather triggered by the On Error tab of tasks in other processes, when that task fails. Input This task receives a data file from a task that generated an error.
Output The output of this task is the same as the input - a data file and job infos that are sent from a task that generated an error. Task properties General Tab l The Input Error Bin task does not have any specific properties unique to it, since it only receives input directly from tasks in other processes when an error is generated. For more information, see the chapter on "Debugging and error handling" on page 99.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Input SOAP The Input SOAP task is used to answer calls from a remote SOAP client and to return a response to that request. It is similar in functionality to the "HTTP Server Input" on page 364 task. Note SOAP communication is non-trivial and requires a certain understanding of XML and the SOAP protocol.
Output As with the HTTP Server Input, this task has a dual-output purpose. First, when the initial input task is run, the XML request is output onto the process. Then, when the process is finished, the last job file generated by the process is returned to the requesting client. Task properties General Tab l SOAP Action: The SOAP action is used with the SubmitJob action. It’s the equivalent of the process name. The difference is that more than one processes can share the same SOAP action.
Job Information definitions l This task does not generate any job information. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. LPD Input LPD (Line Printer Daemon) Input tasks retrieve data in the form of print files sent from remote computers using the LPD/LPR protocol.
Task properties General Tab l LPD queue name: Enter the queue name specified in the printer queue on the remote computer or computers. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job 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.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Merge PDF Files The Merge PDF Files Input task (formerly named "Concatenate PDF Files") captures all PDF files in a given folder and merges them into a single PDF file. This task is put into effect in the following example process: "Example: Daily sales report from PDF files" on page 297.
Task properties General Tab l l l l l l l l l Folder: 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 342. Since this task only supports PDF files, make sure your extension remains .PDF for all your masks. Sort files by: Select a given sorting method to prompt PReS Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order).
Note Metadata can be manipulated with Metadata tasks; see "Metadata tasks" on page 586. "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.
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 (installed by Workflow) instead of Workflow's custom server component. The NodeJS Server is more secure, more up to date and more standardized. For instance: l PUT and DELETE actions can be posted to the server.
or Apache) to serve your contents and to let Workflow process things only it can do. For more information on how to serve HTML and PDF generated by Connect through IIS, watch the Connect with Evie - IIS series.
The NodeJS Server Input task supports basic content-types (multipart/form-data, application/xwww-urlencoded, and application/octet-stream) as well as raw body content-types: l text/plain (.txt) l application/xml, text/xml (.xml) l text/html (.html) l application/xhtml+xml (.xhtml) l text/css (.css) l text/csv (.csv) l application/json (.json) l application/javascript (.
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. However, if this option is not checked, it means there is a second output that comes out of the NodeJS Server Input task: the last output generated by PReS Workflow is sent back to the initial input, by which it is returned to the client.
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.
l l Response file: Select which file to return. Note that the file name doesn't have to be static. You can use any combination of text, variables and data selections; see "Variable task properties" on page 340. 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; for example: "200 OK", "404 Not Found" or "401 Unauthorized". Choose a response code between 100 and 599.
"Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 895. 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.
Note PrintShop Mail Web and PReS Workflow must be installed on the same server in order to make the PrintShop Web Connect Input task available in your PReS Workflow. Input This task does not poll an input, it sits there and waits for a job file to be sent by the local PrintShop Mail Web installation. Processing When the job is received from PrintShop Mail Web, it is saved as a job file. No further processing is done on the file.
General Tab l l All documents: Lists, in a hierarchical view (Company -> Publication Types -> Documents), the PrintShop Mail documents already existing on the PrintShop Web server. Refresh: Click to update the list of PrintShop Mail documents available on the PrintShop Web server. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables are automatically created by the input task.
Secure Email Input The Secure Email Input task captures a POP3 or IMAP email message with SSL or TLS encryption. Note that this plugin cannot be used on a Windows instance that uses a multi-byte language (e.g. Japanese, Chinese). The workaround is to either use a different Windows language or use the standard Email Input/Output plugins. Input Secure Email Input captures an email and its attachments from the selected inbox when it corresponds to the rules defined in the General tab.
Output Once the plugin is done processing, an XML file is created with the email’s details and location of the body and any attachments. The encoding of the XML file is Windows-1252. The body and attachments are located in the job's Temp folder of Workflow. Within the same process, those files must be moved to another location, otherwise they will be deleted at the end of the process (as expected for all files in the Temp Workflow folder).
The most pertinent information is located at the top level, under . The sub node contains all the files for the email. For each file, the type (body or attachment), folder and filename is provided. A file of type Body is always present and contains the body of the email. The information is the same for all files and is repeated to facilitate the selection when using an "XML Splitter" on page 496.
values may be different for some implementations or may change in the future. Note that emails retrieved using POP3 are always deleted from the server. l Enter the account credentials: the email account name on the mail server, and the password required to unlock the selected account. Note By default, GMail may not allow Workflow to access the account’s mail boxes unless that account specifically allows automated systems to access the inbox.
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PReS Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 895.
Task properties General Tab l Since Serial Input tasks have no specific task configurable properties, this section contains no property information. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SFTP Input The SFTP Input task retrieves files from a secure FTP site through an encrypted connection. Masks are typically used to select multiple files to be retrieved from the server. The SFTP Input and "SFTP Output" on page 676 tasks are part of a separate installer and are not included in the Workflow installer.
l l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH). l FTPS: Select if the FTP server uses FTPS (SSL/TSL) Port Number Group l l l Password: If account named in the User name box is password protected, enter the password here. Use default port: Check to use the default port used by the protocol selected above. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available.
l l Passive: Select to prompt the ftp client to use the passive mode when retrieving files from the FTP server. Reset Download List: Security Tab This tab defines the certificates used to connect to the secured FTP servers. l l l l Accept all certificates: Check this option to automatically accept the certificates returned by the FTP server.
CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 895. 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.
Warning Emails received through this task will not reach their intended destination if the process does not end with a Send Email Output Task, or contain the PReS Connect "Create Email Content" on page 625 task. Example In this example, the SMTP Input plugin is used to capture incoming emails data that must meet certain conditions as the subject that contains "Work to do" and the sender that contains "client@company.com ".
Input The SMTP Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received.
places them in a specific location on the drive. When a request is received, the SMTP Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received. Warning Due to a technical limitation the SMTP Input task does NOT receive the BCC addresses from most emails sent to it. Processing The task reads the incoming SMTP request and provides the data within its body.
Task properties General Tab l l Data location: Determines what files are sent into the process: l Envelope: Only the request envelope is sent to the process (see above). l Attachments: Each attachment is sent down the process (see above). Unzip attached file: Select to unzip the attached files. l l Zip password: Enter the password required to unzip the attached files (if any). Note that you can use variables and data selections.
CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 895. 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.
Input This task does not poll an input, it sits there and waits for a job file to be sent through the Telnet port. Processing When the job is received through Telnet, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. Task properties General Tab l l Port: Enter the number of the port on which PReS Workflow is to listen for Raw Socket communications. The default port number is 9100.
The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 895. l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions This task does not generate any job information.
Processing The print job, by default, is in EMF format. If this option is selected, no action is taken on the data file. However, if the RAW format is selected, the job is converted to RAW. Furthermore, if the Create PDF option is selected, the file is converted to a PDF, including metadata. Output Either one of 3 formats is output from this task: l An EMF job format l A RAW job format l A PDF with attached metadata.
"Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PReS Workflow Tools working folders under the "Backup" folder.
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 PReS Workflow to perform a wide variety of operations. PReS Workflow includes more Action tasks then Input and Output tasks combined. Action tasks can even be used to input data and to output data. The difference between an Action task and an Input task is that an Action task can never be the first task of a process.
l "Run Script" on page 506 l "Search and Replace" on page 463 l "Send Images to Printer" on page 464 l "Send to Folder" on page 466 l "Set Job Infos and Variables" on page 468 l "SOAP Client plugin" on page 678 l "Standard Filter" on page 471 l "Translator" on page 473 l "Windows Print Converter" on page 474 Add Document The Add Document action task prepares a printer-centric PostScript job by adding a PostScript version of a selected PReS Connect document and the trigger to execute it bef
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 44). Add job information to the document: Select to prompt your PReS Workflow to add the available job information elements in the header of the generated file. Note that this option is only enabled if a document was selected. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General tab l l l l l l l l Action group l Add: Select if you want the task to add content to the job file. l Remove: Select if you want the task to remove content from the job file. Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
Task properties General tab l Search mode group: Select your chosen search mode within this group. l l l l l Search whole file: Select if you want the entire data stream to be searched as if it were a single string of text. When this option is selected, PReS Workflow loads the entire file in memory. It offers more flexibility, since search expressions may span across multiple lines and may result in more successful hits. Note that since this option uses more memory, it may affect performance.
l l l l l At the beginning of a line: Select to indicate that the search string must be the first string on the line. At the end of a line: Select to indicate that the search string must be the last string on the line. At column: Select to indicate that the search string must be in a specific column. Specify the column number (the value must be greater then 0) in the Column value box below. Between specific words: Select to indicate that the search string must be between specific words.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
Output This task outputs the original data file but with modified (or created) Metadata. The format should be the same as the input. Supported barcode types The following types of barcodes are supported: Barcode types Description EAN13 EAN13 symbology. Used with consumer products internationally, 13 characters. EAN8 EAN8 symbology. Short version of EAN-13, 8 characters. UPCA UPCA symbology. Used with consumer products in U.S., 12 characters. UPCE UPCE symbology.
Barcode types Description PDF417 Portable Data File is a 2-dimensional barcode (also known as matrix code) used in a variety of applications, including Transport, Identification cards, and Inventory management. It is best suited for cases where information needs to move with an item or document. DataMatrix DataMatrix is a two-dimensional barcode which can store from 1 to about 2,000 characters.
Settings l l Force checksum validation: Select to define whether the checksum validation is required for symbologies in which a checksum character is optional. The goal of checksum is to detect accidental modification such as corruption to stored data or errors in a barcode values. By default it is set to false.
intensity greater than 128 will be considered as white, while those less than 128 will be considered black. The value 0 means that the color threshold level will be calculated automatically depending on the image. By default Threshold level [0..255] is 0. This parameter is ignored with binary images (black and white images). On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l l l l l l l l l l BarcodeValue: Metadata field representing the value of the barcode. When multiple barcodes are present on the page, this field is present multiple times. BarcodeCount:: Metadata field representing the number of barcodes on the page. Barcode_1_Value: Metadata field representing the value of the first barcode on the page. Note that this field (Barcode_1_Value) contains the same value as the first occurrence of BarcodeValue.
Limitations l l Some barcodes created with PlanetPress 5 could not be read by the Barcode Scan task, so please use PlanetPress version 6 or 7 to create barcoded documents. When using a secondary input, a known issue of the Workflow Tool can cause some unexpected behavior, like having the same Metadata file reused instead of a new one being created for each data file captured. To work around this issue, simply add a Rename action task to set a unique file name (Ex.
Task properties Note Note to PlanetPress Suite users: The options of this task are basically the same as the Data Selector in PlanetPress Design; see PlanetPress Design User Guide. General Tab Add/remove characters: Enter the number of characters to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add characters; negative values remove characters.
appears at the end of a line of data with a LF. Note, however, that it replaces a line feed followed by a carriage return (LFCR) with two LFs. Binary mode is the recommended printer mode when you use an ASCII emulation. Cut on FF character: Select to have a new data page when a form feed character is encountered in the data stream. If you select Cut on FF character, you have two conditions that signal the end of a data page: the form feed character and the number of lines set in the Lines per page box.
and, when you stabilize your data, set Pages in buffer to the number of records you want the buffer to hold. l l l Delimiter: Enter the character that separates the fields of each record in the input data. If you want to use a tab as a delimiter, select Set tab as field delimiter. If you want to use a backslash character (\) as a delimiter, you must precede it with another backslash character (thus you would enter \\).
you would enter \\). You can also specify an ASCII character as a code using its octal value preceded by a backslash (for example, \041 is the exclamation mark character [!]). l l Char, Skip to line: Use these boxes to enter any channel skip codes in your data that tell the document to skip to a specific line. Enter the code in the Char box; enter the line number in the Skip to line box or use the spin buttons to adjust its value. If you want to use a backslash character (\) as a code, you must precede it
Create PDF The Create PDF Action task creates simple PDF files using the default quality. It is very similar to the Digital Action task (see "Digital Action" on page 435) but is more limited. It does not contain the advanced PDF options that are offered by the PReS Image solution (see "About PReS Image" on page 775). In PlanetPress Suite, this task can be used to merge a data file with a specific Design document and output the result as PDF.
Task properties General tab l l Documents: Select None to use the job file as-is. Alternatively, select a specific PlanetPress Design document if you want all the jobs to be generated with that document. Run mode group (only with a PlanetPress Design document): l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to the PDF RIP. Note that some features, such as the Time and Date require that this option be selected.
l l l l PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files. Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128). It gives the task the ability to take an existing PDF in input and apply the selected password to the PDF without any change to the quality level of the original PDF.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. PDF Values Here's a list of the hard-coded PDF values for files generated with this plugin. Basically, these settings correspond to Digital Action and PReS Image settings for Standard Quality (see "About PReS Image" on page 775). l PDF version: 1.
l l l l Pixels per inch: 150 Security: l Allow printing l Allow changing the document l Allow content copying l Allow form filling Font: l Embed all fonts l Subset embedded fonts Open options: l Zoom factor: Fit in window l Default view: Page only Database Query The Database Query action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format.
l l You can use static properties (properties that will remain the same regardless of the data processed at run-time). This option lets you use an Open DataBase Connectivity (ODCB) compliant data source. You can also edit the SQL statement that assembles the database table. Note that you can import a database connection configuration that you previously exported from PlanetPress Design (when you created a document) or from PReS Workflow (when you set up a sample data file for a process).
l l Range group l l l Table/Query: Select the table or query containing the information you need as your input data. All: Select this option use all the records included in the database. Records: Select this option use only some of the records in the database. Indicate the range by entering the number of the first record followed by a dash and the number of the last record. To use records 50 to 75, for example, enter 50-75.
l l Text delimiter: Select the text delimiter to be used in the generated file. l Field separator: Select the field separator to be used in the generated file. l l Add a header record with field names: Select this option if you want the generated file to have a header record (a record that includes the field names only).
or edit the configuration. You may choose any encoding listed in the dropdown list or enter your own. l l l l l l Maximum records per page: Select this option if you want to limit the number of records per page. This option is only available if you indicated that you wanted each data page to contain several records in the Create data pages as follows box.
Dynamic SQL Tab l Use dynamic values at run-time: Select to use a dynamic database connection string and / or SQL statement at run-time. Check this box to enable the options included in this group (this disables the corresponding options in the General tab). l l l l Parse normally: Select to interpret any backslashes included in the database connection string as backslashes. If this option is not selected, any backslash that is not doubled will be disregarded.
Input This task only accepts ZIP files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself. Processing Every file in the ZIP is extracted to the specified location. If a folder structure exists in the ZIP, it is respected in the output folder. Output This task outputs the data file it received with no modification. Metadata and job files are not touched either.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Digital Action Digital Action Action tasks generate the same types of documents as generated by PReS Image output tasks (see "PReS Image" on page 539). Since Digital Action tasks are not Output tasks, the documents they create are typically passed on to the following task. The image files they generate are always saved, along with their index files (if any), to an archive folder.
Note For an explanation of how to generate specific tags and indexes for the Image and Digital Action tasks, in a PDF/VT file created with Connect, see the Connect Online Help: Generating tags for Image output. Alternatively, select a PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections.
independent format. It is used in many digitizing projects as the format of choice for the digital masters. The TIFF Group 3 and Group 4 formats are efficient for document storage. l l l l l l VDX: The output will be a VDX file, which is a PDF file with some PPML code inside of it to enhance performance by doing caching/image reusing. The output can only be used on devices that support the VDX technology. DPI: Enter the dots per inch (dpi) resolution of the output image.
l l l l Folder and filename: Enter the path of the folder to which output files generated by this task are to be archived. PDF index files (PDI and XML) are also put in this folder. This edit box is enabled when the Save a copy option is selected. To prevent each new file from overwriting the previous one, you should use variable names. As with any variable property box, you can use any combination of text, variables and data selections.
l l Job options: Select the PDF output option that best describes your needs. This loads all the standard settings for the selected usage scenario. These settings can be changed as required. Note that if you make changes and then select a different output option, your changes will be lost. PReS Image supports numerous PDF standards: Standard, High Quality, Custom, and a variety of PDF/VT, PDF/A and PDF/X formats.
l l Monochrome images group l l l Keywords: You may enter keywords for the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time. Monochrome compression: Select the compression to use for the monochrome images. Flate compression is lossless, so no data is lost during compression.
shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l l Color images group l l l l Grayscale resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. Color compression: Select the compression to use for the color images. Flate is a lossless compression method, so no data is lost in the process.
l l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files. PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files. Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128).
pages. Select Full screen to hide all screen contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen. l Font group l l l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded.
l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server). Connection time-out: Enter the time, in seconds, that the connection to the database is maintained while no action is taking place before the connection is severed. Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory.
For images you should rather use Send Images to Printer action tasks (See "Send Images to Printer" on page 464), as they provide image quality and conversion options. Input Any file that you wish to upload to the printer. Note that this task does not attempt to verify that the type of file being sent is compatible with the printer, or is in a supported file format. Processing The currently active data file is converted into PostScript.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. External Program External Program action tasks are used to launch and execute other programs, which can be useful when you wish to process your job file in a way that is not possible with the standard PReS Workflow tasks.
Output If the external program modifies the job file using the full path, the modified file is the output of this software. Otherwise, the output is the same as the input. Metadata is not modified in any way. Job Infos may be modified, depending on the options set in the task's properties. Task properties General Tab l Program group l l l l l Parameters: Enter parameters that will be passed to the external program when it is launched.
generated by the program which will indicate whether its execution was a success or if errors were encountered. l l l l Verify return value: Check to enable the group and react whenever specific exit codes are returned by the software. If exit code is: Use the drop-down to select how to compare to the exit code. This numerical comparison is either equal, greater than or lower than. Value: The numerical exit code that will be verified.
Output The loaded file is output. Metadata is not modified in any way, neither are Job Info variables. Task properties General Tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Processing The task executes the mathematical operation and stores the result in the selected job info or variable. Output The input data file is returned with no modifications. Metadata is not modified. A single job info or variable is modified by this task. Task properties General Tab l Mathematical Expression: Variable data field containing the expression to be evaluated. This expression may combine any combination of standard PReS Workflow variables and VBScript mathematical expressions.
Note This task was built using a custom plugin system and does not display the On Error tab in the regular view. To access the On Error tab, right-click on the task and select Advanced Properties... Open XSLT The Open XSLT action task takes an XML file as input and executes the XSLT code as parameter to rearrange the content of the XML file. XSLT (or XSL Transformation) is a style sheet that describes how an XML document is to be transformed into another XML document.
l l l l l l Delete: Delete the current selection (only available if there is selected text in the editor). Select All: Select all of the contents of the editor. l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog. Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. XSLT Version l XSLT 1.
PDF/A-3 Attachments The PDF/A-3 Attachments task is used to add external files as attachments to a PDF/A-3 job file, or to attach files - the job file and/or other files - to an external PDF/A-3 file. Optionally, some e-invoicing metadata can be added. Several e-invoicing standards, such as ZUGFeRD in Germany and Factur-X in France, require the (XML) invoice data to be attached to a PDF/A-3 file.
Properties General Tab l Target PDF/A-3: Specify the file to which the attachments and (optional) metadata must be added. l l l Job file: When this option is checked the attachments are added to the current job file. The job file should be PDF/A-3 compliant. External file: Adds the attachments to an external file. Use the Browse button to select a PDF/A-3 compliant file. Note that the task doesn't verify that the target file is PDF/A-3 compliant.
Warning If the target PDF already has an attachment with the same name, the existing attachment will be replaced without any error. l l Mime Type: Enter the mime type of the attachment, e.g. text/xml, image/gif. Relationship: Specifies what the attachment is in relation to the (entire) PDF document: l l l l l Alternative: An alternative representation of the PDF document; for instance, an XML version of the invoice in the PDF.
l l l Extension schema: Select the standard to which the PDF and the XML invoice data conform. The standard's extension schema specifies which properties should be added as metadata. Uri: The value of the namespace URI in the selected extension schema (read-only). Properties: l l The DocumentFileName, DocumentType and Version are read-only. ConformanceLevel: Each standard specifies a number of different levels a file can conform to.
Properties The General tab has the following options: l l l Output format: The output format can be either PNG or JPG. Resolution: Specify the resolution of the bitmaps (pixels per inch). The minimum is 12, the maximum is 1200. For example, with the minimum of 12, a PDF page that is 8,5 inch wide is converted into a bitmap of 102 pixels wide, which could be used as a thumbnail on a web page. Page range: An asterisk (*) means: convert all pages.
The Push to Repository task can also be used to update an existing KeySet if a lookup is provided. Input Any data file, in any format. Processing A new KeySet is added to the Data Repository, or updated, using the data provided. Output The unmodified input file. This task does not change the data file in any way. The only modification is a single variable or Job Info variable, if the Store Result option is selected.
or more. Here are some valid conditions: l l l last_name = 'Jones' l id = 237 l age IS NOT NULL l last_name LIKE 'La%' l province IN ('QC', 'ON', 'AB') Add KeySet when condition is false: If the update condition above is false, a new KeySet is added to the group. If unchecked, no data is changed in the repository. Store the result ID in variable: Select a variable or Job Info in which an array of inserted or updated IDs will be placed.
Task properties General Tab l New file name: Enter the job file’s new name.You can use any combination of text, variables and data selections; see "Variable task properties" on page 340. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Output Whatever file the Run Script action generates, Metadata it modifies or creates, etc. Note When using Run Script as a Condition, the output of the task can be within the branch or on the main trunk. To control the output, use the "Script.ReturnValue" on page 176 variable in your script. Properties The Script Editor menu options are as follows. l File l l l Export: Lets you save the current script as a file. l Print: Prints the current script. Edit l Undo: Undo the last edit.
l l l Language: Select the language in which your script is written. Choices are VBScript, JavaScript, Perl or Python. Tools l l Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Editor Options...: Opens the "Editor Options" on page 838. Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l l l The script editor text box: This is where you enter your script that will be used.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Search and Replace Search and Replace Action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data. Note that this Action task cannot be used with binary files. For more advanced search and replace functionality, see "Advanced Search and Replace" on page 410.
l l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies. l button: Click to add a new line to the list of words to find and replace. l button: Click to remove the currently selected line from the list.
Input Any image file that you wish to upload to the printer. Processing The currently active image data file converted to PostScript. The image's resolution, scan orientation, and quality can be modified, depending on the selected option. All files are converted into PostScript format for storage on the printer. If a virtual drive, the file is automatically sent to it. Output A PostScript file containing the necessary code to save the data file on the hard drive.
l l l l l Image compression level: Select the level at which you want images to be compressed. Values can range from 1 (compress up to 1% of the image’s original size) to 100 (do not compress). For example if you set this box to 75, the Image Downloader compresses all images by 75% when it converts those image to PostScript. The default compression level is 70%. Send to Virtual Drive of: Select the computers and / or printers to which the images are to be sent.
Input Any data file in any format. Processing A copy of the data file is saved on the hard drive at the specified location. Output The original data file, Metadata and Job Info variables are not modified, they are passed on to the next task. Task properties General Tab l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task.
Set Job Infos and Variables Add Set Job Infos and Variables action tasks to set Job Info elements as well as custom variables (see "About variables" on page 733). You can set multiple variables and Job Info values in a single task. Be aware that lines are processed from top to bottom. Input Any data file in any format. Processing This task assigns the defined values to local or global variables or Job Info variables. It does not modify the data file nor the Metadata.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SOAP Client plugin SOAP Client plugin tasks can be used as Input, Output and Action tasks, although their basic function is to generate output. SOAP (Simple Object Access Protocol) is a light protocol that defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems.
Task properties General Tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the drop-down list. Note The WSDL Address of a PReS Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
l l l Value: Lets you enter fixed or variable values. To exchange variable information between the Web service and PReS Workflow, you must use job information variables %1 to %9 or variable %c (which contains the entire job file). Note that return values (arguments which are used to return information to the SOAP Client) are displayed in bold font. Namespace: Displays the namespace of the arguments associated with the selected method.
when printing to a PostScript printer that does not recognize them. PReS Workflow provides an easy way to automatically filter these characters through its Standard Filter task. Input Text-based data files such as line printer data (see "Line printer emulation" on page 67) and ASCII data files (see "ASCII emulation" on page 63) data files, which contain HP PCL control characters. Processing All HP PCL characters are removed from the data file.
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.
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.
Note Although it is more common to perform both phases in a single pass, each phase can be performed selectively, as required. Input A print job in EMF format, generally captured from a WinQueue input task. Processing The EMF job is converted into a text-only, "Line printer emulation" on page 67 data file. Output A Line Printer file. Metadata, Job Info variables and other variables are not changed.
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.
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.
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.
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.
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.
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 75). 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.
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.
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 496 or "Database Splitter" on page 481) into multiple data files that are passed to subsequent tasks in the process.
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.
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).
more options than the other ones, this is only because it contains combined features from these other splitters. 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.
l A word: If you choose “A word” in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed: 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.
l l Split when word found: You may not want to split the file every time the string of characters entered above is found, but only every other time, or every third time. If so, enter the number of times in this box. A word change: If you choose A word change in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l l Get: Click to select a search region.
l l A page number: If you choose A page number in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l l Split when word changed: You may not want to split the file every time the string of characters entered above changes, but only every other time, or every third time. If so, enter the number of times in this box. Pages per output file: Enter a number of pages after which to split the file.
l l l Before or after: In the previous box, you entered where you wanted to split the file. Here is where you specify whether you want the Generic Splitter to split the file X number of pages or records before or after the string. Choose 5 in the Pages or records box and “Records after” in this box, for example, to split the file 5 records after the record that matches the condition.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
l l l l l l l From column: Enter a value corresponding to the first column in which the splitter must start searching for the word. To column: Enter a value corresponding to the last column in which the splitter must start searching for the word. 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”.
input, the Metadata Sequencer might perform better. For more information and some test results, see this How-to: Performance testing grounds. 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 68).
tailor exactly how you want the region based splitting process to take place. l l l l l l l l l l l On region content change: Select if you want the data file to be split when the word found at a given location changes. 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.
l l l After: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines after the line on which the condition is met. When condition is found: By default, the task splits the file every time the condition is met (the default value is 1). If you want the task to split the file only when the condition has been met twice, for example, enter the number 2 in this box.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
l Standard XML splitter The following options are only displayed when the Standard XML splitter option is selected in the Split method box. l l l l l l l l l l Condition node path: In the tree view, select the XML node to consider to determine when to split the file. To indicate whether you want the file to be split whenever this node is encountered or whenever the information in this node changes, see the Condition group below.
l l l Advanced XML splitter: The following options and buttons are only displayed when the Advanced XML splitter option is selected in the Split method box. Note that you should not use this option before you have completed all the required settings using the Standard XML splitter option. 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.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Process logic tasks A process is like a flowchart. The data files captured by the Input tasks become job files (see "Job file" on page 51) that travel down the process. Many processes include multiple process logic tasks.
Note Branches, Loops and other Process logic tasks do not generally modify the job file, though some may change system variables. The only exception is the Run Script action, which can be a condition that also modifies the data. Warning Branches, Loops and Conditions do NOT modify metadata in any way. Furthermore, 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.
Task properties Backup Tab l l l l Backup job file: Select if you want PReS Workflow to use identical copies of the job file for the main and secondary branches. When this option is not selected, the file generated by the output task located at the end of the secondary branch is used as the job 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.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Comment Comments can be used to clarify your process either for yourself or others, to explain branches and scripts, or add information for anyone editing the configuration in the future. Comments do not open, modify or otherwise process the job file in any way, and are simply ignored at run-time.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Name Condition File Name Condition tasks test the original name of the job file traveling down the process branch, or in other words, the name of the file received by the last input task appearing above the condition. Task properties General Tab l l File name mask: Enter one file name mask or multiple masks separated by a semicolon (;). See "Masks" on page 342.
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) then 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). On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks.
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.
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 743). 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.
or a Condition from a contextual menu. (See also: "About branches and conditions" on page 137.) For more information on scripts, what languages are supported and how to write scripts and conditions, please see the related chapter, "Using Scripts" on page 143. 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.
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.
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.
Note that a process called through the Send To Process plugin will not self-replicate, even if the process' preferences specify that it should. The initial Input task is being bypassed, and since it's the Input task that initiates the self-replication procedure, self-replication cannot occur. 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.
Management Information Base Object Identifiers A Management Information Base (MIB) is a database of Object Identifiers (OIDs) that can be used to monitor device objects using SNMP. An MIB OID can point be a printer tray, cartridge or hard disk, or to modem mode. Using an SNMP condition, PReS Workflow can communicate with a device located at a given IP address and request the status of the object identified by a given MIB OID number.
l l Printer Queue group (displayed when Printer Queue is selected in the Condition Type box) l l l l Condition type: Select Printer Queue to test a standard printer status condition or User Defined to test a status identified using a printer specific identification code. Bear in mind that the failure to comply with any of the test conditions selected below will make the whole condition False. Printer status: Select Idle or Printing to test whether the printer is currently idle or printing.
Text Condition Text Condition tasks can be used to perform two different types of tests: l l To test the presence of a string within the job file. You can, for example, search for the string “Gold member” on the first line of the job file. As another example, you could search for a variable string retrieved via a job info variable or a data selection in a given location in the job file. To compare two strings. As with the test above, this test can also be used to search for a string in a given location.
comparison. If you chose an operator that compares numeric values, you should select this option. l l l l l l On numeric error: This option is only available when the Numeric comparison option is selected. Select the behavior you prefer when PReS Workflow is unable to successfully perform a numeric comparison. Select ”Return the error”, if you want the Text condition to fail altogether. Select ”Return true”, if you want the condition to be considered True.
change time intervals, for instance, that range from 15 minutes to 24 hours. You may choose to use days or dates, and you may also select specific weeks or months. The Time of Day Condition differs from the process schedule in the fact that you could put this condition after generating some output, and you can also run tasks when the condition itself is false, which is not the case for a process outside of schedule. You can choose contiguous as well as separate time blocks as required.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Connector tasks A Connector, as the name implies, is a task that connects to something outside of PReS Workflow itself. In some cases those are other parts of the PReS Workflow, but in other cases we offer connectors for third-party applications or systems.
Task properties General Tab l Register Job to the SureTrac Server group: Check this option to enable the group. l l l l l Process Verification Job Name: The SureTrac job that this PDF should fall under. Use the button next to the list to retrieve a list of available SureTrac jobs from the server. Mailrun ID: A unique identification for the current job.
This task can be added as an Action task (see "Action tasks" on page 406) or as a Condition Task. When used as a Condition task, the success of the delete operation determines whether the condition returns True or False. Input This task doesn't require an input file. It does need a Repository ID and password, and the ID of the document to delete. Processing This task connects to a Capture OnTheGo Repository and requests removal of a document with a given document ID.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
Workflow Imaging is an add-on license bundle for OL Connect Workflow that includes the Image and Fax plugins; see "About PReS Image" on page 775 and "About PReS Fax" on page 774. Without a valid Imaging license, the plugin will fail with an error. In the trial version, the plugin will work. Input Any data file present on a SharePoint document store, even those not compatible with PReS Workflow emulations, and the properties of these files.
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 900.
l l l l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PReS Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool.
About Laserfiche Laserfiche is a provider of digital document and record management systems. Laserfiche has two components: the Laserfiche server, which hosts the repository, and the Laserfiche client, which serves as the user’s interface with the repository. For more information see the Laserfiche website: https://www.laserfiche.com/.
l l l l l l Electronic files: All files will be stored in their original format in Laserfiche. When double-clicking on the document in Laserfiche the native Windows application associated with the file extension of the archive will be opened. Force folder creation: Select to force the folder creation if it does not already exist on the Laserfiche server. Volume: A list allowing to choose among available Laserfiche volumes. Configure Tags: Click to open the Configure Tags dialog.
license allows. If you see the error message ‘The session number was exceeded’ in the PReS Workflow Service Console, it means you have exceeded your allowed number of connections. l To use the “Use PReS PDF/A archives” option, make sure to: l l l l l l l Check the field as Multiple, select CHAR type and enter the width fields in Laserfiche administration console as long as your PReS fields. Insert a folder path to your PDI source files in the PReS Image archive folder.
Use cases Here are some examples of how the Lookup in Microsoft® Excel® Documents task could be used in combination with PlanetPress Design documents. Use case 1: Send personalized emails with promotional document attached A PlanetPress Design document takes a PDF file as the input data file, and reproduces it exactly as it enters. The document also contains a custom data selection set to hold an email address. The data selection's value is given by a Metadata Field called 'Email'.
Task properties General Tab l Excel group l l l l Excel workbook: The full path and file name of a Microsoft® Excel® workbook (.xls or .xslx file). You can use the Browse button on the right to browse to the file on your computer. Excel worksheet: The name of the worksheet you want to use. Once a workbook is open, this drop-down will automatically list all the available worksheets.
l l button: Moves the currently selected line up one place. l button: Moves the currently selected line down one place. Search option group l Match case: Will force the lookup column names to be in exactly the same case as the Lookup column name. This means if you type in "CustomerID" in the lookup column and the actual column is named "customerid", it would not return any result. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l l l If using a Microsoft® database such as Access® or Excel®, each software must be installed in the same version. For example, using Microsoft® Word® 2007 with a Microsoft® Access® 2003 database will cause the task to fail. If the database path is specified in the Microsoft® Word® document, the mail merge has to be performed with the settings specified in the document, otherwise the database path provided in the task is ignored and can cause different conflicts.
Note The Objectif Lune Printer Driver will naturally add a margin to the PDF generated by this task. If your PDF is full bleed you will not get the desired results using this option. l A DOC (Word Document) file which is the result of the mail merge. This output is only available when doing a mail merge. Task properties General Tab l l Microsoft Word Document: Enter a Microsoft® Word® document or template, or click the browse button to navigate to the location of the document.
l Output Type: l l .PDF File (with metadata): The result will be a PDF file with the number of pages generated by the combination of the template and record set. Metadata is also included that complement the PDF. .DOC file: The result is a Microsoft® Word® document in .doc format. Note that this format is not supported by PReS Workflow as a data file or job file, so this option is only useful if you are simply planning to save the Word document in a specific location.
Output The output that this task produces is the information sent to the Capture OnTheGo online repository (the document ID). Task properties Repository Tab The Repository tab is where you enter the connection information necessary to create the link between OL Connect or PReS and CaptureOnTheGo. l l l 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 Document Information group: In this group, you enter information that will help users identify the document. It is mandatory to enter valid information in all the boxes included in this group. l l Title: Enter the document name that Capture OnTheGo users will see on their device. Choose a name that will let users clearly identify the document. l Author(s): Enter a name identifying the document’s creator(s). l Description: Enter a description helping users identify the document.
Advanced Tab The Advanced tab is where you specify the document's time to live either in the repository or the user's device. l Document Handling Options group: l l l l Customize: You must check this box if you want the options included in this group to be used. When this option is not checked, the other boxes included in this group are faded.
Until box above, the computer’s time zone appears in this box. You may select a different time zone if required. l Document Tracking: l l l Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server. This tracking is done through the COTGDefaul.mdb database located in %ProgramData%\Objectif Lune\PReS Workflow 8\PReS Watch\COTG , and includes most of the information set in this task, as well as information returned from the server.
Without a valid Imaging license, the plugin will fail with an error. In the trial version, the plugin will work. Input Any data file, with optional Metadata. Processing The task connects to the selected Document store and uploads the current data file. 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.
Configure SharePoint Metadata Fields dialog This dialog lets you setup the information you want to assign to the SharePoint Metadata information. It contains one line for each field present in the SharePoint document library. l l l l Field Name: Name of the field as set in SharePoint Document Library. Field Information: The information to enter in the SharePoint Document's Metadata for this field. Use PDF/A: Check to use the information contained within an PDF.
l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted. Domain: The active directory domain for the log-on credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries.
the PReS Fax host specified in the properties. If the file is a TIFF file in the proper format and the "Pass-through" option is selected, no processing is done, the file is sent as-is. Output A TIFF in the CCITT Group 4 compression, and information for the FAX server to know where to send the file. Task properties General Tab l l l l l Host: Select the IP address of the PReS Fax host to which you want the request to be sent. The Fax configuration is set in the PReS Fax User Options on the target host.
In addition to the job-specific PReS Image properties you configure in the task’s Properties dialog box, there are configurable options common to all PReS Image outputs processed by a given computer (see "PReS Image preferences" on page 833). Note that those options are specific to each PReS Image installation and that they are immediately applied. The following describes the properties specific to PReS Image Output tasks.
l l l If the data file and a document are selected, and Printer Centric mode is used, the data file is sent to the PReS Image host which merges the data and document to produce output. If the data file and a document are selected, and Optimized PostScript Stream mode is used, the data file is merged with the document and the resulting OPS job is sent to the PReS Image host to produce output.
l Run mode group (only with PlanetPress Design document) l l l l Output type: Select the output file type that you want. l l l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PReS Image. Note that some features, such as the Time and Date functions, require that this option be selected. Add job information to the document: Select to add the available job info variables in the “header” of the generated output file.
grayscale images (in PlanetPress Design you can have 8-bit color images, but these are reduced to grayscale if you select 8-bit here), while 24-bits produce full color images. For JPEG output, you cannot select a monochrome (1 bpp) color depth. For TIFF G3 and 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.
information. l l l l None: Select if you do not want this task to add an index file to the generated document. 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.
l l l l l Author: You may enter the name of the author of the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time. Subject: You may enter the subject of the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time.
compression. Select Auto to let the application choose the best compression method automatically. Note that configurations that were created with an earlier version of PReS Workflow and that included tasks set not to use any compression will by default be set to use the Flate compression method. l l l Downsampling: Select the down sampling option. Down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels.
Bicubic to use a weighted average to determine pixel shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l l Resolution: Select the resolution to use for color images. Note that this setting has an impact on the color down-sampling process. Security group l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files.
l Initial view group l l Zoom factor: Select the magnification at which you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to open the generated PDF. Choose the Fit in window option to display the entire page using the available screen space, or choose a percentage of the actual document size. Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty.
l l Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database. User ID: Enter the user id required to access the database to which you are adding new PDI files from the generated PDF files. If you are using an SQL database, enter the login name you chose when you configured the SQL database (refer to the “Using PReSSearch with an SQL Server Database” section of the PReS Search User Guide).
Input A PReS Classic job and the resources it needs. These resources include the data file to run against the job, plus any graphic or font resources the jobs needs, along with any required PReS Classic specific resources, such as TRF or PDI files. Processing The selected data file is merged with the selected PReS Classic job to create a print output stream.
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 340. 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.
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.
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.
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.
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.
ZUGFeRD plugin The ZUGFeRD plugin provides a way to enrich German PDF invoices with data specific to the invoice. This is done by embedding the data in a standardized XML format within the PDF itself. For general information on the Plugin, see "ZUGFeRD" on page 777. 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.
For more information on Workflow context menu data selection options, see this page: Workflow Variable Properties l Zu verwendendes PDF group: Allows selection of the PDF file to process and enrich with the ZUGFeRD-XML information. Select from: l l Workflow Jobdatei: Use the incoming Workflow Job File. Datei: Specify a specific PDF. Use the browse button the file path and name into the edit box.
Note The date entry must be formatted in standardized UTC format: yyyy-mm-dd Any other formatting will lead to a run-time error. l Lieferant group contains all the required values and information related to the seller, delivery and/or the invoicing party. l l l Name: The individual or company name. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Adresse: The postal address (sans post code and city entries). Two address lines can be included in this entry.
uppercase letters only. Note The plugin does not check if a given country code is in the list of valid country codes. It is the responsibility of the user to ensure that only valid country codes are entered. This field can be set via Workflow data and/or variables. l l Art der Steuernummer: The two letter code for the tax identity number. Select from the drop down list box. The choices are either "VA" (Umsatzsteueridentifikationsnummer (UStID)) or "FC" (Steuernummer (national)).
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.
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.
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.
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.
PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Suite Production. It is not available in older versions, nor is it available in the Office and Watch versions of PlanetPress Suite. PlanetPress Capture is not compatible with OL Connect Designer templates. PlanetPress Capture is a set of tools available in PReS Workflow that enable output and input for interaction with an Anoto Digital Pen.
page 572 or "Find Capture Documents" on page 578 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).
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.
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.
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).
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.
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.
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.
which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011. Capture Fields Processor The Capture Fields Processor action task is used to update the Capture database using information received from an incoming PGC file, which generally originates from a communication by the Anoto penDirector.
your PGC file before using this task and to create an error handling process to capture these errors. Logical errors do not cause this task to exit. For example, if a List Item Capture Field is set to only accept a single option but contains ink in more than one option, or if a Capture Field that does not accept re-writing receives more ink, the task will still complete. The inks that are relevant to logical errors are still added to the PDF document, but they are added on a separate "error" layer.
l l CapTemplateName: Name of the PReS Connect document used to generate the document. Page Level: l CaptureField: Information on each capture field on the page. Repeated for each capture field that is present. 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 143).
For example, accented letters are not correctly recognized in the English ICR database. l l l l Fail if new ink is found on non-rewritable fields: Check to trigger the On Error tab if and when a field set as Disable Rewriting receives ink in a new session. Ignore out of bounds ink data: Check to continue processing even if receiving a PGC that causes ink to be outside of any Capture Field to appear. This may happen if updating the wrong document.
Capture PGC Splitter The Capture PGC Splitter task can be used to separate each document into its own PGC file so they can be processed separately. The splitter then sends each document PGC to the next action, which should be the Capture Fields Processor task. Note that using the Capture PGC 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.
l Type: Specify from where the Pattern Sequence should be taken. l l l l None: Do not use a Pattern Sequence. Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database. 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.
Processing A query is made to the Capture database and the ICR data is retrieved. The document that is queried must be available in the database (must not have been closed and retrieved previously). 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.
Note The Find Capture Document task makes multiple simultaneous statements to the database when requesting a list of documents. For this task to work, the Allow multiple statements option must be checked in the ODBC connection setup done in the control panel.
the job metadata when the "Capture Fields Generator" on page 569 ads it to the Capture database. l Document-Based Condition: Select this option to set up an advanced filter containing one or more conditions. l Condition Grid: Displays the list of current condition criteria that were set for document retrieval. l Filter: The selected filter type.
l l l l l l l l l l l l l l Equal: Inclusive filter, where anything equal (either by string or numeric comparison) is included in the results. Not Equal: Exclusive filter, where anything not equal to the condition is included in the results. 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.
l l l Remove button: Click to remove the currently selected condition from the grid. To select a row, simply click on any of its 3 components. Condition Operator: Select either "All items are met" to force all conditions to be true for a document to be included, or "At least one item is met" to include documents where a minimum of 1 condition is true. Create Advanced Data File: Click to retrieve additional information about each document in the result list.
Input A data file in PGC or PDF format that is accompanied by valid Metadata. This Metadata must contain Capture information and is generally available after a "Capture Fields Processor" on page 572 or "Find Capture Documents" on page 578 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.
l ICR_[FieldName]_Cfd : The confidence value (in percentage) of the engine for the value provided. 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.
PGC to PDF Converter The PGC to PDF Converter task extracts the digital ink located in a PGC file and adds it to a blank PDF, creating one page per document in the PGC. It's main use is to process PGCs that generated errors when processing them, as part of an Error Handling process. 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.
Note This task was built using a custom plugin system and does not display the On Error tab in the regular view. To access the On Error tab, right-click on the task and select Advanced Properties... On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata tasks Metadata tasks are plugins that can create or edit metadata for a job file.
This task is put into effect in the following example processes. l "Example: Daily sales report from PDF files" on page 297 l Basic Functional Capture Workflow l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Input A data file in any supported emulation (see "About data emulation" on page 60).
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.
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).
Note This task will automatically loop through the Metadata and repeat its action for each of your Metadata's datapages. This task should not be placed after a Metadata Sequencer. Input Any data file with accompanying Metadata. Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties.
Task properties General Tab l Action: Select the type of Metadata Field Management action to perform. Five action types are available: l l l l l l Add/Replace: Create a new Metadata field. If the name already exists, the value is overwritten with the new one. Duplicate: Create a new Metadata field. If the field already exists, a new instance is created. Append: Append the new value at the end of the current one. If no field with that name exists, a new one is created.
l l l l Auto-detect: Interpret automatically the value. This option is ideal for documents using mixed decimal separators. Note that the auto-detect option encountering the value 1,000 (with a comma separator), interprets it as a thousand while interpreting 1.000 (with a dot separator), as one. .: Treat every value with the dot (".") decimal separator. Commas (",") are treated as thousand separator. ,: Treat every value with the comma (",") decimal separator. Dots (".
Output This task outputs the exact same data that was given to it. Its Metadata will either be missing (Delete Metadata), Changed (Load Metadata) or the same (Save Metadata). 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).
Input Any data file with accompanying Metadata. Processing Any Metadata that does not correspond to the rules set forth by the filter are removed from the active Metadata. Note that the 'removed' Metadata is still present in the file, but is unselected: they are disabled and ignored on all tasks that use Metadata afterward (except the Metadata Sorter task). Output The original data file is output, along with the modified Metadata.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
Example of a process with the Metadata Level Creation task Given a document input (created with Metadata), this task can be used to regroup the PDF pages of the received print stream in logical (Metadata) documents, based on the keyword “Page 1 of” printed on the pages, and then treat each newly created document individually in the rest of the process The process begins with the following tasks: 1. WinQueue Input: Intercepts a printed data file sent to a Windows printer queue. 2.
Task properties General Tab l l Document: Create a new Document level. Note: Attributes and Fields are deleted for all new Document levels created as well as existing Groups. Group: Create a new Group level. Note Attributes and Fields are deleted for all new Group levels created. l l Delimiter defines if the Condition parameter is triggering the beginning or the end of a Group or Document. If the delimiter option is set to None, the action is not performed.
Note When using a PlanetPress Design document as input, the PDF Splitter will do the job quicker than the Metadata Sequencer task. However, when using a PDF as input, the Metadata Sequencer might perform better. For more information and some test results, see this How-to: Performance testing grounds. Input Any data file with accompanying Metadata. Processing A loop is established and the Metadata is separated into chunks, as defined in the rules set forth in the task properties.
set to 5, a 100 document job file will be divided into 5 sequences of 20 documents each. l The following rule: Determine if a new sequence starts or if the current one ends. For each Metadata level, the current value of the specified Metadata attribute/field is compared with the one in memory. If they are different, either a new sequence starts or the current sequence is ended. The next sequence starts with the next Metadata level being processed. For details see the "Rule Interface" on page 900.
When you click on either of the sort boxes, a small pop-up displays the following options: l l l Sort by: The drop down displays a list of available fields and attributes in that level, letting you select on which to sort. The field or attributes must be present for every instance of the level you are searching on, or the task raises an error. Order: Choose Ascending (orders like a,b,c, or 1,2,3) or Descending (orders like 3,2,1 or c,b,a) order.
Processing The metadata is read and PDF indexes are located. These indexes are defined in the PlanetPress Design document as data selections, in which the Archive / Email / Fax properties define the data as an index with a name. When all the indexes are collected, a PDI file is generated with those indexes. Output The output is the same as the input, no modification is done to either the data file or the metadata. However, a PDI file is generated and saved in the location specified in the task.
page of the PlanetPress Design template to be used with the current data file. The task rearranges the Metadata accordingly, which greatly facilitates the set up of the N-Up functionality in the design tool, especially when the solution includes duplex printing with variable data on both sides.
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. This number should be equal to the total number of virtual pages in your PlanetPress Design document. For example, a 2 horizontal x 3 vertical is 6-up, so this number should be 6.
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 335. OL Connect Send tasks l "Get Data" below l "Get Job Data" on page 609 l "Job Processor" on page 613 Get Data The Get Data plugin allows OL Connect Send users (admins, accounting personnel, print masters ...) to get information about all jobs received with OL Connect Send on a dedicated machine.
l User(s) l Machine name(s) Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: l Workflow variables l Job variables l Names. Tip No spaces are allowed around the listed names, respectively before or after a semicolon. Operators l Searches are case-insensitive. l Multiple entries in one filter field are combined with: OR. l Entries in different filter fields are combined with: AND.
Example 2 The domain name entered in the Filter Domains field is objmtl.objectiflune.com and the user name entered in the Filter Users field is rentel. If search criteria are entered in multiple input fields, all of them are combined with AND. Therefore the result will only contain all the print job information for objmtl.objectiflune.com where the user name is rentel. Date and Time Definitions Both date and time entries must be notated in UTC format.
l Original file name l Original file size l Domain (workgroup) name l Domain / Workgroup Indicator l Machine name l Machine GUID. Results File Format The following result file formats are selectable: l XML l JSON l CSV (Separator = semicolon (0x3B), string indicator = quote (0x22)). Note This file is not automatically saved to disk. The retrieved job info is written to a temporary results file that will be passed on as the new Workflow job file.
Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value. l l l l l l l Number of Copies: This is the value set by the OL Connect Send Printer Driver for the number of copies (intended number of copies required for the print job). Some applications do not use the general print job information to define the number of copies. In such (rare) cases, the Number of Copies sent in the job can differ from what the user entered in the print dialog.
l l Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API. Machine GUID: The unique machine ID of the machine on which the job was produced. It can be used as an additional identification mark to validate the origin of the job. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Properties General tab Three different settings affect the general behavior of the plugin: l Where to get the Print Job ID. l When to continue with the next step. l Where to store the job information details. Select Job ID Source The plugin can be used in a generic way. Whenever information about a specific print job is required, it can be retrieved as long as the related job ID is known.
l When Job is Processed: When this option is selected, the plugin will query the database until the Status ID value is 1 or 6. If the status does not become 1 or 6 within the time defined via the Timeout (sec) input field, the plugin will raise an error. Select Output Type l l XML Data to Workflow: This will result in an XML file containing all job related data and becoming the new Workflow job file. In this case, the incoming data file of the HTTP Server Input plugin is overwritten and lost.
such (rare) cases, the Number of Copies sent in the job can differ from what the user entered in the print dialog. For example: "IrfanView" does not use the regular Copies indicator, but instead sends the same job as many times as indicated by Copies in its print dialog. l l l l l l l l Number of pages: This is the number of pages for one copy of the print job. This value is calculated by the Windows spooler, when processing the printing order.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Job Processor The Job Processor plugin is an output plugin that appears in the Plug-in Bar of Workflow under OL Connect Send. Input The Job Processor plugin must be added to a Workflow job transfer process that starts with an HTTP Server Input. The Job Processor plugin is the only other task in that process.
receive a message in the Notification Area (also called "system tray") confirming the unlicensed status, and the printer driver will not request another web page. In licensed mode, the plugin will store all relevant information about each job in the OL Connect Send database. This database is a HSQLDB and is installed automatically. Subsequent Workflow processes can use the information in the database for additional processing (see "Get Job Data" on page 609).
Database connection The Job Processor plugin works with a database to store all relevant job information. This database is a HyperSQL Database (HSQLDB, see https://en.wikipedia.org/wiki/HSQL_ Database_Engine). It is installed as a service with the name OL Connect Send DBServer (the internal service name is OLCSServer). Communication between the plugin and the database occurs using port 9001 (the default port for HSQLDB).
Note If no extension is defined by the user for the file name, the default “.ps” extension is added automatically, as the incoming print jobs are PostScript files. Workflow variables Variables can and should be used to create dynamic file and folder names for each print job. This enables separating licensed and unlicensed jobs and/or storing the files by domain, machine and even user name.
l Plug-in Information l l License: Shows whether a license for OL Connect Send could be found. If not, OL Connect Send will be running in unlicensed (default) mode. Protocol version: Here the plugin shows which protocol version is used. The OL Connect Send components communicate with each other by using a well-defined and versioned protocol. As long as these components use the same protocol version, the job transfer will work even if the plugins themselves are changed.
l "Create Print Content" on page 640 l "Create Web Content" on page 643 l "Download EML Messages" on page 647 l "Execute Data Mapping" on page 649 l "File Store - Delete File" on page 653 l "File Store - Download File" on page 654 l "File Store - Upload File" on page 656 l "Mark Connect Sets for Deletion" on page 657 l "Merge Jobs" on page 659 l "Render Email Content" on page 660 l "Retrieve Items" on page 664 l "Set Properties" on page 668 l "Update Data Records" on page 670 All I
Note When added as an Output task, the All In One plugin works asynchronously to the Workflow process. Task properties Data Mapper Tab The Data Mapper step generates a Record Set from a specific source: data mapping on the appropriate source (Current Data File, Database or PDF/VT data file), Retrieving items from the Connect Database (filter setting) or uses the current job Metadata. The resulting Record Set is given to the Content Creation part of the task.
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 after the All In One operation has completed. Any postprocessors defined in the data mapping configuration will be disabled. This option is unchecked by default. l Filter: Retrieves records from the Connect Database. This is identical to using the "Retrieve Items" on page 664 task.
l l Metadata: Uses existing Metadata, generally the output of a "Execute Data Mapping" on page 649 or a "Retrieve Items" on page 664 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. This is the same as using the passthrough option in the "Execute Data Mapping" on page 649 task. Content Items are created automatically.
l Job Preset file: Select which Job Preset to use to generate the job. l l l l l l Default: The IDs in the Metadata are used instead of a job preset file. None: Select this option to prevent the execution of Job Creation and Output Creation. In this case you also have to select 'None' on the Output Creation tab as well. "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below.
l Output Preset: Select the appropriate Output Creation Preset to use: l l l l "%o": Select to use a dynamic Output Preset name. Click on %o to change the expression that determines the name of the Preset to use. Preset Name: Select the appropriate Output Preset to create output with. Listed are the Output Presets that are present in the Connect Resources (see "Connect resources" on page 40). Output Management group: l l l "None": Select to prevent the execution of Output Creation.
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Create Email Content The Create Email Content task generates a set of email content items from a template's Email Context, which are then sent directly to the recipient set in each record. Input This task must receive either Metadata containing information regarding a valid Record Set, or JSON data. Metadata The "Execute Data Mapping" on page 649 task and the "Retrieve Items" on page 664 task output metadata containing information regarding a Record Set.
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. 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.
l JSON: l JSON String: a JSON object or an array of JSON objects representing records (see "JSON string examples" on page 93) or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 94). This option requires that keys in the JSON data 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.
l Attachments: l l l Print Context as PDF document: Check to generate the Print context in the template as a PDF and send it with the email as an attachment. Web Content as HTML page: Check to generate the active Web section in the template as an HTML page and send it with the email as an attachment Test SMTP settings: Validates the format of the sender's address and mail host and tries to send a test email. This won't work when the option Start TLS is checked.
Create Job The Create Job action task prepares a series of print content items for output generation. A Job is not actual contents but simply a collection of content items ready to be printed. See also: "About printing" on page 110. Input The task expects to have a valid Print Content Set, output from the "Create Print Content" on page 640 task, or the result of the "Retrieve Items" on page 664 task set to retrieve either Content Items or a Content Set.
l l l l "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the Connect Resources (see "Connect resources" on page 40). Preset Names: Select the appropriate preset to generate output. Listed are the Job Presets that are present in the Connect Resources (see "Connect resources" on page 40).
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.
Input The task requires a valid Job Metadata file, normally output from a "Create Job" on page 629 or "Merge Jobs" on page 659 task. Processing The job is sent to the OL Connect Server for processing. 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.
l Wait for completion: Check this option to make Workflow wait for confirmation that the output creation task was processed, either successfully or unsuccessfully. Otherwise Workflow will only wait for the confirmation that the job was submitted correctly to the Output Engine. When Output Management is set to "Through Workflow", Workflow always waits for completion of the output creation task.
with the "Create Print Content" on page 640 task directly without the use of a Connect Template (PDF/VT mode). Input Any data file supported by the selected PlanetPress Document. Processing The input data file is merged with the selected PlanetPress Document. 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.
Create Preview PDF The Create Preview PDF plugin generates a PDF preview for a single record as fast as possible. This preview is typically used for previews embedded in web pages. The plugin retrieves the resulting PDF from the file store and makes it available to the process as the job data file. The job file name extension is .pdf.
model attached to the chosen configuration in the DataMapper module, to verify that the right one is used. 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.
message. 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.
JSON string samples The following JSON string samples show various techniques to incorporate data in a JSON string.
[1]',Value,KeepCase,NoTrim)" } A JSON string that contains nested data: { "name":"Peter Parker", "email":"parkerp@localhostcom", "ExtraData":"foobar", "detail": [{"id":"inv123","ExtraData":"hello"}, {"id":"456","ExtraData":"world"}] } Content Creation tab The Create Preview PDF plugin creates a preview PDF from a template selected on the Content Creation tab, using the record that results from the data source selected on the Datamapper tab.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Print Content The Create Print Content task generates a set of printable content items from a template's Print Context, and saves those content items in the database until output creation is requested.
If the input is JSON, the task performs a REST call to the /rest/serverengine/workflow/contentcreation/{templateId} endpoint on the Connect Server. For more information see the REST API Cookbook. Note When JSON data is used as input, the "Create Job" on page 629 plugin (the next task in a print process) cannot use a Job Creation Preset. The Create Print Content task doesn't create a record set based on the provided data, like the "Execute Data Mapping" on page 649 task does.
Properties General Tab l Template File: l l l l "None" File name: Select to accept a PDF/VT file as an input and automatically create content items based on the PDF/VT. "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template. Adding a template to the resources is done through the Send to Workflow option in the Designer Module.
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 811. 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.
Input This task must receive either a valid Record ID or a JSON object. Record ID A valid Record ID can be retrieved from various data sources. By default, when the Record ID input option is selected, the metadata is used as input. The "Execute Data Mapping" on page 649 task and the "Retrieve Items" on page 664 task output metadata containing information regarding records. JSON The Create Web Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records.
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. Output The task outputs HTML code as a job file. Within this HTML code, references to external resources point to the local OL Connect Server and are served to the requester directly when the HTML file is opened in a browser. Properties General Tab l Template File: l l l l "%o": Select to use a dynamic template name.
List (see the REST API Cookbook and "JSON Record Data List example" on page 94). This option requires that keys in the JSON data 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.) Warning The JSON format is not validated by the plugin; it is passed as is to the server.
the HTML file, or hosted outside of the template. So when the "Embed all resources" or "Do not alter HTML" options (or both) are checked, the tag isn't added and local anchors aren't modified. 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 811.
Use the "Metadata Sequencer" on page 597 plugin, followed by the Download EML Messages plugin and the "Send to Folder" on page 466 plugin, to download multiple EML files and save them to disk. As an alternative to the Download EML Messages task you could use the "File Store Download File" on page 654 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 660 task.
Properties General Tab l Data Source (see "Input" on the previous page): l l Metadata: Metadata containing information about an email message. The "Render Email Content" on page 660 task can output information about the email message (s) that it pre-rendered in the current Metadata. Use the "Metadata Sequencer" on page 597 plugin to loop over the items in the Metadata and feed them to the Download EML Messages plugin. JSON: A JSON object representing an email message.
without using a data mapping configuration. Input Optional. Both main options can refer to external files, but either one can be the active data file using %F. By default the Data Source is set to use the active data file as input. Note To open a Microsoft Access database, you have to use the Load External File task just before the Execute Data Mapping task.
Properties General Tab l Data Mapping Configuration: Executes data mapping on the appropriate source. Select the appropriate data mapping configuration in the list: l l l l "None": Select to execute default, basic data mapping on the input PDF/VT file. "%o": Select to use a dynamic data mapping configuration name. Click on %o to change the expression that determines the name of the data mapping configuration to use.
l None (validate only): Select to run the operation in Validation mode and output the validation results in the Metadata. No data is extracted or stored in the Connect Database. The task performs a validation REST call and stores the returned JSON object in a validationresult entry on the Group[0] level of the Metadata. (For the structure of the JSON object, see the REST API Cookbook: JSON Data Mapping Validation Result.) The JSON's result and recordcount fields are also stored at the Group[0] level.
l Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
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 811. 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.
Processing The task tries to download the requested file from the OL Connect File Store by performing a call to the /rest/serverengine/filestore/file/{fileId} REST endpoint; see File Store Service: Download File in the REST API Cookbook. 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.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Store - Upload File The File Store - Upload File task uploads the current Job File to the OL Connect File Store. 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 448 plugin to load that file as the Job File.
l l Save File Store ID in variable: Select the variable in which to store the File Store ID that is returned after a file has been successfully uploaded to the File Store. This ID can be used to download or delete the file from the OL Connect File Store. Mark as permanent: When this option is checked, the file will never be removed automatically by Connect's Clean-Up Service. Non-permanent files may be removed if there are no remaining references to them in the Connect Database.
set for deletion will no longer be available from the database. Input The task requires a valid Metadata file containing items for deletion, including Job Sets, Content Sets and Data Sets. These can be created by the "Execute Data Mapping" on page 649, "Create Print Content" on page 640 and "Create Job" on page 629 tasks. Job Sets, Content Sets and Data Sets are also valid when obtained using the "Retrieve Items" on page 664 task. Processing All sets currently active in the Metadata are set for deletion.
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.
Task properties General Tab l Metadata file: Enter the full path to a valid Metadata file containing an OL Connect Job, or use the Browse button to browse to a valid location. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Note The plugin takes the entire Metadata file as its input, even when it is placed after a "Metadata Sequencer" on page 597 task. JSON The Render Email Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string samples" on page 638.
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. {"messages": [ {"attachments":[ {"name":"att0307c655-e14e-4400-8f90365032648aed.png","disposition":"inline"}, {"name":"myPDF.pdf","disposition":"attachment"}, ], "subject":"Take action now", "to":"recipient@gmail.
l Data Source (see "Input" on page 660): 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 649 task or "Retrieve Items" on the next page task. JSON String: a JSON object or an array of JSON objects representing records (see "JSON string examples" on page 93) or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 94).
Note Information about the Connect Server (host, user name etc.) is taken from the Workflow Preferences (see "OL Connect preferences" on page 811). Advanced Properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
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 94). Note The result of a Retrieve Items task can be used with the "Create Job" on page 629 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.
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. Multiple entities can be retrieved by entering multiple ID's, each on a new line. Conditions: l l Condition: Select entities based on one or more conditions, the value of a metadata field for example. Add a condition: Click to add a new condition line.
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. l l l Pick items based on: Use the [...] to open the "Pick Parameters" on the next page dialog and define how to pick which items will be placed in each document. Content items picked using this method will be part of the same mail piece. Sort items based on: Use the [...
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Pick Parameters The Pick Parameters define how to pick entities retrieved from the Connect Database using the "Retrieve Items" on page 664 task and place them together in Documents or Groups. Items are picked using either Properties or Values.
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 597 task first. Output The task outputs Metadata that is identical to the input Metadata.
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.
Processing The records, of which the IDs are found in the source data, are updated either from the Metadata or from JSON. 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 340.
On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Output tasks Output tasks are exits from PReS 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.
l "PReS Fax" on page 538 l "FTP Output" on the next page l "PReS Image" on page 539 l "Print using a Windows driver" on page 680 l "Printer Queue Output" on page 683 l "Secure Email Output" on page 686 l "Send Email" on page 689 l "Send to Folder" on page 692 l "SOAP Client plugin" on page 678 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.
Task properties General tab l Move to recycle bin: Select to send the deleted files to the Windows recycle bin. When this option is not selected, files are deleted permanently. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. FTP Output FTP Output tasks send job files to other computers using the FTP protocol.
Task properties General Tab l FTP Server: Enter the IP address or host name of the FTP server. l Port number: Set the plugin to use a specific port number. l l Use FTP Client default port number: Use the value as specified in the Preferences (port 21 is the default value). FTP Port: Enter the specific port number to use when Use FTP Client default port number is unchecked. Enter a value between 1 and 9999. Note: There is no validation to ensure the port is available.
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 393 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 PReS Connect. Input Any data file.
l l Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another Workflow task. 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.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SOAP Client plugin SOAP Client plugin tasks can be used as Input, Output and Action tasks, although their basic function is to generate output. SOAP (Simple Object Access Protocol) is a light protocol that defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems.
Task properties General Tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the drop-down list. Note The WSDL Address of a PReS Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
l l l Value: Lets you enter fixed or variable values. To exchange variable information between the Web service and PReS Workflow, you must use job information variables %1 to %9 or variable %c (which contains the entire job file). Note that return values (arguments which are used to return information to the SOAP Client) are displayed in bold font. Namespace: Displays the namespace of the arguments associated with the selected method.
Note This type of output task does not support PDF transparency and duo-tone features, so you should not use it with PlanetPress Design documents that use those features. Input This task can accept either a data file with a correct emulation (see "About data emulation" on page 60), which is then merged to a PlanetPress Design document, or a PDF file which is to be printed natively.
Note This option is not functional when natively printing PDFs (without a PlanetPress Design document). l Documents: Select a specific PlanetPress Design document if you want all the jobs to be printed with that document. l l Natively print PDF file: This special option can be used if your job file is a PDF. The job will .
Printer Queue Output The Printer Queue Output task dispatches jobs to selected PReS Workflow Printer Queues (see "PReS Workflow printer queues" on page 112). Note that you must have created at least one Printer Queue in PReS Workflow before you can add your first Printer Queue Output task. You can select multiple Printer Queues in a Printer Queue Output task and choose exactly how your jobs will be dispatched to the selected printers.
on page 44) if you want all the jobs to be printed with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections. To enable the dynamic document name box, click inside it. To disable it, press Enter. Note that in the later case, you must be certain that the documents that will be chosen at run-time will in fact be available locally or at all the selected printer.
to each one of the selected Workflow printer queues. For a hundred page job, for example, if two queues were selected, each one will get 50 pages. l l l l l Round robin: Round robin means that complete jobs will be sent in turn to each one of the selected Workflow printer queues. For example, Queue_1 will get the first job, Queue_2 will get the second job, and so forth. Page delimiter group: These options are enabled when you choose Split job or Queue balancing load balancing options.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Secure Email Output The Secure Email Output task sends SMTP email messages with SSL or TLS. Note that this plugin cannot be used on a Windows instance that uses a multi-byte language (e.g. Japanese, Chinese). The workaround is to either use a different Windows language or use the standard Email Input/Output plugins.
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.
l l l l Attach input job file: Select to attach the current job file to the email that the task sends. Rename to: Check this option to rename the job file before attaching it to the email, and enter a name. You may use text, variables and data selections (see "Variable task properties" on page 340). File: Select additional or more additional files to include as attachments. You may enter the file name directly and use text, variables and data selections (see "Variable task properties" on page 340).
Send Email The Send Email output task sends the data files it receives via email. Note In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PReS Workflow is running, so emails are not sent out automatically. To correct this, make sure to log on to Windows on the PReS Workflow server using the same login that PReS Workflow is using, and open Outlook before starting the PReS Workflow services.
Task properties Recipients Tab l l l l l To: Enter the email address(es) of the recipient(s). Remember this is a variable property box and you can therefore use various schemes to use email addresses that change with each job at run-time. You can use any combination of text, variables and data selections; see "Variable task properties" on page 340. Cc: Specify addresses to which a copy of the generated emails are to be sent.
l l l l l l l Attach input job files: Select to attach the file received by this task to the emails it will generate. If this option is not selected, the recipients will not receive any data file. File: Select additional files to include as attachments. You may enter the file name directly and use text, variables and data selections. You may also use the Browse button to navigate and select the file.
l l l l l l Reply address: Enter the reply address that will be used in emails sent by PReS Workflow for this task (this is optional). Outgoing mail (SMTP): Enter the IP address of the mail server PReS Workflow is to use to send emails via SMTP. Port: Specify the outgoing SMTP Port if it is different from the default port (25). Server requires authentication: Select if the outgoing server mentioned above requires authentication.
Task properties General Tab l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names. You can use any combination of text, variables and data selections; see "Variable task properties" on page 340.
The following plugins are not initially installed with Workflow but they are available for download on the Resource Center (help.objectiflune.com). Once installed, they appear in the Document Management category. l "Connection tab" on page 696 l "Connection tab" on page 709 l "Advanced properties" on page 717. l "Advanced properties" on page 719. l Therefore2Way. (The manual for this plug-in is provided with the plugin's installer.
Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved. DocuWare Download The DocuWare Download plugin Downloads files of any file type from a dedicated DocuWare CRM system. Installation This plugin is not installed with Workflow, but it is available for free download from the Resource Center (help.objectiflune.com). After downloading the .PPK file, you will then need to import it into Workflow yourself. See See Importing a plugin.
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. Task properties Connection tab The Connection tab fields set the connection parameters. You can use static text and/or Workflow variables, data and lookup functions.
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. Test Connection This button tests the connection details entered in the Connections tab. If a successful connection is made, then Connection Success will appear as the current status.
Cabinet from the drop-down list . Alternatively, you can enter the File Cabinet entry directly. You may also use variables, data and lookup functions. Right-clicking within the field opens the contextual menu. See "Data selections" on page 54 to assist with this. If the File Cabinet specified in the text box does not exist at run time, the plugin will replace it with the first File Cabinet name on the previously extracted Cabinet list. The File Cabinet entry is case-sensitive.
Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 54). You can add or remove search criteria using the following options: You can populate the table with all the available Index Field options at any time by selecting the Add missing fields ( ) button. If selected initially this will add all the available fields to the table.
into the variable. So using dwresponse as the variable name would mean that DocuWare Download searches for the local variable of that name. Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved. DocuWare Output Warning The DocuWare Output plugin will cease to operate as of April 2020. It has been replaced by the new DocuWare Upload plugin. See this see page for details on how to install and use the newer "Connection tab" on page 709.
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 file to upload in any way. If any issue is detected during a file upload, the log messages and the related file and its index values will be stored in a configurable folder (see "Login tab" on page 706).
l l l Workflow Job file: Select this option to upload the incoming Job File to DocuWare. External file: Use this option to upload an external file. You can click the Browse button to select a file, and/or right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 54). File name (Subject) for upload: Enter the file name to use as document name in DocuWare.
Note Index values can only be assigned manually if the Target File Cabinet is specified as static text, without any variables or lookup functions. . l Select a File Cabinet from the drop-down list. Initially the drop-down list is empty. Click the button next to it, to fill it. The plugin will extract the list of File Cabinets from the DocuWare server. If the File Cabinet specified in the text box does not exist, the plugin replaces it with the first File Cabinet name on the extracted list.
l l External file: Select a Metadata file or an XML file (see "XML structure" on page 706). This method can be used with both input file origins (the Job File, or a file from the file system). Corresponding metadata file: With this method, the plugin will look for a file with the exact name as the document file, but with the extension ".meta", in the same folder as the document file. If the input file is the Workflow Job File, the Metadata file is looked for in the Workflow Job File folder.
Tip It is recommended to refresh the list before defining any index values. Click the button next to the Target File Cabinet name to refresh the list. Note In DocuWare specific index fields can be set to be visible or invisible. The API used by the plugin is currently not able to filter. This can lead to differences between indexes shown in the DocuWare interface vs. those visible in the plugin. It also isn't possible for the plugin to show which index entries are mandatory and which are not.
Note The plugin will not check any index values before sending them to the Docuware server. All responsibility for defining correct values lies with the user. XML structure In order to pass index data via an XML file, the structure of the file must be like it is in this example: 12345 98765 ...
variable, it is important to know that the password will be unprotected. It is the user's responsibility to protect the passwords in such cases. Working Directory In case of any upload issue, the log messages and the related file and its index values will be stored in the Working Directory defined here. You can use static text and/or Workflow variables, data and lookup functions.
Installation This plugin is not installed with Workflow, but it is available for free download from the Resource Center (help.objectiflune.com). After downloading the .PPK file, you will then need to import it into Workflow yourself. See See Importing a plugin. Once imported, the DocuWare Upload plugin will appear in the Uncategorized category within the Plug-In Bar. To be able to use this plugin you need a working DocuWare installation and user account with appropriate permissions.
Task properties Connection tab The Connection tab fields set the connection parameters. You can use static text and/or Workflow variables, data and lookup functions. Right-clicking a field opens the contextual menu that allows to add variables, data and lookup functions (see "Data selections" on page 54), where available. DocuWare Server Enter the DocuWare Host address. For example https://mycompany.docuware.cloud Organization Enter registered Organization name.
Test Connection This button tests the connection details entered in the Connections tab. If a successful connection is made, then Connection Success will appear as the current status. When a successful connection is made a listing of all the available cabinets and fields for that login will be downloaded and stored locally, for use in the Upload tab. Once a connection has been established and the cabinet and file information obtained, the plugin will open upon the Upload tab when next plugin is next opened.
the validity of the file name, if it were not browsed for. If no upload file has been specified, DocuWare will take the name of the uploaded file as the document name. If the Workflow Job File is to be uploaded, it is highly recommended renaming the file, as otherwise the Workflow temporary file name will become the document name. l File type: Enter the type of file, from the list contained in the drop down box.
field screen entry, whenever a new Cabinet is selected. l Create a new document / Update existing document selection: Choose between these two options. Each does as the name suggests. l l Create a new document will load the document as a new document to the DocuWare server. This document will be named based upon the document name field (as seen highlighted in the Document name field screen entry).
Index Data Select whatever Index fields you want to add via this index table. You can populate the table with all the available Index Field options at any time by selecting the Add missing fields ( ) button. If selected initially this will add all the available fields to the table. If selected after some fields had already been added via the field picker button ( ), it will add any missing fields to the end of the Index data table.
l l yyyy-mm-dd l yyyy-mm-dd HH:MM:SS Yes/No, True/False, 0/1 values: Such values may be entered as either "Yes", "1", "True" or "No", "0", "False". Any other value will raise an error. Also note that index names are case-sensitive. Note 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.
These plugins are not installed with Workflow, but they are available for free download from the Resource Center (help.objectiflune.com). After downloading the .PPK files, you will then need to import them into Workflow yourself. See .See Importing a plugin. Once installed, the M-Files 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 M-Files installation and a user account with appropriate permissions.
Processing The M-Files Download plugin starts by sending a login request to the M-Files Server. Once the connection is established, it tries to download a copy of the specified file from the Vault that it is connected to. If the search for files results in multiple files being found, then only the first file is downloaded. The downloaded file is not removed from the M-Files Server. The plugin saves either the file name or the (JSON) response that it gets from the M-Files Server in the specified variable.
l l l Property Definition ID: The property to search for. Property Definition IDs can be found in the Metadata Structure of the respective Vault on the M-Files server. Value: The value to search for. Response: Select whether to store either the file name or the response that the plugin gets from the M-Files server in a variable, and specify the name of the variable to use.
Processing The M-Files Upload plugin starts by sending a login request to the M-Files server. Once the connection is established, it tries to upload the specified file to the M-Files server, either as a new document or as the new version of an existing document. The plugin saves the (JSON) response that it gets from the M-Files Server in the specified variable. Output The output of this plugin is the unchanged Job File. Task properties General Tab All of the properties on this tab are dynamic.
l l Update: In this mode, the file is added as the new version of an existing document (at the root level of the Vault) and its properties may be changed. To find the existing document, the plugin needs the following data: l l l Document Class ID: Document classes are defined (per vault) on the M-Files server. Specify the desired Class by giving its ID (an integer). Property ID: Enter the integer that identifies one property of the existing document.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
Input Any data file present on a SharePoint document store, even those not compatible with PReS Workflow emulations, and the properties of these files. Processing The task connects to the selected Document store and retrieves a copy of files according to the specified rules. The files may be deleted or marked as checked out depending on the options selected, otherwise they are untouched. Output The output to this task is a series of individual files, one after the other.
l l l Download files from sub-directories also: Check to also look into subdirectories of the specified Folder. Do not download checked out documents: If the document is set as "Checked Out" in SharePoint, it will be ignored. Action Group l l l Download the document: Simply download the document and do not modify it in SharePoint. Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint.
CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 895. 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.
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.
l l l l Field Name: Name of the field as set in SharePoint Document Library. Field Information: The information to enter in the SharePoint Document's Metadata for this field. Use PDF/A: Check to use the information contained within an PDF. This PDF must have been created with PReS Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library.
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. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
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 match, 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. The Mailjet plugin allows you to: l l Specify the emails' campaign name.
All attachments should be combined in one array: [{"url":"file:///C:/Terms-andConditions.pdf","disposition":"attachment","name":"Terms.pdf"},{"name":"Take action Mandie.pdf","disposition":"attachment"}] The order of the key/value pairs is not important.
Custom header names normally start with "x-": {"x-my-header":"myvalue"}. l Debug settings: l l Send all messages to the Test Address: When this option is checked, Mailjet will only send the emails to the given Test Address. This allows you to review the result and to test ESP specific options like open rates and click through statistics. Log email messages: Check this option to get a copy of each message in the Messages window of Workflow.
l l l Tag the emails with category names, which help organize your email analytics (see About categories). Set a time at which the emails should be sent (see Scheduling parameters). Add custom headers specifying specific handling instructions for your email. (To get an idea of what these could be used for, see SendGrid's blog post about email headers). Input Extra attachments To specify an extra attachment, you have to use the key/value pair "disposition":"attachment".
It then transforms the files into email messages as specified by SendGrid and sends the emails via the SendGrid v3 Web API. Output This task does not make any changes to the Metadata or the Job File. Properties General Tab l SendGrid API: l l l l l l API Key: Enter your API key, retrieved from SendGrid. It will be used for authentication with the SendGrid v3 Web API. A valid key is required to send email messages.
l Log email messages: Check this option to get a copy of each message in the Messages window of Workflow. You can use this to verify that the messages match the format required by the ESP. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. On Error Tab Miscellaneous Tab The Miscellaneous tab is common to all tasks.
About variables A variable is basically a keyword that points to specific location in your computer's memory. This location contains data that you decide to place in it, by assigning that data to the variable name. There are four types of variables that can be used in PReS Workflow: l l l l Global variables are available to all processes and tasks within the configuration, and any modification made to them affects all tasks and configurations. For more information see "Global variables" on page 741.
Not all available Job Infos will actually be used by input tasks. The number of Job Infos as well as their definition can be seen in the Other tab of any input task. The value of a Job Info can also be set: l l Via the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 468. Via a Script task. See the chapter "Using Scripts" on page 143.
data file. Job Infos sent to the document are global to that document, meaning the values do not change between data files. This means that if your data file contains multiple data pages for different clients, your Job Infos cannot be used to send information to the document. Tip You can also access global and local variables from your document using the ExpandString() function. For more information, please see the PlanetPress Design User Guide.
Variable Name Example value when interpreted %O Original file name without extension invoice_june2nd %y Current year 2010 %m Current month (numeric) 06 %M Current month (text) June %L Current month (short text) JUN %d Current day (numeric) 16 %D Current day (text) Monday %l Current day (short text) MON %h Current hour 18 %n Current minute 03 %r Run mode (0: runtime, 1:debug) 0 %s Current second 41 %v Current 24 Page 736
Variable Name Example value when interpreted millisecond %u Unique 13-char string (will be different every time it is used) 0ZIS4CW8U47VI00 %U Unique 36character string consisting of 32 alphanumeric, lower case characters and four hyphens. Format: xxxxxxxx-xxxxxxxx-xxxxxxxxxxxxxxxx (8-4-4-4-12 characters). 123e4567-e89b-12d3-a456-426655440000 %t Current temporary folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PReS Workflow 7\PlanetPress Watch\Spool\6.tmp\ %e Current M
Variable Name Example value when interpreted %w Current process name My Process %i Current Loop iteration index (always the innermost loop) 2 The %i Loop Count variable The value of the %i variable is equivalent to the current iteration of loops inside of a process. It always contains the value of the innermost loop, and only certain tasks trigger the counter to start.
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. 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 743.
by using its name, surrounded by curly brackets and preceded by a percent sign, for example: % {myLocalVariable}. When the process ends, the local variable forgets whatever value was given to it by the process and goes back to its default value. Local variables are generally used to keep information that is useful for the process itself but not to any other process or instance of the process. For example, you could store the current order ID for the process, a name, or an email.
Note While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it will not change the references in any script within a Run Script task. Setting a variable value within a process You can set the value of a variable within your process in two ways: l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 468. You can use Scripts. See the chapter "Using Scripts" on page 143.
1. Right-Click on Global Variables. 2. Click Insert, then Insert Global Variable. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To add a global variable from the Ribbon: 1. Click on the Home tab of the PReS Workflow Ribbon: 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.
Note While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it will not change the references in any script within a Run Script task. Setting a variable value within a process You can set the value of a variable within your process in two ways: l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 468. You can use Scripts. See the chapter "Using Scripts" on page 143.
l Printer Control Characters. See "Shared printer queue properties" on page 114. These are normally only used in printer outputs. 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 468. l In Scripts. See the chapter on "Using Scripts" on page 143. l In the Create File Input Task. See "Create File" on page 348. l Within a PlanetPress Design Document, using the ExpandString() function.
time a new data file passes through it. This is indicated by a data selection (see "Data selections" on page 54). 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.
l Image. See "About PReS Image" on page 775. l M-Files. See "M-Files" on page 714. l OL Connect Send. See "OL Connect Send" on page 776. l ZUGFeRD. See "ZUGFeRD" on page 777. 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.
Anoto Digital Pen A digital pen compatible with the Anoto system. These pens contain a camera, processor and memory chip which record each stroke of the pen on a printed Anoto Pattern, and are able to send this information back to PReS Workflow. This document specifically refers to the Anoto DP-201 Digital Pen, not other equipment has been tested.
Client/Server Architecture A multi-server setup where more then one PReS Workflow server are connected as clients to a single PReS Workflow server which has a Capture Database. In this architecture, the Server contains the licenses for the pens, however the Client contains the database of documents and patterns. The Clients communicate with the server to authenticate pens. This architecture is only provided to simplify pen licensing for users with a large number of pens.
Pattern Sequence Pattern Sequences enable the multiplication of the number of available pattern by adding an extra identification to the document. A Pattern Sequence is also attributed to each Anoto Digital Pen, such as an incoming PGC file will contain the Pattern, on which the Pattern Sequence is added from the pen database. The pattern and pattern sequence refer to a specific document in the database.
General considerations Here are some general considerations in regards to PlanetPress Capture, its environment, the hardware and the software that interacts with it. Please review these considerations carefully as they may impact PlanetPress Capture and its functionality. Warning PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently.
l l Microsoft Access l l Database file (mdb) must be local to the PReS Workflow computer. It cannot be located on a network drive or another server. l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PReS Workflow through an ODBC connection on the local network.
l l l In MySQL, the 16 megs packet size limit can be an issue if the PDFs created by Capture are larger than this size; An error saying "MySQL Server has gone away" would appear in this case. This can be fixed by configuring the max_allowed_packet setting in the MySQL Configuration (Reference). Also in MySQL, if a timeout occurs on simultaneous record access, resubmitting the PGC for processing should resolve the issue.
l l l l l PGC Files, while not written in plain text, are not encrypted and are readable through either PReS Workflow (even a server that did not generate the document associated with it), or through third-party applications using the Anoto SDK. This means if someone gains access to your PGC storage folder, they may be able to read the signatures, checkmarks and other information contained in it and reproduce them on a document of their choice. It is always better to secure this folder properly.
The Numbers First and foremost, the 20,000 patterns is a fixed number - PReS can only generate 20,000 unique patterns as this is the number of patterns that we license through Anoto. The 20,000 patterns are, however, not all available when generating documents. There are 8 "demo" patterns that are used to generate documents when PlanetPress Capture is in demo mode (no license activated), and react the same way that the bulk of the 20,000 patterns.
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.
Using Pattern Sequences In the event where a single location generates all the patterns and this output *can* be split into multiple logical zones, Pattern Sequences can be used. A Pattern Sequence is basically a "tag" that is added after the pattern's identification (Pattern ID). When a Pattern Sequence is used, each Pattern Sequence can re-use each of the 20,000 available patterns.
As you may have figured out by now, we are still not actually printing more than 20,000 patterns. The only distinction here is that we are re-using patterns in separate "zones" (or, well, sequences) and as long as pens and pages using capture patterns are not exchanged between these zones, they act independently with their own 20,000 pattern limitation.
Second, contamination can happen in method 1) above if a pen or paper is moved from one location to another. Similarly to the previous contamination example, if there exists a document in the Capture Database where the "wrong" data is processed, it will update a document where it does not belong. Again, neither the pen nor PReS Workflow have any idea that this causes an error until it's too late.
l l l When necessary, patterns can be extended using multiple servers or Pattern Sequences (as long as these are used in separate physical locations). It is extremely critical that contamination be avoided at all costs. Whenever possible, always avoid using pattern sequences unless it is absolutely necessary to do so. Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc.
To pair penDirector with an Anoto Digital Pen: 1. Make sure that a Bluetooth dongle is present and enabled on the computer where penDirector is installed. 2. Note down the PIN of the Anoto Digital Pen, by docking the pen and going in the Pen settings tab of penDirector and looking at the Pen access group at the bottom of the dialog. The default PIN is 0000. 3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4.
PlanetPress Mobile Application The PlanetPress Mobile application can be installed on some mobile phones and enable fast and direct connectivity between the Anoto Digital Pen and PReS Workflow. The connectivity between the pen and the mobile phone is done through Bluetooth, while the connectivity between the mobile phone and PReS Workflow is through the currently active data plan (either wifi or the cell phone company's data plan, such as 3G).
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.
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.
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.
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.
l l l l In PlanetPress Design, a Capture Field Object must be added and the Perform ICR option must be activated (See the Capture Field page in the PlanetPress Design User Guide). This must be either a Multi-Area Field or a Text Field. The Capture Fields Processor must have the Perform ICR Recognition option checked, and language needs to be selected. Once the ICR data is available, do something with it.
the pen, its movement speed as well as the overall shape of each character to determine which character was written. l l l ICR Value: The alpha, numeric or alphanumeric value that was determined by the ICR engine. ICR Confidence: A percentage value that the ICR engine gives to any specific value, when comparing the pen data with it's character database. ICR Resemblance: A percentage value that defines how closely the value resembles the "average" character shape.
Using the Most Restrictive Mask l l Target: Form designer. What: In the Capture Options tab of a Capture object, the mask type indicates the type of character to be recognized. There are 3 possible selections: numeric, alphabet and alphanumeric. The alphabetic mask type allows you to select the letter case.
How: Use the following options from the Capture options tab under Mask Type and Case option to filter the expected data. The following diagram illustrates the available mask types. It is recommended to select the mask type that is the closest to the desired result. An alphanumeric field should be used as a last resort.
Guidelines for Capture-Ready Fields l l Target: Form designer What: Only one character per Capture field can be recognized. When expecting multiple characters making up a word or phrase, you must make sure that the user only writes one character per field. In order to do so, you must make sure that the fields are big enough and have enough space between each one. The best practice is to make sure that there is a boundary surrounding the field where ink marks are to be written.
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.
l Write an additional line under the number 1. l Write an additional line across the number 7. l l l The ICR functionality of PlanetPress Capture cannot recognize dotted letters where there are circles instead of dots (like i , j). This would be analyzed as an i AND o. Therefore, dots should be as such and not circles. In French, the ç is somewhat sensitive. You must apply yourself and draw the letter carefully. In most cases, it is recognized, but attention must be paid. Number 8 is also sensitive.
Possibility of Interpretation Error in an Automated Process l l Target: Workflow designer What: We cannot be 100% sure that a character would be recognized by PlanetPress Capture as it should. Therefore, the analysis of a value interpreted with ICR should only occur if the level of confidence is superior to a determined level.
Why: An automated process can treat the characters incorrectly due to an incorrect interpretation of a value. This occurrence should be minimized as much as possible. 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.
every computer where PReS Workflow is running, but you may also choose to run it on computers more or less dedicated to PReS Fax. Since the faxing program must always be running and ready to receive requests from PReS Workflow, it should be included in the Windows Startup group. PReS Fax can associate a different fax number with each page it sends via the faxing software.
PReS Image can be installed on any computer on your network and can process requests coming from tasks performed by PReS Workflow on other workstations. You may choose to run it on every computer where PReS Workflow is running, but you may also choose to run it on computers more or less dedicated to PReS Image. Note that in the case of Digital Action tasks, PReS Workflow and the PReS Image service must be running on the same computer.
OL Connect Send tasks l "Get Data" on page 604 l "Get Job Data" on page 609 l "Job Processor" on page 613 ZUGFeRD The ZUGFeRD plugin provides a way to enrich German PDF invoices with data specific to the invoice. This is done by embedding the data in a standardized XML format within the PDF itself. ZUGFeRD is an acronym for Zentraler User Guide des Forums elektronische Rechnungen Deutschland. In English this translates to Central User Guidelines of the Forum for Electronic Billing in Germany.
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" below. Plugin Legal Notices and Acknowledgments Copyright © 2021, Objectif Lune Inc. All rights reserved. The ZUGFeRD name and logo are protected under copyright and used with permission of the Arbeitsgemeinschaft für wirtschaftliche Verwaltung e.V. in Germany. The Objectif Lune Inc.
If the incoming PDF is not PDF/A compliant, the plugin will not touch it but will instead forward the untouched PDF as the Job File. If the incoming PDF already contains ZUGFeRD data, the plugin will not touch it but will instead forward the untouched PDF as the Job File. Properties ZUGFeRD I Tab The ZUGFeRD data entry options are too large to fit within a single entry tab, so the data entry options have been split over two tabs. ZUGFeRD I is the first of these.
instead forward the untouched PDF as the Job File. If the incoming PDF already contains ZUGFeRD data, the plugin will not touch it but will instead forward the untouched PDF as the Job File. l Rechnung group contains invoice related information. l l l Rechnungsnummer: The invoice number. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Dokumentenart: The document type. This field will always be set to "RECHNUNG" (invoice), to cater for BASIC invoices.
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.
Note The plugin does not check if a given tax ID number conforms to any rules. It is the responsibility of the user to ensure that only valid tax ID numbers are entered. This field can be set via Workflow data and/or variables. l Käufer group contains all the required values and information related to the buyer. l l l Name: The individual or company name. This field supports alphanumeric strings and can be set via Workflow data and/or variables.
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. ZUGFeRD II Tab The ZUGFeRD data entry options are too large to fit within a single entry tab, so the data entry options have been split over two tabs.ZUGFeRD II is the second of these. All the entry fields on the ZUGFeRD II tab support the use of variable data.
l IBAN: A bank account number following the International Bank Account Number (IBAN) standard. The IBAN consists of an alphabetical country code, followed by two check digits, and then up to thirty five characters for the bank account number. The bank account number can include the domestic bank account number, the branch identifier, and potential routing information. Note The plugin does not validate bank IBAN/BIC codes. It is the responsibility of the user to ensure that valid codes are entered.
Note The plugin will accept any string. The user needs to take care to only enter valid tax codes as defined in the UNCL 5153 (see http://www.unece.org/trade/untdid/d97b/uncl/uncl5153.htm ). This field can be set via Workflow data and/or variables. l l l l Steuerprozentsatz: The tax rate entry. This is the percentage that applies for the taxation calculation. This entry should be a numeric currency entry, which can be set via Workflow data and/or variables.
and/or variables. Bei Fehler/ On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 100. Anmerkungen/ Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
Available Input services Input services are used to pull in data files. The input services used by PReS Workflow are: l l l l l LPD (Line Printer Daemon) Input service: Inputs data sent from an LPR client. The LPD/LPR printing protocol is a common way to send print jobs that, in turn, use the TCP/IP protocol to communicate through the network. PrintShop Mail Web Capture service: Monitors print requests from a PrintShop Web server. Serial Input service: Monitors a single serial port for incoming data.
dispatch them from the host on which it runs, using a local faxing program, such as WinFax PRO, Captaris RightFax or Windows Fax. See "About PReS Fax" on page 774. l l l PrintShop Mail: Used to generate documents using PrintShop Mail databases and documents. Communicate with it through the PrintShop Mail and PrintShop Mail 7 Connector Tasks. See "PrintShop Mail" on page 553. Laserfiche: Used as a repository for electronic documents. Communicate with it through the Laserfiche Repository Output Task.
Note If you send a new configuration when PReS Workflow is paused, it will continue using the old configuration when you resume processing until you stop and restart it. See also: "Saving and sending a Workflow Configuration" on page 140. l Click Resume to resume the service after pausing it. The PReS Workflow Tool service starts performing jobs again. Users and configurations When a user opens a session on a computer, they typically need to log in.
PReS Workflow and all its services have the same rights on all computers and that it is therefore able to perform all the actions defined it needs to on every computer on your network. A less permissive solution is to create an administrator local account for PReS Workflow and to replicate it on each computer where PReS Workflow and its services are likely to perform operations, such as get files, store files, or run applications and perform operations.
Set the PReS Workflow applications permissions as required: l l l l Local System account: Select to run all the PReS Workflow Services (including PReS Workflow, PReS Fax, and PReS Image) under the Local System account. The Local System account is distinct from the Administrator account. It requires no user name or password, and its privileges may exceed those of the user currently logged in.
The PReS Workflow Configuration program does not test user names and passwords, but merely associates them with the services that require them. If you enter a bad user name or password, these services will be denied access to the selected account. The account you choose will be used by PReS Workflow and all its services, as well as by PReS Fax and PReS Image.
Preferences PReS Workflow Configuration program lets you configure a variety of options, from how the application itself looks or behaves, to plugin specific options. Most of PReS Workflow preferences are located in the PReS Workflow Preferences window, accessible through the Preferences button in the PReS Workflow button, or the key combination Ctrl+Alt+P.
l "Telnet Input plugin preferences" on page 828 l "PReS Fax plugin preferences" on page 829 l "FTP Output Service preferences" on page 832 l "PReS Image preferences" on page 833 l "LPR Output preferences" on page 837 l "PrintShop Web Connect Service preferences" on page 838 Note Preferences are saved automatically and applied immediately.
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.
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.
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.
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.
l l l l l l l l l l l Invalid name: Select to have PReS Workflow warn you when you try to rename an object in the Configuration Components incorrectly. Names can include letters, numbers, and underscores; the first character of a name cannot be a number. Printer queues update: Select to have PReS Workflow prompt you when adding a document to a group under the Documents category in the Configuration Components pane.
l l l l l l l l l l Prompt on overwrite of a document: Select to have PReS Workflow prompt for confirmation when a document that is being imported using File | Import Document is about to overwrite an existing document. Prompt on Document overwrite when service is running: Select to have PReS Workflow prompt for confirmation when a document that is being imported using File | Import Document is about to overwrite an existing document.
configuration file. Imported components can overwrite existing components, or be renamed automatically with unique names. Sample Data behavior preferences Sample Data behavior preferences control the way theData Selectordisplays the sample data file. Preferences l l l Select Font button: Click to access the Font dialog box to select the font in which the Data Selector displays the sample data file.
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.
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.
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.
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.
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 802.
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.
l l l Database file (mdb) must be local to the PReS Workflow computer. It cannot be located on a network drive or another server. l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PReS Workflow through an ODBC connection on the local network.
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.
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.
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.
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.
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.
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.
l l l l l l Task failure: Select to only track when tasks in the processes running in a PReS Workflow configuration fail. Task success and failure with details: Select to track when the tasks in processes running in PReS Workflow succeed and fail, with details. Details can include why tasks fail and how successful tasks are executed. All events with details: Select to log everything that happens in PReS Workflow.
Preferences l PReS Alambic options group l l l Let me set up how many instances to run: Select this option if you want to limit the number of instances of the Alambic that PReS Workflow can run. Then enter the number of instances, a value ranging from 1 to 32, in the box below. When this option is not selected, PReS Workflow starts a minimum of three instances and a maximum of eight, based on the number of CPUs available on the server. Note that this does affects self-replicating processes.
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 824.
This password is encrypted within PReS Workflow server and is not saved in plain text. l Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. 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.
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.
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.
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.
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.
Preferences l Protocol options group l l l l l Log all Winsock and network messages: Select to have PReS Workflow keep a log of all Winsock and other network messages that occur through the LPD service. These are messages related to jobs being sent from other systems through LPR, and being received by PReS Workflow via LPD. Since these messages can accumulate, you have the option of not logging them. Log files are kept in the Log folder, which is located in the PReS Workflow installation folder.
NodeJS Server Input plugin preferences 1 The first set of NodeJS Server Input plugin preferences controls the server protocol aspects of the PReS Workflow NodeJS Server Input tasks. This is where you enable and configure secure communication for the NodeJS Server. Click the PReS Workflow button and then the Preferences button, to open the Preferences dialog. The NodeJS Server Input 1 preferences page can be found under Plug-in. Note Workflow's NodeJS and ppNode folders can be found in %PROGRAMFILES%\Object
be forwarded to the target specified in the proxy list (see "NodeJS Server Input plugin preferences 2" below). l l l l l l l HTTPS Port: Select the port to use. The task's default HTTPS port is 8443, so as not to interfere with the standard HTTPS port (443). Port numbers > 9999 are possible. Root certificate: Enter the absolute path to the Root Certificate, or click the Browse button and select the file in the Browse dialog. The file generally ends with a .crt extension.
l Proxy List: The proxy list is used to setup end points for redirecting requests to another server. l l Mount point: Specify a path name for which requests should be redirected to another site, for example: /myrest. Different mount points can point to the same remote site. Use the buttons below the list to add or delete mount points and to change the order of the mount points in the list. Remote site: Type the address of the server to which the request should be redirected.
Note In the address of the server and in the domain name the following characters should not be used: , + $ @ # < > ' ; | { } ~ [ ] * " : Testing the server l To test the server address and domain, enter a username and password and click the Test server button. Note The user name and password aren't part of the plugin preferences. Users will have to provide their credentials themselves and will be presented with an HTML page for that purpose.
and end of each unit of transferred data, as well as error detection provided by the parity bit. The majority of serial ports use between five and eight data bits. Binary data is typically transmitted as eight bits. Text-based data is transmitted as seven bits or eight bits. If the data is based on the ASCII character set, a minimum of seven bits is required. If an eighth bit is used, it must have a value of 0. If the data is based on the extended ASCII character set, eight bits must be used.
Preferences l l Log all Winsock and network messages (very verbose): Select to have PReS Workflow keep a log of all Winsock and other network messages that occur from the Telnet input. These messages are related to files sent from other systems using a telnet connection. Since these messages can accumulate, you have the option of not logging them. Use Job Delimiters: Check this option if your Telnet input is a single stream that can contain multiple jobs.
l WinFax Pro l Dialing format: Select how you want PReS Fax to read the fax number in the data selection and send it to WinFax PRO. The dialing format you select here must be identical to the one you set in WinFax PRO; a discrepancy between the two may result in WinFax PRO dialing incorrect fax numbers. Select Default to have PReS Fax set the dial prefix, long distance prefix, area code, and fax number according to the content of the data selection, and send the result to WinFax PRO.
file is copied to the specified Report folder only after all fax transmissions in a PReS Fax job are completed or have exceeded the maximum number of retries. This folder can then be used as an input for a PReS Workflow process for monitoring the status of PReS Fax jobs. The postscript (PS) file for the job is also copied with the report file and can be printed, sent by e-mail, or archived as specified by the PReS Workflow process.
(\\servername\sharename\path\filename). This naming convention works well with Windows operating systems, Novell NetWare, and other operating systems when using a local naming system (such as the DOS naming system in Windows) would result in “File not found” error messages. l 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.
Options l Protocol Options Group l l l l Log all Winsock and network messages: Select to have PReS Workflow keep a log of all Winsock and other network messages that occur through the FTP output. These messages are related to jobs sent from PReS Workflow to a server via an FTP output, which in turn uses the FTP output service. Log files are kept in the Log folder, which is located in the PReS Workflow installation folder. They are named ftpdate.
PReS Image 1 or logging tab l l Administrator’s address(es): Enter one or more system administrator email addresses to which error and other messages related to the creation of PDFs/images by PReS Image are sent. Separate multiple email addresses with semi-colons (;). Send to the administrator group l l l l l l l l Daily log: Select to send an email to the administrator every day at midnight (according to the local system clock) reporting the daily activity of PReS Image.
l Select Language: Click to select a different interface language for the PReS Image Configuration applet. Note that this button is not displayed if you edit the PReS Image options directly (not via PReS Workflow Configuration program). PReS Image 2 or database tab Add PDF to PReS Search database group: Select to populate a PReS Search database using the documents created by PReS Image and to activate the related options.
PReS Image 3 or network tab The options in this section are identical to the ones in the Network User Options section. However, they determine how PReS Image will interact with your Novell NetWare system, not the PReS Workflow Service. PReS Image 4 or login tab l l Use Microsoft Outlook: Select to use Microsoft Outlook on the host computer running PReS Image to send the error messages to the administrators. The host computer must be running Outlook, and PReS Workflow must have access to Outlook.
LPR Output preferences LPR output user options control certain functions of the LPR Client service, which in turn has a direct impact on all LPR output tasks performed by PReS Workflow on a given computer. Options l Protocol options group l l l l l Log all Winsock and network messages: Select to have PReS Workflow keep a log of all Winsock and other network messages that occur through the LPR output. These messages are related to jobs being sent from PReS Workflow to an LPD or LPD-compatible printer.
l LPR settings group l l Time-out: Set the time in seconds the PReS Workflow process waits when it sends jobs using the LPR protocol. The default value for the Time-out property is 7200 seconds (2 hours). On a time-out, partially sent data files are not passed to the rest of the process; the LPR output resets and is ready to send further data files. Log messages include the time-out duration.
Script Editor and XSLT Editor" on page 145). There are a number of options for the editors, which you can set via the menu: Tools > Options, in the editor. Most of the options listed below are valid for both editors. Those options which are only valid for a specific editor are identified as such. l Editor l l l l l l l l Auto indent mode: Select to automatically position the insertion pointer under the first non-blank character of the preceding line when you press ENTER.
l l l l l l l l l l Cursor beyond EOF: Select to make it possible to position the pointer beyond the end of the program file. Clear to prevent this. If you clear Insert mode and select Cursor beyond EOF, you can only overwrite the existing lines of the program; you cannot add lines to it. Cursor beyond EOL: Select to make it possible to position the pointer beyond the end of the line. Clear to prevent this. Keep trailing blanks: Select to preserve any blank spaces occurring at the end of a line.
l l l Block indent: Enter the number of spaces to jump for each block indent. The default is 2 and the maximum is 16. The Block indent typically should agree with the tab stops in the Tab stops option. Perform a block indent by selecting a region of code and pressing CTRL+SHIFT+I (to indent the code to the right) or CTRL+SHIFT+U (to move the code to the left). Tab stops: Use to set the number of spaces to advance when you enter a tab character or to set a series of tab stops.
the distance from the left margin to the right margin indicator is 80 characters. Use the drop-down list to select a previously-entered margin position. l l l l l Gutter: Select to have the Editor display a gutter between the Commands and Code areas. Use the Gutter width option to set the width of the gutter. Select the Line numbers on gutter option to display line numbers in this area. Gutter width: Enter the width, in pixels, of the gutter.
l l Italic: Select to italicize the element highlighted in the Element list box when it is displayed in the Script Editor. Underline: Select to underline the element highlighted in the Element list box when it is displayed in the Script Editor.
The user interface This chapter centers on the PReS Workflow Configuration program, which you use to create and edit your configurations. The basic user interface elements are as follows: l "PReS Workflow Button" on page 854. l " The Quick Access Toolbar" on page 924. This toolbar is customizable. l The ribbon tabs; see "The PReS Workflow Ribbon" on page 925. l "The Process area" on page 916 l "Configuration Components pane" on page 855.
Customizing the Workspace You can combine and attach the Configuration Components pane, Messages area and Object Inspector into a single secondary window that can be docked to and undocked from the main PReS Workflow Configuration program window. Combining and attaching areas can facilitate the management of your screen real estate. It lets you reposition multiple areas in a single operation.
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.
the Messages area. The area will jump from an undocked to a docked position and viceversa. Show or hide areas of the program window You can choose to hide or display any of the customizable areas in PReS Workflow program. Hidden areas will still contain the same information but will not be visible. To show or hide a Program window area: 1. In the PReS Workflow Ribbon, click the View tab. 2. From the Show/Hide group, click on any area name to hide or display it.
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.
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.
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.
Image: A) Click to maximize this area. B) Click to restore this currently maximized area.
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.
To resize a program window area: 1. Move the pointer to an edge of the area that you want to resize, to display the resize pointer. 2. Then click and drag to resize the area. Change the Interface language PReS Workflow can be used in multiple languages, and the list of available languages grows as we translate the software. The first time you use PReS Workflow, it starts in the language used for the installation. To change the language used by the PReS Workflow Configuration program: 1.
Japanese. PReS Workflow Button The PReS Workflow button provides access to the File menu options. Options l l l l l New: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. See "Creating a new configuration" on page 35. Open: Displays the dialog to open an existing configuration file. Save: Saves the current configuration.
l l l l l Close: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. Closing the current configuration is the same as creating a new one. Recent Documents: Displays a list of the 9 most recently opened configuration files. Click on any of them to open it. Select Language: Click to display the language selection dialog, which changes PReS Workflow interface language. See " Change the Interface language" on page 853.
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 126).
l l Properties...: Displays the properties, which lets you set a default value for the global variable. Connect Resources: Displays a list of PReS Connect resources that can be used in processes (see: "Connect resources" on page 40). Different resources are divided into subfolders: l Data Mapping Configurations: Displays a list of data mapping configurations used with the Execute Data Mapping task.
l l Properties...: Displays the properties, which lets you see the form information and select its default printing behaviors. Printer Queues: Displays a list of printer queues in your configuration (see: "PReS Workflow printer queues" on page 112). Right-click on a printer queue to access a dropdown menu that offers these choices: l l Insert Printer Queue: Creates a new printer queue in your configuration. Replace Printer Queue By: Replaces the currently selected printer queue with a new one.
Note Subprocesses do not have the General tab which is only used for scheduling, but they do have the Information tab. Options General tab l l l l l l l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PReS Workflow. Startup: Select to make this process a startup process (see: "Startup processes" on page 127). This option is not available for self-replicating processes and error processes.
that's only scheduled to run one hour per week, it will capture the input 120 times during that period. Note that the polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to process. l l Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked.
In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not poll. Note that when multiple files are present in the input, these may continue to be processed after the period set in the time grid. The "Folder Listing" on page 357 plugin in combination with a "Time of Day Condition" on page 514 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. 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.
l l Description: A one-line box to give a title or short description to your process. Comments: A multi-line box to give more detailed information, for example the file format expected, explanation of the system in general. 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.
Document properties options Identification Tab The information here is read-only and gives you information on the document. l l l Document: The file name of the document, as entered in PlanetPress Design. This is the name of the file saved in PlanetPress Design, or the name you give it when you add a printer-resident document in your PReS Workflow Configuration. It may have a PTK extension (if it has been sent to PReS Workflow from PlanetPress Design), or a PS extension (if it is printer-resident).
l Document location group (enabled only when using Printer-Centric mode) l l l l l On printer hard disk: Select if the PlanetPress Design document is on the printer's hard drive. In printer flash memory: Select if the PlanetPress Design document is on the printer's flash memory. RAM: Select if the PlanetPress Design document is on the printer's RAM (Random Access Memory).
Mouse cursor As you drag a configuration component, your mouse cursor will change to indicate the action you are performing, as well as whether the location where the cursor is can accept the configuration component you are dragging. If you try to drag a configuration component in a location that is not accepted, the cursor changes to a "prohibited" icon. If you are moving a configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box.
When dragging configuration components, a horizontal line appears where the component will be dropped (if the location is valid). At the end of this line will be small "dents". If these dents are on top of the line, the component will be placed at the same level (group) as the component before it. If the dents are at the bottom, the component will be placed at the same level (group) as the component after it.
same methods as moving them, with the following differences: l l To copy components using the clipboard buttons and contextual menu, replace Cut by Copy. Otherwise the methods are the same. To copy components using the keyboard shortcuts, replace CTRL+X by CTRL+C. Otherwise the method is the same. Note You can also copy multiple components by selecting more than one then using the methods described above. However, you can only select multiple components from within the same folder.
1. In the PPD/PSM Documents section of the Configuration Components pane, doubleclick a printer-resident document. The PlanetPress Design Document Options dialog box is opened. 2. In the Document name box, enter the new document name and click OK. Reordering objects in the Configuration Components pane There are multiple ways you can reorder objects in the Configuration Components pane.
Grouping Configuration Components Groups help you organize processes, documents, and printer queues. For example, you may create the Invoices, Checks and Reports groups in the Processes section and associate individual processes with each one of these groups. Each group may contain subgroups. Items or processes, and groups, can only be grouped within their own category.
Ungrouping objects To remove a group in the Configuration Components pane, but keep its contents: l Select the group and choose View > Ungroup. l Right-click on the group and select Ungroup from the contextual menu. l Select the group and press CTRL+U. The contents of the group will move one level up. To remove objects from a group, without removing the group itself, select the object or objects and use one of the methods above or drag-and-drop.
l Click a process group, documents group, or printer queue group, then press the Delete key. In the case of process groups and printer queue groups, the group and all its members are deleted. In the case of documents, you are first prompted to confirm the deletion of each member of the group. You can turn off this prompt in the Notification Messages User Options.
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.
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.
Warning The following considerations are to be understood when using the Access Manager to configure IP limitations: l l l l Each permission type (column) is evaluated from top to bottom (column per column) in the order in which they are visible in the Access Manager window. This means that wide ranges should always be at the top to increase performance. For example, if you accept HTTP connections from any IP, the first entry should be 255.255.255.255 with the Allow checkmark in the HTTP Input box.
l l Send Document: Grants access to the remote computer to send new or updated Connect files (templates, data mapping configurations, print presets), or PlanetPress Design Documents, to this server. Send Config:Grants access to the remote computer to overwrite the configuration on the local PReS Workflow service Note In order for the changes made here to be effective, you will need to restart the PReS Messenger service. This can be done via the PReS Workflow Service Console.
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.
Note In order for the changes made here to be effective, you will need to restart the PReS Messenger service. This can be done via the PReS Workflow Service Console. Activate a printer The Activate a Printer dialog lists the existing activated printers on the system and lets you add new activations. Note Activating a printer is required when you have a PlanetPress Suite Printer License.
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. l OK: Save changes and exit. l Cancel: Exit without saving changes.
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.
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.
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.
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.
l l Right-click a task property that may contain variables (recognizable by the color of its field label, which is maroon by default) and choose one of the Get Data ... or Get Metadata ... options. Debug your configuration and step through it until the option Debug > View Metadata gets enabled. This happens when the Metadata file has been created by a task in the process.
The Data Selector is 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 485) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks.
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.
on page 58). 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 55. 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).
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.
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.
Font To set the font the Data Selector uses for all emulations except XML and PDF: 1. In the Data Selector, click the Selector Options tab. 2. Click Select Font. 3. In the Font dialog box, set the font you want PReS Workflow to use to display the sample data file in the Data Pane. l Font: Select the font you want to use to display the sample data file in the Data Pane. l Font style: Select a weight for the font. l Size: Select the point size for the font.
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.
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).
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.
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.
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.
again once it has completed itself and replicates again as necessary, until all files have been processed. l l l l l l Max percentage of threading (%): Determines how many processes you may have running at the same time. This is a percentage of the maximum number of threads specified in the "Messenger plugin preferences" on page 815. 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).
blocks (4 blocks per hour times 24 hours). If you select 24:00, each segment will represent an entire day. l l Poll once per activity period: Select to perform this process’ initial input task no more than once for each set of contiguous blocks (blocks that are on the top of one another). Choosing this option overrides the polling interval option. By default since the Time Grid blocks are divided by hours, this option will make your polling happen once every hour.
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.
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.
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.
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.
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.
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.
To start a stopped service: 1. Right-click on the service. 2. Click on Start. 3. Look in the Log window on the right to see the service starting. To stop a service that is running: 1. Right-click on the running service. 2. Click on Stop. If the service is currently processing a file (if a process is running, output is being generated, job being received, etc), the service will wait for this action to complete before stopping. To pause a service temporarily: 1. Right-click on the running service. 2.
the view in real time. When a service is selected on the left pane, its log file (if any exists for the current day) is displayed. The log displays in a tree fashion. The log itself is the root, and each session (the time between the start and stop of a service) is listed. Under each session, each time a process runs, a new branch is created and it can be expanded to see each action within that process.
Browsing log files Select File > Browse logs, to open a folder that contains either Workflow or Connect log files. This is useful when you need to delete a log file or open it in another editor because it has reached a larger size than the Service Console can handle. With this option you cannot open a log file in the Service Console. Note For Connect log files, the browser opens the current user's default Connect logs location.
Task Properties dialog Any task you add to your PReS Workflow process must be configured using its Properties dialog. It appears as soon as you add a task to a process, or when you double-click on a task. Each task's Properties dialog will give you the options to configure that specific, individual task. Properties of one task do not directly affect the properties of another task, however there are some software preferences that may affect tasks in one way or another (see "Preferences" on page 793).
l Printer Queue: Displays in which printer queue the document is present. l Printer Group: If available, displays in which printer group the document is located. l Document: Displays the name of the document. l Location: Displays the location (printer or Workflow) of the document. Select any document in the list (use CTRL+Click or SHIFT+Click to select multiple document or use the Select All button) and click OK to update these documents.
Workflow Services To be able to run and to have access to local files as well as to files available on other computers in your network, PReS Workflow applications and services must identify themselves using a local or network account. The first time you start the PReS Workflow Configuration program, the application automatically asks you to choose an account (see below).
l l l l l Browse: Opens the default Windows dialog for selecting users/groups/etc. from a domain. User: Enter the name of the user account. Password: Enter the password for the user account you specified in the user name box. Confirm password: Enter the password you entered in the Password box. Services start automatically: Select to start the required PReS Workflow automatically.
You can use the Evaluate Expression section to see the result of any combination of variable properties (see "Variable task properties" on page 743). To add a new expression, simply rightclick in the window and select Add Expression. Click in the box on the left to edit the expression and add any variable properties or static text you want, and click outside of the box to save it. Once saved, the Value column displays the expression's result.
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. While a line is selected, press CTRL+X on your keyboard or right-click on the line and select Cut to place the line in the clipboard.
Editing properties To edit properties of processes, documents, and printers in the Object Inspector: 1. In the Configuration Components pane, select a process, a document (either a document in the Connect Resources or PPS/PSM Documents, or a document assigned to a printer queue) or a printer queue. The selected object’s properties appear in the Object Inspector.
documentation, as tasks, except in the specific case of importing a new plugin or customizing the Plug-in Bar. Categories The default categories list plugins according to what type of task they achieve. When first starting your PReS Workflow program, the following categories are used: l Inputs; see "Input tasks" on page 345. l Actions; see "Action tasks" on page 406. l Data splitters; see "Data splitters" on page 479. l Process logic; see "Process logic tasks" on page 499.
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. Furthermore, the Plug-in Bar can be customized using the popup indicator control ( ). Customizing the Plug-in Bar is mostly used for third party or legacy plugins.
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 126 and "About Tasks" on page 336). 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).
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 PReS 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).
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. Select the task or branch where you want to paste the properties 3. From the Home tab in the Ribbon, choose Paste Properties (or right-click and select Paste Properties from the drop-down menu).
Selecting a highlight color The default highlight color may be changed via the PReS Workflow Configuration preferences (see "Colors" on page 794). A custom highlight color can be defined per task: open the task's properties (double-click) and select or define a color under Highlight color on the Miscellaneous tab. To revert the custom highlight color to the default color, open the Miscellaneous tab again, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Replacing Unknown tasks When you move a task or branch using drag-and-drop, it typically moves from its original location to a position immediately preceding the target onto which you dropped it. But if you drop an Input task over an Unknown input task, the moved task will replace the unknown task. The same will happen if you drag an Output task over an Unknown output task. Note It is impossible to drag-and-drop any task over a configured initial Input or Output task.
Redo a command The Redo command can be used to redo commands that were just undone using the Undo command. For example, if you used the Undo command three times in a row and immediately thereafter decided to redo those commands, you could use the Redo command three times in a row to redo those commands. Note that all commands in PReS Workflow Configuration can be redone. To redo a command: l From the Quick Access Toolbar, choose Redo.
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 337. To replace an existing task with another existing task or its properties, see "Cutting, copying and pasting tasks and branches" on page 917. Note You cannot replace a task by a branch or a condition.
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. To collapse or expand a Branch or Condition, in the Process Area: l l l Double-click the right corner of the line of the Branch or Condition.
Zoom in or out within the Process Area You can do a zoom out in the PReS Workflow Process area to see more tasks at the same time. In zoom out mode, you can perform the exact same functions as in normal view mode. To zoom in or out on the PReS Workflow Process Area: 1. Click on the View tab of the Ribbon. 2. Click on Zoom Out in the Navigate group to zoom out, and Zoom In to zoom in.
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.
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 44). The Printer Queues group contains controls to set up printer queues of any type, as well as replace any existing queues (see "PReS Workflow printer queues" on page 112). The View tab includes the Arrange, Navigate and Show/Hide groups.
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 872, allowing to grant/remove permissions to hosts. The Check for updates control, used to update the current PReS Workflow version. The Launch Upgrade Wizard control, used when migrating from a previous PReS Workflow version. The Services Status control allows to start, pause and stop PReS Workflow service.
l 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. The Activation group contains the Software Activation and Printer Activation controls, used to enter activation codes for either the software (all users) or a given device (PlanetPress Suite users) The License group contains a link to the "PlanetPress Capture License Management" on page 810.
To start a stopped service: 1. Right-click on the service. 2. Click on Start. 3. Look in the Log window on the right to see the service starting. To stop a service that is running: 1. Right-click on the running service. 2. Click on Stop. If the service is currently processing a file (if a process is running, output is being generated, job being received, etc), the service will wait for this action to complete before stopping. To pause a service temporarily: 1. Right-click on the running service. 2.
the view in real time. When a service is selected on the left pane, its log file (if any exists for the current day) is displayed. The log displays in a tree fashion. The log itself is the root, and each session (the time between the start and stop of a service) is listed. Under each session, each time a process runs, a new branch is created and it can be expanded to see each action within that process.
When a search is started, using F3 on the keyboard or clicking Search then Search again will find and highlight the next available result.
Knowledge Base You can find extra information in Connect Knowledge Bases which complement the information contained in this manual. The PReS Workflow Knowledge Base can be found here.
Legal Notices and Acknowledgments PReS Workflow, Copyright © 2019, Objectif Lune Incorporated. All rights reserved. The license agreements for the associated open source third party components can be found in the following installation folder: C:\Program Files\Objectif Lune\OL Connect\Legal Notices This application uses the following third party components: l l l l l l l l Adobe PDF Library which is either a registered trademark or trademark of Adobe Systems Incorporated in the United States and\or
l 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. All rights reserved. J2V8 which is distributed under the terms of the Eclipse Public License (EPL) Version 1.0.
l l l l l l l l l 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.mchange/mchange-commons-java Objectweb ASM, Copyright © 2000-2011 INRIA, France Telecom. All rights reserved. Polyfills which is licensed under the Unlicense license. The source code can be obtained from the following location: https://github.com/inexorabletash/polyfill.
l l l l WinSCP which is used by the SFTP input/output plugins and is distributed under both the GNU General Public License (GPL) version 3, and the Mozilla Public License (MPL) Version 2.0. For more information on WinSCP, see https://winscp.net/eng/docs/introduction. 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.
l Apache Commons Text l Apache Commons Validator l Apache Derby l Apache Felix and dependencies l Apache Geronimo l Apache HttpClient Mime l Apache POI l Apache ServiceMix l Apache Xerces2 Java Parser l Apache XML Graphics l Apache XML Beans l Barcode4j l Google Collections l Google GSON l Hibernate Validator l Jackson JSON processor l Jetty l Liquibase l LMAX Disruptor l Objenesis l OpenCSV l OPS4J Pax Web l org.json.
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/).
l l l This product includes software developed by the JDOM Project (http://www.jdom.org/). Portions of this software are copyright © 2010 The FreeType Project (www.freetype.org). All rights reserved. This product includes software developed by JSON.org (http://www.json.org/java/index.html). Copyright Information Copyright © 1994-2021 Objectif Lune Inc. All Rights Reserved.
