User Guide Version 2022.1.2 Last Revision: 2022-06-01 Upland Objectif Lune 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 All trademarks displayed are the property of their respective owners. © Upland Objectif Lune. 1994-2022. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Upland Objectif Lune by any means whatsoever without the express written permission of Upland Objectif Lune.
Table of Contents Table of Contents 4 Welcome to PReS Workflow 2022.
Features About Workflow Configurations Creating a new configuration Open a PReS Workflow configuration file Saving and sending a Workflow Configuration Exit PReS Workflow Configuration program Workflow Configuration resource files Connect resources PlanetPress Design documents PrintShop Mail documents About data About documents and variable data Job file Job file names and output file names Data selections About data emulation Sample Data Metadata Working with JSON Data Repository Structure Accessing the Da
FTP Output Printer Queue Send to Folder printer queue Load balancing Associating PlanetPress Design documents and PReS printer queues Triggers Objectif Lune Printer Driver (PS) About processes and subprocesses Processes Startup processes Subprocesses Creating a process Importing processes Activating or deactivating a process Process properties About branches and conditions Converting a branch to a subprocess Using Scripts Run Script task APIs The Script Editor and XSLT Editor SOAP Server API Reference The W
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 Metadata tasks OL Connect Send OL Connect tasks Output tasks Document Management tasks Conne
Error handling Unknown tasks About variables Job Info variables System variables Local variables Global variables Variable task properties Workflow add-ons PlanetPress Capture Tasks 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 Ins
PlanetPress Document Manager PlanetPress Capture ODBC Settings PlanetPress Capture Pen Management Tool PlanetPress Capture License Management OL Connect preferences PDF text extraction tolerance factors General and logging preferences Messenger plugin preferences Preferences HTTP Server Input plugin preferences 1 Preferences HTTP Server Input plugin preferences 2 LPD Input plugin preferences Preferences NodeJS Server Input plugin preferences 1 NodeJS Server Input plugin preferences 2 NodeJS Server Input plu
Show or hide areas of the program window Combine and attach areas Resize the program window areas Change the Interface language PReS Workflow Button Options Configuration Components pane Components Area Sections 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 Compo
Categories Settings and customization The Process area Cutting, copying and pasting tasks and branches Highlight a task or branch Disabling tasks and branches Moving a task or branch using drag-and-drop Redo a command Removing tasks or branches Replacing tasks, conditions or branches Resize the rows and columns of the Process area Collapse and expand branches and conditions Undo a command Zoom in or out within the Process Area The Quick Access Toolbar Adding buttons Removing buttons Moving the toolbar The P
Welcome to PReS Workflow 2022.1 This PDF documentation covers version 2022.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 22 l "Known Issues" on page 26 System requirements These are the recommended system requirements for PReS Workflow 2022.1.
Note The NodeJS Server installed with Workflow is not supported in an x86 environment. Virtual environments PReS Workflow supports the following virtual environments: l l VMWare Environments. This includes VMWare Player, VMWare Workstation as well as VMWare ESX Server. VMWare VMotion. This means the virtual machine hosting PReS Workflow can be automatically moved from one ESX server to another in a clustered installation. l Microsoft Hyper-V/Azure infrastructure environments.
l RAM: 6GB l Disk Space:At least 10GB*1 *1: Requirements will depend upon the amount of data you process through PReS Workflow. For instance, a PostScript file containing several thousands of documents could easily take up several GBs. Recommended hardware requirements Due to its versatility, OL Connect is used for a wide variety of applications. Consequently, it is difficult to determine which hardware configuration will produce the best results for any given implementation.
l l l l The Connect Workflow module requires less RAM but fast hard drive access. It also benefits from fast multi-core CPUs, in order to run processes in parallel. The Connect Server module requires more RAM and benefits from fast multi-core CPUs. Disk access speed is less of a concern. The Connect Designer module requires more RAM and fast disk access to provide a responsive user-experience.
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.
SHOWLAUNCHPROGRAM = 0 (Do not launch Update Manager after the installation is complete) CJKFONTS= 0/1 (CJK Fonts Lib) LASERFICHELIB = 0/1 (Laserfiche Lib) ICRLIB = 0/1 (ICR LIBRARY) SP = 0/1 (Sharepoint plugin) NET40 = 0/1 (Install Microsoft .Net 4.0 redistribuable) Example The following performs a silent install of Workflow and the Image and Search modules. "c:\temp\Setup.
implications in regards to PReS Workflow. To change the service log on information, see "Workflow Services" on page 772. 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.
user, you will not have access to this mapped drive while running as a service unless you log off, and then have PReS Workflow Tools map the drive using a Run Script action inside a Startup Process. In addition, the use of network shared drives can cause issues when attempting to capture files from those locations since the notification process for folder changes on network shares may be different than that of local folders.
Component Protocol Local Port Remote Port FTP Input TCP Default1 21 Telnet Input TCP Default1 9100 (configurable) FTP Output TCP Default1 21 Email Output (SMTP mode) TCP Default1 25 Email Output (Outlook mode) TCP See Email Input (Outlook mode) See Email Input (Outlook mode) Send to Folder Windows Queue Output TCP Default1 Standard Windows file and printer sharing ports2: l l 137, 138 and/or 139 (NetBIOS over TCP/IP (NetBT)) 445 (SMB Over TCP/IP) LPR Output TCP Default or 721
SMB over TCP/IP. The operating system may use additional ports. Refer to the Windows documentation for further information. 3 If the “No source port range restriction” option is checked (recommended), see footnote 1. If the option is unchecked, the local port will be chosen from a range going from 721 to 731. 4 Contact your DBMS vendor to determine which ports are used by the ODBC driver for accessing a network database.
Workarounds l l For the Lookup in Microsoft Excel Documents plugin (found in the Connectors tab of the plugin bar): Open the original .xls file and save it with the .xlsx format. That will force the Excel Lookup plugin to switch drivers. For the Database Query plugin (found in the Actions tab of the plugin bar) and when using Excel/Access in PlanetPress Design: Change the ODBC driver used for Excel files from JET to ACE (change the Data Source).
Other known issues l l l l l l l l l l l Custom plugins cannot be permanently removed from the Plug-In Bar through the Workflow tool's user interface. Anoto Pen Director 2.8 is not supported on Windows Server 2012 and Windows 10. Using the PT-PT setting to perform ICR on AlphaNumeric fields may not work properly. If you encounter the issue, use the PT-BR setting instead, or use another PlanetPess Field in your document design.
l l l l l After the initial installation, the PReS Workflow Configuration tool may display an error message the first time you launch it if you had already sent a PReS Workflow Document to it. You can safely ignore this message, you will simply have to manually start the PlanetPress Messenger service from the Workflow console for this one time only. To avoid getting the error altogether, make sure you launch the PReS Workflow tool once before sending any document to it.
that isn't displayed. The only way to resolve this situation is to kill the PReS Workflow service. To avoid these types of issues from occurring, it is imperative that the configuration for the WordToPDF task be tested thoroughly in Debug mode prior to sending it into production. In particular, the connection to the database must be validated. l l l l l The WordToPDF task requires the default system printer to be set to a queue that uses the PlanetPress printer driver.
Basics PReS Workflow is a tool to automate the processing, distribution and printing of your business documents. Once installed on the server, it can be set up to automate all tasks related to document processing (see "Setting up the working environment" on page 22). When you're all set up, you can start using the Workflow Configuration tool, assuming that you have already done research on the processes that need to be automated. Working with Workflow implies the following basic steps: 1.
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 838.
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 631 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 779).
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 851. 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.
Importing Connect resource files Connect resource files are added by using the Send to Workflow option from the PReS Connect Designer's File menu; see Sending files to Workflow in Connect's Online Help. They can also be imported into PReS Workflow as follows: 1. Click the PReS Workflow button. 2. Choose Import, then Import Connect Content. The Import dialog box appears. 3. In the File type box, select the desired file type. 4. Navigate to the document you want to import, select it and click Open.
Note Package files are not saved anywhere. The individual resources contained within the package are extracted and placed in the folders noted above. Tip To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. Resource archives From version 8.2, PReS Workflow maintains an archive of previous versions of resources, in the following location: %PROGRAMDATA%\Objectif Lune\PReS Workflow 8\PReS Watch\OLConnect\Archive , each
You can drag-and-drop a resource on a process to add the appropriate task. When dropped on a process: l A data mapping configuration adds an "Execute Data Mapping" on page 582 task. If you agree to use the first sample file in the data mapping configuration as the process's sample data file, the process's emulation will be changed accordingly. l A Job Creation Preset creates a "Create Job" on page 559 task. l An Output Creation Preset creates a "Create Output" on page 561 task.
3. Double-click on the data file to open the data selector (see "The Data Selector" on page 862). Note Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file. Clicking Cancel instead of OK after viewing will prevent this action from being taken. Saving an attached data file to disk 1. Make sure the Connect Resources section is visible by clicking the appears. 2. Expand the document by clicking the button if it button. 3.
For information about the options in the selection list, see "Selecting a resource file in task properties" on page 307. Printer-centric printing PlanetPress Design lets you send documents to printers as well as to PReS Workflow servers. l l l If you send a document to printers only and not to any PReS Workflow server, you will not be able to see this document in the PReS Workflow Configuration program.
1. In the PReS WorkflowConfiguration Components pane, right-click PPS/PSM Documents and choose Insert > Insert Resident Document. The Add Resident Document dialog box is displayed. 2. Enter the document’s name. Note that the name you enter must exactly match the actual document name or PReS Workflow will not be able to use it on the printer or remote PReS Workflow server. 3. Click OK.
Design document. These data files appear under the document in the PPS/PSM Documents section of the Configuration Components. Setting an attached data file as a sample data file in a process The attached data file can be used as a sample data file in a process. This sets the emulation of the process ("About data emulation" on page 60) and makes it possible to debug it (see "Debugging your PReS Workflow process" on page 106). 1. Make sure the PPS/PSM Documents section is visible by clicking the appears. 2.
Metadata When a Design document uses Metadata, it can also be attached with the document. One Metadata file is generated for each data file attached to the Design document. Metadata does not appear in the Configuration Components pane but it follows the data file and can be viewed from the Metadata tab whenever the data file is viewed through the Data Selector.
l l In the Configuration Components pane, under PPS/PSM Documents, click any Design document (under PPS/PSM Documents) to display its properties in the Object Inspector. In the Configuration Components pane, under PPS/PSM Documents, double-click any Design document to display its properties in the PlanetPress Design Document Options dialog box. For a list of all properties, see "PlanetPress Design document properties" on page 841.
3. Navigate to the document you want to import, select it and click Open. The document is imported and displayed in the Configuration Components pane. This physically installs the documents to the Documents folder relative to the install folder of PReS Workflow. Tip To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. For help on importing PrintShopMail Connect templates, see "Connect resources" on page 39.
Note Null characters present in the data may not be displayed properly when using the PReS Workflow Configuration tool, and they may also be printed differently by different printers. To ensure consistency, you should consider filtering out such characters. About documents and variable data "Variable data" is data that is meant to be merged with a document or template. In PReS Connect, variable data is usually retrieved from a data file (the job file) using the OLConnect Execute Data Mapping task.
It is important to note that job files may be used as a helpful debugging resource (see "Debugging and error handling" on page 98). Job file names are generated automatically and stored in the %f system variable (see "Job file names and output file names" below). Actual data and sample data The actual data is the dynamic data captured by PReS Workflow at run-time. The sample data file is a static sampling of the run-time data (see "Sample Data" on page 70).
l l For the benefit of users who must identify files, be it in a folder or on a printer queue, consider using names that are as meaningful and as precise as possible. Some devices or applications may use file name extensions to know what to do with incoming files. Since variable properties can be entered in the boxes where you specify the folder and file names, you can use variables (see "About variables" on page 722), data selections (see "Data selections" below) and static text.
open the Data Selector (see "The Data Selector" on page 862) or Get Repository Location to open the Data Repository Manager (see "Data Repository Manager" on page 859). Note The Get (...) Value options will also open the Data Selector or the Data Repository Manager, but once selected, the value becomes static and does not change between each data page and job file. After opening a sample of the data (see "Choosing a sample data file" on page 71) and/or Metadata, you can easily make a selection.
Text-based data selections Text-based selections are used for text data files such as Line Printer, ASCII and Channel Skip emulations. The selection refers to a rectangular selection that may contain multiple lines, rows, columns on a given page. Syntax @(page number, from line, to line, from column, to column, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l l @(): Always surrounds a data selection.
l field(): Always surrounds database field selections. l Record Set Number: The data page (or "record") of the data selection. l Child Number: Line Number in the record (if there are multiple lines returned for one single record). l Field Name: The name of the field you want to retrieve. l Case Option: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent.
PDF data selections These selections are used for PDF data files. The selection refers to a specific area of any given page of the PDF by using precise region coordinates (in inches). Note that when adding a metadata field, if you perform a multi-line data selection on a PDF region, only the first line of that region will be set to the metadata field.
a task in the process. Open the metadata viewer and save the metadata file to use it as a metadata sample file in the Data Selector. Syntax GetMeta(Field Name [, Option Flags, Metadata Path]) Here is a breakdown of the syntax: l l GetMeta(): Always surrounds metadata selections. Field/Attribute Name: specifies the name of the field (or attribute, if the GetAttribute option flag is set) to retrieve (see "Metadata" on page 75).
Name Value Behavior (defaults to Page level when path argument is empty), instead of default behavior, which recursively goes up from the Page level to the Job level. FailIfNotFound 4 Raise an error and crash the job is the specified name is not found instead of returning an empty string. SelectedNodesOnly 8 Returns values from selected nodes only (i.e. ignores unselected nodes). XML data selections XML data selections are used to retrieve an element's name, value or count from an XML file.
About data emulation An emulation specifies how to interpret a data file. It is basically the method through which PReS Workflow parses and displays the data. If the emulation is set to CSV (comma separated values), for instance, commas encountered in the data will typically be considered as value separators. The way data selections are made depends on the emulation (see "Data selections" on page 53).
The Hex Viewer can be useful in helping determine the control characters that appear at the head of the data stream. (To open the Hex Viewer, select Debug > View as Hex, in the menu.) Note that you cannot add characters in a CSV. Further note that if you remove characters in a CSV emulation, you should ensure that you do not inadvertently remove field or text delimiters.
l "Database emulation" on page 65 l "Line printer emulation" on page 67 l "PDF emulation" on page 67 l "XML Emulation" on page 69 Emulations in PlanetPress Design The Data Selector in Workflow is essentially the same as the one used in PlanetPress Design. When you create a document in PlanetPress Design, you choose a sample data file and specify the emulation to use for the chosen data.
Using an ASCII file on a printer If an ASCII file gets sent to a printer (which is possible in a PlanetPress Suite solution), you need to know if your printer supports binary mode as this is the recommended mode for ASCII emulation. On printers that support binary mode, you can switch the printer to binary mode using the printer keypad or by sending the appropriate PostScript code to the printer.
Note that if a given value is used for multiple channels, the result may be different at design time, or when a PlanetPress Design document is previewed or printed. Also note that Split on FormFeed (FF) is not supported with the Channel Skip emulation in Optimized PostScript Stream mode or when printing using a Windows driver. Note Channel skip emulation is only used when merging line printer data with a PlanetPress Design document.
of a record. The process reads the data stream one line at a time and puts each field of the database record on a separate line in the data page buffer, until the buffer is full. You can force a new data page for each record when you set up the emulation. Note that a double text delimiter within a field is not considered a normal character when not using the Optimized PostScript Stream option or when printing using a Windows printer driver.
When generating output from the design tool (which is the Designer in Connect, or Design in PlanetPress suite) one can open the document and then use the Data Selector to select a database. By making a connection to the database, its structure can be accessed and it becomes possible to determine how data is to be pulled into the document. In a Workflow process, the database query has to be performed automatically. This can be performed by the "Database Query" on page 396 Action task.
Note for PlanetPress Suite users: For information about setting up a database emulation in a Design document, please see the relevant page in the PlanetPress Design User Guide. Line printer emulation Line printer emulation tells the process to treat the input data as data destined for a line printer. In this emulation, a form feed signals the end of a data page. If no form feed occurs in the data stream, the emulation adds lines to the data page buffer until the buffer is full.
PDF emulation options The PDF emulation does not have any options - that is, there is nothing to set up when opening a PDF data file. In the Preferences there is a number of options that affect how words, lines and paragraphs are detected in the PDF when creating data selections. You will find these options when you select Workflow > Preferences > PDF Text Extractor. For more information see "PDF text extraction tolerance factors" on page 794.
l l l l l Lines per page: Enter the number of lines each data page contains, or use the spin buttons to increment or decrement the value. A higher value means more lines will be displayed on each data page. Note that increasing the value for this setting increases the amount of RAM used by the application and may exceed the system’s capacity. Since the Show used cells option also uses up some RAM, consider removing this option (see "Data Selector display preferences" on page 867) to reduce system load.
Note Characters referenced using the ϧ syntax are limited to values ranging from 000 (�) to 256 (Ā). Note When XML data is merged with PlanetPress Design documents on a printer DOCTYPE and ENTITY tags are ignored. XML emulation options l Cache XML data: When this option is selected, PReS Workflow Server only reloads the data if the size or modified date of the XML file changes.
Choosing a sample file sets the process's emulation to the chosen format (see "About data emulation" on page 60). The only other way to change a process's emulation is by inserting a "Change Emulation" on page 387 task in it. Changing the emulation is particularly important if you want to make a data selection in a file after it has been converted to another format or when the job file has changed (see "Data selections" on page 53).
1. Expand the relevant resource files folder (Connect Resources or PPS/PSM Documents) by clicking the button. 2. Expand the file by clicking the button. 3. Right-click on the data file, then click Set as sample data file or simply double-click on the data file. For example, to use a sample data file included in a Connect data mapping configuration: select Connect Resources > Data Mapping Configurations > [your data mapping configuration], right-click a data file and choose Set as sample data file.
l ODBC Data Source: In ODBC Data Source, click to connect to an ODBC Data Source. Use the Select Data Source dialog box that appears to select an existing Data Source or set up a new one. When you exit the Select Data Source dialog box, the Database box updates to display the connection string it uses to connect to the database, and the Table/query name box updates to reflect the tables and queries available in the selected database.
Entering an SQL query 1. In the Database Connection dialog box, click Edit SQL. 2. If necessary, click Show Tables to display, in the Tables area, a list of the tables available in the database. 3. In the SQL Query Entry area, enter the SQL query. The following two sample queries both retrieve all the fields in the Orders table. The second sorts the resulting records on the Date field. SELECT * FROM [Orders] SELECT * FROM [Orders] ORDER BY [Date] 4.
Metadata Metadata is a hierarchical structure describing a job. Simply put, Metadata is data about data or, in other words, information tagged to data. Depending on the type of job, the Metadata includes information about the job, the data file, items in the Connect database, a PlanetPress Design document, 'User defined information' (sometimes created by regular tasks) and in some cases page properties and page counts. Some of the Action and Output tasks produce, alter, or use the Metadata.
l l l Job: A file that contains one or more groups. Group: A logical and ordered group of documents (ex: all invoices for a specific customer number; all documents going to the same address, etc.). Document: A group of one or more ordered data pages intended to the same recipient from the same source (ex: invoice). l Data page: One atomic unit of content that produces zero, one or more pages. l Page: One side of a physical paper sheet. When Metadata is produced for a given job, a hierarchical (i.e.
Note: Metadata in OL Connect jobs In PlanetPress Suite, all levels in the Metadata hold information about an actual job. In Connect, that isn't the case. The Metadata file created and maintained by OL Connect tasks looks the same, but contains less information. Only the first three levels in the Metadata hold information about the job: Job, Group and Document. A Group has information about a record set in the Connect database and a Document has information about one record in that set.
Metadata Tools in PlanetPress Design PlanetPress Suite includes a complete set of Metadata-related functionality, which can be referred to as Metadata Tools. These tools can be used to generate Metadata, retrieve or define Metadata elements, and build the Metadata structure of a PlanetPress Design document. For information about these tools see the Design user guide: PlanetPress Design 7.6 User Guide.
l l l l l l "Run Script" on page 465 tasks can modify Metadata using the "Metadata API" on page 197 (see "Using Scripts" on page 141). "Create PDF" on page 392 has the option to reset your Metadata according to the new PDF file. "OL Connect tasks" on page 545 can add information, such as record IDs, a record set ID or a print job ID, to the Metadata. They put it under 'User defined information' on the Job, Group or Document level.
page 619). l The "Create PDF" on page 392 task also takes the Metadata into account. Output issues caused by Metadata, and how to avoid them A Branch, Loop (the "PDF Splitter" on page 449, for instance, or the Loop task) and Condition don't reset the Metadata. This can cause confusing issues if they are used in combination with a task that takes the Metadata into account.
l l l l l l Step 2 splits the PDF whenever it encounters a new Invoice Number on the Top Right corner of a page. From this point on, the rest of the process applies to each split (i.e. each invoice). Step 3 checks if the first page is a separator (presumably by looking for some kind of keyword on the page). If a separator page was found, step 4 creates Metadata for the split PDF… ...
l l l The process moves back up to Task 2 in order to process the second split of the original PDF. The Metadata file still exists in the process! So far, it doesn't impact the rest of the process… but wait… Let's say in step 3 no separator page is found on page 1 of the second split PDF. Step 7 prints that second split PDF… but page 1 is unselected in the Metadata (because the Metadata was carried over from the last split!) so at the very least, you will be missing one page.
Metadata Attributes reference An Attribute is a read-only, system-defined element which holds certain information about a certain node in the "Metadata" on page 75 structure. This information can be static (e.g. the size of a physical page) or evaluated on-the-fly (e.g. the number of documents in a group). Attributes are non-repetitive (i.e. name is unique) and do not persist through Metadata recreation.
In the following table, the last 5 columns indicate at which level the corresponding attribute is available. This also depends on the type of job, however. Note In the Metadata file created for an OL Connect job: l l Only three levels are filled with actual data about the job: Job, Group and Document. Only Index and Count attributes are used. Attribute Description Categor y Jo b Grou p Docum ent DataEncoding (optional) Name of the character encoding.
Attribute Description Categor y Jo b Grou p Docum ent Title Title of the source document. Producti on X X X Producer Name of the software that created the Metadata. Producti on X X X Creator Name of the software that created the source of the Metadata. Producti on X X X TargetDevice Name of the device for which the Metadata and associated data is intended.
Attribute Description Categor y point values separated by a colon indicating the media size in typographical points (ex: 612:792). g Orientation "Rotate0", "Rotate90", "Rotate180" or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape. Finishin g Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent.
Attribute Description Categor y Jo b Grou p Docum ent Datapa ge Pag e Duplex "None", "DuplexTumb le" or "DuplexNoTu mble"; indicates a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source. Finishin g X X X X X OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedependent color of the media.
Attribute Description Index Categor y Jo b Index/C ount IndexInDocument Returns the Absolute index of the node within all the nodes under the parent Document. Index/C ount IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group. Index/C ount IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
Attribute Description Categor y Jo b Grou p Docum ent PageCount Index/C ount X X X SelectedCount Index/C ount X X X SelectedDocume ntCount Index/C ount X SelectedDatapag eCount Index/C ount X X SelectedPageCo unt Index/C ount X X SelectedIndexInD ocument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInG roup Returns the Absolute index of the node within all the selected nodes under the parent Group.
Attribute Description Categor y ob Absolute index of the node within all the selected nodes under the parent Job. ount NumCopies Indicates how many times the job is set to execute, as set when printing using a Windows driver. Index/C ount Jo b Grou p Docum ent Datapa ge Pag e X Working with JSON In online processes, it is common to send data to and retrieve data from a server. That data is often exchanged in JSON format. JSON is short for JavaScript Object Notation.
l l l l The "XML/JSON Conversion" on page 439 task converts an XML job file to JSON or a JSON job file to XML. The following OL Connect tasks accept JSON data as input: "Create Email Content" on page 554, "Create Print Content" on page 570, "Create Web Content" on page 574, "Render Email Content" on page 595, and the "Create Preview PDF" on page 565 task.
"last": "Parker" } A JSON string with references to local variables and a Job Info variable (see "About variables" on page 722): { "first":"%{first}", "last":"%{last}", "email":"%2" } A JSON string containing a local variable and various Data Repository selections (see "Data Repository lookups" on page 56): { "jobid":"%{jobid}", "account":"lookup(OLCS_jobs, account, jobid, '%{jobid}')", "datafile_name":"lookup(OLCS_jobs, datafile_name, jobid, '% {jobid}')", "pages":"lookup(OLCS_jobs, pages, jobid, '%{jobid}
{ "name":"Peter Parker", "email":"parkerp@localhostcom", "ExtraData":"foobar", "detail": [{"id":"inv123","ExtraData":"hello"}, {"id":"456","ExtraData":"world"}] } JSON Record Data List example A JSON Record Data List describes a list of data fields (as name/value pairs), a data table schema and nested data records (if any) for one or more data records. Below is an example of such a JSON Record Data List.
"detail": [{ "id": 3678078, "fields": { "ItemTotal": "2300.00", "ItemShipped": 2.0, "ItemOrdered": false } }, { "id": 3678079, "fields": { "ItemTotal": "29.99", "ItemShipped": 1.0, "ItemOrdered": "false" } }], "detail2": [{ "id": 3678080, "fields": { "ItemUnitPrice": "1150.00", "ItemOrdered": 2 } }, { "id": 3678081, "fields": { "ItemUnitPrice": "29.99", "ItemOrdered": 1 } }] } } ] Values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.detail[0].fields.
Data Repository The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes. This feature was introduced in version 8.5. The Data Repository is especially useful in situations where data needs to be kept in between processes. A few examples: An HTTP-based authentication process, once it has validated user credentials, could store session information (unique ID, user name, session starting time) into the repository.
Feature Name Description Equivalent Database Terminology bytes. KeySet A group may contain as many KeySets (rows), which contain variable data, as necessary. A KeySet is inserted using the "Push to Repository" on page 424 task. Row/Record Lookup A method of retrieving one or more KeySets from a group in the data repository.
For the Value_To_Match parameter, the single-quotes surrounding the value are mandatory even if the value is dynamic. This function may also be used anywhere else where the contextual menu gives access to it. You could, for example, use it on the General tab of the Create File task, to fill in the value of a key/value pair in a JSON string. Tip The Data Repository Manager displays, at the bottom left, the syntax used for accessing a specific value.
It is also possible to create a Repository at a custom location; see ConnectionString. Debugging and error handling This chapter touches on two subjects that are intrinsically linked, though their use is different. Debugging is the act of running through your process, either step by step or as a whole, directly from the PReS Workflow Configuration tool, in order to detect and resolve issues with your process.
Using the On Error tab Whenever an error is triggered either during debugging or when a process runs in production, the settings specified in the On Error tab of the task that generated the error will be used to determine a course of action. On Error Tab The On Error tab is common to all tasks and processes. It can be found in the"Task Properties dialog" on page 886.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PReS Workflow log file. You can use any variables available in PReS Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PReS Workflow log file.
You can have as many error processes as you can normal processes - that is, you are limited to 512 processes, subprocesses, startup processes and error processes combined. Information available in an Error process The following information is available from within your Error process when it is triggered. l A series of variables containing information about the error, the task that triggered it and the process that contained it (see below). These are "System variables" on page 724.
Variable Name %{error.errorid} The error ID, as entered in the OnError tab of the task. This is the same ID that appears in the Windows Event Viewer. %{error.errorlog} A string containing the logged error message(s) from a task. Multiple error messages are delimited by a "|" (vertical bar) character. Accessing the Logs If your process is running live in the PReS Workflow Service, you have two ways of seeing what is happening now or what has happened in the past.
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 796 and on the 'Minimal logs' option in the "Process properties" on page 874. Viewing logs for jobs that have already processed The logs for jobs that have already processed are available in the following folder: C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\Log You can access this folder more quickly by using
But if, for a given input task, you did select this option and something goes wrong and an original input file is lost or corrupted, you will have the option to use the Resubmit Job command to pull the backed up input file into the process. Granted that you have backup copies of the files polled by an Input task, you may resubmit them as required.
3. From the Task index box, select the index level to which you want the data to be sent. The index is the position in the process where you want to submit the job file. The numbers on the left in the Process area indicate the task index. 4. In the list of backed up input files, select the file you want to resubmit (see "Knowing what to resubmit" below). 5. Using the From page and To page boxes, select the data pages that you want to resubmit.
page numbers in a Connect template, please see PlanetPress Design User Guide or Connect Online Help, respectively. Debugging your PReS Workflow process After designing a process, which is to add the different tasks, branches and conditions to the process and configuring them (see "About processes and subprocesses" on page 125), you can test whether or not the process and configuration actually work.
l Any task is executed with the permissions of the user that is currently running the PReS Workflow Configuration tool. When running in Service mode, the user configured in the Configure Services dialog is used instead. If the credentials are different, a job that runs in debug mode may fail at run-time if the permissions are not available to the Service. Please see "Workflow Services" on page 772 for more details.
l l l l l l l Click on View as Text in the Data group of the Debug tab to view the current job file using a text editor (Notepad by default). Click on View as PDF to view the current job file in Adobe Acrobat if it is present (this will work only for PDF job files). Click on View Metadata to open the data selector and see the current state of the process' Metadata. Click on View as Hex to view the current job file in the internal Hex editor. Click on the Stop button to stop the debugging process.
l l l l l Step through the process in Debug mode until you reach the emulation or data change. Click on View as Text (or View as PDF if your data is PDF at this point) in the Data group of the Debug tab. In the viewer that appears, save the file to a location on your hard drive. Stop the process, and select the file you saved as your process's sample data file (see "Choosing a sample data file" on page 71).
only supported with PlanetPress Design documents, and requires that this feature be available on the printer. OL Connect print jobs There are two OL Connect tasks designed to create print output based on a Connect Designer template: the "Create Output" on page 561 task, and the "All In One" on page 545 task, which combines 4 different OL Connect tasks, including the Create Output task, within a single one.
Using a Printer Queue requires creating the appropriate Printer Queue in the Workflow Configuration tool first. In the Output to Printer Queue task, select No document to let the spool file pass through it. PlanetPress Suite print jobs In PlanetPress Suite, the printer model and settings are defined in the Design document itself (see "PlanetPress Design documents" on page 44). Print output is normally generated by an Output task that merges a PlanetPress Design document with a data file (i.e.
dispatch spool files to printer queues, you have to create queues in Workflow and set each one’s properties. Printer Queue types The PReS Workflow Configuration program lets you create four types of printer queues: l l l l Windows Output printer queues are used to send print jobs to local or network printers. See "Windows Output printer queue" on page 114. LPR Output printer queues are used to send print jobs to printers via the LPR/LPD protocol. See "LPR Output Printer Queue" on page 115.
Shared printer queue properties The options on a printer queue’s Advanced properties tab are common to all printer queues. They include the printer’s speed and any special pre- or post-job commands required for printer specific reasons. Pre-job commands are added right before the data in the data file, while postjob commands are placed at the end of the data file. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue.
Character name: Character code: Typical use in printing context: Horizontal Tab \t Adds a horizontal tab Line Feed \012 Moves to the next line Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape character New Line (CRLF) \n Goes to a new line Windows Output printer queue Windows output printer queues send print jobs to local or network pr
Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing. Commands: The list of available commands appears in this box. Select either Pre-job commands or Post-job commands in the Selected box, and double-click a command from this list to add it to the appropriate list.
l Data type: Select the proper data type. Select: l l l (f) Formatted text to interpret the first character of each line of text as a standard FORTRAN carriage control character. l (d) DVI file if the job file contains data in the TeX DVI format. l (o) PostScript file if the job file is a PostScript file. l (n) Ditroff format if the job file contains data in device independent troff. l (t) Troff format if the job file contains data in troff.
Commands box. Use the right-click menu for a list of standard printer control characters. (See also: "Frequently used printer control characters" on page 113.) Note If you plan to use an LPR output printer queue to send PlanetPress Design documents generated using the Optimized PostScript Stream option, you should not enter data selections in the Printer address and Queue name variable property boxes.
l l Active: Select to prompt the FTP client to use active mode when sending files to the FTP server. Passive: Select to prompt the FTP client to use passive mode when sending files to the FTP server. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing.
Properties General tab l l l l Folder: Enter the path of the folder to which the print jobs are to be saved. File name: Enter the name of the print jobs sent to this queue. To prevent each new file from overwriting the previous one, you should use variable names. This variable property box lets you use a combination of text, variables and data selections.
Load balancing PReS Workflow offers various load balancing options to distribute the printing load and to make the process faster and more efficient. Print jobs may, for example, be split equally among several printers, or they may be split according to each printer’s capacity and speed. Load balancing can only be used for jobs sent to Printer Queue output tasks and it only applies when multiple Workflow Printer Queues are selected.
Breaking the association between documents and a Workflow printer queue To break the association between a PlanetPress Design document and a given Workflow printer queue: l Select the document as displayed under the printer queue in question and press Delete. To break the association between a PlanetPress Design document and multiple Workflow printer queues: 1. Select the document as displayed under one of the printer queues in question and from the right-click menu choose Delete Instances.
l l When the server running PReS Workflow sends a PlanetPress Design document along with the data to the printer, it adds a trigger before the document (trigger+document+data). When the server running PReS Workflow only sends the data to the printer, because the document is already present on the printer, it adds a trigger before the data (trigger+data). PReS Workflow adds the trigger code automatically, but you may want to use custom triggers.
4. Enter a Name for the printer queue. 5. Click OK. Every new Windows printer queue using the Objectif Lune Printer Driver (PS) is shared by default. Once such a shared queue is created, end-users can install it on their own computer by going through the same steps they would when installing a new remote printer in their Operating System. By default, connecting to a shared printer will automatically result in the Objectif Lune Printer Driver being downloaded to the connecting host.
Data Capture from PReS Workflow Once a shared Windows printer queue using Objectif Lune Printer Driver (PS) is installed on both the server and the client sides, data capture can be achieved the same way as with any other Windows printer queues. 1. Open your PReS Workflow Configuration program. 2. Insert a new process. 3. Select WinQueue Input from the Plugin Bar and insert it in the new process. 4.
About Metadata Metadata files are files containing information on the job itself rather than containing the job per se. A job sent to the Objectif Lune Printer Driver (PS) creates its own Metadata, allowing users to retrieve relevant information, such as, for instance, the time and date the print request was sent and how many pages it contains. For more on this, see the Metadata documentation pages ("Metadata" on page 75).
l l Subprocesses can be called by any other process (see "Subprocesses" on the next page). Error processes can only be used in the On Error tab of a task in your process (see "Creating and using Error processes" on page 100). Self-replicating processes are in fact regular processes that replicate themselves in the background when multiple input files are received simultaneously.
Subprocesses Subprocesses are special processes that can be called by any other process. Subprocesses act exactly as subroutines in programming languages, allowing users to reuse existing processes by sharing them to the whole configuration file.
Adding a startup process You may create a startup process in two different ways. l l In the Ribbon, go to the Home tab and click the Startup Process button in the Processes group. In the Configuration Components pane, right-click on any process or the Processes folder and select Insert > Insert Startup Process. In addition, you may convert a regular process into a startup process: l Right-click a regular process and select Startup to convert the process into a startup process.
Processes can be deleted, duplicated, renamed, disabled, grouped etc. via the Configuration Components pane. For a list of all operations that can be performed on processes in the Configuration Components pane, please refer to "Configuration Components pane" on page 838. 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.
4. In the list, select the components you want to import. The PReS Workflow Configuration program lets you open and import any of the following: l l Complete PlanetPress Watch 4 to 6 configurations, as well as PReS Workflow 7 and 8 configurations. Specific processes from Version 6, 7 and 8 configurations, including their local variables. l Specific subprocesses from any PReS Workflow 7 and 8 Tools configurations. l Specific global variables from PReS Workflow 7 and 8 Tools configurations.
An inactive process will display in the Configuration components as red and strike-through. Inactive processes can be useful for designing new processes in a live configuration. As the process does not execute there is no danger of submitting it to a PReS Workflow Service. To activate or deactivate a process: 1. Right-click the process in question in the Configuration Components pane 2. Click Active to disable or enable the process. 3. Send the configuration.
Options General tab l l l l l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PReS Workflow. Startup: Select to make this process a startup process (see: "Startup processes" on page 126). This option is not available for self-replicating processes and error processes.
l Polling interval: Enter the frequency (in seconds) at which the process should verify if there are new jobs to process. The polling interval also applies to scheduled tasks that only run on certain times. For example, if your process polls every 30 seconds on a task that's only scheduled to run one hour per week, it will capture the input 120 times during that period.
l Minimal logs: With this option enabled, the process will only log its Start time and the End time (along with the Time Spent), if no error was encountered during execution of the process. In case of an error, the entire process information is logged. The Time Grid The PReS Workflow Process Options dialog box includes a time grid that lets you set exactly when you want a process to poll. The grid is composed of blocks that represent time periods on a given day.
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.
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 822.
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) containing any variable available to Watch, including data selections. Example usage: var watchDate = Watch.ExpandString ("%y-%m-%d"); "Watch.GetConnectToken" on page 164 Uses the default Connect Server host as defined in the Workflow preferences to log into the Connect Server and retrieve an authorization token. Example usage: var tokenConnect = Watch.GetConnectToken(); "Watch.
Variable Name Description Example Usage (VBScript) Example usage: var s = Watch.GetMetadataFileName(); "Watch.GetOriginalFileName" on page 168 Retrieves a string containing the job's original path and filename. Note: this filename is generally no longer available if it has been captured by Watch. Example usage: var s = Watch.GetOriginalFileName(); Watch.GetPDFEditObject Is used to manipulate PDF files using the AlambicEdit API.
Variable Name Description Example Usage (VBScript) "Watch.Log" on page 171 Writes to the Workflow log file, or the message window when in debug - can accept multiple log levels from 1 (red) to 4 (gray). Example usage: Watch.Log("Hello, World!", 3); "Watch.SetJobInfo" on page 172 Writes the value of a string to a numbered job info. Example usage: Watch.SetJobInfo(9, "Job info 9 Value"); "Watch.SetVariable" on page 173 Writes the value of a string to a local or global variable by name.
The working directory for the execution of the command line as a widestring. ShowFlags Integer value representing the flag to use during the execution of the command line. These flags have an effect on the execution window opened by the ExecuteExternalProgram procedure. Flag Effect 0 Hide the execution window. 1 Display the window normally. 2 Display the window minimized. 3 Display the window maximized. 4 Makes the window visible and brings it to the top, but does not make it the active window.
Perl $Watch->ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); Watch.ExpandResourcePath The Watch.ExpandResourcePath method expands a Connect resource file name (e.g. invoice.OL-template) to its fully qualified path (e.g. C:\ProgramData\Objectif Lune\PlanetPress Workflow\Documents\invoice.OL-template). It returns empty ('') if the resource does not exist, and will log an empty line next to the task number if logged.
Syntax Watch.ExpandString(StringToExpand) StringToExpand A regular parseable string that may contain system variables (%u, %f), user variables (%1 to %9), octal codes, and data selections. Note Workflow interprets a backslash in the regular parseable string as an escape character; JavaScript, Python and Perl do the same. This means that backslashes must be doubled when using one of those scripting languages.
Watch.Log "Current Date is: " + s, 2 Python s= Watch.ExpandString("%y-%m-%d") Watch.Log("Current Date is: " + s, 2) 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 793) to log into the Connect Server and retrieve an authorization token. Syntax Watch.
VBScript Watch.GetConnectToken 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 793), in the form of strings (host, username and password) and a number (port).
Examples JavaScript Watch.GetConnectTokenEx("localhost", 1234, "myUser", "secret"); 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.
Perl $s = $Watch->GetJobFileName; $Watch->Log("The job filename is: " + $s, 3); 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 723.) 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.
VBScript Watch.GetMetadataFileName 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.
resourcetype 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.
s = Watch.GetVariable("global.MyVariable") Watch.Log "global.MyVariable's value is: " + s, 2 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.
VBScript Watch.InstallResource "c:\myfile.ol-package" 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.
An integer between 1 and 4, specifying the severity level of the error message. Set message levels as follows. 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.
Example JavaScript Watch.SetJobInfo(3, "Job info 3 Value"); 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.
Watch.Sleep Pauses the process for the specified number of milliseconds. This can be used while waiting for something else to happen when the delay is known. Syntax Watch.Sleep(milliseconds: integer) Example In the following example, Sleep() pauses the process for 1 second (1000 milliseconds) JavaScript Watch.Sleep(1000); VBScript Watch.Sleep 1000 Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.
JavaScript var everythingOK; everythingOK = true; if(everythingOK){ Script.ReturnValue = 1; } else { Script.ReturnValue = 0 } VBScript Dim everythingOK everythingOK = true if (everythingOK = true) then Script.ReturnValue = 1 else Script.ReturnValue = 0 end if Python everythingOK = True if everythingOK: Script.ReturnValue = 1 else: Script.
For a quick start, turn to this How-to: Interacting with the Data Repository API. Warning All operations on the Repository must be performed through this API - rather than directly accessing the physical file - since the Repository's underlying file structure may change over time. This API is guaranteed to remain compatible with future versions of the Data Repository. It is used by all Workflow tasks dealing with the Repository.
set repoObject = CreateObject("RepositoryLib.WorkflowRepository") In each example in this documentation, the object repoObject is deemed having been obtained through the above call to the COM object. The default Repository is always stored at the same location (see "Where to find the Data Repository" on page 97). The ConnectionString property allows to create an instance of the Repository at another location; see ConnectionString.
Name Description you know for sure no other process is accessing the Data Repository. "ClearRepository" on page 186 Deletes all groups, keys and keysets from the repository, returning it to a blank state. Use with caution! "ClearGroupData" on page 185 Deletes all keysets inside GroupName while retaining the existing key structure. "ClearAllData" on page 185 Delete all keysets in all groups, while retaining the existing key structure.
Name Description 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. Key Methods Name Description "AddKey" on page 183 Adds key KeyName to group GroupName. KeyName must not already exist in the specified group. Note that this method only adds a key name to the group, not a key value. See "AddValue" on page 184 for information on how to set a value for a key.
Value Methods Name Description "AddValue" on page 184 Creates a new KeySet by assigning Value to the key KeyName in Group GroupName. Note that KeyName must exist in GroupName, otherwise an error is raised. See "AddKey" on page 183 for information on adding a key to a group. Upon successful completion, the method returns the ID of the newly created KeySet. "GetValue" on page 187 Performs a lookup in group GroupName and retrieves the first value for key KeyName that matches Condition.
KeySet methods Name Description "AddKeySets" on page 183 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. "GetKeySets" on page 186 Retrieves Keys values in GroupName for keysets that match Condition.
Name Description ID: integer): integer ExamplesIn 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).JavaScript/* both methods perform the same task */repoObject.RemoveKeySetByID ("Users", 10);repoObject.RemoveKeySets ("Users", "ID=10");VB Script/* both methods perform the same task */repoObject.RemoveKeySetByID "Users", 10repoObject.
AddKey Adds key KeyName to group GroupName. KeyName must not already exist in the specified group. Note that this method only adds a key name to the group, not a key value. See "AddValue" on the next page for information on how to set a value for a key. Syntax AddKey(GroupName: string, KeyName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.
JavaScript repoObject.AddKeySets("Users", '[{"FirstName": "John","LastName": "Smith"},{"FirstName": "Richard", "LastName": "Doe"}]'); VB Script repoObject.AddKeySets "Users"," [{""FirstName"":""John"",""LastName"":""Smith""}, {""FirstName"":""Richard"",""LastName"": ""Doe""}]" Inserting a row In most cases, you won't need to insert or update a row in a script, as this can be easily done through the the Push to Repository action task.
Syntax AddValue(GroupName: string, KeyName: string, Value: string): integer64 Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 176). JavaScript repoObject.AddValue("Users", "LastName", "Smith"); VB Script repoObject.
ClearRepository Deletes all groups, keys and keysets from the repository, returning it to a blank state. Use with caution! Syntax ClearRepository() GetKeySets Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all keys are retrieved. To ensure backward compatibility with versions prior to 2018.1, all keys are retrieved when the Keys parameter is left empty. It is however recommended to use an asterisk instead.
myKeySet = repoObject.GetKeySets("Users", " [""FirstName"",""LastName""]", "Gender='M'") Querying a single row This JavaScript example shows how to get one or more rows from the repository and use them in the process. The script gets 3 fields ("firstname", "lastname" and "email") from the CustomerID field. It assumes there's a local variable called %{CustomerID} set in the workflow process. var CustomerID = Watch.GetVariable("CustomerID"); var repoObject = new ActiveXObject ("RepositoryLib.
Condition may be left empty in which case the very first value found for the specified KeyName is returned. Syntax GetValue(GroupName: string, KeyName: string, Condition: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 176). JavaScript var myValue = repoObject.
"CustomerID='CURD654321'"); /* Update Values */ repoObject.SetValueByID("customers", "FormOfAddress", "Mr.", keySetID); repoObject.SetValueByID("customers", "Country", "US", keySetID); repoObject.SetValueByID("customers", "Language", "EN", keySetID); ListGroups Retrieves the list of all group names in the Repository, stored in a JSONStringArray.
Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 176). JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListKeys("Internal")); for (var Property in myList) { /* Log all key names for group Users to the console */ Watch.
VB Script repoObject.RemoveGroup "Users" RemoveKey Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised. All values for the key, in all keysets for the group, are removed. Note that when the Group contains a large number of KeySets, this operation may take a while.
Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 176). JavaScript /* both methods perform the same task */ repoObject.RemoveKeySetByID("Users", 10); repoObject.RemoveKeySets("Users", "ID=10"); VB Script /* both methods perform the same task */ repoObject.RemoveKeySetByID "Users", 10 repoObject.
Deleting a row This script attempts to delete a client from the rows, then returns "true" or "false" in JobInfo variable %9 as a response. var CustomerID = Watch.GetVariable("CustomerID"); var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var deletedCount = JSON.parse(repoObject.RemoveKeySets ("customers","customerID = '" + CustomerID + "'")); var answer = (deletedCount > 0) ? "true" : "false"; Watch.SetJobInfo(9, answer); RenameGroup Renames group oldName to newName.
Syntax RenameKey(GroupName: string, oldName: string, newName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 176). JavaScript repoObject.RenameKey("Users", "LastName", "SurName"); VB Script repoObject.
repoObject.SetValue("Users", ); repoObject.SetValue("Users", AND MaritalStatus='Married'" repoObject.SetValue("Users", AND MaritalStatus=''" ); "FormOfAddress", "Mr.", "Gender='M'" "FormOfAddress", "Ms.", "Gender='F' ); "FormOfAddress", "Miss", "Gender='F' VB Script repoObject.SetValue "Users", "FormOfAddress", "Mr.", " Gender=""M"" " repoObject.SetValue "Users", "FormOfAddress", "Ms.", " Gender=""F"" AND MaritalStatus=""Married"" " repoObject.
Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 176). JavaScript /* both methods perform the same task */ repoObject.SetValueByID("Users", "FormOfAddress", "Mr.", 10); repoObject.SetValue("Users", "FormOfAddress", "Mr.", "ID=10" ); VB Script /* both methods perform the same task */ repoObject.SetValueByID "Users", "FormOfAddress", "Mr.
Metadata API The "Metadata" on page 75 is a hierarchical structure describing the data in a job. It is composed of 5 basic levels, from top to bottom: Job, Group, Document, Datapage, and Page. There is a set of plugins that allow to edit the Metadata during a Workflow process (see "Metadata tasks" on page 514), but you can also manipulate the Metadata in your process via scripts using the Metadata API.
MetaFile The MetaFile object represents the physical Metadata file and is used to load and save the Metadata from and to the file system. It also publishes the "MetaJob" on page 200 object, which is the root node of the Metadata structure. The MetaFile object is the only object that is formally published to the user. All the other objects are obtained, directly or indirectly, through methods of this object. A standalone, empty MetaFile object can be created using CreateObject ("MetadataLib.
Job() Returns the "MetaJob" on the next page node, which sits at the top of the Metadata tree structure. "LoadFromFile(const String Filename )" below Loads a Metadata file from the file system. "SaveToFile(const String Filename)" below Saves a Metadata file to the file system. "Export(const String Filename, TExportFormat Format)" below Exports the Metadata in a non-native format. LoadFromFile(const String Filename ) Loads a Metadata file from the file system.
Format Format in which to save the file. The only value currently supported is efXml21 (value = 0), which is an XML format corresponding to the former Metadata native file format. Exceptions l EOleException: The specified export format is invalid. MetaJob Properties Name Type Description "Attributes" on page 232 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 83.) "Count" on page 218 Integer Returns the number of child nodes.
account. 0: The node is not selected. 1: The node is selected but one of its parents is not. 2: The node and all of its parents are selected. Methods Name Return type Description "Add(Integer Index)" on page 220 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 221 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 221 String Returns the value of the attribute of the specified name.
Integer Index)" on page 224 field of the specified name. "Item(Integer Index)" on page 226 Node Returns the child (node) item located at the specified index. Group(Integer Index), see "Item(Integer Index)" on page 226 Node Returns the MetaGroup at the specified index. "PageCount()" on page 226 Integer Returns the total number of pages present underneath this node. "Paste()" on page 227 Node Inserts the clipboard's content as the last child of the current node.
"SelectedPageCount()" on page 229 Integer "Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3)" on page 230 Returns the number of pages selected to be output that are underneath this node. Sorts the sub-nodes according to a number of criteria. MetaGroup Properties Name Type Description "Attributes" on page 232 MetaCollection Returns the node's attribute collection.
"Selected" on page 219 Bool Indicates whether or not the Node is set to be printed. "SelectedCount" on page 219 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 216.) "SelectedState" on page 220 Integer Returns an integer indicating whether the node is selected or not, taking its parents into account. 0: The node is not selected. 1: The node is selected but one of its parents is not.
"DatapageCount()" on page 222 Integer "Delete()" on page 223 Returns the total number of datapages present underneath this node. Deletes the node. "FieldByIndex(Integer Index)" on page 223 String Returns the specified field's value. "FieldByName(const String Name)" on page 224 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 224 String Returns the value of the N'th field of the specified name.
"Select(TSelectWhat SelectWhat)" on page 228 Selects the child nodes according to the SelectWhat parameter. The TSelectWhat type is not defined in an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use. "SelectedDatapageCount()" on page 228 Integer Returns the number of datapages selected to be output that are underneath this node.
page 218 "Fields" on page 233 MetaCollection Returns the node's field collection. "Index" on page 218 Integer Gets the index of the node in its parent. "NodeType" on page 218 TNodeType Returns the node type of the current Node. Note that the TNodeType type is not defined in an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use. "Parent" on page 219 Node Returns the parent node of the current node.
"Add(Integer Index)" on page 220 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 221 String Returns the specified attribute's value. "AttributeByName(const String Name)" on page 221 String Returns the value of the attribute of the specified name. "Clear()" on page 222 Deletes all the child nodes as well as the attributes and fields. "Copy() " on page 222 Places a copy of the node in the metadata clipboard.
the documents from all the groups into account. "Item(Integer Index)" on page 226 Node Returns the child (node) item located at the specified index. Datapage(Integer Index), see "Item(Integer Index)" on page 226 Node Returns the MetaDatapage at the specified index. "PageCount()" on page 226 Integer Returns the total number of pages present underneath this node. "Paste()" on page 227 Node Inserts the clipboard's content as the last child of the current node.
"SelectedIndexInJob()" on page 229 Integer "Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3)" on page 230 Index of the page among all the selected pages in the Job. Sorts the sub-nodes according to a number of criteria. MetaDatapage Properties Name Type Description "Attributes" on page 232 MetaCollection Returns the node's attribute collection.
page 219 printed. "SelectedCount" on page 219 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 216.) "SelectedState" on page 220 Integer Returns an integer indicating whether the node is selected or not, taking its parents into account. 0: The node is not selected. 1: The node is selected but one of its parents is not. 2: The node and all of its parents are selected.
"Delete()" on page 223 Deletes the node. "FieldByIndex(Integer Index)" on page 223 String Returns the specified field's value. "FieldByName(const String Name)" on page 224 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 224 String Returns the value of the N'th field of the specified name.
as a child node at the specified index. "Select(TSelectWhat SelectWhat)" on page 228 Selects the child nodes according to the SelectWhat parameter. The TSelectWhat type is not defined in an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use. "SelectedIndexInDocument()" on page 229 Integer Index of the page among all the selected pages in its parent Document.
"Fields" on page 233 MetaCollection Returns the node's field collection. "Index" on page 218 Integer Gets the index of the node in its parent. "NodeType" on page 218 TNodeType Returns the node type of the current Node. Note that the TNodeType type is not defined in an Active Script environment, such as the Run Script task. See the detailed reference for the numerical values to use. "Parent" on page 219 Node Returns the parent node of the current node.
"FieldByName(const String Name)" on page 224 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 224 String Returns the value of the N'th field of the specified name. "IndexInDocument()" on page 225 Integer Returns the index of this page in its parent document, taking all the pages from all the datapages into account.
l "MetaDocument" on page 206 l "MetaDatapage" on page 210 l "MetaPage" on page 213 The MetaJob is a collection of MetaGroup objects, where each MetaGroup is a collection of one or more MetaDocument objects, and so on, except for the MetaPage which does not have child nodes. Properties and methods All Node objects share a number of properties and methods that are common to all Node object types.
SelectedCount only considers child nodes that have their Selected property set to true, but also checks if their parents also have their Selected property to true. It is therefore possible that a node is selected but is not counted. The SelectedState property can be used to verify the effective selection state of a node, i.e. whether or not a node will be part of the output and, if not, whether it is because it is itself not selected or one of its parents is not.
Properties Attributes Returns the attribute collection (MetaCollection) of the current node. See "Attributes" on page 232. Count Not available in MetaPage Returns the number of child nodes in the current node. Fields Returns the field collection (MetaCollection) of the current node. See "Fields" on page 233. Index Not available in MetaJob Gets the index of the node in its parent. Returns: The index (0-based) at which the current node is found in the parent's node list.
3 Document 5 Datapage 6 Page Note In an Active Script environment, such as the Run Script task, the return value is a numerical value. However, in environments where the TNodeType type is defined, the node types are ntJob, ntGroup, ntDocument, ntDatapage, and ntPage. Parent Not available in MetaPage Returns the parent node of the current node. Selected Not available in MetaPage Indicates whether or not the node is set to be printed (see "Including or excluding nodes from the output" on page 216).
Returns the number of child nodes in the current node that are set to be output, meaning that they have their Selected property set to true, taking the parents into account. Returns: The number (integer) of child nodes that will be included in the output. If the current node and all of its parents have their Selected property set to true, this amounts to the number of child nodes that are selected. If any parent is not selected, returns 0.
Parameters: Index Specifies where in the child list to add the node. The node is inserted before the node at the specified index. In other words, the node being inserted becomes the node found at Index. To add a node at the start of the collection, use 0. To add it at the end, use Node.Count. Returns: Reference to the Node that was added. Exception: l EOleException: The value of Index is invalid. AttributeByIndex(Integer Index) Returns the value of the Metadata attribute at the specified index.
Returns: The value of the attribute as a string. If an attribute named Name is not found, an empty string is returned. Clear() Not available in MetaPage Deletes all the child nodes of the current node, as well as all of its attributes and fields. Copy() Not available in MetaJob Places a copy of the current node, along with all of its children, attributes and fields, in the metadata clipboard. Modifying the original node after the copy is made does not modify the copy in the clipboard.
Returns the number of MetaDatapage nodes in all child nodes. This methods recursively goes through all child nodes to count the total number of MetaDatapage that are contained underneath the current node. Returns: Total number (integer) of MetaDatapage nodes found under the current node. Delete() Not available in MetaJob Removes the current node, along with all of its children, attributes and fields, from the metadata structure. Warning The node being deleted is removed immediately.
0-based index of the field value to retrieve. The index of the first element is 0 and the index of the last is Count-1. Returns: The value of the field as a string. Exception: l EOleException: Index is lower than 0 or higher than Count-1. FieldByName(const String Name) Returns the value of the Metadata Field of the specified name. (See: "Fields" on page 233.) If more than one field has the same name, this method returns the value of the first one it finds, starting at the first field in the list.
Returns: The value of the specified field as a string. If an field named Name is not found, or Index is higher or equal to the number of fields named Name (in other words, you specify 4 to get the fifth but there are only three), an empty string is returned. Exception: l EOleException: Index is lower than 0. IndexInDocument() MetaPage and MetaDatapage only Returns the index of this page in its parent document, taking all the pages from all the datapages into account.
Returns: Absolute index (0-based) of the page within all the pages in the job. Item(Integer Index) Group ( Integer Index ) MetaJob only Document ( Integer Index ) MetaGroup only Datapage ( Integer Index ) MetaDocument only Page ( Integer Index ) MetaDatapage only Returns the child node located at the specified index. Parameters: Index 0-based index of the node to retrieve. The index of the first node is 0 and the index of the last is Count-1. Returns: Reference to the specified node.
Paste() Not available in MetaPage Inserts the contents of the metadata clipboard as the last child node of the current node. This removes the node from the clipboard, making it empty after the paste operation. Returns: Reference to the top node being pasted. Exception: l EOleException: The node type of the clipboard and the current node don't match. For example, trying to paste a MetaGroup in a MetaGroup or a MetaPage in a MetaDocument.
Select(TSelectWhat SelectWhat) Not available in MetaPage Changes the "selected" status of the current node as well as all of its child nodes according to the SelectWhat parameter. Parameters: SelectWhat Indicates what to select. The value swNone changes the Selected property of the current node and all child nodes to false, while swAll changes it to true. Script users: use 0 for swNone, 1 for swAll.
SelectedIndexInDocument() MetaDatapage and MetaPage only Returns the index of this page in its parent document, taking only the selected pages into account. Returns: Absolute index (0-based) of the page within all the selected pages under the parent document. If the page is not set to be output (i.e. its SelectedState is different than ssTrue), it returns -1.
Returns the number of pages under the current node that are set to be part of the output, i.e. that have their Selected property set to true, as well as all of their parents. Returns: The number of such nodes, if any. If the current node is not selected or one of its parents is not, it returns 0.
All the parameters to this method except for the first one are optional. If a Name is specified, it must be valid for every sub-node. If, for example, the specified field is not found in a sub-node, or a numeric sort is performed and one of the values is not numeric (i.e. consists of only decimal characters, no thousand or decimal separator allowed), the method will fail. If a sub-node contains multiple occurrences of fields with the specified name, only the first occurrence will be considered.
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 99).
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 766) 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 415, then use the "Delete" on page 609 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 462. 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 574 task. l If, however, the file is found, then it is loaded with the "Load External File" on page 415 task, and then deleted (for the same reasons).
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 78. Note In Connect it is also possible to group, sort and split PDF data using "OL Connect tasks" on page 545. 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 521 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 526 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 742 l "20,000 Patterns" on page 743 l "PlanetPress Capture Implementation Restrictions" on page 751 There are also 2 external tools that are used to communicate the pen's data to PReS Workflow: l "Anoto penDirector" on page 749 l "PlanetPress Mobile Application" on page 750 Creating a Capture-Ready document This is done when creating your PlanetPress Design document.
l l l l The "Error handling" on page 707, 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 699 task to do post-processing using the Capture Fields data. A "Capture-Get document" on page 717 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 720 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 703 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 770). 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 375 l "Data splitters" on page 440 l "Process logic tasks" on page 455 l "Connector tasks" on page 474 l "PlanetPress Capture Tasks" on page 735 l "Metadata tasks" on page 514 l "OL Connect tasks" on page 545 l "OL Connect Send" on page 766 l "Document Management tasks" on page 632 l "Output tasks" on page 608 l "Unknown tasks" on page 721 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 775).
Variable properties may include: l Static data. l System variables. See "System variables" on page 724. l Local and Global Variables. See "Local variables" on page 729. l Job Infos. See "Job Info variables" on page 723. l Data and Metadata Selections. See "Data selections" on page 53. l Printer Control Characters. See "Shared printer queue properties" on page 113. These are normally only used in printer outputs.
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 874.
l "SMTP Input" on page 367 l "Telnet Input" on page 371 l "WinQueue Input" on page 372 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 733. 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 874. 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).
selections; see "Variable task properties" on page 303. l Masks: Enter a single or multiple file names or use file name masks (see "Masks" on page 306). Multiple filters are separated by a semicolon (e.g. *.csv;.xls*). This is a variable property field. (See "Variable task properties" on page 303.) l Treat as regular expressions: When ticked, the contents of the Mask field are deemed to be a regular expression .
"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 874. 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.
Warning If you create a Folder Capture input task that takes any file it finds in the root folder of one of your hard disks, then PReS Workflow will try to remove all the files located in that folder, including all the system and hidden files. So when using a Folder Capture, be aware of where you are capturing. Processing Each file capture by the input is sent down through the process, one at a time.
option is ticked. The percent sign, the curly brackets and the period are all key elements of the RegEx syntax, therefore they cannot be mixed and matched with Workflow variable data syntax (e.g. %1, ${global.myvar}, etc.). Also, there is no validation of the RegEx being specified. l l l l l l l Sort files by: Select a given sorting method to prompt PReS Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order).
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 874.
Processing Folder Listing loops through the files and, for each file, generates an XML node with information about the file. Output The output is an XML file containing information about each file. If the Sub-directories option was checked, the structure of the XML also contains the folder structure as it is present on the drive. Here is a sample of the XML that is generated: C:\Samples\ invoice.
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 v2.
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 874. 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.
l l %{error.process}: the process name where the error occurred. %{error.tasktype}: the type of the failed task, can be Action, Input, Output, Printer, Comment and Branch. l %{error.taskname}: the name of the plugin (the Display Name as seen in the plugin bar). l %{error.taskindex}: the index of the task in the process (its position in the process). l %{error.errormsg}: the "Message" specified on the OnError tab of the failed task. l %{error.
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 874. l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
Input This task does not poll any location by itself. It sits there waiting for requests coming in through WSDL (SOAP communication) and, when it receives a request, runs the process and returns the last output generated by the process to the client. Processing No processing is done. The request that is received by this task is XML and it is maintained as such. Output As with the HTTP Server Input, this task has a dual-output purpose.
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 874. 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.
Processing When the job is received through LPR, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. Task properties General Tab l l l LPD queue names: Enter the queue name (or names, one per line) specified in the printer queue on the remote computer or computers. Allow empty queue names: Check this option to accept LPR jobs that don't specify a queue name.
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 l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user for which a software sending the job was logged in under.
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 874) 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.
Body C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0106HBKO3IODK3F\ 0106HBKO3IODK40.html Attachment C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0106HBKO3IODK3F\ 0106HBKO3X2KK41.pdf Attachment C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Wat
l l l l l %2 - Sender's name: Contains the name of the sender as defined by the sender himself (or, if the sender is using Exchange, by the name defined in his Exchange server). %3 - Sender's address: Contains the email address of the sender as defined by the sender. %4 - Subject: Contains the subject of the received email (may be blank). %5 - Recipients:Contains a list of the names of all the recipients of the email, separated by a semicolon (;).
l l l Tenant ID: Enter the Tenant ID as specified in Azure. This value is static and cannot contain variables. User ID: This is the user's ID or email address. This value is dynamic. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303. Use delegated permissions: Select this option to use delegated permissions instead of application permissions.
The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 874. 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.
Each file captured by the input is sent down through the process, one at a time. When the file is finished, the process goes back to the input which feeds another file down, as long as there are files in the queue. Once all the files are gone, the task polls the input folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. Note The MS Graph REST API is limited to a certain number of requests within a certain period of time.
l Masks: Enter a single or multiple file names or use file name masks (separated by a semicolon). See "Masks" on page 306. l Treat as regular expressions: When ticked, the contents of the Mask field are deemed to be a regular expression . You can specify multiple masks based on regular expressions, separating the regular expressions by a semicolon. The checkbox is not ticked by default. Please refer to Regular Expressions for more information.
Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. "Other" Tab l Job Information group l l l l l Information elements: Indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
NodeJS Server is more secure, more up to date and more standardized. For instance: l PUT and DELETE actions can be posted to the server. l The NodeJS Server can serve multiple static resources at once. l Port numbers > 9999 are allowed. l You can specify a HTTPS port separately. l l A Proxy list can be used to setup end points for redirecting requests to another server.
Connect Server Enter the credentials and protocol (either http or https) in the auth and protocol entries. Once the file has been changed, the ppNode service needs to be restarted for the change to take effect. Note Although Workflow can serve both static and dynamic resources to a web browser, it is not meant to be used as a fully featured web server as it is not built for responsiveness nor guaranteed uptime.
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.
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. 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.
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 874) 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 874. 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 617 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 l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH). l FTPS: Select if the FTP server uses FTPS (SSL/TSL) Port Number Group l l l Parse password: Checkbox to determine if the password should be parsed or used as a literal string. This option is checked by default (parsed) for backwards comparability with SFTP I/O plugin versions earlier than 1.3. Use default port: Check to use the default port used by the protocol selected above. Port number: Set to use a specific port number.
l l Passive: Select to prompt the ftp client to use the passive mode when retrieving files from the FTP server. Reset Download List: Security Tab This tab defines the certificates used to connect to the secured FTP servers. l l l l Accept all certificates: Check this option to automatically accept the certificates returned by the FTP server.
CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 874. l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
Warning Emails received through this task will not reach their intended destination if the process does not end with a Send Email Output Task, or contain the PReS Connect "Create Email Content" on page 554 task. Example In this example, the SMTP Input plugin is used to capture incoming emails data that must meet certain conditions as the subject that contains "Work to do" and the sender that contains "client@company.com ".
These files do not have the full path, but you can use the %t%O variable to get the current temporary folder where they are located. Tip Suppose we have two files named in the XML file under /ppemail[1]/@rawemail 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 l “From” contains: Select to limit those messages used by this task to those that are sent from a specific address. The address you enter in the box below can include variables and wildcards. “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.
l l %8 - Header: Contains the headers of the message (in multiple lines separated by a line return). %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.
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 "Action-EMF Converter (Windows Print Converter)" on page 695). 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).
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 396 l "Decompress File(s)" on page 401 l "Digital Action" on page 403 l "Download to Printer" on page 671 (Legacy task) l "External Program" on page 413 l "Load External File" on page 415 l "Logger" on page 416 l "Mathematical Operations" on page 417 l "Open XSLT" on page 419 l "PDF/A-3 Attachments" on page 421 l "PDF to Bitmap" on page 593 l "Push to Repository" on page 424 l "Rename" on page 426 l "Run Script" on page 465 l "Search and Replace" on pa
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.
Input Any text-based file can be used in this task, even formats that are not directly compatible with PReS Workflow. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task. Processing The appropriate changes are made to the data file (replacing text). Output The modified data file is output from this task. Metadata is not modified in any way if it is present.
l Search options group l l l Case sensitive: Select to force the plugin to match the character casing of the search string above with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Whole word only: Select force the plugin to search only for strings that match the search string from beginning to end (cannot be used with regular expressions).
l l l l At every specified occurrence: The replacement will take place every time the specified number of occurrences is reached. Specifying 2 occurrences, for instance, means that the second, the fourth and the sixth (and so on) occurrence will be replaced. All after occurrence: All occurrences of the search string will be replaced once the specified number of occurrences has been reached. Specifying 2 occurrences, for instance, means that all occurrences after the second one will be replaced.
l Portable Network Graphics (PNG) l Bitmap (BMP) Processing The task reads the image and detects the presence of the selected supported barcode types. When a barcode is detected, the data it contains is read and added to the Data Page level of the Metadata. Note This task does not recognize more than one level of the Metadata Document. This means that if you are intending to define separate documents, you should use the Metadata Level Creation task after the Barcode Scan.
Barcode types Description applications Code93 Code 93 symbology. Compressed form of Code 39. Code128 Code128 symbology. Very dense code, used extensively worldwide. Codabar Codabar symbology. Used in libraries and blood banks. Inter2of5 Interleaved 2 of 5 symbology. Used in warehouse, industrial applications. Add2 2 additional digits code for UPC-based symbologies. Used to indicate magazines and newspaper issue numbers. Add5 5 additional digits code for UPC-based symbologies.
Note The fewer barcode types are selected, the faster the plugin performs. Selecting only the expected barcodes is therefore a good practice. Barcode orientations Barcode orientations represent a barcode orientation on an image. For example, when the leftto-right option is checked, the task will try to read the barcode value assuming that the barcode data should be read in a left-to-right fashion. Note The fewer orientations are selected, the faster the task performs.
Barcode Scan task character replacement option will allow successful barcode reading of all non-printable characters in a given barcode. The value specified in the Replace non-printable character with option will be found in place of any non-printable character in the BarcodeValue and Barcode_x_Value Metadata fields, while the original barcode value (i.e. with non-printable characters) will be available in the BarcodeBase64_x_value Metadata field. This option allows only one printable replacement character.
Note If Metadata was created previously in the process, the task only adds new fields to the existing Metadata at the datapage level. Metadata fields The barcode values are stored at the datapage level of the Metadata. In the following definitions, the first 2 Metadata fields are for standard use, while the next 8 fields contain '_1_' in their name. This number represents the barcode index on the page.
Accessing a barcode value from the Workflow tool One method to access a barcode value from the Workflow configuration tool is to use a VBScript with the Open Script task, using the Watch.ExpandString command with a Metadata command as its input parameter, in between double quotes. For example, the following script line gives the value of the first BarcodeValue Metadata field of the first datapage: watch.expandstring("GetMeta(BarcodeValue[0],0,Job.Group[0].Document[0].
Processing The emulation for the following tasks is changed to the selected emulation. Output The original data file, metadata and job infos are not modified. Only the emulation is changed. Task properties Note Note to PlanetPress Suite users: The options of this task are basically the same as the Data Selector in PlanetPress Design; see PlanetPress Design User Guide.
Pages in buffer: Enter the number of data pages you want the data page buffer to contain, or use the spin buttons to increment or decrement the value. Read in binary mode (ASCII emulation only): Select to read the data file in binary mode. 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.
backslash character (thus you would enter \\). You can also specify an ASCII character using its octal value preceded by a backslash (for example, \041 is the exclamation mark character [!]). l l l l Force one record per page: Select to force a single record per data page. If you clear the selection, the document fills the data page completely, splitting a record across data pages if necessary.
stored. In this case, it compares the character in each cell in the line with the one in the new line destined for that cell. If the character in the cell is a space or an underscore, it overwrites that character with the one from the new line. If the character in the cell is not a space or an underscore, it leaves it intact. l l l Skip x lines: Use these boxes to enter any channel skip codes in your data that tell the document to skip a specific number of lines.
Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create PDF The Create PDF Action task creates simple PDF files using the default quality. It is very similar to the Digital Action task (see "Digital Action" on page 403) but is more limited. It does not contain the advanced PDF options that are offered by the PReS Image solution (see "About PReS Image" on page 765).
Output The output of this task is always, exclusively, a PDF file, optionally optimized and optionally with fresh Metadata. For the PDF values for files generated with this plugin, see "PDF Values" on page 395. Task properties General tab l l Documents: Select None to use the job file as-is. Alternatively, select a specific PlanetPress Design document if you want all the jobs to be generated with that document.
options of the generated PDF files. 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 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.
contents of the Bookmarks tab (you use data selection objects to create bookmarks in PReS) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages. 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. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l l l l Color images: l Compression: Auto l down sampling: Bicubic l Pixels per inch: 150 Security: l Allow printing l Allow changing the document l Allow content copying l Allow form filling Font: l Embed all fonts l Subset embedded fonts Open options: l Zoom factor: Fit in window l Default view: Page only Database Query The Database Query action task retrieves data from various databases to use as input data.
When adding a Database Query action task, you have two options: l l You can use static properties (properties that will remain the same regardless of the data processed at run-time). This option lets you use an Open DataBase Connectivity (ODCB) compliant data source. You can also edit the SQL statement that assembles the database table.
Workflow Database action task. l l Range group l l l Table/Query: Select the table or query containing the information you need as your input data. All: Select this option use all the records included in the database. Records: Select this option use only some of the records in the database. Indicate the range by entering the number of the first record followed by a dash and the number of the last record. To use records 50 to 75, for example, enter 50-75.
l CSV Emulation: If you selected CSV in the Output file emulation box, the following options are available: l l Text delimiter: Select the text delimiter to be used in the generated file. l Field separator: Select the field separator to be used in the generated file. l l Add a header record with field names: Select this option if you want the generated file to have a header record (a record that includes the field names only).
l l l l l l l Data encoding: Select the encoding used in the generated XML file. By default, this option is set to the default encoding of the computer used to create or edit the configuration. You may choose any encoding listed in the dropdown list or enter your own. Maximum records per page: Select this option if you want to limit the number of records per page.
l Export Config: Click to export the currently displayed properties of the PReS Workflow action task. The exported configuration can then be reused on other PReS Workflow workstations. Dynamic SQL Tab l Use dynamic values at run-time: Select to use a dynamic database connection string and / or SQL statement at run-time. Check this box to enable the options included in this group (this disables the corresponding options in the General tab).
Input This task only accepts ZIP files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself. Processing Every file in the ZIP is extracted to the specified location. If a folder structure exists in the ZIP, it is respected in the output folder. Output This task outputs the data file it received with no modification. Metadata and job files are not touched either.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Digital Action Digital Action Action tasks generate the same types of documents as generated by PReS Image output tasks (see "PReS Image" on page 493). Since Digital Action tasks are not Output tasks, the documents they create are typically passed on to the following task. The image files they generate are always saved, along with their index files (if any), to an archive folder.
Note For an explanation of how to generate specific tags and indexes for the Image and Digital Action tasks, in a PDF/VT file created with Connect, see the Connect Online Help: Generating tags for Image output. Alternatively, select a PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections.
independent format. It is used in many digitizing projects as the format of choice for the digital masters. The TIFF Group 3 and Group 4 formats are efficient for document storage. l l l l l l VDX: The output will be a VDX file, which is a PDF file with some PPML code inside of it to enhance performance by doing caching/image reusing. The output can only be used on devices that support the VDX technology. DPI: Enter the dots per inch (dpi) resolution of the output image.
l l l l Folder and filename: Enter the path of the folder to which output files generated by this task are to be archived. PDF index files (PDI and XML) are also put in this folder. This edit box is enabled when the Save a copy option is selected. To prevent each new file from overwriting the previous one, you should use variable names. As with any variable property box, you can use any combination of text, variables and data selections.
l Job options: Select the PDF output option that best describes your needs. This loads all the standard settings for the selected usage scenario. These settings can be changed as required. Note that if you make changes and then select a different output option, your changes will be lost. PReS Image supports numerous PDF standards: Standard, High Quality, Custom, and a variety of PDF/VT, PDF/A and PDF/X formats.
l l 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.
compression will by default be set to use the Flate compression method. l l l Grayscale down sampling: Select the down sampling option. down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels. The Grayscale resolution you enter in the following box is used to control the down sampling process. Select None to prevent grayscale down sampling .
l l Color resolution: Select the resolution to use for color images. Note that this setting has an impact on the color down sampling process. Security group l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files.
l Initial view group l l 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. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages.
in PReS) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages. 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 Enforce global table creation: Select this option, as it ensures that all database users are granted access to the database. This option is available only when you select SQL database in the Database type box. 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.
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. Each parameter should be enclosed in quotation marks and separated by a space ("Param1" "Param2" "Param3") except command line options (such as -f, /n). The exact parameters accepted are unique to the executable and defined in its documentation if it exists.
l l l 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. Return: Use the drop-down to select whether this exit code should define a success or a failure of the external program. If "Failure" is chosen, exit codes that match the condition set will cause the On Error tab to be triggered and any other exit code will be considered a success.
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.
Task properties General tab l l l Level { APPLICATION | SYSTEM | WORKFLOW }: Specifies the name of the event log in which the event will be created. Type { SUCCESS | ERROR | WARNING | INFORMATION }: Specifies the type of event to create. Source Name: Specifies the source to use for the event. A valid source can be any string and should represent the application or component that is generating the event (e.g. PPWorkflow). l EventID: Specifies the event ID for the event.
Input Any active data file, in any format. This data file is ignored by the task and is not modified in any way. 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.
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.
Task properties General tab l l Group: Use the drop-down to select into which group the KeySet is inserted, or in which group the KeySet should be updated. Key set: Displays a list of keys for the selected group. l l l l l l l Key: Displays the key name in the group. Value: Enter a value for the key, which will be inserted in the KeySet. This value can be dynamic, including data selections, metadata selections, variables and other data. Update: Check to update the key with new data.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Rename Rename action tasks are used to rename the job files they receive. Note that you can see how each file is renamed via the Object Inspector when stepping through a process in Debug mode. Input Any job file, in any format. Processing The task renames the job file to the desired name, and changes the value of %f and %F to reflect the new name.
The Run Script task can be used either as an Action or a Condition. When dragging and dropping a Run Script task on a given process, you select whether to use this task as an Action or a Condition from a contextual menu. (See also: "About branches and conditions" on page 137.) For more information on scripts, what languages are supported and how to write scripts and conditions, please see the related chapter, "Using Scripts" on page 141. Input Any data file, in any format. Processing The script is executed.
l Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l l Delete: Delete the current selection (only available if there is selected text in the editor). Select All: Select all of the contents of the editor. l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog.
l Script filename and path: Either the full path of the script, or click the Browse button to navigate to the file. This option is only available if you choose external script file in the Script running from option. Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties.
Processing The appropriate changes are made to the data file (replacing text). Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General Tab l l l Find: Enter the string of data for which to search. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303. Replace with: Enter the string of data to use as a replacement.
Send to Folder Send to Folder Action tasks send the files they receive to a local folder. They perform the same function as Send to Folder Output tasks, with the only difference being that in this case PReS Workflow will wait for the task to be completed before going on to the next task in the configuration. Note As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources.
it, PReS Workflow will append the content of the new file to that of the existing file. This appending process will go on until the file is removed from the folder. l Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected. 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 Value: Enter the value that you want to associate with the selected Job Info variable or custom variable. l button: Adds a new line and lets you define the variable and value to set. l button: Removes the line that is currently selected (highlighted). l button: Moves the line up so it is processed before. l button: Moves the line down so it is processed after. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
To configure a given SOAP Client plugin task in the PReS Workflow Configuration program, you must first get its WSDL file (note that you cannot download the WSDL file over an HTTPS connection, so you should use an HTTP connection to get the file and then switch back to a secure connection). This lets you know which services the SOAP server provides, as well as each service’s methods and name spaces.
l l 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. Method: Choose an available method from this drop-down list. This populates the Namespace box below. You may also enter the method name directly.
l Password: Enter the password for the above user name. l Allow invalid security certificate: Check to ignore SSL certificates that are invalid. 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. Standard Filter Standard Filter Action tasks can be used to remove HP Escape characters from data files, as well as to eliminate spacing problems caused by LF-CR end-of-line sequences.
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. Remove and convert HP escape characters: Select to filter HP escape character sequences from the job file. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
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. Output The data file in its new encoding format. Metadata, Job Info variables and other variables are unchanged. Task properties General Tab l l l l Source encoding: Select the current data encoding.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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. Processing The current job file is converted from XML to JSON or from JSON to XML.
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. l JSON to XML: the task only converts JSON files to XML.
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. In OL Connect jobs, data is normally extracted from a data file using the "Execute Data Mapping" on page 582 task. That task stores the extracted data in records which can then be merged with a template. Warning Splitters do not modify the Metadata that is currently active within your process.
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.
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). Field value condition: Select if you want the file to be split based on a condition set for the values of a selected database field (the value in the Order field equals 1, for example).
Pages before if you want the file to be split a given number of pages before the field that matches the set condition. Select Pages after if you want the file to be split a given number of pages after the field that matches the set condition. l l l l Split when condition is found group: Use this group if you want the condition to be met a multiple number of times before splitting the file.
Example This task is put into effect in the following example process: l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Input Any emulated data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task.
l l l l l l l l l Get: Click to go to the Data Selector and select the location associated with the Word change option. Specific word: Enter the word to use as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. You may also use the Get Data button to get a static string of characters from the sample data file.
l l l After: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines after the line on which the condition is met. When condition is found: By default, the task splits the file every time the condition is met (the default value is 1). If you want the task to split the file only when the condition has been met twice, for example, enter the number 2 in this box.
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. Page breaks on a number of lines: Select if you want start a new data page whenever a given number of lines has been counted. Enter the number of lines in the edit box below or use the spin buttons. Page(s) per output: Select if you want the file generated by the splitter to include multiple data pages. Enter the number of pages in the edit box below or use the spin buttons.
l When word is found: By default, the task splits the file every time the search word is found (the default value is 1). If you want the task to split the file only when the search word has been found twice, for example, enter the number 2 in this box. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Note The 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 80. Task properties General Tab l Split on page: Select to split the data file based on pages (rather than on a word found within the PDF data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place.
l l l l l l l Match case: Select to force the splitter to match the character casing. Note that this setting applies both to the On region change and Specific word options. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Trim selection: Select to force the splitter to strip empty trailing characters.
Document, and this value is set to 5, a 100 document job file will be divided into 5 sequences of 20 documents each. l l l The following rule: Determine if a new sequence starts or if the current one ends. For each Metadata level, the current value of the specified Metadata attribute / field is compared with the one in memory. If they are different, either a new sequence starts or the current sequence is ended. The next sequence starts with the next Metadata level being processed.
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. If you want to use your own XSLT engine, click the Alternate XSLT Engine tab. l Split method: Use this box only if you want to edit the standard XSLT script that will be used to split the XML file.
l l l l l l l Add new root node: Select this option and enter a root node name in the box to the right, if you want the generated files to have a structure that begins with a new root name and that then goes directly to the node on which the file was split, as indicated in the Split on node box below. Encoding group: This group lets you indicate whether you want the splitter to use the file’s own encoding or the universal encoding UTF8 to process the file.
parameter. When you click the buttons below, the corresponding parameters are automatically added at the current cursor position. These variables will be replaced by the correct information at run-time. l l l l XSLT file button: Click to add the {XSLTFILE} variable to the command prompt displayed in the box above. Data file button: Click to add the {DATAFILE} variable to the command prompt displayed in the box above.
A "Loop" on page 464 is a task that will cause anything after it to repeat a certain number of times. You can indicate a static number of loops or dynamically determine the number via a variable or information from your job file, and store the iteration of the loop in a Job Info variable. The "Send to Process" on page 467 and "Go Sub" on page 462 tasks are used to send the job file to another process or subprocess and, in the case of the GoSub, to get information back from the subprocess.
l "Text Condition" on page 471 l "Time of Day Condition" on page 472 Branch A Branch duplicates your job file along with accompanying information. Branches do not execute in parallel - the branch is executed, and then the trunk (or the following branch) continues. For more information about branching see "About branches and conditions" on page 137.
In case of the failure of a Branch task (the branch itself, not the other tasks contained within), by default the process will ignore the branch and simply go down the main trunk. You can overwrite this in the On Error tab. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
If the folder or file count value is invalid and the task is used as Input task, the process does not run. If it is a Condition task, it returns False. No error is generated. Output Job Information definitions When used as Input task, the File Count task sets the following Job Info variables. l %1 - FolderName. The target folder. l %2 - Mask. The specified mask. l %3 - FileCount: The specified file count.
l l File count: Select whether the condition is to check if the file count is equal to, less than, greater than, less than or equal to, or greater than or equal to the specified value. Value: Enter the desired file count. This is a variable property field. (See "Variable task properties" on page 303.) Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties.
File/Folder Condition The File/Folder Condition tasks checks if the specified file or folder exists and returns true if it exists, or false if it doesn't exist. Task properties General Tab l File or folder to check: Enter one file or folder name. The name may contain text, variables and data selections (see "Variable task properties" on page 303). The Browse button allows to select a file or folder on disk. Advanced properties Right-click the task in the Workflow process and select Advanced Properties...
Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Size Condition File Size conditions test the size of the job file they receive. Note that the job file may include data selections, attachments and documents that were added by other tasks. If a file does not exist, it's file size will be 0kb.
Every subprocess starts with a BeginSub input task and ends with a EndSub output task, both of which have nothing to configure and cannot be replaced or deleted. The simply represents entry and exit points for the subprocess. Note While it is possible to place a GoSub action within a subprocess, doing so will hide the subprocess from any GoSub action, in order to avoid circular referencing (aka an infinite loop).
Loop Loop action tasks are used to repeat those tasks that are located after it on a given process branch. The number of repeats can be fixed or variable, as required. Note The Metadata is not reset at the start of each iteration. See also: "Output issues caused by Metadata, and how to avoid them" on page 80. Task properties General Tab l l l l Number of iterations: The number of times the loop should be repeated. Every task after the Loop action task will be repeated this number of times.
Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" on page 413). However, they can be slower to execute. The Run Script task can be used either as an Action or a Condition.
l File l l l Export: Lets you save the current script as a file. l Print: Prints the current script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l l Paste: Paste the last selection that was cut or copied in the location of the cursor in the text editor. Delete: Delete the current selection (only available if there is selected text in the editor). Select All: Select all of the contents of the editor.
modifying the script in this case does not modify the external file and changes are not saved). l l Script running from: Choose if the script should be run from the editor text box, or from an external script file. Script filename and path: Either the full path of the script, or click the Browse button to navigate to the file. This option is only available if you choose external script file in the Script running from option.
In either case, the called process will ignore the input task along with its Job Info variables and schedule, and use the job file, Job Info variables, and Metadata from the current process. Note that a process called through the Send To Process plugin will not self-replicate, even if the process' preferences specify that it should. The initial Input task is being bypassed, and since it's the Input task that initiates the self-replication procedure, self-replication cannot occur.
Management Information Base Object Identifiers A Management Information Base (MIB) is a database of Object Identifiers (OIDs) that can be used to monitor device objects using SNMP. An MIB OID can point be a printer tray, cartridge or hard disk, or to modem mode. Using an SNMP condition, PReS Workflow can communicate with a device located at a given IP address and request the status of the object identified by a given MIB OID number.
l l Printer Queue group (displayed when Printer Queue is selected in the Condition Type box) l l l l Condition type: Select Printer Queue to test a standard printer status condition or User Defined to test a status identified using a printer specific identification code. Bear in mind that the failure to comply with any of the test conditions selected below will make the whole condition False. Printer status: Select Idle or Printing to test whether the printer is currently idle or printing.
Text Condition Text Condition tasks can be used to perform two different types of tests: l l To test the presence of a string within the job file. You can, for example, search for the string “Gold member” on the first line of the job file. As another example, you could search for a variable string retrieved via a job info variable or a data selection in a given location in the job file. To compare two strings. As with the test above, this test can also be used to search for a string in a given location.
comparison. If you chose an operator that compares numeric values, you should select this option. l l l l l l On numeric error: This option is only available when the Numeric comparison option is selected. Select the behavior you prefer when PReS Workflow is unable to successfully perform a numeric comparison. Select ”Return the error”, if you want the Text condition to fail altogether. Select ”Return true”, if you want the condition to be considered True.
The Time of Day Condition differs from the process schedule in the fact that you could put this condition after generating some output, and you can also run tasks when the condition itself is false, which is not the case for a process outside of schedule. You can choose contiguous as well as separate time blocks as required. The condition is tested True every time the current time and date corresponds to a selected time block.
Connector tasks A Connector, as the name implies, is a task that connects to something outside of PReS Workflow itself. In some cases those are other parts of the PReS Workflow, but in other cases we offer connectors for third-party applications or systems.
Processing This task connects to a Capture OnTheGo Repository and requests removal of a document with a given document ID. The protocol used is SSL 2.3. Output When used as a Condition task, the success of the delete operation determines whether the task returns True or False. Task properties General Tab The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document.
Input from SharePoint The Input from SharePoint task can be used to retrieve files from a SharePoint server on your network, filtering on your template fields and creating Metadata to use in your process. When the Input from SharePoint task runs, it first lists all of the files to download then runs the process once for each file in the list. If any new files are added during the process, they will not be touched until the next time the process is scheduled.
Input Any data file present on a SharePoint document store, even those not compatible with PReS Workflow emulations, and the properties of these files. Processing The task connects to the selected Document store and retrieves a copy of files according to the specified rules. The files may be deleted or marked as checked out depending on the options selected, otherwise they are untouched. Output The output to this task is a series of individual files, one after the other.
l l l Download files from sub-directories also: Check to also look into subdirectories of the specified Folder. Do not download checked out documents: If the document is set as "Checked Out" in SharePoint, it will be ignored. Action Group l l l Download the document: Simply download the document and do not modify it in SharePoint. Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint.
CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 874. 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.
Processing A connection is established with the Laserfiche server, the file is uploaded and the metadata in the Laserfiche server is generated correctly. Output The output from this task is the specified file along with the metadata within the Laserfiche server. The file is not directly modified by this task. Task Properties General Tab l Laserfiche configuration group l l Folder: Enter the Laserfiche client repository folder where the documents will be exported.
files. l l If the PReS Image archive folder field is empty and the option “Use PReS PDF/A” is selected, a warning message will be displayed: "You should insert PReS Image archive folder source". The indexes in the PlanetPress Design document must match the ones in the Laserfiche server. Connection Tab l Server Name: The server name or IP address of the server you wish to connect to. l Repository: The name of the repository you wish to send the files to.
l l If you intend to use PDI for number type, your decimal separator in both your Regional and Language Options and in PReS Index (PDI) numbers should be a dot ("."). The Laserfiche output task will only work if an activated PReS Image is found, either locally or on the network. Lookup in Microsoft® Excel® Documents The Lookup in Microsoft® Excel® Documents action task is used to complement your job file's Metadata by retrieving data from a Microsoft® Excel® spreadsheet on your system.
Use Case 2: Translate a list of line items descriptions into a given language A PlanetPress Design document takes as input a transactional PDF file, and reproduces it exactly as it enters. Metadata fields called ItemDesc are created, one for each line item description, at the data page level. Each ItemDesc Metadata field is given the value of a line item description as found on a region of the current data page.
l Metadata group l l l Lookup Field: The name of the Metadata field that will be used to determine which row should be returned. The Metadata field can be on any level. Lookup Column: The name of the column in the Microsoft® Excel® worksheet that corresponds to the contents of the Lookup Field. Action: What to do with the resulting data from the Microsoft® Excel® worksheet. This can be: l l l l l l l Add Field: Creates a new field with the data. This may cause multiple fields to be created.
Output to Capture OnTheGo The Output to Capture OnTheGo task sends document information to the Capture OnTheGo online repository. These documents can then be retrieved by the Capture OnTheGo mobile application. This task can be added as an Action task (see "Action tasks" on page 375) or as an Output task (see "Output tasks" on page 608). Adding it as an Action task enables the process or branch to continue after this task. An Output task is always located at the end of a process or branch.
Deposit Tab In the Deposit tab, you enter information regarding the document you are making available to Capture OnTheGo users. l Document to Publish group: This is where you specify the document location and type. It is mandatory to enter valid information in all the boxes included in this group. l l l l File Type: Select the appropriate document type. HTML for forms that users can fill out, and PDF for documents users can read.
then click the button marked with an X. l l Categories: Enter at least one valid Capture OnTheGo document category in this box. Capture OnTheGo documents are listed by categories (Reference, Delivery bills, Satisfaction Polls, for instance) on Capture OnTheGo app. These categories are typically managed via the Capture OnTheGo Repository Management page. Note that there cannot be any spaces before or after each category name and that the names are case insensitive.
user's device). l l l l Until: If you want the document to remain in the repository until a given date, select this option and enter a date in the corresponding box (the date format must be “YYYY-MM-DD” - note that you can use the date picker). The date entered corresponds to the last day of validity (the document is valid until 11:59:59 PM on the date you entered). If you leave the box empty, the document will not be removed from the repository based on this setting.
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. 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 765 and "About PReS Fax" on page 764.
l l 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. You can click the Browse button to display your folder structure. In the Browse Folders dialog, click on the folder you want to use and click OK. l Force folder creation: If the folder does not exist, it will be created.
l l l Date/Time: Date/Time fields contain a date and time 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. Note Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PReS Workflow 7.4 and higher only. Connection Tab l l l l Server Name: The name of the SharePoint server.
given computer (See "PReS Fax plugin preferences" on page 812). Note that those options are specific to each PReS Fax installation and that they are immediately applied. Input Any data file with a valid emulation (see "About data emulation" on page 60). Metadata is optional and can be used to specify the fax number and information to send the file. Alternatively, a TIFF file in the proper page size and compression (CCITT Group 4) can be used.
documents. Some PlanetPress Design features, such as the Time and Date functions, require that this option be selected. PReS Image PReS Image Output tasks are used to make requests to PReS Image, which creates image files which it then archives or emails. For more information about this product, see "About PReS Image" on page 765. Since this task is an Output, it is not possible to immediately act on the generated image before continuing.
can be generated either with the use of "Add document" on page 668, or a printer queue using a "Send to Folder printer queue" on page 118. Postscript generated using any other way will fail, as PReS Image requires knowledge of the number of pages in the document, which is not available in output generated using any other means. Note however that "Digital Action" on page 403 does have the ability, in most cases, to generate output using third-party PostScript files.
Digital Action tasks, in a PDF/VT file created with Connect, see the Connect Online Help: Generating tags for Image output. Alternatively, select a PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections. To enable the dynamic document name box, click inside it. To disable it, press Enter.
the digital masters. The TIFF Group 3 and Group 4 formats are efficient for document storage. l l l l l l l l l l The AutoStore, DocAccel and KYOcapture formats also generate TIFF files along with special XML that are meant for these specialized systems. VDX: The output will be a PDF file with some PPML code inside of it to enhance performance by doing caching/image reusing. The output can only be used on devices that support the VDX technology.
When multiple files are generated for a single job (such as for multiple TIFFs), each file name includes a sequence number, such as in Invoice0, Invoice1, Invoice2. If you use file name masks that include dots, such as Statement.%y.@(1,1,1,1,25,KeepCase,Trim) or Job.%f, for example, you must add quotation marks at the beginning and end of the file name (“Statement.%y.%m.@(1,1,1,1,25,KeepCase,Trim)” or ”Job.%f”).
l General group l l 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). This option produces a file suitable for transmission over a 7-bit ASCII link. This option is useful if the PDFs need to be opened in a text editor, sent across networks, or sent via email using a program that does not support binary files. This option also generates smaller files.
well on images with large areas of solid shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs. CCITT typically yields the best compression of monochrome images. It is the compression method developed for fax transmissions. Note that configurations that were created with an earlier version of PReS Workflow and that included tasks set not to use any compression will by default be set to use the Flate compression method.
image data and may reduce image quality, but may be suitable for continuous-tone photographs containing more detail than can be reproduced onscreen or in print. Since JPEG eliminates data, it can achieve much smaller file sizes than Flate compression. Select Auto to let the application choose the best compression method automatically.
the ability to take an existing PDF in input and apply the selected password to the PDF without any change to the quality level of the original PDF. 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.
Limitations In order for PReS Print Control tasks to be functional, some pre-requisites must first be met: l l PReS Classic 6.3.0 or higher must be installed on the same system. A valid PReS Classic license (either dongle or software based) must be available on the same system. Note All PReS Classic licenses are issued and controlled by the PReS License Server and not Connect. Thus a separate PReS Classic license is required. Input A PReS Classic job and the resources it needs.
Task properties General Tab l PDC File: Select either an un-compiled PReS Classic script file (PDS) which will need to be compiled on the fly, or a pre-compiled PReS Classic job file (PDC). The job needs to be specified exactly. If you want to compile the job at run time, then you must select a PDS file. If you wish to use a pre-compiled PReS Classic job, then select the PDC file, rather than the PDS.
Note If the PDC File selection contains a folder path and the Working Folder also has an entry, then the PDC File entry will be appended to the Working Folder entry. One should be very cautious doing this, as it could easily lead to errors. l PDL Type: Select the desired PReS Classic output type for the job. Note Not all PReS Classic jobs can be swapped between output types. Jobs designed for certain output types (such as AFPDS) will likely have settings specific to the original output type.
Note It is heavily recommended that this setting be left as ‘Auto’, as PReS Classic licenses being assigned to different PRNx instances is extremely rare. l Time-out: The time in seconds that the Connect Workflow waits for a response from the PReS Print Control to make sure it is running. If Connect Workflow does not receive a response in the allotted time it will terminate the Print Control and continue to the next step in the workflow.
Properties ZUGFeRD I Tab The ZUGFeRD data entry options are too large to fit within a single entry tab, so the data entry options have been split over two tabs. ZUGFeRD I is the first of these. All the entry fields with a maroon field name support the use of variable data. You can rightclick within these fields to insert a Workflow data selection.
l Rechnung group contains invoice related information. l l l Rechnungsnummer: The invoice number. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Dokumentenart: The document type. This field will always be set to "RECHNUNG" (invoice), to cater for BASIC invoices. Rechnungsdatum: The invoice date. This entry can be set directly, or through the date selection pop-up that appears when the drop down icon is selected.
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. The plugin provides some common predefined country codes in the pull-down list. Codes other than those provided can be entered either manually or through variables.
Note The plugin does not check if a given tax ID number conforms to any rules. It is the responsibility of the user to ensure that only valid tax ID numbers are entered. This field can be set via Workflow data and/or variables. l Käufer group contains all the required values and information related to the buyer. l l l Name: The individual or company name. This field supports alphanumeric strings and can be set via Workflow data and/or variables.
Note The plugin does not check if a given country code is in the list of valid country codes. It is the responsibility of the user to ensure that only valid country codes are entered. This field can be set via Workflow data and/or variables. ZUGFeRD II Tab The ZUGFeRD data entry options are too large to fit within a single entry tab, so the data entry options have been split over two tabs.ZUGFeRD II is the second of these. All the entry fields on the ZUGFeRD II tab support the use of variable data.
l IBAN: A bank account number following the International Bank Account Number (IBAN) standard. The IBAN consists of an alphabetical country code, followed by two check digits, and then up to thirty five characters for the bank account number. The bank account number can include the domestic bank account number, the branch identifier, and potential routing information. Note The plugin does not validate bank IBAN/BIC codes. It is the responsibility of the user to ensure that valid codes are entered.
Note The plugin will accept any string. The user needs to take care to only enter valid tax codes as defined in the UNCL 5153 (see http://www.unece.org/trade/untdid/d97b/uncl/uncl5153.htm ). This field can be set via Workflow data and/or variables. l l l l Steuerprozentsatz: The tax rate entry. This is the percentage that applies for the taxation calculation. This entry should be a numeric currency entry, which can be set via Workflow data and/or variables.
and/or variables. Bei Fehler/ On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 99. Anmerkungen/ Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
This task is put into effect in the following example processes. l "Example: Daily sales report from PDF files" on page 288 l Basic Functional Capture Workflow l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Input A data file in any supported emulation (see "About data emulation" on page 60).
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 879 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 75.
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 (using TLS 1.2) and for such purposes as creating record sets, generating contents and generating output. For more information about the Workflow processes in which these tasks are used, see the Connect Online Help.
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 582, "Create Print Content" on page 570, "Create Job" on page 559, and "Create Output" on page 561. 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 "%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.
functions (see "Data selections" on page 53). If the data mapping configuration name is dynamic, you must enter the name (or select a variable that contains the name) and set the value of all the runtime parameters that may occur in the data mapping configuration. If a runtime parameter is defined in a data mapper configuration, but not set in the task properties, an error will be raised. Note Backslashes (\) and double quotes (") in a JSON string must be escaped with a backslash (\\, \") if the JSON strin
l l l Rule Viewer: Displays a text-based view of the condition using operators and parentheses. Sort contents: Defines how records are sorted. l l l Export the rule: Click to open a Save dialog and save the Rules file to disk. Sort items based on: Displays the current sorting method. To modify the sorting method, click on the [...] button at the right of the box to open the "Sort Parameters" on page 553 dialog.
of OL Connect.) Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53). If the template name is dynamic, you must enter the name (or select a variable that contains the name) and set the value of all runtime parameters that may occur in the template. If a runtime parameter is defined in a template, but not set in the task properties, an error will be raised.
l Job Preset file: Select which Job Preset to use to generate the job. l l l l l Default: The IDs in the Metadata are used instead of a job preset file. None: Select this option to prevent the execution of Job Creation and Output Creation. In this case you also have to select 'None' on the Output Creation tab as well. "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below.
necessary backslashes. Output Creation Tab The Output Creation step generates the output for the current job, using the selected Output Creation Preset. Note that the Job Creation task normally necessary when using the individual tasks is implicitly executed before output creation. l Output Preset: Select the appropriate Output Creation Preset to use: l l l l "%o": Select to use a dynamic Output Preset name. Click on %o to change the expression that determines the name of the Preset to use.
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 793. 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.
l Remove: Click to remove the currently selected line in the sort list. l Move Up: Click to move the currently selected line up one position in the sort list. l Move Down: Click to move the currently selected line down one position in the sort list. l Validate Names: Click to check each line in the sort list against the currently active Metadata.
l A JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 93). When the "Execute Data Mapping" on page 582 or "Retrieve Items" on page 600 task is set to output Records in JSON, it outputs this kind of JSON data. If the input is JSON, the task performs a REST call to the /rest/serverengine/workflow/contentcreation/email/{templateId} endpoint on the Connect Server. For more information see the REST API Cookbook.
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. l Runtime Parameters: The runtime parameters defined in the selected template are displayed and their values can be set here. (See Runtime parameters in the Online Help of OL Connect.) Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 53).
l l l Precedence to template address: If the sender's address is given in the template, that address gets precedence over the one specified here. Use encryption (TLS): Check to connect to the SMTP server using TLS 1.0 (Transport Layer Security, also called "SSL"). Use Authentication group: Check to enable authentication to the SMTP server. l l l Password: Enter the password for the above user name.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Job The Create Job action task prepares a series of print content items for output generation. A Job is not actual contents but simply a collection of content items ready to be printed. See also: "About printing" on page 109. Tip Drag-and-drop a Job Creation Preset from the Connect resources in the Configuration Components pane on a process to add this task.
Task properties General Tab l Job Preset file: Select which Job Preset to use to generate the job. 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 l l Default: The IDs in the Metadata are used instead of a job preset file. Select this option if the Print Content Set is the result of the "Retrieve Items" on page 600 task. "%o": Select to use a dynamic preset name.
Note Backslashes (\) and double quotes (") in a JSON string must be escaped with a backslash (\\, \") if the JSON string is passed via a global, local, or Job Info variable. If the JSON is entered directly in the runtime parameter field, the plugin adds the necessary backslashes. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the "OL Connect preferences" on page 793.
This task can be added as an Action task (see "Action tasks" on page 375) or as an Output task (see "Output tasks" on page 608). Adding it as an Action task enables the process or branch to continue after this task. An Output task is always located at the end of a process or branch. Note When added as an Output task, the Create Output plugin works asynchronously to the Workflow process.
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 570 task. Add job information to document: Check to add the 9 Job Info variables to the PDF/VT metadata at the root level.
Tip Drag-and-drop a template from the Connect resources in the Configuration Components pane on a process to add this task or one of the other OL Connect tasks that create content from a template: a "Create Email Content" on page 554 task, a "Create Print Content" on page 570 task, or a "Create Web Content" on page 574 task. Properties Datamapper tab The Create Preview PDF plugin gets one record from the source selected on the Datamapper tab.
Note When the data mapping configuration provides multiple records, the preview is created based on the first record. Note The Create Preview PDF plugin cannot pass runtime parameters to a data mapping configuration. Instead it uses the default values set up in the Preprocessor of the data mapping configuration.
l Metadata uses existing metadata, generally the output of a Create Record Set or a Retrieve Items task set to retrieve a record. Update fields with metadata: when this option is selected, the plugin will update fields in the Connect database based on the metadata content. This is only useful if the Workflow process has modified the metadata and the corresponding fields should be updated in the database before creating the preview PDF.
lookup functions (see "Data selections" on page 53). If the template name is dynamic, you must enter the name (or select a variable that contains the name) and set the value of all runtime parameters that may occur in the template. If a runtime parameter is defined in a template, but not set in the task properties, an error will be raised. Note that it is not possible to change a parameter's type here; that can only be set in the template itself.
template. OL Connect Proxy Tab l Server Connect Settings l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340. User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Input This task can receive either Metadata containing information regarding a valid Record Set, or JSON data, or a PDF/VT File (see "Create PDF/VT" on page 564). Metadata The "Execute Data Mapping" on page 582 task and the "Retrieve Items" on page 600 task output Metadata containing information regarding a Record Set. JSON The Create Print Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records.
generated using the record's data and these pages are saved as a content item in the database. In the case of a PDF/VT file, content items are created based on the structure of the PDF/VT metadata and content items are stored using the data for each of those metadata records. By default, the entire Print Context is used to create print content items. Individual Print sections can be selected dynamically via a Control Script. (For more information see the Designer Help.
records. Otherwise, only the ID of the current job is sent, and the unchanged records are used. l JSON: l JSON String: A JSON object or an array of JSON objects representing records or a JSON Record Data List (see: "Types of JSON in Workflow" on page 91). This option requires that keys in the JSON data have matching field names in the data model of the template.
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 793. 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.
Tip Drag-and-drop a template from the Connect resources in the Configuration Components pane on a process to add this task or one of the other OL Connect tasks that create content from a template: a "Create Email Content" on page 554 task, a "Create Preview PDF" on page 565 task, or a "Create Web Content" on the previous page task. Input This task must receive either a valid Record ID or a JSON object. Record ID A valid Record ID can be retrieved from various data sources.
Processing For a single record, this task generates the output for the Web Context of the specified template. Any external resources such as images, CSS style sheets or JavaScript files, are also produced and put aside on the OL Connect Server component. Note Content creation may be aborted by a script in a Connect template that raises a fatal error. This triggers the On Error tab of the Content Creation task. See Designer Script API. Output The task outputs HTML code as a job file.
l l Update Records from Metadata: If the process's Metadata has been modified by any of the "Metadata tasks" on page 514, check this option to update the records in the Connect database with the Metadata and use the updated records. JSON: l JSON String: A JSON object or an array of JSON objects representing records (see "JSON string examples" on page 91) or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 93).
Note By default, the Create Web Content task inserts a meta tag in the generated HTML, specifying a default URL and target for all links on the web page. By pointing to the Connect Server the job was sent to, the tag enables the HTTP server to retrieve the resources that were saved with the Designer template. Since the tag corrupts local anchors - links to another location in the same web page -, the task also replaces the HREF attribute of local anchors with JavaScript code.
OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the "OL Connect preferences" on page 793. 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 661 and "SendGrid" on page 664 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 595. 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.
Processing The task executes the selected data mapping configuration on the appropriate data source, or converts the PDF/VT into a Record Set directly. If the input is paginated, this task can create a Print Content Set as well. If the data mapping configuration expects a database data source, the Data Source option is ignored and the database is accessed instead. If a PDF/VT file is used, the data mapping configuration option is optional - if one is present, it must be able to read the PDF/VT.
correct one is used. Only works for configurations listed (will not work for "None" or "Dynamic" options). l Output Type group: l l l l l Metadata - IDs only: Select to only output the Record and Job IDs in the Metadata. This does not permit sorting and filtering, but it enhances performance since only minimal data is exchanged between the OL Connect Server and PReS Workflow. Metadata: Select to output the full Record table (no Details table) as Metadata in the task.
Tip To determine if there were any errors in a job and handle it accordingly, you can use a Condition that checks if GetMeta(SelectedCount[0], 11, Job.Group[0]) is greater than 0, immediately after the task (see "Conditions" on page 137). l Runtime Parameters: Runtime parameters pass information from the Workflow process to the data mapping configuration (see Properties and runtime parameters in the Online Help of OL Connect).
l l Duplex: Whether the page sheet is duplex. Tumble: Whether to duplex pages as in a calendar. For this to work, the duplex option must be checked as well. Note The Bypass content creation option only works if the input is paginated. Set the Output type to Metadata if the Content Creation task is omitted and the output is to be used by the Job Creation task later on in the print process.
File Store - Delete File The File Store - Delete File task deletes a file from the OL Connect File Store, using either a file name or File Store ID. Input The task requires either the name of the file in the OL Connect File Store or its File Store ID. The name of a file is chosen and its File Store ID is returned when uploading it with the "File Store - Upload File" on page 589 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.
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 793. 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 When a file is uploaded to the Connect File Store, it is automatically assigned a File Store ID. The task stores the returned File Store ID in the specified variable. This task does not modify the Job File. 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.
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. 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.
l l Content Set: Tag any Content set created by the "Create Print Content" on page 570 task or the "Retrieve Items" on page 600 task set to retrieve Content Sets. Record Set: Tag any Record set created by the "Execute Data Mapping" on page 582 task or the "Retrieve Items" on page 600 task set to retrieve Record 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.
Processing The current Metadata Job File is merged with the selected external Metadata file. Output The task outputs a merged Metadata Job File which can be used in the "Create Output" on page 561 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.
Note As of OL Connect version 2020.2 the PDF to Bitmap plugin requires the OL Connect Server to produce output. This could cause problems when running older configurations. To cure such issues, set the Connect Server connection settings within Workflow (see "OL Connect preferences" on page 793). Output This task outputs the PDF file it received with no modification. Properties The General tab has the following options: l l l Output format: The output format can be either PNG or JPG.
OL Connect Proxy Tab l Server Connect Settings l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340. User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Input This task must receive either Metadata containing information regarding a valid Record Set, or JSON data. Metadata The "Execute Data Mapping" on page 582 task and the "Retrieve Items" on page 600 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 525 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. When an email address is invalid, no email content will be created. Instead, an error is reported for the record with an invalid email address.
{"messages": [ {"attachments":[ {"name":"att0307c655-e14e-4400-8f90365032648aed.png","disposition":"inline"}, {"name":"myPDF.pdf","disposition":"attachment"}, ], "subject":"Take action now", "to":"recipient@gmail.com", "from":"sender@yourdomain.com", "folder":8768, "eml":"c5f97db0-45ca-4f1d-be4d-473d000c92bd.eml", "body":"07decd87-d03c-4969-bc2a-7527cc594878.html", "text":"7a4e5217-0103-487f-a4f8-77d37d0c1087.
l JSON String: a JSON object or an array of JSON objects representing records (see "JSON string examples" on page 91) or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 93). This option requires that keys in the JSON data have matching field names in the data model of the template. When they have, the JSON values are passed to the template; the personalization scripts of the template will have access to the values through the record's data fields.
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. Retrieve Items The Retrieve Items Action task locates and extracts items from the OL Connect Database so they can be used with further tasks.
Note The result of a Retrieve Items task can be used with the "Create Job" on page 559 task if it is a Content Item or Content Set, but it cannot be used in combination with a Job Preset. Note Content Creation tasks accept Metadata as well as JSON data as input. Task properties General Tab l Entity to retrieve: Use the drop-down to select which items to retrieve. l l l l l l l Record: Retrieves one or more Records, whether or not they are part of a Record Set.
l Retrieve by: l l l l l l l l l ID: Depending on the option selected under Entity to retrieve this is a Record ID, Record Set ID, Content Item ID, Content Set ID, Job ID or Job Set ID. IDs can be entered directly; when entering multiple IDs, put each on a new line. Alternatively, they can be passed via variables (see "Variable task properties" on page 303), or as a JSON array, e.g. [6001,6002,6003]. A JSON array may contain variables, e.g. [%1, 75001].
the same principle when all the Print Content Items are generated using the same Template file. This tab is only available if the Content Item option is selected in the General tab's Entity to retrieve drop-down. To modify any of the following options, click in the Parameters box and then click the [...] button that appears. l Document contents: Defines the Document ("Mail Piece") level and how they are built. l l l Pick items based on: Use the [...
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. Pick Parameters The Pick Parameters define how to pick entities retrieved from the Connect Database using the "Retrieve Items" on page 600 task and place them together in Documents or Groups. Items are picked using either Properties or Values.
Processing The task sets the chosen properties to all entities present in the Metadata. These properties are added to the entities on the OL Connect Server. Note that the properties are calculated only once, and are applied identically to all entities. If each entity should have different properties (such as record-level properties), the Metadata should be split using the "Metadata Sequencer" on page 525 task first. Output The task outputs Metadata that is identical to the input Metadata.
Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Output The Job File is not changed by this task. Task properties General Tab l Update Source: Select the data source from which the records in the Connect database will be updated. l l Metadata: Select this option to use the current content of the Metadata. JSON: Enter a JSON string, or a variable containing JSON. (See "Variable task properties" on page 303.) The task expects a JSON Record Data List; see: "Types of JSON in Workflow" on page 91.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Output tasks Output tasks are exits from PReS Workflow processes. They can be used to send data to specific devices, such as printers, applications, such as email software, or locations, such as folders. A single process can include multiple branches, each one terminated by an Output task, and so a single process may generate output via a variety of Output tasks.
l "PReS Image" on page 493 l "Print using a Windows driver" on page 619 l "Printer Queue Output" on page 621 l "Secure Email Output" on page 625 l "Send Email" on page 628 l "Send to Folder" on page 631 l "SOAP Client plugin" on page 692 (Legacy task) The SFTP Output task also appears in the Output category when it is installed. (It isn't installed by default.) Delete Delete output tasks simply delete the job files they receive.
Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. FTP Output FTP Output tasks send job files to other computers using the FTP protocol. It is similar to the Sent To Folder output task but sends to an FTP connection instead of a local drive. The following describes the properties specific to FTP Output tasks.
l l l l Password: Enter a password associated with the FTP server user name entered above. Directory: Enter the directory to which the job files are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server. File name: Enter the name under which the output job file will be saved. Consider using a dynamic name, since if you use a static name every new file will overwrite the previous one.
Input Any data file. Processing The task uses the Microsoft Graph API to access accounts in the organization (subject to that organization's IT policies). While an email is always sent by this task (or at least attempted to be sent), the contents of the email and presence of attachments depends on the selected options. Once the contents of the email and attachments are determined, the email (including any attachments) is sent directly to the selected mail server.
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.
Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Microsoft 365 OneDrive Output Microsoft 365 OneDrive Output tasks allows to send files to any of the organization's Microsoft 365 OneDrive accounts. This task uses the Microsoft Graph API.
Note The MS Graph REST API is limited to a certain number of requests within a certain period of time. This is called throttling. When throttling comes into play, the plugin receives HTTP response 429. The plugin will log the error and retry, but it exits with an error after 15 unsuccessful attempts. Task properties General Tab General l l Folder: Enter the path of the folder to which the files are to be saved.
perform its tasks, but no more. However, application permissions apply to all accounts in the organization: if the application has been granted permission to read emails, then that permission applies to all email accounts in the organization, and if it has access to OneDrive, it has access to all folders. 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.
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 Password: If the account named in the User name box is password protected, enter the password here. l l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH).
l 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.
Note This type of output task does not support PDF transparency and duo-tone features, so you should not use it with PlanetPress Design documents that use those features. Input This task can accept either a data file with a correct emulation (see "About data emulation" on page 60), which is then merged to a PlanetPress Design document, or a PDF file which is to be printed natively.
Note This option is not functional when natively printing PDFs (without a PlanetPress Design document). l Documents: Select a specific PlanetPress Design document if you want all the jobs to be printed with that document. l l Natively print PDF file: This special option can be used if your job file is a PDF. The job will .
You can select multiple Printer Queues in a Printer Queue Output task and choose exactly how your jobs will be dispatched to the selected printers. The task can create print output as well, by merging the data file with a PlanetPress Design document (see "PlanetPress Design documents" on page 44). This requires at least one PlanetPress Design document to be associated with a Workflow printer queue (see "Associating PlanetPress Design documents and PReS printer queues" on page 120).
chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections. To enable the dynamic document name box, click inside it. To disable it, press Enter. Note that in the later case, you must be certain that the documents that will be chosen at run-time will in fact be available locally or at all the selected printer. Note that PReS Workflow will not specify a given document version number, so the latest version will be used by default.
l l l l l Round robin: Round robin means that complete jobs will be sent in turn to each one of the selected Workflow printer queues. For example, Queue_1 will get the first job, Queue_2 will get the second job, and so forth. Page delimiter group: These options are enabled when you choose Split job or Queue balancing load balancing options. They are used to determine how each job is to be split before being sent to the Workflow printer queues.
Secure Email Output The Secure Email Output task sends SMTP email messages with SSL (2.0, 2.3 or 3.0) or TLS (1.0, 1.1 or 1.2) encryption. Note that this plugin cannot be used on a Windows instance that uses a multi-byte language (e.g. Japanese, Chinese). The workaround is to either use a different Windows language or use the standard Email Input/Output plugins. Also note that this task doesn't merge data records with a PReS Connect template, like the "Create Email Content" on page 554 task does.
Note When specifying multiple recipients for the To, CC and BCC fields, separate the e-mail addresses with semi-colons (;). l To: Enter the email address(es) of the recipient(s). l Cc: Specify addresses to which a copy of the generated emails are to be sent. l l l Bcc: Specify discreet addresses (other recipients will not be able to see these addresses) to which a copy of the generated emails are to be sent. Subject: Enter the subject of the email.
l l l l Attach input job file: Select to attach the current job file to the email that the task sends. Rename to: Check this option to rename the job file before attaching it to the email, and enter a name. You may use text, variables and data selections (see "Variable task properties" on page 303). File: Select additional or more additional files to include as attachments. You may enter the file name directly and use text, variables and data selections (see "Variable task properties" on page 303).
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. 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.
Task properties Recipients Tab l l l l l To: Enter the email address(es) of the recipient(s). Remember this is a variable property box and you can therefore use various schemes to use email addresses that change with each job at run-time. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303. Cc: Specify addresses to which a copy of the generated emails are to be sent.
l l l l l l l Attach input job files: Select to attach the file received by this task to the emails it will generate. If this option is not selected, the recipients will not receive any data file. File: Select additional files to include as attachments. You may enter the file name directly and use text, variables and data selections. You may also use the Browse button to navigate and select the file.
l l l l l l Reply address: Enter the reply address that will be used in emails sent by PReS Workflow for this task (this is optional). Outgoing mail (SMTP): Enter the IP address of the mail server PReS Workflow is to use to send emails via SMTP. Port: Specify the outgoing SMTP Port if it is different from the default port (25). Server requires authentication: Select if the outgoing server mentioned above requires authentication.
Task properties General Tab l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names. You can use any combination of text, variables and data selections; see "Variable task properties" on page 303.
l "Connection tab" on page 635 l "Connection tab" on page 640 l "Advanced properties" on page 650 l "Advanced properties" on page 653 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. Output The output of this task - the Job File - is either the downloaded file, or the document index data in XML or JSON format. In the latter case, the JSON/XML file includes the path to the file on the DocuWare Server.
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.
Note You can use static text and/or Workflow variables, data and lookup functions in all of the fields on this tab. Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 53). l Download section. In order to download a file the plugin needs to know from which File Cabinet it must be downloaded.
Note The drop-down list display can be customized by entering a search string in the entry field atop the Field Picker box. This restricts the listed fields to just those containing the search string. l Value. Add the value to apply. You can add or remove search criteria using the following options: You can populate the table with all the available Index Field options at any time by selecting the Add missing fields ( ) button. If selected initially this will add all the available fields to the table.
l Store file name in variable: Stores the name of the downloaded file in a variable. l Store response in variable: Stores the success/failure response in a variable. l Save document index data to Job as XML/JSON: Outputs the document index data to the Job File as XML or JSON (according to the selected option) and stores the status information in a variable. The downloaded document itself is stored in the Connect File Store.
To be able to use this plugin you need a working DocuWare installation and user account with appropriate permissions. Input The input of this plugin can be a file of any type. Processing After establishing a connection with the DocuWare system, the plugin will try to upload the specified file (either the Job File, or an external file) with the given index values to the selected File Cabinet. The plugin won't modify the uploading file in any way.
Right-clicking a field opens the contextual menu that allows to add variables, data and lookup functions (see "Data selections" on page 53), where available. DocuWare Server Enter the DocuWare Host address. For example https://mycompany.docuware.cloud Organization Enter registered Organization name. For example MyCompany Platform Enter the DocuWare platform. For example docuware/platform Username Enter the DocuWare login Username.
been established and the cabinet and file information obtained, the plugin will open upon the Upload tab when next plugin is next opened. As different users can have different permissions (such as access to different cabinets) this information is tied to both the host and username. If either the user or server is changed, then a new Test Connection will be required to re-populate the cabinets and fields for that new connection.
l File type: Enter the type of file, from the list contained in the drop down box. Select Autodetect if unsure of the file type, and the plugin will then set the content-type based upon the file extension. The File type entry is directly editable so your can enter your own file type, should it be missing from the list. Destination In order to upload a file the plugin needs to know to which File Cabinet it must be directed to. The details for this are all contained in this Destination frame.
highlighted in the Document name field screen entry). l Update existing document will add to an existing document of the same name on the DocuWare server, based upon the following criteria: l Search Field. Enter the Field to search on. This can be entered directly as static text, or you could use the Field picker ( ) to launch a Field selection pick list that is populated with all the available fields, and them select the desired field from there.
) or Remove ( ) individual entries, as well as move them up ( ) or down ( ) within the table. At any point you can verify the accuracy of the selected Index options by selecting the Validate ( ) button. Index entries that are duplicated appear in orange text, and index entries that do not match available options appear in red. Note The Document name field entry will appear in italics in the table. All index values must be entered in a unified format.
Fields with empty values will not be saved when the OK button is pressed. Response Specify an optional Workflow variable that is used to store the result. The DocuWare plugin searches for the variable by name and sets the JSON response into the variable. So using dwresponse as the variable name would mean that DocuWare Upload searches for the local variable of that name. Plugin legal notices and acknowledgments Copyright © 2020 Objectif Lune Incorporated. All rights reserved.
Note To be able to use this plugin you need a working M-Files installation and a user account with appropriate permissions. Plugin legal notices and acknowledgments Copyright © 2019 Objectif Lune Incorporated. All rights reserved. M-Files Download The M-Files Upload plugin downloads a single file from an M-Files system (see "M-Files" on the previous page). This Action plugin is not initially installed with Workflow. It is available for download on the Resource Center (help.objectiflune.com).
Output The output of this task - the Job File - is either the downloaded file, or the document index data in XML or JSON format. In the latter case, the JSON/XML file includes a path to the file so it can be downloaded separately. The response that the plugin gets from the M-Files Server is then stored in a variable (if specified). Task properties All of the task's General properties are dynamic.
l l FileID (optional): If the file ID is not given, the first file - the root document - will be retrieved. Retrieve by search: This section allows the retrieval of files by searching for specific properties (Definition entries). Enter the properties under Index data. l l Field: The property to search for.
l Save document index data to Job as XML/JSON: Outputs the document index data to the Job File as XML or JSON (according to the selected option)andstores the status information in a variable (if it exists). The downloaded document itself is stored in the Connect File Store. The XML/JSON output file includes a URL to the document so that it can be downloaded separately. In the Response variable field you can enter the Workflow variable in which the file name or status information should be stored.
Note To be able to use this plugin you need a working M-Files installation and a user account with appropriate permissions. The M-Files Upload plugin is designed to be configured offline as well as online. Once a Test Connection has been established, the Vaults and properties data will be downloaded and stored locally. This allows authoring of Workflow configurations without requiring a constant live connection. Input The input of this plugin can be any file.
l l Username, Password: Enter the user name and password that the plugin can use to send a login request to the M-Files Server. The user should have the appropriate rights. Test Connection: Click this button to establish a connection with the M-Files Server and retrieve the Document Classes of the selected Vault. This information is used on the Upload tab. Upload Tab l File to upload: l l l l Job file: Click this option to upload the current Job File (see "Job file" on page 51).
Metadata Structure of the Vault on the M-Files server. l Value: The (new) value of the property. Note The plugin will fail if a required property is missing from the Index data, or if the Index data contains a property that does not exist for the chosen Class. Use the Index data buttons to: l l l l l Add and remove properties. Change the order of the properties by moving them up or down. This is for convenience only; to the M-Files Server, this order is not important.
Input from SharePoint The Input from SharePoint task can be used to retrieve files from a SharePoint server on your network, filtering on your template fields and creating Metadata to use in your process. When the Input from SharePoint task runs, it first lists all of the files to download then runs the process once for each file in the list. If any new files are added during the process, they will not be touched until the next time the process is scheduled.
Input Any data file present on a SharePoint document store, even those not compatible with PReS Workflow emulations, and the properties of these files. Processing The task connects to the selected Document store and retrieves a copy of files according to the specified rules. The files may be deleted or marked as checked out depending on the options selected, otherwise they are untouched. Output The output to this task is a series of individual files, one after the other.
l l l Download files from sub-directories also: Check to also look into subdirectories of the specified Folder. Do not download checked out documents: If the document is set as "Checked Out" in SharePoint, it will be ignored. Action Group l l l Download the document: Simply download the document and do not modify it in SharePoint. Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint.
CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 874. l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
Input Any data file, with optional Metadata. Processing The task connects to the selected Document store and uploads the current data file. If the file already exists, it will be overwritten and, if this option is selected, marked as "checked in". The information accompanying the file (the SharePoint Metadata) is either updated or created. Output The output of this task is the original data file.
l l l l Field Name: Name of the field as set in SharePoint Document Library. Field Information: The information to enter in the SharePoint Document's Metadata for this field. Use PDF/A: Check to use the information contained within an PDF. This PDF must have been created with PReS Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library.
l l l Domain: The active directory domain for the log-on credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries. Password: The correct password for the user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Mailjet Note l l l The Mailjet plugin is not installed by default. It is available for download on the Resource Center (help.objectiflune.com). Make sure that the version number of Workflow and the plugin are the same, to avoid compatibility issues. Version 2021.1.0 is backwards compatible with Workflow down to version 2020.1. In order to use HTTPS it is essential to upgrade the plugin to the 2021.1.0 version, available for download on the Resource Center (help.objectiflune.com).
Note No third party system resources are incorporated directly into this OL product. This means that while the plugin was tested against the associated third party systems when initially released, they may behave differently with later versions of that system. Use at your own risk. Should you encounter any issues, please contact your local Objectif Lune Support team and we will do our best to help. Testing the plugin To test the plugin, drag it from the Plug-In Bar into a process.
[{"fileid":100034,"name":"example.pdf","disposition":"attachment"}] [{"url":"file:///C:/Terms-andConditions.pdf","name":"terms.pdf","disposition":"attachment"}] All attachments should be combined in one array: [{"url":"file:///C:/Terms-andConditions.pdf","disposition":"attachment","name":"Terms.pdf"},{"name":"Take action Mandie.pdf","disposition":"attachment"}] The order of the key/value pairs is not important.
l l Headers (optional): A JSON object containing one or more key/value pairs of header names and the value to substitute for them:. For example: {"Sensitivity":"Company-Confidential","X-Priority":"1"} If they contain Unicode characters, you must ensure that these are properly encoded. Custom header names normally start with "x-": {"x-my-header":"myvalue"}. Debug settings: l l Send all messages to the Test Address: When this option is checked, Mailjet will only send the emails to the given Test Address.
l l In order to use HTTPS it is essential to upgrade the plugin to the 2021.1.0 version, available for download on the Resource Center (help.objectiflune.com). To be able to send email using the SendGrid plugin, you need a SendGrid account and API key. The SendGrid plugin allows you to: l l l Tag the emails with category names, which help organize your email analytics (see About categories). Set a time at which the emails should be sent (see Scheduling parameters).
Conditions.pdf","disposition":"attachment","name":"Terms.pdf"},{"name":"Take action Mandie.pdf","disposition":"attachment"}] The order of the key/value pairs is not important. Processing The plugin communicates with the Connect Server to retrieve each email message's body, any attachments and the plain text version (if available) from the File Store, using the folder ID and file names specified in the output of the Render Email Content task.
id, x-sg-eid, received, dkim-signature, Content-Type, ContentTransfer-Encoding, To, From, Subject, Reply-To, CC, BCC. l Debug settings: l l Send all messages to the Test Address: When this option is checked, SendGrid will only send the emails to the given Test Address. This allows you to review the result and to test ESP specific options like open rates and click through statistics. Log email messages: Check this option to get a copy of each message in the Messages window of Workflow.
l "Capture-Get document" on page 717 l "Extract ICR Data" on page 712 l "Capture-PGC splitter" on page 710 l "PGC to PDF Converter" on page 720 l "Create MRDX" on page 670 l "Microsoft® Word® Documents To PDF Conversion" on page 683 l "PrintShop Mail" on page 686 l "PrintShop Mail" on page 686 l "HTTP Server Input" on page 678 l "SOAP Client plugin" on page 692 l "Add document" below l "Send Images to Printer" on page 689 l "Download to Printer" on page 671 l "Generic Splitter" on
Input This task can support files in any emulation, however, the actual file that should be used is one that is compatible with the selected PlanetPress Design document. 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.
Create MRDX Note This plug-in has been moved to the Legacy group. The Create MRDX Action task is used to register a job on a SureTrac server using an MRDX file. The MRDX contains information about the job and its finishing, as well as integrity features use by SureTrac. This task requires a PDF file as an input, along with metadata generated through a document that contains PitneyBowes Scan Codes.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Download to Printer Note This plug-in has been moved to the Legacy group. Download to Printer Action tasks are used to warn printers that the files that will be sent to them are to be stored to a specific location rather than printed.
Task properties General Tab l l l l l Hard disk name and path (as required): Enter the name and path of the hard disk to which the file is to be saved (enter “%disk0%/PPFiles/Resources”, for example, to save the file to the folder [ROOT]/PPFiles/Resources located on a hard disk identified internally as “disk0”). Leave blank to save the printer’s default hard disk and path. File name: Enter the name under which you want the file to be saved.
more options than the other ones, this is only because it contains combined features from these other splitters. Warning The Generic Splitter, while seemingly more feature-rich, is slower than the other splitters by an order of magnitude. Whenever encountering the Generic Splitter, it is always recommended to replace it with a more appropriate splitter instead. Input Any data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties.
l A word: If you choose “A word” in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed: l l l Word: Enter the string of characters to search for as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. Get: Click to get a static string of characters from the sample data file.
l l Split when word found: You may not want to split the file every time the string of characters entered above is found, but only every other time, or every third time. If so, enter the number of times in this box. A word change: If you choose A word change in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l l Get: Click to select a search region.
l l A page number: If you choose A page number in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l l Split when word changed: You may not want to split the file every time the string of characters entered above changes, but only every other time, or every third time. If so, enter the number of times in this box. Pages per output file: Enter a number of pages after which to split the file.
l l l Before or after: In the previous box, you entered where you wanted to split the file. Here is where you specify whether you want the Generic Splitter to split the file X number of pages or records before or after the string. Choose 5 in the Pages or records box and “Records after” in this box, for example, to split the file 5 records after the record that matches the condition.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. HTTP Server Input Note This plug-in has been moved to the Legacy group. HTTP Server Input tasks are used to receive HTTP requests made via GET or POST commands and to send replies to the servers from which the requests were made. The HTTP server supports both HTTP and HTTPS. For HTTPS Support information, see "HTTP Server Input plugin preferences 1" on page 798.
Warning It is highly recommended to make all processes using the HTTP Server Input task selfreplicating and to reduce their polling interval in the "Process properties" on page 874. Examples This task is put into effect in the following example processes: l HTTP PDF Invoice Request l HTTP Brochure Request l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Input The HTTP Server Input task does not, by itself, capture any files.
Processing Depending on the options chosen in the HTTP Server Input task properties, the task may choose to ignore some of the files. For example, using the "Do not include XML envelope" means that only the POST attachments will be used in the process, the XML file will be discarded. Attachments are always saved on disk in a specific location, which is accessible either directly in the XML or directly as a data file through the "Loop each attachment as data file" option.
l Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the HTTP Server Input task loop through each attachment. Each data file is an XML with the accompanied file. l l Do not include XML envelope: Only active when the previous Loop option is checked. When checked, the XML file containing the request data will not be available. Only the attachment itself is sent as a data file.
l Variable containing the response code: The contents of the job information or local variable selected in this drop-down, presumed to be a valid response code, will be returned in the response header. This is the value that is present at the end of the process, not the beginning. Note In order to make the Capture OnTheGo app delete the submitted form from the device's library upon successful transmission of the data, the Workflow process must return status code 291.
l l l %2 - Request Header: Contains the headers of the request, which can contain information such as the Browser and Operating System, languages, etc. %3 - Filename: Contains the local file name of the job file created by this task (and XML file). This is equivalent to %o. %4 - Attachment Index: Contains the index number of the current attachment while looping the attachments as data files (zero based; when processing the request file, the Attachment Index is 0; with the first attachment it is 1, etc.).
Notes l Microsoft® Word® needs to be installed for this task to be functional and to test the connection. l Microsoft Word must not be currently opened when the automation task runs. l Microsoft Word 2003 up to Word 2007 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.
Output The output is either: 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.
l l l SQL Statement: An SQL statement that is understood by the database you are using and that will return a series of records that the Microsoft® Word® template is expecting. Note that no validation is made on SQL statements except if they are for Microsoft Access and Excel data files. You can use the Test Connection button to test the SQL and connection string.
l l The version supported: PrintShop Mail only supports 6.1 documents, while PrintShop Mail 7 supports 7.0, 7.1 and 7.2 documents. PrintShop Mail 7 can output PDF/VT and PPML/VDX. Limitations In order for the PrintShop Mail tasks to be functional, some pre-requisites must be met: l l l PrintShop Mail version 6.1 or higher must be installed on the same system, and an activated PrintShop Mail production dongle must be plugged in to the system.
Task properties PSMail Tab l l File name: Select a specific PrintShop Mail document if you want all the jobs to be printed with that document. Output type group l Output type: Select the type of output you want the task to generate. l l l l l l l l l l l Select PDF to generate a PDF file. Select Windows PostScript driver (PrintShop Mail)/Direct to printer (PrintShop Mail 7) to send the output to a printer that is available via Windows.
technologies, consult the PrintShop Mail User Guide. This option is only available when Direct to printer is selected in the Output type box. l l l l Layout: Select which layout to use to produce the JPG file (output is limited to a single image). This option is only available when JPG is selected in the Output type box. User generated file as output: The output from the plugin will be the file generated by the merging (depending on the output type selected).
Output task set to 'pass-through' (No document), in order for the images to be actually sent to that printer. Note Images sent to a printer are stored in the root folder of the printer’s hard disk, while images sent to the virtual drive of another computer are stored in a sub-folder of the PReS Workflow folder. Input Any image file that you wish to upload to the printer. Processing The currently active image data file converted to PostScript.
l l l l l l l l Color conversion: Select As is to keep the color information included in the images. Select Grayscale to convert color images to gray scale. Naming convention: Select ’File name, original’ to store the file under its original file name. Select ’File name, no extension’ to store the file without its original file name extension. Note that all characters are converted to uppercase and that extended characters (characters, such as é, for example) are not recommended in image file names.
SOAP Client plugin Note The SOAP client output task plug-in has been moved to the Legacy group. SOAP Client plugin tasks can be used as Input, Output and Action tasks, although their basic function is to generate output. SOAP (Simple Object Access Protocol) is a light protocol that defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems.
Timeout By default the SoapClient plugin waits 100 seconds before returning an error if it doesn't get a response. To change the time the Soap Client plugin should wait, a Timeout registry key can be set in: HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Objectif Lune\PlanetSuite\PlanetWatch\TimeoutVal (DWORD) The value can be set to anything, in seconds. To wait indefinitely for a response, -1 can be used. However, this could cause the process to hang if the Soap Server never responds nor closes the connection.
l l l l l l l Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below. As script: Click to apply the options you chose above and to display information on the chosen Web service in JavaScript format in a script viewer. You should use this option if the Web service is too complex to be interpreted correctly by the SOAP Client plugin. Name: Displays the name of the arguments associated with the selected method.
Action-EMF Converter (Windows Print Converter) Note This plug-in has been moved to the Legacy group. 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. Typically, Windows Print Converter action tasks are located below WinQueue input tasks (note that the latter include options specific to Windows Print Converter action 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. PlanetPress Capture Tasks Note All of the Capture plug-ins have been moved to the Legacy group. 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.
Capture-Condition Note This plug-in has been moved to the Legacy group. The Capture Condition task checks the status or field contents of a Capture document that has been processed by the Capture-Field processor action task. 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 A data file in PGC or PDF format that is accompanied by valid Metadata.
l Document Origin: l Document to process: Determines where the document information is read 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.
l Capture Field-based condition: Select to base the condition on the state of one or more fields of your document. l Field Name: The name of the field on which to base your condition. This is equivalent to the name of the Capture Field Object in PlanetPress Design. Note In this field in particular, the right-click menu displays a unique option, 'Open Document Preview'. This option displays a list of existing documents.
l l l l l End timestamp: Triggered when the last stroke finishes in the field. (see Start Timestamp for detailed options) Pen Id: Triggered by the ID (serial number) of the pen. A box provides a way to specify which Pen ID will trigger this condition to be true. Field List Value: Triggered only on Field List Capture Fields. A box provides a way to specify which value will trigger this condition to be true. Content Status: Triggered when the field is in a specific status.
l l l At least one item is met: The task will return true if ANY of the combined conditions is true. Condition Scope: Determines whether the conditions need to be true for all the pages of the document, or any one of them. l l l All items are met: The task will return true if ALL the combined conditions are true. In the document (occurrence): The task will return true if the condition set it true for any page of the document.
This task is put into effect in the following use cases and example processes: l Basic Functional Capture Workflow l Capture Web Manager Workflow Input The Capture Field Generator action task expects to receive a regular data file that corresponds to the Capture-Ready document that uses it, along with Metadata generated using the same data file and document. This means that this task must be preceded by at least the Create Metadata task.
Note If any error occurs during processing, such as running out of patterns while generating the job, every action made by this task will be rolled back as if they hadn't happened. Output The Capture fields Generator action task will output either a PDF and Metadata, or an Optimized PostScript Stream file without Metadata.
l l l Override document pattern sequence: Check to override the pattern sequence as entered in your PlanetPress Design document properties. Once checked, enter a new pattern sequence in the Pattern Sequence box. Fail if document doesn't contain at least one capture field: If the static or dynamic document that tries to pass through this task does not contain any capture fields, an error will be generated.
l Basic Functional Capture Workflow l Capture Web Manager Workflow Input This task requires a PGC file that has been obtained from an Anoto Digital Pen that was used to write on documents generated from the same PReS Workflow installation. Processing The PlanetPress Capture Fields Processor action task receives and processes the information sent by the Anoto digital pen and updates all the documents in the PlanetPress Capture Database using the information from the pen.
Output This task outputs the PGC file it received along with Metadata that contains the documents that have been updated by this task. The Metadata can be used to do post-processing of the file using Capture Conditions, or directly through other Metadata tools. The structure of the output Metadata added by Capture is the following: l Document Level l l l l l l l l l CapCloseDate: Date at which the document was closed by Capture Field Generator. Blank if the document is still open.
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). Task properties Capture Fields Processor action task properties are as follows: l l PGC Name: This value will be added to the output Metadata, as well as the Capture Database, to link the PGC to the document it updates.
updating the wrong document. When out of bounds ink is found, the document will be set in the "Error" status. (see note below) l l Split PGC by document: Check to treat each document as a separate PGC file. This removes the need to use a Capture PGC splitter before this task, however the PGC Splitter remains useful when using self-replicating processes to accelerate PGC processing.
splitter will cause your process to take more time, since each PGC must pass through the Capture-Fields processor and then the Capture-Get 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.
Processing A query is made to the Capture database and the ICR data is retrieved. The document that is queried must be available in the database (must not have been closed and retrieved previously). Output The original data file is output by this task, along with the original Metadata file that has been enhanced with the ICR data at the selected level.
This task is most often useful as the beginning of an automated process using a series of Capture documents, for example one that removes old documents to unlock patterns. However, it can also be used as a secondary input in order to retrieve one or more documents after some operations. Note The Capture-Find document task makes multiple simultaneous statements to the database when requesting a list of documents.
Task properties General Tab l Document-ID Based Condition: Select this option for this task to filter its results using a specific Document ID. l l Document ID: Enter the ID on which you want to filter. The Document ID is a unique identifier of the document when it is stored in the database. It is attributed to the job metadata when the "Capture-Fields generator" on page 703 ads it to the Capture database.
l l Content Status: The status of the document as a whole. A document can be Empty (no ink), Partial (some ink but still open), Complete (all mandatory ink is present) or in Error (logical or process error). Operator: The choice of the condition operator. The available choices are variable depending on the filter but will be part of the following choices: l l l l l l l l l l l l Equal: Inclusive filter, where anything equal (either by string or numeric comparison) is included in the results.
l l l l l Condition: The condition or value the document needs to meet. The condition is variable dependent on the chosen filter. It can be a drop-down of values, an alphanumerical or numerical value. Add button: Click to add a condition row to the grid. Remove button: Click to remove the currently selected condition from the grid. To select a row, simply click on any of its 3 components.
The Capture-Get document action task is used after the Capture-Fields processor to retrieve all documents that have been updated. This task is put into effect in the following use cases and example processes: l Basic Functional Capture Workflow l Capture Post Processing Workflow l Capture Web Manager Workflow Input A data file in PGC or PDF format that is accompanied by valid Metadata.
In addition, any ICR information available (when using PlanetPress Capture ICR) will be placed at the Page Level, as follows: l l ICR_[FieldName]_Val : The value of the text that was recognized by the ICR engine, for the field named [FieldName]. If the field is not and ICR field or if that field contains no ink, the value will be empty. ICR_[FieldName]_Cfd : The confidence value (in percentage) of the engine for the value provided.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. PGC to PDF Converter Note This plug-in has been moved to the Legacy group. The PGC to PDF Converter task extracts the digital ink located in a PGC file and adds it to a blank PDF, creating one page per document in the PGC. It's main use is to process PGCs that generated errors when processing them, as part of an Error Handling process.
Task properties General Tab l PDF page size: Choose the page size of the output PDF. The default size is A2, and changing the format does not scale the digital ink. Ink appearing outsize of the selected page size will not be visible. 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... Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l Opening a configuration that contains plugins only available in PReS Workflow (such as Create PDF) from a PReS Watch installation will cause these plugins to be replaced by Unknown tasks. Opening the configuration in a PReS Production or Office installation or upgrading PReS Watch to PReS Workflow and re-opening the configuration will restore the plugins and their properties. About variables A variable is basically a keyword that points to specific location in your computer's memory.
Job Info variables Job Infos contain information on any job file that comes out of the initial input task or any secondary input tasks. There are only 9 Job Infos available numbered from 1 to 9. They can be accessed directly anywhere where variable properties are accepted, by using the number of the variable preceded by a percent sign, for example, %2 or %9. Not all available Job Infos will actually be used by input tasks.
Note that Job Infos don't change whilst the task executes. Consequently, the value of the field that contains the Job Info will be the same in each of the records in the resulting record set.
Variable Name Example value when interpreted %F Job file path and name C:\Program Files\PReS Workflow 7\PlanetPress Watch\Spool\job1D80328.dat %f Job file name including the file extension job1D80328.dat %z Job file size in bytes 34134 %o Original file name invoice_june2nd.
Variable Name Example value when interpreted (short text) %h Current hour 18 %n Current minute 03 %r Run mode (0: runtime, 1:debug) 0 %s Current second 41 %v Current millisecond 24 %u Unique 13-char string (will be different every time it is used) 0ZIS4CW8U47VI00 %U Unique 36character string consisting of 32 alphanumeric, lower case characters and four hyphens. Format: xxxxxxxx-xxxxxxxx-xxxxxxxxxxxxxxxx (8-4-4-4-12 characters).
Variable Name Example value when interpreted %t Current temporary folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PReS Workflow 7\PlanetPress Watch\Spool\6.tmp\ %e Current Metadata file name job00ZAIZ2C4FXON16CE6C566.dat.meta %E Current Metadata path and file name C:\Documents and Settings\All Users\Application Data\Objectif Lune\PReS Workflow 7\PlanetPress Watch\Spool\5.tmp\job00ZAIZ2C4FXON16CE6C566.dat.
Initial input tasks do not modify the value of %i. However, the following tasks do trigger the variable: l Barcode scan l Capture Field Processor l All Splitters (Including the Metadata Sequencer) l Get Capture Document l Loop l Capture PGC Splitter l PrintShop Mail Error handling variables The error handling variables are read only and are filled by the On Error mechanism.
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.
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 733). 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 432. 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.
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 Pattern A series of dots placed in a pattern that is unique to each page where the pattern is printed. The Anoto Digital Pen identifies this pattern and its location on the page. PlanetPress Capture contains 20,000 patterns (8 in demo mode, See "PlanetPress Capture License Management" on page 792) which can be used to generate documents. Capture Condition PReS Workflow task that is used for post-processing of documents after they have been processed by the Capture Fields Processor.
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.. This can happen in architectures with more than one sequence being used such as when a pen is docked in the wrong location or if two pens are swapped. ICR (Intelligent Character Recognition) Recognizing text that has been hand-written with the Anoto Digital Pen.
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. Pidget Type of PlanetPress Capture object.
with Capture Fields, you must review and understand the Critical PlanetPress Capture Implementation Restrictions. Database considerations (ODBC) Note On 64-bit operating systems, the ODBC Data Sources created by the Data Source (ODBC) icon in the Administrative Tools will not appear here, as PReS Suite is 32-bit and cannot access the 64-bit data sources. In order to create an ODBC connection visible by PReS, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\o
l l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database can be in any location, but performance will depend on the speed of the connection between PReS and the MySQL server. MySQL's performance has been slower than SQL Server and SQL Server Express during our tests. By default, MySQL is configured not to allow any SQL request larger than 16 megs.
l In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue. Security Considerations PlanetPress Capture introduces new and efficient methods for digitally capturing the contents of ink laded out on physical paper. However, because of its nature, some end users may voice concerns about security and privacy.
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. This means someone located anywhere between penDirector and PReS Workflow could use software such as a packet sniffer to retrieve its parts and recreate the PGC files. This may be resolvable by create a secure VPN tunnel for each location where penDirector is installed instead of going through regular remote HTTP server.
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. Another single pattern is used to register pens in the database, and one last single pattern is used when printing a "Preview" from PlanetPress Design.
out of patterns only after 10 days, assuming the numbers remained completely static. Since there are easy ways to deal with these remainders (a simple automated process that, once a day, closes any document that is older than 48 hours, for example), a correct implementation like this one would be perfectly functional and not be affected by the 20,000 page limit.
Pattern Sequences can be handled in 2 different ways: by attaching a Pattern Sequence to a specific pen, or by attaching it to a specific PReS Workflow process. Here is an example for each cases, using a typical situation of a shipping company that uses PlanetPress Capture to simplify the archiving of the client's signature on a "Confirmation of Reception" slip. l Pen-Based Sequences: In this case, each pen is attributed a specific pattern sequence.
communication to receive pen data and transmit it to PReS Workflow, can still be used with both pattern sequence methods, as it is the equivalent of a docking station on the web. PlanetPress Mobile was added to PlanetPress Capture in version 7.4. Contamination The single but critical danger with any implementation that deals with PlanetPress Capture is "Contamination". Basically, contamination happens when an Anoto Digital Pen writes on a "wrong" document or is docked in the wrong location.
Third, contamination (the most common one) can happen if pattern sequences get mixed up, if pens or paper gets swapped between users, etc. For example, again using a shipping company (with example 2-A), if two of the drivers were to meet for a coffee and exchange their pens inadvertently (we hope, anyways), the pens would be signing the "wrong" documents all day and, when docked, would update the wrong documents in the database.
Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc. The penDirector creates a bridge between the Anoto Digital Pen and a PlanetPress Capture workflow in PReS Workflow. In order to use penDirector, it needs to be downloaded from the Objectif Lune website, on this page. This software must be installed after PReS Workflow. The setup will install a preconfigured version of penDirector which can be immediately used with PlanetPress Capture.
2. Note down the PIN of the Anoto Digital Pen, by docking the pen and going in the Pen settings tab of penDirector and looking at the Pen access group at the bottom of the dialog. The default PIN is 0000. 3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4. Go in the Bluetooth tab of penDirector and click on Add Pen. 5. Click on Search while the cap is off on the pen. 6.
between the pen and the mobile phone is done through Bluetooth, while the connectivity between the mobile phone and PReS Workflow is through the currently active data plan (either wifi or the cell phone company's data plan, such as 3G). PlanetPress Capture Implementation Restrictions This document describes the limitations of the Anoto Digital Pen & Paper Technology, especially in regards to using it within a PReS Workflow implementation.
Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
This is because the pen's camera (which captures the position of the pen) is located under the pen tip and must fully see the pattern.
Knowing this, the best practice when creating fields is that they have, at the very least, a 7mm margin on each size of the actual area you want to capture from. For example, an effective 30mm wide pattern will actually be 44mm wide using these margins. The margin should be for both the vertical size and the horizontal size.
PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition". The difference between the two is easily explained: While OCR can only recognize characters using the finished shape (for example, in scanned documents and pictures), ICR relies on much more data which is provided by the Anoto Digital Pen: the path that the pen takes, the exact timing of this path, start and stop points, etc.
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 531 l "Get Job Data" on page 536 l "Job Processor" on page 540 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 506. Plugin Legal Notices and Acknowledgments Copyright © 2022, Upland Objectif Lune 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.
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 772. 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 764. 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 812 l "PReS Fax plugin preferences" on page 812 l "FTP Output Service preferences" on page 816 l "PReS Image preferences" on page 816 l "LPR Output preferences" on page 820 l "PrintShop Web Connect Service preferences" on page 821 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 784.
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: OL Connect tasks communicate with the OL Connect Server using TLS 1.2. l l l l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server.
Text formatting features such as kerning, bold, exponential, etc, may cause these fragments to be considered as separate even if, to the naked eye, they obviously belong together. The PDF Text Extraction Tolerance Factors is used to modify the behavior of data selections made from PDF data files from within PReS Workflow. Each factor available in this window will determine if two fragments of text in the PDF should be part of the same data selection or not.
Font Delta Height Defines the tolerance for the difference in average height of fonts in the two target fragments. The higher the number, the more difference in average font heights will be accepted. The average font height is bigger in text written in uppercase than text written in lowercase. At 0, the font size must be exactly the same between two fragments. At 1, a greater variance in font size is accepted. Accepted values range from 0 to 1. The default value is 0.65, recommended values are between 0.
process. l Log level group l l l l l l l Startup and shutdown: Select to only track when the PReS Workflow service is started and stopped. Task failure: Select to only track when tasks in the processes running in a PReS Workflow configuration fail. Task success and failure with details: Select to track when the tasks in processes running in PReS Workflow succeed and fail, with details. Details can include why tasks fail and how successful tasks are executed.
Messenger plugin preferences Apart from enabling communication between the various parts of PReS Workflow, the PReS Workflow Messenger also manages local instances of the PReS Workflow Alambic. The Messenger service uses the SSL 2.3 protocol. Preferences l PReS Alambic options group l l l Let me set up how many instances to run: Select this option if you want to limit the number of instances of the Alambic that PReS Workflow can run.
To open the Preferences dialog, click the PReS Workflow button and then the Preferences button, or use the key combination Ctrl+Alt+P. The HTTP Server Input 1 plugin preferences can be found under Plug-in. Preferences l l l Port: Select the port to use. The default port is 8080, the official HTTP alternate port, so as not to interfere with the standard HTTP port (80). To block any regular HTTP traffic (for example if only using HTTPS connections) the port can be set to 0.
l l l Key: Enter the absolute path to the Private Key file. This file generally has a .key extension. Password: Enter the password (or passkey) for the Private Key file. The maximum length of this password is 64 characters. This password is encrypted within PReS Workflow server and is not saved in plain text. Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. The service uses SSL 2.3 or TLS 1.0.
l l l l None: No special processing is applied. Use PHP-like Arrays: When the name of form inputs contains two pairs of square brackets, the data are interpreted as an array. The result is a single XML node (named after the value between the first pair of square brackets) with each part of the array as children. See: "PHP arrays example" below.
Incoming HTML PAGE 803
122 253 dent 361 341 dent HTTP Server Input plugin preferences 2 The second set of HTTP Server Input plugin preferences is used to enable serving static HTTP resources, as part of an HTTP Server workflow. These resources are referred to within the HTML response file and do not pass through a process to get served so the process is very quick.
href="images/faces/johnsmith.jpg". l Capture OnTheGo group l l Cross-Origin Resource Sharing (CORS) l l Authentication Key: Enter the authentication key for the COTG repository. This key can be found in the Settings section of the COTG Web Administration Panel. Allowed Origins: Enter an origin (everything in a URL before the path, e.g. http://www.example.com).
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 l l Strict RFC 1179 control file: Select to disable control file extensions the LPD service implements for some flavors of UNIX and LPR. This enforces the basic Line Printer Daemon protocol. Enable BSD compatibility mode: Select to have the LPD service emulate a BSD UNIX server. Although RFC 1179 is supposed to describe the BSD LPD/LPR protocol, and the LPD input in PReS Workflow is RFC1179-compliant, there are some incompatibilities between the RFC and the BSD implementation.
l l Time out: Set the timeout period in seconds. The default value is 120 seconds. Enable server for HTTPS requests: Check this option to accept secured, encrypted requests from web clients. The encryption protocol is TLS. Note HTTPS requires two certificates: a Root Certificate and an accompanying Certificate. These are obtained from a Certificate Provider such as Thawte or Verisign, or through the use of certificate generators such as openSSL.
NodeJS Server Input plugin preferences 2 The second set of NodeJS Server Input plugin preferences is used to enable serving static HTTP resources, as part of a NodeJS Server workflow. These resources are referred to within the HTML response file and do not pass through a process to get served so the process is very quick.
l Allowed Origins: Enter an origin (everything in a URL before the path, e.g. http://www.example.com). The Workflow server will add this value to the Access-Control-Allow-Origin header, which signals to the browser that it is allowed to make the request. This enables cross-origin resource requests, such as AJAX requests. The default setting "*" is a wildcard that allows all cross-origin resource requests.
Testing the server l To test the server address and domain, enter a username and password and click the Test server button. Note The user name and password aren't part of the plugin preferences. Users will have to provide their credentials themselves and will be presented with an HTML page for that purpose. Changing the Log in page You can change the look and feel of the login window if you are familiar with the EJS templating syntax.
Serial Input plugin preferences Serial input plugin preferences control certain functions of the PlanetPress Serial Capture service, which in turn has a direct impact on all Serial input tasks performed by PReS Workflow on a given computer. Preferences l Serial settings group l l l l l l Serial port: Select the port of the computer where the Serial input is connected to (COM1 through COM8). Baud rate: Select the baud rate of the Serial input.
received data files are not passed to the rest of the process; the Serial input resets, ready to receive further data files. l l Job delimiters: Enter the strings that tell PReS Workflow the data file being retrieved through the Serial input is complete. Each line in the Job delimiters text box is a different delimiter. You can enter as many delimiters as you want, one per line. The three default delimiters that appear are three of the most commonly recognized end of a file delimiters.
So you should consider changing the PReS Fax user options on the computer that actually performs the PReS Workflow Fax output tasks. The changes you make to the PReS Workflow Fax plugin preferences are stored in the PReS Fax configuration file. They will be applied when PReS Fax is started. Preferences l l Delete log after: Enter the number of days after which to delete the PReS Fax service log.
l Windows Fax Service l l l l l l Report Failures: Select to have PReS Fax generate a report whenever the maximum number of retries for a single fax is exceeded. The error generated by the Windows Fax Service is also logged in the report. Note that when PReS Fax is unable to send a fax because an empty fax number is used as the only recipient for a document, a failure will not be reported but an error will be logged.
l l l l Report Successes: Select to have PReS Fax generate a report whenever one of the faxes in the PReS Fax Job reaches its destination successfully or at least as far as the Windows Fax service is concerned. Folder: Enter or select the location of the report file. PReS Fax generates report file names automatically with the file name extension PFX.
l l About: Click to display an About dialog box for PReS Fax. This dialog box contains information such as the version number, whether the software is activated or the number of days remaining in the trial. Select Language: Click to select a different interface language for the PReS Fax Configuration applet. Note that this button is not displayed if you edit the PReS Fax options directly (not via PReS Workflow Configuration program).
include error and logging options, PReS Search database options, as well as networking and email options. Bear in mind that Image Output tasks included in a given PReS Workflow configuration can be performed by a PReS Image installation running on a different computer, typically one that runs only PReS Image. When you change the user options on a given computer, only that computer is affected. So you should change the Image user options on the computer that actually performs the Image Output tasks.
folder, which is located in the PReS Workflow installation folder. This log may be on the local computer running PReS Workflow or on another computer on your network. l l l l Activation: Click to enter activation codes for the PReS Image service installed on the same computer as PReS Workflow. If you have already activated the PReS Image service from its Control Panel applet, this is reflected when you open the Activation dialog box by clicking this button.
l l Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database. User ID: Enter the user id required to access the database to which you are adding new PDI files from the generated PDF files. If you are using an SQL database, enter the login name you chose when you configured the SQL database (refer to the “Using PReSSearch with an SQL Server Database” section of the PReS Search User Guide).
l l Outgoing mail (SMTP): Enter the IP address of the server that PReS Workflow uses to send the emails via SMTP. Server requires authentication: Select if the outgoing server used to send the emails via SMTP requires authentication. Note that if you select this option, you will be required to enter information in the Account name and Password boxes below. l l Account name: Enter the account name of the user on the server to be able to send emails via SMTP.
l l Error handling group l l l l Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service. Max. retry period: Select the maximum time period, in hours, within which PReS Workflow attempts to dispatch the job using the LPR output before giving up. Note that entering a maximum retry period of 0 hours disables retries altogether.
Note It is also mandatory to send your configuration to your PReS Workflow service since the PrintShop Web credentials are included in the *.cfg file (See "Sending a configuration" on page 36), which is updated every time the configuration is sent to the service via the Send Configuration button.
l l l l l l l l l Backspace unindents: Select to move the insertion pointer to the previous indentation level when you press BACKSPACE. This is useful when you enter a block of code such as a for loop; you enter the for statement, advance one indentation level to enter the body of the for loop, then press BACKSPACE to enter the end for statement. You must select Auto indent mode to use this option.
l l l l l l l Enable dragging: Select to permit dragging and dropping a selection to reposition it in the code. This option works only if you also select Enable selection. Enable search highlight: Select to highlight the search term match found in the code when you perform a search. Clear to prevent the highlighting. In both cases, the pointer appears after the last character of the search term match. Double click line: Select to highlight the complete line of code when you doubleclick that line.
l l l Sample: Displays a preview of the font selected in the Editor font option, at the size selected in the Size option. Margin and Gutter Group l l l l l l l Use monospace fonts only: Select to display only fixed width fonts in the Editor font drop-down list. Every character in a fixed width font occupies the same amount of space. Right margin: Select to display a vertical gray bar as a right margin indicator. Use the Right margin position drop-down list to set the position of this indicator.
change their pre-sets by selecting them in the Element list box and editing their values. l l l l Element list box: Select a script element in the Element list box, then edit the background and foreground color with which it is displayed, and/or its formatting attributes. Each element recognized for each scripting language, for example, a URL in a JavaScript script, is displayed with the properties you set.
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 837. l " The Quick Access Toolbar" on page 902. This toolbar is customizable. l The ribbon tabs; see "The PReS Workflow Ribbon" on page 903. l "The Process area" on page 893 l "Configuration Components pane" on page 838.
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 836.
l Delete: Deletes the process from the configuration. l Rename: Renames the process. l l l Startup: Triggers whether the process is a startup process (runs before any other process). l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties, for scheduling and error handling. Subprocesses: Displays a list of subprocesses in your configuration (see: "About processes and subprocesses" on page 125).
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 844. 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 672) 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 798. 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).
l Week of month / by date: Select the desired option for the time grid. Note that any selection you make in this box will be interpreted based on the selection made in the Month box. If you chose All months in the Month box and Last in the Week of month / by date box, then the process will run on the last week of every month. If you chose January in the Month box and First in the Week of month / by date box, then the process will run only on the first week of January.
l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two. l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
l l l To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler. To deselect all the days or dates for a given time segment, CTRL+click the time segment on the left grid ruler.
On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings. The Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
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 775).
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 98). It is divided in 4 sections: l l l l Job Information: Displays the Job Info variables, as well as the job's file name, size, last edit date and presence of metadata (see "Job Info variables" on page 723). Local Variables: Displays all the variables local to this process (see "Local variables" on page 729).
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 98.
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 545. l Document Management; see "Document Management tasks" on page 632. l Outputs; see "Output tasks" on page 608. l Legacy; see "Legacy tasks" on page 667. 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.
Workflow tool. For information on removal of custom plugins see "Deleting a custom plugin" below. l Revert to the default Plug-in Bar by selecting Reset to default. Custom plugins will remain as installed. 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.
the upper left corner. When you create a new process, this first task is always followed by the default Output task in the following box.
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). To copy and paste tasks or branches: 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.
Note You can only paste the properties of an Input task on the initial Input task of your process. Similarly you can only paste the properties of an Output task on another Output task. Also, you cannot paste the properties of a task on a branch and vice versa. 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.
Turning highlighting on and off via the task's contextual menu doesn't change the highlight color. Disabling tasks and branches PReS Workflow lets you ignore individual tasks, branches or conditions. 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 106) 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.
Moving a task or branch using drag-and-drop To move a task or branch using drag and drop: 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.
Removing tasks or branches To remove any task or branch (except Input and Output tasks), use one of the following methods: 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.
Note You cannot replace a task by a branch or a condition. Trying to paste or drop a branch or condition over a task will insert it before the task instead. The contrary is also true, you cannot replace a branch or condition with a task. Warning When you replace a task, you lose all the properties you set in this task.
l l l Double-click the right corner of the line of the Branch or Condition. Right-click the icon of the Branch or Condition or the right corner of its line, and select Collapse or Expand. Select the icon of the Branch or Condition or the right corner of its line. Then you can either: 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.
The Quick Access Toolbar The PReS Workflow Quick Access Toolbar is displayed, by default, on the right side of the PReS Workflow Button and provides one-click shortcuts to commonly used functions and features. You can add as many buttons as you want to the Quick Access Toolbar and remove them at will. 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.
2. Click on Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon, depending on where you want it. The PReS Workflow Ribbon The PReS Workflow Ribbon centralizes commands, organizing them into a set of Tabs, each tab containing groups of controls. Each tab on the Ribbon displays the commands that are most relevant to a given feature set. The built-in Ribbon and Quick Access Toolbar contain commands that are frequently used and convenient to keep close at hand.
l The View tab includes the Arrange, Navigate and Show/Hide groups.
l l l l l l The Configure Services control loads the PReS Workflow Services dialog to configure the user account PReS Workflow should use. 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. The Document Manager button opens the " PlanetPress Document Manager" on page 786. The Pen Manager button opens the "PlanetPress Capture Pen Management Tool" on page 790.
The Task Comments Pane The Task Comments pane displays comments relevant to the currently selected items, such as the contents of the Comments tab of any task in the currently selected process. The Task Comments pane cannot be used to edit the comments themselves - only to see them. to edit the comments, the properties of the task must be opened, and the comments changed in the Comments tab.
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. 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.
The log viewer for the current day is always live, meaning it updates automatically as the log file is updated by the appropriate service. Viewing older log files To open an existing, older log file: 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.
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 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 l Tern which is distributed under the terms of the Eclipse Public License (EPL) Version 1.0. The source code for tern can be obtained from the following location: https://github.com/angelozerr/tern.java Web Services Description Language for Java which is distributed under the terms of the Common Public License v 1.0. The source code for this can be obtained from the following location: http://wsdl4j.cvs.sourceforge.
l Apache Commons IO l Apache Commons JCS Core l Apache Commons Lang l Apache Commons Logging l Apache Commons Pool l Apache Commons Text l Apache Commons Validator l Apache Derby l Apache Felix and dependencies l Apache Geronimo l Apache HttpClient Mime l Apache POI l Apache ServiceMix l Apache Xerces2 Java Parser l Apache XML Graphics l Apache XML Beans l Barcode4j l Google Collections l Google GSON l Hibernate Validator l Jackson JSON processor l Jetty l Liqui
l Spring Dynamic Modules l UCanAccess l Woodstox Eclipse Technology: This Software includes unmodified Eclipse redistributables, which are available at www.eclipse.org. The Eclipse redistributables are distributed under the terms of the Eclipse Public License - v 1.0 that can be found at https://www.eclipse.org/legal/epl-v10.html. VSS Java FreeMarker: This product includes software developed by the Visigoth Software Society (http://www.visigoths.org/).
license from Oracle. “Commercial Features” means those features identified Table 1-1 (Commercial Features In Java SE Product Editions) of the Java SE documentation accessible at http://www.oracle.com/technetwork/java/javase/documentation/index.html. Further Components: l l l This product includes software developed by the JDOM Project (http://www.jdom.org/). Portions of this software are copyright © 2010 The FreeType Project (www.freetype.org). All rights reserved.
