User Guide Version 2022.2.3 Last Revision: 2023-02-22 Upland Objectif Lune 2409 46e Avenue Lachine QC H8T 3C9 Canada All trademarks displayed are the property of their respective owners. © Upland Objectif Lune. 1994-2023. 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 Welcome to PReS Workflow 2022.
Basics Related tools and resource files Features About Workflow Configurations 32 32 33 33 Creating a new configuration 34 Open a PReS Workflow configuration file 34 Saving and sending a Workflow Configuration 35 Exit PReS Workflow Configuration program 37 Workflow Configuration resource files 37 Connect resources 38 PlanetPress Design documents 41 PrintShop Mail documents 45 About data 46 About documents and variable data 46 Job file 47 Job file names and output file names 47 Da
Triggers 102 Objectif Lune Printer Driver (PS) 102 About processes and subprocesses 104 Processes 104 Startup processes 106 Subprocesses 106 Creating a process 106 Importing processes 108 Activating or deactivating a process 109 Process properties 110 About branches and conditions 113 Converting a branch to a subprocess 115 Using Scripts 117 Run Script task 117 APIs 118 The Script Editor and XSLT Editor 118 SOAP Server API Reference 123 The Watch Object 129 Data Repositor
PasteAt(Integer Index) 181 Select(TSelectWhat SelectWhat) 181 SelectedDatapageCount() 181 SelectedDocumentCount() 182 SelectedIndexInDocument() 182 SelectedIndexInGroup() 182 SelectedIndexInJob() 182 SelectedPageCount() 183 Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3) 183 Parameters 186 Exceptions 186 Parameters 187 Exceptions 187 Parameters 188 Returns 188 Pa
About PReS Image 279 OL Connect Send 280 ZUGFeRD 280 About related programs and services 281 Available Input services 282 Available Output services 282 Start and stop PReS Workflow Service 283 Users and configurations 284 Workflow Services 285 About Tasks 286 Adding tasks 287 Editing a task 288 Task properties 288 Variable task properties 289 Masks 291 Date and Time Format 291 Masks 291 Selecting a resource file in task properties 292 Variable file name Input tasks 293
WinQueue Input Action tasks 348 350 Add/Remove Text 351 Advanced Search and Replace 352 Barcode Scan 355 Change Emulation 360 Create PDF 364 Database Query 368 Decompress File(s) 373 Digital Action 374 External Program 383 Load External File 385 Logger 385 Mathematical Operations 386 Open XSLT 387 PDF/A-3 Attachments 389 Push to Repository 392 Rename 393 Run Script 394 Search and Replace 396 Send to Folder 397 Set Job Infos and Variables 398 SOAP Client plugin 39
Text Condition 431 Time of Day Condition 432 Connector tasks 433 Available Connector tasks 434 Delete Capture OnTheGo Document 434 Input from SharePoint 435 Laserfiche Repository Output 438 Lookup in Microsoft® Excel® Documents 440 Output to Capture OnTheGo 443 Output to SharePoint 446 PReS Fax 448 PReS Image 450 PReS Print Controls 458 ZUGFeRD plugin 461 Metadata tasks 467 Create Metadata 467 Embed/Extract PReS Workflow Metadata 469 Metadata Fields Management 470 Metadat
Merge Jobs 531 PDF to Bitmap 531 Render Email Content 533 Retrieve Items 537 Set Properties 541 Update Data Records 542 Output tasks 543 Available Output tasks 544 Delete 544 FTP Output 545 Microsoft 365 Email Output 546 Microsoft 365 OneDrive Output 549 SFTP Output 551 Print using a Windows driver 553 Printer Queue Output 555 Secure Email Output 557 Send Email 560 Send to Folder 563 Document Management tasks 564 DocuWare 564 M-Files 574 Input from SharePoint 581
Inactive process Object Inspector appearance preferences 638 638 Colors 638 Options 638 Configuration Components pane appearance preferences 639 Colors 639 Options 639 Default configuration behavior preferences 639 Notification Messages behavior preferences 640 Preferences Sample Data behavior preferences Preferences Network behavior preferences Preferences PlanetPress Capture preferences 641 643 643 643 644 644 The available PlanetPress Capture user options are: 645 PlanetPress
SMTP Input preferences Preferences Telnet Input plugin preferences Preferences PReS Fax plugin preferences 667 667 668 668 668 Preferences 669 OpenText RightFax options 671 FTP Output Service preferences Options 671 671 PReS Image preferences 672 PReS Image 1 or logging tab 672 PReS Image 2 or database tab 673 PReS Image 3 or network tab 674 PReS Image 4 or login tab 674 LPR Output preferences 675 Options 675 PrintShop Web Connect Service preferences 676 Editor Options 676 The
Data Selector display preferences 713 The File Viewer 716 LaserFiche Repository Output Task - Configure Tags 716 LaserFiche Repository Output Task - Configure Templates 716 PDF Viewer 718 Printer utilities 719 Process properties 721 Rule Interface 724 The PReS Workflow Service Console 727 Task Properties dialog 730 Update document 731 Virtual Drive Manager 731 The Debug Information pane 731 The Message Area Pane 732 The Object Inspector pane 733 Editing properties 733 The Plu
Welcome to PReS Workflow 2022.2 This PDF documentation covers version 2022.2. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow plays a major role in many 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.
l "Setting up the working environment" on page 24 l "Known Issues" on page 27 System requirements These are the recommended system requirements for PReS Workflow 2022.2. Operating System l Microsoft Windows 11 l Microsoft Windows 10 (Pro and Enterprise versions only) l Microsoft Windows 8.1 l Microsoft Windows Server 2022 l Microsoft Windows Server 2019 l Microsoft Windows Server 2016 l Microsoft Windows Server 2012/2012 R2 Note: PReS Workflow2022.
Minimum hardware requirements As with any software application, minimum hardware requirements represent the basic hardware on which the software will run. Note however that settling for the minimum specification is unlikely to produce the performance you expect from the system. It can be used when configuring a trial or a development system, however.
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. l The Connect Server module requires more RAM and benefits from fast multi-core CPUs. Disk access speed is less of a concern. l The Connect Designer module requires more RAM and fast disk access to provide a responsive user-experience.
Caution: The PReS Workflow End-User License Agreement (EULA) specifies that a PReS Workflow software license may only be used on a single virtual or physical PC at a time. While copying a virtual machine for backup purposes is acceptable, running two instances of the same machine, using the same serial number, is strictly prohibited. 32-bit or 64-bit? PlanetPress Suite version 7.1.3 and higher, as well as PReS Connect, support a 64-bit operating system.
this folder, unless you notice performance issues when generating PDFs, and then only as a test. l Processes: l FTPPutService.exe l HTTPService.exe l LPDService.exe l LPRService.exe l PPWatchService.exe l PSWService.exe l SerialService.exe l SMTPService.exe l TelnetService.exe l ppNode.exe l PPFaxService.exe l PPImageService.exe l MessengerService.
For details on how to upgrade the Connect License see Users of Connect prior to 2019.1 in Connect's Online Help. Always backup before upgrading It is recommended that you always backup your existing Workflow files and preferences before upgrading to a new version. This will enable you to revert back to the previous version, in a worst case scenario in which the new version introduces issues with your existing production processes.
Then comes the Component Selection page, where the different components of Workflow can be selected for installation. Currently, the following are available: l l PReS Connect Workflow: This is the main Workflow program. PReS Connect Imaging: Imaging is an optional add-on and purchased separately from Connect. It is broken up into different components: l l PReS Connect Image: This is the main component required to use Imaging. l PReS Connect Fax: Required for sending faxes through Workflow.
The Product Update Manager If the Check for Update option has been selected, a message will be displayed after clicking Finish in the setup. The message details the information that needs to be sent back to Objectif Lune Inc. in order to determine whether the software needs updating. Click Yes to install or open the Product Update Manager where the frequency with which the updates can be checked and a proxy server (if required) can be specified.
SHORTCUTS = 0/1 (Creation of desktop icons. 0 is the default if not selected) UNINSTALL = 1 (Uninstall mode) 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, the Image and Search modules and prepares desktop shortcuts for each: "c:\
Preferences button under the PReS Workflow (W) button, or via the key combination Ctrl+Alt+P . Network considerations While PReS Workflow is typically installed on a server machine that is only accessed by one single user such as an IT person, multiple users logging on to that machine is a possibility (except with terminal servers, see "Environment considerations" on page 18).
In addition, the use of network shared drives can cause issues when attempting to capture files from those locations since the notification process for folder changes on network shares may be different than that of local folders. Network ports used by each service The port configuration for each PReS Workflow Input task or Output task is described in the following table. The port number assignments comply with Internet standards. If a PReS Workflow component is not active, the port is not used.
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 net- work database. Known Issues Microsoft patch causing handling of XLS to fail Some Windows updates from Microsoft have impacted the handling of XLS sources in PReS\PlanetPress Workflow 8.
Data Repository error The Push to Repository task, as well as the corresponding repository API calls SetValue() and SetValueW() may on rare occasions fail with an unexpected error (517), caused by the Write Ahead Logging (WAL) journal mode. The workaround is to disable WAL journal mode: 1. Create the "Repository" key in \HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Objectif Lune\PlanetSuite\PlanetWatch\8.0\ if it does not exist. 2.
l Printing PDF files in passthrough mode using a Windows Printer Driver task causes jobs to be processed sequentially rather than in parallel. This is caused by a 3rd party library used in the printing process. Possible workarounds are to use a PlanetPress document to call the PDF files as dynamic images, or to use the PDF file as the Data File for a PlanetPress Document.
1. Open a command-line window (CMD.exe) 2. Type "AT 10:56 /INTERACTIVE CMD.EXE" (replace 10:56 with the next upcoming minute on your system) 3. At the specified time, a new command-line window opens. In it, navigate to Word Installation folder, then type Winword Follow the instructions to complete the installation 4. Re-start PReS Workflow and test your process. l The WordToPDF task relies on MS-Word to perform its functions.
Obtaining a certificate Certificates are files that uniquely identify people and resources on the Internet. They are required to enable secure, confidential communication between two entities. For production purposes, it is highly recommended that you obtain a proper certificate issued by an official Certificate Authority (CA). Certificates can be obtained from many different commercial parties. If you use certificates for other applications, you are likely already dealing with a Certificate Authority.
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 24). 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.
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.
When you start the PReS Workflow Configuration tool, it either opens the configuration file that is active on the PlanetPress Workflow service, or starts with no configuration at all, depending on your preferences (see "Configuration Components pane appearance preferences" on page 639). You can always create a new configuration or open an existing one (see "Creating a new configuration" below and "Open a PReS Workflow configuration file" below).
1. Use Windows' File Explorer to navigate to the Workflow configuration file (.OL-workflow) that you want to open. 2. Double-click the file. If the currently opened configuration file includes unsaved modifications, the PReS Workflow Configuration program asks you whether to send the configuration to the PReS Workflow service before opening the selected configuration.
To save the current configuration under a new name: l From the PReS button, choose Save As. l Browse to the location where you wanted to save the file, enter the new name of the configuration in the File name box and click Save. Sending a configuration PReS Workflow Configuration saves entire configurations in the form of a single file. Like any other file, configuration files may be saved and reopened, as well as renamed as desired.
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 700. Note: If PReS Workflow service is paused when you send a new configuration, it will not stop and restart.
l PReS Connect Resources are files created with one of the other Connect modules - the Designer and DataMapper (see "Connect resources" below). l PlanetPress Suite users may use PlanetPress Design documents (see "PlanetPress Design documents" on page 41) in PReS Workflow processes. l PrintShop Mail Suite users may use PrintShop Mail documents to create output using the "PrintShop Mail" on page 608 task (see "PrintShop Mail documents" on page 45).
l Data mapping configurations l Data model l Templates l Job Creation Preset l Output Creation Preset 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.
Resource archives From version 8.2, PReS Workflow maintains an archive of previous versions of resources, in the following location: %PROGRAMDATA%\Objectif Lune\PReS Workflow 8\PReS Watch\OLConnect\Archive , each in their own folder: l datamapper contains archives of the data mapping configurations (.OL-datamapper) l jobcreation contains archives of the Job Presets (.OL-jobpreset) l outputcreation contains archives of the Output Presets (.
configuration. These data files appear under the data mapping configuration in the Connect 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 54) and makes it possible to debug it (see "Debugging your PReS Workflow process" on page 88). 1.
Generating output with PlanetPress Design documents PlanetPress Design documents are typically selected in certain Output tasks designed to merge data with a Design document, but they can also appear in other tasks that produce formatted data such as the Digital Action task and the Add Document task.
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.
1. Make sure the PPS/PSM Documents section is visible by clicking the 2. Expand the document (name.ptk) by clicking the button if it appears. button. 3. Right-click on the data file, then click Set as sample data file. Viewing an attached data file 1. Make sure the PPS/PSM Documents section is visible by clicking the 2. Expand the document (name.ptk) by clicking the button if it appears. button. 3. Double-click on the data file to open the data selector (see "The Data Selector" on page 710).
Viewing the Document Preview 1. Make sure the PPS/PSM Documents section is visible by clicking the 2. Expand the document (name.ptk) by clicking the button if it appears. button. The Document Preview has the same name as the document but with a PDF extension. 3. Right-click on the Document Preview, then click Open in PDF Viewer. Saving the Document Preview to disk 1. Make sure the PPS/PSM Documents section is visible by clicking the 2. Expand the document (name.
Importing PrintShop Mail documents This procedure describes how to import variable content documents created in PrintShop Mail (Suite, not Connect) into PReS Workflow. 1. Click the PReS Workflow button. 2. Choose Import, then Import PrintShop Mail Document. The Import PrintShop Mail Document dialog box appears. 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.
DataMapper, to produce a record set. A data mapping configuration contains a data model. Any Connect template constructed using the same data model can be merged with the resulting record set by an OLConnect Create Content task. In PlanetPress Suite, Design documents are typically associated with an Output task. PReS Workflow dispatches captured data (the job file) to PlanetPress Design documents directly.
l If the job file is processed by a Splitter action task, the task typically creates a number of new files which are all given new job file names. Since these files are generated and managed by PReS Workflow, you should not actually pay too much attention to their names. Many Output tasks, on the other hand, let you determine exactly how you want the files they generate to be named.
are always dynamic and depend on the job file that is currently being processed. There are several types of data selections you can use, depending on which emulation you are using, whether or not Metadata have been created by a previous task in the process, and whether or not data have been entered in the Data Repository. Adding a data selection A data selection can be used in any task property that may contain a variable (see "Variable task properties" on page 289).
l In the following rule, the question mark in the text-based data selection represents the current page number: (@(?,1,1,1,9,KeepCase,NoTrim) IS EQUAL TO Page 1 of) 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.
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.
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. Syntax region(page, left, top, right, bottom, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l region(): Always surrounds PDF data selections. l Page: The page of the PDF from which to retrieve the data.
l GetMeta(): Always surrounds metadata selections. l Field/Attribute Name: specifies the name of the field (or attribute, if the GetAttribute option flag is set) to retrieve (see "Metadata" on page 66). l Option Flag (optional): Sets the options for the selection (see table below). l Metadata Path (optional): Defines the precise path where the Metadata Field is located.
l l Case Options: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase characters as they are. l LowerCase: Converts all characters to their lowercase equivalent. l UpperCase: Converts all characters to their uppercase equivalent. Trim Options: Enter "Trim" if you want to trim empty spaces before and after the data selection or "NoTrim" to retain the extra spaces. About data emulation An emulation specifies how to interpret a data file.
Note that you cannot add characters in a CSV. Further note that if you remove characters in a CSV emulation, you should ensure that you do not inadvertently remove field or text delimiters. Add/remove lines: Enter the number of lines to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add lines; negative values remove lines. This is useful when one or more lines of input data precede the start of the first data page.
to use for the chosen data. Within PReS Workflow, the same emulation tools as in PlanetPress Design are available throughout your process, using the Data Selector. One notable exception however is that User-Defined Emulation is not available because it uses PlanetPress Talk code, which is not available within the PReS Workflow Configuration program.
defined in the Number of spaces in the tab box below. Note that this option is available only when the Read in binary mode option is selected. l Number of spaces in the tab: Enter the number of spaces you want the application to use when an isolated carriage return character is found within the data. This number typically corresponds to the maximum column number.
l Force one record per page: Select to force a single record per data page. If you clear the selection, a record may be split across data pages if necessary. If you want to avoid splitting a record across data pages, yet have several records in the buffer, select Force one record per page, and set the Pages in buffer option to the number of records you want the buffer to hold. l Delimiter: Enter the character that separates the fields of each record in the input data.
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 Set tab as field delimiter: Select to define a tab as the character that separates the fields of each record in the input data. Clear to use the Delimiter box to define that character. Database emulation The Database emulation differs from other emulation types.
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.
useful for legacy systems (such as AS/400 computers) that send data as text meant for older line printers using pre-printed forms. The emulation options are used to make sure your data is stable. Stabilizing data is the process of defining the size of the data page and where the first data page occurs in the data stream. A stable data page is critical to obtain accurate results. When you stabilize your data, you also need to consider the internal structure of each data page.
l Read in binary mode: Select this option to force the printer to read the incoming data in binary mode. Use this option with the ASCII emulation to fix problems related to line spacing caused by LFCR character pairs found within the data. Use it with the ASCII emulation and with the Tab on carriage return option to fix problems related to data formatting caused by isolated CR characters found within the data. This option can only be used with the ASCII emulation.
l Create a process that retrieves dynamic data from a data file. Once a sample data file is available, you can use it to make data selections in a process (see "Data selections" on page 48). l Debug a process (see "Debugging your PReS Workflow process" on page 88). Choosing a sample file sets the process's emulation to the chosen format (see "About data emulation" on page 54). The only other way to change a process's emulation is by inserting a "Change Emulation" on page 360 task in it.
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. Tip: Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file.
Note: Since the Workflow tool is a 32-bit application, it can only use 32-bit ODBC data sources. Make sure you use the proper Windows application (ODBC Data Sources (32-bit)) to create and manage data sources that can be used in Workflow. 5. Click Edit SQL to create the SQL query by hand to define the SQL query that retrieves the data your document requires. 6. Set the properties that define a record set: l Condition: Select the condition that signals the end of a record set.
Alternate syntax(not recommended): Select to prevent PlanetPress Design from automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the advanced SQL Statement dialog box. 6. Client side cursor: Select to download result sets to client computer running the SQL query.
Caution: When a user-defined emulation (created in PlanetPress Design) is used with Metadata, results and behavior are unknown and unsupported. For instance, refreshing the Metadata file may cause the document to crash and/or corrupt. For this reason, it is strongly advised to create backup copies of your documents beforehand. Metadata structure The hierarchical structure of the Metadata is composed of a number of basic levels for adding information to a job.
Note: Any operation that modifies the data with regards to the structure (ex: remove pages, alter the data, etc.) makes the Metadata obsolete and so it must be recreated or refreshed; see "Working with Metadata" on the facing page. Note: Metadata in OL Connect jobs In PlanetPress Suite, all levels in the Metadata hold information about an actual job. In Connect, that isn't the case. The Metadata file created and maintained by OL Connect tasks looks the same, but contains less information.
this property is set to true for all nodes. This property is not visible in the Metadata file, but it can be used in a Run Script task via the Metadata API. 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.
l "OL Connect tasks" on page 492 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. l The "Barcode Scan" on page 355 task can add information to the existing Metadata, and creates it if there is none.
Output issues caused by Metadata, and how to avoid them A Branch, Loop (the "PDF Splitter" on page 412, 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 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). l Step 3 checks if the first page is a separator (presumably by looking for some kind of keyword on the page). l If a separator page was found, step 4 creates Metadata for the split PDF… l ...
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 66 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.
Note: The presence of some finishing attributes depends on the PlanetPress Design document and target device used when producing the job. l Index/Count attributes are not part of the original Metadata file. They are evaluated dynamically, based on the content of the Metadata. Note: Metadata Index/Count values are one-based when viewed in the user interface: the first element in any collection has an index of 1 and the last element's index corresponds to the collection's length.
Attribute Description Category Job Group Document Datapage Page TargetDevice Name of the device for which the Metadata and associated data is intended. Production X Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input. Production X Dimension Two floating-point values separated by a colon indicating the media size in typographical points (ex: 612:792).
Attribute Description Category IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group. Index/Count IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
l www.json.org l www.w3schools.com JSON support in Workflow tasks and scripts PReS Workflow offers JSON support in and via the following tasks: l The "XML/JSON Conversion" on page 404 task converts an XML job file to JSON or a JSON job file to XML. l The following OL Connect tasks accept JSON data as input: "Create Email Content" on page 500, "Create Print Content" on page 513, "Create Web Content" on page 516, "Render Email Content" on page 533, and the "Create Preview PDF" on page 509 task.
"last": "Parker" } A JSON string with references to local variables and a Job Info variable (see "About variables" on page 238): { "first":"%{first}", "last":"%{last}", "email":"%2" } A JSON string containing a local variable and various Data Repository selections (see "Data Repository lookups" on page 51): { "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}'
{"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. { "data": { "schema": { "columns": { "ID": "STRING", "Gender": "STRING", "FirstName": "STRING", "LastName": "STRING" } }, "fields": { "ID": "CU00048376", "Gender": "M.
l An HTTP-based authentication process, once it has validated user credentials, could store session information (unique ID, user name, session starting time) into the repository. All other related processes could then look into the repository to determine if a new request is received from an already authenticated user, if the session has expired, what the user name is, etc. l Data comes in and is merged into a Capture OnTheGo template and stored in the Data Repository.
Note: Value_To_Matchcan be a static string, a jobInfo or a variable, but not a data selection. 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.
Examples JavaScript var repoObject = new ActiveXObject("RepositoryLib.WorkflowRepository"); repoObject.ConnectionString = "C:\\Users\\Administrator\\Desktop\\repoObject.Repository"; (In JavaScript, backslashes have to be escaped.) VB Script set repoObject = CreateObject("RepositoryLib.WorkflowRepository") repoObject.ConnectionString = "C:\Users\Administrator\Desktop\repoObject.
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 730. By default, any Action task, Branch, Splitter or Condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and Output tasks will not generate output.
When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded. If your process continues after the error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. All error codes are listed in the knowledge base of PReS Workflow.
Error handling variables The error handling variables are read only and are filled by the On Error mechanism. They can be accessed anywhere, but they only appear in the contextual menu of a task property field when the current process is an error-handling process (that starts with the Error Bin Input task). See also: "Variable task properties" on page 245. Variable Name %{error.process} Name of the process where the error was triggered. %{error.
l PReS Fax l PReS Messenger 3. When any job or file is processed by the selected service, the processing logs will be displayed in the window on the right. Note: The information that is displayed here is the same as in PReS Workflow logs and depends on the logging level that you set in the "General and logging preferences" on page 654 and on the 'Minimal logs' option in the "Process properties" on page 721.
submitted originally (polled by the initial input task) or to submit them to those tasks located on the index you select. The numbers on the left in the Process area indicate the task index. In the above image, the Folder Capture task is on level 1 and the Text condition is on level 4. Here's how to resubmit backed up input data files.
Caution: The From page and To page boxes are only useful for Printer Queue (or printer capture) Input tasks. They will not function for other types of inputs. In these cases, the complete backup job is submitted. 6. Click Send to resubmit the data. 7. To resubmit backed up input files for the same process or for a different one, repeat step 2 to step 6. 8. To close the File Resubmission dialog box, click Close.
Note: The sample job file should generally be the exact same format as the data that the process will receive when PReS Workflow is processing the job at run-time. About the Debug mode When debugging your process, it is important to keep in mind that: l The initial Input task is never executed. The sample data file is used instead of the initial run. This is to prevent "live" data from being retrieved by the initial input task while debugging is being done.
Use the Debug Information pane to see the current value of any variable in your process or globally, or to evaluate custom expression. See "The Debug Information pane" on page 731. Use the Object Inspector - one of the panes alongside the Debug Information pane - on the process to enter sample job information as required. The Debug ribbon provides the following buttons: l Click on Skip to ignore the next task or branch and go to the subsequent one. The job file is not modified in any way.
l Step through the process until you have reached the point after the emulation or data change. l Make the necessary data selections (see "Data selections" on page 48). Any data selection used in task properties after this point will use the new emulation. l Continue stepping through each task until the end of the process to debug it. This method does not allow you to add, remove or move tasks, however. The second method can be used when that is required.
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 506 task, and the "All In One" on page 493 task, which combines 4 different OL Connect tasks, including the Create Output task, within a single one.
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 41). Print output is normally generated by an Output task that merges a PlanetPress Design document with a data file (i.e. the job file). This can be either the "Print using a Windows driver" on page 553 Output task, or the "Printer Queue Output" on page 555 Output task.
l LPR Output printer queues are used to send print jobs to printers via the LPR/LPD protocol. See "LPR Output Printer Queue" on page 96. l FTP Output printer queues are typically used to send print jobs to FTP sites. See "FTP Output Printer Queue" on page 98. l Send to Folder printer queues are typically used to send print jobs to local or network folders. See "Send to Folder printer queue" on page 99. The properties associated with each queue will differ depending on the queue type.
to add it to the appropriate list. l Selected: Select either Pre-job commands or Post-job commands to add new commands to the appropriate list and to see those commands that have already selected. Double-click a command to remove it from the selected list. l Add: Click to add a new command to the list displayed in the Commands box. You must then edit the new command’s description and value. Note that new commands are shared by all printer queues.
Properties General tab l Printer queue: Select the Windows printer queue to which you want to send print jobs. l Job name: Enter the job’s file name. By default, the variable %f (Job File Name; see "System variables" on page 240) is used. You may use a different variable, but you may not use a data selection. This information may be used for the printer’s banner page. l Job owner name: Enter the job owner name. You may use a PReS Workflow variable.
Properties General tab l Printer address: Enter the IP address or host name of the printer receiving LPR jobs. l Queue name: Enter the printer queue name. Based on printer and network requirements, this property may not be required. l Data type: Select the proper data type. Select: l (l) Binary data if the job file is a standard binary file. l (f) Formatted text to interpret the first character of each line of text as a standard FORTRAN carriage control character.
l Delete: Click to remove a command from the Commands box. l Command description: Use this box to edit the description of the command currently selected in the Commands box. l Command value: Use this box to edit the code of the command currently selected in the Commands box. Use the right-click menu for a list of standard printer control characters. (See also: "Frequently used printer control characters" on page 95.
l Passive: Select to prompt the FTP client to use passive mode when sending files to the FTP server. Advanced tab 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. l Commands: The list of available commands appears in this box.
l Concatenate files: If this option is selected, when PReS Workflow tries to save the print job under an existing name, it appends the content of the new print job file to that of the existing file, instead of overwriting it. l Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected. Advanced tab l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue.
Associating PlanetPress Design documents and PReS printer queues One of the resources stored in a PReS Workflow printer queue is the list of PlanetPress Design documents associated with it. Also stored in the printer queue are the properties of each document associated with the queue. Note that Workflow printer queues are different from normal printer queues; see "PReS Workflow printer queues" on page 93. For more information about PlanetPress Design documents, see "PlanetPress Design documents" on page 41.
The settings available in this window are the same as the Printer Settings dialog of a document's properties in the Documents list of the Configuration Components pane, but they are specifically for this document on this printer queue. See "PlanetPress Design document properties" on page 692 for more details. Triggers In PReS Workflow, a trigger is typically a two line piece of PostScript code placed just before the data.
3. In the WinQueue Input plugin properties, click New. 4. Enter a Name for the printer queue. 5. Click OK. Every new Windows printer queue using the Objectif Lune Printer Driver (PS) is shared by default. 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.
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. In the WinQueue Input properties, select a Windows print queue using the Objectif Lune Printer Driver (PS) from the drop-down list. 5. Click OK. 6. Send the configuration and start your PReS Workflow service. 7. Start the windows application from which you want to capture data. 8. Open your selected document. 9. Click File | Print. 10.
terminates with one or more output tasks. In its simplest form, a process can retrieve data from a given folder and save it in a different folder. In most cases, though, processes are more elaborate and configurations, which may include many processes, can be extremely complex.
Startup processes Startup processes run only once before every other process in a given configuration. They can be used to perform operations that need to be completed once before the configuration can actually be run, such as to map network drives. The order in which the Startup processes are arranged in the Configuration Components pane determines, from top to bottom, the order in which the Startup processes are executed when the Workflow Service launches.
l In the Ribbon, go to the Home tab and click the Process button in the Processes group. l In the Configuration Components pane, right-click on any process or the Processes folder and select Insert > Insert Process or Insert Self Replicating Process. Regardless of the method, a new process is created with a default name (Process1, Process2, etc), an Input task and an Output task. The defaults are configurable in the "Default configuration behavior preferences" on page 639 screen.
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 689. 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.
l References to specific PReS Design or PrintShop Mail documents. Note that the documents themselves must be imported separately. l Specific printer queues. 5. Check Overwrite existing components with same name if you want processes with existing names to be overwritten by those in the imported configuration, or uncheck it to duplicate those processes under a new automatically generated name. 6. Click OK to start the import.
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. You can also double-click on the process to show its options. Note: Subprocesses do not have the General tab which is only used for scheduling, but they do have the Information tab. Options General tab l Active: Select to make the process active.
l Day(s) to keep backup: Indicate the number of days to keep backups of jobs processed by input tasks. Note that backups will only be kept for those input tasks that have the Keep backup file option selected and that they are required to resubmit input files. 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.
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. To activate the Time Grid, the "As soon as possible" option must be unchecked. In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not poll.
l To select the entire grid, use the Select All button located below the grid. To deselect the entire grid, use the Clear All button located below the grid. Caution: "Toggle" means turn on when it's off and vice versa, when selecting multiple blocks in one command. This means if you select a certain number of blocks in the Time Grid and then use the shift+click or drag method, blocks that are on will turn off.
an email address is found, or printing to a different printer depending on who sent you a print job. To do this, conditional branches ("conditions") are used. For the list of operations you can perform on Branches and Conditions, please refer to "The Process area" on page 736. Branches A branch is effectively a doubling of your job file (see "Job file" on page 47). As your job file goes down the process, when a branch is encountered, a copy of the job file will go in that branch.
Adding a branch or condition The PReS Workflow Configuration program offers two different commands when it comes to adding new branches to a process. l You can add a new branch by dragging and dropping a Branch task or one of the Condition tasks from the Process Logic category of the Plug-in Bar, into your process. Branches as well as conditions can thus be added like a task; see "Adding tasks" on page 287.
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.
l While JavaScript and VBScript are natively available on Windows operating systems, Python and Perl require third-party tools to be functional. For Perl, ActivePerl can be installed and for Python ActivePython can be installed.3. These links are provided for convenience only, and Upland Objectif Lune does not offer support for their use. APIs Multiple APIs (methods of communicating with PReS Workflow scripting tools) are available through the scripting engine, in all languages.
Note: 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.
3. Navigate to the location where you want to save the exported script. 4. Enter the name of the script in the File name box. 5. To save the script using a different scripting language or under a different file format, make a selection in the Save as type drop-down list. 6. Click OK. Find Strings in a Script The Find Text dialog box allows you to search for text strings in the editor. The available options help you limit the search, making searches quicker and easier.
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). If you limit the scope to selected text, you move backward only within the script selection. When the search reaches the beginning of the script or script selection, the search finishes.
l Selected text: Select to find matching text only within a text block you select. The text must be selected before you run the search. l Forward: Select to search the script forward, from the location of the cursor or from the beginning of the script, depending on what you choose as 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).
number drop-down list box. 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.
"GetProcessList" below Allows SOAP clients to request the list of available PReS Workflow processes, based on their authentication credentials. "GetProcessTaskList" on the facing page Allows a user to remotely request the tasks list of a process. This will be useful with the PostJob method since it needs a TaskIndex. "GetSOAPProcessList" on the facing page Allows users to request the list of PReS Workflow processes that contain a SOAP Input plugin with the SOAP action name.
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.
Syntax GetSOAPProcessList (user name, Password) : GetSOAPProcessListResult Description Parameters l user name: String containing the user name. l Password: String containing the password. This is case sensitive. Return Value l GetSOAPProcessListResult: Structure containing the following information: l Success: Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful.
l PostJobInfStruc: Structure containing any required information to prepare the file for resubmission into a PReS Workflow process (see "PostJobInfoStruc" below). l User name: String containing the user name. l Password: String containing the password. This is case sensitive. Return Value PostjobResult: Structure containing the following information: l Success: Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful.
SubmitJob The SubmitJob method allows a user to remotely submit files to their PReS Workflow from a SOAP client. The SOAP client has the option to wait for a response file from PReS Workflow SOAP server. Syntax SubmitJob (File, SubmitJobInfStruc , ReturnJobFile, user name, Password) : SubmitJobResult Arguments l File – base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64).
l The SubmitJob method only returns a file if the PReS Workflow process contains a SOAP Input task. l 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. l 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.
Variable Name Description Example Usage (VBScript) "Watch.ExpandResourcePath" on page 132 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). var fullPath = Watch.ExpandResourcePath("invoice.OL-template"); "Watch.ExpandString" on page 133 Retrieves the content of any Workflow string, containing any variable available to Watch, including data selections. var watchDate = Watch.
Variable Name "Watch.Sleep" on page 145 Description Example Usage (VBScript) Pauses all processing for X milliseconds. Watch.Sleep(1000); Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line. The program's execution will be directed by the appropriate flags specified as this method's parameters. Syntax Watch.
VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true Python Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, True) Perl $Watch->ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); Watch.ExpandResourcePath The Watch.ExpandResourcePath method expands a Connect resource file name (e.g. invoice.OLtemplate) to its fully qualified path (e.g. C:\ProgramData\Objectif Lune\PlanetPress Workflo
Watch.ExpandString Provides access to the emulated job file and to all variables. This function returns a string that is the expanded version of the input string. Syntax Watch.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.
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 652) 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 652), in the form of strings (host, username and password) and a number (port).
VBScript Watch.GetConnectTokenEx "localhost", 1234, "myUser", "secret" Python Watch.GetConnectTokenEx("localhost",1234,"myUser","secret"); Perl $Watch->GetConnectTokenEx("localhost",1234,"myUser","secret"); Watch.GetJobFileName Returns the complete path and file name of the job. This method is the same as PW_GetJobFileName. getjobfilename() obtains the file name of a PReS Workflow process. This is useful for manipulating the job file, for example to replace data within it.
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.Log("Jobinfo 3's value is: " + s, 2) Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("Jobinfo 3's value is: " . $s, 2); Watch.
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.GetPreferences The Watch.GetPreferences method returns a JSON string containing the preferences for the OL Connect Server and Workflow's HTTP Server, NodeJS Server and SMTP Server. Syntax Watch.
"version": "1.0.0.213 [Debug; Private build (Developer build)]", "edition": "PReS Workflow", "serialNumber": "CA00W-802058-5075", "currentUser": "LocalSystem", "workFolder": "C:\\ProgramData\\Objectif Lune\\PlanetPress Workf 8\\PlanetPress Watch\\", "httpServer": { "port": 8080, "portSSL": 443, "SOAPEnabled": false, "staticResources": [{ "endpoint": "_iRes", "folder": "" } ], "processes": [] }, "nodeServer": { "port": 9090, "portSSL": 8443, "SOAPEnabled": true, "staticResources": [], "proxies": [], "proces
Examples JavaScript Watch.GetPreferences(); VBScript Watch.GetPreferences Python Watch.GetPreferences(); Perl $Watch->GetPreferences(); Watch.GetResources The Watch.GetResources method retrieves a specific type of Connect resources when it is passed a file extension (e.g. "OL-template") or all Connect resources when it is passed an empty string. Files in the Connect resources folder are visible in Workflow's Configuration Components pane under Connect Resources (see "Connect resources" on page 38).
Watch.GetVariable Returns the string value of the corresponding variable name. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.GetVariable(Name: String): String Example JavaScript var s; s = Watch.GetVariable("MyVariable"); Watch.Log("MyVariable's value is: " + s, 2); s = Watch.GetVariable("global.MyVariable"); Watch.Log("Jobinfo 3's value is: " + s, 2); VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.
The Workflow process will wait for the file(s) to be unpacked or copied to the Connect resources folder, so that the next plugin in line that uses an installed resource will have the latest, up-to-date version of the file. Files in the Connect resources folder are visible in Workflow's Configuration Components pane under Connect Resources (see "Connect resources" on page 38). Syntax Watch.InstallResource(path) path A string containing the resource path. Examples JavaScript Watch.InstallResource("c:\\myfil
Arguments Message A string representing the message that is logged in the log file. Note that the text of the message must use the locale encoding of the system where the PReS Workflow software will be running, otherwise it will be unreadable. Level An integer between 1 and 4, specifying the severity level of the error message. Set message levels as follows. 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.
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.
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.
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.
Data repository structure The table below lists the different levels in the repository and what their names corresponds to: The term ... ... is the same as an Excel ... ... is the same as a Database ... Group Sheet Table Key Column Field KeySet Row Record Note: Group and key names are case-insensitive. API Reference Obtaining an instance of the Repository Object The Data Repository is accessed via a COM object that exposes methods to store and retrieve data within the Repository.
repoObject.AddGroup("MyGroup","['FirstKey', 'SecondKey']"); Many methods require using the JSONStringArray type but JSON is not natively supported in VB Script. Therefore, for those methods, only JavaScript sample code is provided. There are many resources on the Web that propose ways of implementing JSON parsing in VB Script so you can implement whichever you see fit. However, using JavaScript is highly recommended.
Name Description "RemoveKey" on page 157 Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised. All values for the key, in all keysets for the group, are removed. Note that when the Group contains a large number of KeySets, this operation may take a while. "RenameKey" on page 159 Renames key oldName to newName in group GroupName.
Syntax AddGroup(GroupName: string, keyNames: JSONStringArray) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 147). JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.AddGroup("Users", ''); VB Script repoObject.AddGroup "Users", "[""FirstName"", ""LastName""]" repoObject.
specify all available keys in KeyValues. Only the keys specified are updated in GroupName while unspecified keys are set to an empty string. Syntax AddKeySets(GroupName: string, KeyValues: JSONObjectArrayString): JSONIntegerArray Examples Basic 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 147). JavaScript repoObject.
'[131,132]' AddValue 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 150 for information on adding a key to a group. Upon successful completion, the method returns the ID of the newly created KeySet.
Syntax ClearGroupData(GroupName: string) 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.
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.WorkflowRepository"); var customer = repoObject.
Object" on page 147). JavaScript var myValue = repoObject.GetValue("Users", "email", " LastName='Smith' AND FirstName='John' "); /* retrieves email for John Smith */ var myValue = repoObject.GetValue("Users", "email", " LastName='Smith' "); /* retrieves email for first user named Smith */ var myValue = repoObject.GetValue("Users", "email", ""); /* retrieves email for first user */ VB Script myValue = repoObject.
JavaScript var repoObject = new ActiveXObject("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListGroups()); for (var i=0; i
As shown in the sample, the value associated with each key name is actually the data type for that key. Only two values are currently possible: string and meta, where meta denotes an internally generated key. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys. Syntax RemoveGroup(GroupName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.
RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise. Note: This method is functionally equivalent to using "RemoveKeySets" below with its Condition parameter set to "ID=ID". Syntax RemoveKeySetByID(GroupName: string, ID: integer): integer Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.
JavaScript repoObject.RemoveKeySets("Users", 'Gender="M"'); VB Script repoObject.RemoveKeySets "Users", "Gender='M'" 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.
refer 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 147). JavaScript repoObject.RenameKey("Users", "LastName", "SurName"); VB Script repoObject.
repoObject.SetValue("Users", "FormOfAddress", "Miss", "Gender='F' AND MaritalStatus=''" ); VB Script repoObject.SetValue "Users", "FormOfAddress", "Mr.", " Gender=""M"" " repoObject.SetValue "Users", "FormOfAddress", "Ms.", " Gender=""F"" AND Mar- italStatus=""Married"" " repoObject.SetValue "Users", "FormOfAddress", "Miss", " Gender=""F"" AND MaritalStatus="""" " SetValueByID Updates KeyName with Value in group GroupName, where the KeySet's ID matches the ID parameter.
Updating a row There is currently no 'update' feature in the API for a whole KeySet. This JavaScript example retrieves the KeySet ID, which is then used to update values in the row. /* Get KeySet ID */ var repoObject = new ActiveXObject("RepositoryLib.WorkflowRepository"); var keySetID = repoObject.GetValue("customers", "ID", "CustomerID='CURD654321'"); /* Update Values */ repoObject.SetValueByID("customers", "FormOfAddress", "Mr.", keySetID); repoObject.
database and a Document has information about one record in that set. This information appears in the Fields collection of the respective Node object. (When viewing the Metadata file, this information is visible under 'User defined information'.) The Data Model fields are added into the Document level.
loaded), the objects would point to invalid data. The effect of calling any object method in these circumstances is undefined and may result in memory corruption, crash or loss of data. Methods Name Description Job() Returns the "MetaJob" on the facing page node, which sits at the top of the Metadata tree structure. "LoadFromFile(const String Filename )" below Loads a Metadata file from the file system. "SaveToFile(const String Filename)" below Saves a Metadata file to the file system.
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 184 MetaCollection Returns the node's attribute collection. (See the "Metadata Attributes reference" on page 73.) "Count" on page 174 Integer Returns the number of child nodes.
"FieldByNameIndex(const String Name, Integer Index)" on page 179 String Returns the value of the N'th field of the specified name. "Item(Integer Index)" on page 180 Node Returns the child (node) item located at the specified index. Group(Integer Index), see "Item(Integer Index)" on page 180 Node Returns the MetaGroup at the specified index. "PageCount()" on page 180 Integer Returns the total number of pages present underneath this node.
"SelectedState" on page 175 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. Integer Methods Name Return Description type "Add(Integer Index)" on page 176 Node Adds a new child node to the current node. "AttributeByIndex(Integer Index)" on page 176 String Returns the specified attribute's value.
"SelectedIndexInJob()" on page 182 Integer "Sort(const String Name, optional TSortFlags Flags, optional const String Name2, optional TSortFlags Flags2, optional const String Name3, optional TSortFlags Flags3)" on page 183 Index of the page among all the selected pages in the Job. Sorts the sub-nodes according to a number of criteria. MetaDocument Properties Name Type Description "Attributes" on page 184 MetaCollection Returns the node's attribute collection.
"FieldByName(const String Name)" on page 178 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 179 String Returns the value of the N'th field of the specified name. "IndexInGroup()" on page 179 Integer Returns the index of this page in its parent group, taking all the pages from all the datapages from all documents into account.
"Parent" on page 175 Node Returns the parent node of the current node. "Selected" on page 175 Bool Indicates whether or not the Node is set to be printed. "SelectedCount" on page 175 Integer Returns the number child nodes selected to be output. (See also: "Including or excluding nodes from the output" on page 173.) Integer Returns an integer indicating whether the node is selected or not, taking its parents into account. 0: The node is not selected.
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. "Select(TSelectWhat SelectWhat)" on page 181 "SelectedIndexInDocument()" on page 182 Integer Index of the page among all the selected pages in its parent Document. "SelectedIndexInGroup()" on page 182 Integer Index of the page among all the selected pages in its parent Group.
"FieldByName(const String Name)" on page 178 String Returns the value of field of the specified name. "FieldByNameIndex(const String Name, Integer Index)" on page 179 String Returns the value of the N'th field of the specified name. "IndexInDocument()" on page 179 Integer Returns the index of this page in its parent document, taking all the pages from all the datapages into account.
Note: The "MetaPage" on page 171 object does not have a child accessor method as it does not contain any Node objects. For the available properties and methods see the Node type's documentation: "MetaJob" on page 165, "MetaGroup" on page 166, "MetaDocument" on page 168, "MetaDatapage" on page 169, and "MetaPage" on page 171.
collection however has additional methods to support multiple entries with the same name, which is forbidden with attributes. Node properties and methods reference This topic gives detailed information about all properties and methods of the Node object. The availability of a property or method with an actual Node object, however, depends on the type of the Node: "MetaJob" on page 165, "MetaGroup" on page 166, "MetaDocument" on page 168, "MetaDatapage" on page 169, and "MetaPage" on page 171.
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 173).
1 Disabled: The node is selected but one of its parents is not. 2 True: The node and all of its parents are selected. Note: In an Active Script environment, such as the Run Script task, the return value is a numerical value. However, in environments where the Selected State type is defined, the types are ssFalse (= 0), ssDisabled (= 1), and ssTrue (= 2). Methods Add(Integer Index) Not available in MetaPage Adds a new Node as a child of the current node.
AttributeByName(const String Name) Returns the value of the metadata attribute of the specified name. Parameters: Name Name of the attribute to retrieve. Returns: The value of the attribute as a string. If an attribute named Name is not found, an empty string is returned. Clear() Not available in MetaPage Deletes all the child nodes of the current node, as well as all of its attributes and fields.
Removes the current node, along with all of its children, attributes and fields, from the metadata structure. Caution: The node being deleted is removed immediately. Any reference to it or its child nodes becomes invalid. The results of calling methods of such references is undefined. DocumentCount() MetaJob only Returns the number of MetaDocument in all child nodes.
FieldByNameIndex(const String Name, Integer Index) Returns the value of the n'th metadata field of the specified name. This method can be used to retrieve the value of a specific field when more than one field has the same name. Parameters: Name Name of the field to retrieve. Index Ordinal of the field to retrieve. To retrieve the value of the first field named Name, use 0. For the second field, use 1, and so on. Returns: The value of the specified field as a string.
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.
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. PasteAt(Integer Index) Not available in MetaPage Inserts the contents of the metadata clipboard at the specified index in the current node. This removes the node from the clipboard, making it empty after the paste operation. Parameters: Index Specifies where in the child list to add the node.
Returns: The number of such nodes, if any. If the current node is not selected or one of its parents is not, it returns 0. SelectedDocumentCount() MetaJob only Returns the number of documents under the current node that are set to be part of the output, i.e. that have their Selected property set to true, as well as all of their parents. Returns: The number of such nodes, if any. If the current node is not selected or one of its parents is not, it returns 0.
SelectedPageCount() MetaJob, MetaGroup and MetaDocument only 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.
Parameters: Name Name of the field or attribute contained in each sub-node whose value will be used as the first sort criteria. If it is an attribute instead of a field, this needs to be specified in the Flags parameter. Flags (optional) Set of flags that modify how the sorting on Name is done. Name2 (optional) Name of the field or attribute contained in each sub-node whose value will be used as the second sort criteria.
erties. The Fields collection however has additional methods to support multiple entries with the same name, which is forbidden with attributes. Caution: Attributes are intended for system-defined data. Please restrict user-defined data to Fields, and do not modify the Attributes. Properties Name Count Type Integer Description Returns the number of elements in the collection.
Methods Name Return Description type "Add(const String Name, const String Value)" below 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. Note that the TAddFlags 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.
Add2(const String Name, const String Value, TAddFlags Flags, Integer Index (optional)) Fields only Adds a new field to the collection. The behavior of the method when the specified name already exists in the collection is determined by the Flags argument. Parameters Name Name of the field to add. The name must adhere to this syntax rules: start with a letter, followed by zero or more letters, numbers, underscore or dash. The name is not case-sensitive. Value Value of the element.
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. Delete(Integer Index) Delete a specified element from the collection. Parameters Index 0-based index of the element to delete. The first element in the collection is at index 0 and the last is at Count-1.
Returns The value of the element as a string. If no element is found, an empty string is returned. Fields only: If more than one field has the specified name, the value of the first one in the list is returned. ItemByNameIndex(const String Name, Integer Index) Fields only Returns the value of the n'th field of the specified name. This method can be used to retrieve the value of a specific field when more than one field has the same name. Parameters Name Name of the field to retrieve.
StringSort StringSort is a convenience class that provides a generic sorting class for ActiveScript-compatible languages. It is a non-trivial task to sort data in scripting, especially in VBScript where there is no equivalent for the JScript sort function. It is designed as a list of strings. Each string in the list is a key based on which the sort is done. Each key can have an optional integer value that can be used, for example, to retrieve a record in an array.
Count() Returns the number of strings in the list. Return value: Integer. Number of strings in the list. If the list does not contain any string, the return value is 0. Delete(Integer Index) Removes a single string from the list. Index 0-based index of the string to remove. Exceptions l EOleException Index is lower than 0 or higher than Count-1. Find(const String Key) Finds a string and returns its position in the list. Key String to find. Return value: 0-based index (integer) of the string.
Value(Integer Index ) Retrieves the value of the optional integer at the specified index. Index 0-based index (integer) of the value to retrieve. Return value: The integer value at the specified index. Exceptions l EOleException: Index is lower than 0 or higher than Count-1. AlambicEdit API reference The AlambicEdit library allows Workflow to access, create or modify PDF files. It does so by wrapping Adobe PDF Library API calls in an object-oriented COM API.
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.
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.left PDF object The PDF object implements the IPDF interface.
"GetInfos()" on page 197 "IPdfInfos" on page 216 Retrieves the contents of the Document Information Dictionary from the PDF. Returns the version of the underlying PDF file format. For example, for PDF 1.7, 1 is returned in major and 7 is returned in minor. Note that this method is not available in scripts. "GetVersion(*major, *minor)" on page 197 "GetXMP()" on page 197 STRING Retrieves the XMP attachment embedded in the PDF.
VOID Close () Note: Before using Close() in Javascript, you should call the CollectGarbage() global method to ensure all references to pages are properly discarded. This additional statement is not required with other languages. For instance: var objPDF = Watch.GetPDFEditObject(); objPDF.Open(Watch.GetJobFileName(), false); var objPages = objPDF.Pages(); var objPage = null; for(var i=0; i
pdfFilename Name of the file to convert. ppmlFilename Name of the PPML file to embed. GetInfos() Retrieves the contents of the Document Information Dictionary from the PDF. Syntax IPdfInfos GetInfos () Return value An "IPdfInfos" on page 216 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.
STRING GetXYML () Return value A string containing the complete text of the PDF in XYML format. IsProtected(filename) Returns True if the PDF file is password-protected. When a file is password-protected, the OpenEx() method must be used instead of the Open() method. See also: "OpenEx(filename, password, doRepair)" on page 200. 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.
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 198. Syntax VOID OpenEx (STRING filename, STRING password, BOOL doRepair) filename Name of the file to open. password Password to open the file. doRepair Boolean.
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. To print all pages from fromPage to the end, use -1. PrintEx(printername, *PdfPrintParams) Prints a range of PDF pages to the specified Windows printer with specific printer options stored in an "IPdfPrintParams" on page 217 structure.
SetInfos(Infos) Sets the contents for the PDF's Document Information Dictionary. Syntax VOID SetInfos ( IPdfInfos Infos ) Infos "IPdfInfos" on page 216 structure containing the new values. setPageCacheSize(cacheSize) Sets the maximum number of IPage objects in the cache. Calling this method flushes the cache. Syntax VOID setPageCacheSize ( UNSIGNED LONG cacheSize ) cacheSize Maximum number of IPage pointers that the cache can hold, between 1 and 1000.
SetVersion (major, minor) Sets the version of the underlying PDF file format. This is applied when the file is saved. See also: "Save()" on page 201. Syntax VOID SetVersion ( LONG major, LONG minor ) major Major version number. minor Minor version number. SetXMP(xmpPacket) Sets the XMP attachment by replacing the existing one with xmpPacket. Syntax VOID SetXMP ( STRING xmpPacket ) xmpPacket New XMP attachment to use instead of the existing one.
"Item(index)" on page 206 IPage (see "Page object" on page 207) "Move(index, count, offset)" on page 207 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)). Moves a range of pages within the same PDF. IPages methods reference Count() Returns the number of items in the Pages collection, in other words the number of pages in the PDF.
0-based index of the first page to copy. srcCount Number of contiguous pages starting from srcIndex to extract. optimize If true, optimize (linearize and garbage-collect) the output file. Insert(index, *mediaSize) Inserts a new blank page in the PDF file. See also: "Count()" on the previous page. Syntax VOID Insert ( LONG index, IPdfRect * mediaSize ) index 0-based index at which to insert the page. The page is inserted *before* the page at index "index ". To insert a page at the end, use IPages.Count().
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.Count(). InsertFrom2(srcPages, srcIndex, srcCount, destIndex) Inserts pages from another IPages object into this one. All relevant resources are copied with the pages. See also: "Count()" on page 204.
0-based index of the page to acquire. Return value An IPage object for the specified page. (See "Page object" below.) Move(index, count, offset) Moves a range of pages within the same PDF. Syntax VOID Move ( LONG index, LONG count, LONG offset ) index 0-based index of the first page of the range. count Number of contiguous pages to move. offset Number of hops to move the pages. If negative, the pages are moved towards the beginning of the file. If positive, towards the end.
"ExtractText2(left, top, right, bottom)" on page 211 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 211 "IPdfRect" on page 217 Returns the size of the actual media, i.e. the sheet of paper. "setIncludeBorders(pbIncludeBorders)" on page 212 Sets whether or not borders are included for IPage.ExtractText2().
scale Scale at which to draw. To draw at the 100% size, use a scale of device_dpi / 72. Do not use the DC to do the scaling; this will result in scaling artifacts being drawn. offsetX Horizontal offset from the left edge of the DC surface, in *device* units, at which to start the drawing. offsetY Vertical offset from the top edge of the DC surface, in *device* units, at which to start the drawing. The drawing is done in PDF user space units (72th of an inch).
Caution: This method is subject to many limitations (see below) and exists for backward-compatibility 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.
ExtractText2(left, top, right, bottom) 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. Syntax VOID ExtractText2 ( FLOAT left, FLOAT top, FLOAT right, FLOAT bottom ) left Distance in inches of the left limit of the region from the left edge of the /CropBox. Must be between 0 and 5000. top Distance in inches of the top limit of the region from the top edge of the /CropBox.
setIncludeBorders(pbIncludeBorders) Sets whether or not borders are included for IPage.ExtractText2(). If true, a character is considered to be inside the region using the 30% rule (i.e. at least 30% of the character must be enclosed in the region). Otherwise, the character must be entirely enclosed in the region to be returned. See also: "ExtractText2(left, top, right, bottom)" on the previous page.
FLOAT left, FLOAT top, FLOAT rotateAngle, FLOAT scaleFactor ) imageFile Full name of the image to insert on the current page. left Coordinate at which to place the left edge of the image from the left edge of the page, in points. top Coordinate at which to place the top edge of the image from the top of the page, in points. rotateAngle Angle at which to rotate counter-clockwise the inserted image, in degrees. The rotation is done after the image is placed at (left, top) and centered around that point.
top Coordinate at which to place the top edge of the image from the top of the page, in points. rotateAngle Angle at which to rotate counter-clockwise the inserted image, in degrees. The rotation is done after the image is placed at (left, top) and centered around that point. scaleFactor Scale at which to display the image. For bitmaps, this is based on a 72 dpi resolution. Use 1.0 for the nominal size.
Scale at which to display the image. For bitmaps, this is based on a 72 dpi resolution. Use 1.0 for the nominal size. layerName Name of an Optional Content Group in which to put the layer containing the image. The string cannot be empty but can be NULL if no layer is required. 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).
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. This corresponds to the /CropBox entry of the /Page PDF object.
application that created the original document from which it was converted. STRING Producer If the document was converted to PDF from another format, the name of application that converted it to PDF. STRING CreationDate The date and time the document was created, in human-readable form. ) IPdfPrintParams The IPdfPrintParams structure contains information used to control the printing of the file. To instantiate the IPdfPrintParams structure, create the AlambicEdit.
VBScript implementation: set pdfRect = CreateObject("AlambicEdit.PdfRect") Structure IPdfRect { LONG left Left edge of the rectangle. LONG top Top edge of the rectangle. LONG right Right edge of the rectangle. LONG bottom Bottom edge of the rectangle. ) 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.
VBScript In VBSCript, the Err.Raise method will halt the execution of the script and trigger the On Error tab unless you previously specified On Error Resume Next. See MSDN for the Raise method properties and this page for a list of available errors to raise. In the case of VBScript, the error number used will determine the message shown in the log. You can also override the standard error message by providing your own: Dim s s = Watch.GetJobInfo(9) If (s = "") Then Err.
# Do something with Job Info 9! Watch.Log("Job Info 9's value is: " + s,5) Perl In PERL, die stops execution of the script unless the unless command is used, but in order to raise an exception and trigger the On Error tab, you must nest the die command inside an eval statement. See the perl documentation.
OL Connect Send (see "OL Connect Send" on page 481) 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 237.
Tip: Essentially the "NodeJS Server Input" on page 327 task does the same as the HTTP Server Input task, but it uses a NodeJS Server (installed by Workflow) instead of Workflow's custom server component. The NodeJS Server Input task is more secure, more up to date and more standardized. It is configured using its three settings dialogs in the Preferences (Workflow button > Preferences). Note: You can control access to the PReS Workflow Tools HTTP Server via the Access Manager.
c:\PReS\http and your Resource action name is static, pointing your browser to http://127.0.0.1:8080/static/css/style.css will immediately load and return the file c:\PReS\http\css\style.css . This does not require any process to work - everything is handled directly by the HTTP Server Input and files are returned immediately. This feature is very useful when dealing with stylesheets, images, browser JavaScript, or static HTML files that do not require any processing.
both cases, this information is located in the XML envelope that is the original input file of a process that starts with a Server Input task. l When doing POST requests and uploading files, always make sure to include the "multipart" option in the
will be sent to the client. If the last output task generates a PostScript file for printing, this PostScript is returned to the client. In most cases, what is returned is what remains after the last task, but only if this task's processing is done in PReS Workflow. For example, if the data file is a text file and this file is sent to PReS Image using the Image connector, it is a text file that is returned, not the output of the Imaging.
Process illustration Task breakdown 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 AutoDetect. l 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 423. The condition returns "true" if the file is not found: c:\PReS\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value,Ke
l If, however, the file is found, then it is loaded with the "Load External File" on page 385 task, and then deleted (for the same reasons). HTTP brochure request This workflow builds on the knowledge acquired in "HTTP PDF Invoice Request" on page 225 and uses a single process, but in this case it also uses a PlanetPress Design document (see "PlanetPress Design documents" on page 41) which merges the data received from a browser form with the document to generate a PDF brochure, which is sent via email.
l When the condition is false, it means that there is something in the Full Name field. In this case, we know that the form was filled and submitted back to the process, and we handle the request as such. l First, we add the full name, email and company information to job informations, in order for them to be available for the rest of the process. l Then, we have a small condition that verifies if the user checked the "Newsletter" box. If so, the conditional branch is triggered.
Resources l PDF-DailySalesReport-Workflow.zip Task breakdown l The initial input is the "Merge PDF Files" on page 317, which retrieves and merges all the PDF files inside of the specified folder. Once a single PDF is created, the task also optimizes the PDF (to avoid duplicating images and font definitions for each page) as well as generates a basic Metadata structure containing a single document with one Data Page per captured PDF.
everything it writes on paper, as long as this paper contains special Anoto Patterns. Caution: There are important considerations to keep in mind when dealing with PlanetPress Capture. Please review them in "PlanetPress Capture Implementation Restrictions" on page 260. In order to properly build a PlanetPress Capture workflow, it is very important to understand the terminology, implications and limitations of the technology.
l An "HTTP Server Input" on page 601 task or "Folder Capture" on page 304 task that receives the PGC. l The "Capture-Fields processor" on page 624, which converts each PGC in an EPS layer, adds this layer to the PDF in the database, releases patterns and closes documents. l Optionally, a "Capture-Condition" on page 617 task to do post-processing using the Capture Fields data.
The Examples l "Basic Functional Capture Workflow" below l "Capture Post Processing Workflow" on the facing page l "Capture Web Manager Workflow" on page 236 Basic Functional Capture Workflow This workflow is the most basic and simple workflow that you can use with PlanetPress Capture. In small implementations with only one simple document, this may be the only thing required for a functional workflow since, even in this simple state, it can be enough to automate the archive of your digital documents.
l "HTTP Server Input" on page 601 or "Folder Capture" on page 304 input task l "Capture-Fields processor" on page 624 l "Capture-Get document" on page 632 l Archive or Print output Capture Post Processing Workflow Though the "Basic Functional Capture Workflow" on the previous page is minimal functional one, it will most likely not be enough for most actual implementations.
Task Breakdown: l The HTTP Server Input receives a POST request sent either by the Anoto penDirector or the PlanetPress Mobile Application. This requests contains information sent by the pen as well as a PGC file as an attachment. Because we're only concerned about the PGC, the task is configured to ignore the XML envelope as well as loop through each attachments (of which there is only one). So, the output of the task is the PGC file alone.
After Retrieving Information from the Capture Database There are two basic ways in which the Find Capture Document task can be used. First, in an automated process that runs at specified intervals. For example, the following process which sends a daily report of all incomplete and "in error" documents to an agent who would presumably take action on each document through the document manager.
Capture Web Manager Workflow This example is both a more involved workflow for Capture, and an interesting implementation of an HTTP Workflow. Before looking at this example, it would be best to become familiar with both "PlanetPress Capture Workflow" on page 229 and "HTTP Server workflow" on page 221. The example is too complex to display as images in this guide, so it is rather available for download.
Considerations l The workflow itself is a standalone system that does not interact with any third-party systems, which of course does not correspond to real customer implementation. A client will most likely need to communicate with both an ERP system that generates documents as well as an archive software to store completed documents.
l The Get Job Data plugin. Creating interactive processes for incoming print jobs requires that the relevant information about the respective job is available and can be used in Workflow. This is what the OL Connect Send Get Job Data plugin is made for. (See "Get Job Data" on page 485) l The Create Web Content plugin. Each web page served by an interaction process is generated by this plugin.
l System variables are standard variables, created and managed directly by PlanetPress Workflow. These variables are read-only and cannot be modified. They provide information about the job, process, and PlanetPress Workflow environment. For more information see "System variables" on the next page. All the variables in PReS Workflow are considered strings, even if the information itself can be a number.
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 %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 36-character string consisting of 32 alphanumeric, lower case characters and four hyphens. Format: xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (8-4-4-4-12 characters). 123e4567-e89b-12d3-a456-426655440000 %t Current temporary folder C:\Documents and Setti
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. They can be accessed anywhere, but they only appear in the contextual menu of a task property field when the current process is an error-handling process (that starts with the Error Bin Input task).
1. Select the process where you want to add the variable. 2. Now you can use one of two methods: l Click on the Home tab of the PReS Workflow Ribbon, then click Local Variable in the Variables group. l 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.
To refer to a global variable, for example in a variable task property (see: "About Tasks" on page 286), use its name preceded by "global." and surrounded by curly brackets, for example: %{global.myGlobalVariable}. Global variables are generally used to keep information that applies to multiple locations but needs to be changed easily. For example, a lot of users use them to set a server's IP, a printer name, or folder location that is used by multiple processes.
Renaming a variable l Right-click on the variable name in the Configuration Components pane. l Click Rename. l Type in the new name of the variable, then press Enter on your keyboard. Note: While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it will not change the references in any script within a Run Script task.
l In the Set Job Infos and Variables Action Task. See "Set Job Infos and Variables" on page 398. l In Scripts. See the chapter on "Using Scripts" on page 117. l In the Create File Input Task. See "Create File" on page 297. l Within a PlanetPress Design Document, using the ExpandString() function. See the PlanetPress Design User Guide and PlanetPress Talk Reference Guide.
l Get Repository Value: Brings up the "Data Repository Manager" on page 707 dialog to select the value (contents) of a specific key. The result of the lookup is static. l Get Repository Location: Brings up the Data Repository Manager dialog to select the location of the key to lookup every time this task is executed.
PlanetPress Capture is a set of tools available in PReS Workflow that enable output and input for interaction with an Anoto Digital Pen. Anoto Digital Pens are electronic devices containing a camera, processor, memory and communication capabilities and they can recognize their location on any paper where a special Anoto pattern is printed. For more information on building and using PlanetPress Capture processes, please see "PlanetPress Capture Workflow" on page 229.
Capture Document Manager A tool that lets a user search through the available documents in the Capture Database. The documents can be search through a few different criteria and can be displayed as PDF files, individually or as a group. Documents can also be closed or deleted from this interface. Capture Field The PReS Connect object that acts as a placeholder for the Anoto Pattern. The pattern is only applied when using the Capture Field Generator in Workflow.
complete it so it can be closed. Pattern ID The ID of the Anoto pattern. Represents the pattern on the page. Can be used to retrace the document to which the pattern belong. Pattern Sequence Pattern Sequences enable the multiplication of the number of available pattern by adding an extra identification to the document. A Pattern Sequence is also attributed to each Anoto Digital Pen, such as an incoming PGC file will contain the Pattern, on which the Pattern Sequence is added from the pen database.
General considerations Here are some general considerations in regards to PlanetPress Capture, its environment, the hardware and the software that interacts with it. Please review these considerations carefully as they may impact PlanetPress Capture and its functionality. Caution: PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently.
l l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l Database can be in any location, but performance will depend on the speed of the connection between PReS and the MySQL server. l MySQL's performance has been slower than SQL Server and SQL Server Express during our tests. l 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.
tunnel for each location where penDirector is installed instead of going through regular remote HTTP server. l The PlanetPress Capture database, since it can be external to PReS Workflow such as on a MySQL server, will be dependent on your own database security. l The Anoto Digital Pens, since they may contain critical information, are just like physical sheets of signed paper and must be kept secured.
generates, if that page contains a pattern. PReS Workflow also stores a copy of each document in the Capture Database, in PDF format. While a document is printed, and while this printed document has not received any ink or signature, the document is deemed "open", the pattern it uses remains locked in the database and cannot be re-used.
Extending There are actually 2 ways of dealing with extending the number of patterns using the currently available tools, each with its own advantages and disadvantages. Using separate PReS Workflow servers and licenses. In a scenario where there are multiple locations that use PlanetPress Capture and where neither pen nor paper has any risk of being moved from one location to another, the easiest (but costlier) solution is to have a separate installation of PReS Workflow in each location.
l Process-Based Sequences: In this case, while documents are still printed and their route number attributed to their pattern sequence, the pens do not have this distinction. However, the docking station where the pens are placed at the end of the day are set to send the pen's data to a specific process which will only handle processing for that specific route number.
Second, contamination can happen in method 1) above if a pen or paper is moved from one location to another. Similarly to the previous contamination example, if there exists a document in the Capture Database where the "wrong" data is processed, it will update a document where it does not belong. Again, neither the pen nor PReS Workflow have any idea that this causes an error until it's too late.
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 pre-configured version of penDirector which can be immediately used with PlanetPress Capture.
6. When the pen is found, click on it and then click Add. 7. When asked for the PIN, enter the one noted above. 8. Click OK to save the settings. The settings for Bluetooth PGC handling are separate from the ones used when docking. Through Bluetooth, only a single storage and PGC Post URL location can be set for all PGCs.
Thermal printers will not work either due to the low quality printout and the absence of actual blank ink on the paper. Black ink close to patterns Because the Anoto Pen & Paper technology relies on infrared to read pure-black dots on the paper, it is imperative that no other black ink interfere with this reading. Though it is possible to print Capture documents on a black & white laser printer as long as there is no other ink on top of, or close to, the patterns, this is not recommended.
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. The following image illustrates how the pen reads its position: 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.
PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularlyknown "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 A Capture field is setup for ICR in a PlanetPress Design document. l The document is sent to PReS Production l The Capture Field Generator is used to produce one or more print-outs using this document. l The physical sheets are written on using an Anoto Digital Pen l The pen is docked and the data is sent to PReS Production l The pen data goes through the Capture Field Processor, where the Capture Field ink is sent through the ICR engine.
l Target: The targeted audience. There are 3 possibilities: Form designer, Workflow designer and User. l What: A brief description of the best practice. This could include an explanation of the concepts that are addressed. l Why: A brief explanation of the reasoning behind the relevance of this guideline. l How: How to apply this best practice. This section describes a list of the best practices to implement. They are listed in no particular order of importance.
Why: Reducing the number of expected characters increases the probability that the correct one is matched. This allows us to avoid that the letter l (a lowercase L) is not recognized as the numeric value 1 (one) and vice versa. Or, if the mask type is identified as alphanumeric, there’s a possibility that the letter a is recognized as 2; since Capture will also interpret how the movement was traced.
Guidelines for Capture-Ready Fields l Target: Form designer l 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 Target: User. l 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 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. l Number 8 is also sensitive. It is recommended that the number is traced as one movement instead of drawing 2 circles on top of each other. Selecting the Correct Language When Using the Capture Field Processor Task l Target: Workflow designer. l What: It is crucial that the correct language is selected when using the ICR recognition option.
Possibility of Interpretation Error in an Automated Process l Target: Workflow designer l 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.
05-16 18:01:30Z" inklastutc="2013-05-16 18:01:30Z" contentstatus="2"> PAGE 273strokewidth="1" inkfirst="2013/05/16 14:01:31" inklast="2013/05/16 14:01:32" inkfirstutc="2013-05-16 18:01:31Z" inklastutc="2013-05-16 18:01:32Z"/>
PAGE 274 PAGE 275top="279.459991455078" width="316.620025634766" height="66.140007019043" areatype="0" groupindex="0" areastyle="2" contentstatus="0"/> PAGE 276contentstatus="0"/> PAGE 277top="588.539978027344" width="550.070007324219" height="56.6900215148926" areatype="0" groupindex="0" maskformat="AAAAAAAAAAAAAAAAAAAA" areastyle="3" contentstatus="0"/> PAGE 278areatype="0" groupindex="0" areastyle="2" contentstatus="0"/> PAGE 279l Windows 2000: PReS Fax Output tasks set to use Windows Fax under Windows 2000 may fail when no one is logged on to the system running PReS Fax. l Windows XP: Windows Fax may not work properly after the Windows XP Service Pack 2 (SP2) has been installed (refer to Microsoft Customer service for more information on this issue). Also note that Windows Fax may take as much as three times more time to send faxes under Windows XP.
Note: The minimum time required to generate a PReS Image document is approximately 10 times longer on Windows 2000 than on Windows XP/2003. Preferences In addition to the job-specific PReS Image properties that you configure in the task’s Properties dialog box, there are configurable options common to all PReS Image Outputs processed by a given computer; see "PReS Image preferences" on page 672. Note that those options are specific to each PReS Image installation and that they are immediately applied.
is the lowest level, and is the level supported by the Workflow plugin. It holds structured data which is enough to cater for most requirements of the Federal Ministries and industries (such as the software and taxation sectors) participating in the standard. For more information, please see the ZUGFeRD website: https://www.ferd-net.de/zugferd/definition/index.html. Licensing The ZUGFeRD plugin is bound to the Connect Workflow Imaging license.
monitor, start and stop PReS Workflow services (see "Users and configurations" on page 284 and "The PReS Workflow Service Console" on page 727). Services must use an account to be granted the permission to use the system’s resources and objects. This information is included in the service's configuration and most services use the Local System Account, which is granted access to all the system’s resources. All input and output services used by PReS Workflow run under the same account.
l PReS Fax: Outputs jobs as faxes. You use PReS Fax as an interface to WinFax PRO or Windows Fax, to send faxes you create from documents. You can install multiple 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 278.
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. When they do so, a session is opened and customized for them on that computer (certain drive letters and network shortcuts may be mapped, local and network printers may be made available, etc.).
Different users may also map network drives differently. Let us say this time that you have a server in your office. User A maps that server’s main drive using drive letter “y:” while user B maps it using drive letter “z:” A configuration created on one system and then used on the other would both get and save the wrong files from the wrong drives. Note that such situations may be avoided by using the Universal Naming Convention option.
l l Browse: Opens the default Windows dialog for selecting users/groups/etc. from a domain. l User: Enter the name of the user account. l Password: Enter the password for the user account you specified in the user name box. l Confirm password: Enter the password you entered in the Password box. Services start automatically: Select to start the required PReS Workflow automatically.
l "Input tasks" on page 295 l "Action tasks" on page 350 l "Data splitters" on page 405 l "Process logic tasks" on page 418 l "Connector tasks" on page 433 l "PlanetPress Capture Tasks" on page 617 l "Metadata tasks" on page 467 l "OL Connect tasks" on page 492 l "OL Connect Send" on page 481 l "Document Management tasks" on page 564 l "Output tasks" on page 543 l "Unknown tasks" on page 635 Note: Completely empty files (0 bytes) cannot be processed by Workflow.
There are a few things to keep in mind when dropping tasks: l You can insert input tasks anywhere in the process except in output task locations. l When you add an output task, a new branch leading to that new task is added above the selected task or branch, except when replacing an existing output task. l Dropping a task on top of another one replaces it. l Dropping a task between two tasks will insert it at that location.
that it contains, see "Using the On Error tab" on page 82. The error management system (the On error tab and the Error Bin Input task), however, is only triggered when there is an error within the task functionality - that is, a plugin error. These kinds of errors are triggered if the plugin cannot communicate with a service, another task, if the plugin crashes, etc.
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.
l A percentage sign identifies system variables, as well as standard and custom job info variables — %f, for example. l A backslash indicates a control character — \004, for example. l An at sign (@) indicates a data selection for emulations other than database — @ (1,1,1,1,17,KeepCase,Trim), for example. l Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example.
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. l Wildcards: Two wildcards are available in masks. 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. l Question Mark (?): Supports a single character. file?.txt would pick up File1.
l You can choose not to use any document (only in certain cases). If an Output task was originally designed to merge a PlanetPress Design document with data, this means no document is merged with the data and the job file is sent as is. Variable file name The variable file name feature is used to dynamically determine which file is used with the task. The file name can be constructed using any variable (see "Variable task properties" on page 245). To insert a variable file name: 1.
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.
Secondary Input tasks Secondary Input tasks are placed in the process like an Action task would and will replace the job file in the process with the file they retrieve. Since they are part of the process, they can use data from previous tasks to pull data from a variable location. Secondary Inputs do not follow a separate schedule from the process - they are automatically run when the process triggers them.
Available Input tasks l "Create File" below l "Database Query" on page 368 l "Email Input" on page 299 l "File Count" on page 420 l "Folder Capture" on page 304 l "Folder Listing" on page 307 l "FTP Input" on page 309 l "HTTP Client Input" on page 311 (Legacy task) l "HTTP Server Input" on page 601 l "Input Error Bin" on page 313 l "Input SOAP" on page 314 l "LPD Input" on page 316 l "Merge PDF Files" on page 317 l "Microsoft 365 Email Input" on page 320 l "Microsoft 365 OneDriv
Since Create File input tasks are not dependent on data from external sources, they are performed at every polling interval and the process is thus started every time. This task is put into effect in the following use cases and example processes: l HTTP PDF Invoice Request l HTTP Brochure Request Input Create File does not capture any file and, if it is a secondary input task, discards the current data file. Processing Create File generates a job file with the contents of its text.
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 721.
Note: If you use Email Input tasks to capture data encoded using a Double-Byte character set (such as those used for Japanese or Chinese, for instance), it is preferable to use attachments rather than the email body to carry the data from its source to the input task, as data corruption is less likely to occur using this method. Task properties General Tab l Data Location group l Message body: Select to use the data found in the body of the email.
folder as it appears in Outlook’s Folder List area, regardless of whether it is a child of another folder. For example, if you want to use a folder named Bills that is listed under another folder named PassedDue, only enter Bills in the text box. Make sure no two folders have the same name, even if they are under different parent folders, as this could generate errors.
Job Information definitions l %1 - Date received. Contains the date of the reception of the email (and not the date of retrieval by PReS Workflow). The format is YYYY/MM/DD HH:MM:SS. 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). l %3 - Sender's address: Contains the email address of the sender as defined by the sender himself.
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.
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 Information elements: Indicates what Job Info variables are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
Caution: 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.
l Use archive attribute: Select to turn on the archive attribute of the data files found in the source folder and to leave them in their original location (i.e. to take copies of the source files). Note that PReS Workflow never takes source files that have their archive attribute turned on (so the source files will not be taken again and again). When this option is turned off, PReS Workflow removes data files from the source location.
%2 - Folder: Contains the folder from which the data was captured. l Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Folder Listing Folder Listing input tasks list the files present in a selected folder and give you the option to use filename masks, to sort files by name or date, and to list the files present in the selected folder’s subfolders.
C:\Samples\manuals\ usermanual.pdf C:\Samples\manuals\ 644037 Note: The
l Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l %1- 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.
l Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another PReS Workflow task. l Directory (optional): Enter the path of the folder to poll on the FTP server. If this box is left empty, PReS Workflow will poll the root directory. l Mask: Enter a single file name mask. Multiple entries are not allowed in this box.
l %3 - Source file name: Contains the name of the current file that was retrieved from the server. l %4 - Folder: Contains the FTP folder from which the current file was retrieved. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. HTTP Client Input HTTP Client Input tasks use the HTTP protocol to issue HTTP GET commands (queries) to HTTP servers.
l Server requires authentication: Check this option if the HTTP server requires user authentication. This enables the following options. l l User name: A user name known to the Web server. l Password: The password associated with the user name entered above. Custom headers: Some services require additional HTTP headers to be set. To add a custom header, click the + icon; then type the header's name and value.
Input Error Bin The Input Error Bin task is used specifically and only to create error management processes. These processes do not run on their own but are rather triggered by the On Error tab of tasks in other processes, when that task fails. Input This task receives a data file from a task that generated an error. Accompanying this data file is the current Job Infos of the process that triggered the error.
"Other" Tab l Job Information group l Information elements: Indicates what Job Info variables are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. 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.
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.
Job Information definitions l This task does not generate any job information. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. LPD Input LPD (Line Printer Daemon) Input tasks retrieve data in the form of print files sent from remote computers using the LPD/LPR protocol.
"Other" Tab l Job Information group l Information elements: Indicates what Job Info variables are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. 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.
This task is put into effect in the following example process: "Example: Daily sales report from PDF files" on page 228. Input This task captures all of the PDF files present in a specific folder, in one operation. The Merge PDF Files Input task performs just like any other Input task: once the process has completed, control is transferred back to the Input task one last time to check if new files meeting the mask have come in.
files will not be taken again and again). When this option is turned off, PReS Workflow removes data files from the source location. 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.
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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Microsoft 365 Email Input The Microsoft 365 Email Input task allows the processing of emails from any of the organization's Microsoft 365 accounts, without having to specify a user's credentials.
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. Output Once the plugin is done processing, an XML file is created with the email’s details and location of the body and any attachments. The encoding of the XML file is UTF-8.
Attachment C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\Pla Watch\Debug\0106HBKO3IODK3F\ 0106HBKO4J5U342.jpg The most pertinent information is located at the top level, under . The sub node contains all the files for the email. For each file, the type (body or attachment), folder and filename is provided.
l First found (no conditions): When no conditions are specified, the first unread email that is found will be processed (for each iteration of the plugin). In any other case, all conditions must be met for the email to get processed. l “From/To/CC/Subject/Body” contains: Select one or more options and enter the search text.
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 Information elements: Indicates what Job Info variables are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
For more information on setting application permissions for Microsoft Graph, see https://docs.microsoft.com/en-us/graph/auth-v2-service. Input The Microsoft 365 OneDrive Input task retrieves files corresponding to a specified file mask, from a specified OneDrive folder. These files may be of any format, even formats that are not readable by PReS Workflow. Processing The task uses the Microsoft Graph API to access OneDrive folders in the organization (subject to that organization's IT policies).
selections; see "Variable task properties" on page 289. Click the Add button to add the folder to the list. Note that subfolders of the given folders are not taken into account; if they need to be monitored, they must be added to the list separately. When a folder doesn't exist in the system it will be created at runtime. l Masks: Enter a single or multiple file names or use file name masks (separated by a semicolon). See "Masks" on page 291.
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 Information elements: Indicates what Job Info variables are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
l You can specify a HTTPS port separately. l A Proxy list can be used to setup end points for redirecting requests to another server. This could be useful if for example the Connect server is on another server which could change; when it changes you’d only have to modify the proxy list instead of the configuration. l You can enable or disable authentication using users from an Active Directory server.
Note: While you can insert the NodeJS Server Input task anywhere in your process as a secondary input task, in reality the NodeJS Server Input task will only function when used as the initial input, as it is triggered when Workflow's NodeJS Server receives a request and passes it on to the correct task. Caution: It is highly recommended to make all processes using the NodeJS Server Input task self-replicating and to reduce their polling interval in the "Process properties" on page 721.
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. 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.
Note: The following characters are not allowed in an action name: $ * ? #, spaces, and any characters that are not permitted in Windows folder names, such as \ / : ? ” < > | . Action names are not case sensitive. l MIME Type: Select the MIME type of the file that will be returned by the plugin. l Form Data Encoding: Specifies how this endpoint will interpret any form data received by the web server.
selections; see "Variable task properties" on page 289. Note: This option requires every plugin in the process to be explicitly set to "On Error: Stop process" (see ), even if the process itself is set to "On Error: Stop process". l Send immediate response to client: Do not wait for the process to finish and send a static HTML or Text file back to the client instead. This prevents any timeout from occurring. l Response file: Select which file to return. Note that the file name doesn't have to be static.
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 721.
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.
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 721.
Note: When using the POP3 method, the plug-in will run very slowly if the inbox contains a large number of emails. Always use IMAP when possible. Emails retrieved using POP3 are deleted from the server; emails retrieved using IMAP can either be deleted or marked as read. Output Once the plugin is done processing, an XML file is created with the email’s details and location of the body and any attachments. The encoding of the XML file is Windows-1252.
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 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.
l Options: 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. l Select what to do when an email is processed: mark the retrieved item as read or delete the retrieved item from the mail server. Note that when using POP3, you cannot specify the inbox, and a retrieved email is always deleted from the mail server.
Serial Input Serial Input tasks receive files sent to a serial port on the computer running PReS Workflow. All the Serial Input tasks in a PReS Workflow configuration share the same general properties, which are configured through user options (see "Serial Input plugin preferences" on page 666). Only the properties set in the Other and Error tabs are specific to individual tasks. Input This task does not poll an input, it sits there and waits for a job file to be sent through the Serial connection.
Job Information definitions l %1 - Source file name: Contains the name of the job file as specified by the software that sent the job. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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.
Task properties General Tab l Server Settings group l FTP Server: Enter the IP address or host name of the FTP server to poll. l User name: Enter the name of a user account on the FTP server. l Password: If account named in the User name box is password protected, enter the password here. l Parse password: Checkbox to determine if the password should be parsed or used as a literal string.
l Active: Select to prompt the ftp client to use the active mode when retrieving files from the FTP server. l Passive: Select to prompt the ftp client to use the passive mode when retrieving files from the FTP server. l Reset Download List: Security Tab This tab defines the certificates used to connect to the secured FTP servers. l Accept all certificates: Check this option to automatically accept the certificates returned by the FTP server.
The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 721. l Backup filename: Enter the file name that you wish the input data file backup to be saved under. l Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l %1 - User name: Contains the user name that was used to connect to the FTP server.
Input The SMTP Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received. Actually, it is the SMTP Server service that receives the requests and places them in a specific location on the drive. When a request is received, the SMTP Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received.
Processing The task reads the incoming SMTP request and provides the data within its body. Output Depending on the Data Location option, the output is different: l Envelope: The request file in XML format, including all email fields (from, to, cc, bcc, subject, body) as well as additional header fields (email client information, attachments, etc). The message body and attachments are available through specific XML attributes.
l Nothing: Select to limit those messages used by this task to those that do not specify any subject. 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. l “To” contains: Select to limit those messages used by this task to those that are sent to a specific address. The address you enter in the box below can include variables and wildcards.
Input This task does not poll an input, it sits there and waits for a job file to be sent through the Telnet port. Processing When the job is received through Telnet, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. Task properties General Tab l Port: Enter the number of the port on which PReS Workflow is to listen for Raw Socket communications. The default port number is 9100.
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. WinQueue Input WinQueue Input tasks capture print jobs received by a Windows printer queue. 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.
Converter)" on page 614). Note that this option must not be selected when capturing generic text type data. l Spool Print Jobs in RAW Format: Select to output in RAW format, which is the exact data that the computer receives (and is not converted in any way). l Create PDF (With Metadata): Select to output a PDF. l Optimize Resulting PDF: The resulting PDF is optimized for size and caching options are enabled.
l %4 - Document name: Contains the name of the job as seen in the printer queue from which it is captured. This name is defined by the software that creates the print job. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Action tasks Use action tasks in PReS Workflow to perform a wide variety of operations.
l "PDF/A-3 Attachments" on page 389 l "PDF to Bitmap" on page 531 l "Push to Repository" on page 392 l "Rename" on page 393 l "Run Script" on page 426 l "Search and Replace" on page 396 l "Send Images to Printer" on page 610 (Legacy task) l "Send to Folder" on page 397 l "Set Job Infos and Variables" on page 398 l "SOAP Client plugin" on page 612 l "Standard Filter" on page 401 l "Translator" on page 402 l "Action-EMF Converter (Windows Print Converter)" on page 614 (Legacy task) A
Task properties General tab l l Action group l Add: Select if you want the task to add content to the job file. l Remove: Select if you want the task to remove content from the job file. Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file.
they allow the use of regular expressions. Using regular expressions, it is possible to search for patterns rather than specific strings. For instance, a pattern can be specified to find all valid email addresses or phone numbers within the data stream. In a regular expression, substrings can be captured as groups using parentheses. Values of capturing groups - the matched substrings - can then be included in the replacement string using the dollar sign syntax: $1 ... $9.
l Search whole file: Select if you want the entire data stream to be searched as if it were a single string of text. When this option is selected, PReS Workflow loads the entire file in memory. It offers more flexibility, since search expressions may span across multiple lines and may result in more successful hits. Note that since this option uses more memory, it may affect performance. l String to search: Enter your search string or regular expression in this variable property box.
reset before the end of the file. Select one of the occurrence options (described below) in the list box below and enter a value in the Occurrence value box besides it. l At occurrence: The replacement will take place only when the specified number of occurrences has been reached. Specifying 2 occurrences, for instance, means that only the second occurrence will be replaced. l At every specified occurrence: The replacement will take place every time the specified number of occurrences is reached.
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 Description types PostNet PostNet symbology. Used by the United States Postal Service to assist in directing mail. RM4SCC RM4SCC symbology. Used by the Royal Mail. Note: The fewer barcode types are selected, the faster the plugin performs. Selecting only the expected barcodes is therefore a good practice. Barcode orientations Barcode orientations represent a barcode orientation on an image.
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. By default, this character is an empty space. Note: Non-printable characters are the first 32 characters in ASCII character table (Ex.
number represents the barcode index on the page. If there is more than one barcode on the same page, these Metadata fields will be defined as many times as there are barcodes on the page, except that the middle number (..._X_...) will increment according to the barcode index (e.g. Barcode_2_ Value, Barcode_3_Value, etc.). l BarcodeValue: Metadata field representing the value of the barcode. When multiple barcodes are present on the page, this field is present multiple times.
Limitations l Some barcodes created with PlanetPress 5 could not be read by the Barcode Scan task, so please use PlanetPress version 6 or 7 to create barcoded documents. l When using a secondary input, a known issue of the Workflow Tool can cause some unexpected behavior, like having the same Metadata file reused instead of a new one being created for each data file captured. To work around this issue, simply add a Rename action task to set a unique file name (Ex.
and a backspace (hexadecimal 08) can cause unpredictable behavior. 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 Remove HP PCL escapes: Select to have the document remove any Hewlett Packard Printer Control Language (HP PCL) escape sequences it encounters. l CSV (comma separated values). l Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the document splits that data into two fields. If you want to use a backslash character (\) as a delimiter, you must precede
each line of data in the data page buffer, and that each cell of the data page buffer can contain at most a single character. If the emulation ignores the LF at the end of a line, it must determine whether to overwrite the cells of the last line of data it 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.
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 374) 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 279).
Task properties General tab 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. l Run mode group (only with a PlanetPress Design document): l Printer centric: Select to send the document along with the trigger and data to the PDF RIP. l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to the PDF RIP.
l Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128). It gives the task the ability to take an existing PDF in input and apply the selected password to the PDF without any change to the quality level of the original PDF. l Font group l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs.
PDF Values Here's a list of the hard-coded PDF values for files generated with this plugin. Basically, these settings correspond to Digital Action and PReS Image settings for Standard Quality (see "About PReS Image" on page 279). l PDF version: 1.
l l 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 input or action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format. Database Query input tasks are used to start a process.
Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and Job Info variables are not modified in any way. Job Information definitions l %1 - DB Connection String l %2 - The actual query used l %3 - The number of records returned. Task properties Database Connection Tab l Database group l Location: Enter either the path and name of the database or a database connection string in this box.
l Emulation options group: Options from this group change based on the selected output file emulation. l PReS Workflow Database Emulation: If you selected PReS Workflow Database in the Output file emulation box, the following options are available: l Create data pages as follows: Select the option that will be used to generate the data pages.
and indicates their widths. To change the indicated widths, simply click the values displayed in the Width column and enter new values. Click OK when you are done to close the dialog box. You will then no longer be able to use the Default width box. l XML Emulation: If you selected XML in the Output file emulation box, the following options are available: l Create data pages as follows: Select the option used to generate the data pages.
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 Include password in config: Select to save an encrypted version of the database password (if any) within the exported configuration. l Export Config: Click to export the currently displayed properties of the task. The exported configuration can then be reused on other PReS Workflow workstations.
Decompress File(s) Decompress File action tasks decompress zipped job files (files compressed as zip files). 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.
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 450). 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.
l Run mode group l Printer centric: Select to send the document along with the trigger and data to PReS Image. l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PReS Image. Note that some features, such as the Time and Date require that this option be selected. l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file.
chrome (1 bpp) color depth. For TIFF G3 and TIFF G4, monochrome (1 bpp) is the only Color depth option you can select. This property is enabled for all output types except PDF. l Multi-page: Select to generate a single file containing multiple pages. When this option is not selected, PReS Image creates a file for each page included in the output file. This property is enabled for all output types except PDF and JPEG. Add page number: Select to put a page number on each page included in the output file.
l Index group: This group lets you specify which type of index must be created for each document generated by this task. PDI files are used by PReS Search as indexing information. l None: Select if you do not want this task to add an index file to the generated document. l PDI: Select if you want this task to add a PDI index file to the generated document. l XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document.
l Auto-rotate pages: Select to automatically rotate pages based on the orientation of the text or DSC comments. l Optimize for fast web view: Select to minimize file size and facilitate page downloading. l Title: Enter a title for the document. If you leave this box empty, the document’s name will be used as the document’s title. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time.
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. Note that configurations that were created with an earlier version of PReS Workflow and that included tasks set not to use any compression will by default be set to use the Flate compression method. l Grayscale down sampling: Select the down sampling option.
pixel shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l Color resolution: Select the resolution to use for color images. Note that this setting has an impact on the color down sampling process. l Security group l Set document permissions: Select to enter the Permissions password.
l Initial view group l Zoom factor: Select the magnification at which you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to open the generated PDF. Choose the Fit in window option to display the entire page using the available screen space, or choose a percentage of the actual document size. 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.
contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen. PReS Search Database Tab If PReS Workflow is configured to automatically update a PReS Search database (See "PReS Image preferences" on page 672), this tab can be used to override the global settings so that the task updates a different database than the one set in that global configuration. In order for the settings to work, the Add PDF to PReS Search database must be checked.
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. Note: As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the "Network considerations" on page 25 page.
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 Start in: Enter the folder in which the external program is to run.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Load External File Load External File action tasks are used to replace the current job file by the designated text file. Loading an external file does not delete the original file or modify it in any way. This task is put into effect in the following example process: l "HTTP PDF Invoice Request" on page 225 Input The current data file in the process will be discarded.
Processing The selected operation (adding or removing lines, text or pages) is made on the data file. Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General tab l Level { APPLICATION | SYSTEM | WORKFLOW }: Specifies the name of the event log in which the event will be created. l Type { SUCCESS | ERROR | WARNING | INFORMATION }: Specifies the type of event to create. l Source Name: Specifies the source to use for the event.
Output The input data file is returned with no modifications. Metadata is not modified. A single job info or variable is modified by this task. Task properties General Tab l Mathematical Expression: Variable data field containing the expression to be evaluated. This expression may combine any combination of standard PReS Workflow variables and VBScript mathematical expressions. For example, to multiply Job Info 9 by 2, the expression would be %9*2 .
Processing The XSLT is applied to the XML data file. Output The modified XML data file is output. Metadata and Job Info variables are not modified. l l File l Import: Lets you open an existing XSLT script from an XSL, XSLT or TXT file. l Export: Lets you save the current XSLT script as a file. l Print: Prints the current XSLT 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 The script editor text box: This is where you enter your XSLT Script that will be used. If you use an external script file, this will display the content of the file (note however that modifying the script in this case does not modify the external file and changes are not saved). l Script running from: Choose if the script should be run from the editor text box, or from an external script file.
Output This task outputs the target PDF/A-3 file, with the attachments added to it, as the job file. Properties General Tab l Target PDF/A-3: Specify the file to which the attachments and (optional) metadata must be added. 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. l External file: Adds the attachments to an external file. Use the Browse button to select a PDF/A-3 compliant file.
l Data: Data that is visually represented in the PDF; a CSV file with the detail lines of the invoice, for example. l Source: The source that the PDF was created from. If the target PDF was created from a Word file, that Word file would be the source. l Supplement: A supplemental representation of the PDF content or data. l Unspecified: The relationship is not known or cannot be described using one of the other values.
Push to Repository The Push to Repository Action task adds data to the PReS Workflow "Data Repository" on page 79. The task may only add one KeySet per action. If more than one insert is needed, a loop must be established first. The Push to Repository task can also be used to update an existing KeySet if a lookup is provided. Input Any data file, in any format. Processing A new KeySet is added to the Data Repository, or updated, using the data provided. Output The unmodified input file.
l l last_name = 'Jones' l id = 237 l age IS NOT NULL l last_name LIKE 'La%' l province IN ('QC', 'ON', 'AB') Add KeySet when condition is false: If the update condition above is false, a new KeySet is added to the group. If unchecked, no data is changed in the repository. l Store the result ID in variable: Select a variable or Job Info in which an array of inserted or updated IDs will be placed. The array of IDs in the form of [1, 2, 3, 4, 2443, 532, 5457, ...
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" on page 383). However, they can be slower to execute. The Run Script task can be used either as an Action or a Condition.
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 Copy: Copy the current selection (only available if there is selected text in the editor). l Paste: Paste the last selection that was cut or copied in the location of the cursor in the text editor. l l Delete: Delete the current selection (only available if there is selected text in the editor). l Select All: Select all of the contents of the editor.
The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from within your script. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l List of words to find and replace: Lists each string to find, and its replacement. These are executed in order, from top to bottom. l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. l Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies.
Task properties General Tab l Folder: Enter the path of the folder to which the files are to be saved. l 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 289.
Task properties General Tab l Var/Info#: Lists all Job Info variables, local variables in the current process and global variables in the configuration. Click on the variable you want to change. 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.
you know which services the SOAP server provides, as well as each service’s methods and name spaces. If firewalls control communication between the SOAP client and the Web servers, they must be configured so as not to block client-server communication. In the case of "string" type data, SOAP Client plugin tasks normalize all line endings to a single line feed character. Timeout By default the SoapClient plugin waits 100 seconds before returning an error if it doesn't get a response.
l 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. l Name: Displays the name of the arguments associated with the selected method. Note that you may also manually enter new arguments, change or delete existing ones, as well as change their order if needed. l Type: Displays the argument type.
are not meant to be printed. If your print job is bound for an HP compatible printer, it may include these characters even when printing to a PostScript printer that does not recognize them. PReS Workflow provides an easy way to automatically filter these characters through its Standard Filter task. Input Text-based data files such as line printer data (see "Line printer emulation" on page 60) and ASCII data files (see "ASCII emulation" on page 56) data files, which contain HP PCL control characters.
Icelandic, Indonesian, Italian, Malay, Norwegian, Portuguese, Spanish, Swahili and Swedish. Codepage 932 is often used for Japanese. Note: You can create your own translation matrix files for the Translation action task by adding them to the following folder: %COMMONPROGRAMFILES(X86)%\Objectif Lune\PlanetPress Workflow 8\Plugins\Translator Two examples are already present, converting ASCII to and from IBMEBCDIC. Input Any text-based data file.
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.
l JSON to XML: the task only converts JSON files to XML. l XML to JSON: the task only converts XML files to JSON. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Data splitters Splitter action tasks are used to split single data files into multiple data files. Splitters initiate a recurring cycle that stops only when the original file has been completely processed.
When using the ASCII or Channel Skip emulation, if there are missing line feed characters (when lines end with a single carriage return in ASCII, or when lines start with a No line feed channel in Channel Skip), the output data will be different from the input data, but the change will not be significant.
Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task. Task properties General Tab l Split group: Use this group to indicate how you want the file to be split. l 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).
that matches the set condition. Select Records after if you want the file to be split a given number of records after the field that matches the set condition. Select 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 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 To line: Enter a value corresponding to the last line on which the splitter must start searching for the word. l From column: Enter a value corresponding to the first column in which the splitter must start searching for the word. l To column: Enter a value corresponding to the last column in which the splitter must start searching for the word. l Match case: Select to force the splitter to match the character casing. Note that this setting applies both to the Specific Word and Word change options.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. In-Stream Splitter In-Stream Splitter action tasks are used to split non-emulated data files into multiple data files that are passed to subsequent tasks in the process. Note: Performing the splitting process on raw, non-emulated data speeds up the splitting process.
l Match case: Select to force the splitter to match the character casing of the string of characters entered above with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. l Where to split: By default, the task splits the file at the beginning of the line on which the search word is found (the default value is 0).
Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task. Note: The Metadata is not reset at the time the next data file is sent to the rest of the process. See also: "Output issues caused by Metadata, and how to avoid them" on page 71.
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”. l Trim selection: Select to force the splitter to strip empty trailing characters.
l The following rule: Determine if a new sequence starts or if the current one ends. For each Metadata level, the current value of the specified Metadata attribute / field is compared with the one in memory. If they are different, either a new sequence starts or the current sequence is ended. The next sequence starts with the next Metadata level being processed. For details see the "Rule Interface" on page 724. l Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized.
l Split method: Use this box only if you want to edit the standard XSLT script that will be used to split the XML file. First use the Standard XML splitter option to define the standard settings. Then, to change the standard XSLT script, select Advanced XML splitter and edit the script as required. l Standard XML splitter The following options are only displayed when the Standard XML splitter option is selected in the Split method box.
l Use UTF8 encoding: Select if you want to use the UTF8 encoding to process the file. l Use file’s encoding: Select if you want to use the XML file’s own encoding to process the file. l Advanced XML splitter: The following options and buttons are only displayed when the Advanced XML splitter option is selected in the Split method box. Note that you should not use this option before you have completed all the required settings using the Standard XML splitter option.
Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Process logic tasks A process is like a flowchart. The data files captured by the Input tasks become job files (see "Job file" on page 47) that travel down the process. Many processes include multiple process logic tasks.
l "File Name Condition" on page 423 l "File Size Condition" on page 423 l "File/Folder Condition" on page 422 l "Go Sub" on page 424 l "Loop" on page 425 l "Run Script" on page 426 l "Send to Process" on page 428 l "SNMP Condition" on page 429 l "Text Condition" on page 431 l "Time of Day Condition" on page 432 Branch A Branch duplicates your job file along with accompanying information.
secondary branch is used for the main branch. If the secondary branch includes a secondary input task or a Change Emulation action task, then the last emulation selected in the secondary branch will be the one used for the main branch. l Backup local variables: Select if you want PReS Workflow to use identical copies of the local variables for the main and secondary branches.
Processing At run time, the number of files in the folder is compared to the specified value, using the specified operator. If the folder or file count value is invalid and the task is used as Input task, the process does not run. If it is a Condition task, it returns False. No error is generated. Output Job Information definitions When used as Input task, the File Count task sets the following Job Info variables. l %1 - FolderName. The target folder. l %2 - Mask. The specified mask.
l Value: Enter the desired file count. This is a variable property field. (See "Variable task properties" on page 289.) 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 Information elements: Indicates what Job Info variables are automatically created by the input task.
a file or folder on disk. Advanced properties Right-click the task in the Workflow process and select Advanced Properties... to make settings on the On Error and Miscellaneous tabs. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Task properties General Tab l File size is: Select whether the condition is to check if the job file is smaller (less than) or larger (more than) than the specified value. l Kbytes: Enter the minimum (more than) or maximum (less than) size setting in kilobytes. l Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l Backup job file: Select if you want to use identical copies of the job file for the main process and the subprocess. l Backup job information: Select if you want to use identical copies of the job file information for the main process and subprocess. Once the subprocess completes its execution, the main process will retrieve the original job information values. l Backup emulation: Select if you want to use the emulation selected when the job file reaches the subprocess for the main process as well.
l Use original Data Stream every time: Select to reuse the original job file received by the Loop action task at every iteration. If this option is not selected and if the process ends with a Printer Queue Output task, for example, the second time the Loop action task will be performed, it will use the PostScript file generated by the output task. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l File l Import: Lets you open an existing script from an external file. This can be a .vbs, .js, .pl or .py file for language-specific scripts, or .txt for any of them. 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 Copy: Copy the current selection (only available if there is selected text in the editor).
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. Caution: With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking 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. SNMP Condition SNMP is a communication protocol for helping network administrators manage devices and peripherals on their network. It is useful for verifying the status of network printers, as you can retrieve error and other status messages that printers send out, such as being out of paper or having low toner.
access. It is recommended to increase security on your network by entering community names allowing varying levels of access depending on the particular device, its users, etc. The community name tells the device which rights to grant PReS Workflow (required to perform the test). l IP address: Enter the IP address of the network printer (or other device) whose status is to be checked via SNMP. l Get info: Click to retrieve information corresponding to the IP address you entered.
l Value: Enter a specific object status. Vendors of SNMP compliant devices sometimes list possible object states in their documentation. l Invert condition result: Select to toggle the result of the whole SNMP condition (true becomes false and vice versa). Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l Numeric comparison: This option is not displayed when either “Is found” or “Is not found” is selected in the Operator box. Select to convert the strings from the String and Comparison string boxes to their corresponding numeric values before performing the comparison. If you chose an operator that compares numeric values, you should select this option. l On numeric error: This option is only available when the Numeric comparison option is selected.
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.
Available Connector tasks l "Create MRDX" on page 594 (Legacy task) l "Laserfiche Repository Output" on page 438 l "Lookup in Microsoft® Excel® Documents" on page 440 l "Microsoft® Word® Documents To PDF Conversion" on page 605 (Legacy task) l "Output to Capture OnTheGo" on page 443 l "PReS Fax" on page 448 l "PReS Image" on page 450 l "PReS Print Controls" on page 458 l "PrintShop Mail" on page 608 (Legacy tasks) l When installed, the "ZUGFeRD plugin" on page 461 also appears in the Conn
Task properties General Tab The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document. l Server URL: Select the address of the COTG Server that you want the plugin to communicate with. (This option is only available if more than one COTG Server address has been defined.) l Repository ID: Enter a valid Capture OnTheGo Repository ID.
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 279 and "About PReS Fax" on page 278. Without a valid Imaging license, the plugin will fail with an error. In the trial version, the plugin will work. Input Any data file present on a SharePoint document store, even those not compatible with PReS Workflow emulations, and the properties of these files.
l Action Group l Download the document: Simply download the document and do not modify it in SharePoint. l Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint. This is useful for preventing files to be downloaded more than once. l Download the document and delete it from SharePoint: Download the document and delete it from the SharePoint server. Connection Tab l Server Name: The name of the SharePoint server.
Job Information definitions l %1 - Source file name: Contains the name of the current captured file. l %2 - Directory: Contains the name of the SharePoint director from which the current file was captured. Laserfiche Repository Output The Laserfiche Repository Output task publishes files - and optionally sets index values - into a Laserfiche server.
field is empty, the documents will be exported by default to the root folder l Import Format group l Laserfiche Pages: Converts all images files (*.bmp, *.gif, *.jpeg, *.pcx, *.png, *.tif, *.tiff, *.txt) into the Laserfiche internal TIFF format on the server. When double-clicking on the document in Laserfiche the image will be opened in the Laserfiche Image Viewer. l Electronic files: All files will be stored in their original format in Laserfiche.
Restrictions l Each Laserfiche Repository Output task uses a connection to Laserfiche. You can use as many Laserfiche Repository Output tasks at the same time as your Laserfiche license allows. If you see the error message ‘The session number was exceeded’ in the PReS Workflow Service Console, it means you have exceeded your allowed number of connections.
A PlanetPress Design document takes a PDF file as the input data file, and reproduces it exactly as it enters. The document also contains a custom data selection set to hold an email address. The data selection's value is given by a Metadata Field called 'Email'. The value of this Email Metadata field is a region from the sample data file representing the customer number.
l Metadata group 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. l Lookup Column: The name of the column in the Microsoft® Excel® worksheet that corresponds to the contents of the Lookup Field. l Action: What to do with the resulting data from the Microsoft® Excel® worksheet. This can be: 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 350) or as an Output task (see "Output tasks" on page 543). 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.
l USE URL: Enter a URL corresponding to the document location and name (note that the URL must begin with either HTTP: // or HTTPS: //). The document would typically be available from the PReS HTTP Server or a regular Web server. l File Type: Select the appropriate document type. HTML for forms that users can fill out, and PDF for documents users can read. l Cover Image: Enter the path to a cover image that is shown in the repository and library list, as well as the document property.
l Fail process if any of the categories does not exist: Check this box if you want the process to fail if any of the categories listed above does not exist on the Capture OnTheGo Server. If this option is not selected, and if some of the listed categories are not present on the Capture OnTheGo Server, the process will go through and the listed categories will be added to the Server.
from the repository based on this setting. Note that the date you enter will automatically be reflected in the For box above. l Time zone: When you enter a number of days in the For box or a date in the Until box above, the computer’s time zone appears in this box. You may select a different time zone if required. l Document Tracking: l Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server. This tracking is done through the COTGDefaul.
Processing The task connects to the selected Document store and uploads the current data file. If the file already exists, it will be overwritten and, if this option is selected, marked as "checked in". The information accompanying the file (the SharePoint Metadata) is either updated or created. Output The output of this task is the original data file. Task properties General Tab l SharePoint Site: The name of the SharePoint site where you want to send the files.
l Single line of text: This type may contain a string of any type of characters. This is the most flexible type of field. Use this type when you are not sure if the constraints of the other types of fields will be appropriate. l Multiple line of text: This type may contain multiple lines of text. l Choice: This type contains the menu to choose from. l Number: This type may contain a number (1, 1.0, 100). The decimal separator is “.” in the plugin. l Currency: This type contains the currency ($ …).
In addition to the job-specific PReS Fax properties you configure in the task’s Properties dialog box, there are configurable options common to all PReS Fax outputs processed by a given computer (See "PReS Fax plugin preferences" on page 668). 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 54).
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 279. Since this task is an Output, it is not possible to immediately act on the generated image before continuing. When necessary to immediately retrieve the generated file, the "Digital Action" on page 374 task should be used instead.
l If the data file and a document are selected, and Optimized PostScript Stream mode is used, the data file is merged with the document and the resulting OPS job is sent to the PReS Image host to produce output. l If the data file is a postscript file and either mode is used, the postscript file is sent to the PReS Image host which generates output (since this is already Optimized PostScript, it is not regenerated).
l Output type: Select the output file type that you want. l PDF: The output will be a PDF file. If you select PDF, the DPI and Color Depth options (see below) are disabled and the options available in the PDF tab are enabled. l JPEG: The output will be a JPEG file. JPEG is a lossy compression image format that creates small files, compressing continuous tone images (such as scanned photographs) well. l TIFF: The output will be a TIFF file.
l Send Email: Select to send the generated file via email. You enter the emailing properties in the Login, Recipients, and Attachment(s) tabs. Note that the generated file will only be sent if you select the Attach output file(s) option in the Attachment(s) tab. l Archive folder: 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 Archive output option is selected.
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 Monochrome images group l Compression: Select the compression to use for the monochrome images. Flate compression is lossless, so no data is lost during compression. Flate Mono works 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.
l Color images group l Compression: Select the compression to use for the color images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs. JPEG removes 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.
l Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128). It gives the task the ability to take an existing PDF in input and apply the selected password to the PDF without any change to the quality level of the original PDF. l Font group l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs.
l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server). l 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. l Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory.
l PReS Classic 6.3.0 or higher must be installed on the same system. l 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.
Note: The use of pre-compiled PReS Classic jobs is heavily recommended, as this greatly reduces the scope for run-time errors. l Data File: The data file to use in the run. This file can be explicitly selected, or it could be set via a Connect Workflow variable; see "Variable task properties" on page 289. Note: If the Data File selection does not include the data file folder path, then the folder entered into the Working Folder entry will be used for determining the path.
l Instance: Used for specifying the PReS Classic Print Control instance. PReS allows up to four instances of the same Print Control type (license dependent), and any one of those instances can be selected here. Selecting 1 would force Connect Workflow to use Print Control PRN1, whilst selecting 2 would launch PRN2, and so on. This is useful if you have a variety of Print Control license speeds, and each license is assigned to a different PRNx instance.
All the entry fields with a maroon field name support the use of variable data. You can right-click within these fields to insert a Workflow data selection. This provides an easy option for including Workflow information that relates to the currently processing invoice (such as Metadata and variables) into the ZUGFeRD fields.
l Name: The individual or company name. This field supports alphanumeric strings and can be set via Workflow data and/or variables. l Adresse: The postal address (sans post code and city entries). Two address lines can be included in this entry. This field supports alphanumeric strings and can be set via Workflow data and/or variables. l Postleitzahl: The postal address post/ZIP code.
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 Name: The individual or company name. This field supports alphanumeric strings and can be set via Workflow data and/or variables.
II tab support the use of variable data. You can right-click within these fields to insert a Workflow data selection. For more information on Workflow context menu data selection options, see this page: Workflow Variable Properties l Zahlungsinformationen group contains payment related information. l Zahlungsreferenz: The payment reference, purpose, or payment number serving as identifier for the payment. This field supports alphanumeric strings and can be set via Workflow data and/or variables.
the user to ensure that valid codes are entered. This field can be set via Workflow data and/or variables. l Allgemeine steuerliche Informationen group contains taxation related general information. l Steuerart: The trade tax code following the international UNCL 5153 standard. Generally this is "VAT" (Umsatzsteuer, value added tax). 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.
variables. l Gesamtbetrag der Abschläge: The total amount of discounts and allowances. This entry should be a numeric currency entry, which can be set via Workflow data and/or variables. l Steuergesamtbetrag: The total tax amount. This entry should be a numeric currency entry, which can be set via Workflow data 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 82.
For more information about Metadata see: "Metadata" on page 66. This task is put into effect in the following example processes. l "Example: Daily sales report from PDF files" on page 228 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 54).
retrieved. l Add job information to the document (only if a document was selected): Select to prompt PReS Workflow to add the available Job Information elements in the header of the generated 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. Embed/Extract PReS Workflow Metadata Embed the current PReS Workflow Metadata inside the current data file in a PDF emulation.
l Embed Metadata from PDF job file: the current Metadata file is inserted in the current data file, which is assumed to be a PDF file. If the original PDF is PDF/X or PDF/A compliant, the resulting PDF file will also be compliant. 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 The task raises an error if the selected Metadata Fields Management action is Sum and if one of the field values is not numeric. The task supports approximately 15 digits of precision in a range from 2.23 x 10-308 to 1.79 x 10308. Output The original data file is outputted, along with the modified Metadata. Task properties General Tab l Action: Select the type of Metadata Field Management action to perform. Five action types are available: l Add/Replace: Create a new Metadata field.
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. l Decimal Separator: Set the decimal separator for the Sum option. 3 possible modes are offered: l Auto-detect: Interpret automatically the value. This option is ideal for documents using mixed decimal separators.
Properties l Chose an action group 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). l Save the current metadata file: Saves the current Metadata to a specified location. Useful as a backup or for use in Error processes. l Delete the current metadata file: Removes the active Metadata from the process.
Task properties General Tab l Filter levels: Rules for deselecting nodes at the Group, Document or Data page level. Note that currently unselected nodes are ignored. l Group: Select the Metadata Group nodes (the nodes only) based on the specified rule(s). l Document: Select the Metadata Document nodes (the nodes only) based on the specified rule(s). l Datapage: Select the Metadata Datapage nodes (the nodes only) based on the specified rule(s).
Using the wildcard parameter "?" Since all metadata data pages, and possibly all physical data pages, are treated by the task at run-time in order to evaluate the condition at each level, it is necessary to dynamically define metadata as well as data selections to check all occurrences instead of a fixed one. This is done using the wildcard parameter "?". When a question mark is used as a parameter in a data or metadata function, the function operates on all nodes (not just one) of a given level.
Task properties General Tab l Document: Create a new Document level. Note: Attributes and Fields are deleted for all new Document levels created as well as existing Groups. l Group: Create a new Group level. Note: Attributes and Fields are deleted for all new Group levels created. 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.
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.
Output The original data file is output, along with the modified Metadata. General Tab l Group: Sorts the Metadata by group. l Document: Sorts the Metadata by document. l Data page: Sorts the Metadata by data page. For each parameter, three columns are available: Sort By, Then by, Then by (again). This lets you sort your document level in three different orders sequentially. Sorts are always done from left to right, top to bottom, giving you a total of 9 sorting possibilities.
Processing The metadata is read and PDF indexes are located. These indexes are defined in the PlanetPress Design document as data selections, in which the Archive / Email / Fax properties define the data as an index with a name. When all the indexes are collected, a PDI file is generated with those indexes. Output The output is the same as the input, no modification is done to either the data file or the metadata. However, a PDI file is generated and saved in the location specified in the task.
l Each instance of the N-Up object must have the “change data page with each repeat” option checked. l The total number of repeats on each page (vertical X horizontal) must correspond to the number specified in the Number of virtual pages per physical page option.. l The Alignment setting of each n-up object must be set according to the device’s duplicating capabilities (long-edge or short edge binding).
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.
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. Tip: No spaces are allowed around the listed names, respectively before or after a semicolon. Operators l Searches are case-insensitive.
Example 2 The domain name entered in the Filter Domains field is objmtl.objectiflune.com and the user name entered in the Filter Users field is rentel. If search criteria are entered in multiple input fields, all of them are combined with AND. Therefore the result will only contain all the print job information for objmtl.objectiflune.com where the user name is rentel. Date and Time Definitions Both date and time entries must be notated in UTC format.
l Machine name l Machine GUID. Results File Format The following result file formats are selectable: l XML l JSON l CSV (Separator = semicolon (0x3B), string indicator = quote (0x22)). Note: This file is not automatically saved to disk. The retrieved job info is written to a temporary results file that will be passed on as the new Workflow job file. To save the results file, use a Send to Folder plugin and configure that appropriately.
l Number of pages: This is the number of pages for one copy of the print job. This value is calculated by the Windows spooler, when processing the printing order. Please be aware that some applications do an implicit reformatting of jobs if the intended paper size does not match the paper size as selected in the print dialog.
The plugin appears in the Plug-in Bar of Workflow under OL Connect Send. Typically, it is used in the OL Connect Send interaction process, just after the initial HTTP Server Input plugin. The Get Job Data plugin gets all relevant information for the dedicated print job using the Unique Job ID. Whenever an OL Connect Send Printer Driver is sending a print job to the OL Connect Send Job Processor plugin, it creates a unique ID string composed of 10 upper- and lowercase letters and digits e.g. “ri0zZdluLp”.
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. If no matching Job ID is found, the plugin will wait for 5 seconds and then raise an error, which can be acted upon via the On Error tab settings. When selecting this option, the Status ID information has to be checked.
l Number of Copies: This is the value set by the OL Connect Send Printer Driver for the number of copies (intended number of copies required for the print job). Some applications do not use the general print job information to define the number of copies. In such (rare) cases, the Number of Copies sent in the job can differ from what the user entered in the print dialog.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Job Processor The Job Processor plugin is an output plugin that appears in the Plug-in Bar of Workflow under OL Connect Send. Input The Job Processor plugin must be added to a Workflow job transfer process that starts with an HTTP Server Input. The Job Processor plugin is the only other task in that process.
Timeout During a job transfer from the OL Connect Send Printer Driver to Workflow, a timeout could occur (indicated by a log entry like “ERROR: sendBinaryContents: Could not open request. Reason: 12002”). In this case, the timeout for the HTTP service in Workflow needs to be increased. It is recommended to use a value of more than 10 minutes (>600 seconds). Additionally, the timeout in the browser on the client side should be enhanced. Please see the help pages for your browser about how to do this.
Output The plugin stores the incoming print job in the target folder with the file name specified in the plugin. If no extension is defined by the user for the file name, the default “.ps” extension is added automatically, as the incoming print jobs are PostScript files. Metadata In addition to the print job, the plugin creates a metadata file with basic information. The values originate from the client machine.
Information Workflow Variable When licensed When unlicensed 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. l Plug-in Information l License: Shows whether a license for OL Connect Send could be found. If not, OL Connect Send will be running in unlicensed (default) mode.
l "Create PDF/VT" on page 508 l "Create Print Content" on page 513 l "Create Web Content" on page 516 l "Download EML Messages" on page 520 l "Execute Data Mapping" on page 522 l "File Store - Delete File" on page 526 l "File Store - Download File" on page 527 l "File Store - Upload File" on page 528 l "Mark Connect Sets for Deletion" on page 530 l "Merge Jobs" on page 531 l "Render Email Content" on page 533 l "Retrieve Items" on page 537 l "Set Properties" on page 541 l "Update
Task properties Data Mapper Tab The Data Mapper step generates a Record Set from a specific source: data mapping on the appropriate source (Current Data File, Database or PDF/VT data file), Retrieving items from the Connect Database (filter setting) or uses the current job Metadata. The resulting Record Set is given to the Content Creation part of the task.
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). Initially, the value of runtime parameters that are defined in the selected data mapping configuration is set to that of a local variable or else a global variable if there exists a variable with the same name. If no such variable exists, the value will be an empty string.
l Delete the selected condition: Click to delete the currently selected conditions in the list. l Clear the rule: Click to delete all rules in the list. Note: This cannot be undone. l Import a rule: Click to open the Browse dialog and load a Rules file. This will load its rules into the list. l l Export the rule: Click to open a Save dialog and save the Rules file to disk. Rule Viewer: Displays a text-based view of the condition using operators and parentheses.
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 48). 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.
l Preset Names: Select the appropriate Job Preset file. Listed are the Job Presets that are present in the Connect Resources (see "Connect resources" on page 38). l Runtime Parameters: The Runtime Parameters defined in the selected Job Creation Preset are displayed and their values can be edited here. Right-click the field to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 48).
l Preset Name: Select the appropriate Output Preset to create output with. Listed are the Output Presets that are present in the Connect Resources (see "Connect resources" on page 38). l Output Management group: l As defined by Output Preset: Select to send the output of the job to the location set in the Print Preset (file, printer, etc). l Through Workflow: Select to replace the current job file with the output produced by the server.
Sort Parameters The Sort Parameters define how to sort the entities retrieved from the Connect Database using either the "Retrieve Items" on page 537 task, or the Filter source in the "All In One" on page 493's Data Mapper task. l Sort items based on: Lists the different sorts to apply to the entities. l Name: Click and enter the name for the Value or the Property to sort on. l Type: Select whether the Name option refers to a Property or a Value within the entity.
l A JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string examples" on page 77. l A JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 79).
Properties General Tab l Template 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. l Template Names: Select the appropriate template. Adding template is done through the Send to Workflow option in the Designer Module. l Section: Enter the section name that will generate output. Only one section can be output. If no section is defined or if the section name is invalid, the default section will be output.
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. At runtime, Workflow passes the parameter values as strings, and the type defined in the template will be used to try and parse the input parameter value.
l Web Content as HTML page: Check to generate the active Web section in the template as an HTML page and send it with the email as an attachment l Test SMTP settings: Validates the format of the sender's address and mail host and tries to send a test email. This won't work when the option Start TLS is checked. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks.
Note: The result of a Retrieve Items task cannot be used with a Job Creation Preset. Use the IDs in the metadata instead (see the Properties below). Processing The task prepares the content items or content sets for printing, tagging them as printable. Only the content items that are part of the job will generate output. Output The task outputs a Print Job ready to be sent to the "Create Output" on the next page task for printing.
o Numeric string values need to be parseable as a number (either a whole integer or decimal value). o Dates should be in an ISO8601 compatible format (e.g. 2019-10-15) or use the current Windows Locale date settings options.The latter is not recommended as it requires all computers in the cluster have the same locale data format. The order of the parameters doesn't affect the way they are handled at runtime. Note: Backslashes (\) and double quotes (") in a JSON string must be escaped with a backslash (\
This task can be added as an Action task (see "Action tasks" on page 350) or as an Output task (see "Output tasks" on page 543). 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.
l Through Workflow: Select to replace the current job file with the output produced by the server. Every option in the Output Preset is still used, except for the output location. Note that when the output is separated, the current job file is not replaced with the actual output files but with a CSV file that lists the paths to the outputted files (e.g. “C:\Users\Administrator\Connect\filestore\3836.2859982401376467470\template_0001.pdf,C:\Users\Administrator\Connect\filestore\3836.2859982401376467470\temp
Input Any data file supported by the selected PlanetPress Document. Processing The input data file is merged with the selected PlanetPress Document. Output The output is a PDF/VT with default quality settings. The metadata embedded within the PDF/VT is the one generated by the PlanetPress Document. Properties Note that the Connect Proxy tab is not present in the Create PDF/VT Action task properties, as this task does not communicate with the OL Connect Server.
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. 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 500 task, a "Create Print Content" on page 513 task, or a "Create Web Content" on page 516 task.
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. To work around this issue, insert an Execute Data Mapping task (which does allow to specify runtime parameters) immediately before the Create Preview PDF plugin; configure it to output JSON, and use the JSON string option in the Create Preview PDF plugin.
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. l A template name: Select the appropriate template name from the list. Adding templates to this list is done from the Send to Workflow option in the Designer module. A preview will be displayed of the output generated by the Print context of the selected template. (Not available for a dynamic template name).
however, an easy workaround: insert an Execute Data Mapping task immediately before the Create Preview PDF task, configure it to output either Metadata or JSON and adjust the settings on the Datamapper tab of the Create Preview PDF task accordingly. The Content Creation tab then allows to specify Runtime parameters for the selected template. OL Connect Proxy Tab l Server Connect Settings l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides.
Metadata The "Execute Data Mapping" on page 522 task and the "Retrieve Items" on page 537 task output Metadata containing information regarding a Record Set. JSON The Create Print Content task supports two types of JSON: l A JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records.
from the task, they are only saved in the OL Connect Database. Properties General Tab l Template File: l "None" File name: Select to accept a PDF/VT file as an input and automatically create content items based on the PDF/VT. 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. l Template Names: Select the appropriate template.
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. At runtime, Workflow passes the parameter values as strings, and the type defined in the template will be used to try and parse the input parameter value.
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 500 task, a "Create Preview PDF" on page 509 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.
Output The task outputs HTML code as a job file. Within this HTML code, references to external resources point to the local OL Connect Server and are served to the requester directly when the HTML file is opened in a browser. Properties General Tab l Template File: l "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. l Template Names: Select the appropriate template.
Caution: warningThe JSON format is not validated by the plugin; it is passed as is to the server. Note: Only the first record or JSON object is processed, since this task can only generate HTML output for a single record. l Embed all resources: Check this option to download the resources and embed them in the HTML file. l Do not alter HTML: Check this option to prevent that the Create Web Content task modifies the HTML.
number (either a whole integer or decimal value). Dates should be in an ISO8601 compatible format (e.g. 2019-10-15) or use the current Windows Locale date settings options. The latter is not recommended as it requires all computers in the cluster have the same locale data format. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the "OL Connect preferences" on page 652.
Note: With PReS Workflow version 2020.1, using the Download EML Messages task requires the version 2020.1 "Mailjet" on page 587 and "SendGrid" on page 590 plugins . They are available for download on the Resource Center (help.objectiflune.com). Tip: Double-click an .eml to open it in your email client. Input This task must receive either Metadata or JSON Job Data containing information regarding a prerendered email message that has been saved in EML format in the File Store.
Note: Information about the Connect Server (host, user name etc.) is taken from the Workflow Preferences (see "OL Connect preferences" on page 652). 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.
If the data mapping configuration expects a database data source, the Data Source option is ignored and the database is accessed instead. If a PDF/VT file is used, the data mapping configuration option is optional - if one is present, it must be able to read the PDF/VT. Output The output to this task is twofold. On the OL Connect Server side, a Record Set containing multiple records is created and saved.
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. l 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 114). 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).
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 652. 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.
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 652. 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.
Task properties General Tab l Filename or File Store ID: Enter the name of the file in the OL Connect File Store or its File Store ID. A File Store ID refers to a file or folder in the File Store. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the "OL Connect preferences" on page 652.
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 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.
Mark Connect Sets for Deletion The Mark Connect Sets for Deletion task indicates that an item in the Connect Database should be deleted the next time the Database Cleanup runs. This means that whatever item is set for deletion will no longer be available from the database. Input The task requires a valid Metadata file containing items for deletion, including Job Sets, Content Sets and Data Sets.
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. Merge Jobs The Merge Jobs Action task merges an external Metadata file containing an OL Connect Job with the current Job File.
Processing The PDF to Bitmap plugin converts PDF pages to bitmaps, optionally scaling them. Invalid pages or ranges generate an error; in this case, no bitmap is produced. If the specified output folder doesn't exist, it will be created. If the folder cannot be created, an "Error creating directory" message is logged. If the plugin can't connect to the OL Connect Server it will return an error message. Note: As of OL Connect version 2020.
OL Connect Proxy Tab l Server Connect Settings l 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.
JSON The Render Email Content task supports two types of JSON: l A JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string examples" on page 77. l A JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 79).
Here is an example of the JSON structure. In this case there's only one email message in the Content Set. {"messages": [ {"attachments":[ {"name":"att0307c655-e14e-4400-8f90-365032648aed.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.
l Metadata: The Metadata must contain information regarding a valid Record Set, or JSON data. This can be the output of the "Execute Data Mapping" on page 522 task or "Retrieve Items" on the facing page task. l JSON String: a JSON object or an array of JSON objects representing records (see "JSON string examples" on page 77) or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 79).
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. The items are retrieved using a set of conditions working together.
Task properties General Tab l Entity to retrieve: Use the drop-down to select which items to retrieve. l Record: Retrieves one or more Records, whether or not they are part of a Record Set. Output similar to the "Execute Data Mapping" on page 522 task. l Record Set: Retrieves one or more Record Sets, including all their records. Output similar to the "Execute Data Mapping" on page 522 task. l Content Item: Retrieves one or more Content Items, whether or not they are part of a Content Set.
l Switch conditions: Click to swap two conditions on the same level, or two groups of conditions. l Delete the selected condition: Click to delete the currently selected conditions in the list. l Clear the rule: Click to delete all rules in the list. Note: This cannot be undone. l Import a rule: Click to open the Browse dialog and load a Rules file. This will load its rules into the list. l Export the rule: Click to open a Save dialog and save the Rules file to disk.
are often used to separate mail routes, provinces, or cities. l Sort items based on: Use the [...] to open the "Sort Parameters" on page 500 dialog and define how documents are sorted within the group, for example by Zip 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 652.
Set Properties The Set Properties Action task defines properties for entities saved in the OL Connect Database (Records, Content, and Jobs). These properties are applied to the entities and can then be used to retrieve them using the "Retrieve Items" on page 537 task. Input The task must receive Metadata that contains appropriate entities, generally from the "Execute Data Mapping" on page 522, "Create Print Content" on page 513, "Create Web Content" on page 516 or the "Create Job" on page 504 tasks.
page 652. Note: Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name.
Task properties General Tab l Update Source: Select the data source from which the records in the Connect database will be updated. l Metadata: Select this option to use the current content of the Metadata. l JSON: Enter a JSON string, or a variable containing JSON. (See "Variable task properties" on page 289.) The task expects a JSON Record Data List; see: "Types of JSON in Workflow" on page 77.
actually been sent from the software. And in the case of a PReS Image Output task, PReS Workflow considers its job done once it has sent its request to PReS Image, not once PReS Image has finished generating the actual image file. Other tasks available in PReS Workflow can also be used to generate output, such as Digital Action, Create VDX and PrintForm Action tasks. Unlike Output tasks, Action tasks are only considered completed once the output file has been generated.
l HTTP PDF Invoice Request l HTTP Brochure Request Note that Capture can only be used with PlanetPress Suite. Input Any data file, with optional metadata. Processing The data file is either deleted directly or sent to the Windows Recycle Bin. Task properties General tab l Move to recycle bin: Select to send the deleted files to the Windows recycle bin. When this option is not selected, files are deleted permanently. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Task properties General Tab l FTP Server: Enter the IP address or host name of the FTP server. l Port number: Set the plugin to use a specific port number. l Use FTP Client default port number: Use the value as specified in the Preferences (port 21 is the default value). l FTP Port: Enter the specific port number to use when Use FTP Client default port number is unchecked. Enter a value between 1 and 9999. Note: There is no validation to ensure the port is available.
Note that this task doesn't merge data records with a PReS Connect template, like the "Create Email Content" on page 500 task does. This task uses the Microsoft Graph API. For this task to function correctly, Workflow needs to be granted application permissions for Microsoft Graph in the organization’s Azure instance. It needs read access to the Users category (User.Read.All) so that the task can identify the users in the organization. In addition, to send emails on any user’s behalf, the Mail.
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 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. l Subject: Enter the subject of the email.
click the Add file to Attach list button (the downward pointing arrow). l List of files to attach: Lists the files that will be attached to the email. Selecting the Attach output file(s) option adds these files at the top of the list. Any other file that may have been added using the File box (above) is also listed here. To remove a file from the list, select it, then right-click and select Remove from the list.
Graph in the organization’s Azure instance. It needs read access to the Users category (User.Read.All) so that the task can identify the users in the organization. In addition, the Files.ReadWrite.All permission is required. For more information on setting application permissions for Microsoft Graph, see https://docs.microsoft.com/en-us/graph/auth-v2-service. Input Any data file.
l Tenant ID: Enter the Tenant ID as specified in Azure. This value is static and cannot contain variables. l User ID: This is the OneDrive user's ID. This value is dynamic. You can use any combination of text, variables and data selections; see "Variable task properties" on page 289. l Use delegated permissions: Select this option to use delegated permissions instead of application permissions.
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 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.
l l 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. l Remove: Click to remove the server from the approved list. List of known servers: Displays a list of servers that were connected to, whether they are approved or not. l l Server: The name of the server the certificate belongs to. l Fingerprint: The RSA fingerprint of the server.
and print it). Task properties General Tab l Printer queue: Select the queues to which you want to send the output. Note that this is a variable property box, so you can use various schemes to use printer queue names that change with each job at run-time. l Properties: Click to change the current printer queue properties.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Printer Queue Output The Printer Queue Output task dispatches jobs to selected PReS Workflow Printer Queues (see "PReS Workflow printer queues" on page 93). Note that you must have created at least one Printer Queue in PReS Workflow before you can add your first Printer Queue Output task.
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.
printing 50 pages a minute, the first queue will receive roughly ten times more pages than the second one. 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. l Page delimiter group: These options are enabled when you choose Split job or Queue balancing load balancing options.
Processing While an email is always sent by this task (or at least attempted to be sent), the contents of the email and presence of attachments depends on the selected options. Once the contents of the email and attachments are determined, the email (including any attachments) is sent directly to the selected mail server. Output This task doesn't have any output other than the email that is sent to the recipient(s).
PReS Connect has a tool to design HTML email templates: the Designer. To generate email output from a template you would use the "Create Email Content" on page 500 task. Also note that it is currently not possible to send both an HTML and plain-text version of your message. Attachments Tab Use this tab to specify what files to attach to the e-mail. l Attach input job file: Select to attach the current job file to the email that the task sends.
l Enter the account credentials: the account name on the mail server, and the password required to unlock the selected account. l Select the level of priority and sensitivity. The default value is Normal. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send Email The Send Email output task sends the data files it receives via email.
Task properties Recipients Tab 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 runtime. You can use any combination of text, variables and data selections; see "Variable task properties" on page 289. l Cc: Specify addresses to which a copy of the generated emails are to be sent.
l Attach: Lists the files that will be attached to the messages sent from PReS Workflow for this task. Selecting the Attach output file(s) option adds these files at the top of the list. Any other file that may have been added using the File box (above) is also listed here. l Zip mode: Select how you want the files checked in the Attach box to be zipped. Select Zip individually to have PReS Workflow create a zip file for each file.
l Account name: Enter the name of the account that PReS Workflow is to use to send emails via the mail server. l Password: Enter the password associated with the account name entered above. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send to Folder Send to Folder Output tasks send the files they receive to a local folder.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Document Management tasks A Document Management task is a connector to a Document Services, ECM or Document Management system outside of PReS Workflow itself.
Note: To be able to use this plugin you need a working DocuWare user account with appropriate permissions. Note: The version of DocuWare we tested the 2022.2 plugins on was 7.7.0.10245. Upland Objectif Lune expects the plugins will work with later versions of DocuWare but this has not been tested. DocuWare Download The DocuWare Download plugin Downloads files of any file type from a dedicated DocuWare CRM system.
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. The response that the plugin gets from the DocuWare Server is then stored in a variable (if specified). Task properties Connection tab The Connection tab fields set the connection parameters. You can use static text and/or Workflow variables, data and lookup functions.
Test Connection This button tests the connection details entered in the Connections tab. If a successful connection is made, then Connection Success will appear as the current status. When a successful connection is made, the Cabinet and Index data for this login will be downloaded and stored locally. This allows configuring the Docuware Download plugin in Workflow configurations offline as well as online, without requiring a constant live connection.
Depending upon the selection made, one of the two options will become available: l ID section becomes active if Retrieve By ID was chosen. Enter the Document ID directly in the Document ID entry box. l Search section becomes active if Retrieve By Search was chosen. It will download a document from the DocuWare server, based upon the following criteria: l Field. Enter the Field to search on.
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.
Processing After establishing a connection with the DocuWare system, the plugin will try to upload the specified file (either the Job File, or an external file) with the given index values to the selected File Cabinet. The plugin won't modify the uploading file in any way. If any issue is detected during a file upload, the log messages and the related file and its index values will be stored. The Docuware Upload plugin is designed to work offline as well as online.
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.
1. Job file: Select this option to upload the current Workflow Job file (the equivalent of using %F). 2. External file: Select this option to upload a file from the file system. Selecting this option activates the file selection input field. To select a file click the Browse button ( ) to browse for a file, or right-click within the input field to open the context menu which allows the selection of variables, data and lookup functions (see "Data selections" on page 48).
l Create a new document will load the document as a new document to the DocuWare server. This document will be named based upon the document name field (as seen highlighted in the Document name field screen entry). 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.
l 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. This means as follows: l Strings: String values will be uploaded to Docuware "as-is", without modifications. Strings are Unicode-aware, so that non-ASCII characters can be entered as well, like Chinese, Japanese, etc..
l The "M-Files Download" below plugin for downloading files from an M-Files server. l The "M-Files Upload" on page 578 plugin for uploading files to an M-Files server. These plugins are not initially installed with Workflow. available for download on the (help.objectiflune.com). After downloading the .PPK files, you will then need to import them into Workflow yourself. See . See Importing a plugin. Once installed, the M-Files plugins will appear in the Document Management category in the Plug-In Bar.
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 FileID (optional): If the file ID is not given, the first file - the root document - will be retrieved. l Retrieve by search: This section allows the retrieval of files by searching for specific properties (Definition entries). Enter the properties under Index data. l Field: The property to search for.
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. (Right-click and select Variables > Local variables > yourvariable.) This is optional. If the variable exists, it will be used. The M-Files plugin searches for the variable by name and sets the selected response into the variable.
Processing The M-Files Upload plugin starts by sending a login request to the M-Files Server. Once the connection is established, it tries to upload the specified file to the M-Files Server, either as a new document or as the new version of an existing document. The plugin saves the (JSON) response that it gets from the MFiles Server in the specified variable. Output The output of this plugin is the unchanged Job File. Task properties All of the task's General properties are dynamic.
l Destination: l Class: Document Classes are defined (per Vault) on the M-Files server. Select the desired Class from the drop-down list. l Select whether to create a new document or update an existing one. l Create new document: In Create mode, a new document with a single file is created at the root level of the Vault. l Update existing document: In this mode, the file is added as the new version of an existing document (at the root level of the Vault) and its properties may be changed.
l Add missing properties. Any properties that are defined in the Metadata Structure for the selected Document Class, but not specified in the Index data, are added to the Index data. l Response: l Store response in a variable (optional): Specify a variable if you want the plugin to store the JSON response that it gets from the M-Files server. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties.
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 Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint. This is useful for preventing files to be downloaded more than once. l Download the document and delete it from SharePoint: Download the document and delete it from the SharePoint server. Connection Tab l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ).
Job Information definitions l %1 - Source file name: Contains the name of the current captured file. l %2 - Directory: Contains the name of the SharePoint director from which the current file was captured. Output to SharePoint The Output to SharePoint action task can be used to send files to an existing Microsoft SharePoint server.
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. l 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.
"No". l 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 Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted.
Mailjet l The Mailjet plugin is not installed by default. It is available for download on the (help.objectiflune.com). Make sure that the plugin version you download is compatible with your Workflow version. The latest plugin version: 1.12.0, provided in the 2022.2 download package, is backwards compatible with Workflow down to version 2020.1. l In order to use HTTPS it is essential to use the latest version of the plugin, available for download on the (help.objectiflune.com).
Should you encounter any issues, please contact your local Objectif Lune Support team and we will do our best to help. Testing the plugin To test the plugin, drag it from the Plug-In Bar into a process. The plugin configuration dialog will open and show the index property page. If that works, the plugin is installed correctly and ready for use. Further help can be found by pressing F1 or the Help button in Connect Workflow from the “M-Files” dialog or by searching for “M-Files” in the Workflow product.
It then transforms the files into email messages as specified by Mailjet and sends the emails via the Mailjet Web API. Output This task does not make any changes to the Metadata or the Job File. Properties General Tab l Mailjet API: l API Key and Secret Key: The API Key and Secret Key are both generated automatically when you create your Mailjet account. The plugin needs to provide them in order to authenticate its request to Mailjet's Email API endpoint.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SendGrid The SendGrid plugin's settings allow you to: l Tag the emails with category names, which help organize your email analytics (see About categories). l Set a time at which the emails should be sent (see Scheduling parameters). l Add custom headers specifying specific handling instructions for your email.
All attachments should be combined in one array: [{"url":"file:///C:/Terms-and-Conditions.pdf","disposition":"attachment","name":"Terms.pdf"},{"name":"Take action Mandie.pdf","disposition":"attachment"}] The order of the key/value pairs is not important.
l Debug settings: 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. l Log email messages: Check this option to get a copy of each message in the Messages window of Workflow. You can use this to verify that the messages match the format required by the ESP.
l "Microsoft® Word® Documents To PDF Conversion" on page 605 l "PrintShop Mail" on page 608 l "PrintShop Mail" on page 608 l "HTTP Server Input" on page 601 l "SOAP Client plugin" on page 612 l "Add document" below l "Send Images to Printer" on page 610 l "Download to Printer" on page 595 l "Generic Splitter" on page 596 Add document Note: This plug-in has been moved to the Legacy group.
Task properties General tab l Documents: Select a specific PlanetPress Design document if you want all the jobs to be merged with that document (see "PlanetPress Design documents" on page 41). l Add job information to the document: Select to prompt your PReS Workflow to add the available job information elements in the header of the generated file. Note that this option is only enabled if a document was selected. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l Files Location: Enter the path and file name (without extension) of the PDF and MRDX file, or use the Browse button to select either. The PDF and MRDX file must have the exact same name apart from the extension. l Use MRDX as new data file: Ignore the PDF file and use the MRDX as a job file after this task. The PDF is discarded. If this is unchecked, the PDF and metadata are used. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Task properties General Tab 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. l File name: Enter the name under which you want the file to be saved.
Input Any data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, Job Infos and other variables are not modified by this task. Task properties General Tab l Split data file on: Use this box to choose the item on which top split the file. The options available depend on whether or not the Use emulation box is checked (see below).
Splitter will search in the ten first lines of every page. Note that the actual search region is a combination of the vertical and horizontal search regions. l Word is between columns l From and To: Enter a horizontal search region defined as starting from a given column and ending at a given column. If you enter 1 in the From box and 5 in the To box, the Generic Splitter will search for the string of characters only in the first five column (five first characters of every line selected above).
above. l Consider case: Select to force the Generic Splitter to consider a change in character casing as a word change. If this option is selected, “DAY” will be considered as different from “day”. l Trim selection: Select to force the Generic Splitter to trim empty characters at the beginning and end of the data found in the search region. If this option is not selected, “DAY” will be considered as different from “DAY”. l Where to split group l Pages: Enter exactly where to split the file.
database field contains additional characters (“day“ and “days“, for example, would be considered a match). l Value: Enter the string of characters to search for as the splitting criteria. Like the Field box, this is also a variable property box. l Consider case: Select to force the Generic Splitter to match the character casing of the string of characters entered in the Value box with the characters found in the file.
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.
Caution: It is highly recommended to make all processes using the HTTP Server Input task self-replicating and to reduce their polling interval in the "Process properties" on page 721. 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.
If the Send Immediate Response to client option is selected, the response file is sent back right away and the involvement of the input task ends then. However, if this option is not checked, it means there is a second output that comes out of the HTTP Server Input task: The last output generated by PReS Workflow is sent back to the initial input, which is returned back to the client (see "Request/process/response cycle" on page 224).
l Use custom HTTP server response code: When the process ends and a response is sent to the requesting client, a custom response code can be specified depending on how the process goes. While in previous versions the "200 OK" code was always used, this option overrides it to, for example, "404 Not Found" or "401 Unauthorized". Note: The response code must start with 3 digits, followed by a space and then the error message.
Job Information definitions l %1 - Client IP Address: Contains the IP address of the HTTP client requesting a response. l %2 - Request Header: Contains the headers of the request, which can contain information such as the Browser and Operating System, languages, etc. l %3 - Filename: Contains the local file name of the job file created by this task (and XML file). This is equivalent to %o.
l The task uses a printer queue set with the “PReS Word to PDF Printer” driver, which is created and set by default on-the-fly the first time a Microsoft® Word® Documents to PDF Conversion action task is run. This printer cannot be shared on the network in order to avoid confusion from network users, however it is shared between all Microsoft® Word® Document to PDF action tasks on the same system.
Task properties General Tab l Microsoft Word Document: Enter a Microsoft® Word® document or template, or click the browse button to navigate to the location of the document. The supported extensions are: *.doc, *.docx, *.dot and *.dotx. l Perform Mail Merge: Check when providing a Microsoft® Word® document or template configured for mail merge. l Use settings specified in document: Selected to instruct the task to use the connection string and SQL statements stored in the DOC file.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. PrintShop Mail Note: These plug-ins have been moved to the Legacy group. Once you have imported PrintShop Mail documents to your PReS Workflow workstation (see "Importing PrintShop Mail documents" on page 46), you can use PrintShop Mail action tasks to output the job file with a selected PrintShop Mail document.
option does a cursory verification of the job and will generate an XML file that contains a list of all warnings and errors. Task properties PSMail Tab l File name: Select a specific PrintShop Mail document if you want all the jobs to be printed with that document. l Output type group l Output type: Select the type of output you want the task to generate. l Select PDF to generate a PDF file.
PrintShop Mail User Guide. This option is only available when Direct to printer is selected in the Output type box. 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. l User generated file as output: The output from the plugin will be the file generated by the merging (depending on the output type selected).
Input Any image file that you wish to upload to the printer. Processing The currently active image data file converted to PostScript. The image's resolution, scan orientation, and quality can be modified, depending on the selected option. All files are converted into PostScript format for storage on the printer. If a virtual drive, the file is automatically sent to it. Output A PostScript file containing the necessary code to save the data file on the hard drive.
l Send to Virtual Drive of: Select the computers and / or printers to which the images are to be sent. l Refresh: Click to prompt PReS Workflow to look again for available printers and computers. l Hard disk name and path: You may enter the name and path of the hard disk to which you want to send the images. Needless to say that this option is used if the device to which you are sending the images has multiple hard drives.
In the case of "string" type data, SOAP Client plugin tasks normalize all line endings to a single line feed character. 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.
l Name: Displays the name of the arguments associated with the selected method. Note that you may also manually enter new arguments, change or delete existing ones, as well as change their order if needed. l Type: Displays the argument type. l Value: Lets you enter fixed or variable values. To exchange variable information between the Web service and PReS Workflow, you must use job information variables %1 to %9 or variable %c (which contains the entire job file).
l The Windows print file is first converted into an XML file in which each printable character appears with its horizontal and vertical coordinates. l The XML file is then converted into a standard Line Printer file. Note: Although it is more common to perform both phases in a single pass, each phase can be performed selectively, as required. Input A print job in EMF format, generally captured from a WinQueue input task.
adjusted value 0.60. Therefore those two text passages are recognized as not belonging together. l Word distance: Indicates the largest acceptable distance between two text passages, so that they are still recognized as belonging together. This the factor the 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).
l Windows Print Converter: Select this option if the task is to generate a Line Printer file. This will prompt the task to perform the second phase of the process, and thus convert the XML file to a Line Printer file. If this option is not selected, the output file will thus be an XML file. The settings included in this group determine the format settings of the generated Line Printer file. l Character per inch (CPI): The number of individual characters per inch on a line of text.
Input A data file in PGC or PDF format that is accompanied by valid Metadata. This Metadata must contain Capture information and is generally available after a "Capture-Fields processor" on page 624 or "Capture-Find document" on page 629 task. However, it is also possible to directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and Metadata are completely ignored by this task's condition rules, and the database information is used instead.
l Document is partial: Condition will be true if the document is still open but only part of the appropriate Capture Fields are filled. l Document is empty: Condition will be true if the document is open but no Capture Field is filled. l Document is on error: Condition will be true if a logical error was triggered while processing the PGC. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc.
l Pidget setting: Triggered by specific pidget settings. l Every pidget setting (such as stroke color and stroke thickness) is listed here. If the specific pidget was triggered before ink was applied to the Capture Field, the conditions becomes true. l Start timestamp: Triggered when the first ink is applied in the field. l Before: If the first stroke found in the Capture Field was made earlier than the specified date and time, the condition becomes true.
l ICR Resemblance: Triggered then the resemblance percentage the ICR engine gave to the ICR value in relation to its recognition database compares with the value determined in the "Resemblance" box, using the chosen comparison operator. For more information on ICR, see PlanetPress Capture ICR. l button: Add a new field and action line. l button: Remove the currently selected line.
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.
Task properties Pattern Generator action task properties are as follows: l Capture Document: Choose the PlanetPress Design capture ready document that will be used to generate the output including the capture fields. l Document Title: Enter a name for the document that will be saved inside the PlanetPress Capture Database. This name should be unique and recognizable and will be used later to retrieve the document form using the Get Capture Document action task.
"Anoto" and the Anoto logotype are trademarks owned by Anoto AB. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011. Capture-Fields processor Note: This plug-in has been moved to the Legacy group.
accept re-writing receives more ink, the task will still complete. The inks that are relevant to logical errors are still added to the PDF document, but they are added on a separate "error" layer. 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.
Task properties Capture Fields Processor action task properties are as follows: 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. l Pattern sequence group l Type: Specify from where the Pattern Sequence should be taken. l None: Do not use a Pattern Sequence. l Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database.
l At the Document node, timestamp information such as ink start/end time l At the Page node, information about each Capture Field such as its name, dimensions, style, index, mask, timestamp and content status. Note: When the Ignore out of bounds ink data option is checked, this option modifies the way that the On Error tab reacts. When a single split is processed and generates an error, only that split triggers the On Error tab. The other splits continue processing as usual.
Output One or more PGC file, separated as described above. Task properties General tab l Pattern sequence group: Determines what Pattern Sequence will be assigned to each PGC file. l Type: Specify from where the Pattern Sequence should be taken. l None: Do not use a Pattern Sequence. l Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database. l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection.
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.
l Capture Post Processing Workflow l Capture Web Manager Workflow Input Because this task in an Input task, it does not use the current job file in your process, even when used as a secondary input task. Processing This task connects to the Capture database and looks up all available documents that meet the criteria specified in the plugin. Then it does further processing to retrieve relevant information about each document and places the information in the data file it generates.
l Date Closed: The date, in YYYY-MM-DD format, when the document was closed by the Capture Field Processor or Get Capture Document tasks. This field is empty in documents that are still open. l Pen user (by description): The description of the pen, as entered in the "PlanetPress Capture Pen Management Tool" on page 650. Generally, this is the name of the owner of the pen.
l Does not contain: Exclusive string comparison, documents where the specified value is not present within the chosen filter are included. l Before: Date comparison, documents of which the date is previous to the specified value are included (Date Generated and Date Closed filters only). l After: Date comparison, documents of which the date is closer than the specified value are included (Date Generated and Date Closed filters only).
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.
l ICR_[FieldName]_Cfd : The confidence value (in percentage) of the engine for the value provided. Task properties General Tab l Document Origin group: l Document to process: Determines where the document information is read l From Metadata: Select to use the current document available in the Metadata generated by the Capture Field Processor. l From Specific ID: Select to specify an exact Document ID from the database.
Note: When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False. This task is put into effect in the following use cases and example processes: l PlanetPress Capture Workflow Input A PGC file received from an Anoto digital pen.
l Cutting an input or output task will replace it with an Unknown task. See "Cutting, copying and pasting tasks and branches" on page 737. l Creating a new branch will create an Unknown output task in that branch. See "Adding tasks" on page 287. l Using Branch From Here... will create an Unknown output task below that branch. See "Adding tasks" on page 287.
l Plug-in: l "General and logging preferences" on page 654 l "Messenger plugin preferences" on page 656 l "HTTP Server Input plugin preferences 1" on page 656 l "HTTP Server Input plugin preferences 2" on page 660 l "LPD Input plugin preferences" on page 661 l "NodeJS Server Input plugin preferences 1" on page 662 l "NodeJS Server Input plugin preferences 2" on page 664 l "NodeJS Server Input plugin preferences 3" on page 664 l "Serial Input plugin preferences" on page 666 l "SMTP Input
Colors l Variable properties: Select a color for the labels identifying variable property boxes. l Debug: Select the color applied to the PReS Workflow Process area background when in debug mode. l Highlighted tasks and branches: Select the background color for highlighted tasks and branches in the Process Area’s invisible grid. l Disabled tasks and branches: Select the background color for disabled tasks and branches in the Process Area’s invisible grid.
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. Options l Line Style: Select the style (dotted or solid) of the line that connects the different objects in the Configuration Components pane.
l Default output task for conditions/branches: Select an output task to use as the default output task when you add a new branch or condition. Click the Configure button located to the right of this box to set the properties of the selected output task. l Open the current configuration on startup: When this option is selected the Workflow Configuration tool automatically starts with the configuration that was last sent to the server. Otherwise no configuration will be opened at the start.
Preferences l User mismatch: Select to have PReS Workflow display a prompt when a different user opens the application. l Task deletion: Select to prompt for confirmation when deleting a task. l Document deletion: Select to have PReS Workflow prompt for confirmation when deleting a document.
l No registry: Select to have PReS Workflow notify you if it cannot find an install location in the registry. In such cases, the path of the currently running software executable is used as the install path. l PReS Watch 3 documents and job commands transfer: Select to have PReS Workflow display a prompt when you import a configuration from PReS Watch 3 that allows you to transfer documents and job commands.
l Prompt on Form Refresh: Select to have PReS Workflow prompt for confirmation when recompiling the PostScript (PSx) version of a PReS Connect Document. Refreshing PReS Connect Documents that are currently in use can lead to unexpected results. l Prompt on Saving with Unknown Task: Select to have PReS Workflow prompt for confirmation when saving a configuration file or sending the configuration to the PReS Watch service, when any process contains "Unknown tasks" on page 635.
Preferences l NetWare Login: Check to enable the options PReS Workflow requires to access NetWare resources. When you select this option, you must enter values in the Username and Password fields, and in the NDS options group (these properties are optional) below to properly log in to NetWare. l Username: Enter your NetWare user name. This is the user the PReS Workflow service uses to log in to NetWare at run-time. The service accesses resources as configured for this user.
The available PlanetPress Capture user options are: l Mode: Choose between Server and Client mode. Client and Server mode are used for multiserver 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 Status: Displays the status of the database.
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. PlanetPress Document Manager The PlanetPress Capture Document Manager dialog is used to manage all the documents present in the PlanetPress Capture database that are currently open.
l Less than or equal to: If the mask and database information are both numbers, the mask will either be smaller or equal to the database information. l Greater than or equal to: If the mask and database information are both numbers, the mask will either be larger or equal to the database information. l Contains: The mask is contained within the database information, at any location within the information. l Does not contain: The mask is not contained within the database information.
Settings l Name: Click to displays and choose from a drop-down of each DSN (Data Source Name) available on the system, along with it's source (User DSN or System DSN) and the driver it uses (database type). 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. l user name: If the database is secured with a user name and password, enter the user name here.
l All databases l User Rights: During normal operation, Read/Write to tables should be sufficient. However, during the initial setup, the Create/Drop tables rights is necessary. l Minimum 100MB of database size is required as a minimum, but the space requirement depends on the implementation. The more active documents in the database, the more space is used - note that this progression is rather linear.
l In the event where 2 requests are made simultaneously on the same record, SQL Server will drop the most complex request. Resubmitting the PGC for processing should resolve this issue. This, however, should happen only rarely. l When configuring the ODBC connection, your must use the Microsoft version of the driver, and not the Native SQL version of the driver. This is due to a technical limitation of the native driver that interferes with the PReS Suite database requests.
l Search in column Pen ID: Enter a search term for a Pen ID, then click the Search button. The Pen Data List will highlight any pen containing your search term. To register a new pen manually 1. Click on the icon 2. Enter the Pen ID (located on the pen after the word "Serial: ") 3. If necessary, enter an optional pattern sequence and User ID (identifier of who will use the pen). To register a pen using the registration pattern 1.
If no pen pack is available, PlanetPress Capture functions in Demo Mode. In Demo mode, only one (1) pen can be registered in the pen management window. Also, the "Capture-Fields generator" on page 621 will be unable to produce more than 8 documents with a pattern instead of the full 20,000 patterns. 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.
l 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. l Timeout in seconds: Set the timeout period in seconds. l Protocol: Set the protocol (HTTP/HTTPS) used to communicate with the Connect Server.
When this value is at 1, a very large space or overlap will be accepted. This may case "false positives" and separate words and text blocks may be considered as a single word if the value is too high. Accepted values range from 0 to 1. The default value is 0.3, recommended values are between 0.05 and 0.30. Delta Height Defines the tolerance for the height and position difference between two target fragments.
Changing the plugin preferences also affects the logs displayed in the PReS Workflow Service Console. Note: Each individual process has the option to produce 'minimal logs' (see "Process properties" on page 721). This means 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. l Log level group l Startup and shutdown: Select to only track when the PReS Workflow service is started and stopped.
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 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.
using HTTPS connections) the port can be set to 0. Note that it is possible to use both the NodeJS Server and the standard HTTP Server simultaneously, provided that they are not set to listen to the same port. See "NodeJS Server Input plugin preferences 1" on page 662. l Time out: Set the timeout period in seconds. The default value is 120 seconds. l Enable server for SSL requests: Check this option to enable secure data exchange over the Web.
certificate, "https" appears in the URL. For more information on SSL and how to purchase a certificate, see for example Q10694 on SSL.com. l Disable SOAP Server: Check to disable all SOAP Server functionality. l Verbose log: Select to enable to keep a verbose log. Note that a communication log is generated whether or not this option is selected. If you use a secure connection, the log will contain extra information. l PHP Arrays: This option defines how incoming POST requests with arrays are processed.
Incoming HTML PAGE 660
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.
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. l Form Data Encoding: Specifies how form data, which was sent to the web server, should be interpreted.
by PReS Workflow via LPD. Since these messages can accumulate, you have the option of not logging them. Log files are kept in the Log folder, which is located in the PReS Workflow installation folder. They are named lpddate.log, where date is the current date in the yyyymmdd numerical format. Note that changing this option also affects the log displayed in the PReS Workflow Service Console.
simultaneously, provided that they are not set to listen to the same port. See "HTTP Server Input plugin preferences 1" on page 656. l Time out: Set the timeout period in seconds. The default value is 120 seconds. l Enable server for HTTPS requests: Check this option to accept secured, encrypted requests from web clients. The encryption protocol is TLS. l Forward all HTTP traffic to HTTPS: When the server is enabled for HTTPS requests it doesn't listen on the port specified for HTTP anymore.
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 Enable authentication: Check to enable authentication for ActiveDirectory via LDAP. Any process that starts with a NodeJS input task will then require the user to authenticate before it can run. Until the user has been successfully authenticated, the Workflow process is never triggered. After a certain number of failed attempts, the NodeJS server will lock out the user for a certain length of time, to discourage denial of service attacks.
Setting the duration of the authentication When a user has logged in, that user's authentication is valid for the duration of the session. There is no option in the Workflow Preferences that allows you to set a different behavior for the duration of the authentication. However, you can manually edit the file named: C:\Program Files (x86)\Objectif Lune\ppnode\src\constants\default.js. Look for the line exports.
mark the beginning of the byte, but the stop bit can be a single 1, or two bits each with a value of 1. l Time-out: Set the time in seconds the PReS Workflow process waits for the transfer of bytes in the data file before ending the transfer of this file. On a time-out, partially received data files are not passed to the rest of the process; the Serial input resets, ready to receive further data files.
l Key: Enter the absolute path to the Private Key file. This file generally has a .key extension. l 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. l Minimum encryption level: Choose the minimum cryptographic protocol (SSL 2.3, TSL 1.0, 1.1 or 1.2). This is determined by the software that generated the keys.
Preferences l Delete log after: Enter the number of days after which to delete the PReS Fax service log. Each log covers a 24-hour period and is kept in the Log folder, which is located in the PReS Workflow installation folder (on the computer that actually performs the PReS Fax output tasks). l Fax service: Select the faxing program to which PReS Fax sends its documents for faxing.
Report folder only after all fax transmissions in a PReS Fax job are completed or have exceeded the maximum number of retries. This folder can then be used as an input for a PReS Workflow process for monitoring the status of PReS Fax jobs. The postscript (PS) file for the job is also copied with the report file and can be printed, sent by e-mail, or archived as specified by the PReS Workflow process.
l Dialing options button: Click to set the appropriate options as required. Since these options are specific to the faxing program, refer to the faxing program’s documentation for more information. OpenText RightFax options l RightFax Printer: Select a RightFax printer. A RightFax printer is a fax driver that makes it possible to send faxes automatically. This printer will output faxes without prompting the user for fax addressing information.
l Back up job on error: Select to move the job file to a local folder ftpPut\error if an error occurs while sending a job via the FTP output. This folder is relative to your install folder. l FTP Port: Select the port number that you want PReS Workflow to use for all FTP output tasks. The recommended port is 21 (the default setting).
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 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 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 Password: Enter the password required to access the database. l Test Connection: Click to verify that PReSImage can connect to the specified database.
l Account name: Enter the account name of the user on the server to be able to send emails via SMTP. You must select Server requires authentication to enable this field. l Password: Enter the password corresponding to the Account name of the user on the server to be able to send email via SMTP. You must select Server requires authentication to enable this field.
l LPR settings group l Time-out: Set the time in seconds the PReS Workflow process waits when it sends jobs using the LPR protocol. The default value for the Time-out property is 7200 seconds (2 hours). On a time-out, partially sent data files are not passed to the rest of the process; the LPR output resets and is ready to send further data files. Log messages include the timeout duration.
enter overwrites existing text. You can also press INSERT to toggle between the two modes. l Use tab character: Select to use the tab character instead of spaces to represent tabs in the program file. Clear to use spaces to represent tabs. You must clear the Smart tab option to use this option. l Smart tab: Select to use smart tabs. A smart tab advances with reference to the preceding line.
you can also use the arrow keys to move within the code without affecting the selected code. You must select the Enable selection option to use the Persistent blocks option. l Overwrite blocks: Select to have any text you enter immediately after selecting a block of code replace that block of code. You must clear Persistent blocks and select Enable selection for this option to have an effect. l Enable selection: Select to permit the creation of selections in the Code area.
l Display l Display Options Group l Editor font: Use to select the font the Editor uses to display the program code. Select the Use monospace fonts only option to restrict the fonts available to fixed width fonts. A preview of the selected font, at the selected Size, appears in the Sample box. l Size: Use to select the font size the Editor uses to display the program code. A preview of the selected font, at the selected size, appears in the Sample box.
the Gutter option. If you clear both this and the Line numbers on gutter option, no line numbers appear alongside the lines of code. l Color l Mapping: Select a mapping for the content of the script in the script editor—the mapping is used as well when the script appears in the text box of the Run Script Actions Properties dialog. Each mapping (Default, Classic, Ocean, Twilight) includes pre-set color values and attributes for each script element as listed in the Elements list box.
l "Configuration Components pane" on page 689. l The dockable panels including "The Plug-in Bar" on page 734, " The Object Inspector pane" on page 733 and "The Debug Information pane" on page 731. l " The Message Area Pane" on page 732. l The status bar. This displays your current software version and status of the PReS Service. You can customize the appearance of the PReS Workflow Configuration programs to your needs. See "Customizing the Workspace" below.
Note: Since the Process area must remain in the main PReS Workflow Tools Configuration Program window, it cannot be combined and attached in this fashion. Dock and undock areas of the Program Window The Configuration Components pane, the Object Inspector, and the Messages area can be displayed in windows that are attached to the Program window (docked position) or that float above it (undocked position).
l Double-click either a title bar (separate or attached areas) or a tab (combined areas) displaying the name of the Configuration Components pane, the Object Inspector or the Messages area. The area will jump from an undocked to a docked position and vice-versa. 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.
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.
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. l Double-click the tab of the area you want to take out of the combined area. The area will jump outside of 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. l To maximize a horizontally attached area, click the left pointing arrow on its title bar. l To restore a horizontally attached area, click the right pointing arrow on its title bar.
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 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.
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. Click the PReS Workflow button, then click Select Language. The Select Language dialog box appears.
l Save As: Saves the current configuration under a new name. It does not overwrite any existing configuration file, unless an existing file is selected and overwritten manually by the user. l Import: l Configuration Components: Displays the Import Processes dialog, letting you import processes and other components from other existing configuration files. See "Importing processes" on page 108.
choices: l Insert Process: Inserts a new process with a default input and output task. l Insert Startup Process: Inserts a new process as a Startup Process (see "About processes and subprocesses" on page 104). l Insert Self Replicating Process: Inserts a regular process that is set to be self-replicating. l Insert Local Variable: Inserts a new local variable (see: "Local variables" on page 242). l Cut, Copy, Paste: Controls the clipboard. l Delete: Deletes the process from the configuration.
l Delete: Deletes the global variable from the configuration. l Rename: Renames the global variable. l Reset: Resets the global variable to its default value. Useful if one of your process is modifying the global variable's value and you want to return it to its original default value. l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the properties, which lets you set a default value for the global variable.
l Delete: Deletes the document from the configuration, as well as the Workflow Tools Working Folders. l Refresh: Regenerates a PostScript Cache from the original document's PTK file. l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the properties, which lets you see the form information and select its default printing behaviors. l Printer Queues: Displays a list of printer queues in your configuration (see: "PReS Workflow printer queues" on page 93).
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. They are also set using PReS Workflow Configuration program and are retained when documents are assigned to printer queues.
l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to the component that generates fax documents. Some PlanetPress Design features, such as the Time and Date PReS Talk functions, require that this option be selected. l Document location group (enabled only when using Printer-Centric mode) l PReS Workflow-based: Select if the PlanetPress Design document is in PReS Workflow.
Mouse cursor As you drag a configuration component, your mouse cursor will change to indicate the action you are performing, as well as whether the location where the cursor is can accept the configuration component you are dragging. If you try to drag a configuration component in a location that is not accepted, the cursor changes to a "prohibited" icon. If you are moving a configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box.
Using the clipboard buttons l Click on the component you want to move. l Go to the Home tab of the ribbon. l Click the Cut button in the Clipboard group. l Click on the new location where you want the component. l Click the Paste button in the Clipboard group. 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.
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.
l Move to the top to move the item to the top of the category or group. If the item is already the top object in the category or group, this command has no effect. l Move to the bottom to move the item to the bottom of the category or group. If the item is already the bottom object in the category or group, this command has no effect.
Objects are added to an existing group via drag-and-drop. The objects are added as the last objects in the group. Ungrouping objects To remove a group in the Configuration Components pane, but keep its contents: l Select the group and choose View > Ungroup. l Right-click on the group and select Ungroup from the contextual menu. l Select the group and press CTRL+U. The contents of the group will move one level up.
notification. To enable a notification again, go to Preferences > Behavior > Notification Messages 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.
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 127.0.0.1: The local computer.
3. Restart the Messenger service. Caution: The following considerations are to be understood when using the Access Manager to configure IP limitations: 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.
l 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. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each user name entered in this dialog can have access to one or more processes.
l Administrator: Choose the permission type l User: Can access none, some, or all of the processes, selected individually in the Permissions section. l Admin: Has access to all processes and features. When this option is selected, the Permissions section is grayed out an all options are selected in it. l Disabled: Has access to nothing. The result is the same as not having this user defined at all, but has the advantage that a disabled user can be reactivated with a simple click. 3.
127.0.0.1 127.0.0.1 127.0.0.1 255.255.255.255 127.0.0.1 255.255.255.255 127.0.0.1 As you can see, the format looks different than how it is displayed visually in the Access Manager. However, the same rule applies in that it is read from top to bottom in the order that the file is saved here.
To display the Activate a Printer dialog, click the Printer Activation button from the Help menu. The printer list displays the following information l License Number: Reference number of the activation, linked to your customer account. l Magic Number: The magic number generated by the printer. If the magic number is incorrect, your jobs will output with a watermark on that printer. l Activation Code: The activation code generated by your license number and magic number.
Advanced SQL Statement dialog box. The alternate syntax may be required for some database types. l Client-side Cursor: When this option is enabled, the complete result set is downloaded before processing starts, and changing records is done by PReS. This is generally faster for queries returning a small number of results ; otherwise the start of the record processing can be delayed since the whole record set must be downloaded. Note: MySQL, using ODBC 5.0, must be set to use a client-side cursor.
l l ID is a unique number that identifies a key set in the Data repository. 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. l Key section l 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.
l 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. l Show/Hide System Keys: Click to show or hide the ID, DateC (creation date) and DateM (modification date) keys. The creation date and modification date fields both contain a full time stamp in the form of YYYY-MM-DDThh:mm:ss.sZ, where l YYYY = four-digit year l MM = two-digit month (01=January, etc.
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 Press CTRL+N to add a new key within the selected group. l Press Ctrl+G to add a new group. l Press Insert to add a key set. The Add Key Set dialog will appear, allowing you to create a new key set.
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 596) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks.
Channel Skip and User-Defined emulations will display the default options (see "About data emulation" on page 54) and a grid-like display of each character on each line. The following emulations however, will be slightly different. Database Emulation The Database emulation exchanges the Browse button button for the Database Emulation Configuration , which displays the Database Emulation Configuration (see "Database emulation" on page 59).
PlanetPress Design documents (unlike Connect Designer templates) are built to contain Metadata. PlanetPress Design users may therefore generate a Metadata file for their active sample data file, using a PlanetPress Design document: click the Create meta data file button. The Generated PressTalk Expression shows the expression to retrieve the currently selected attribute or field. Metadata are retrieved with the GetMeta() function (see "Metadata selections" on page 52).
Content and appearance of the Data Pane To adjust the content and appearance of the Data pane for all emulations except XML and PDF: 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 View size: Use to adjust the size of each cell in the Data Pane, and the amount of visible data that is visible. l Show used cells: Select this to display in green all cells that contain data.
Workflow to apply the option, or use the spin buttons to adjust the value. This option is not available in database emulation. l Show selected cells: Select this to display in gray all cells that your document currently references. l Highlight data: Select to have the Data Selector highlight only those cells (or fields) that contain data from the sample data file.
l Script: Select the system-level encoding table you want to use for the font selected in the Font box. The encoding tables available here are those available on the system on which you are running PReS Workflow, and are distinct from those available when you create a style. While you can edit the encoding table a style uses, you cannot edit the system-level encoding table.
About Laserfiche Laserfiche is a provider of digital document and record management systems. Laserfiche has two components: the Laserfiche server, which hosts the repository, and the Laserfiche client, which serves as the user’s interface with the repository. For more information see the Laserfiche website: https://www.laserfiche.com/. Configuring a template l Template: Select from a list of templates imported from Laserfiche. l Fields: Set to configure the fields on a by-template basis.
l Data: This type is unsupported by the Laserfiche Repository Output task and the Laserfiche client. Note: Character, List, Integer, Long integer, Number and Date types allow you to use PReS Workflow archive fields (PDI). Also, note that all fields are validated by the Laserfiche Repository Output task. PDF Viewer The PDF Viewer, introduced in PlanetPress Tools 7.3 in some areas and expanded for use throughout the configuration tool, displays any PDF used in the configuration or process.
Printer utilities Printer Utilities are options for customers using "PlanetPress Design documents" on page 41. These commands were made for PostScript printers, so the printer on which they are used needs to be able to interpret PostScript. To get to these options, open the Tools ribbon and click Printer Utilities. Set Printer’s Advanced Options This allows to set some of the PostScript printer’s options from Workflow. l Printer Password: If the printer requires a password, enter it here.
%FLASH% In Flash memory. For example: %flash%tax_bill deletes the document or file “tax_bill” from the flash memory of the printer. On a printer that has either only Flash memory or only a single hard disk. 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.
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. You can also double-click on the process to show its options. Note: Subprocesses do not have the General tab which is only used for scheduling, but they do have the Information tab. Options General tab l Active: Select to make the process active.
l Day(s) to keep backup: Indicate the number of days to keep backups of jobs processed by input tasks. Note that backups will only be kept for those input tasks that have the Keep backup file option selected and that they are required to resubmit input files. 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.
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. To activate the Time Grid, the "As soon as possible" option must be unchecked. In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not poll.
l To select the entire grid, use the Select All button located below the grid. To deselect the entire grid, use the Clear All button located below the grid. Caution: "Toggle" means turn on when it's off and vice versa, when selecting multiple blocks in one command. This means if you select a certain number of blocks in the Time Grid and then use the shift+click or drag method, blocks that are on will turn off.
l "Metadata Sequencer" on page 476 l "Input from SharePoint" on page 581 Conditions are expressed using the following syntax: The and options represent the values for comparison. The interface displays clickable links as the following: l First link: click to set the first expression. l Second link: click to choose the operator from a popup menu. l Third link: click to set the second expression.
When you click a link to set an expression, an input field appears below that link. Right-clicking this field opens a popup menu that gives access to variables, the Data Selector (see "Data selections" on page 48) and the Data Repository Manager (see "Data Repository Manager" on page 707). Wildcard parameter Expressions may contain metadata/data selection functions (see "Data selections" on page 48).
Example As an example, consider the following conditional expression, where A, B, C and D are conditions of the form : A and (B or C) and D Such a conditional expression can be expressed by means of sub conditions in the following way: 1. Define condition A. 2. Select condition A and choose Add Condition. Specify the logical operator AND. 3. Define condition B. 4. Select condition B and choose Add Sub Condition.
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.
Log viewer settings The log viewer for the current day is normally live, meaning it updates automatically as the log file is updated by the appropriate service. There are a few options to change this behavior, which could be useful when a service is under heavy load. These options are found in the View menu: l Update speed: Refreshes the view based on a timer. l Pause monitoring: Pauses or resumes the update. To refresh the log viewer, press F5 or select File > Reload.
1. In the File menu, click on Open. 2. Browse to the location of the log file you want to open 3. Click on the log file and click Open. The log file is added, by name, at the end of the list of PReS Workflow services. Clicking on it opens the log file in the viewer. Right-clicking on the file brings a menu from which the log file can be refreshed, or removed from the list. The log viewer for existing log files does not refresh automatically since log files for older days do not generally change.
Update document The Update Document dialog lets you update PlanetPress Design documents on your printers where those documents are used in printer-centric mode. It displays the following information in the list of installed printer documents: 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 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 239). l Local Variables: Displays all the variables local to this process (see "Local variables" on page 242). l Global Variables: Displays all the variables global to this configuration (see "Local variables" on page 242). l Evaluate Expression: Lets you enter a custom expression and displays its value at run-time.
l Click any line to select it. l While a line is selected, press Delete on your keyboard or right-click on the line and select Delete to delete the line. l While a line is selected, press CTRL+X on your keyboard or right-click on the line and select Cut to place the line in the clipboard. l Press CTRL+C on your keyboard or right-click on the line and select Copy to place a copy of the line in the clipboard.
Note: When you select a group (folder), no information is displayed in the Object Inspector, because what is really selected is the group heading and not the items included in the group. 2. In the Object Inspector, click an editable property. 3. Depending on the values that can be entered for the selected property, edit the value by typing one or by selecting a new one from the drop-down list.
l Document Management; see "Document Management tasks" on page 564. l Outputs; see "Output tasks" on page 543. l Legacy; see "Legacy tasks" on page 592. 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.
4. Select the desired file type: .DLL or .PPK. 5. Select the file and click on Open. Plugins downloaded from the Resource Center will be placed in the appropriate category in the Plug-In Bar. The M-Files plugins, for example, will appear in the Document Management category. Third-party plugins appear in the Uncategorized category. Deleting a custom plugin To permanently delete a custom plugin from the Plug-In Bar, you have to manually delete the DLL file from the following location: C:\Program Files (x86)\
l "Undo a command" on page 742 l "Redo a command" on page 740 l "Highlight a task or branch" on the next page l "Collapse and expand branches and conditions" on page 741 l "Resize the rows and columns of the Process area" on page 741 l "Zoom in or out within the Process Area" on page 742 Cutting, copying and pasting tasks and branches Using cut and paste, and copy and paste, you can move as well as duplicate tasks and branches within a given process as well as between different processes and sub
l If you cut one task or branch, then cut another one, the first one is lost and replaced by the second. Remember however that you can always undo the command to retrieve it (see "Undo a command" on page 742). l Tasks and branches will always appear on top of (in other words, before) the task or branch where you paste it. The only exceptions are Input and Output tasks which can only be pasted on top of an Unknown Task.
Selecting a highlight color The default highlight color may be changed via the PReS Workflow Configuration preferences (see "Colors" on page 638). A custom highlight color can be defined per task: open the task's properties (double-click) and select or define a color under Highlight color on the Miscellaneous tab. To revert the custom highlight color to the default color, open the Miscellaneous tab again, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
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.
Note: You cannot use the Delete option to remove an input or output task, but you can right-click on them and click Cut instead. This replaces the task with an Unknown task (see "Unknown tasks" on page 635). To delete the path below a branch crossing (instead of the path to the right of the branch): l Press Shift+CTRL+Delete. l From the right-click menu, choose Edit | Delete| Delete Below the Branch.
To collapse or expand a Branch or Condition, in the Process Area: l Double-click the right corner of the line of the Branch or Condition. l Right-click the icon of the Branch or Condition or the right corner of its line, and select Collapse or Expand. l Select the icon of the Branch or Condition or the right corner of its line. Then you can either: l From the View tab in the Ribbon select Collapse or Expand.
1. Locate the button you want to add in one of the tabs of the Ribbon. 2. Right-click on the button. 3. Select Add to Quick Access toolbar. Note: The Quick Access Toolbar buttons cannot be moved or reordered. If you wish to reorder them, you will need to remove all the buttons and re-add them in the desired order. Removing buttons To remove a button from the Quick Access Toolbar: 1. Locate the button you want to remove in the Quick Access Toolbar. 2. Right-click on the button. 3.
l The Clipboard group contains the typical Windows-based editing controls: Cut, Copy, Paste, Select All, Delete. l The Processes group contains controls allowing to insert new processes of any type as well as controls to converts, activate or branches processes (see "About processes and subprocesses" on page 104).
l The Debug Messages group contains two controls to either clear or save the contents of the Messages pane. l The Tools tab includes the Managers, Services and Test Page groups. l The Managers group: l The Install PostScript Font control allows to install a PostScript font into your PReS Workflow installation. This feature is specific to PlanetPress Suite. l The Virtual Drive Manager control loads the "Virtual Drive Manager" on page 731. This feature is specific to PlanetPress Suite.
l The Help tab includes the Help, Activation and License groups. l The Help group contains the User Guide, the Reference Guide and the About controls, used to access online documentation and version information.
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.
opens the log file in the viewer. Right-clicking on the file brings a menu from which the log file can be refreshed, or removed from the list. The log viewer for existing log files does not refresh automatically since log files for older days do not generally change. The display of the sessions, processes and tasks is the same. Note: The log viewer as described here was introduced in version 7.4 of PReS Workflow.
l Eclipse Gemini Blueprint which is distributed under the terms of the Apache Software License Version 2.0. This product includes sub-components with separate copyright notices and license terms. l Eclipse Persistence Services Project (EclipseLink), Copyright © 2007, Eclipse Foundation, Inc. and its licensors. All rights reserved. This is distributed under the terms of the Eclipse Public License Version 1.0 and Eclipse Distribution License Version 1.0.
l Java XmlHttpRequest which is licensed under the terms of the GNU Lesser General Public License Version (LGPL) 2.1. The source code for this can be obtained from the following location: https://github.com/objectifluneCA/java-XmlHttpRequest l Jersey which is distributed under the terms of the Common Development and Distribution License (CDDL) Version 1.1. Information on how to obtain the source code can be found at the following location: http://repo1.maven.
l Servlet API developed by Sun as part of the Glassfish project and licensed under the terms of the Common Development and Distribution License (CDDL) Version 1.0. Information on how to download the Glassfish source (as part of Java EE platform) can be obtained from here: https://wikis.oracle.com/display/GlassFish/Java+EE+7+Maven+Coordinates l Simple Logging Facade for Java (SLF4J) Copyright © 2004-2017 QOS.ch. All rights reserved.
l Apache Commons Beanutils l Apache Commons CLI l Apache Commons Codec l Apache Commons Collections l Apache Commons DBCP l Apache Commons Digester l Apache Commons Imaging 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 X
l Liquibase l LMAX Disruptor l Objenesis l OpenCSV l OPS4J Pax Web l org.json.simple l Quartz Scheduler l Snakeyaml l SNMP4J 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.
Oracle Binary Code License Agreement for the Java SE Platform Products and Java FX. Copyright 2013, Oracle America ,Inc. All rights reserved. Use is subject to license terms. ORACLE and JAVA trademarks and all ORACLE- and JAVA-related trademarks, service marks, logos and other brand designations are trademarks or registered trademarks of Oracle in the U.S. and other countries. Use of the Commercial Features for any commercial or production purpose requires a separate license from Oracle.
