User Guide Version 2020.1 Last Revision: 2021-09-29 Objectif Lune, Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 +1 (514) 875-5863 www.objectiflune.com All trademarks displayed are the property of their respective owners. © Objectif Lune, Inc. 1994-2021. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc. Inc. Objectif Lune Inc. Inc.
Table of Contents Table of Contents 4 Welcome to PReS Workflow 2020.
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 Using Scripts Run Script task APIs The Script Editor and XSLT Editor SOAP Server API Reference T
Copy() Cut() DatapageCount() Delete() DocumentCount() FieldByIndex(Integer Index) FieldByName(const String Name) FieldByNameIndex(const String Name, Integer Index) IndexInDocument() IndexInGroup() IndexInJob() Item(Integer Index) PageCount() Paste() PasteAt(Integer Index) Select(TSelectWhat SelectWhat) SelectedDatapageCount() SelectedDocumentCount() SelectedIndexInDocument() SelectedIndexInGroup() SelectedIndexInJob() SelectedPageCount() Sort(const String Name, optional TSortFlags Flags, optional const Stri
Parameters Returns Exceptions Parameters Returns Exceptions AlambicEdit API reference Stopping execution Special workflow types HTTP Server workflow PDF Workflow PlanetPress Capture Workflow Workflow processes in a Connect Send solution About Tasks Adding tasks Editing a task Task properties Masks Selecting a resource file in task properties Input tasks Action tasks Data splitters Process logic tasks Connector tasks PlanetPress Capture Metadata tasks OL Connect Send OL Connect tasks Output tasks Document Ma
Unknown tasks About variables Job Info variables System variables Local variables Global variables Variable task properties Workflow add-ons PlanetPress Capture Capture OnTheGo (COTG) About PReS Fax About PReS Image OL Connect Send ZUGFeRD About related programs and services Available Input services Available Output services Start and stop PReS Workflow Service Users and configurations Workflow Services Preferences Other preferences and settings General appearance preferences Object Inspector appearance pre
PlanetPress Capture ODBC Settings PlanetPress Capture Pen Management Tool PlanetPress Capture License Management OL Connect preferences PDF text extraction tolerance factors General and logging preferences Messenger plugin preferences Preferences HTTP Server Input plugin preferences 1 Preferences HTTP Server Input plugin preferences 2 LPD Input plugin preferences Preferences NodeJS Server Input plugin preferences 1 NodeJS Server Input plugin preferences 2 NodeJS Server Input plugin preferences 3 Testing the
Combine and attach areas Resize the program window areas Change the Interface language PReS Workflow Button Options Configuration Components pane Components Area Sections PlanetPress Design document properties Moving and copying configuration components Renaming objects in the Configuration Components Pane Reordering objects in the Configuration Components pane Grouping Configuration Components Expanding and collapsing categories and groups in the Configuration Components pane Deleting something from the Co
Settings and customization The Process area Cutting, copying and pasting tasks and branches Highlight a task or branch Disabling tasks and branches Moving a task or branch using drag-and-drop Redo a command Removing tasks or branches Replacing tasks, conditions or branches Resize the rows and columns of the Process area Collapse and expand branches and conditions Undo a command Zoom in or out within the Process Area The Quick Access Toolbar Adding buttons Removing buttons Moving the toolbar The PReS Workflo
Welcome to PReS Workflow 2020.1 This PDF documentation covers version 2020.1. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow is the heart of all of our solutions. Working in conjunction with PReS Connect, PReS Capture, CaptureOnTheGO, PReS Imaging, PReS Fax, and a variety of plugins, it helps improve your communications processes.
Tip Information that may help you use PReS Workflow better or that suggests an easier method. Warning Information that is potentially critical to using PReS Workflow.
Installation and setup The installation procedure for Workflow is described in the topic Installing Workflow. The following topics describe the different considerations that are important in regards to the installation and use of PReS Workflow. l "System requirements" below l "Environment considerations" on page 18 l "Setting up the working environment" on page 21 l "Known Issues" on page 25 System requirements These are the recommended system requirements for PReS Workflow 2020.1.
Virtual environments PReS Workflow supports the following virtual environments: l l VMWare Environments. This includes VMWare Player, VMWare Workstation as well as VMWare ESX Server. VMWare VMotion. This means the virtual machine hosting PReS Workflow can be automatically moved from one ESX server to another in a clustered installation. l Microsoft Hyper-V/Azure infrastructure environments.
*1: Requirements will depend upon the amount of data you process through PReS Workflow. For instance, a PostScript file containing several thousands of documents could easily take up several GBs. Recommended hardware requirements Due to its versatility, OL Connect is used for a wide variety of applications. Consequently, it is difficult to determine which hardware configuration will produce the best results for any given implementation.
l l The Connect Designer module requires more RAM and fast disk access to provide a responsive user-experience. The back-end database (MySQL by default) benefits from more RAM, speedy disk access and fast networking as it will be solicited by all modules simultaneously. Environment considerations This page provides technical information about the environment in which PReS Workflow is intended to run.
l Microsoft Hyper-V/Azure infrastructure environments. l Amazon Web Services (AWS) PReS Workflow is not officially supported on any other virtual machines such as Virtual PC, Parallels, Bochs, Xen, etc. While running PReS Workflow on these virtual machines may work fine we have not tested them and cannot offer support for them. Warning The PReS Workflow End-User License Agreement (EULA) specifies that a PReS Workflow software license may only be used on a single virtual or physical PC at a time.
disabling your antivirus or whitelisting the folders or executables listed here, or any other change in your antivirus protection setup! l On Windows 7/2008 and later: l l l l C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\ C:\Users\[user]\AppData\Local\Temp\ (where [user] is the user under which Workflow is configured) C:\Users\[user]\Connect (where [user] is the user under which Workflow is configured) On all systems: l C:\Windows\Temp\ Note C:\Windows\Temp\ is used by multiple software which
l PPImageService.exe l MessengerService.exe Backup software For similar reasons, it is important to know that backup software can also access files while copying them to a remote backup location, so you should make sure that no PReS Workflow process is working during your backups. Microsoft Office compatibility The Microsoft Office 2010 line of products, other than Pro and Enterprise, has not been certified for use with PReS Workflow.
Local and network rights Programs, such as PReS Workflow and all its services, must identify themselves in order to be granted permission to perform operations on the computer on which they run as well as on other computers accessible via a network connection. On a given workstation, you can configure your PReS Workflow to use either the local system account or any specific user account. When you do this, you grant PReS Workflow and all its services the same rights associated with the selected account.
We strongly recommended that instead of using mapped drives, you use full UNC paths for your network drives. PReS Workflow Tools can automatically convert mapped paths to UNC paths. For more information, please see "Network behavior preferences" on page 763. Network ports used by each service The port configuration for each PReS Workflow Input task or Output task is described in the following table. The port number assignments comply with Internet standards.
Component Protocol Local Port Remote Port FTP Output TCP Default1 21 Email Output (SMTP mode) TCP Default1 25 Email Output (Outlook mode) TCP See Email Input (Outlook mode) See Email Input (Outlook mode) Send to Folder Windows Queue Output TCP Default1 Standard Windows file and printer sharing ports2: l l 137, 138 and/or 139 (NetBIOS over TCP/IP (NetBT)) 445 (SMB Over TCP/IP) LPR Output TCP Default or 721 to 7313 515 PReS Database TCP or UDP Unknown4 Unknown4 SNMP Condition UD
4 Contact your DBMS vendor to determine which ports are used by the ODBC driver for accessing a network database. Known Issues NodeJS Server Input task does not run processes with similar action names The NodeJS Server Input task does not process jobs being sent to it if the action name is a superset of another action name declared previously.
Microsoft patch causing handling of XLS to fail Some Windows updates from Microsoft have impacted the handling of XLS sources in PReS\PlanetPress Workflow 8. The Microsoft updates concerned are as follows: l KB4041693 for Windows 8.1 and Windows Server 2012 R2 l KB4041681 for Windows 7 and Windows Server 2008 R2 l KB4041690 for Windows Server 2012 (no service pack) Installing these updates may cause the application to fail when attempting to open or load XLS files via a plugin or in a script.
Data Repository error The Push to Repository task, as well as the corresponding repository API calls SetValue() and SetValueW() may on rare occasions fail with an unexpected error (517), caused by the Write Ahead Logging (WAL) journal mode. The workaround is to disable WAL journal mode: 1. Create the "Repository" key in \HKEY_LOCAL_ MACHINE\SOFTWARE\WOW6432Node\Objectif Lune\PlanetSuite\PlanetWatch\8.0\ if it does not exist. 2.
l l l l l l l l l 20143: The Metadata to PDI task encodes the XML using the default system encoding, not the document's. In addition, it does not discriminate between index names written in different cases (e.g. Name vs. name). Printing PDF files in passthrough mode using a Windows Printer Driver task causes jobs to be processed sequentially rather than in parallel. This is caused by a 3rd party library used in the printing process.
be the case. You can confirm this behavior by opening up the Windows Task Manager and checking whether the MSIExec application is running. In order to complete the installation of MS-Word for the LocalSystem account, follow these steps: 1. Open a command-line window (CMD.exe) 2. Type "AT 10:56 /INTERACTIVE CMD.EXE" (replace 10:56 with the next upcoming minute on your system) 3. At the specified time, a new command-line window opens.
l Barcodes produced in printer-centric mode may have a slightly different aspect from those produced in Optimized PostScript mode. This is due to the different types of 3rd party libraries being used to generate the barcodes. However, all barcodes scan correctly.
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 39). They become visible in the "Configuration Components pane" on page 817.
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 320 initial input task and a "Send to Folder" on page 668 output task by default. You can then edit and save your new configuration. The default input task and output task depend on your preferences ("Default configuration behavior preferences" on page 759).
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 830. 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 70.) 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 527 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 53. 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 50), Metadata file (see "Metadata" on page 74), or "Data Repository" on page 94. 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 838. 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 53). 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 401. 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 facing 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 facing 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 841). 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 Applications or plugins created in PlanetPress Suite 6 and using Metadata will need to be updated for use in version 2020.1. No backward compatibility mode is available. Warning When a user-defined emulation (created in PlanetPress Design) is used with Metadata, results and behavior are unknown and unsupported. For instance, refreshing the Metadata file may cause the document to crash and/or corrupt. For this reason, it is strongly advised to create backup copies of your documents beforehand.
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. Note: Metadata in OL Connect jobs In PlanetPress Suite, all levels in the Metadata hold information about an actual job. In Connect, that isn't the case. The Metadata file created and maintained by OL Connect tasks looks the same, but contains less information.
Metadata Attributes and Fields Each Metadata node (i.e. Job, Group, Document, etc.) is described with a series of elements, that is, system-defined attributes or user-defined fields holding static or dynamic information about the node they are attached to. Each element has a name and a value. Here is a definition of these 2 types of elements: l l Attribute: A read-only, system-defined element which holds certain information about a certain node in the Metadata structure. This information can be static (e.
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 543, "Capture Fields Processor" on page 546, "Get Capture Document" on page 556 and "Find Capture Documents" on page 552 tasks generate their own Metadata. The "Lookup in Microsoft® Excel® Documents" on page 499 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 74 structure. This information can be static (e.g. the size of a physical page) or evaluated on-the-fly (e.g. the number of documents in a group). Attributes are non-repetitive (i.e. name is unique) and do not persist through Metadata recreation.
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 examples" below. a JSON Record Data List (see the REST API Cookbook).
{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 58): { "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 838, 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 838. 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 175. 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 838.
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 776 and on the 'Minimal logs' option in the "Process properties" on page 853.
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.
Note The resubmit option is triggered through the Workflow configuration tool, but the job being resubmitted is actually handled by the Workflow Service, using that service's credentials. The service must therefore be running in order to resubmit jobs. 1. In the 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.
used internally by PReS Workflow and generated by the Input task using parameters defined within the task. The name of the job file can be found in the logs (see "The PReS Workflow Service Console" on page 862). To simplify file identification, you should consider using names that include both the name of the original input file (if any) plus some details such as the current date and time. In addition it may be useful to know the number of each failed page.
l l l The initial Input task is never executed. The sample data file is used instead of the initial run. This is to prevent "live" data from being retrieved by the initial input task while debugging is being done. If, however, the initial task is critical to the process, it can be executed by copying the initial input task and pasting it as a secondary input task (the first Action task to actually run in the process).
Use the Object Inspector - one of the panes alongside the Debug Information pane - on the process to enter sample job information as required. The Debug ribbon provides the following buttons: 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).
l l l Step through the process until you have reached the point after the emulation or data change. Make the necessary data selections (see "Data selections" on page 53). Any data selection used in task properties after this point will use the new emulation. Continue stepping through each task until the end of the process to debug it. 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 The type of job (Connect, or PlanetPress Suite). The features that you want to use. When you associate a single Printer Queue Output task with multiple printer queues, you have the option of using load balancing or not (see "Load balancing" on page 119). The file type. Printer Queues can only handle PostScript and PDF files. 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.
l l l Additional flexibility. Printer Queues have load balancing options that allow to distribute the printing load and 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. (See "PReS Workflow printer queues" on the next page.) Archiving. If the output file is a PDF, the file can be sent to an Archiving solution before it is sent to the printer. Easier debugging.
document the printer should use to merge the data. The document must already be present on the printer’s hard disk or memory, otherwise printing will fail; or a file that contains the data and the document to the selected Printer Queue. Since the data and the document with which it must be merged are both sent to the printer, printing should never fail.
l l l You could send big output files to a production printer and smaller files to the office printer, using a Condition in the print process, for example. These printer queues offer various automatic load balancing options; see "Load balancing" on page 119. Printer-specific commands can be added after the output has been created, to be executed before or after printing. Shared printer queue properties The options on a printer queue’s Advanced properties tab are common to all printer queues.
Frequently used printer control characters Character name: Character code: Typical use in printing context: End-Of-Job \004 Indicates the end of a print job Backspace \b Moves a character space backwards 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 char
not use a data selection. This information may be used for the printer’s banner page. l Job owner name: Enter the job owner name. You may use a PReS Workflow variable. The field is empty by default, which is equivalent to use the default print job owner name, i.e. the current logged in user name. 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.
Properties General tab l l l Printer address: Enter the IP address or host name of the printer receiving LPR jobs. Queue name: Enter the printer queue name. Based on printer and network requirements, this property may not be required. 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 l l l Add: Click to add a new command to the list displayed in the Commands box. You must then edit the new command’s description and value. Note that new commands are shared by all printer queues. Delete: Click to remove a command from the Commands box. Command description: Use this box to edit the description of the command currently selected in the Commands box. Command value: Use this box to edit the code of the command currently selected in the Commands box.
l l l l FTP Port: Enter the FTP port to use. This option is disabled if Use FTP Client default port number is checked. The port should always correspond with the server's port number. Directory: Enter the directory to which the print jobs are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server. File name: Enter the name under which the print jobs will be saved.
Send to Folder printer queue Unlike Send to Folder output tasks, which are typically used to send data files to local or network folders, Send to Folder printer queues are mostly used to send print jobs. The files generated will always be PostScript files. 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.
l l Command description: Use this box to edit the description of the command currently selected in the Commands box. Command value: Use this box to edit the code of the command currently selected in the Commands box. Use the right-click menu for a list of standard printer control characters. (See also: "Frequently used printer control characters" on page 113.
1. In the PPS/PSM Documents group of the Configuration Components pane, select either a single document or a group of documents. 2. Drag the selected documents over a PReS Workflow printer queue. The selected document or the group of documents is associated with the printer queue. Each document keeps its default properties.
Triggers In PReS Workflow, a trigger is typically a two line piece of PostScript code placed just before the data. Triggers tell the printer to turn on PostScript mode and specify which document should be used in the merging process (PlanetPress Design document+data). Triggers are used in two situations: 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).
To create a new Windows printer queue from any PReS Workflow: 1. Start your PReS Workflow Configuration program. 2. Insert a WinQueue Input plugin. 3. In the WinQueue Input plugin properties, click New. 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.
l Checked if the incoming stream has been produced with the Objectif Lune Printer Driver. l Unchecked if the incoming stream comes from some other PostScript Driver. l Grayed out and unchecked if the incoming stream is not PostScript. 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.
l No down-sampling of images These settings are pre-configured and cannot be changed by the user. 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.
l l l l A regular process will run as soon as an input file is available through its input task or, if it is scheduled not to run at that time, will start processing as soon as the schedule permits it. To learn how to create a process see: "Adding a process" on the facing page. Startup processes run only once before every other process in a given configuration (see "Startup processes" below). Subprocesses can be called by any other process (see "Subprocesses" on the facing page).
To learn how to create a startup process see: "Adding a startup process" on the next page. 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.
Note While a configuration is limited to a maximum of 512 processes, any given process can have as many tasks as necessary (see: "About Tasks" on page 300). 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.
Editing a process Designing a process is done by dragging tasks from the Plug-In Bar onto the process in the Process area. Each task then needs to be configured via the Task properties dialog (see "About Tasks" on page 300). For a list of all operations you can perform on tasks in the Process area, please refer to "The Process area" on page 873. Processes can be deleted, duplicated, renamed, disabled, grouped etc. via the Configuration Components pane.
2. Navigate to the PReS Workflow configuration file containing the processes or groups of processes you want to import. 3. Select the file, then click Open. The Import Configuration dialog appears displaying all the processes and/or process groups, as well as the subprocesses, variables, PlanetPress Design documents and printer queues in the selected configuration file. 4. In the list, select the components you want to import.
Activating or deactivating a process All processes are Active by default, but you may make any PReS Workflow process Inactive as required. 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.
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 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 125). This option is not available for self-replicating processes and error processes.
LPD Input task will run trigger-based if they are set to run As soon as possible with a Polling interval of 0. This reduces CPU usage. Note In order to wake up a trigger-based process that starts with the HTTP Server Input task the server issues a signal to all trigger-based processes, not just those that start with an HTTP Server Input task. This means that some processes may get woken up when they do not need to. This issue only occurs in version 2020.1 and will be fixed in version 2020.2.
only on the first week of January. l Select Date to display dates on the grid’s top ruler. l Select any of the other options to display days on the top ruler. l Select All weeks to have the process run every week. l l l l l Select First, Second, Third or Fourth to have the process run on the first, second, third or fourth week. Select Last to have the process run only on the last week. Time division: Select the duration of each daily segment in the time grid.
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.
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.
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 801.
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 156 Structure containing any required information to prepare the file for a valid insertion into a PReS Workflow process. Note With the SOAP API reference, new SOAP plugins have been introduced. The old plugin, which could be used as an Input, Action or Output task, was renamed Legacy SOAP Client and has become obsolete.
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 168 Retrieves the content of a local or global variable by name. Example Usage: var s = Watch.GetVariable ("MyVariable"); "Watch.ExpandString" on page 162 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 173 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 773) 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 773), 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 703.) 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 94) and at design time via the "Data Repository Manager" on page 838.
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 182 Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. "ListGroups" on page 188 Retrieves the list of all group names in the Repository, stored in a JSONStringArray.. "RemoveGroup" on page 190 Deletes the group named GroupName, along with all its keysets and keys. "RenameGroup" on page 193 Renames group oldName to newName.
Name Description "RemoveKey" on page 190 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 193 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 195 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 192 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 176). 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 187 and "SetValueByID" on page 195).
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 empty string, 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 176). 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 176). 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 176). 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 187).
/* 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 206 objects. In turn, MetaDocument objects hold "MetaDatapage" on page 210 objects, which have "MetaPage" on page 213 objects. In addition, a Node contains a collection of "Attributes" on page 232 and can contain any number of "Fields" on page 233. 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 166) when using the "Run Script" on page 481 task. Note that the exact syntax may vary according to the selected script language. When writing a plugin using the plugin SDK the current job's Metadata file name can be obtained by calling the IWatchJob::MetadataFilename method from within IWatchPlugin::Execute.
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 232 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 82.) "Count" on page 217 Integer Returns the number of child nodes. "Fields" on page 233 MetaCollection Returns the node's field collection. "NodeType" on page 218 TNodeType Returns the node type of the current Node. Note that the TNodeType type is not defined in an Active Script environment, such as the Run Script task.
Methods Name Return type Description "Add(Integer Index)" on page 220 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 221 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 221 String Returns the value of the attribute of the specified name. "Clear()" on page 221 Deletes all the child nodes as well as the attributes and fields.
"PageCount()" on page 226 Integer Returns the total number of pages present underneath this node. "Paste()" on page 226 Node Inserts the clipboard's content as the last child of the current node. "PasteAt(Integer Index)" on page 227 Node Inserts the clipboard's content as a child node at the specified index. "Select(TSelectWhat SelectWhat)" on page 227 Selects the child nodes according to the SelectWhat parameter.
MetaGroup Properties Name Type Description "Attributes" on page 232 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 82.) "Count" on page 217 Integer Returns the number of child nodes. "Fields" on page 233 MetaCollection Returns the node's field collection. "Index" on page 218 Integer Gets the index of the node in its parent. "NodeType" on page 218 TNodeType Returns the node type of the current Node.
1: The node is selected but one of its parents is not. 2: The node and all of its parents are selected. Methods Name Return type Description "Add(Integer Index)" on page 220 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 221 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 221 String Returns the value of the attribute of the specified name.
page 224 specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 224 String Returns the value of the N'th field of the specified name. "IndexInJob()" on page 225 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 226 Node Returns the child (node) item located at the specified index.
"SelectedDatapageCount()" on page 228 Integer Returns the number of datapages selected to be output that are underneath this node. "SelectedPageCount()" on page 229 Integer Returns the number of pages selected to be output that are underneath this node. "SelectedIndexInJob()" on page 229 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 219 Node Returns the parent node of the current node. "Selected" on page 219 Bool Indicates whether or not the Node is set to be printed. "SelectedCount" on page 219 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 216.
well as the attributes and fields. "Copy() " on page 222 Places a copy of the node in the metadata clipboard. "Cut()" on page 222 Removes the node and places it in the metadata clipboard. "Delete()" on page 222 Deletes the node. "FieldByIndex(Integer Index)" on page 223 String Returns the specified field's value. "FieldByName(const String Name)" on page 224 String Returns the value of field of the specified name.
node. "Paste()" on page 226 Node Inserts the clipboard's content as the last child of the current node. "PasteAt(Integer Index)" on page 227 Node Inserts the clipboard's content as a child node at the specified index. "Select(TSelectWhat SelectWhat)" on page 227 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 232 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 82.) "Count" on page 217 Integer Returns the number of child nodes. "Fields" on page 233 MetaCollection Returns the node's field collection. "Index" on page 218 Integer Gets the index of the node in its parent. "NodeType" on page 218 TNodeType Returns the node type of the current Node.
1: The node is selected but one of its parents is not. 2: The node and all of its parents are selected. Methods Name Return type Description "Add(Integer Index)" on page 220 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 221 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 221 String Returns the value of the attribute of the specified name.
"IndexInDocument()" on page 225 Integer Returns the index of this page in its parent document, taking all the pages from all the datapages into account. "IndexInGroup()" on page 225 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 225 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 228 Integer Index of the page among all the selected pages in its parent Document. "SelectedIndexInGroup()" on page 229 Integer Index of the page among all the selected pages in its parent Group. "SelectedIndexInJob()" on page 229 Integer Index of the page among all the selected pages in the Job.
values to use. "Parent" on page 219 Node Returns the parent node of the current node. Methods Name Return type Description "AttributeByIndex(Integer Index)" on page 221 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 221 String Returns the value of the attribute of the specified name. "Copy() " on page 222 Places a copy of the node in the metadata clipboard. "Cut()" on page 222 Removes the node and places it in the metadata clipboard.
"IndexInGroup()" on page 225 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 225 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 226 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 232 and "Fields" on page 233. 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 233. Index Not available in MetaJob Gets the index of the node in its parent. Returns: The index (0-based) at which the current node is found in the parent's node list. 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 216). 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.
Exception: l EOleException: The value of Index is invalid. AttributeByIndex(Integer Index) Returns the value of the Metadata attribute at the specified index. Parameters: Index 0-based index of the attribute value to retrieve. The index of the first element is 0 and the index of the last is Count-1. Returns: The value of the attribute as a string. Exception: l EOleException: Index is lower than 0 or higher than Count-1.
Copy() Not available in MetaJob Places a copy of the current node, along with all of its children, attributes and fields, in the metadata clipboard. Modifying the original node after the copy is made does not modify the copy in the clipboard. Cut() Not available in MetaJob Places a copy of the current node, along with all of its children, attributes and fields, in the metadata clipboard and immediately removes the original from the Metadata structure. Warning The node being cut is removed immediately.
Removes the current node, along with all of its children, attributes and fields, from the metadata structure. Warning The node being deleted is removed immediately. Any reference to it or its child nodes becomes invalid. The results of calling methods of such references is undefined. DocumentCount() MetaJob only Returns the number of MetaDocument in all child nodes.
FieldByName(const String Name) Returns the value of the Metadata Field of the specified name. (See: "Fields" on page 233.) If more than one field has the same name, this method returns the value of the first one it finds, starting at the first field in the list. 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.
IndexInDocument() MetaPage and MetaDatapage only Returns the index of this page in its parent document, taking all the pages from all the datapages into account. Returns: Absolute index (integer, 0-based) of the page within all the pages under the parent document. IndexInGroup() MetaDocument, MetaDatapage and MetaPage only Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account.
Item(Integer Index) Group ( Integer Index ) MetaJob only Document ( Integer Index ) MetaGroup only Datapage ( Integer Index ) MetaDocument only Page ( Integer Index ) MetaDatapage only Returns the child node located at the specified index. Parameters: Index 0-based index of the node to retrieve. The index of the first node is 0 and the index of the last is Count-1. Returns: Reference to the specified node. Exception: l EOleException: Index is lower than 0 or higher than Count-1.
Inserts the contents of the metadata clipboard as the last child node of the current node. This removes the node from the clipboard, making it empty after the paste operation. Returns: Reference to the top node being pasted. Exception: l EOleException: The node type of the clipboard and the current node don't match. For example, trying to paste a MetaGroup in a MetaGroup or a MetaPage in a MetaDocument.
Changes the "selected" status of the current node as well as all of its child nodes according to the SelectWhat parameter. Parameters: SelectWhat Indicates what to select. The value swNone changes the Selected property of the current node and all child nodes to false, while swAll changes it to true. Script users: use 0 for swNone, 1 for swAll. SelectedDatapageCount() MetaJob and MetaGroup only Returns the number of datapages under the current node that are set to be part of the output, i.e.
Returns the index of this page in its parent document, taking only the selected pages into account. Returns: Absolute index (0-based) of the page within all the selected pages under the parent document. If the page is not set to be output (i.e. its SelectedState is different than ssTrue), it returns -1. SelectedIndexInGroup() MetaDocument, MetaDatapage and MetaPage only Returns the index of this page in its parent group, taking only the selected pages from all the datapages from all documents into account.
Returns: The number of such nodes, if any. If the current node is not selected or one of its parents is not, it returns 0. Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3) Not available in MetaJob Sorts the sub-nodes contained in the node according to a number of sort criteria.
or a numeric sort is performed and one of the values is not numeric (i.e. consists of only decimal characters, no thousand or decimal separator allowed), the method will fail. If a sub-node contains multiple occurrences of fields with the specified name, only the first occurrence will be considered. String comparisons are done without regards to the case (case-insensitive) using the Windows Win32 API function CompareString(LOCALE_USER_DEFAULT, NORM_IGNORECASE, ...).
Exceptions: l l l EOleException: Specified field or attribute does not exist in one of the sub-nodes. EOleException: A numeric sort is specified and one of the fields or attributes does not contain a valid numeric integer value. EOleException: An error occurred while comparing two strings. Attributes An Attribute is a read-only, system-defined element: a name/value pair, where the name is case-insensitive. It holds certain information about a certain "Node" on page 215 in the Metadata structure.
Methods Name Return type Description "Add(const String Name, const String Value)" on page 235 Adds a new element to the collection or overwrites its value. Clear() Clears all elements from the collection. "CountByName(const String Name)" on page 237 Integer "Delete(Integer Index)" on page 237 Returns the number of elements with the specified name. Deletes the element at the specified index. "Item(Integer Index)" on page 237 String Returns the value of the element stored at the specified index.
Properties Name Type Description Count Integer Returns the number of elements in the collection. Methods Name Return type Description "Add(const String Name, const String Value)" on the facing page Adds a new element to the collection or overwrites its value. "Add2(const String Name, const String Value, TAddFlags Flags, Integer Index (optional))" on the facing page Adds a new element with a customizable behavior if the name already exists.
page 238 "Name(Integer Index)" on page 239 String Returns the name of the element stored at the specified index. Attributes and Fields methods This topic lists the methods of the "Attributes" on page 232 and "Fields" on page 233 collection container objects. Note that the Add2() and the ItemByNameIndex() functions are only available with Fields. Fields support multiple entries with the same name, which is forbidden with Attributes.
Parameters Name Name of the field to add. The name must adhere to this syntax rules: start with a letter, followed by zero or more letters, numbers, underscore or dash. The name is not casesensitive. Value Value of the element. There is no restriction on the content, although binary is discouraged. Flags Additional flags for the method. This determines how the method behaves when the specified name already exists.
l EOleException The index is invalid. l EOleException An index is specified but afReplace is not specified. CountByName(const String Name) Returns the number of attributes or fields (integer) with the specified name. Parameters Name Name of the element to count. Returns Number of occurrences of elements with the specified name. Note that when counting an attribute by name, the only possible values are 1 and 0 because attributes can only occur once.
0-based index of the element to delete. The first element in the collection is at index 0 and the last is at Count-1. Returns The value of the specified element as a string. Exceptions l EOleException Index is lower than 0 or higher than Count-1. ItemByName(const String Name) Returns the value of the element of the specified name. Parameters Name Name of the element to retrieve. Returns The value of the element as a string. If no element is found, an empty string is returned.
Ordinal of the field to retrieve. To retrieve the value of the first field named Name, use 0. For the second field, use 1, and so on. Returns The value of the specified field as a string. If an field named Name is not found, or Index is higher or equal to the number of fields named Name (in other words, you specify 4 to get the fifth but there are only three), an empty string is returned. Exceptions l EOleException Index is lower than 0.
To create a StringSort object, use CreateObject("MetadataLib.StringSort") or the {A07730B74100-457E-91E2-31BFF24E1EC4} CLSID. Although the object is published by the metadata library, it is completely independent of the metadata and can be used in any script, including those run outside of PlanetPress Suite. Methods Name Returns Description "Add(const String Key, Integer Value)" on the facing page Integer Adds a new item in the sort list.
Add(const String Key, Integer Value) Adds a new string key in the list, with an optional associated integer Value. Key String on which the sort will be performed. Value (optional) Integer associated with the string. This value is not used and will not be changed by the sort class. If the string goes to another position in the list after the sort, this value will move as well to the new index of the string. Return value: 0-based index (integer) of the newly added string.
Return value: 0-based index (integer) of the string. If the string is not found, the method returns -1. Key(Integer Index) Returns the key at the specified index. Index 0-based index (integer) of the string to retrieve. Return value: String. Value of the key at the specified index. Exceptions l EOleException Index is lower than 0 or higher than Count-1. Sort() Sorts the items in the list according to their key. The sort performed is a simple alphabetical string sort: 30 comes after 200.
AlambicEdit API reference The AlambicEdit library allows Workflow to access, create or modify PDF files. It does so by wrapping Adobe PDF Library API calls in an object-oriented COM API. The use of COM as the underlying technology allows Workflow's scripting environment to create an instance of that COM object through the Watch.GetPDFEditObject method (see "The Watch Object" on page 156). The object's hierarchy is modeled on the PDF document structure: l l l The PDF object implements the IPDF interface.
Methods Syntax RETURN_VALUE_TYPE methodName( [ARGUMENT_TYPE arg1[, ARGUMENT_TYPE arg2[,...]]] ) Methods with a RETURN_VALUE_TYPE of VOID do not have a return value. In case of failure, methods raise an exception. Examples VOID Open( STRING fileName, BOOLEAN doRepair ) STRING GetXYML() JavaScript implementation: myPDF.Open("C:\\PDFs\\SomeDocument.pdf", false); var myXYML = myPDF.GetXYML(); Note: In JavaScript, all method calls must include parentheses, even for methods that do not require arguments (e.g.
VBScript implementation: currentOrientation = myPDF.Pages(0).Orientation myPDF.Pages(0).Orientation = 180; Structures Syntax STRUCT_NAME { FIELD_TYPE fieldName1[, FIELD_TYPE fieldName2[, ...]] } Examples IPDFRect { LONG left, LONG top, LONG right, LONG bottom } JavaScript implementation: var pdfRect = myPDF.Pages(0).Size(); var pageWidth = pdfRect.right - pdfRect.left; VBScript implementation: set pdfRect = myPDF.Pages(0).Size pageWidth = pdfRect.right - pdfRect.
VBScript implementation: set myPDF = Watch.GetPDFEditObject IPDF methods Name Return type Description "Close()" on page 248 Closes the PDF file. If changes were made but not saved, they are silently lost. All IPage objects must be released before closing a PDF. "Create(filename)" on page 249 Creates a new empty PDF file. "GetInfos()" on page 249 "IPdfInfos" on page 273 "GetVersion(*major, *minor)" on page 250 Retrieves the contents of the Document Information Dictionary from the PDF.
"MergeWith2(pdfFilename, xnum, ynum, xoffset, yoffset, scaleFactor)" on page 251 Overlays each page of pdfFilename (the source) onto pages of the current PDF (the destination) in a grid whose size is specified by xnum and ynum. The pages are laid from left to right and then from top to bottom. "Open(filename, doRepair)" on page 252 Opens an existing PDF, optionally repairing it. "OpenEx(filename, password, doRepair)" on page 253 Opens an existing, password-protected PDF, optionally repairing it.
"setTolerances (tolerableDeltaWidth, tolerableDeltaHeight, tolerableDeltaFontHeight, tolerableGap)" on page 256 Sets the floating point values for the tolerable factors. "SetVersion (major, minor)" on page 256 Sets the version of the underlying PDF file format. This is applied when the file is saved. "SetXMP(xmpPacket)" on page 257 Sets the XMP attachment by replacing the existing one with xmpPacket. IPDF methods reference Close() Closes the PDF file.
If you run the above code without calling the CollectGarbage() method, the Close() method will error out. Create(filename) Creates a new empty PDF file. See also: "Save()" on page 255. Syntax VOID Create (STRING filename) filename Name of the file to create. The file is not physically written to disk until IPDF.Save() is called.
Return value An "IPdfInfos" on page 273 structure containing the PDF properties. Cannot be NULL. GetVersion(*major, *minor) Returns the version of the underlying PDF file format. Note: This method is not available in all scripting environments. Syntax GetVersion(LONG *major, LONG *minor) major Pointer to a LONG that receives the major version number. minor Pointer to a LONG that receives the minor version number. GetXMP() Retrieves the XMP attachment embedded in the PDF.
IsProtected(filename) Returns True if the PDF file is password-protected. When a file is password-protected, the OpenEx() method must be used instead of the Open() method. See also: "OpenEx(filename, password, doRepair)" on page 253. Syntax BOOL IsProtected (STRING filename) filename Name of the file to check for password-protection. Return value True if the file is password-protected, False otherwise.
In PlanetPress Suite, this method is useful for n-Up imposition. For example, (xnum=1, ynum=1, scaleFactor=1.0) means that each source is overlaid on the corresponding destination page, 1 on 1, 2 on 2, 3 on 3, etc. Having (xnum=3, ynum=2) with xoffset, yoffset and scaleFactor set accordingly results in a 3x2 mosaic looking like this: 1 2 3 4 5 6 There is no separator between the source pages on the destination page. A space can be obtained by using an offset bigger than the size of the scaled source page.
VOID Open (STRING filename, BOOL doRepair) filename Name of the file to open. doRepair Boolean. If true, the software automatically attempts to repair the file if it is found to be damaged or corrupt. Otherwise, the operation fails if the file is damaged. OpenEx(filename, password, doRepair) Opens an existing, password-protected PDF, optionally repairing it. See also: "IsProtected (filename)" on page 251. Syntax VOID OpenEx (STRING filename, STRING password, BOOL doRepair) filename Name of the file to open.
Print(printername) Prints a range of PDF pages to the specified Windows printer with default options. See also: "PrintEx(printername, *PdfPrintParams)" below. Syntax VOID Print ( STRING printerName, LONG fromPage, LONG toPage ) printerName (optional) Name of the printer to print to. The default options of the printer will be used. If NULL, the default printer is used. fromPage 0-based index of the first page to print. toPage 0-based index of the last page to print.
Pointer to an "IPdfPrintParams" on page 274 structure that specifies various print options. If NULL , default values are used. Save() Saves changes to the PDF file. The version of the PDF file format is the highest possible for a newly created file and is unchanged when saving an existing file, unless the SetVersion method was called in which case the file format used will be the one set by SetVersion. See also: "SetVersion (major, minor)" on the next page.
setTolerances(tolerableDeltaWidth, tolerableDeltaHeight, tolerableDeltaFontHeight, tolerableGap) Sets the floating point values for the tolerable factors. Syntax VOID setTolerances ( FLOAT tolerableDeltaWidth, FLOAT tolerableDeltaHeight, FLOAT tolerableDeltaFontHeight, FLOAT tolerableGap ) tolerableDeltaWidth Tolerable delta width factor value. tolerableDeltaHeight Tolerable delta height factor value. tolerableDeltaFontHeight Tolerable delta font height factor value.
SetXMP(xmpPacket) Sets the XMP attachment by replacing the existing one with xmpPacket. Syntax VOID SetXMP ( STRING xmpPacket ) xmpPacket New XMP attachment to use instead of the existing one. Pages collection object The Pages collection object implements the IPages interface. This interface defines methods to add, import, move or delete pages as well to access individual Page items. It is accessed via the "PDF object" on page 245.
srcIndex, srcCount, destIndex)" on page 260 "InsertFrom2 (srcPages, srcIndex, srcCount, destIndex)" on page 260 "Item(index)" on page 261 Inserts pages from another IPages object into this one. All relevant resources are copied with the pages. IPage (see "Page object" on page 262) "Move(index, count, offset)" on page 261 Returns a Page object from the PDF. Note that sinceItem() is the collection's default method, it can be omitted altogether (e.g. IPages(0) is the same as IPages.Item(0)).
0-based index of the page to delete. ExtractTo(destFilename, srcIndex, srcCount, optimize) Extracts pages from the PDF and creates a new file with these pages. All relevant resources are copied with the pages. If the target file already exists, it is overwritten. Syntax VOID ExtractTo ( STRING destFilename, LONG srcIndex, LONG srcCount, BOOL optimize ) destFilename Name of the PDF to create with the specified pages. srcIndex 0-based index of the first page to copy.
0-based index at which to insert the page. The page is inserted *before* the page at index "index ". To insert a page at the end, use IPages.Count(). mediaSize "IPdfRect" on page 275 structure containing the rectangular dimensions of the new page, in points. Cannot be NULL. InsertFrom(srcFilename, srcIndex, srcCount, destIndex) Inserts pages from another PDF file into this one. All relevant resources are copied with the pages. See also: "Count()" on page 258.
VOID InsertFrom2 ( IPages srcPages, LONG srcIndex, LONG srcCount, LONG destIndex ) srcPages IPages collection from which the pages are retrieved. srcIndex 0-based index of the first page to copy. srcCount Number of contiguous pages starting from srcIndex to insert. If srcCount is -1, all pages from srcIndex up to the end are inserted. destIndex 0-based index of the position where to insert the pages. They will be inserted before the page at index destIndex. To insert the pages at the end, use IPages.
VOID Move ( LONG index, LONG count, LONG offset ) index 0-based index of the first page of the range. count Number of contiguous pages to move. offset Number of hops to move the pages. If negative, the pages are moved towards the beginning of the file. If positive, towards the end. Page object The Page object implements the IPage interface. This interface defines methods to retrieve information from a page or modify it.
separated by a CR-LF pair. "ExtractText2(left, top, right, bottom)" on page 267 String Returns the text located inside the region bounded by the left, top, right and bottom parameters. If multiple lines are found, they are separated by a CR-LF pair. "MediaSize()" on page 268 "IPdfRect" on page 275 Returns the size of the actual media, i.e. the sheet of paper. "setIncludeBorders (pbIncludeBorders)" on page 268 Sets whether or not borders are included for IPage.ExtractText2().
left, top, rotateAngle, scaleFactor, layerName)" on page 272 "Size()" on page 273 () but allows to put the source page as a layer (aka an Optional Content Group). "IPdfRect" on page 275 Returns the size of the rectangle that is used to clip (crop) the content of the page before applying it to the medium, in points. IPage methods reference Draw(context, scale, offsetX, offsetY) Draws the page onto the device context.
Vertical offset from the top edge of the DC surface, in *device* units, at which to start the drawing. The drawing is done in PDF user space units (72th of an inch). In order to have a smooth drawing of the page, the device context must have its mapping mode set to MM_TEXT with a 1:1 mapping between logical space (SetWindowExtEx) and device space (SetViewportExtEx).
Warning This method is subject to many limitations (see below) and exists for backwardcompatibility and debugging purposes only. For production purposes, use ExtractText2() instead. Syntax VOID ExtractText ( FLOAT left, FLOAT bottom, FLOAT right, FLOAT top ) left Distance in inches of the left limit of the region from the left edge of the /CropBox. bottom Distance in inches of the bottom limit of the region from the bottom edge of the /CropBox.
l l Horizontal moveto is not considered as a space. /CropBox size is not taken into account (an object whose left is at 144 is considered to be 2 inches from the edge even if the /CropBox starts at 72). l Only horizontal text is supported; vertical or rotated text is undefined. l Rotated pages are unsupported. l /UserUnit is not supported. ExtractText2(left, top, right, bottom) Returns the text located inside the region bounded by the left, top, right and bottom parameters.
MediaSize() Returns the size of the physical medium on which the page is intended to be placed, in points. This corresponds to the /MediaBox entry of the /Page object in the PDF. See also: "Size()" on page 273. Syntax IPdfRect MediaSize ( ) Return value An "IPdfRect" on page 275 structure containing the dimensions, in points, of the media size. Cannot be NULL. setIncludeBorders(pbIncludeBorders) Sets whether or not borders are included for IPage.ExtractText2().
Tolerable delta width factor value. tolerableDeltaHeight Tolerable delta height factor value. tolerableDeltaFontHeight Tolerable delta font height factor value. tolerableGap Tolerable gap between words factor value. Merge(imageFile, left, top, rotateAngle, scaleFactor) Inserts an image file and places it on the page at a specific location. Supported image types are: JPG and PNG. It calls MergeToLayer internally.
scaleFactor Scale at which to display the image. For bitmaps, this is based on a 72 dpi resolution. Use 1.0 for the nominal size. Merge2(srcPage, left, top, rotateAngle, scaleFactor) Transparently places a PDF page on top of the current page at a specific location. The source page can be either from the same PDF or another opened file. If the source is from the same PDF file, the source page is not modified. This allows to have the same behavior as IPDF.
MergeToLayer(imageFile, left, top, rotateAngle, scaleFactor, layerName) This method behaves the same as Merge() but allows to insert the image as a layer (aka an Optional Content Group). Supported image types are JPG and PNG. If the input file is a PNG with an alpha channel, the PNG is alpha blended with the page underneath. Monochrome PNG files are drawn transparently, with the white used as the transparent color.
Name of an Optional Content Group in which to put the layer containing the image. The string cannot be empty but can be NULL if no layer is required. MergeToLayer2(srcPage, left, top, rotateAngle, scaleFactor, layerName) This method behaves the same as Merge2() but allows to put the source page as a layer (aka an Optional Content Group). Syntax VOID MergeToLayer2 ( IPage srcPage, FLOAT left, FLOAT top, FLOAT rotateAngle, FLOAT scaleFactor, BSTRlayerName ) srcPage IPage object to overlay on the current page.
Name of an Optional Content Group in which to put the layer created from the source page. The string cannot be empty but can be NULL if no layer is required. layerName Name of an Optional Content Group in which to put the layer created from the source page. The string cannot be empty but can be NULL if no layer is required. Size() Returns the size of the rectangle that is used to clip (crop) the content of the page before applying it to the medium, in points.
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 98).
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 746) needs one Workflow process to handle the job transfer, and in licensed mode it needs at least one other process to interact with the user. Reports about the use of OL Connect Send might be produced in yet another Workflow process. For examples of these processes see "Workflow processes in a Connect Send solution" on page 298.
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 312 or "Load External File" on page 421, then use the "Delete" on page 645 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 478. 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 615 task. l If, however, the file is found, then it is loaded with the "Load External File" on page 421 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 77. Note In Connect it is also possible to group, sort and split PDF data using "OL Connect tasks" on page 591. Example: Daily sales report from PDF files This workflow makes heavy use of PDF tasks and Metadata, and assumes that you are using PReS Workflow version 7.3 or higher.
l l l l l l The "Metadata Filter" on page 567 follows by removing any invoice that is not in the US. Note that the Metadata filter is an *inclusive* filter, meaning that the filter includes the parts of the Metadata where the result of the filter is true, and filters out anything else. The "Metadata Sorter" on page 572 then re-orders the Metadata documents by Rep ID, so that all of the invoices for any particular sales representative are all together.
l "Security Considerations" on page 722 l "20,000 Patterns" on page 723 l "PlanetPress Capture Implementation Restrictions" on page 731 There are also 2 external tools that are used to communicate the pen's data to PReS Workflow: l "Anoto penDirector" on page 729 l "PlanetPress Mobile Application" on page 731 Creating a Capture-Ready document This is done when creating your PlanetPress Design document.
l l l l The "Capture Fields Processor" on page 546, which converts each PGC in an EPS layer, adds this layer to the PDF in the database, releases patterns and closes documents. Optionally, a "Capture Condition" on page 538 task to do post-processing using the Capture Fields data. A "Get Capture Document" on page 556 action task to retrieve each document in the database and output a PDF file Any existing output such as Output to Folder, email, ftp, etc.
l A "PGC to PDF Converter" on page 558 task converts the PGC to a PDF l Any existing output is used here, for example an email notification. The Examples l "Basic Functional Capture Workflow" below l "Capture Post Processing Workflow" on the facing page l "Capture Web Manager Workflow" on page 297 Basic Functional Capture Workflow This workflow is the most basic and simple workflow that you can use with PlanetPress Capture.
l "Capture Fields Generator" on page 543 l Print output PGC Handling Process The second process is the PGC Handling process. It receives data from the Anoto Digital pen, updates the Capture database and releases patterns as appropriate.
After PGC Handling Here is an example of a process that receives ink data, updates the database, and then verifies whether or not a field that indicates manager attention is required (for example, a box noting the wrong number of items in a delivery slip). If attention is required, the document is sent via email to the manager. Otherwise, the document is simply archived.
l Capture Condition is where we can check whether a specific field (a "RequireManager" field) has ink contained in it, and if it does, the branch on the right is triggered. l l In the branch, Get Capture Document retrieves a PDF version of the document and sends it as an attachment to an email sent directly to a manager using Send Email. Otherwise, Get Capture Document is used again, but this time the PDF is stored in a SharePoint Server using the Output to SharePoint connector.
Task Breakdown l The Find Capture Documents task queries the Capture database for documents that correspond to certain specific conditions. For example, here we would look for all documents that are either in an "Error" or a "Partial" state, which means they received ink but are not completed correctly.
to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met". l With this list of documents in the metadata, we Branch off. This is done because we need to build a report that will be sent to an administrator, and only one email should be sent. l l To build the report, inside of the branch we use the Metadata Sequencer to create one sequence for each document, by splitting at the Document level, by 1 occurrence of the level for each sequence.
5. Click the PReS Workflow button (File menu) and go in Preferences. 6. In the HTTP Server Input 2 section, check the Serve HTTP resources option, change the Resource action name box to static , and the Resource folder to c:\PReS\http . Then, click OK. 7. Send the configuration to your local PReS Workflow server. 8. Start PReS Workflow services (see "Start and stop PReS Workflow Service" on page 750). 9. Open your browser and point it to http://127.0.0.
the user. Reports about the use of OL Connect Send might be produced in yet another Workflow process. Each OL Connect Send solution will require the Workflow processes to be configured differently, but certain plugins will always be part of the solution. Job transfer process The Workflow process that handles the job transfer starts with an HTTP Input task.
Sample project The Ad Hoc Mail Consolidation sample project may help you understand the Workflow processes for OL Connect Send and configure your own. l l Watch the sample in action on demo.objectiflune.com. Under Ad Hoc Mail Consolidation, click Demo and follow the instructions. (If you have already installed the printer driver, you don't have to do that again.) Add a Connect Send printer with the given settings and print the provided Word file to that printer.
l "Input tasks" on page 309 l "Action tasks" on page 379 l "Data splitters" on page 451 l "Process logic tasks" on page 471 l "Connector tasks" on page 490 l "PlanetPress Capture" on page 716 l "Metadata tasks" on page 560 l "OL Connect tasks" on page 591 l "OL Connect Send" on page 746 l "Document Management tasks" on page 669 l "Output tasks" on page 644 l "Unknown tasks" on page 702 Note Completely empty files (0 bytes) cannot be processed by Workflow.
3. Using your mouse, click and drag the task in your process at the place you want to insert it. 4. Depending on where you place your mouse, you may see that you can replace or insert existing tasks, or not place it at that location at all. 5. When you drop the task in the desired location, a dialog box containing the available task properties is displayed. 6. Set the task properties as required and click OK to close the dialog box.
Task properties Any task you add to your PReS Workflow process must be configured using its Properties dialog. It appears as soon as you add a task to a process, or when you double-click on a task. Each task's Properties dialog will give you the options to configure that specific, individual task. Properties of one task do not directly affect the properties of another task, however there are some software preferences that may affect tasks in one way or another (see "Preferences" on page 755).
Variable properties may include: l Static data. l System variables. See "System variables" on page 705. l Local and Global Variables. See "Local variables" on page 709. l Job Infos. See "Job Info variables" on page 703. l Data and Metadata Selections. See "Data selections" on page 53. l Printer Control Characters. See "Shared printer queue properties" on page 112. These are normally only used in printer outputs.
l l l l l l l l Global Variables: Contains a list of global variables in this configuration. If no global variables exist, this item is disabled. Control Characters: Contains a list of control characters that can be used in printers. Get Data Value: Brings up the Data Selector, retrieves the value you select and places it in the variable properties box. This information becomes static and does not change between each datapage and job file.
Masks Certain tasks, such as the Folder Capture Input task and the File Name Condition task, allow for entering a mask instead of a file name. See "Masks" below. Date and Time Format To simplify things and to prevent errors, date and time formats have been standardized. l l Dates are entered and displayed as yyyy/MM/dd (2007/06/13, for example). Times are entered and displayed using the 24 hour format as HH:mm:ss (3:38:54 PM, for example, is entered and displayed as 15:38:54).
l l Literal characters: Any alphanumerical character is considered a literal character and must appear. For example, a mask of "trigger.txt" will not capture any other files than that name. Wildcards: Two wildcards are available in masks. l l l Asterisk (*): Supports any number of characters. *.txt would pick up any text file, file*.txt would pick up any file starting with file and any characters: file1.txt, filetest.txt. Question Mark (?): Supports a single character. file?.txt would pick up File1.
In most cases, you have three options: l l l You can choose a specific file from the list of installed documents (see "Workflow Configuration resource files" on page 39); these will be either Connect resources, or PlanetPress Design documents, depending on the task. You can choose a variable file (see below). You can choose not to use any document (only in certain cases).
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 853.
The SFTP Input task also appears in the Input category when it is installed. (It isn't installed by default.) Create File Create File input tasks are different from other input tasks in that they do not pull in data from a source location. The data that this task passes along to other task is its own: text or values from variables entered when the task was created or last edited.
Task properties General Tab l l l Create File: Enter the text to use as the data. The Create File box is a Variables Properties box, so you can use any of the variables, control characters or data selections as noted in "Variable task properties" on page 713. Add CRLF after last line: Check if you want the plugin to automatically add a new line at the end of the file. Remove the checkmark to leave the file as-is, useful in the creation of CSV files for example.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Email Input The Email Input task retrieves email data through a Microsoft Outlook or POP3 connection. Note If Microsoft Outlook connection is used, Microsoft Outlook 2000 or higher must be installed on the computer where PReS Workflow is located.
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 853. 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. File Count File Count tasks check if a target folder contains a specified number of files. They can be used as Condition task or as Input task. When used as Input task, the task triggers the process to run only when the condition is true. As long as the condition is false, it does nothing (except log any errors).
l %3 - FileCount: The specified file count. Task properties General Tab l l Target folder: Enter the full path of the folder from which the input files are to be taken, or use the Browse button to select it. Note that subfolders are not processed. This is a variable property field. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303. Masks: Enter a single or multiple file names or use file name masks (see "Masks" on page 306).
"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.
Note As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the "Network considerations" on page 21 page. Warning If you create a Folder Capture input task that takes any file it finds in the root folder of one of your hard disks, then PReS Workflow will try to remove all the files located in that folder, including all the system and hidden files.
The checkbox is not ticked by default. Please refer to Regular Expressions for more information. Note No Variable Data can be used inside this field if the Treat as regular expressions option is ticked. The percent sign, the curly brackets and the period are all key elements of the RegEx syntax, therefore they cannot be mixed and matched with Workflow variable data syntax (e.g. %1, ${global.myvar}, etc.). Also, there is no validation of the RegEx being specified.
"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.
Input Folder Listing captures nothing, however it does read the input folders (and, if selected, subfolders) and gathers information about each file in that folder. Processing Folder Listing loops through the files and, for each file, generates an XML node with information about the file. Output The output is an XML file containing information about each file. If the Sub-directories option was checked, the structure of the XML also contains the folder structure as it is present on the drive.
Note The
Job Information definitions l %1- Folder: Contains the full path of the base folder from which the files are listed. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. FTP Input FTP Input tasks retrieve files from FTP sites using the FTP protocol. Masks are typically used to select multiple files to be retrieved from the server.
l l l Password: If account named in the User name box is password protected, enter the password here. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another PReS Workflow task. Directory (optional): Enter the path of the folder to poll on the FTP server.
Job Information definitions l l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically. %2 - FTP Server: Contains the FTP address of the server from which the files were retrieved. %3 - Source file name: Contains the name of the current file that was retrieved from the server. %4 - Folder: Contains the FTP folder from which the current file was retrieved.
Task properties General Tab l URL: Enter the URL of the HTTP server from which the file must be downloaded. Since this is a variable property box, variables may be used, as well as the Get Data and Select Data commands (see "Variable task properties" on page 303). Note that when PReS Workflow connects to a secure page, an SSL (Secure Socket Layer) connection is automatically used. Note The connection to remote HTTPS is done through TLS v1 encryption. Prior to version 2019.2, this was done through SSL v.
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 853. 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.
Note Athough Workflow can serve both static and dynamic resources to a web browser, it is not meant to be used as a fully featured web server as it is not built for responsiveness nor guaranteed uptime. It is recommended to use a common web server (for example, IIS or Apache) to serve your contents and to let Workflow process things only it can do. For more information on how to serve HTML and PDF generated by Connect through IIS, watch the Connect with Evie - IIS series.
The request can contain one or more files, one being an XML file containing the request information as well as any GET or POST variables that were received within this request. Other files are POST attachments. Note By default, the request XML also contains a CDATA section which contains the raw input data, effectively doubling the size of the incoming file. Due to technical restrictions, the incoming XML file cannot be more than 400MB, which because of CDATA is reduced to around 200MB.
Note You can serve static resources through PReS, which is especially useful for images, CSS and JavaScript files. See "HTTP Server Input plugin preferences 2" on page 783. Task properties General Tab l l l HTTP action: Enter the name of the action requested of PReS Workflow by the client. This name corresponds to the URL that the client will be accessing. For example, if you enter "MakePDF" here, you could trigger the process by accessing http://127.0.0.1:8080/MakePDF .
occurring. When checking this option, the field under the option is used to select which file to return. l Use custom HTTP server response code: When the process ends and a response is sent to the requesting client, a custom response code can be specified depending on how the process goes. While in previous versions the "200 OK" code was always used, this option overrides it to, for example, "404 Not Found" or "401 Unauthorized".
"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 853. 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.
Input This task receives a data file from a task that generated an error. Accompanying this data file is the current Job Infos of the process that triggered the error. This means that this input does not generate its own job infos! No Metadata is received by this task, and none is generated. The following error information is generated by the Input Error Bin starting version 7.5, and is accessible throughout the process: l l %{error.process}: the process name where the error occurred. %{error.
"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.
Note SOAP communication is non-trivial and requires a certain understanding of XML and the SOAP protocol. Using the SOAP tasks pre-supposes this knowledge and this documentation does not attempt to provide it. The Input SOAP Task only responds to a single SOAP action by the client: SubmitJob. Within this request however, a secondary action (SubmitSOAPActionName) can be specified - this is what the SOAP Action corresponds to in this task properties. Input This task does not poll any location by itself.
"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.
To prevent conflicts between competing LPD servers, you must not run any other LPD server than the PReS Workflow LPD server on PReS Workflow workstation. LPD Input tasks are configured primarily through user options (see "LPD Input plugin preferences" on page 784). The only LDP information you enter in each LPD task is the queue name. Input This task does not poll an input, it sits there and waits for a job file to be sent through the LPR port.
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 853. 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.
The Merge PDF Files Input task performs just like any other Input task: once the process has completed, control is transferred back to the Input task one last time to check if new files meeting the mask have come in. This means that the merging of PDF files that are not all present at the start of the process may take several passes, which may have an adverse effect on the overall performance and the size of the resulting PDF.
l l l l Capture files in sub-directories also: Select to capture files from child folders of the source folder as well. When this option is selected, the chosen Sort order is applied to each separate folder, not across folders. The subfolders themselves are always processed in alphabetical order, regardless of the sort order. Sort directories first: If you selected a sorting method in the Sort files by box, and if you want the folders present in the source folder to be sorted first, select this option.
l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l %1 - PDF Directory: Contains the folder from which the data was captured. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
properties" on page 853) and it will capture the emails as long as there is unread email in the selected inbox. Processing The task accesses Inbox folders in the organization through the Microsoft Graph API (subject to that organization's IT policies) . Filtering is done at the mail server. Only the first unread email matching the conditions is retrieved from the mail server, along with its attachments. Captured emails can either be deleted or marked as read.
Example output file Anny One onea@ca.objectiflune.com Your Subscription 2020-01-22T14:03:38Z someone@ca.yourcompany.com Body C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0106HBKO3IODK3F\ 0106HBKO3IODK40.html Attachment C:\ProgramData\Objectif Lune\
If multiple attachments have the same name, they will be appended with a numeric suffix, for example: File.pdf, File (1).pdf, File (2).pdf. Job Information definitions l l l l l l %1 - Date received. Contains the date of the reception of the email (and not the date of retrieval by PReS Workflow). The format is YYYY/MM/DD HH:MM:SS. %2 - Sender's name: Contains the name of the sender as defined by the sender himself (or, if the sender is using Exchange, by the name defined in his Exchange server).
Connection l l l l Application ID: Enter the application ID provided by Azure for this specific application. This value is static and cannot contain variables. Application Password: Enter the client secret (key) for the Azure app. This value is static and cannot contain variables. Tenant ID: Enter the Tenant ID as specified in Azure. This value is static and cannot contain variables. User ID: This is the user's ID or email address. This value is dynamic.
l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
files in the queue. Once all the files are gone, the task polls the input folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. Output The output to this task is a series of individual files, one after the other. These files are not modified in any way from when they are captured from the source folder. Job Information definitions l l l %1 - User. This is the OneDrive user's ID. %2 - Source File Name.
Note No Variable Data can be used inside this field if the Treat as regular expressions option is ticked. The percent sign, the curly brackets and the period are all key elements of the RegEx syntax, therefore they cannot be mixed and matched with Workflow variable data syntax (e.g. %1, ${global.myvar}, etc.). Also, there is no validation of the RegEx being specified. Connection l l l l Application ID: Enter the application ID provided by Azure for this specific application.
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 853. 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.
not started by Workflow; it can still be started manually, but will only serve static resources and redirect requests to other servers. Before using this plugin Configure the NodeJS Server using its three settings dialogs in the Preferences (Workflow button > Preferences): "NodeJS Server Input plugin preferences 1" on page 786, "NodeJS Server Input plugin preferences 2" on page 787 and "NodeJS Server Input plugin preferences 3" on page 788.
Note The NodeJS Server Input plugin is not compatible with PlanetPress Capture. Input The NodeJS Server Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received. Actually, it is the NodeJS service that receives the requests and places them in a specific location on the drive. When a request is received, the NodeJS Server Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received first.
either directly in the XML or directly as a data file through the "Loop each attachment as data file" option. How arrays in input data are interpreted When the names of Form inputs in an incoming POST request contain two pairs of square brackets: [..][..], the data are interpreted as an array. The value between the first pair of square brackets is expected to consist of two parts, separated by an underscore (e.g. row_0). The first part is considered to be the element's name.
Task properties General Tab l HTTP action: Enter the name of the action requested of PReS Workflow by the client. This name corresponds to the URL that the client will be accessing. For example, if you enter "MakePDF" here, you could trigger the process by accessing http://127.0.0.1:9090/MakePDF. This is also what your HTML Form's action should be. Note The following characters are not allowed in an action name: $ * ? #, spaces, and any characters that are not permitted in Windows folder names, such as \
Warning Don't use any non-ASCII characters in Workflow's working directories path (in the V8WorkingDirectory registry key). Combined with the UTF-8 Form Data Encoding setting, this might make it impossible for Workflow to retrieve files from that path, depending on the actual path name and the system locale. l Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the NodeJS Server Input task loop through each attachment.
Wikipedia.) If the response isn't currently handled by any HTTP response code, you may use an unused code in that range. Note The response code must start with 3 digits, followed by a space and then the error message. If the first few characters can't be converted to a valid number, the server automatically returns "500 Internal Server Error", regardless of the actual response code provided by the process.
l Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l %1 - Client IP Address: Contains the IP address of the HTTP client requesting a response. %2 - Request Header: Contains the headers of the request, which can contain information such as the Browser and Operating System, languages, etc.
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. Output The task outputs the job file as is, with no evaluation or modification. The format of the job is PostScript generated by PrintShop Mail Web.
"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.
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. It will process one email at a time (unless the process is self-replicating; see "Process properties" on page 853) and it will capture the emails as long as there is unread email in the selected inbox.
Example output file Peter Parker parkerp@ca.objectiflune.com Bill of Lading 2018-03-29 15:52:54 starkt@ca.objectiflune.com Body C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0103W5GQXZR2F0A\ Body.html Attachment C:\P
If multiple attachments have the same name, they will be appended with a numeric suffix, for example: File.pdf, File (1).pdf, File (2).pdf. Task properties General Tab Enter the condition(s) that must be met for an email to be captured. l l First found (no conditions): If this option is selected, the first email that is found will be processed (for each iteration of the plugin). In any other case, all conditions must be met for the email to get processed.
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. Please refer to GMail documentation to learn how to do that (https://support.google.com/accounts/answer/6010255?hl=en). l Options: l l l Enter the name of the inbox to monitor. This is useful if the email account has defined rules to automatically store certain incoming messages in a specific mail box.
The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 853. l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
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.
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 652 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.
l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH). l FTPS: Select if the FTP server uses FTPS (SSL/TSL) Port Number Group l l l Use default port: Check to use the default port used by the protocol selected above. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another PReS Workflow task.
Security Tab This tab defines the certificates used to connect to the secured FTP servers. l l l l Accept all certificates: Check this option to automatically accept the certificates returned by the FTP server. Otherwise, in order for a connection to work, you have to establish a connection first and then accept a certificate from the List of known servers up to the Approved server list.
l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically.
Example In this example, the SMTP Input plugin is used to capture incoming emails data that must meet certain conditions as the subject that contains "Work to do" and the sender that contains "client@company.com ". The process then redirects the content of those emails to an extraction and finally to a PDF printing. Input The SMTP Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received.
and /ppemail[1]/body[1]/@html respectively. With %t%O\xmlget('/ppemail[1]/body [1]/@html',Value,KeepCase,NoTrim) and %t%O\xmlget('/ppemail[1]/@rawemail',Value,KeepCase,NoTrim) we get both the body and the whole raw email. l Attachments: The input task loops through each attachment and sends them down through the process. While the Envelope is not available, the Job Infos contain pretty much all of the information you would get from it.
l “To” contains: Select to limit those messages used by this task to those that are sent to a specific address. The address you enter in the box below can include variables and wildcards. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
return). l %9 - Body: Contains the body text of the message. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Telnet Input The Telnet Input task (also known as the Raw Socket Printing Input) receives files sent to a specific port. If you want PReS Workflow to receive data using multiple ports, you must use multiple Telnet input tasks.
l Description: PReS Workflow displays the name of the service or process assigned to the port number entered in the Port box. Note that these are standard Internet Assigned Numbers Authority (IANA) descriptions. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
Note Before configuring this task, on the computer running PReS Workflow you will need to create a local printer queue that will be used to receive data files in the form of print jobs. This queue can be shared, so as to be able to receive jobs sent from local as well as remote users. To ensure that the spooled files created by PReS Workflow remain in the spool folder, the printer queue must be paused. Input The WinQueue input regularly polls the selected printer queue for new jobs.
l Printer properties group l l Spool Print Job ins EMF Format (Advanced printing features): Select to create EMF files for Windows Print Converter action tasks (see "Windows Print Converter" on page 447). Note that this option must not be selected when capturing generic text type data. Spool Print Jobs in RAW Format: Select to output in RAW format, which is the exact data that the computer receives (and is not converted in any way). l Create PDF (With Metadata): Select to output a PDF.
Job Information definitions l l l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user un which a software sending the job was logged in under. %2 - Host computer: Contains the name of the computer from which the job was sent. %3 - Printer name: Contains the name of the printer in which the job was received. Is the same for all jobs received on any given printer.
l "Database Query" on page 401 l "Decompress File(s)" on page 406 l "Digital Action" on page 407 l "Download to Printer" on page 417 l "External Program" on page 419 l "Load External File" on page 421 l "Mathematical Operations" on page 422 l "Open XSLT" on page 424 l "PDF/A-3 Attachments" on page 426 l "PDF to Bitmap" on page 429 l "Push to Repository" on page 430 l "Rename" on page 432 l "Run Script" on page 481 l "Search and Replace" on page 436 l "Send Images to Printer" on
Processing This task takes the PostScript version of the document (.ps7), adds the trigger and then the active data file to it. If Metadata is present, the output is based on this Metadata (unselected data pages will not generate output, the sort order will be respected, etc). Otherwise the complete data file is merged. Output The output is a PostScript job that can be sent to any output task in "passthrough" mode, for example Create PDF, PReS Image, etc. Metadata is not generated by this task.
Input Any text-based file can be used in this task, even formats that are not directly compatible with PReS. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task. Processing The selected operation (adding or removing lines, text or pages) is made on the data file. Output The modified data file is output from this task. Metadata is not modified in any way if it is present.
l l l Characters: Enter the string of characters to be added to the job file. This box is only displayed when the Characters option is selected in the Content box. Lines: Enter the lines of text to be added to the job file. This box is only displayed when the Lines option is selected in the Content box. Remove: Enter the number of characters or lines to be removed from the job file.
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.
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). 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.
l l l l l l l l l BarcodeCount:: Metadata field representing the number of barcodes on the page. Barcode_1_Value: Metadata field representing the value of the first barcode on the page. Note that this field (Barcode_1_Value) contains the same value as the first occurrence of BarcodeValue. BarcodeBase64_1_Value: Metadata field containing the value of the first barcode, encoded in Base64. Barcode_1_Type: Metadata field containing the type of the first barcode (ex. EAN13, UPCA …).
l When using a secondary input, a known issue of the Workflow Tool can cause some unexpected behavior, like having the same Metadata file reused instead of a new one being created for each data file captured. To work around this issue, simply add a Rename action task to set a unique file name (Ex. %u) to each new file before the Barcode Scan task, after each secondary input.
General Tab Add/remove characters: Enter the number of characters to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add characters; negative values remove characters. This is useful when one or more characters of input data precede the start of the first data page. Note that certain control characters can be problematic.
Emulation. The available emulations are: l Line printer. (Nothing to configure.) l ASCII. l l l l Tab on CR: Select to have the document insert a tab after each carriage return character it encounters. Set the number of spaces in the tab using the Number of spaces in the tab box. This option is available only if you selected the Read in binary mode option. If you cleared Read in binary mode, the printer replaces any end of line characters (CR, LF, or CRLF) it encounters with a LF.
l Channel skip. l l l l Skip page: Enter the channel skip code that, in your data, signals the start of a new data page. In standard channel skip emulation, a 1 (one) signals the start of a new data page. If a 1 appears in the first column of your data, it is likely the channel skip codes are standard, and that only minor adjustments to the other codes, if any, will be necessary.
l Go to column: Use this to enter the channel skip code in your data that tells the document to advance to a specific column. Enter the code in the Char box to the left of the Go to column label, and use the box on the right of the Go to column label to set the column number. This is useful when your data contains redundant lines that were originally created to bold a line on a line printer.
Alternatively this task may be part of a "PDF workflow": a workflow in which both input and output are PDF and in which Metadata tasks are used to group, sort and sequence (split) the PDF data. (See "PDF Workflow" on page 287 for more information on this.) The Create PDF task will apply the active Metadata to the PDF data file. PDFs created with the Create PDF action task will effectively replace the current data file in any given process using such a task.
l l Options group l l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to the PDF RIP. Note that some features, such as the Time and Date require that this option be selected. Add job information to the document: Select to add the available Job Info variables in the “header” of the generated output file. Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized.
l Font group l l l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded. If a font is not embedded in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font.
PReS Image" on page 745). l PDF version: 1.
l Open options: l Zoom factor: Fit in window l Default view: Page only Database Query The Database Query action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format. Database Query action tasks are not considered input tasks as such, because they cannot be used to start a process.
Input Any data file. The data file will be discarded by the task. Processing A connection to the selected database is made, the data is retrieved, and an output in the selected emulation format is generated. Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and Job Info variables are not modified in any way.
l l l l Output file emulation: Select the emulation corresponding to the type of output file you want the PReS Workflow Database action task to generate. CR-LF replacement: If you want CR-LF (Carriage Return-Line Feed) characters within the data file to be replaced by another character, use this box to indicate which character to use. You may select the replacement character from the list or type your own.
l l l l Default width: This box is used to set the default width for all fields. It is set to 60 by default, but can be set to any value between 1 and 65535. This value is applied to all the fields in the generated file. To set different widths for each field, use the Configure Width button. Doing this disables the Default width box. Configure Width: Click to set the width of each field in the generated file.
l l l l Alternate syntax: Select to prevent automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the Advanced SQL Statement dialog box. The alternate syntax may be required for some database types. Edit SQL: Click to create and test an advanced SQL query; see "Advanced SQL Statement Dialog" on page 837.
l l l Expect record set: Check if you are expecting a result from the database after executing the SQL query. If the query is expecting a record set in return and does not return one, the task will trigger an error. Database connection string: Enter a variable connection string in this box. To do this you may begin by clicking to create an ODBC connection string to the data source and paste the string automatically to this box.
Output This task outputs the data file it received with no modification. Metadata and job files are not touched either. Task properties General Tab l l l l l l l Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Output folder: Enter the name of the folder in which you want the decompressed files to be stored.
image files they generate are always saved, along with their index files (if any), to an archive folder. Note The Digital Action task requires a PReS Image license to be present on the same IP Subnet as PReS Workflow, either on the same server or a different one with PReS Image installed and activated. Differences between Digital Action and Image tasks l l Digital Action is an Action task and cannot be the last task in a branch or process.
that in the latter case, you must be certain that the documents that will be chosen at runtime will in fact be available locally or at the selected host. l l List only documents using VDX compilation: Check to ensure that only documents that are compatible with the VDX compilation method are shown in the list, if producing VDX output. Run mode group l l l l Printer centric: Select to send the document along with the trigger and data to PReS Image.
l l l l DPI: Enter the dots per inch (dpi) resolution of the output image. This property is enabled for all output types except PDF. Color depth: Enter the color depth of the output image in bits per pixel (bpp). The color depth is measured in bits, because each pixel of the output image can be described with a varied number of bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images.
(“Statement.%y.%m.@(1,1,1,1,25,KeepCase,Trim)” or ”Job.%f”). Otherwise, when the file is saved, anything appearing after the last dot is replaced by the file’s extension characters (and the file name thus becomes Statement.2005.pdf instead of Statement.2005.255842.pdf, or Job.tif instead of Job.544872.tif). Failing to add the quotation marks may result in files being overwritten.
Note PDF/A output created from a template that uses CMYK colors will be much bigger than PDF/A output created from a template that uses RGB colors, because PDF/A needs to contain a color profile and the CMYK color profile is rather big compared to a RGB color profile. If the output size matters it is recommended to avoid using CMYK colors. l General group l l l l l l l ASCII format: Select to create the PDF file using ASCII characters (instead of the usual 8-bit binary format).
contain parentheses, you should use a Run script action task (see Run Script Action Task Property) with a Strip() function to strip them out. l l Monochrome images group l l l Keywords: You may enter keywords for the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time. Monochrome compression: Select the compression to use for the monochrome images.
that are less smooth. Select Bicubic to use a weighted average to determine pixel shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l l Color images group l l l l Grayscale resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. Color compression: Select the compression to use for the color images.
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 437), 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.
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. 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 303. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task.
Note When using Run Script as a Condition, the output of the task can be within the branch or on the main trunk. To control the output, use the "Script.ReturnValue" on page 174 variable in your script. Properties The Script Editor menu options are as follows. l File l l l Export: Lets you save the current script as a file. l Print: Prints the current script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor).
l l Language: Select the language in which your script is written. Choices are VBScript, JavaScript, Perl or Python. Tools l l Editor Options...: Opens the "Editor Options" on page 801. 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 383.
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.
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.
images by 75% when it converts those image to PostScript. The default compression level is 70%. l l l l Send to Virtual Drive of: Select the computers and / or printers to which the images are to be sent. Refresh: Click to prompt PReS Workflow to look again for available printers and computers. Hard disk name and path: You may enter the name and path of the hard disk to which you want to send the images.
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. To prevent each new file from overwriting the previous one, you should use variable names.
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. Output The original data file, Metadata and other Job Info variables are not modified, they are passed on to the next task. Task properties General Tab l l Var/Info#: Lists all Job Info variables, local variables in the current process and global variables in the configuration. Click on the variable you want to change.
defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems. A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol. The payload of the SOAP packet is an XML document that specifies the call being made and the parameters being passed.
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. Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found.
l Use returned raw SOAP packet as new data file: Check to use the complete SOAP packet (including the passed parameters) instead of the parameters only. This option overrides any return value set to %c in the Arguments box. You should use this option when the SOAP Client plugin is not able to fully support the syntax of the response. Advanced Tab l Domain: Enter the domain for the authentication on the SOAP server. The Domain is optional even when authentication is used.
Processing All HP PCL characters are removed from the data file. Note that these characters are not interpreted, only stripped out. Output The modified data file, with stripped characters, is output from this task. Metadata, Job Info variables and other variables are not modified. Task properties General Tab l l Process job using ASCII emulation: Select to use the ASCII emulation to process the job file. This reverses LF-CR end-of-line sequences that may result in unwanted doublespacing.
Swahili and Swedish. Codepage 932 is often used for Japanese. Note You can create your own translation matrix files for the Translation action task by adding them to the following folder: %COMMONPROGRAMFILES(X86)%\Objectif Lune\PlanetPress Workflow 8\Plugins\Translator Two examples are already present, converting ASCII to and from IBMEBCDIC. Input Any text-based data file. Processing The characters in the data file are converted from the old encoding to the new one.
they will be simply stripped from the data, so you may consider using a space as a place holder for unidentified characters. 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. Windows Print Converter The Windows Print Converter action tasks are designed to convert Windows print files into Line Printer files, that can then be used in a variety of other PReS Workflow tasks.
Task properties General Tab l EMF to XY group: Select this option if the file received by this task is a Windows print file. This will prompt the task to perform the first phase of the process, and thus convert the file to an XML file. If this option is not selected, the input file will not be converted to an XML file (note that the task will fail if the file it receives is not an XML file). The settings included in this group fine tune the process.
font's mean character width is multiplied with. The value for the mean character width is taken from the corresponding font's attributes (for texts which are printed justified, it is suggested to raise this value up to about 2). For example, if the mean character width of the font example shown here corresponds to the width of the blank character (for other fonts it may be another sign).
l l Character per inch (CPI): The number of individual characters per inch on a line of text. Line per inch (LPI): The number of lines of text per inch. XML/JSON Conversion The XML/JSON Action task converts an XML job file to JSON or a JSON job file to XML. This task makes parsing XML/JSON files much simpler in a JavaScript environment and also allows processes to natively send JSON to a Connect template or data mapping configuration. Input The current job file.
naming rules and best naming practices, see: XML elements on W3Schools. Output The output is the modified job file, which replaces the input job file. The metadata are reset. Task properties General tab l Automatic detection: By default, the format of the job file is detected automatically. If the source file is a JSON file, it will be converted to XML. If it is an XML file, it will be converted to JSON. Uncheck this option to limit the task to one type of conversion.
can then be printed and sent by snail mail, or emailed directly from PReS Workflow, to each individual client. Note that if the process merges the split data with a PlanetPress Design document, the splitter must not alter the structure of the data file. In other words, each split file must have the same structure as the original files, otherwise the Design documents to which they will be sent will not be able to extract the data correctly and the merging process will fail.
...and so forth... Once split, the first file generated by the action task would look like this: Data line1 of page 1 Data line2 of page 1 Data line2 of page 1 Last data line of page 1 But when opened with PlanetPress Design or a PReS Workflow using the ASCII emulation, the data in the generated file would look exactly like the data in the original. The same would hold true for the Channel Skip emulation.
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. Task properties General Tab l l l l l Split group: Use this group to indicate how you want the file to be split. Field value change: Select if you want the file to be split based on changes in the values of a selected database field (the value in the ClientID field changes, for example).
l l l l l l Pages or records: Enter the number of pages or records before or after which the file is to be split. Enter 0 if you want the file to be split right before or after the page or record that matches the set condition. Before or after: Options from this list box are used to define exactly how the file is to be split. Select Records before if you want the file to be split a given number of records before the field that matches the set condition.
Change Emulation action task (See "Change Emulation" on page 392 and "About data emulation" on page 59). Using an emulation to format the data before splitting provides the most splitting options, but slows down the process. Splitting a data file containing a few hundred thousand pages may take several hours. So you may choose to use non-emulated data to speed up the splitting process (See "In-Stream Splitter" on page 463).
l Split data file on a word group: Select to split the data file whenever a given word is found within the emulated data file (rather than on based on pages), or whenever the word found at a given location changes, and to activate the options from this group, which are used to tailor exactly how you want the word based splitting process to take place. l l l l l l l l l l Word change: Select if you want the data file to be split when the word found at a given location changes.
l l l l Before: 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 before the line on which the condition is met. 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).
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 other variables are not modified by this task. Task properties General Tab l l l Split data file on: Use this box to choose the item on which top split the file. The options available depend on whether or not the Use emulation box is checked (see below).
only in the first line of every page. If you enter 1 in the From box and 10 in the To box, the Generic Splitter will search in the ten first lines of every page. Note that the actual search region is a combination of the vertical and horizontal search regions. l Word is between columns l l l l l Consider case: Select to force the Generic Splitter to match the character casing of the string of characters entered above with the characters found in the file.
l Word is between columns group l l l l l l Trim selection: Select to force the Generic Splitter to trim empty characters at the beginning and end of the data found in the search region. If this option is not selected, “DAY” will be considered as different from “DAY”. Pages: Enter exactly where to split the file. Enter 1 to split the file 1 page before or after the string, 2 to split the file 2 pages before or after the string, or 0 to split the file immediately before or after the string.
the job to fail). If you enter “ID”, for example, the Generic Splitter will only look in the field named “ID” for the value entered below. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. l l l l Operator: Select the appropriate comparison operator. If you select Equals, the Generic Splitter will only consider that the condition is met when it finds a perfect match (“day“ and “day“, for example).
l l Consider case: Select to force the Generic Splitter to match the character casing of the string of the values appearing in the selected database field. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Where to split group l l l Pages or records: Enter exactly where to split the file.
Task properties General Tab l Split data file on page group: Select to split the data file based on pages (rather than on a word found within the data stream) and to activate the options from this group, which are used to tailor exactly how you want the page based splitting process to take place. l l l l Page breaks on form feed: Select if you want to start a new data page whenever a form feed character is found.
this box. Enter 1, for example, to split the file at the beginning of the line that precedes the line on which the search word is found. l l l Before: 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 before the search word. 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 search word.
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. Note The Metadata is not reset at the time the next data file is sent to the rest of the process. See also: "Output issues caused by Metadata, and how to avoid them" on page 79.
l l l l l l l l l l Right: Enter a value corresponding to the right coordinate on which the splitter must start searching for the region. Top: Enter a value corresponding to the top coordinate on which the splitter must start searching for the region. Bottom: Enter a value corresponding to the bottom coordinate on which the splitter must start searching for the region. Match case: Select to force the splitter to match the character casing.
processed. For example, if the Metadata level is set to Group, and this value is set to 3, each sequence contains 3 groups (except, possibly, the last one, depending on the number of groups left in the last sequence). The next loop starts with the next group after this sequence. l l l l The following number of sequences in the job: Divides the Metadata into a set number of sequences and equally distributes the number of levels between the sequences.
Input An XML file (see "XML Emulation" on page 69). 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 Info variables and user variables are not modified by this task. Task properties General Tab This tab lets you choose the splitter settings for the default PReS Workflow XSLT engine.
box changes. When this option is selected, the split files typically contain more information (all the orders for a given customer, for example). l l l l l l l l l New file root structure group: Use this group to tailor the structure of the generated XML files. Keep XML structure: Select if you want the generated files to have the exact same structure as the original XML file (all the way to the root node).
l l l l l l Use alternate XSLT engine group: Select this option to enable the box and the buttons included in this group. Path and parameters for the alternate engine: Enter your XSLT engine’s absolute path (use quotes for non DOS 8.3 compliant paths) followed by its required operators and parameters (you must know exactly which operators and parameters your XSLT engine requires and in which order they must appear in the command prompt used to launch the engine).
A "Branch" on the facing page is effectively a doubling of your job file (see "Job file" on page 50). As your job file goes down the process, when a branch is encountered, a copy of the job file will go in that branch. In the branch, all tasks up to the Output task will be performed, before returning to the main trunk to continue processes. You can have branches within branches, and all branches must have an Output task. For more information on branches, see "About branches and conditions" on page 136.
l "File/Folder Condition" on page 477 l "Go Sub" on page 479 l "Loop" on page 480 l "Run Script" on page 481 l "Send to Process" on page 484 l "SNMP Condition" on page 485 l "Text Condition" on page 487 l "Time of Day Condition" on page 489 Branch A Branch duplicates your job file along with accompanying information. Branches do not execute in parallel - the branch is executed, and then the trunk (or the following branch) continues.
located at the end of the secondary branch is used for the main branch. If the secondary branch includes a secondary input task or a Change Emulation action task, then the last emulation selected in the secondary branch will be the one used for the main branch. l Backup local variables: Select if you want PReS Workflow to use identical copies of the local variables for the main and secondary branches.
Setting the file count to 0 allows to take action, for example, when a scheduled process is expected to have files but it doesn't. Note When used as an Input task, the File Count task does not apply the process polling interval. Once the condition is true, it triggers the process repeatedly, as if the polling interval were 0. To work around this, start the process with a Create File task followed by a File Count as Condition task. This issue only occurs in version 2020.1 and will be fixed in version 2020.
l Masks: Enter a single or multiple file names or use file name masks (see "Masks" on page 306). Multiple filters are separated by a semicolon (e.g. *.csv;.xls*). This is a variable property field. (See "Variable task properties" on page 303.) l Treat as regular expressions: When ticked, the contents of the Mask field are deemed to be a regular expression . You can specify multiple masks based on regular expressions, separating the regular expressions by a semicolon.
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 853. 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.
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 306. The condition will be tested True only in the case of an exact match, so consider using wildcard characters.
l Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess (see "About processes and subprocesses" on page 124).
l l l 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. Backup emulation: Select if you want to use the emulation selected when the job file reaches the subprocess for the main process as well. Note that the emulation is not passed from a main process to a subprocess or vice versa.
l l Use value of Variable/Job Info # expression: If the contents of the previous option is a variable, its content (which is assumed to be a number between 1 and 9) will be used to determine which Job Info number to use for the iteration number. For example if % {myvariable} is used and contains the value 9, then Job Info 9 will store the value of the loop's iteration. Use original Data Stream every time: Select to reuse the original job file received by the Loop action task at every iteration.
Output Whatever file the Run Script action generates, Metadata it modifies or creates, etc. Note When using Run Script as a Condition, the output of the task can be within the branch or on the main trunk. To control the output, use the "Script.ReturnValue" on page 174 variable in your script. 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 801. 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. Send to Process The Send to Process task transfers job file(s), job information and all related files (Metadata, sorted Metadata, etc.) to a selected process. This Action task is asynchronous, meaning the current process will continue running in parallel to the process chosen in this task and will not wait for it to finish.
SNMP Condition SNMP is a communication protocol for helping network administrators manage devices and peripherals on their network. It is useful for verifying the status of network printers, as you can retrieve error and other status messages that printers send out, such as being out of paper or having low toner.
with the condition. Most SNMP devices come with a public community name that usually gives you read-only and/or read-write access. It is recommended to increase security on your network by entering community names allowing varying levels of access depending on the particular device, its users, etc. The community name tells the device which rights to grant PReS Workflow (required to perform the test). l l l l l l Get info: Click to retrieve information corresponding to the IP address you entered.
sometimes list MIB OIDs in their documentation. l Test: Click to test communication with the device and the MIB OID number. l Operator: Select the operator used to test the condition. l l Value: Enter a specific object status. Vendors of SNMP compliant devices sometimes list possible object states in their documentation. Invert condition result: Select to toggle the result of the whole SNMP condition (true becomes false and vice versa). Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Task properties General Tab l l l l l l l String: If you want to test the presence of a given string at a given location, enter the string in this box. If you want to compare two strings or perform a numeric comparison, enter the first string in this box. Note that you can enter either a static string, a variable or a data selection in this box. If you enter a variable, PReS Workflow will retrieve the string from the variable before performing the comparison.
l l l Page range: Select Any page if you do not want to specify a precise data page. Select Pages to specify individual pages or page ranges. The page range setting is only considered when either ”Is found” or ”Is not found” is selected in the Operator box. Range: Entries must be separated by commas. Page ranges are entered using a starting page and an ending page, separated by a dash. For pages 1, 3 and 5 to 7, you would enter the following: 1,3,5-7.
l l l l Week of month / by date: Select Date if you want the selected time blocks to be valid only on specific dates. Select All weeks if you want the selected time blocks to be valid every week of the month. Select a specific week of the month if you want the selected time blocks to be valid only on that week (the first, second or last week of the month, for instance). Time division: Select the desired time interval. Each block in the grid corresponds to the selected time interval.
l "PReS Fax" on page 512 l "PReS Image" on page 513 l "PReS Print Controls" on page 523 l "PrintShop Mail" on page 527 l When installed, the "ZUGFeRD plugin" on page 529 also appears in the Connector category. It is bound to the Connect Workflow Imaging license and provided separately. Create MRDX The Create MRDX Action task is used to register a job on a SureTrac server using an MRDX file.
Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Delete Capture OnTheGo Document The Delete Capture OnTheGo Document deletes a document from a Capture OnTheGo Repository, which stores documents that can then be retrieved by the Capture OnTheGo mobile application.
l Server URL: Select the address of the COTG Server that you want the plugin to communicate with. (This option is only available if more than one COTG Server address has been defined.) l Repository ID: Enter a valid Capture OnTheGo Repository ID. l Password: Enter the password that corresponds to the Repository ID entered above. l Document ID: Enter the ID of the document to delete from the Repository.
Note Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PlanetPress 7.5 and higher only. Licensing This plugin requires the OL Connect Workflow Imaging license. 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 745 and "About PReS Fax" on page 744. Without a valid Imaging license, the plugin will fail with an error.
Task properties General Tab Note For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab. l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files.
Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted. Domain: The active directory domain for the logon credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries.
Laserfiche Repository Output The Laserfiche Repository Output task publishes files - and optionally sets index values into a Laserfiche server. This task uploads any documents in a Laserfiche repository, optionally filling the index information on the Laserfiche server with dynamic information that can be taken from PReS Workflow PDI files (for PReS Workflow archives only). Note The Laserfiche Repository Output requires the Laserfiche run-time version 8.1 or higher and will not work with previous versions.
Task Properties General Tab l Laserfiche configuration group l l Folder: Enter the Laserfiche client repository folder where the documents will be exported. The user can specify the remote folder by clicking the Browse… button. Note: If the Folder field is empty, the documents will be exported by default to the root folder Import Format group l l l l l l l Laserfiche Pages: Converts all images files (*.bmp, *.gif, *.jpeg, *.pcx, *.png, *.tif, *.tiff, *.
Connection Tab l Server Name: The server name or IP address of the server you wish to connect to. l Repository: The name of the repository you wish to send the files to. l User name: A user name in Laserfiche that has access to the above repository. l Password: The password for the above user name. l Test Connection: Click to verify that the information entered in this tab is correct and the server accepts it.
data retrieved is based on existing data in your Metadata, and it will either be added to your Metadata or will append or replace your existing Metadata if it exists. Fields on any level (Page, Datapage, Document, Group, Job) can be used, and the result field will be added on the same level as the lookup field. Note This task will automatically "loop" through the Metadata and repeat its action for each of your Metadata's data pages.
Input Any compatible data file. This task requires Metadata to be present. Processing The task parses each level of the Metadata and, for each field of the specified name it finds, a lookup is made. If a field of the same name appears on multiple levels, the lookup will happen for all fields, on all levels, individually. Output The original data file is unchanged. Metadata is updated according to the specified criteria.
l l l l l l Replace field value: Replaces any existing field with the new content. Only the last result will be displayed. If the field does not exist, it will create it. Append field value: Ads the data to the existing field within the same one. No "separator" is added. If the field does not exist, it will create it. Result Field: The Metadata field name in which the result should be stored. This field will appear in the same Metadata level as the Lookup Field.
l Microsoft Word must not be currently opened when the automation task runs. l Microsoft Word 2003 and up are supported. l l l l l While debugging this task, the printer shows the message that the document can not be printed. This message is normal and will not appear when running a live configuration.
l A PDF file accompanied with basic PDF metadata. This is the default output. The Metadata contains one Document level, and one Data page (and Page) level for each PDF page generated by the document. When Mail Merge is not selected, this is the only available choice. Note The Objectif Lune Printer Driver will naturally add a margin to the PDF generated by this task. If your PDF is full bleed you will not get the desired results using this option.
Microsoft Access and Excel data files. You can use the Test Connection button to test the SQL and connection string. l l Test connection: Checks if the Connection String and SQL Statement are valid, and if the resulting recordset is understood by the Microsoft® Word® document. This is optional, though highly recommended. Output Type: l l .PDF File (with metadata): The result will be a PDF file with the number of pages generated by the combination of the template and record set.
Processing This task does not process the data or Metadata file. The information entered in the Deposit tab of this task is sent to the repository configured in the Repository tab. Output The output that this task produces is the information sent to the Capture OnTheGo online repository (the document ID). Task properties Repository Tab The Repository tab is where you enter the connection information necessary to create the link between OL Connect or PReS and CaptureOnTheGo.
l l Document Information group: In this group, you enter information that will help users identify the document. It is mandatory to enter valid information in all the boxes included in this group. l l Cover Image: Enter the path to a cover image that is shown in the repository and library list, as well as the document property. The maximum image size is 512x512 px and it is required to be in JPG or PNG format. Use the Browse button to locate an image on the local drive.
are not present on the Capture OnTheGo Server, the process will go through and the listed categories will be added to the Server. Advanced Tab The Advanced tab is where you specify the document's time to live either in the repository or the user's device. l Document Handling Options group: l l l l Customize: You must check this box if you want the options included in this group to be used. When this option is not checked, the other boxes included in this group are faded.
that the date you enter will automatically be reflected in the For box above. l l Document Tracking: l l l Time zone: When you enter a number of days in the For box or a date in the Until box above, the computer’s time zone appears in this box. You may select a different time zone if required. Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server. This tracking is done through the COTGDefaul.mdb database located in %ProgramData%\Objectif Lune\PReS Workflow 8\PRe
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 745 and "About PReS Fax" on page 744. 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.
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.
Output A TIFF in the CCITT Group 4 compression, and information for the FAX server to know where to send the file. Task properties General Tab l l l l l Host: Select the IP address of the PReS Fax host to which you want the request to be sent. The Fax configuration is set in the PReS Fax User Options on the target host. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box.
given computer (see "PReS Image preferences" on page 796). Note that those options are specific to each PReS Image installation and that they are immediately applied. The following describes the properties specific to PReS Image Output tasks. Note In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PReS Workflow is running, so emails are not sent out automatically.
l l If the data file and a document are selected, and Optimized PostScript Stream mode is used, the data file is merged with the document and the resulting OPS job is sent to the PReS Image host to produce output. If the data file is a postscript file and either mode is used, the postscript file is sent to the PReS Image host which generates output (since this is already Optimized PostScript, it is not regenerated).
l l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Output type: Select the output file type that you want. l l l l l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PReS Image. Note that some features, such as the Time and Date functions, require that this option be selected. PDF: The output will be a PDF file.
TIFF G4, monochrome (1 bpp) is the only Color depth option you can select. This property is enabled for all output types except PDF. l l l l l l l l Multi-page: Select to generate a single file containing multiple pages. When this option is not selected, PReS Image creates a file for each page included in the output file. This property is enabled for all output types except PDF and JPEG. Add page number: Select to put a page number on each page included in the output file.
l l l PDI: Select if you want this task to add a PDI index file to the generated document. XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document. Use Title as FormName for PDF/VT document: Check to use the Title (defined on the Job Options tab) as the PDF's FormName in the PDI, instead of the incoming PDF/VT document's dc.title meta data tag. If the Title is empty, a warning is logged and the FormName is not changed.
l l l l Subject: You may enter the subject of the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time. Note that if you use a data selection in this box, you must be sure that the data that will be selected at run-time will not contain any parentheses, as this would cause the task to fail.
l l l Downsampling: Select the down sampling option. Down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels. The Grayscale resolution you enter in the following box is used to control the down sampling process. Select None to prevent grayscale down sampling. Select Average to average pixel shades in each sample area and to replace the entire area with a pixel of the average shade.
l Security group l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files.
choose a percentage of the actual document size. l Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty. Select Bookmarks and page to display the contents of the Bookmarks tab (you use data selection objects to create bookmarks in PReS) alongside the PDF pages.
name you chose when you configured the SQL database (refer to the “Using PReSSearch with an SQL Server Database” section of the PReS Search User Guide). l Password: Enter the password required to access the database. l Test Connection: Click to verify that PReSImage can connect to the specified database. l Enforce global table creation: Select this option, as it ensures that all database users are granted access to the database.
These resources include the data file to run against the job, plus any graphic or font resources the jobs needs, along with any required PReS Classic specific resources, such as TRF or PDI files. Processing The selected data file is merged with the selected PReS Classic job to create a print output stream. If the PReS Classic job selected is an uncompiled PReS Classic script (PDS), it will first be compiled on the fly and then run using the selected data file.
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 303. 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.
For general information on the Plugin, see "ZUGFeRD" on page 747. Input A PDF file that is PDF/A compliant. The PDF/A conformity level doesn't matter. It may be 1, 2 or 3. Processing The plugin first checks that the PDF is PDF/A compliant, and doesn't already contain ZUGFeRD data. If it is, then the PDF is processed. Output A PDF/A-3 file with the selected ZUGFeRD data included.
l l Workflow Jobdatei: Use the incoming Workflow Job File. Datei: Specify a specific PDF. Use the browse button the file path and name into the edit box. to select a file, or paste The file path and name can be given and defined via variables, so the file selection can be dynamic. Note The PDF selected must already be PDF/A compliant. The conformity level doesn't matter (it may be 1, 2 or 3).
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.
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 546 or "Find Capture Documents" on page 552 task. However, it is also possible to directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and Metadata are completely ignored by this task's condition rules, and the database information is used instead. Processing The condition is evaluated using the specified rules, combination (condition is true when...) and scope (condition scope).
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.
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.
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 Page Level: l CaptureField: Information on each capture field on the page. Repeated for each capture field that is present. Note There is no method of obtaining the information from a PGC except through a successful processing of this task, or via the use of the PlanetPress Capture API within a Script (see "Using Scripts" on page 141).
l l l l Fail if new ink is found on non-rewritable fields: Check to trigger the On Error tab if and when a field set as Disable Rewriting receives ink in a new session. Ignore out of bounds ink data: Check to continue processing even if receiving a PGC that causes ink to be outside of any Capture Field to appear. This may happen if updating the wrong document. When out of bounds ink is found, the document will be set in the "Error" status.
Splitter will cause your process to take more time, since each PGC must pass through the Capture Fields Processor and then the Get Capture Document task. Note Due to the fact that the Capture PGC Splitter task modifies the original PGC, in some cases the legality of the PGC signature may be compromised. This depends on your country or region's laws, so if your implementation of Capture requires signatures to be authenticated please consult a legal advisor for more details.
l l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the pattern sequence to be used. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Output The original data file is output by this task, along with the original Metadata file that has been enhanced with the ICR data at the selected level. Task properties General Tab l l Document ID: A variable data field that corresponds to the database ID of the document from which you want to retrieve ICR data. The Document ID is generated by the system through the Capture Fields Generator. The ID must correspond to a document in the Capture database, or the task will fail with an error.
panel. This task is put into effect in the following use cases and example processes: l Capture Post Processing Workflow l Capture Web Manager Workflow Input Because this task in an Input task, it does not use the current job file in your process, even when used as a secondary input task. Processing This task connects to the Capture database and looks up all available documents that meet the criteria specified in the plugin.
l Condition Grid: Displays the list of current condition criteria that were set for document retrieval. l Filter: The selected filter type. This can be any of the following: l l l l l l l l l l Document Name: The name of the document, as specified in the Document Name property of the "Capture Fields Generator" on page 543. Date Generated: The date, in YYYY-MM-DD format, when the document was generated through the Capture Field Generator.
l l l l l l l l l l l l l l Less Than: Numerical comparison, where anything lower than the specified value is included. Greater Than: Numerical comparison, where anything higher than the specified value is included. Less than or equal to: Numerical comparison, where anything lower or equal to than the specified value is included. Greater than or equal to: Numerical comparison, where anything higher or equal to than the specified value is included.
l Create Advanced Data File: Click to retrieve additional information about each document in the result list. These information include each field, the presence of ink on each of them, time stamps, etc. Please refer to Find Capture Document for an example of the XML file. Warning The Advanced Data File option will generate a high number of queries into the Capture Database, and will be slower than a regular data file by orders of magnitude.
Processing One PDF, corresponding to the information present either in the Metadata or specified in the task, is extracted from the Capture database. When retrieving documents from the database, the PDF from which the document is obtained will remain in the database until each document contained in it is retrieved from it. For example, if a 10-page PDF contains 5 documents, the 10 pages remain in that PDF until all 5 documents have received ink, been closed and retrieved from the database.
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.
Note When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False. This task is put into effect in the following use cases and example processes: l PlanetPress Capture Workflow Input A PGC file received from an Anoto digital pen.
Properties... Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata tasks Metadata tasks are plugins that can create or edit metadata for a job file. For more information about the metadata structure and elements, see "Metadata" on page 74.
l "Example: Daily sales report from PDF files" on page 288 l Basic Functional Capture Workflow l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Input A data file in any supported emulation (see "About data emulation" on page 59).
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).
Input Any data file with accompanying Metadata. Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties. If the field is present in a level that repeats (for example, the data page level), this task loops so that the action may take place on each of the occurrences of that level. Updating all nodes For a given Metadata Field Management action, all nodes of a given level might be updated with a New Field value.
l l l l l l Add/Replace: Create a new Metadata field. If the name already exists, the value is overwritten with the new one. Duplicate: Create a new Metadata field. If the field already exists, a new instance is created. Append: Append the new value at the end of the current one. If no field with that name exists, a new one is created. Sum: Calculate the sum of all values found in all fields of a given name, at a given level. The resulting number is formatted by default with the dot decimal separator.
l l ,: Treat every value with the comma (",") decimal separator. Dots (".") are treated as thousand separator. Rule: Define criteria for the Metadata Field Management action execution. The condition must be TRUE for the action to execute. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action. See the "Rule Interface" on page 859 page for more details. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Properties l Chose an action group l l l l l Load metadata file: Loads an external Metadata file that was previously saved. This can be useful in Error processes if you have previously saved the Metadata to file (ErrorBin outputs do not transfer Metadata). Save the current metadata file: Saves the current Metadata to a specified location. Useful as a backup or for use in Error processes. Delete the current metadata file: Removes the active Metadata from the process.
Processing Any Metadata that does not correspond to the rules set forth by the filter are removed from the active Metadata. Note that the 'removed' Metadata is still present in the file, but is unselected: they are disabled and ignored on all tasks that use Metadata afterward (except the Metadata Sorter task). Output The original data file is output, along with the modified Metadata. Task properties General Tab l Filter levels: Rules for deselecting nodes at the Group, Document or Data page level.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Special Considerations l l The task CANNOT re-select unselected nodes if the condition is false for those nodes. Filter rules cannot be based on the following metadata attributes: SelectedIndexInJob, SelectedIndexInGroup, SelectedIndexInDocument and SelectedIndex. Metadata Level Creation The Metadata Level Creation task conditionally creates new Metadata groups or documents.
1. WinQueue Input: Intercepts a printed data file sent to a Windows printer queue. 2. Metadata Level Creation: Begins a new document node when “Page 1 of” is found on a data page. l Action: Document l Delimiter: Begins when l Rule: (@(?,1,1,1,9,KeepCase,NoTrim) IS EQUAL TO Page 1 of) 3. Metadata Sequencer: Splits the data file on each Metadata document node level.
l l Delimiter defines if the Condition parameter is triggering the beginning or the end of a Group or Document. If the delimiter option is set to None, the action is not performed. Rules enable the user to define on which criteria the action must to be performed. The condition must be TRUE to execute the action. If the condition is not met at least once, the rule is not applied. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action.
Output The original data file is output once per chunk, along with this chunk's metadata. Note that all the Metadata is in each of the sequence, but anything not part of the sequence is disabled and is ignored by all tasks using Metadata afterwards. Task properties General Tab l Metadata level: Select the Metadata level to process.
Processing The order of the Metadata is changed in accordance with the rules set forth in the task's properties. The Metadata Sorter task works on all nodes, regardless of their selected state. Output The original data file is output, along with the modified Metadata. General Tab l Group: Sorts the Metadata by group. l Document: Sorts the Metadata by document. l Data page: Sorts the Metadata by data page. For each parameter, three columns are available: Sort By, Then by, Then by (again).
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata to PDI The Metadata to PDI task takes the active metadata and generates a PDI using the information in that metadata. It is generally used in conjunction with a PDF data file and is used to generate the PDI file which is used by PReS Search when building, refreshing or rebuilding its database. For more information about Metadata see "Metadata" on page 74.
l Index Group: l l PDI: Only generate a PDI file. PDI and XML: Generate both the PDI and an XML equivalent (not used by PReS Search). Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata-Based N-Up The Metadata-based N-Up action task works in conjunction with the PlanetPress Design tool's N-Up functionality.
Also see Output Creation Preset and Print Options in Connect's Online Help. Input Any data file with accompanying Metadata. Processing The Metadata is re-arranged and/or duplicated in order to correspond to the options set forth in this task's properties. Output The original data file is output, along with the modified Metadata. Task properties General Tab l l Number of virtual pages that appear on each physical page: This is equivalent to the N in N-Up.
OL Connect Send Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application. It is in fact an application with two components. The first is a Windows printer driver while the other is a group of Workflow plugins (Job Processor, Get Job Data and Get Data). These two components work together indiscriminately, each needing the other to function. Connect Send can be used in unlicensed mode and licensed mode.
Note The Get Data plugin gets data from the OL Connect Send database which means it only works when Connect is in LICENSED mode. Properties General Tab Filter options Filters are required for: l Start and end date (down to minutes) l Domain(s) l User(s) l Machine name(s) Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: l Workflow variables l Job variables l Names.
Example 1 A valid user name search string, entered in the Filter Users field, would be: %\{global.User};helen;%1;george napier This would look for all entries, where the user name is either: l as currently stored in the global Workflow variable User l "helen" l as stored in the job variable number 1 l equals "george napier" (case insensitive). These search criteria are combined with OR. Example 2 The domain name entered in the Filter Domains field is objmtl.objectiflune.
and minute is a colon) It is possible to define the same date for From Date/Time as for To Date/Time. However, entering the same info (without time information) would lead to getting no entries.
Returned information For each job received by the OL Connect Send Job Processor plugin the following values will be available. l l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Status ID: The status ID shows in which stage the job currently is: 0 = undefined; 1 = idle; 2 = transfer; 3 = chunk; 4 = concatenate; 5 = unzip; 6 = done. A value of 6 indicates a fully processed job. Any value between 2 and 5 (inclusive) means that the job is still in progress.
l l l l l l Original file name: This is the "file name" as sent from the application to the Windows spooling system. It is taken from the name as it arrives in the spooler. Some applications add info to the name (like Notepad++) while others don’t (like Adobe Reader). OL Connect Send can only use what it gets from the spooler. It does not interact with the applications itself. Original file size: The size of the print job - NOT the size of the document file.
OL Connect Send Job Processor plugin, it creates a unique ID string composed of 10 upperand lowercase letters and digits e.g. “ri0zZdluLp”. This Unique Job ID is used in any communication between the Printer Driver and the plugin and is the leading identification element for this particular job. All job related information is stored in the underlying database and linked together by this Unique Job ID.
Select Returning Type Depending on this setting the plugin gets status information about the job before it has arrived or it gets information after the job has been completely received. l l Immediately: By choosing this option, the Get Job Data plugin will return as quickly as it can, providing it can find a matching Job ID in the database. It is important to know that it will wait until any information about the job is available.
l Date/Time stamp: This is the time when the matching job was initially created in the database. It is stored in UTC format plus time zone indicator inside the database. It will differ from the time stamp logged by the OL Connect Send Printer Driver as well as by the OL Connect Send Job Processor. Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value.
logged on users vs. application running users, machine names etc. please refer to the respective Windows help pages or ask your system administrator. l l l Domain / Workgroup Indicator: Indicates whether the field "Domain (workgroup) name" is a domain name or a workgroup name. The possible values are 0 (false) for a workgroup, or 1 (true) for a domain. Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API.
possible. Processing The Job Processor plugin receives a compressed PostScript file sent by the OL Connect Send Printer Driver and communicates with the Printer Driver to ensure that all data has been received correctly. If the Printer Driver has split the job into multiple chunks, the plugin combines the chunks into one PostScript file. License mode Each incoming print job is checked against the license to determine if it can be handled in licensed mode or in unlicensed mode.
HTTPS Communication The OL Connect Send Printer Driver can be set to use HTTPS for any job transfer. To do this, Workflow must also be set to use HTTPS. Job Origin Each print job will include unique information about the machine it has been sent from. This unique machine ID is calculated with a proven method and will be transferred, encrypted and enhanced. The enhancement will result in a different encrypted machine ID per print job, so that spoofing can be detected.
Metadata In addition to the print job, the plugin creates a metadata file with basic information. The values originate from the client machine. In unlicensed mode, the user name, machine name and domain/workgroup name will not be available through the metadata. Properties General tab l Data Output l Output Folder: Enter the target folder for the incoming print jobs. l Output File Name: Enter the file name for the incoming print jobs.
Information Workflow Variable When licensed When unlicensed Username 1 %3 The user name "na" IP Address 1 %4 The IP address The IP address No. of Pages 1 %5 Number of pages of the job Number of pages of the job No. of Copies 1 %6 Number of copies set by the user Number of copies set by the user Domain Name 1 %7 The Domain Name "na" Machine Name 1 %8 The Machine Name "na" 1) These values originate from the Printer Driver machine.
OL Connect tasks OL Connect tasks are available in PReS Workflow 8.0 and up. They are used specifically to communicate with the Server component of PlanetPress Connect or PReS Connect and for such purposes as creating record sets, generating contents and generating output. For more information about the Workflow processes in which these tasks are used, see the Connect Online Help.
This task is a combination of the 4 different OL Connect tasks that are normally used in conjunction to generate Print output: "Execute Data Mapping" on page 622, "Create Print Content" on page 612, "Create Job" on page 602, and "Create Output" on page 605. Combining them in a single task makes creating Print content easier and faster, as the task is optimized for this specific purpose.
l l l l l "%o": Select to use a dynamic data mapping configuration name. Click on %o to change the expression that determines the name of the data mapping configuration to use. Right-click it to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53). Configuration Names: Select the appropriate data mapping configuration. Adding configurations is done through the Send to Workflow option in the DataMapper Module.
l Filter type: Determines at which level to retrieve the records: l l l l l l l l l l Add a condition: Click to add a new condition line. This adds the line to the current condition level, by default with an AND operator. Switch conditions: Click to swap two conditions on the same level, or two groups of conditions. Delete the selected condition: Click to delete the currently selected conditions in the list. Clear the rule: Click to delete all rules in the list. Note: This cannot be undone.
Note Once the All In One plugin has been executed with this option selected, any task that attempts to access records in the database will fail. Content Creation Tab The Content Creation step generates Content Items either by merging a Record Set with a Template, or by processing a PDF/VT file into individual content items. l Template: Select the appropriate template or option to execute it: l l l l "None": Select to skip Content Creation completely. "%o": Select to use a dynamic template name.
l l l Preset Names: Select the appropriate Job Preset file. Listed are the Job Presets that are present in the Connect Resources (see "Connect resources" on page 39). Runtime Parameters: The Runtime Parameters defined in the selected Job Creation Preset are displayed and their values can be edited here. Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53).
l l l As defined by Output Preset: Select to send the output of the job to the location set in the Print Preset (file, printer, etc). Through Workflow: Select to replace the current job file with the output produced by the server. Every option in the Output Preset is still used, except for the output location. Note that when the output is separated, the current job file is not replaced with the actual output files but with a CSV file that lists the paths to the outputted files (e.g. “C:\Users\Administrat
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Sort Parameters The Sort Parameters define how to sort the entities retrieved from the Connect Database using either the "Retrieve Items" on page 636 task, or the Filter source in the "All In One" on page 591's Data Mapper task. l Sort items based on: Lists the different sorts to apply to the entities. l l l Name: Click and enter the name for the Value or the Property to sort on.
JSON The Create Email Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string examples" on page 91. A JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 92).
Note If sending email is not included in the license, the emails will be sent to the sender instead of to the intended recipients. Properties General Tab l Template l l l l "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template. Adding template is done through the Send to Workflow option in the Designer Module. Section: Enter the section name that will generate output.
Warning The JSON format is not validated by the plugin; it is passed as is to the server. Email Info tab l l l l l l Sender Address: Enter the email address that appears in the "From" field of the email. Alternatively you may enter the sender's name and email address in the following format: John Smith . It depends on the email client which information gets displayed: the sender's name or email address, or both.
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 773. 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.
Note The result of a Retrieve Items task cannot be used with a Job Creation Preset. Use the IDs in the metadata instead (see the Properties below). Processing The task prepares the content items or content sets for printing, tagging them as printable. Only the content items that are part of the job will generate output. Output The task outputs a Print Job ready to be sent to the "Create Output" on page 605 task for printing.
in the Job Creation Preset will be used to try and parse the input parameter value. In order to make this work: o Boolean values need to be entered as either “true” or “false”. (When the comparison actually occurs, it will be a full Boolean comparison. Thus it can compare this runtime parameter with Boolean data values that are stored as 0/1 in data fields.) o Numeric string values need to be parseable as a number (either a whole integer or decimal value).
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Output The Create Output task generates Print output in a format specified by a Connect Print Preset and sends this output to the appropriate target location. See also: "About printing" on page 108. This task can be added as an Action task (see "Action tasks" on page 379) or as an Output task (see "Output tasks" on page 644).
General Tab l Output Preset file: Select which Output Preset to use to generate the output. To be used in this dialog, a preset must have been sent to PReS Workflow using the Package File function in PReS Connect. l l l Preset Names: Select the appropriate preset to generate output. Output Management group: l l l "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below.
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
General Tab l l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. Recipient Node: Use the drop-down to select which level of the metadata is used as the "Recipient" node. The Recipient node defines each Record in the output when used with the "Create Print Content" on page 612 task. Add job information to document: Check to add the 9 Job Info variables to the PDF/VT metadata at the root level.
Properties Datamapper tab The Create Preview PDF plugin gets one record from the source selected on the Datamapper tab. This record is then merged with the template (selected on the Content Creation tab) to create a preview PDF. The Datamapper tab can have one of the following source options: l Data mapping configuration sets the data source to a data mapping configuration. l l l %o: Select this to use a dynamic data mapping configuration name.
Instead it uses the default values set up in the Preprocessor of the data mapping configuration. To work around this issue you could either convert the posted data file into JSON, add the variables and use the JSON string option in the Create Preview PDF plugin, or you could add the variables to the data file and let the data mapping configuration extract them. Another alternative would be to use the "All In One" on page 591 task.
Note The Metadata option requires that entries in the metadata have matching field names in the data model of the template. When they have, the values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data).
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Print Content The Create Print Content task generates a set of printable content items from a template's Print Context, and saves those content items in the database until output creation is requested. This task also accepts a PDF/VT file as input (see "Create PDF/VT" on page 607), allowing the task to be used without a Connect Template.
Note When JSON data is used as input, the "Create Job" on page 602 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 622 task does. Job Creation Presets need such a record set to group, sort and filter items. Processing In the case of a record set or a JSON object/array and template, this task loops through each record (or object) in the set (or array).
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 773. 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.
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 622 task and the "Retrieve Items" on page 636 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.
Output The task outputs HTML code as a job file. Within this HTML code, references to external resources point to the local OL Connect Server and are served to the requester directly when the HTML file is opened in a browser. Properties General Tab l Template File: l l l l "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template.
Adding Variable Data.) Warning The JSON format is not validated by the plugin; it is passed as is to the server. Note Only the first record or JSON object is processed, since this task can only generate HTML output for a single record. l l Embed all resources: Check this option to download the resources and embed them in the HTML file. Do not alter HTML: Check this option to prevent that the Create Web Content task modifies the HTML.
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 773. 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.
selection methods: GetMeta(_vger_prop_folder[0], 10, Job.Group[0].Document[0]) GetMeta(_vger_prop_eml[0], 10, Job.Group[0].Document[0]). The "Mailjet" on page 695 and "SendGrid" on page 699 plugins offer the possibility to add extra attachments to a rendered email message via Workflow. Note that any such attachments will not be part of the EML file produced by the Render Email Content task. Note With PReS Workflow version 2020.1, using the Download EML Messages task requires the version 2020.
Processing The plugin communicates with the Connect Server to retrieve the EML file that was stored in the Connect File Store by the "Render Email Content" on page 632. Output The task outputs the EML file as the Job File. The Metadata are unchanged. Properties General Tab l Data Source (see "Input" on the previous page): l l Metadata: Metadata containing information about an email message.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Execute Data Mapping The Execute Data Mapping action task generates a record set by executing a data mapping configuration on a data source. It can also automatically create a record set from a PDF/VT file without using a data mapping configuration. Input Optional. Both main options can refer to external files, but either one can be the active data file using %F.
"Note: Metadata in OL Connect jobs" on page 76). Alternatively, you can either get an XML file or JSON file containing the full Record Set structure, or skip storing the Record Set on the OL Connect Server and run the operation in Validation mode; the validation results are returned via the Metadata. Properties General Tab l Data Mapping Configuration: Executes data mapping on the appropriate source.
in a "Run Script" on page 481 task. 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.
occur in the data mapping configuration. If a runtime parameter is defined in a data mapper configuration, but not set in the task properties, an error will be raised. 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 773. Note Defaults are not used unless the configuration is sent to the Workflow service.
Processing The task requests removal of the file by performing a call to the /rest/serverengine/filestore/delete/{fileId} REST endpoint; see File Store Service: Delete File in the REST API Cookbook. Output This task has no impact on the current Job File. Task properties General Tab l File name/ID: The name or the ID of the file to delete. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Store - Download File The File Store - Download File task downloads a file from the OL Connect File Store, using either a file name or File Store ID. Input The task requires either the name of the file in the OL Connect File Store or its File Store ID.
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Task properties General Tab l l l Filename: Enter the file name or a JobInfo, local or global variable that contains the file name, to use when saving the file in the OL Connect File Store. The default is %f, the name of the job file. Right-click the field to select another variable. When you specify %o as the file name, the file in the OL Connect File Store will have the same name as the original file.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Mark Connect Sets for Deletion The Mark Connect Sets for Deletion task indicates that an item in the Connect Database should be deleted the next time the Database Cleanup runs. This means that whatever item is set for deletion will no longer be available from the database. Input The task requires a valid Metadata file containing items for deletion, including Job Sets, Content Sets and Data Sets.
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 773. 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.
Output The task outputs a merged Metadata Job File which can be used in the "Create Output" on page 605 task. Task properties General Tab l Metadata file: Enter the full path to a valid Metadata file containing an OL Connect Job, or use the Browse button to browse to a valid location. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Input This task must receive either Metadata containing information regarding a valid Record Set, or JSON data. Metadata The "Execute Data Mapping" on page 622 task and the "Retrieve Items" on page 636 task output Metadata containing information regarding a Record Set. Note The plugin takes the entire Metadata file as its input, even when it is placed after a "Metadata Sequencer" on page 571 task.
Note Make sure that other components in the Workflow configuration working on the job data handle UTF-8 encoded files correctly. Processing This task loops through each record in a Record Set or through each JSON object in an array. For each record or JSON object, the task generates an HTML email using that record's or object's data. Note Content creation may be aborted by a script in a Connect template that raises a fatal error. This triggers the On Error tab of the Content Creation task.
"eml":"c5f97db0-45ca-4f1d-be4d-473d000c92bd.eml", "body":"07decd87-d03c-4969-bc2a-7527cc594878.html", "text":"7a4e5217-0103-487f-a4f8-77d37d0c1087.txt"} ], "contentSet":8769} Properties General Tab l l l Template: Click the Browse button to select a template from the resources (see "Connect resources" on page 39), or enter a dynamic template name. Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53).
Email output settings in the Email context and sections) and EML file (see below). l l l Metadata: Write the information to the current Metadata. JSON Data in Job Data File: Return the information in a JSON structure that replaces the current Job File. This allows you to manipulate the output in a "Run Script" on page 481 task before sending it to an Email Service Provider (ESP).
Input The task requires no input file, but any input information such as Metadata, Job Info variables, a data file or a JSON array can be used to specify which items to retrieve. Processing The task requests the items on the OL Connect Server using the conditions set in the task properties. Only the condition information and the returned Metadata or JSON are exchanged. Note that the order in which the requested items are returned cannot be guaranteed.
l l l l l l Job: Retrieves one or more Jobs, including all their content items ready to be printed. Output similar to the "Create Job" on page 602 task. Job Set: Retrieves one or more Job Sets, including all their content items ready to be printed. Output similar to the "Create Job" on page 602 task. Condition: Select entities based on one or more conditions, the value of a metadata field for example.
l Output Type group: l l l Metadata - IDs only: Select to only output minimal metadata containing the entity IDs. Metadata: Select to output IDs as well as record details in the metadata, useful for further sorting and filtering of the metadata. JSON: Select to output a JSON Record Data List (see "Output" on page 637). Commingling/Batching Tab Commingling is a method by which Print Content Items are merged together to create mail pieces going to each recipient.
preferences" on page 773. 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.
Set Properties The Set Properties Action task defines properties for entities saved in the OL Connect Database (Records, Content, and Jobs). These properties are applied to the entities and can then be used to retrieve them using the "Retrieve Items" on page 636 task. Input The task must receive Metadata that contains appropriate entities, generally from the "Execute Data Mapping" on page 622, "Create Print Content" on page 612, "Create Web Content" on page 615 or the "Create Job" on page 602 tasks.
l Move entry up: Click to move the currently selected line up in the Properties list. l Move entry down: Click to move the currently selected line down in the Properties list. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the "OL Connect preferences" on page 773. Note Defaults are not used unless the configuration is sent to the Workflow service.
Input The current Job File is not used by this task. In order to update values in the Connect database, the task requires that the current Metadata contains record IDs, or that the given JSON contains a JSON Record Data List (see: "Types of JSON in Workflow" on page 91). 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.
l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks. 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.
Available Output tasks l "Delete" below l End Subprocess, see: "Go Sub" on page 479 l "PReS Fax" on page 512 l "FTP Output" on the next page l "Microsoft 365 Email Output" on page 647 l "Microsoft 365 OneDrive Output" on page 651 l "PReS Image" on page 513 l "Print using a Windows driver" on page 657 l "Printer Queue Output" on page 659 l "Secure Email Output" on page 662 l "Send Email" on page 665 l "Send to Folder" on page 668 l "SOAP Client plugin" on page 654 The SFTP Output ta
Task properties General tab l Move to recycle bin: Select to send the deleted files to the Windows recycle bin. When this option is not selected, files are deleted permanently. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. FTP Output FTP Output tasks send job files to other computers using the FTP protocol.
l 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. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or PReS Workflow task. l User name: Enter an FTP server user name. l Password: Enter a password associated with the FTP server user name entered above.
Microsoft Graph in the organization’s Azure instance. It needs read access to the Users category (User.Read.All) so that the task can identify the users in the organization. In addition, to send emails on any user’s behalf, the Mail.Send permission is required. For more information on setting application permissions for Microsoft Graph, see https://docs.microsoft.com/en-us/graph/auth-v2-service. Input Any data file.
Message information Note When specifying multiple recipients for the To, CC and BCC fields, separate the e-mail addresses with semi-colons (;). l To: Enter the email address(es) of the recipient(s). l Cc: Specify addresses to which a copy of the generated emails are to be sent. l l l Bcc: Specify discreet addresses (other recipients will not be able to see these addresses) to which a copy of the generated emails are to be sent. Subject: Enter the subject of the email.
Attachments Use this tab to specify what files to attach to the e-mail. l l l l Attach input job file: Select to attach the current job file to the email that the task sends. Rename to: Check this option to rename the job file before attaching it to the email, and enter a name. File: Select additional or more additional files to include as attachments. Enter the file name, or use the Browse button to navigate and select the file.
Microsoft 365 OneDrive Output Microsoft 365 OneDrive Output tasks allows to send files to any of the organization's Microsoft 365 OneDrive accounts. This task uses the Microsoft Graph API. For this task to function correctly, Workflow needs to be granted application permissions for Microsoft Graph in the organization’s Azure instance. It needs read access to the Users category (User.Read.All) so that the task can identify the users in the organization. In addition, the Files.ReadWrite.
combination of text, variables and data selections; see "Variable task properties" on page 303. Connection l l l l Application ID: Enter the application ID provided by Azure for this specific application. This value is static and cannot contain variables. Application Password: Enter the client secret (key) for the Azure app. This value is static and cannot contain variables. Tenant ID: Enter the Tenant ID as specified in Azure. This value is static and cannot contain variables.
Processing The file is sent to the secure FTP Server and location defined in the task's properties. If the folder in which the file should be placed doesn't exist, it will be created. Task properties General Tab l Server Settings group l FTP Server: Enter the IP address or host name of the FTP server. l User name: Enter the name of a user account on the FTP server. l l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH).
l l l l Accept all certificates: Check this option to automatically accept the certificates returned by the FTP server. Otherwise, in order for a connection to work, you have to establish a connection first and then accept a certificate from the List of known servers up to the Approved server list. Approved Server list: Displays a list of servers that were approved for connection: l Server: The name of the server the certificate belongs to. l Fingerprint: The RSA fingerprint of the server.
In order to access and successfully use Web services, client applications must know how to get them, what operations they support, what parameters they expect, as well as what they return. SOAP servers make this information available via WSDL (Web Service Description Language) files.
The following three options are only available in the Legacy SOAP Client plugin: l l l l l l l l Namespace: You may choose an available namespace to prevent ambiguity between identically named elements or attributes. You may also enter a namespace directly. Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Print using a Windows driver Printing Using a Windows Driver Output tasks task lets you send a job to a local or network printer, using its own drivers. The printer does not need to be a PostScript printer. Since the printer driver itself is not necessarily PostScript, Workflow cannot optimize the print file, so this task will always generate a larger and slower print job.
l l l Properties: Click to change the current printer queue properties. Note that PReS Workflow generates the job file and hands it over with the available print options to the Windows print driver, which takes the relay for the actual printing part, so there is no way for your PReS Workflow Tool to ensure that all the settings you make will be applied to the printed document. Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used.
Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Printer Queue Output The Printer Queue Output task dispatches jobs to selected PReS Workflow Printer Queues (see "PReS Workflow printer queues" on page 111). Note that you must have created at least one Printer Queue in PReS Workflow before you can add your first Printer Queue Output task.
place the file in the destination. Sending this same file to an LPR or Windows queue will produce no output as these queues expect valid PostScript. Task properties General Tab l l Queues: Select the queues to which you want to send the output (see "PReS Workflow printer queues" on page 111). Documents: Select None if you want the job file to be printed as is.
Advanced Tab l l Copies: Enter the number of copies to be printed outputs. Since this is a variable property box, you may enter a fixed value or use a data selection. Note that load balancing options have an impact on how copies are printed as well as on the total number of printed copies. Load balancing group (Options from this group are only valid if multiple Workflow printer queues were selected.
l l Add job information to the document: Includes the current "Job Info variables" on page 703 to the job output. This option is only available if a document was selected in the General tab. Use job name as Title: Uses the Job Name set in the Workflow printer queue's General tab, as the job's title, set as %%Title in the PostScript's job. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Task properties Recipients Tab The fields on this tab are variable property fields, which means the values may change with each job at run-time. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303. Note When specifying multiple recipients for the To, CC and BCC fields, separate the e-mail addresses with semi-colons (;). l To: Enter the email address(es) of the recipient(s).
on page 598 task. Also note that it is currently not possible to send both an HTML and plain-text version of your message. Attachments Tab Use this tab to specify what files to attach to the e-mail. l l l l Attach input job file: Select to attach the current job file to the email that the task sends. Rename to: Check this option to rename the job file before attaching it to the email, and enter a name. You may use text, variables and data selections (see "Variable task properties" on page 303).
required to unlock the selected account. l Select the level of priority and sensitivity. The default value is Normal. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send Email The Send Email output task sends the data files it receives via email.
descriptions below to know what each option does. Once the contents of the file and attachments are determined, the email (including attachments) is either sent directly to the selected SMTP server, or is deposited in the "Outbox" folder of the local Microsoft Outlook account. Task properties Recipients Tab l l l l l To: Enter the email address(es) of the recipient(s).
Attachments Tab Use this tab to add the files received by this task (plus any other file that you may choose to attach) to the emails sent by PReS. l l l l l l l Attach input job files: Select to attach the file received by this task to the emails it will generate. 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.
l l l l l l l l Organization: Enter the organization name that will be used in emails sent by PReS Workflow for this task (this is optional). Email address: Enter the sender’s email address that will be used in emails sent by PReS Workflow for this task. 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.
Task properties General Tab l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303.
l "Connection tab" on page 672 l "Connection tab" on page 677 l "Advanced properties" on page 685 l "Advanced properties" on page 688 l Therefore2Way (The manual for this plug-in is provided with the plugin's installer and is not available under the Workflow Help.) DocuWare DocuWare is an Enterprise Content Management (ECM) system that is widely used in industry. It provides mechanism for storing, versioning and sharing files across an organization. See https://start.docuware.
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 53 to assist with this. If the File Cabinet specified in the text box does not exist at run time, the plugin will replace it with the first File Cabinet name on the previously extracted Cabinet list. The File Cabinet entry is case-sensitive.
Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 53). 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 Upload The DocuWare Upload plugin uploads a single file of any file type to a dedicated DocuWare CRM system with related index information.
If any issue is detected during a file upload, the log messages and the related file and its index values will be stored. The Docuware Upload plugin is designed to work offline as well as online. Once a Test Connection has been established, the Cabinet and Index data will be downloaded and stored locally. This allows authoring of Workflow configurations without requiring a constant live connection. Warning The plugin is not designed to be run in multi-threaded, multi-process or auto-replicate environments.
Password Enter the password associated with the selected DocuWare login Username. Use the password Hide/Show button to either display or obscure the password. Clicking this option will display the password. Clicking this option will obscure the displayed password. Note When the password is set via a variable, it is important to know that the password might be visible. It is the user's responsibility to protect the passwords in such cases.
File to upload This frame holds all the elements on the file which is to be uploaded to DocuWare. The plugin can upload either the incoming Job file, or a file from the file system (External file). Select either: 1. Job file: Select this option to upload the current Workflow Job file (the equivalent of using %F). 2. External file: Select this option to upload a file from the file system. Selecting this option activates the file selection input field.
"Data selections" on page 53, to assist with this. If the File Cabinet specified in the text box does not exist at run time, the plugin will replace it with the first File Cabinet name on the previously extracted Cabinet list. The File Cabinet entry is case-sensitive. Note Each cabinet has a default document name, which is configured in the DocuWare preferences. The current document name will be highlighted in the read only Document name field screen entry, whenever a new Cabinet is selected.
l Value. Add the value to apply. You can use static text and/or Workflow variables, data and lookup functions. Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 53). Note If more than one document is found based upon the selected search criteria, the update will fail. Index Data Select whatever Index fields you want to add via this index table.
l l l l Strings: String values will be uploaded to Docuware "as-is", without modifications. Strings are Unicode-aware, so that non-ASCII characters can be entered as well, like Chinese, Japanese, etc.. Numeric values: Numeric values must be entered using only digits 0-9, a preceding - or + sign and the dot as decimal separator. Any other characters are prohibited and using them will lead to an error.
Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved. M-Files M-Files is an Enterprise Content Management (ECM) system that is widely used in industry. It provides a metadata driven mechanism for storing, versioning and sharing files across an organization. See https://www.m-files.com for more detail about M-Files.
Once installed, the plugin 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. Input The input of this plugin can be any file, since it isn't used by the plugin. Processing The M-Files Download plugin starts by sending a login request to the M-Files Server.
l l l l l Document ID: Specify the Document ID. Version (optional): Specify the version of the document (at the root level of the Vault). If the version is not given, the latest version of the document will be retrieved. FileID (optional): If the file ID is not given, the first file - the root document - will be retrieved. Retrieve by Property Search: This section allows the retrieval of files by searching for specific Definition entries.
This Action plugin is not initially installed with Workflow. It is available for download on the Resource Center (help.objectiflune.com). After downloading the .PPK file, you have to import it into Workflow; see Importing a plugin. Once installed, the plugin will appear in the Document Management category in the Plug-In Bar. Note To be able to use this plugin you need a working M-Files installation and a user account with appropriate permissions. Input The input of this plugin can be any file.
l l l VaultGUID: Specify the unique identifier (GUID) for the desired Vault. This is required. The uploaded file will be stored in this Vault. File to Upload: l l l Username, Password: Enter the user name and password that the plugin can use to send a login request to the M-Files Server. The user should have the appropriate rights. Input File Name: Enter %F to use the current Job File, or specify the full file name (including its extension).
l Data Type: The ID of the Data Type of this property. Supported data types are: ID Data Type 1 Text 2 Integer 5 Date 8 Boolean l l Value: The (new) value of the property. Response: l Store response in a variable (optional): Specify a variable if you want the plugin to store the JSON response that it gets from the M-Files server. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties.
l SharePoint Foundation 2010 l SharePoint 2013 It may work but has not been certified with other SharePoint server versions. Note Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PlanetPress 7.5 and higher only. Licensing This plugin requires the OL Connect Workflow Imaging license.
Task properties General Tab Note For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab. l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files.
Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted. Domain: The active directory domain for the logon credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries.
Output to SharePoint The Output to SharePoint action task can be used to send files to an existing Microsoft SharePoint server. Example Workflow process This task is put into effect in the following use cases and example processes: l Capture Post Processing Workflow Note that Capture is only available with PlanetPress Suite. Licensing This plugin requires the OL Connect Workflow Imaging license.
Task properties General Tab l l l SharePoint Site: The name of the SharePoint site where you want to send the files. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to send the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously. Folder: The folder location in the document library where your files will be sent.
l Multiple line of text: This type may contain multiple lines of text. l Choice: This type contains the menu to choose from. l Number: This type may contain a number (1, 1.0, 100). The decimal separator is “.” in the plugin. l Currency: This type contains the currency ($ …). l Date/Time: Date/Time fields contain a date and time l l Yes/No: Yes/No (menu to choose from). If passing a variable, has to be either "Yes" or "No". Hyperlink or Picture: This type contains an html hyperlink or picture.
Email Services Email Services tasks send emails to an Email Service Provider (ESP) using the ESP's Web API. These OL Connect tasks are not initially installed with Workflow but they are available for download on the Resource Center (help.objectiflune.com). After downloading a .PKK file, you have to import it into Workflow; see "Importing a plugin" on page 873. Once installed, these tasks will appear in the Email Services category.
Installing the plugin First unzip the contents of the ZIP file and then install using the wizard. Click Yes to replace any previously installed version of the plugin. 1. Open the Workflow Configuration tool . 2. In the Plug-In Bar, click on the two black arrows with the black triangle underneath, at the bottom right area of the window pane. 3. In the popup menu, select “Import Plug-in” and select the PluginFileName file. 4.
Note Further help can be found by pressing F1 or the Help button in Connect Workflow from the “M-Files” dialog or by searching for “M-Files” in the Workflow product documentation at help.objectiflune.com Input Extra attachments To specify an extra attachment, you have to use the key/value pair "disposition":"attachment". To let the plugin know where it can find the attachment, you can either provide a full path ("url"), for example: [{"url":"file:///C:/Terms-and-Conditions.
It then transforms the files into email messages as specified by Mailjet and sends the emails via the Mailjet Web API. Output This task does not make any changes to the Metadata or the Job File. Properties General Tab l Mailjet API: l l l l l API Key and Secret Key: The API Key and Secret Key are both generated automatically when you create your Mailjet account. The plugin needs to provide them in order to authenticate its request to Mailjet's Email API endpoint.
Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SendGrid Note l l The SendGrid plugin is not installed by default. It is available for download on the Resource Center (help.objectiflune.com).
or [{"url":"http://www.example.com/image.png","disposition":"attachment"}] or a Connect File Store ID ("fileid"), for example: [{"fileid":100034, "disposition":"attachment"}] Optionally, you may provide a name ("name") to override the name that the plugin creates for an extra attachment. Examples: [{"fileid":100034,"name":"example.pdf","disposition":"attachment"}] [{"url":"file:///C:/Terms-andConditions.pdf","name":"terms.
l l l l l Data Source (see "Input" on page 699): Categories (optional): Enter a single category name (e.g. invoice) or an array of category names (e.g. ["invoice","brand1"]) for the messages. The maximum length of each category name is 255 characters. You can specify up to 10 categories per request. See About categories. Send At (optional): Enter a UNIX timestamp specifying when you want your email to be sent from SendGrid.
Unknown tasks An Unknown task is a task location that is not linked to any existing known task. Unknown tasks can have multiple causes: l l l l l Cutting an input or output task will replace it with an Unknown task. See "Cutting, copying and pasting tasks and branches" on page 874. Creating a new branch will create an Unknown output task in that branch. See "Adding tasks" on page 301. Using Branch From Here... will create an Unknown output task below that branch. See "Adding tasks" on page 301.
l l Job Infos are also specific to an instance of a process, however their use is different. Just after an initial or secondary input task, Job Infos contain information about the job file itself. They are generally used to gather information from the input task, or to transfer information to a Connect template or PlanetPress Design document. For more information see "Job Info variables" below. System variables are standard variables, created and managed directly by PlanetPress Workflow.
task. l Job infos are limited in quantity and are slowly being deprecated when transferring data to your documents. You should probably consider using "Metadata" on page 74, or local variables (see "Local variables" on page 709). Using Job Infos in a Connect template Workflow variables can be passed to a Connect template via a data mapping configuration. Data mapping configurations are created with the DataMapper module (inside Connect Designer).
System variables System variables are standard variables, created and managed directly by PReS Workflow. These variables are read-only and cannot be modified. They provide information about the job, process, and PReS Workflow environment. Available system variables Variable Name Example value when interpreted %a Job file last modified date. Format: YYYY/MM/DD 2020/08/16 %c Content of the job file in its original format n/a %F Job file path and name C:\Program Files\PReS Workflow 7\PlanetPress Wat
Variable Name Example value when interpreted %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 millisecond 24 %u Unique 13-char string (will be different every time it is used) 0ZIS4CW8U47VI00 Page 706
Variable Name Example value when interpreted %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 Metadata file name job00ZAIZ2C4FXON16CE6C566.dat.
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. The below image shows an example process and the value of %i during this process: Initial input tasks do not modify the value of %i.
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 713. 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.
1. Select the process where you want to add the variable. 2. Now you can use one of two methods: l l Click on the Home tab of the PReS Workflow Ribbon, then click Local Variable in the Variables group. Right-click on the process in the Configuration Components area, then click on Insert Local Variable. Deleting a variable l Right-click on the variable name in the Configuration Components pane and click Delete. Note Deleting a variable does not delete any reference to it.
l You can use Scripts. See the chapter "Using Scripts" on page 141. Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" on page 713). Global variables Global variables are set at the level of the configuration file and are shared between all processes and tasks. To refer to a global variable, for example in a variable task property (see: "About Tasks" on page 300), use its name preceded by "global." and surrounded by curly brackets, for example: % {global.
2. Click Global Variable in the Variables group. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To set the value of a global variable from the Configuration Components pane: 1. Double-click on the global variable in the Configuration Components pane. (Rightclicking then clicking Properties also works.) 2. Enter the new value for your global variable. 3. Click OK to save the new value.
l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 440. You can use Scripts. See the chapter "Using Scripts" on page 141. Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" below). Variable task properties When you edit tasks, you may notice that some of the properties that you can modify have a red (or more precisely, a maroon) title.
Variable properties can also be mixed, meaning you can combine, within a single variable property box, any number and order of variable types. You can, for example, do the following for an output file name: %O_@(1,1,1,30, KeepCase,Trim)_%y-%m-%d.txt. This would translate in the original file name, followed by part of the first line of a text data file, then the current date.
You can quickly identify variable information that is already present in your variable properties as such: l l l l l A percentage sign identifies system variables, as well as standard and custom job info variables — %f, for example. A backslash indicates a control character — \004, for example. An at sign (@) indicates a data selection for emulations other than database — @ (1,1,1,1,17,KeepCase,Trim), for example.
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.
Anoto Functionality Statement Statement ('Paper featuring Anoto functionnality') that is automatically placed on the page when a PlanetPress Capture field is present. The statement can also include the Trace Code Anoto Pattern A series of dots placed in a pattern that is unique to each page where the pattern is printed. The Anoto Digital Pen identifies this pattern and its location on the page.
Closed Document A document still within the PlanetPress Capture Database of which all the required fields have been filled by the Capture Field Processor from a PGC. A closed document will only remain in the database until it is retrieved with the Get Capture Document task, after which it is deleted. Contamination The act of writing on a "wrong" document, aka one that has a Pattern Sequence different that the one for which it was produced..
that of the document causes Contamination, which can cause errors or ink to be placed on the wrong document. Pen ID The serial number of the Anoto Digital Pen. It is registered in the PlanetPress Capture database and is present in each PGC file. PGC File Pen Generated Coordinates; PGC File containing all ink processed while the pen was undocked along with the Pen ID. It is possible that a single document requires multiple PGC, just as it is possible that a single PGC have multiple documents.
Warning PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently. In order to design a document with Capture Fields, you must review and understand the Critical PlanetPress Capture Implementation Restrictions.
l Microsoft Access l l l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database file (mdb) must be local to the PReS Workflow computer. It cannot be located on a network drive or another server. Database can be in any location, but performance will depend on the speed of the connection between PReS and the MySQL server.
this case. This can be fixed by configuring the max_allowed_packet setting in the MySQL Configuration (Reference). l l Also in MySQL, if a timeout occurs on simultaneous record access, resubmitting the PGC for processing should resolve the issue. In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue.
access to your PGC storage folder, they may be able to read the signatures, checkmarks and other information contained in it and reproduce them on a document of their choice. It is always better to secure this folder properly. You could also use third-party encryption software to secure the files, and decrypt them as necessary for reprocessing. l l l l The transfer between the Anoto penDirector and PReS Workflow is not encrypted due to a limitation of penDirector which does not support SSL connections.
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 577 l "Get Job Data" on page 582 l "Job Processor" on page 586 ZUGFeRD The ZUGFeRD plugin provides a way to enrich German PDF invoices with data specific to the invoice. This is done by embedding the data in a standardized XML format within the PDF itself. ZUGFeRD is an acronym for Zentraler User Guide des Forums elektronische Rechnungen Deutschland. In English this translates to Central User Guidelines of the Forum for Electronic Billing in Germany.
Plugin language The plugin is only available in German, as its application is only really relevant to documents created for the German market. Plugin usage For help on how to use the ZUGFeRD plugin, see "ZUGFeRD plugin" on page 529. Plugin Legal Notices and Acknowledgments Copyright © 2021, Objectif Lune Inc. All rights reserved. The ZUGFeRD name and logo are protected under copyright and used with permission of the Arbeitsgemeinschaft für wirtschaftliche Verwaltung e.V. in Germany. The Objectif Lune Inc.
services and system permissions, refer to Windows documentation. For more information on how to configure the account used by the services, see "Workflow Services" on page 752. 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.
instances of the PReS Fax service on your network, and have PReS Workflow send jobs to one or more of these instances. Each instance of PReS Fax can generate faxes and dispatch them from the host on which it runs, using a local faxing program, such as WinFax PRO, Captaris RightFax or Windows Fax. See "About PReS Fax" on page 744. l l l PrintShop Mail: Used to generate documents using PrintShop Mail databases and documents.
Note If you send a new configuration when PReS Workflow is paused, it will continue using the old configuration when you resume processing until you stop and restart it. See also: "Saving and sending a Workflow Configuration" on page 36. l Click Resume to resume the service after pausing it. The PReS Workflow Tool service starts performing jobs again. Users and configurations When a user opens a session on a computer, they typically need to log in.
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 791 l "PReS Fax plugin preferences" on page 792 l "FTP Output Service preferences" on page 795 l "PReS Image preferences" on page 796 l "LPR Output preferences" on page 799 l "PrintShop Web Connect Service preferences" on page 801 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 764.
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 786.
This password is encrypted within PReS Workflow server and is not saved in plain text. l Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. The service uses SSL 2.3 or TLS 1.0. Note When SSL is enabled and a user sends a query prefixed with https://, then this specific communication will be sent through port 443, which cannot be changed in Workflow.
l l Use enhanced PHP-like Arrays: Like the previous option, but in this case, the value between the first pair of square brackets is expected to consist of two parts, separated by an underscore (e.g. row_0). The first part is considered to be the element's name. All content after the first underscore (preferably an integer) will be used as index, which is given as an attribute of the element (e.g. ; also see "PHP arrays example" below).
Resulting XML Structure with 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.
l Form Data Encoding: Specifies how form data, which was sent to the web server, should be interpreted. Even though it is strongly recommended to use the element in web pages, some might use another encoding or not have the element at all, affecting the character set used by the browser to send the parameters and file names. l l System language: Sets the encoding attribute in the request XML file to the system codepage (e.g. Windows-1252).
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.
l ActiveDirectory Server: Enter the address of the ActiveDirectory Server. l Domain: Enter the domain for authentication.
The two files that you need are located here: C:\Program Files (x86)\Objectif Lune\ppnode\src\html Be careful; errors in these files can lead to unpredictable behavior! Setting the duration of the authentication When a user has logged in, that user's authentication is valid for the duration of the session. There is no option in the Workflow Preferences that allows you to set a different behavior for the duration of the authentication. However, you can manually edit the file named: C:\Program Files (x86)\O
bits is required. If an eighth bit is used, it must have a value of 0. If the data is based on the extended ASCII character set, eight bits must be used. l l l l l Parity: Select the type of parity used for error detection. The parity transfers through the serial connection as a single bit. It is used to verify that each set of data bits transfers correctly. It is then stripped away before the data file passes through the rest of the PReS Workflow process.
l Use Job Delimiters: Check this option if your Telnet input is a single stream that can contain multiple jobs. The box lets you enter one or more possible delimiters (separated by a line return), either a direct string (such as %%EOJOB) or an ASCII character (\001). For a list of ASCII characters, see http://www.asciitable.com/.
and area code, and fax number to the ones it receives from PReS Fax. If any of the values it receives from PReS Fax are empty, it uses its own default values. For example, if the data selection did not contain a dialing prefix, WinFax PRO uses its default dialing prefix. Select Dial as entered to limit PReS Fax to removing any spaces or parentheses that appear in the data selection, and sending the result to WinFax PRO. WinFax PRO dials the result exactly as it receives it from PReS Fax.
(\\servername\sharename\path\filename). This naming convention works well with Windows operating systems, Novell NetWare, and other operating systems when using a local naming system (such as the DOS naming system in Windows) would result in “File not found” error messages. l l Dialing options button: Click to set the appropriate options as required. Since these options are specific to the faxing program, refer to the faxing program’s documentation for more information.
Captaris RightFax options l l l l l RightFax Printer: Select a RightFax printer. A RightFax printer is a fax driver that makes it possible to send faxes automatically. This printer will output faxes without prompting the user for fax addressing information. For more information, refer to Captaris RightFax documentation. Activation: Click to enter activation codes for the PReS Image service installed on the same computer as PReS Workflow.
Console. l l l Interval: Select the interval (in seconds) at which the FTP service is to dispatch jobs from the ftpPut folder to the FTP sites. Back up job on error: Select to move the job file to a local folder ftpPut\error if an error occurs while sending a job via the FTP output. This folder is relative to your install folder. FTP Port: Select the port number that you want PReS Workflow to use for all FTP output tasks. The recommended port is 21 (the default setting).
log is sent to all addresses you enter in the Administrator’s address(es) text box. l l l l l l l l Error log: Select to send an email that includes the current error log to the administrator when an error occurs. The error log is sent to all addresses you enter in the Administrator’s address(es) text box. Error file: When enabled, sends an e-mail with an attachment of the offending file when an error occurs in the PReS Image output task.
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.
be running Outlook, and PReS Workflow must have access to Outlook. Outgoing emails appear in the outbox of Outlook, and is sent whenever Outlook is set to send email. l Use SMTP mail group: Check to activate this group’s options and to use Simple Mail Transfer Protocol (SMTP) to send the error messages to the administrators. Note that if you select this option, you will be required to enter information in the Name, Email address and Outgoing mail (SMTP) boxes.
Options l Protocol options group l l l l l Print banner pages between jobs: Select to print banner pages between each job processed and output from the LPR output. The banner page includes details of the job being printed, including the job file name and the user name on the host computer running the LPR output client. No source port range restriction: Select to remove any restrictions on the port PReS Workflow uses to send the job file via the LPR/LPD protocol.
l Polling interval (seconds): Select the period of time—the default is 4 seconds—for which PReS Workflow is to wait when it finishes dispatching jobs to the LPR printer queues before polling the LPR output folder again. PrintShop Web Connect Service preferences PrintShop Web Connect service preferences control the credentials to log into the PrintShop Web server. The available preferences are as follows: l l User name: Enter the user name of a valid PrintShop Web user, mostly operators.
l Editor l l l l l l l l l Auto indent mode: Select to automatically position the insertion pointer under the first non-blank character of the preceding line when you press ENTER. Insert mode: Select to use Insert mode and clear to use Overwrite mode. In Insert mode, when you enter text, existing text shifts to accommodate it. In Overwrite mode, text you enter overwrites existing text. You can also press INSERT to toggle between the two modes.
l l l l l l l l l l Cursor beyond EOL: Select to make it possible to position the pointer beyond the end of the line. Clear to prevent this. Keep trailing blanks: Select to preserve any blank spaces occurring at the end of a line. Clear to remove those blank spaces. Persistent blocks: Select to have any text you enter immediately after selecting a block of code appended to that block of code as part of the selection.
l l Tab stops: Use to set the number of spaces to advance when you enter a tab character or to set a series of tab stops. Enter a single integer to set the number of spaces to advance with each tab. Enter a sequence of two or more integers, each separated by a space, to specify tab stops. The sequence must be in ascending order. Tab stops are measured in number of space characters. For example, a value of 20 places the tab stop at the 20th space character.
l l l l Gutter width: Enter the width, in pixels, of the gutter. Use the drop-down list to select a previously-entered gutter width. Line numbers on page: Select to display code line numbers at the left edge of the Code area. If you clear both this and the Line numbers on gutter option, no line numbers appear alongside the lines of code. Line numbers on gutter: Select to display code line numbers in the gutter between the Commands and Code areas.
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 816. l " The Quick Access Toolbar" on page 881. This toolbar is customizable. l The ribbon tabs; see "The PReS Workflow Ribbon" on page 882. l "The Process area" on page 873 l "Configuration Components pane" on page 817.
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 34. 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 815.
l Delete: Deletes the process from the configuration. l Rename: Renames the process. l l l Startup: Triggers whether the process is a startup process (runs before any other process). l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties, for scheduling and error handling. Subprocesses: Displays a list of subprocesses in your configuration (see: "About processes and subprocesses" on page 124).
l l Properties...: Displays the properties, which lets you set a default value for the global variable. Connect Resources: Displays a list of PReS Connect resources that can be used in processes (see: "Connect resources" on page 39). Different resources are divided into subfolders: l Data Mapping Configurations: Displays a list of data mapping configurations used with the Execute Data Mapping task.
l l Properties...: Displays the properties, which lets you see the form information and select its default printing behaviors. Printer Queues: Displays a list of printer queues in your configuration (see: "PReS Workflow printer queues" on page 111). Right-click on a printer queue to access a dropdown menu that offers these choices: l l Insert Printer Queue: Creates a new printer queue in your configuration. Replace Printer Queue By: Replaces the currently selected printer queue with a new one.
PReS Workflow Configuration programs let you view a number of the properties associated with the PlanetPress Design documents you use, but most of those properties are set in PlanetPress Design and cannot be edited using PReS Workflow Configuration program. The Document name of printer-resident documents can be changed using PReS Workflow Configuration program simply because it is initially set using that program. The properties available via the Printer Settings tab define how documents are printed.
Printer Settings Tab l l l Trigger Type: Select whether you want a normal trigger configuration to be used, or a custom trigger that you manually enter. Custom Trigger Box (appears only when Custom Trigger is selected in Trigger type): Lets you enter the exact trigger you want to use. This trigger must absolutely be in standard postscript language.
l l Update Instances: Clicking this button brings up a dialog box that lets you manually update any document on any printer. Printer-Specific folder: This option lets you enter a manual location where the documents should reside in the printer's memory. This option is only available if the document is Printer Centric, and the Document location is either On printer hard disk or In printer flash memory.
Moving Configuration Components You can move components in the Configuration Components pane in a number of ways; see below. Note that moving a configuration component does not change the order in which the components are used. However they can affect your process if, for example, you move a local variable from one process to another and the local variable is still used in the first process.
Using the contextual menu l Right-click on the component you want to move. l Click on Cut in the contextual menu. l Right-click on the new location where you want the component. l Click on Paste in the contextual menu. Using the keyboard shortcuts l Click on the component you want to move. l Do CTRL+X (cut) on your keyboard. l Click on the new location where you want the component. l Do CTRL+V (paste) on your keyboard.
Renaming objects in the Configuration Components Pane You can rename processes, groups, and printer queues in the Configuration Components pane. Resource files cannot be renamed or modified using PReS Workflow. You can, on the other hand, change the name of printer-resident PlanetPress Design documents. Note Names cannot begin with a number. They can only contain the following ASCII characters: underscore, upper and lower case letters of the alphabet, all digits 0 through 9.
1. Click an object or group. 2. In the PReS Workflow Ribbon, go to the View tab. Then click Order in the Arrange group, and select one of the following: l l l l Move up to move the item one step up in the category or group. If the item is already the top object in the category or group, this command has no effect. Move down to move the item one step down in the category or group. If the item is already the bottom object in the category or group, this command has no effect.
Tip Groups can be copied and moved using the Clipboard and Drag & Drop; see "Moving and copying configuration components" on page 823. Grouping objects To add a group in the Configuration Components pane: l l l Select one or more processes and/or groups in the same group and choose View > Group. Right-click one or more selected processes and/or groups and select Group from the contextual menu. Select one or more processes or groups in the same group and press CTRL+G.
Expanding and collapsing categories and groups in the Configuration Components pane You can expand and collapse the Processes, Global Variables, PPD/PSM Documents and Printers Queues categories, and groups, in the Configuration Components pane. To do this, click the Expand / Collapse button to the left of the item. Deleting something from the Configuration Components pane To delete a process, document, or printer queue: l Click a process, document, or printer queue, then press the Delete key.
and check the desired Prompt on (...) deletion options. Dialogs Dialogs are either accessible from the preferences or from different parts of PlanetPress Workflow. Access Manager The Access Manager controls what rights are granted to other machines (clients and servers) on the same network. It grants access to functions such as sending documents and jobs to the server. To open the Access Manager: 1. Open PReS Workflow. 2. In the Ribbon, go in Tools > Managers > Access Manager.
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.
l Printer Name (Optional): Name and/or model of the printer. l Comments (Optional): Comments about the printer. The following buttons are available in this dialog: l Add: Brings up the Printer Activation dialog. This dialog lets you enter the information for the printer (see previous section), then click OK to save the new activation. l Delete: Removes the currently selected activation from the list. l Web Activation: Click to access the online activation manager on our website.
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 458) 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 57). This expression is editable, which allows you to customize the string returned by the Metadata selector. Tip The wildcard parameter '?' indicates that the function operates on all nodes (not just one) of a given level; see "Wild card parameter "?"" on page 54. The Enable search on multiple levels option is available when a Metadata is selected under Production information or User defined information. If it is not selected, the option flag includes NoCascade (+2).
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 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 777. 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).
Note The polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to process. l l Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked. Week of month / by date: Select the desired option for the time grid.
a given day. To activate the Time Grid, the "As soon as possible" option must be unchecked. In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not poll. Note that when multiple files are present in the input, these may continue to be processed after the period set in the time grid.
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 755).
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.
The Debug Information pane The Debug Information pane displays the current values of variables and other information useful in debugging processes (see "Debugging and error handling" on page 97). It is divided in 4 sections: l l l l Job Information: Displays the Job Info variables, as well as the job's file name, size, last edit date and presence of metadata (see "Job Info variables" on page 703). Local Variables: Displays all the variables local to this process (see "Local variables" on page 709).
Warning Deleting an expression or clearing the expression list cannot be undone! The Message Area Pane The Messages area is used in Debug mode to indicate the status of your PReS Workflow process as the sample data file is processed and used to generate output. When your PReS Workflow runs in Debug mode, the Messages area displays useful processing and error information. Messages are displayed in different colors (debug levels) in the Message area.
The Message Area will only display information while running in Debug mode. It does not display information from other running services, and will not display the log of any process running in a live configuration (submitted to PReS Workflow Service). To learn more about debugging a process, refer to "Debugging and error handling" on page 97.
Note If you select multiple objects in the Configuration Components window, some properties that are shared between those objects can be changed in the Object Inspector. Changing a property changes it for all the selected objects. The Plug-in Bar PReS Workflow offers a constantly increasing number of plugins, while always allowing third party plugins to be installed and set up to be used by PReS Workflow.
l OL Connect; see "OL Connect tasks" on page 591. l Document Management; see "Document Management tasks" on page 669. l Outputs; see "Output tasks" on page 644. Note An Uncategorized category is dynamically created if your PReS Workflow finds any plugin that would not be part of the existing Plug-in Bar. User-defined plugins and third party application plugins fall into such a category.
l Revert to the default Plug-in Bar by selecting Reset to default. Custom plugins will be moved to the "Uncategorized" category. Importing a plugin 1. Click on the popup control ( ). 2. Click on Import Plugin. 3. Browse to the location of the plugin DLL file or PPK file. 4. Select the desired file type: .DLL or .PPK. 5. Select the file and click on Open. Plugins downloaded from the Resource Center will be placed in the appropriate category in the Plug-In Bar.
l "Adding tasks" on page 301 l "Adding a branch or condition" on page 137 l "Cutting, copying and pasting tasks and branches" below l "Disabling tasks and branches" on page 876 l "Editing a task" on page 302 l "Moving a task or branch using drag-and-drop" on page 877 l "Replacing tasks, conditions or branches" on page 879 l "Removing tasks or branches" on page 878 In the Process area you can also: l "Undo a command" on page 881 l "Redo a command" on page 878 l "Highlight a task or branc
1. In PReS Workflow Process area, select the task or branch you want to copy and paste. 2. From the Home tab in the Ribbon, choose Copy (or right-click and select Copy from the drop-down menu). 3. To paste the task or branch to a different process, select that process. 4. Select the task or branch crossing above which you want the task or branch to be pasted. 5. From the Home tab in the Ribbon, choose Paste (or right-click and select Paste from the drop-down menu).
Copying the On Error Properties of a task or branch Instead of pasting all properties, you can paste only the properties of the On Error tab of any task or branch on another one: 1. Copy or cut a task or branch from which you want the On Error properties. 2. Select the task or branch where you want to paste the On Error properties. 3. From the Home tab in the Ribbon, choose Paste On Error (or right-click and select Paste On Error from the drop-down menu).
l l When a task is disabled, it is not executed when the process is run in Debug mode (see "Debugging your PReS Workflow process" on page 105) or by the PReS Workflow Service. When a branch is disabled, the whole branch including the tasks inside that branch is ignored and not executed. In the case of conditional branches, this means that the tasks appearing on the True side are not executed. A task, branch or condition that was previously disabled out can be re-enabled at any time.
1. In the PReS Workflow Process area, click the icon of the task or branch you want to move. 2. While holding down the mouse button, drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item. The dropped task or branch is moved above the item over which it was dropped. When you move a branch, all its tasks are also moved. When you move a conditional branch, all the tasks appearing on the True side of the condition are also moved.
l l l Click on the task or branch you want to delete, go to the Home tab of PReS Workflow Ribbon and click on the Delete button in the Clipboard group. Click on the task or branch you want to delete, and press the Delete (or "Del") key on your keyboard. Right-click on the task or branch you want to delete, and select Delete from the menu. When you remove a branch, all the tasks located in that branch are also deleted. When you delete a task, only that task is deleted.
Warning When you replace a task, you lose all the properties you set in this task. Resize the rows and columns of the Process area The rows and columns of PReS Workflow Process area in which tasks are located can be resized to better visualize the organization of your process. To resize rows and columns of the PReS Workflow Tools Process area: 1. In the PReS Workflow Tools Process area, place your cursor over the separator line dividing each section of row or column rulers. 2.
l l From the View tab in the Ribbon select Collapse or Expand. Press the + key on the numeric keypad to expand the Branch or Condition, or the key to collapse it. To collapse or expand all Branches and Conditions: l l Right-click the icon of a Branch or Condition or the right corner of its line, and select Collapse all or Expand all. From the View tab in the Ribbon, select Collapse all or Expand all.
Adding buttons To add a new button to the Quick Access Toolbar: 1. Locate the button you want to add in one of the tabs of the Ribbon. 2. Right-click on the button. 3. Select Add to Quick Access toolbar. Note The Quick Access Toolbar buttons cannot be moved or reordered. If you wish to reorder them, you will need to remove all the buttons and re-add them in the desired order. Removing buttons To remove a button from the Quick Access Toolbar: 1.
commands that are frequently used and convenient to keep close at hand. You can minimize the Ribbon, and choose the position of the Quick Access Toolbar, as well as the commands it displays. l You can minimize the Ribbon by right-clicking on it and selecting Minimize the Ribbon. l You can also customize the Ribbon's color scheme in the Preferences window. The PReS Workflow Ribbon has five tabs: the Home tab, the View tab, the Debug tab, the Tools tab and the Help tab.
Child/Go to Parent to move around a given process logical nodes (branches or conditions) and a Collapse/Expand, Collapse All and Expand all to collapse or expand branches and conditions in a process. l l The Debug tab includes the Data, Debug and Debug Messages groups. l l l l The Show/Hide group contains four controls to display or hide any of the four panes; the Configuration Components pane, the Object Inspector pane, the Message pane, the Debug Info pane and the Plug-in Bar.
l l l l The Document Manager button opens the " PlanetPress Document Manager" on page 766. The Pen Manager button opens the "PlanetPress Capture Pen Management Tool" on page 770. The Test Page group: l l l The Service Console button opens the "The PReS Workflow Service Console" on the next page, allowing to monitor real-time information on the configuration execution.
changed in the Comments tab. The PReS Workflow Service Console The PReS Workflow Service Console is a centralized service console and log viewer in one. You can use it to individually start and stop PReS Workflow services, as well as to view current and past log files for each service. Note The Service Console has changed greatly since version 7.4. If you are still using an older version of PReS, please see the user manual for your version instead.
To pause a service temporarily: 1. Right-click on the running service. 2. Click on Active to remove the checkmark. If the service was currently processing a file, the service will wait for this action to complete before pausing. Once paused, the service is still "started" but will wait until it is activated again before processing jobs. This is very useful if you want to receive jobs from external services (such as with the LPD Server) but not process them right away. To kill (force quit) a service: 1.
1. In the File menu, click on Open. 2. Browse to the location of the log file you want to open 3. Click on the log file and click Open. The log file is added, by name, at the end of the list of PReS Workflow services. Clicking on it opens the log file in the viewer. Right-clicking on the file brings a menu from which the log file can be refreshed, or removed from the list. The log viewer for existing log files does not refresh automatically since log files for older days do not generally change.
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 Warning: PReS Workflow is protected by copyright law and international treaties. Unauthorized reproduction or distribution of this program, via any means, in part or in whole, may be prosecuted to the full extent of the law. The license agreements for the associated open source third party components can be found in the following installation folder: C:\Program Files\Objectif Lune\OL Connect\Legal Notices This application uses the following third party components: l l l
l Hamcrest Matchers Copyright © 2000-2006, www.hamcrest.org. All rights reserved. l HyperSQL, Copyright © 2001-2010, The HSQL Development Group. All rights reserved. l l l l l l l l l l l IcoMoon. Connect uses unmodified icons from IcoMoon (https://icomoon.io/#iconsicomoon) which have been made available under the Creative Commons By 4.0 license (https://creativecommons.org/licenses/by/4.0). ICU4J 4.4.2 Copyright © 1995-2013 International Business Machines Corporation and others.
l l l l l l l l l l Logback which is distributed under the terms of the Eclipse Public License (EPL) Version 1.0. The source code for Logback can be obtained from the following location: https://logback.qos.ch/download.html Mchange Commons Java which is licensed under the terms of the Lesser General Public License (LGPL) Version 2.1. The source code can be obtained from the following location: https://mvnrepository.com/artifact/com.
l l l l l Web Services Description Language for Java which is distributed under the terms of the Common Public License v 1.0. The source code for this can be obtained from the following location: http://wsdl4j.cvs.sourceforge.net/viewvc/wsdl4j/ 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.
l Apache Commons Lang l Apache Commons Logging l Apache Commons Pool l Apache Commons Text l Apache Commons Validator l Apache Derby l Apache Felix and dependencies l Apache Geronimo l Apache HttpClient Mime l Apache POI l Apache ServiceMix l Apache Xerces2 Java Parser l Apache XML Graphics l Apache XML Beans l Barcode4j l Google Collections l Google GSON l Hibernate Validator l Jackson JSON processor l Jetty l Liquibase l LMAX Disruptor l Objenesis l OpenCSV
l Woodstox Eclipse Technology: This Software includes unmodified Eclipse redistributables, which are available at www.eclipse.org. The Eclipse redistributables are distributed under the terms of the Eclipse Public License - v 1.0 that can be found at https://www.eclipse.org/legal/epl-v10.html. VSS Java FreeMarker: This product includes software developed by the Visigoth Software Society (http://www.visigoths.org/).
(Commercial Features In Java SE Product Editions) of the Java SE documentation accessible at http://www.oracle.com/technetwork/java/javase/documentation/index.html. Further Components: l l l This product includes software developed by the JDOM Project (http://www.jdom.org/). Portions of this software are copyright © 2010 The FreeType Project (www.freetype.org). All rights reserved. This product includes software developed by JSON.org (http://www.json.org/java/index.html).
