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 PlanetPress Workflow 2022.
Basics Related tools and resource files Features About Workflow Configurations 32 32 33 33 Creating a new configuration 34 Open a PlanetPress Workflow configuration file 35 Saving and sending a Workflow Configuration 35 Exit PlanetPress Workflow Configuration program 37 Workflow Configuration resource files 38 Connect resources 38 PlanetPress Design documents 42 PrintShop Mail documents 46 About data 46 About documents and variable data 47 Job file 47 Job file names and output file
Triggers 103 Objectif Lune Printer Driver (PS) 103 About processes and subprocesses 105 Processes 105 Startup processes 107 Subprocesses 107 Creating a process 107 Importing processes 109 Activating or deactivating a process 110 Process properties 111 About branches and conditions 115 Converting a branch to a subprocess 116 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 PlanetPress 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 PlanetPress 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 Inp
WinQueue Input Action tasks 349 351 Add/Remove Text 352 Advanced Search and Replace 354 Barcode Scan 357 Change Emulation 361 Create PDF 365 Database Query 369 Decompress File(s) 374 Digital Action 375 External Program 384 Load External File 386 Logger 387 Mathematical Operations 388 Open XSLT 389 PDF/A-3 Attachments 390 Push to Repository 393 Rename 395 Run Script 395 Search and Replace 397 Send to Folder 399 Set Job Infos and Variables 400 SOAP Client plugin 40
Text Condition 433 Time of Day Condition 434 Connector tasks 435 Available Connector tasks 435 Delete Capture OnTheGo Document 436 Input from SharePoint 437 Laserfiche Repository Output 439 Lookup in Microsoft® Excel® Documents 442 Output to Capture OnTheGo 444 Output to SharePoint 448 PlanetPress Fax 450 PlanetPress Image 452 PReS Print Controls 460 ZUGFeRD plugin 463 Metadata tasks 469 Create Metadata 469 Embed/Extract PlanetPress Workflow Metadata 471 Metadata Fields Man
Merge Jobs 532 PDF to Bitmap 533 Render Email Content 535 Retrieve Items 538 Set Properties 542 Update Data Records 544 Output tasks 545 Available Output tasks 546 Delete 546 FTP Output 547 Microsoft 365 Email Output 548 Microsoft 365 OneDrive Output 551 SFTP Output 553 Print using a Windows driver 555 Printer Queue Output 556 Secure Email Output 559 Send Email 561 Send to Folder 564 Document Management tasks 565 DocuWare 566 M-Files 576 Input from SharePoint 583
Inactive process Object Inspector appearance preferences 640 640 Colors 640 Options 640 Configuration Components pane appearance preferences 641 Colors 641 Options 641 Default configuration behavior preferences 641 Notification Messages behavior preferences 642 Preferences Sample Data behavior preferences Preferences Network behavior preferences Preferences PlanetPress Capture preferences 643 645 645 645 646 646 The available PlanetPress Capture user options are: 647 PlanetPress
SMTP Input preferences Preferences Telnet Input plugin preferences Preferences PlanetPress Fax plugin preferences 669 669 670 670 670 Preferences 671 OpenText RightFax options 673 FTP Output Service preferences Options 673 673 PlanetPress Image preferences 674 PlanetPress Image 1 or logging tab 674 PlanetPress Image 2 or database tab 675 PlanetPress Image 3 or network tab 676 PlanetPress Image 4 or login tab 676 LPR Output preferences Options 677 677 PrintShop Web Connect Service pre
Data Selector display preferences 716 The File Viewer 719 LaserFiche Repository Output Task - Configure Tags 719 LaserFiche Repository Output Task - Configure Templates 719 PDF Viewer 721 Printer utilities 722 Process properties 724 Rule Interface 727 The PlanetPress Workflow Service Console 730 Task Properties dialog 733 Update document 734 Virtual Drive Manager 734 The Debug Information pane 734 The Message Area Pane 735 The Object Inspector pane 736 Editing properties 736
Welcome to PlanetPress 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.
l "Setting up the working environment" on page 24 l "Known Issues" on page 27 System requirements These are the recommended system requirements for PlanetPress 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: PlanetPress 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 PlanetPress Workflow End-User License Agreement (EULA) specifies that a PlanetPress 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 PlanetPress Connect, support a 64-bit operating system.
scan on 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 PlanetPress Connect Workflow: This is the main Workflow program. PlanetPress Connect Imaging: Imaging is an optional add-on and purchased separately from Connect. It is broken up into different components: l l PlanetPress Connect Image: This is the main component required to use Imaging.
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 PlanetPress Workflow (W) button, or via the key combination Ctrl+Alt+P . Network considerations While PlanetPress 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).
have access to this mapped drive while running as a service unless you log off, and then have PlanetPress Workflow Tools map the drive using a Run Script action inside a Startup Process. In addition, the use of network shared drives can cause issues when attempting to capture files from those locations since the notification process for folder changes on network shares may be different than that of local folders.
2 Windows NT 4.0 uses NetBIOS over TCP/IP for file and printer sharing, while Windows 2000, Win- dows XP, and Windows Server 2003 may be configured to use NetBIOS over TCP/IP or SMB over TCP/IP. The operating system may use additional ports. Refer to the Windows documentation for further information. 3 If the “No source port range restriction” option is checked (recommended), see footnote 1. If the option is unchecked, the local port will be chosen from a range going from 721 to 731.
In the meantime Objectif Lune would like to apologize to any customers affected by this problem and for any inconvenience caused. For more information, please contact your local support team. 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.
l The Metadata to PDI task encodes the XML using the default system encoding, not the document's. In addition, it does not discriminate between index names written in different cases (e.g. Name vs. name). 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.
behavior by opening up the Windows Task Manager and checking whether the MSIExec application is running. In order to complete the installation of MS-Word for the LocalSystem account, follow these steps: 1. Open a command-line window (CMD.exe) 2. Type "AT 10:56 /INTERACTIVE CMD.EXE" (replace 10:56 with the next upcoming minute on your system) 3. At the specified time, a new command-line window opens.
l Barcodes produced in printer-centric mode may have a slightly different aspect from those produced in Optimized PostScript mode. This is due to the different types of 3rd party libraries being used to generate the barcodes. However, all barcodes scan correctly. 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.
You could also create self-signed certificates directly with Windows PowerShell, but you would still have to use OpenSSL to extract the certificate and the corresponding key from the .pfx file that you would get from the store. Note: Keep in mind that when using a self-signed certificate, clients (e.g. browsers) might need to be told to trust it. Basics PlanetPress Workflow is a tool to automate the processing, distribution and printing of your business documents.
http://help.objectiflune.com/en/PlanetPress-connect-user-guide/2022.2/. l PlanetPress Suite users may use documents made with PlanetPRess Design. For the user guide, see http://help.objectiflune.com/en/planetpress-design-user-guide/. The product-specific files need to be sent to, or imported into, Workflow before they can be used in conjunction with a task (see "Workflow Configuration resource files" on page 38). They become visible in the "Configuration Components pane" on page 692.
Note: A PlanetPress Workflow configuration must be composed of at least one process, but it may include as many as 512. PlanetPress Workflow cannot work without a valid configuration, and a PlanetPress Workflow session running on a given computer can only use one configuration at a time. For a configuration created in the PlanetPress Workflow Configuration tool to actually be executed by PlanetPress Workflow, it must be sent to the PlanetPress Workflow Service.
new configuration. Select the Always save without prompting for confirmation option to automatically save any unsaved work. Open a PlanetPress Workflow configuration file To open a configuration file: 1. From the PlanetPress Workflow button, choose Open. The Open dialog box appears. 2. Navigate to the Workflow configuration file you want to open, select it and click Open. Or: 1. Use Windows' File Explorer to navigate to the Workflow configuration file (.OL-workflow) that you want to open. 2.
Saving a configuration Files created and edited using PlanetPress Workflow can be saved as PlanetPress Workflow configuration files anywhere on your computer or even a network location. To save the current configuration: l From the PlanetPress button, choose Save. l If you were editing the current PlanetPress Watch service configuration or if you were editing a new configuration file, you are prompted with the Save As dialog instead.
3. When the configuration is ready to be used, from the PlanetPress Workflow button, choose Send Configuration, then Send Local. Sending a Configuration to a remote server 1. Open the configuration you want to use as PlanetPress Workflow’s new configuration. 2. Edit the configuration, if required. 3. When the configuration is ready to be used, from the PlanetPress Workflow button, choose Send Configuration, then Send Remote. A list of available PlanetPress Workflow servers on the local network appears. 4.
If the default configuration does not include any active process, the PlanetPress Workflow Configuration program asks you whether to continue. If a file different from the default configuration file is currently opened, and if it includes unsaved modifications, the PlanetPress Workflow Configuration program asks you whether to save the configuration before exiting. Select the Always save without prompting for confirmation option to automatically save any unsaved work before exiting.
l Document Templates: Templates can be used in content creation tasks: "Create Email Content" on page 502, "Create Web Content" on page 518 and "Create Print Content" on page 515. l Print Presets: l Job Presets: Job Presets can be used in the "Create Job" on page 506 task to filter and rearrange print content items. l Output Presets: Output Presets contain settings for Print output. They can be used in the "Create Output" on page 508 task.
l DataMapper contains the data mapping configurations (.OL-datamapper) l JobCreation contains the Job Creation Presets (.OL-jobpreset) l OutputCreation contains the Output Creation Presets (.OL-outputpreset) l Template contains the templates (.OL-template) Note: Package files are not saved anywhere. The individual resources contained within the package are extracted and placed in the folders noted above.
l A data mapping configuration adds an "Execute Data Mapping" on page 524 task. If you agree to use the first sample file in the data mapping configuration as the process's sample data file, the process's emulation will be changed accordingly. l A Job Creation Preset creates a "Create Job" on page 506 task. l An Output Creation Preset creates a "Create Output" on page 508 task.
3. Right-click on the data file, then click Save sample data file. PlanetPress Design documents A PlanetPress Design document is a file created with the Design module of PlanetPress Suite. Design documents are used to produce an output, merged with data (i.e. the job file). They contain static data such as logos, addresses and graphic formatting, as well as placeholders for data. Documents may also contain conditions and programming logic.
PostScript fonts, use the Install PostScript Font command in the Workflow ribbon (see "The PlanetPress Workflow Ribbon" on page 746). Adding printer resident documents to the Configuration Components Pane By default, the Documents group displayed in Configuration Components pane of the PlanetPress Workflow Configuration program includes all those documents that are available on your local PlanetPress Workflow server.
Using files attached to PlanetPress Design documents Data files When sending a PlanetPress Design Document from PlanetPress Design to PlanetPress Workflow, all data files used in the document are automatically sent to PlanetPress Workflow along with the Design document. These data files appear under the document in the PPS/PSM Documents section of the Configuration Components.
Document Preview When sending a PlanetPress Design document from PlanetPress Design to PlanetPress Workflow, a PDF Preview of the job's output is automatically sent to PlanetPress Workflow along with the Design document. This preview appears under the PPS/PSM Documents section of the Configuration Components pane. The PDF contains the result of a preview with the active data file (for all data pages) run as an Optimized PostScript Stream. Viewing the Document Preview 1.
assigned to printer queues. They can be edited by selecting documents within the PPS/PSM Documents category of the Configuration Components pane, which changes the document’s default printer settings, or within the Printer Queues category, which changes the document properties on the selected queue. PrintShop Mail documents PrintShop Mail documents are documents made with PrintShop Mail (Suite, not Connect).
Note: Null characters present in the data may not be displayed properly when using the PlanetPress Workflow Configuration tool, and they may also be printed differently by different printers. To ensure consistency, you should consider filtering out such characters. About documents and variable data "Variable data" is data that is meant to be merged with a document or template.
debug PlanetPress Workflow configurations (see "Debugging your PlanetPress Workflow process" on page 89). Job file names and output file names When an Input task sends a new data file down a process, it gives it an internal file name referred to as the job file name (associated with the %f variable). The new job file typically keeps the same name until the end of the process.
generate three JPEGs or TIFFs called Invoice0, Invoice1 and Invoice2. Note that this does not apply to multiple TIFFs, which can include multiple images in a single file. Note: You can change the name of a previously named file using a Rename action task (see "Rename" on page 395). Data selections A data selection could be compared to an address.
Examples l In a PDF emulation, the format of a selected region could be: region(?,0.59375,2.21875,1.85416,2.51041,KeepCase,NoTrim) In this case “?” represents the current physical data page processed by the task. l In the following rule, the Metadata selection function loops through all datapages in a job, comparing their index in the document to a value: (GetMeta(SelectedIndexInDocument[0], 11, Job.Group[?].Document [?].
Database data selections These selections are used for database-driven data files such as Database and CSV emulations. The selection refers to a specific field on any given data page. Syntax field(record set number, child number, field name, treatment of character case, treatment of empty trailing cells) Here is a breakdown of the syntax (all options are mandatory): l field(): Always surrounds database field selections. l Record Set Number: The data page (or "record") of the data selection.
l lookup key: The name of the key in the group with which to look up the value. The return key of the KeySet in which the lookup key's value matches the lookup value will be returned. l lookup value: A string surrounded by quotes which will be used in the lookup. The lookup syntax is akin to a SQL SELECT statement and could be loosely translated to: SELECT [return key] FROM [group] WHERE [lookup key] = [lookup value]; PDF data selections These selections are used for PDF data files.
process. Open the metadata viewer and save the metadata file to use it as a metadata sample file in the Data Selector. Syntax GetMeta(Field Name [, Option Flags, Metadata Path]) Here is a breakdown of the syntax: l 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 67). l Option Flag (optional): Sets the options for the selection (see table below).
l xmlget(): Always surrounds a data selection. l Value Options: l Count: The number of elements on the same level in the same node that have the same name. l l l Name: The element's name. l Value: The element's value. Case Options: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase characters as they are. l LowerCase: Converts all characters to their lowercase equivalent. l UpperCase: Converts all characters to their uppercase equivalent.
Add/remove characters: Enter the number of characters to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add characters; negative values remove characters. This is useful when one or more characters of input data precede the start of the first data page. Note that certain control characters can be problematic.
l "Line printer emulation" on page 60 l "PDF emulation" on page 60 l "XML Emulation" on page 62 Emulations in PlanetPress Design The Data Selector in Workflow is essentially the same as the one used in PlanetPress Design. When you create a document in PlanetPress Design, you choose a sample data file and specify the emulation to use for the chosen data. Within PlanetPress Workflow, the same emulation tools as in PlanetPress Design are available throughout your process, using the Data Selector.
Using an ASCII file on a printer If an ASCII file gets sent to a printer (which is possible in a PlanetPress Suite solution), you need to know if your printer supports binary mode as this is the recommended mode for ASCII emulation. On printers that support binary mode, you can switch the printer to binary mode using the printer keypad or by sending the appropriate PostScript code to the printer.
Also note that Split on FormFeed (FF) is not supported with the Channel Skip emulation in Optimized PostScript Stream mode or when printing using a Windows driver. Note: Channel skip emulation is only used when merging line printer data with a PlanetPress Design document. CSV emulation options l Text delimiter: Enter the character that starts and ends the data in each field of the record.
CSV emulation options l Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the data is split into two fields. If you want to use a backslash character (\) as a delimiter, you must precede it with another backslash character (thus you would enter \\). You can also specify an ASCII character using its octal value preceded by a backslash (for example, \041 is
l The person or plugin performing the query must have full access to the database. l The data is extracted at the time of the query. A new query must be performed whenever the data needs to be updated. l Any changes to the structure of the database may have an impact on automated data querying tasks. l You must have the proper ODBC driver installed to use this emulation.
PDF emulation slightly differs from other emulations: with other emulations, data is read either one line at a time or one character at a time, while PDF emulation processes the input data from the PDF file in such a fashion that every PDF page becomes a full data page. Note: Protected PDF and PDF of versions above 1.7 are not supported by PlanetPress Workflow. PDF emulation options The PDF emulation does not have any options - that is, there is nothing to set up when opening a PDF data file.
l 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 while negative values remove lines. l Lines per page: Enter the number of lines each data page contains, or use the spin buttons to increment or decrement the value. A higher value means more lines will be displayed on each data page.
When XML data is merged with PlanetPress Design documents on a printer DOCTYPE and ENTITY tags are ignored. XML emulation options l Cache XML data: When this option is selected, PlanetPress Workflow Server only reloads the data if the size or modified date of the XML file changes. When this option is not selected, the XML data will be reloaded into memory every time that a plugin works on the data file.
process. The sample data file should also contain at least one of every exception you may want to detect, or data used for a specific condition. For example, if you wanted to filter out any data for clients in Canada, you would want to use a data file that has at least one client from Canada, to test whether your process filters it out correctly. To choose a sample data file: 1. Click the Debug tab in the PlanetPress Workflow Ribbon. 2. Click on Select in the Data group. 3.
4. Associate a database. l Microsoft Access Database or dBase file: In Database, enter the path of the Microsoft Access database or dBase file, or click the Browse button to the right of the box to navigate to, the database file. Recall that a Microsoft Access database file bears the extension .mdb, and a dBase file bears the extension .dbf. If the file is a dBase file, you must specify the folder that contains the .dbf file. The folder in this case is considered to be the database, while each individual .
l All: Select to include all records in the database in the sample data file. l Records: Select to define the range of records you want to include in the sample data file. Entering an SQL query 1. In the Database Connection dialog box, click Edit SQL. 2. If necessary, click Show Tables to display, in the Tables area, a list of the tables available in the database. 3. In the SQL Query Entry area, enter the SQL query. The following two sample queries both retrieve all the fields in the Orders table.
Metadata Metadata is a hierarchical structure describing a job. Simply put, Metadata is data about data or, in other words, information tagged to data. Depending on the type of job, the Metadata includes information about the job, the data file, items in the Connect database, a PlanetPress Design document, 'User defined information' (sometimes created by regular tasks) and in some cases page properties and page counts. Some of the Action and Output tasks produce, alter, or use the Metadata.
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.
they are attached to. Each element has a name and a value. Here is a definition of these 2 types of elements: l Attribute: A read-only, system-defined element which holds certain information about a certain node in the Metadata structure. This information can be static (e.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.
the filtered one. However in some cases Metadata does affect your output directly (see "How Metadata affects the output" below). l Modifying data does not immediately modify the Metadata. So, if you have a PDF file with Metadata and you use a PDF splitter, the Metadata information would still reflect the original data, not the split. This can generally be resolved by using the Create Metadata plugin (again).
l The "Create Print Content" on page 515 and "Create Email Content" on page 502 tasks have the option to update the records in the Connect database from the Metadata and use the updated records as input. Note: Date/time values are stored in the OL Connect database as Unix timestamps, i.e. the total number of seconds from the starting time of UTC (Universal Time, Coordinated) to the current time (with zero time zone offset). For instance: 1675950179.
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 ...
l The process moves back up to Task 2 in order to process the second split of the original PDF. The Metadata file still exists in the process! So far, it doesn't impact the rest of the process… but wait… l Let's say in step 3 no separator page is found on page 1 of the second split PDF. l Step 7 prints that second split PDF… but page 1 is unselected in the Metadata (because the Metadata was carried over from the last split!) so at the very least, you will be missing one page.
page) 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. When the Metadata file is viewed through "The Data Selector" on page 713, the Attributes are listed under Production information (see "Metadata tab" on page 715). The Metadata Attributes can be categorized as either Production, Finishing or Index/Count. l Production attributes describe the production of the job and/or Metadata (e.g.
Attribute Description Category Job Group Document Datapage Page Date Date the Metadata was created in ISO format. Production X X X Time Time the Metadata was created in ISO format. Production X X X Title Title of the source document. Production X X X Producer Name of the software that created the Metadata. Production X X X Creator Name of the software that created the source of the Metadata.
Attribute Description Category Job Group Document Datapage Page Weight Device-dependent weight of the media. Finishing X X X X X MediaColor Device-dependent color of the media. Finishing X X X X X MediaType Device-dependent type of the media. Finishing X X X X X X X X X X X X X X X X X X X X X Index Index/Count IndexInDocument Returns the Absolute index of the node within all the nodes under the parent Document.
Attribute NumCopies Description Indicates how many times the job is set to execute, as set when printing using a Windows driver. Category Index/Count Job Group Document Datapage Page X Working with JSON In online processes, it is common to send data to and retrieve data from a server. That data is often exchanged in JSON format. JSON is short for JavaScript Object Notation. It is a way to store information in a structured and easy-to-read format.
l a JSON Record Data List (see the REST API Cookbook). A JSON Record Data List is a proprietary JSON object type. It includes a schema entry with information about the types of all fields at the beginning of the record, and the data set with values after the schema. This structure allows for easy handling of REST API return values through scripting in Workflow or in the Designer; see "JSON Record Data List example" on the facing page.
{ "first":"xmlget('/request[1]/values[1]/first[1]',Value,KeepCase,NoTrim)", "last":"xmlget('/request[1]/values[1]/last[1]',Value,KeepCase,NoTrim)", "email":"xmlget('/request[1]/values[1]/email[1]',Value,KeepCase,NoTrim)" } A JSON string that contains nested data: { "name":"Peter Parker", "email":"parkerp@localhostcom", "ExtraData":"foobar", "detail": [{"id":"inv123","ExtraData":"hello"},{"id":"456","ExtraData":"world"}] } JSON Record Data List example A JSON Record Data List describes a list of data fields
Values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.detail[0].fields.ItemTotal; Data Repository The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes. This feature was introduced in version 8.5. The Data Repository is especially useful in situations where data needs to be kept in between processes.
Accessing the Data Repository Via plugins Storing data in the Data Repository Data can be stored in the Data Repository using the Push to Repository task (see "Push to Repository" on page 393). Retrieving data from the Data Repository In any Workflow task where variable data is allowed (recognisable by the maroon field labels), information can be retrieved from the Data Repository using a Lookup function. Right-click a field with a maroon label and select Get Repository Location.
Data Repository Manager At design-time, the Data Repository Manager may be used to insert or remove Groups, Keys and KeySets; see "Data Repository Manager" on page 710. Where to find the Data Repository In case the Repository contains valuable information that must not be lost in case of a hardware failure, create a backup of the repository. By default, the Data Repository is located in the following folder: %ProgramData%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\Repository.
Error handling, on the other hand, occurs when your configuration has been sent to PlanetPress Workflow services, and are running in "production" mode. The automated handling of errors within your processes will have a large impact on recovering from errors as they happen during production. About error handling When your process is running, or during debugging, it may happen that the task that is currently running causes an error, and the task fails.
When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration. l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. If the task is not on a branch, the entire process will be stopped. l Stop Process: The process is stopped and no more processing is done.
To create an Error process, simply replace the initial input task by the InputErrorBin Input task, and that process automatically becomes able to handle error jobs sent to it. It is up to you, however, to decide how that error job will be handled. For example, you could place the job file in a specific folder, then send an email to a supervisor indicating that a job has failed. Or you could update a database with an error status so that it appears on a customer's online order.
Variable Name %{error.errorlog} A string containing the logged error message(s) from a task. Multiple error messages are delimited by a "|" (vertical bar) character. Accessing the Logs If your process is running live in the PlanetPress Workflow Service, you have two ways of seeing what is happening now or what has happened in the past. Viewing running processes To view what processes are running and processing data as it happens: 1.
1. Open the Workflow Configuration tool and then press CTRL+SHIFT+ALT+F4 simultaneously. This macro keyboard shortcut opens the PlanetPress Workflow working folders. 2. Double-click on the folder called Log. 3. There are multiple logs displayed here, including: l ppwYYYYMMDD.log - PlanetPress Workflow logs, including the year, month and day of the log (from midnight to midnight). Note: The PlanetPress Image and PlanetPress Fax logs are available in different folders.
In the above image, the Folder Capture task is on level 1 and the Text condition is on level 4. Here's how to resubmit backed up input data files. Note: The resubmit option is triggered through the Workflow configuration tool, but the job being resubmitted is actually handled by the Workflow Service, using that service's credentials. The service must therefore be running in order to resubmit jobs. 1. In the PlanetPress Workflow Ribbon, go to the Tools tab then click Resubmit Job in the Services group.
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 PlanetPress 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 734. 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 49). 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 508 task, and the "All In One" on page 495 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 42). 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 555 Output task, or the "Printer Queue Output" on page 556 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 97. l FTP Output printer queues are typically used to send print jobs to FTP sites. See "FTP Output Printer Queue" on page 99. 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 100. 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 PlanetPress 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 96.
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 PlanetPress 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 PlanetPress printer queues One of the resources stored in a PlanetPress Workflow printer queue is the list of PlanetPress Design documents associated with it. Also stored in the printer queue are the properties of each document associated with the queue. Note that Workflow printer queues are different from normal printer queues; see "PlanetPress Workflow printer queues" on page 94.
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 695 for more details. Triggers In PlanetPress 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 PlanetPress 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 PlanetPress Workflow service. 7. Start the windows application from which you want to capture data. 8. Open your selected document. 9. Click File | Print. 10.
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 641 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 692. Special workflow types PlanetPress Workflow supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility.
l References to specific PlanetPress 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.
Note: If you try to send a configuration that contains only inactive processes, the PlanetPress Workflow Configuration program will ask you to confirm the operation (this can be changed in the Notification User Options). Process properties To have access to the properties of a process or subprocess: l Right-click on the process in the Configuration Components pane. l Select Properties. You can also double-click on the process to show its options.
Tip: Non-startup processes starting with the HTTP Server Input, NodeJS Server Input, LPD Input or SMTP Input task will run trigger-based if they are set to run As soon as possible with a Polling interval of 0. This reduces CPU usage. 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.
option overrides the polling interval option. By default since the Time Grid blocks are divided by hours, this option will make your polling happen once every hour. l Minimal logs: With this option enabled, the process will only log its Start time and the End time (along with the Time Spent), if no error was encountered during execution of the process. In case of an error, the entire process information is logged.
l To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. l To select all the days or dates for a given time segment, click the time segment on the left grid ruler. To deselect all the days or dates for a given time segment, CTRL+click the time segment on the left grid ruler.
About branches and conditions While some processes can simply start with an input task, manipulate the data with a few action tasks and finish with an output task, in some cases you may want to have more control over the flow of your process. For example, you may want multiple outputs, such as printing to multiple printers as well as generating a PDF and emailing it. To do this, you will need branches.
l "Run Script" on page 428 l "SNMP Condition" on page 431 l "Text Condition" on page 433 l "Time of Day Condition" on page 434 Adding a branch or condition The PlanetPress 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.
Using Scripts Scripts can be used to perform various operations, such as to manipulate data, for example. PlanetPress Workflow can perform scripts written in four different scripting languages and also provides an interface for editing scripts. Note: While this chapter provides some very useful and detailed information about scripting within PlanetPress Workflow, its focus is to inform you about the features, variables and functions unique to this environment.
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 PlanetPress Workflow scripting tools) are available through the scripting engine, in all languages.
You can use the Script Editor to edit scripts written in VBScript, JavaScript (JScript, Enhanced JScript), Perl, and Python. You can use the XSLT Editor to edit scripts written in XSLT 1.0 and 2.0. 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.
1. In the editor, choose File > Export. The Save As dialog box appears. 2. 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. 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.
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 forward only within the selection. When the search reaches the end of the script or script selection, the search finishes. It does not loop back to the beginning.
l Prompt on replace: Select to have PlanetPress Workflow display a prompt before it replaces text. When you use the Replace All function, you are prompted each time matching text is found. The prompt includes an All button for replacing all matching text. This suppresses any further prompting. l Global: Select to search the entire content of the script. 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.
display settings, see "Editor Options" on page 679). To go to a line in a script: 1. Click anywhere in the Script Editor, then choose Search > Go To Line, or press Alt+G. The Go To Line dialog box appears. The last used line numbers are displayed in the Enter new line 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.
While there are multiple possibilities for solutions using a SOAP server implementation, the SOAP Server API Reference is specifically for submitting jobs from a SOAP client. It implements methods that will allow SOAP clients to submit jobs and get information from PlanetPress Workflow executing them. Methods, structures Description "GetProcessList" below Allows SOAP clients to request the list of available PlanetPress Workflow processes, based on their authentication credentials.
l Message: String containing text information about the Success status. l ProcessList: Structure containing the following information details. l ProcessName: String containing the process name. l Active: Boolean value specifying whether the process is currently active. Note: To obtain access to the complete list of processes for all users, the end-user must have administrator privileges.
GetSOAPProcessList The GetSOAPProcessList function will allow users to request the list of PlanetPress Workflow processes that contain a SOAP Input plugin with the SOAP action name. This is useful when working with the SubmitJob SOAP API method since it requires a SOAPActionName. 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.
Description Parameters l File: base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64). l PostJobInfStruc: Structure containing any required information to prepare the file for resubmission into a PlanetPress Workflow process (see "PostJobInfoStruc" below). l User name: String containing the user name. l Password: String containing the password. This is case sensitive.
l FirstPage: Integer: first page of data to process. l LastPage: Integer: Last page of data to process. Note: If both FirstPage and LastPage are set to 0, the entire data file is used. SubmitJob The SubmitJob method allows a user to remotely submit files to their PlanetPress Workflow from a SOAP client. The SOAP client has the option to wait for a response file from PlanetPress Workflow SOAP server.
completion of the PlanetPress Workflow process (for instance, if the process creates a PDF and sets it as the current job file, the PDF is the file that gets returned to the calling SOAP client). Note: l The SubmitJob method only returns a file if the PlanetPress 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.
Variable Name Description Example Usage (VBScript) Calls and executes an external program in the command line. "Watch.ExecuteExternalProgram" on the facing page Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); "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.
Variable Name Description Example Usage (VBScript) "Watch.SetJobInfo" on page 144 Writes the value of a string to a numbered job info. Watch.SetJobInfo(9, "Job info 9 Value"); "Watch.SetVariable" on page 144 Writes the value of a string to a local or global variable by name. Watch.SetVariable("MyVariable", "Hello World!"); "Watch.Sleep" on page 145 Pauses all processing for X milliseconds. Watch.Sleep(1000); Watch.
Examples JavaScript Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true Python Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, True) Perl $Watch->ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); Watch.ExpandResourcePath The Watch.
Python Watch.ExpandResourcePath("invoice.OL-template"); Perl $Watch->ExpandResourcePath("invoice.OL-template"); Watch.ExpandString Provides access to the emulated job file and to all variables. This function returns a string that is the expanded version of the input string. Syntax Watch.ExpandString(StringToExpand) StringToExpand A regular parseable string that may contain system variables (%u, %f), user variables (%1 to %9), octal codes, and data selections.
Watch.Log("Current Date is: " + s, 2); VBScript Dim s s= Watch.ExpandString("%y-%m-%d") Watch.Log "Current Date is: " + s, 2 Python s= Watch.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.
Examples JavaScript Watch.GetConnectToken(); 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.
Examples JavaScript Watch.GetConnectTokenEx("localhost", 1234, "myUser", "secret"); VBScript Watch.GetConnectTokenEx "localhost", 1234, "myUser", "secret" Python Watch.GetConnectTokenEx("localhost",1234,"myUser","secret"); Perl $Watch->GetConnectTokenEx("localhost",1234,"myUser","secret"); Watch.GetJobFileName Returns the complete path and file name of the job. This method is the same as PW_GetJobFileName. getjobfilename() obtains the file name of a PlanetPress Workflow process.
Perl $s = $Watch->GetJobFileName; $Watch->Log("The job filename is: " + $s, 3); Watch.GetJobInfo Returns the job information corresponding to the specified index. Index is an integer from 1 to 9. (See also: "Job Info variables" on page 239.) Syntax Watch.GetJobInfo(Index: integer): string Example JavaScript var s; s = Watch.GetJobInfo(3); Watch.Log("Jobinfo 3's value is: " + s, 2); VBScript Dim s s = Watch.GetJobInfo(3) Watch.Log "Jobinfo 3's value is: " + s, 2 Python s = Watch.GetJobInfo(3) Watch.
Python Watch.GetMetadataFileName() Perl $Watch->GetMetadataFileName(); Watch.GetOriginalFileName Returns the original name of the file, when it was captured. This method is the same as PW_GetOriginalFileName. Example JavaScript Watch.GetOriginalFileName(); VBScript Watch.GetOriginalFileName Python Watch.GetOriginalFileName() Perl $Watch->GetOriginalFileName(); Watch.GetPreferences The Watch.
"username": "ol-admin", "mailHost": "", "mailSender": "", "mailUser": "" }, "OLWorkflow": { "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": { "por
"port": 25, "TLSEnabled": false } } } } 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.
VBScript Watch.GetResources "OL-template" Python Watch.GetResources("OL-template"); Perl $Watch->GetResources("OL-template"); Watch.GetVariable Returns the string value of the corresponding variable name. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.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.
Watch.InstallResource The Watch.InstallResource(path) method copies or unpacks a resource, such as a Connect Designer template, Data Mapping Configuration, or package file, from the supplied path to the Connect resources folder (%PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\OLConnect). If a file already exists, it will be overwritten. The original resource file, which is processed by this functionality, will not be deleted or altered in any way.
View error messages in the Services Console while PlanetPress Workflow is in Run mode by choosing Tools | Services | Service Console. In the Service Console, error messages appear with colors that correspond to the message level. Level Type Text Color in Service Console 1 Error Red 2 Warning Orange 3 Information Black 4 Debug Grey Arguments Message A string representing the message that is logged in the log file.
Perl $Watch->Log("this is a log",3); Watch.SetJobInfo Sets the job information at the specified index to a specified string value. (See also: "Job Info variables" on page 239.) Syntax Watch.SetJobInfo(Index: Integer; Value: String) Example JavaScript Watch.SetJobInfo(3, "Job info 3 Value"); VBScript Watch.SetJobInfo 3, "Job info 3 Value" Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.SetVariable Sets the variable to a specified string value.
Python Watch.SetVariable("MyVariable", "Desired value") Watch.SetVariable("global.MyVariable", "Desired value") Perl $Watch->SetVariable("MyVariable", "Desired value"); $Watch->SetVariable("global.MyVariable", "Desired value"); Watch.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.
JavaScript var everythingOK; everythingOK = true; if(everythingOK){ Script.ReturnValue = 1; } else { Script.ReturnValue = 0 } VBScript Dim everythingOK everythingOK = true if (everythingOK = true) then Script.ReturnValue = 1 else Script.ReturnValue = 0 end if Python everythingOK = True if everythingOK: Script.ReturnValue = 1 else: Script.
For a quick start, turn to this How-to: Interacting with the Data Repository API. Caution: All operations on the Repository must be performed through this API - rather than directly accessing the physical file - since the Repository's underlying file structure may change over time. This API is guaranteed to remain compatible with future versions of the Data Repository. It is used by all Workflow tasks dealing with the Repository.
enclose the entire string in single quotes. Alternatively, you can escape the double quotes inside the JSON Array. For instance, the following calls to AddGroup() are correct: repoObject.AddGroup("MyGroup",'["FirstKey", "SecondKey"]'); repoObject.AddGroup("MyGroup","[\"FirstKey\", \"SecondKey\"]"); But the following is incorrect: repoObject.AddGroup("MyGroup","['FirstKey', 'SecondKey']"); Many methods require using the JSONStringArray type but JSON is not natively supported in VB Script.
Key Methods Name Description "AddKey" on the next page Adds key KeyName to group GroupName. KeyName must not already exist in the specified group. Note that this method only adds a key name to the group, not a key value. See "AddValue" on page 152 for information on how to set a value for a key. "ListKeys" on page 156 Retrieves the list of all Key names and data types in Group GroupName, stored in a JSONStringObject. You should use JSON.Parse() to convert the string into an actual JavaScript object.
AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. Syntax AddGroup(GroupName: string, keyNames: JSONStringArray) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 147). JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.
AddKeySets Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues must exist otherwise an error is raised. However, it is not required to specify all available keys in KeyValues. Only the keys specified are updated in GroupName while unspecified keys are set to an empty string.
Sample return value The method returns a JSONIntegerArray containing the ID's of all keysets inserted into GroupName: '[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.
ClearGroupData Deletes all keysets inside GroupName while retaining the existing key structure. 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.
myKeySet = repoObject.GetKeySets("Users", "[""FirstName"",""LastName""]", "Gender='M'") Querying a single row This JavaScript example shows how to get one or more rows from the repository and use them in the process. The script gets 3 fields ("firstname", "lastname" and "email") from the CustomerID field. It assumes there's a local variable called %{CustomerID} set in the workflow process. var CustomerID = Watch.GetVariable("CustomerID"); var repoObject = new ActiveXObject("RepositoryLib.
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 var myValue = repoObject.GetValue("Users", "email", " LastName='Smith' AND FirstName='John' "); /* retrieves email for John Smith */ var myValue = repoObject.
Example 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 var repoObject = new ActiveXObject("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListGroups()); for (var i=0; i
Sample return value '{"ID": "meta", "FirstName": "string", "LastName": "string", "email": "string", "DateC": "meta", "DateM": "meta"}' As shown in the sample, the value associated with each key name is actually the data type for that key. Only two values are currently possible: string and meta, where meta denotes an internally generated key. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys.
repoObject.RemoveKey("Users", "email"); VB Script repoObject.RemoveKey "Users", "email" RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise. Note: This method is functionally equivalent to using "RemoveKeySets" below with its Condition parameter set to "ID=ID".
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.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.
repoObject.RenameGroup "Users", "Customers" RenameKey Renames key oldName to newName in group GroupName. While this operation has no impact on the data stored in that Group, it does require any plugin and/or script that uses oldName to be modified to 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.
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=''" ); VB Script repoObject.SetValue "Users", "FormOfAddress", "Mr.", " Gender=""M"" " repoObject.SetValue "Users", "FormOfAddress", "Ms.", " Gender=""F"" AND Mar- italStatus=""Married"" " repoObject.
/* both methods perform the same task */ repoObject.SetValueByID "Users", "FormOfAddress", "Mr.", repoObject.SetValue "Users", "FormOfAddress", "Mr.", 10 "ID=10" Updating a row There is currently no 'update' feature in the API for a whole KeySet. This JavaScript example retrieves the KeySet ID, which is then used to update values in the row. /* Get KeySet ID */ var repoObject = new ActiveXObject("RepositoryLib.WorkflowRepository"); var keySetID = repoObject.
All of these objects are contained in a "MetaFile" below object, and they are obtained, directly or indirectly, through methods of this object. Note: In an OL Connect job, only the first three levels in the Metadata hold information about the job: Job, Group and Document. A Group has information about a record set in the Connect database and a Document has information about one record in that set. This information appears in the Fields collection of the respective Node object.
The Metadata objects point to an underlying persistent data store. This means that if there are live references to Metadata objects and the underlying data is destroyed (e.g. a new file is 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.
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 483) 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.
ation on how to serve HTML and PDF generated by Connect through IIS, watch the Connect with Evie IIS series. Tip: Essentially the "NodeJS Server Input" on page 328 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).
l Serve HTTP resources: This is where you enable static resources in PlanetPress Workflow. When enabling this option, the HTTP server will always look in the Resource Folder for files requested inside of the Resource action name as a folder. This means that, if your Resource folder is c:\PlanetPress\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:\PlanetPress\http\css\style.css .
l The HTTP service accepts both POST and GET requests. Other than the presence of file attachments, there is little difference in how these are handled. This means that visiting /myaction?id=12345&q=test would be the same as having a form with two fields named, respectively, id and q, and submitting them with the information "12345" and "test". In 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.
9. If, during this time, the timeout has expired (if the process takes more than 120 seconds), the HTTP service returns a "timeout" to the client, but the process stills finishes on its own. When the process finishes, the return file is ignored by the HTTP service. Point 7 is critical to understand, as it has an impact on what the client receives. If a process receives a file that is split into multiple parts and each of these parts generates and output, the last split's output will be sent to the client.
l ?in=INV999999 : A GET Variable, specifying that the variable named invoicenum (invoice number) would have a value of INV999999 , or any other "valid" invoice number. 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.
Tip: Instead of creating a web page from scratch, you could create a web page from a Connect Web template; use the "Create Web Content" on page 518 task. l If, however, the file is found, then it is loaded with the "Load External File" on page 386 task, and then deleted (for the same reasons).
l The file is renamed with the .html extension, so that both the HTTP service and the browser will recognize it as an HTML page. And then, as usual, it is deleted (but still returned to the browser). 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.
day, putting all the invoices for each sales representative in a single PDF and then sending it to the sales representative. It does this using several specific Metadata tasks as well as a quick lookup in an external Excel spreadsheet. Resources l PDF-DailySalesReport-Workflow.zip Task breakdown l The initial input is the "Merge PDF Files" on page 318, which retrieves and merges all the PDF files inside of the specified folder.
PlanetPress Capture Workflow PlanetPress Capture, introduced in PlanetPress 7.2 and enhanced ever since, is a set of tools that is used to simplify digital archiving processes by capturing information from a special pen which records 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.
Capturing and Archiving After the printed documents have been inked with the Anoto Digital Pen, the PGC files from the pen must be processed and merged with the appropriate documents in the PlanetPress Capture Database. A workflow process that receives PGC files and reads them in turn consists of the following actions: l An "HTTP Server Input" on page 602 task or "Folder Capture" on page 304 task that receives the PGC.
l A "PGC to PDF Converter" on page 636 task converts the PGC to a PDF l Any existing output is used here, for example an email notification. The Examples l "Basic Functional Capture Workflow" below l "Capture Post Processing Workflow" on the facing page l "Capture Web Manager Workflow" on page 236 Basic Functional Capture Workflow This workflow is the most basic and simple workflow that you can use with PlanetPress Capture.
PGC Handling Process The second process is the PGC Handling process. It receives data from the Anoto Digital pen, updates the Capture database and releases patterns as appropriate.
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 230 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 487) 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 PlanetPress 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 PlanetPress 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 400. 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 710 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 PlanetPress 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 230.
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 PlanetPress 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 PlanetPress 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.
VPN 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 PlanetPress 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.
that it generates, if that page contains a pattern. PlanetPress 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 PlanetPress 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 PlanetPress 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 PlanetPress Workflow have any idea that this causes an error until it's too late.
l Whenever possible, always avoid using pattern sequences unless it is absolutely necessary to do so. Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc. The penDirector creates a bridge between the Anoto Digital Pen and a PlanetPress Capture workflow in PlanetPress Workflow. In order to use penDirector, it needs to be downloaded from the Objectif Lune website, on this page. This software must be installed after PlanetPress Workflow.
4. Go in the Bluetooth tab of penDirector and click on Add Pen. 5. Click on Search while the cap is off on the pen. 6. When the pen is found, click on it and then click Add. 7. When asked for the PIN, enter the one noted above. 8. Click OK to save the settings. The settings for Bluetooth PGC handling are separate from the ones used when docking. Through Bluetooth, only a single storage and PGC Post URL location can be set for all PGCs.
Printer limitations Any document printed with Capture Fields (aka Anoto Patterns) must be sent through a Laser printer. Bubble jet printers are not supported and will most likely cause reading errors with Anoto Digital Pens. Thermal printers will not work either due to the low quality printout and the absence of actual blank ink on the paper.
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.
Distance between patterns In implementations where a lot of patterns need to be close together (a questionnaire, multiple choice question, checkmarks, etc) it is important to understand the risk of then pen writing across multiple fields on the paper. People using the pen may, for example, make a very broad checkmark which would bleed over to the next field. This can cause PlanetPress Capture to detect the ink as being present, and thus trigger whatever that field does.
l Once the ICR data is available, do something with it. This is done by reading the ICR data that is available in the metadata generated by the Get Capture Document task. l The metadata is also readable by the Capture Condition task, including the captured text and the reliability of this text. The Workflow as such is the following: l A Capture field is setup for ICR in a PlanetPress Design document.
business requires the application of best practices by all parties involved: Form designer, Workflow designer and User. Here we present a list of recommended best practices. Each of these guidelines aim at maximizing the likelihood that the characters are recognized; and minimize the risk of errors due to an incorrect analysis. You will find the following information, when applicable, for each best practice: l Target: The targeted audience.
l If proper names or nouns are expected (i.e. only the first letter must be a capital letter), select Capitalization in the Case option menu. Only the first letter would be converted to a capital letter. l If no specific format is expected, select None in the Case option menu. The letters will be interpreted as written, no conversion will be done i.e. characters in lower case will be displayed as such.
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.
and is written over two fields like numbers 9, 1 or 7; then the bottom tip of these numbers could be considered as number 1 in the second field. (Refer to the example below) 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.
l The ICR functionality of PlanetPress Capture cannot recognize dotted letters where there are circles instead of dots (like i , j). This would be analyzed as an i AND o. Therefore, dots should be as such and not circles. 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.
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: PlanetPress Fax Output tasks set to use Windows Fax under Windows 2000 may fail when no one is logged on to the system running PlanetPress 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 PlanetPress Image document is approximately 10 times longer on Windows 2000 than on Windows XP/2003. Preferences In addition to the job-specific PlanetPress Image properties that you configure in the task’s Properties dialog box, there are configurable options common to all PlanetPress Image Outputs processed by a given computer; see "PlanetPress Image preferences" on page 674.
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.
be used to monitor, start and stop PlanetPress Workflow services (see "Users and configurations" on page 284 and "The PlanetPress Workflow Service Console" on page 730). 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.
l PlanetPress Fax: Outputs jobs as faxes. You use PlanetPress Fax as an interface to WinFax PRO or Windows Fax, to send faxes you create from documents. You can install multiple instances of the PlanetPress Fax service on your network, and have PlanetPress Workflow send jobs to one or more of these instances. Each instance of PlanetPress 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.
l Click Resume to resume the service after pausing it. The PlanetPress 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 PlanetPress Workflow automatically.
l "Input tasks" on page 295 l "Action tasks" on page 351 l "Data splitters" on page 406 l "Process logic tasks" on page 420 l "Connector tasks" on page 435 l "PlanetPress Capture Tasks" on page 618 l "Metadata tasks" on page 469 l "OL Connect tasks" on page 494 l "OL Connect Send" on page 483 l "Document Management tasks" on page 565 l "Output tasks" on page 545 l "Unknown tasks" on page 637 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 83. 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 369 l "Email Input" on page 299 l "File Count" on page 422 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 602 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 318 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 PlanetPress Workflow Tools working folders under the "Backup" folder. To navigate quickly to the Workflow working folders, press the keyboard shortcut CTRL+ALT+Shift+F4 from within the Workflow configuration tool. The number of days to keep backups of jobs processed by input tasks is set per process; see "Process properties" on page 724.
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 PlanetPress 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 PlanetPress 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 PlanetPress 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, PlanetPress Workflow removes data files from the source location.
Job Information definitions %1 - Source File Name. Contains the file name (including the path and extension) of the file l name that is captured. %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.
C:\Samples\ 20197 C:\Samples\manuals\ usermanual.pdf C:\Samples\manuals\ 644037 Note: The
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 724. 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.
Task properties General Tab l FTP Server: Enter the IP address or host name of the FTP server to poll. l User name: Enter the name of a user account on the FTP server. l Password: If account named in the User name box is password protected, enter the password here. l Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available.
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. This is useful if this task is used as a secondary input and the information is defined dynamically.
commands (see "Variable task properties" on page 289). Note that when PlanetPress Workflow connects to a secure page, an SSL (Secure Socket Layer) connection is automatically used. Note: The connection to remote HTTPS is done through TLS v1 encryption. Prior to version 2019.2, this was done through SSL v2.3. Secure connections (SSL) made with the HTTP Input Client are known to experience issues when connecting to site bindings using the Server Name Indication (SNI).
Job Information definitions l %1 - URL address: Contains the full URL that was requested by the task. This includes any GET variables in the URL. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Input Error Bin The Input Error Bin task is used specifically and only to create error management processes.
Task properties General Tab l The Input Error Bin task does not have any specific properties unique to it, since it only receives input directly from tasks in other processes when an error is generated. For more information, see the chapter on "Debugging and error handling" on page 82. "Other" Tab l Job Information group l Information elements: Indicates what Job Info variables are automatically created by the input task.
Note: SOAP communication is non-trivial and requires a certain understanding of XML and the SOAP protocol. Using the SOAP tasks pre-supposes this knowledge and this documentation does not attempt to provide it. The Input SOAP Task only responds to a single SOAP action by the client: SubmitJob. Within this request however, a secondary action (SubmitSOAPActionName) can be specified - this is what the SOAP Action corresponds to in this task properties. Input This task does not poll any location by itself.
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 724. 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.
Task properties General Tab l LPD queue names: Enter the queue name (or names, one per line) specified in the printer queue on the remote computer or computers. l Allow empty queue names: Check this option to accept LPR jobs that don't specify a queue name. l Create PDF (With Metadata): Select to output a PDF. This will only work with PostScript input. l Optimize Resulting PDF: The resulting PDF is optimized for size and caching options are enabled.
l %4 - Source file name: Contains the name of the job file as specified by the software that sent the job. l %5 - Sender's IP address: Contains the IP address from which the job was sent. l %6 - 6 Queue name: The name of the queue from which the job was captured. It will be empty if the queue name was empty. 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 Folder: Enter the full path of the folder from which the input files are to be taken. l Masks: Enter a single or multiple file names or use file name masks. See "Masks" on page 291. Since this task only supports PDF files, make sure your extension remains .PDF for all your masks. l Sort files by: Select a given sorting method to prompt PlanetPress Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order).
"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 PlanetPress Workflow Tools working folders under the "Backup" folder.
Mail.Read permission; the Mail.ReadBasic permission is insufficient as it does not grant access to the email’s body or attachments. 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 Email Input task captures an email and its attachments from the selected inbox when it corresponds to the rules defined in the General tab.
Body C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\Pla Watch\Debug\0106HBKO3IODK3F\ 0106HBKO3IODK40.html Attachment C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\Pla Watch\Debug\0106HBKO3IODK3F\ 0106HBKO3X2KK41.pdf Attachment C:\ProgramData\Objectif Lune\PlanetPress Workflow 8
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. l %4 - Subject: Contains the subject of the received email (may be blank). l %5 - Recipients:Contains a list of the names of all the recipients of the email, separated by a semicolon (;).
l User ID: This is the user's ID or email address. This value is dynamic. You can use any combination of text, variables and data selections; see "Variable task properties" on page 289. l Use delegated permissions: Select this option to use delegated permissions instead of application permissions. Delegated permissions allow the application to log in as a standard registered user, and IT can grant that user account access to specific inboxes and specific OneDrive folders.
Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Microsoft 365 OneDrive Input Microsoft 365 OneDrive Input tasks allow the processing of files from any of the organization's Microsoft 365 OneDrive accounts. This task uses the Microsoft Graph API.
Output The output to this task is a series of individual files, one after the other. These files are not modified in any way from when they are captured from the source folder. Job Information definitions l %1 - User. This is the OneDrive user's ID. l %2 - Source File Name. Contains the file name (excluding path but including extension) of the file name that is captured. Equivalent to using the %o system variable. l %3 - Folder: Contains the folder from which the data was captured.
Connection l Application ID: Enter the application ID provided by Azure for this specific application. This value is static and cannot contain variables. l Application Password: Enter the client secret (key) for the Azure app. This value is static and cannot contain variables. 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.
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. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Input plugin preferences 2" on page 666 and "NodeJS Server Input plugin preferences 3" on page 666. 2. In order to serve resources that come from the Connect Server the ppNode service needs to know the credentials and communication protocol to use for communication to the Connect Server. These must be entered in a file named default.js that is by default found in C:\Program Files (x86)\Objectif Lune\ppnode\src\constants\.
The request can contain one or more files, one being an XML file containing the request information as well as any GET, POST, PUT or DELETE variables that were received within this request. Other files are POST or PUT attachments. The NodeJS Server Input task supports basic content-types: multipart/form-data, application/x-wwwurlencoded, and application/octet-stream, as well as raw body content-types: l text/plain (.txt) l application/xml, text/xml (.xml) l text/html (.
If the Send Immediate Response to client option is selected, the response file is sent back right away and the involvement of the input task ends then. However, if this option is not checked, it means there is a second output that comes out of the NodeJS Server Input task: the last output generated by PlanetPress Workflow is sent back to the initial input, by which it is returned to the client.
misinterpretation. If the original file name is needed, it can be found in the original attribute of the file tag in the request XML. Note: If form data are submitted from HTML files that are made with the OL Connect software, you can expect them to be UTF-8 encoded. Caution: Don't use any non-ASCII characters in Workflow's working directories path (in the V8WorkingDirectory registry key).
in that range. Note: The response code must start with 3 digits, followed by a space and then the error message. If the first few characters can't be converted to a valid number, the server automatically returns "500 Internal Server Error", regardless of the actual response code provided by the process.
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.
PrintShop Web Connect Preferences A PrintShop Web Connect preferences page, accessible via the PlanetPress Workflow Button | Preferences | PrintShop Web Connect, allows to provide operator credentials to your PlanetPress Workflow configuration. It is mandatory to fill both the user name and password fields (with the values of an existing user on the PrintShop Web server) in order to use the PrintShop Web Connect Input task.
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. Secure Email Input The Secure Email Input task captures a POP3 or IMAP email message using the highest encryption method that is available on the server (SSL 2.0, 2.3 or 3.0 / TLS 1.0, 1.1 or 1.2). Note that this plugin cannot be used on a Windows instance that uses a multi-byte language (e.g. Japanese, Chinese).
(as expected for all files in the Temp Workflow folder). Retrieving and moving the body and attachment files may be done using an "XML Splitter" on page 417. Example output file Peter Parker parkerp@ca.objectiflune.com Bill of Lading 2018-03-29 15:52:54 starkt@ca.objectiflune.com Body C:\ProgramData\Objec
l “From/To/CC/Subject/Body” contains: Select one or more options and enter the search text. "Contains" means that the search text can be surrounded by other text; for example, when looking for “world” in the “Subject” field, an email with the subject “Hello world, my name is Peter” will be captured. These condition fields are variable property fields. You can use any combination of text, variables and data selections; see "Variable task properties" on page 289.
If the original filenames are used and multiple attachments have the same name, they will be appended with a numeric suffix, for example: File.pdf, File (1).pdf, File (2).pdf. "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.
Processing When the job is received through the Serial connection, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. Task properties General Tab l Since Serial Input tasks have no specific task configurable properties, this section contains no property information. "Other" Tab l Job Information group l Information elements: Indicates what Job Info variables are automatically created by the input task.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SFTP Input The SFTP Input task retrieves files from a secure FTP site through an encrypted connection. Masks are typically used to select multiple files to be retrieved from the server. The SFTP Input and "SFTP Output" on page 553 tasks are part of a separate installer and are not included in the Workflow installer.
l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH). l FTPS: Select if the FTP server uses FTPS (SSL/TSL) Port Number Group l Use default port: Check to use the default port used by the protocol selected above. 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 PlanetPress Workflow task.
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.
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.
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 PlanetPress Workflow is to listen for Raw Socket communications. The default port number is 9100.
Job Information definitions 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. WinQueue Input WinQueue Input tasks capture print jobs received by a Windows printer queue.
l Printer properties group l Spool Print Job ins EMF Format (Advanced printing features): Select to create EMF files for Windows Print Converter action tasks (see "Action-EMF Converter (Windows Print Converter)" on page 616). 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).
Job Information definitions l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user un which a software sending the job was logged in under. l %2 - Host computer: Contains the name of the computer from which the job was sent. l %3 - Printer name: Contains the name of the printer in which the job was received. Is the same for all jobs received on any given printer.
l "External Program" on page 384 l "Load External File" on page 386 l "Logger" on page 387 l "Mathematical Operations" on page 388 l "Open XSLT" on page 389 l "PDF/A-3 Attachments" on page 390 l "PDF to Bitmap" on page 533 l "Push to Repository" on page 393 l "Rename" on page 395 l "Run Script" on page 428 l "Search and Replace" on page 397 l "Send Images to Printer" on page 612 (Legacy task) l "Send to Folder" on page 399 l "Set Job Infos and Variables" on page 400 l "SOAP Clie
Processing The selected operation (adding or removing lines, text or pages) is made on the data file. Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General tab l l 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.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Advanced Search and Replace Advanced Search and Replace action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data. Contrary to Search and Replace action tasks, they allow the use of regular expressions. Using regular expressions, it is possible to search for patterns rather than specific strings.
Task properties General tab l Search mode group: Select your chosen search mode within this group. l Search line by line: Select if you want each line in the data stream to be searched separately. When this option is selected, PlanetPress Workflow considers each line as an individual data stream (lines are separated by Line Feed characters). It minimizes memory requirements but may also limit hits, since lines are considered separately.
l At the end of a line: Select to indicate that the search string must be the last string on the line. l At column: Select to indicate that the search string must be in a specific column. Specify the column number (the value must be greater then 0) in the Column value box below. l Between specific words: Select to indicate that the search string must be between specific words. Specify these words in the Word before and Word after boxes below.
Barcode Scan The Barcode Scan task is used to convert barcode data from multiple image formats into text-readable information. This information is placed in the Metadata and can be used by the rest of the process.
Barcode Description types Codabar Codabar symbology. Used in libraries and blood banks. Inter2of5 Interleaved 2 of 5 symbology. Used in warehouse, industrial applications. Add2 2 additional digits code for UPC-based symbologies. Used to indicate magazines and newspaper issue numbers. Add5 5 additional digits code for UPC-based symbologies. Used to mark suggested retail price of books.
converted to tiff format. l Process by File: The task will process the file once and will insert the barcode information in one Metadata file. Metadata will be created if it does not exist or will be enhanced with the values if it already exists. l Replace non-printable character with: Enter a character that will be used as a replacement for all non-printable characters read from the barcode.Some barcode types like Data Matrix can store non-printable characters that Metadata does not support.
l If the selected option is process by page, then the Metadata file is created and overwritten for each new scanned page. l If the selected option is process by file, then only one Metadata file will be created (or updated). Note: If Metadata was created previously in the process, the task only adds new fields to the existing Metadata at the datapage level. Metadata fields The barcode values are stored at the datapage level of the Metadata.
Accessing a barcode value from the Workflow tool One method to access a barcode value from the Workflow configuration tool is to use a VBScript with the Open Script task, using the Watch.ExpandString command with a Metadata command as its input parameter, in between double quotes. For example, the following script line gives the value of the first BarcodeValue Metadata field of the first datapage: watch.expandstring("GetMeta(BarcodeValue[0],0,Job.Group[0].Document[0].
Task properties Note to PlanetPress Suite users: The options of this task are basically the same as the Data Selector in PlanetPress Design; see PlanetPress Design User Guide. General Tab Add/remove characters: Enter the number of characters to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add characters; negative values remove characters.
Emulation. The available emulations are: l Line printer. (Nothing to configure.) l ASCII. l Tab on CR: Select to have the document insert a tab after each carriage return character it encounters. Set the number of spaces in the tab using the Number of spaces in the tab box. This option is available only if you selected the Read in binary mode option. If you cleared Read in binary mode, the printer replaces any end of line characters (CR, LF, or CRLF) it encounters with a LF.
a 1 appears in the first column of your data, it is likely the channel skip codes are standard, and that only minor adjustments to the other codes, if any, will be necessary. l No line feed: Enter the channel skip code that tells the document to ignore any line feed character (LF) that appears at the end of the line. This causes the next line to print over the current line, and is a technique impact printers use to print a line, or elements of a line, in bold or with underlining.
l Database. (Nothing to configure.) l XML. l Cache XML data: When this option is selected, PlanetPress Watch/Server only reloads the data if the size or modified date of the XML file changes. When this option is not selected, the XML data will be reloaded into memory every time that a plugin works on the data file. Caching the XML data will make subsequent tasks run faster (as loading an XML file can take a long time) but will also use up more memory since that memory isn't released in between tasks.
Processing A PostScript file can be converted straight into PDF. A regular data file needs to be merged with a PlanetPress Design document first, except for a PDF file, which may or may not be merged with a PlanetPress Design document. When a PDF file is used as-is, the Create PDF task will apply the active Metadata to the PDF data file (for more information on this see "PDF Workflow" on page 228 and "Working with Metadata" on page 69).
l Security group l Set document permissions: Select to enter the Permissions password. l Permissions password: Enter a password in this box only if you want to prevent users who does not have this password from changing the security options of the generated PDF files. l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files.
l Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty. Select Bookmarks and page to display the contents of the Bookmarks tab (you use data selection objects to create bookmarks in PlanetPress) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages.
l l l l Color images: l Compression: Auto l down sampling: Bicubic l Pixels per inch: 150 Security: l Allow printing l Allow changing the document l Allow content copying l Allow form filling Font: l Embed all fonts l Subset embedded fonts Open options: l Zoom factor: Fit in window l Default view: Page only Database Query The Database Query input or action task retrieves data from various databases to use as input data.
l You can use dynamic properties (properties that include variables or data available at run-time). This option lets you create a dynamic database connection string as well as an SQL statement that changes based on the data processed by PlanetPress Workflow. Note that this option will not let you test the query performed by this task before it is performed with actual data. Input Any data file. The data file will be discarded by the task.
l Range group l All: Select this option use all the records included in the database. l Records: Select this option to use only some of the records in the database. Indicate the range by entering the number of the first record followed by a dash and the number of the last record. To use records 50 to 75, for example, enter 50-75. Note that this option is intended mostly for testing purposes, since in real life scenarios, you typically want to use all the records stored in a database.
l Field separator: Select the field separator to be used in the generated file. l Add a header record with field names: Select this option if you want the generated file to have a header record (a record that includes the field names only).
l XML for PrintShop Mail: This emulation is specifically for use with merging your data with a PrintShop Mail document, using the PrintShop Mail task (see PrintShop Mail). No options are offered, as this format is static and should not be modified. l Alternate syntax: Select to prevent automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the Advanced SQL Statement dialog box.
the string automatically to this box. Note that if a login name and password are required to connect to the database, a dialog box is displayed and the information you enter is saved in the configuration of the PlanetPress Workflow Database action task. Another option, if a database connection string (not a database path and name) was already entered in the Database Connection tab, is to simply copy and paste it to this box.
l File mask: Enter a file name mask to specify which files must be decompressed. Leave the default value of *.* to decompress all the files found within the zip. l Password: Enter a password if the zip file is password protected. l Restore path structure: Select if you want the complete file structure to be rebuilt from the output folder to the decompressed files. l Force directories: Select if you want to allow the system to create new folders when required.
l Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box. l Documents: Select None (Do not use a document (passthrough) in order to generate an image with a PDF/VT or PostScript file in passthrough mode. Note: For an explanation of how to generate specific tags and indexes for the Image and Digital Action tasks, in a PDF/VT file created with Connect, see the Connect Online Help: Generating tags for Image output.
l The AutoStore, DocAccel and KYOcapture formats also generate TIFF files along with special XML that are meant for these specialized systems. l VDX: The output will be a VDX file, which is a PDF file with some PPML code inside of it to enhance performance by doing caching/image reusing. The output can only be used on devices that support the VDX technology. l DPI: Enter the dots per inch (dpi) resolution of the output image. This property is enabled for all output types except PDF.
(such as for multiple TIFFs), each file name includes a sequence number, such as in Invoice0, Invoice1, Invoice2. If you use file name masks that include dots, such as Statement.%y.@ (1,1,1,1,25,KeepCase,Trim) or Job.%f, for example, you must add quotation marks at the beginning and end of the file name (“Statement.%y.%m.@(1,1,1,1,25,KeepCase,Trim)” or ”Job.%f”).
to contain a color profile and the CMYK color profile is rather big compared to a RGB color profile. If the output size matters it is recommended to avoid using CMYK colors. l General group l ASCII format: Select to create the PDF file using ASCII characters (instead of the usual 8bit binary format). This option produces a file suitable for transmission over a 7-bit ASCII link.
l Monochrome images group l Monochrome 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 Color compression: Select the compression to use for the color images. Flate is a lossless compression method, so no data is lost in the process. 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 PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files. 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.
Adobe Reader are never embedded. If a font is not embedded in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font. l Subset: Select to embed only a subset of the Type 1 and TrueType fonts used in the document. A font subset is in fact composed of only those characters that are actually used in the document. This option can only be used if the Embed all fonts option is selected.
l Data source name: Enter the name of the computer on which the database runs. This option is available only when you select SQL Server database or Oracle database in the Database type box. l Use default database: Select to use the default database associated with your user profile on that SQL Server or Oracle database. Clear to enter the name of the database in the box that appears. l Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database.
Processing The external program is executed using the parameters provided. Note that the current data file is not "sent" to the executable file, however you can refer to the full path of the data file using %F. Output If the external program modifies the job file using the full path, the modified file is the output of this software. Otherwise, the output is the same as the input. Metadata is not modified in any way. Job Infos may be modified, depending on the options set in the task's properties.
the program which will indicate whether its execution was a success or if errors were encountered. l Verify return value: Check to enable the group and react whenever specific exit codes are returned by the software. l If exit code is: Use the drop-down to select how to compare to the exit code. This numerical comparison is either equal, greater than or lower than. l Value: The numerical exit code that will be verified.
Task properties General Tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
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. Mathematical Operations The Mathematical Operations action task resolves a mathematical expression and stores the result in an existing Job Information or other type of variable (see "About variables" on page 238).
l Store result in: Variable data field containing the job information, local or global variable in which to store the result. For job information use %1 through %9, for local variables use %{variable} and for global variables use %{global.variable}. l Use value of Variable/JobInfo # expression: Use the contents of the variable entered in Store result in:, which is assumed to be a digit between 1 and 9. This digit determines in which job info the result of the mathematical expression is store.
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. Search l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence.
Several e-invoicing standards, such as ZUGFeRD in Germany and Factur-X in France, require the (XML) invoice data to be attached to a PDF/A-3 file. PDF/A-3 files with attachments can also be used for hybrid archiving: the PDF/A serves as the version that is suitable for long term storage, and alternate forms and/or the source document can be added as attachments. Licensing This plugin requires the OL Connect Workflow Imaging license.
that is non-PDF/A-3 compliant, the task will add the attachments to it, but it will not convert the file into a PDF/A-3 compliant file. l Attachments: Specify which files should be attached to the target file. Use the buttons at the bottom to add and delete attachments and to change their order. Note: All of the Attachments properties can be variable (see "Variable task properties" on page 245). You can right-click on a field to open the contextual menu and select variables, data, and lookup functions.
The plugin doesn't verify that the resulting PDF/A-3 file and attachment conform to the chosen standard; it is up to you to ensure that it does. Note: The ZUGFeRD and Factur-X standards require XML invoice data to be attached to the PDF/A-3 document. The name of the XML attachment should be the same as the DocumentFileName in the metadata. l Add PDF/A-3 conforming metadata: Check this option to add XMP metadata to the PDF/A-3 file.
Task properties General tab l Group: Use the drop-down to select into which group the KeySet is inserted, or in which group the KeySet should be updated. l Key set: Displays a list of keys for the selected group. l Key: Displays the key name in the group. l Value: Enter a value for the key, which will be inserted in the KeySet. This value can be dynamic, including data selections, metadata selections, variables and other data. l Update: Check to update the key with new data.
Rename Rename action tasks are used to rename the job files they receive. Note that you can see how each file is renamed via the Object Inspector when stepping through a process in Debug mode. Input Any job file, in any format. Processing The task renames the job file to the desired name, and changes the value of %f and %F to reflect the new name. Output The input data file is output, with the new name. Task properties General Tab l New file name: Enter the job file’s new name.
Processing The script is executed. The script can modify anything such as the data file, Job Info variables, Metadata, or even other files on the operating system. Output Whatever file the Run Script action generates, Metadata it modifies or creates, etc. Note: When using Run Script as a Condition, the output of the task can be within the branch or on the main trunk. To control the output, use the "Script.ReturnValue" on page 145 variable in your script.
l Language: Select the language in which your script is written. Choices are VBScript, JavaScript, Perl or Python. l Tools l l Editor Options...: Opens the "Editor Options" on page 679. Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l The script editor text box: This is where you enter your script that will be used.
Input Any text-based file can be used in this task, even formats that are not directly compatible with PlanetPress. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task. Processing The appropriate changes are made to the data file (replacing text). Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General Tab l Find: Enter the string of data for which to search.
Send to Folder Send to Folder Action tasks send the files they receive to a local folder. They perform the same function as Send to Folder Output tasks, with the only difference being that in this case PlanetPress Workflow will wait for the task to be completed before going on to the next task in the configuration. 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.
Set Job Infos and Variables Add Set Job Infos and Variables action tasks to set Job Info elements as well as custom variables (see "About variables" on page 238). You can set multiple variables and Job Info values in a single task. Be aware that lines are processed from top to bottom. Input Any data file in any format. Processing This task assigns the defined values to local or global variables or Job Info variables. It does not modify the data file nor the Metadata.
XML format used to communicate among systems across different architectures, languages, and operating systems. A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol. The payload of the SOAP packet is an XML document that specifies the call being made and the parameters being passed. Web services, a SOAP class of applications, expose their services via the Internet in a manner that lets other applications access them, as well as use and combine them as required.
Note: The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l Get: Click to get the WSDL file from the SOAP server and populate the Service box below. l Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found.
l Username: Enter the user name for the authentication, if required. l Password: Enter the password for the above user name. l Allow invalid security certificate: Check to ignore SSL certificates that are invalid. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l Remove and convert HP escape characters: Select to filter HP escape character sequences from the job file. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Translator Translator action tasks can convert your data from its current encoding to a different encoding. The same data may be converted back and forth as required.
Task properties General Tab l Source encoding: Select the current data encoding. Note that the source encoding is not selected automatically and you must therefore select the proper encoding from this list in order for the conversion process to be performed successfully. l Target encoding: Select the encoding to which you want the data to be converted.
JSON to XML conversion When a JSON source file contains a single JSON object, that object's key will be used as the root node name in the resulting XML file, and the root node will be populated with the data inside of the JSON object. In all other cases, a root node named 'root' will be added to the XML. It has the property "OL" with the value "RootObject" to define it as an array container. This property will be ignored when converting from XML to JSON.
In PlanetPress Suite, such tasks can be used, for example, to split files that contain statements for multiple clients into smaller files that each contain a single client statement. Each statement can then be printed and sent by snail mail, or emailed directly from PlanetPress Workflow, to each individual client. Note that if the process merges the split data with a PlanetPress Design document, the splitter must not alter the structure of the data file.
But when opened with PlanetPress Design or a PlanetPress Workflow using the ASCII emulation, the data in the generated file would look exactly like the data in the original. The same would hold true for the Channel Skip emulation. Note the following details about emulations and their options: l With most emulations, if a file is split on a form feed, the form feed will not be appended to the output file.
The following options are only displayed when the Field value change or the Field value condition option has been selected at the top of the dialog box. l Field: Enter the name of the field upon which to base the splitter condition. Note that you can use the popup menu's Get Data command to select the field and populate this box automatically. The following options are only displayed when the Field value condition option has been selected at the top of the dialog box.
l Maximum records per file: Enter the maximum number of records to include in each file. Enter 0 for no limit. l Maximum pages per file: Enter the maximum number of pages to include in each file. Enter 0 for no limit. 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 Split data file on emulated page group: Select to split the data file based on pages (rather than on a word found within the emulated data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place. l Page(s) per output: Enter the number of pages to include in the file generated by the splitter in this edit box below or use the spin buttons.
cess, so the word “DAY” will not be considered as matching the word “DAY”. Note that this setting applies only to the Word change option. l Where to split: By default, the task splits the file at the beginning of the line on which the condition is met (the default value is 0). If you want the task to split the file a certain number of lines before or after that line, enter a value other than 0 in this box.
Task properties General Tab l Split data file on page group: Select to split the data file based on pages (rather than on a word found within the data stream) and to activate the options from this group, which are used to tailor exactly how you want the page based splitting process to take place. l Page breaks on form feed: Select if you want to start a new data page whenever a form feed character is found.
l After: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines after the search word. l When word is found: By default, the task splits the file every time the search word is found (the default value is 1). If you want the task to split the file only when the search word has been found twice, for example, enter the number 2 in this box. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Task properties General Tab l Split on page: Select to split the data file based on pages (rather than on a word found within the PDF data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place. l Page(s) per output: Enter the number of pages to include in the file generated by the splitter in this edit box below or use the spin buttons.
cess, so the word “DAY” will not be considered as matching the word “DAY”. Note that this setting applies only to the On region change option. l Where to split: By default, the task splits the file at the beginning of the line on which the condition is met (the default value is 0). If you want the task to split the file a certain number of lines before or after that line, enter a value other than 0 in this box.
l Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized. Optimization can lead to a significant reduction in the size of the PDF, but it may also add a certain amount of time to the process. This option should only be unchecked if the timing of the process is critical and needs to be done quickly, but keep in mind that the resulting PDF may be much larger than it should be and may even be too large for PlanetPress Workflow to handle.
l Standard XML splitter The following options are only displayed when the Standard XML splitter option is selected in the Split method box. l Condition node path: In the tree view, select the XML node to consider to determine when to split the file. To indicate whether you want the file to be split whenever this node is encountered or whenever the information in this node changes, see the Condition group below.
l 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. l Refresh XSLT button: Once you have made all the required settings using the Standard XML splitter option, click this button to display the XML code generated by the XML splitter.
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. In the Process area, conditional branches appear with their associated condition, allowing you to understand the logic of the whole process at a glance.
l "Loop" on page 427 l "Run Script" on page 428 l "Send to Process" on page 430 l "SNMP Condition" on page 431 l "Text Condition" on page 433 l "Time of Day Condition" on page 434 Branch A Branch duplicates your job file along with accompanying information. Branches do not execute in parallel - the branch is executed, and then the trunk (or the following branch) continues. For more information about branching see "About branches and conditions" on page 115.
main branch. Any modification performed on the secondary branch thus has an impact on the main branch. In case of the failure of a Branch task (the branch itself, not the other tasks contained within), by default the process will ignore the branch and simply go down the main trunk. You can overwrite this in the On Error tab. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
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. Task properties General Tab l Target folder: Enter the full path of the folder from which the input files are to be taken, or use the Browse button to select it. Note that subfolders are not processed. This is a variable property field.
"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 PlanetPress Workflow Tools working folders under the "Backup" folder.
Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Name Condition File Name Condition tasks test the original name of the job file traveling down the process branch, or in other words, the name of the file received by the last input task appearing above the condition.
l Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess (see "About processes and subprocesses" on page 105).
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. Note that the emulation is not passed from a main process to a subprocess or vice versa. l Retrieve subprocess error: Select if you want to receive error(s) from the subprocess in order to handle them on its own. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" on page 384). 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.
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.
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. If the information is successfully retrieved and it corresponds to a printer, the Host name and Description of the printer (or other device) appears in the corresponding boxes.
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. Text Condition Text Condition tasks can be used to perform two different types of tests: l To test the presence of a string within the job file. You can, for example, search for the string “Gold member” on the first line of the job file.
l On numeric error: This option is only available when the Numeric comparison option is selected. Select the behavior you prefer when PlanetPress Workflow is unable to successfully perform a numeric comparison. Select ”Return the error”, if you want the Text condition to fail altogether. Select ”Return true”, if you want the condition to be considered True. Select ”Return false”, if you want the condition to be considered False.
Task properties General Tab l Month: Select All months if you want the selected time blocks to be valid every month of the year. Select a specific month if you want the selected time blocks to be valid only on that month. l Week of month / by date: Select Date if you want the selected time blocks to be valid only on specific dates. Select All weeks if you want the selected time blocks to be valid every week of the month.
l "PlanetPress Fax" on page 450 l "PlanetPress Image" on page 452 l "PReS Print Controls" on page 460 l "PrintShop Mail" on page 609 (Legacy tasks) l When installed, the "ZUGFeRD plugin" on page 463 also appears in the Connector category. It is bound to the Connect Workflow Imaging license and provided separately.
l Password: Enter the password that corresponds to the Repository ID entered above. l Document ID: Enter the ID of the document to delete from the Repository. l Invert result: When the task is used as a Condition task, the success of the delete operation determines whether the condition returns True or False. Check this option to invert the result. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
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. Task properties General Tab Note: For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab.
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. l Domain: The active directory domain for the logon credentials. This is not necessary if the SharePoint server is not part of a domain. l User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries.
index information on the Laserfiche server with dynamic information that can be taken from PlanetPress Workflow PDI files (for PlanetPress Workflow archives only). Note: The Laserfiche Repository Output requires the Laserfiche run-time version 8.1 or higher and will not work with previous versions. It also requires a valid PlanetPress license. About Laserfiche Laserfiche is a provider of digital document and record management systems.
l Electronic files: All files will be stored in their original format in Laserfiche. When double-clicking on the document in Laserfiche the native Windows application associated with the file extension of the archive will be opened. l Force folder creation: Select to force the folder creation if it does not already exist on the Laserfiche server. l Volume: A list allowing to choose among available Laserfiche volumes. l Configure Tags: Click to open the Configure Tags dialog.
l To use the “Use PlanetPress PDF/A archives” option, make sure to: l Check the field as Multiple, select CHAR type and enter the width fields in Laserfiche administration console as long as your PlanetPress fields. l Insert a folder path to your PDI source files in the PlanetPress Image archive folder. l If a field is checked as Required in Laserfiche administration console, fill the field value.
Microsoft® Excel® Documents action task will replace the value of this Metadata field with the corresponding customer email. Use Case 2: Translate a list of line items descriptions into a given language A PlanetPress Design document takes as input a transactional PDF file, and reproduces it exactly as it enters. Metadata fields called ItemDesc are created, one for each line item description, at the data page level.
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. l Replace field value: Replaces any existing field with the new content. Only the last result will be displayed. If the field does not exist, it will create it.
This task can be added as an Action task (see "Action tasks" on page 351) or as an Output task (see "Output tasks" on page 545). Adding it as an Action task enables the process or branch to continue after this task. An Output task is always located at the end of a process or branch. Input This task ignores the input data file and any Metadata unless data selections are used in the variable data fields. Processing This task does not process the data or Metadata file.
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. The maximum image size is 512x512 px and it is required to be in JPG or PNG format. Use the Browse button to locate an image on the local drive. The Cover Image is optional and, if omitted, displays a default image based on the file type.
the Capture OnTheGo Server, the process will go through and the listed categories will be added to the Server. Advanced Tab The Advanced tab is where you specify the document's time to live either in the repository or the user's device. l Document Handling Options group: l Customize: You must check this box if you want the options included in this group to be used. When this option is not checked, the other boxes included in this group are faded.
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.mdb database located in %ProgramData%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\COTG , and includes most of the information set in this task,
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 PlanetPress Fax properties you configure in the task’s Properties dialog box, there are configurable options common to all PlanetPress Fax outputs processed by a given computer (See "PlanetPress Fax plugin preferences" on page 670). Note that those options are specific to each PlanetPress Fax installation and that they are immediately applied. Input Any data file with a valid emulation (see "About data emulation" on page 54).
PlanetPress Image PlanetPress Image Output tasks are used to make requests to PlanetPress Image, which creates image files which it then archives or emails. For more information about this product, see "About PlanetPress 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 375 task should be used instead.
l If the data file and a document are selected, and Printer Centric mode is used, the data file is sent to the PlanetPress Image host which merges the data and document to produce output. l If the data file and a document are selected, and Optimized PostScript Stream mode is used, the data file is merged with the document and the resulting OPS job is sent to the PlanetPress Image host to produce output.
l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. 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.
l Archive output: Select to archive generated files. If you select this option, you must enter a folder path in the Archive folder box and a name in the File name box. 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 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. PlanetPress 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 83.
For more information about Metadata see: "Metadata" on page 67. 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 PlanetPress 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.
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 All PlanetPress Design document templates must use the N-Up object on both the front and the back pages of the duplex document. 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..
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 510 l "Create Print Content" on page 515 l "Create Web Content" on page 518 l "Download EML Messages" on page 522 l "Execute Data Mapping" on page 524 l "File Store - Delete File" on page 528 l "File Store - Download File" on page 529 l "File Store - Upload File" on page 530 l "Mark Connect Sets for Deletion" on page 531 l "Merge Jobs" on page 532 l "Render Email Content" on page 535 l "Retrieve Items" on page 538 l "Set Properties" on page 542 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 49). 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 49).
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 538 task, or the Filter source in the "All In One" on page 495'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 78. 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.
parameter with Boolean data values that are stored as 0/1 in data fields.) o Numeric string values need to be parseable as a number (either a whole integer or decimal value). o Dates should be in an ISO8601 compatible format (e.g. 2019-10-15) or use the current Windows Locale date settings options.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 (\)
This task can be added as an Action task (see "Action tasks" on page 351) or as an Output task (see "Output tasks" on page 545). 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 502 task, a "Create Print Content" on page 515 task, or a "Create Web Content" on page 518 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 524 task and the "Retrieve Items" on page 538 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 502 task, a "Create Preview PDF" on page 511 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 654.
Note: With PlanetPress Workflow version 2020.1, using the Download EML Messages task requires the version 2020.1 "Mailjet" on page 588 and "SendGrid" on page 591 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 654). 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.
Output The output to this task is twofold. On the OL Connect Server side, a Record Set containing multiple records is created and saved. On PlanetPress Workflow's side, Metadata is returned with information about each record set (see "Note: Metadata in OL Connect jobs" on page 68).
l Metadata: Select to output the full Record table (no Details table) as Metadata in the task. It is then possible to sort and filter the Metadata using the regular Metadata tools, as long as the Update Records from Metadata option is used in further tasks to use the modified Metadata. l XML: Select to output an XML structure containing the full Record Set including all detail tables. This option cannot be used with other OL Connect tasks.
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 OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
l Mark as permanent: When this option is checked, the file will never be removed automatically by Connect's Clean-Up Service. Non-permanent files may be removed if there are no remaining references to them in the Connect Database. (See: Clean-Up Service preferences.) 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 654.
Task properties General Tab l Set types to mark for deletion based on metadata content: l Job Set: Tag any Job set created by the "Create Job" on page 506 task or the "Retrieve Items" on page 538 task set to retrieve Job Sets. l Content Set: Tag any Content set created by the "Create Print Content" on page 515 task or the "Retrieve Items" on page 538 task set to retrieve Content Sets.
Processing The current Metadata Job File is merged with the selected external Metadata file. Output The task outputs a merged Metadata Job File which can be used in the "Create Output" on page 508 task. Task properties General Tab l Metadata file: Enter the full path to a valid Metadata file containing an OL Connect Job, or use the Browse button to browse to a valid location. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Properties The General tab has the following options: l Output format: The output format can be either PNG or JPG. l Resolution: Specify the resolution of the bitmaps (pixels per inch). The minimum is 12, the maximum is 1200. For example, with the minimum of 12, a PDF page that is 8,5 inch wide is converted into a bitmap of 102 pixels wide, which could be used as a thumbnail on a web page. l Page range: An asterisk (*) means: convert all pages.
Render Email Content The Render Email Content task pre-renders emails from a template's Email Context and stores them in the File Store, along with their attachments. Note: The Render Email Content task works only if PlanetPress Workflow is licensed for sending emails. It is not available for users with Demo, Test or Reseller licenses. For the Render Email Content task in PlanetPress Workflow 2020.1 and higher to function correctly with the SendGrid and Mailjet plugins, the version 2020.
Note: Make sure that other components in the Workflow configuration working on the job data handle UTF-8 encoded files correctly. Processing This task loops through each record in a Record Set or through each JSON object in an array. For each record or JSON object, the task generates an HTML email using that record's or object's data. When an email address is invalid, no email content will be created. Instead, an error is reported for the record with an invalid email address.
], "contentSet":8769} For any non-fatal errors that occur, the data record index and error message will be added to an errors key at the same level as the messages and contentSet keys. The number of non-fatal errors that can be logged is limited to 100. Properties General Tab l Template: Click the Browse button to select a template from the resources (see "Connect resources" on page 38), or enter a dynamic template name.
the Email context and sections) and EML file (see below). l Metadata: Write the information to the current Metadata. l JSON Data in Job Data File: Return the information in a JSON structure that replaces the current Job File. This allows you to manipulate the output in a "Run Script" on page 428 task before sending it to an Email Service Provider (ESP).
Processing The task requests the items on the OL Connect Server using the conditions set in the task properties. Only the condition information and the returned Metadata or JSON are exchanged. Note that the order in which the requested items are returned cannot be guaranteed.
l Job: Retrieves one or more Jobs, including all their content items ready to be printed. Output similar to the "Create Job" on page 506 task. l Job Set: Retrieves one or more Job Sets, including all their content items ready to be printed. Output similar to the "Create Job" on page 506 task. l Optimized: This option, available when the Entity to retrieve is a Record or a Record set, allows to retrieve a greater number of records and handle large JSON files without memory issues.
l Simplified JSON: Select to output the full Record Set including all tables as an array of JSON objects. Unlike the output of the "JSON" option, simplified JSON does not contain information about the data type of fields. Commingling/Batching Tab Commingling is a method by which Print Content Items are merged together to create mail pieces going to each recipient.
l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Output The task outputs Metadata that is identical to the input Metadata. Only the entries on the OL Connect Server side change. Task properties General Tab l Entity: Use the drop-down to select the entity type of which to set the properties. This task does not auto-detect entities, and so the appropriate selection must be made: Record, Record Set, Content Item, Content Set, Job l Properties: Add all the properties to be added l Name: The name of the property.
Update Data Records The Update Data Records action task updates records in the OL Connect Database using values from the current Metadata or from JSON. Each of the OL Connect Content Creation tasks can do the same, if the Update Records from Metadata option is enabled for that task. The Update Data Records task can be useful when data needs to be updated multiple times before actually generating content, for instance when Postal Address Cleansing and Sorting is a two-pass process.
Note: Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
Available Output tasks l "Delete" below l End Subprocess, see: "Go Sub" on page 426 l "PlanetPress Fax" on page 450 l "FTP Output" on the facing page l "Microsoft 365 Email Output" on page 548 l "Microsoft 365 OneDrive Output" on page 551 l "PlanetPress Image" on page 452 l "Print using a Windows driver" on page 555 l "Printer Queue Output" on page 556 l "Secure Email Output" on page 559 l "Send Email" on page 561 l "Send to Folder" on page 564 l "SOAP Client plugin" on page 613 (Le
Task properties General tab l Move to recycle bin: Select to send the deleted files to the Windows recycle bin. When this option is not selected, files are deleted permanently. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. FTP Output FTP Output tasks send job files to other computers using the FTP protocol.
l Directory: Enter the directory to which the job files are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server. l File name: Enter the name under which the output job file will be saved. Consider using a dynamic name, since if you use a static name every new file will overwrite the previous one. l Connection mode group l Active: Select to prompt PlanetPress Workflow to use the active mode when sending files to the FTP server.
Processing The task uses the Microsoft Graph API to access accounts in the organization (subject to that organization's IT policies). While an email is always sent by this task (or at least attempted to be sent), the contents of the email and presence of attachments depends on the selected options. Once the contents of the email and attachments are determined, the email (including any attachments) is sent directly to the selected mail server.
would cause the task to fail. If you suspect that the data may contain parentheses, you should use a Run Script action task (see "Run Script" on page 428) with a Strip() function to strip them out. l Message: Enter the content of the email message. This may be text or HTML based. Note that since this is a variable property field, its content is parsed at run-time. If HTML code is entered or pasted in this box, percent (%) and slash (/) HTML characters must be doubled, otherwise they will be disregarded.
l Application Password: Enter the client secret (key) for the Azure app. This value is static and cannot contain variables. 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 user's ID or email address. This value is dynamic and may include variables. l Use delegated permissions: Select this option to use delegated permissions instead of application permissions.
Processing and output The task uses the Microsoft Graph API to access OneDrive folders in the organization (subject to that organization's IT policies). The file is saved in the location specified, as the file name specified. When a communication error occurs while uploading a file to OneDrive, some temporary "~." files may remain on the server; however, these files will eventually be cleaned up automatically.
tasks, but no more. However, application permissions apply to all accounts in the organization: if the application has been granted permission to read emails, then that permission applies to all email accounts in the organization, and if it has access to OneDrive, it has access to all folders. Advanced properties To get access to the following properties tabs, right-click the plugin in the process and select Advanced Properties. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
comparability with SFTP I/O plugin versions earlier than 1.3. l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH). l FTPS: Select if the FTP server uses FTPS (SSL/TSL) Port Number Group l Use default port: Check to use the default port used by the protocol selected above. l Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available.
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. Print using a Windows driver Printing Using a Windows Driver Output tasks task lets you send a job to a local or network printer, using its own drivers. The printer does not need to be a PostScript printer.
l Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used. You may use a different variable, but you may not use a data selection. This information may be used for the printer’s banner page. l Job owner name: Enter the job owner name. You may use a PlanetPress Workflow variable. Note: This option is not functional when natively printing PDFs (without a PlanetPress Design document).
document to be associated with a Workflow printer queue (see "Associating PlanetPress Design documents and PlanetPress printer queues" on page 102). This also requires printer licenses, unless you have the “Optimized Output” add-on in your Connect license, which grants you the equivalent of PlanetPress Production in Connect Workflow. (Even then, “printer-centric” output requires a printer license.) For more information about printing see "About printing" on page 92. Input Any data file.
"PlanetPress Workflow printer queues" on page 94). In the All in One task or the Create Output task, on the Output Creation tab, select the Output Management Through Workflow option. The Print output file returned to the Workflow process will become the new job file. In the Printer Queue Output task, on the General tab, under Documents, select None to send the job file to the Workflow Printer Queue as-is. See also: "About printing" on page 92.
l Keyword: Cuts the job file after each occurrence of the specified keyword (string of characters). l Custom Trigger: Enter the code of the trigger that will be sent with the data to the selected Workflow printer queues. Note that this box is only enabled if None was selected in the General tab. l Add job information to the document: Includes the current "Job Info variables" on page 239 to the job output. This option is only available if a document was selected in the General tab.
Task properties Recipients Tab The fields on this tab are variable property fields, which means the values may change with each job at run-time. You can use any combination of text, variables and data selections; see "Variable task properties" on page 289. 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 Attach input job file: Select to attach the current job file to the email that the task sends. l Rename to: Check this option to rename the job file before attaching it to the email, and enter a name. You may use text, variables and data selections (see "Variable task properties" on page 289). l File: Select additional or more additional files to include as attachments. You may enter the file name directly and use text, variables and data selections (see "Variable task properties" on page 289).
Note: In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PlanetPress Workflow is running, so emails are not sent out automatically. To correct this, make sure to log on to Windows on the PlanetPress Workflow server using the same login that PlanetPress Workflow is using, and open Outlook before starting the PlanetPress Workflow services. You could also use a startup process to start Outlook before the rest of the services.
data may contain parentheses, you should use a Run Script action task (see "Run Script" on page 428) with a Strip() function to strip them out. l Message: Enter the content of the email message. This is a variable property box, so the text may be personalized using variables and data selections. Note that since this is a variable property box, its content is parsed at run-time.
Login Tab l Use Microsoft Outlook: Select to use Microsoft Outlook to send emails (and attachments). The host computer must be running Outlook, and PlanetPress must have access to Outlook. Emails generated by PlanetPress Workflow appear in the outbox before being sent by Outlook whenever it is set to send emails. l Use SMTP mail: Select to use Simple Mail Transfer Protocol (SMTP) to send the emails (and attachments).
Input Any data file. Processing and output The file is saved in the location specified, as the file name specified. 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.
l "DocuWare Download" below l "DocuWare Upload" on page 571 l "M-Files Download" on page 577 l "M-Files Upload" on page 580 l Therefore2Way (The manual for this plug-in is provided with the plugin's installer and is not available under the Workflow Help.) DocuWare DocuWare is an Enterprise Content Management (ECM) system that is widely used in industry. It provides mechanism for storing, versioning and sharing files across an organization. See https://start.docuware.
Installation This plugin is not installed with Workflow, but it is available for free to download from the Resource Center (help.objectiflune.com). After downloading the .PPK file, you will then need to import it into Workflow yourself. See . Once imported, the DocuWare Download plugin will appear in the Uncategorized category within the Plug-In Bar. To be able to use this plugin you need a working DocuWare installation and user account with appropriate permissions.
Right-clicking a field opens the contextual menu that allows to add variables, data and lookup functions (see "Data selections" on page 49), where available. DocuWare Server Enter the DocuWare Host address. For example https://mycompany.docuware.cloud Organization Enter registered Organization name. For example MyCompany Platform Enter the DocuWare platform. For example docuware/platform Username Enter the DocuWare login Username.
Download tab The Download tab provides the controls for defining the file to be Downloaded, included related index values. The plugin window is expandable, which helps to display all the information at once when field names are quite long. Note: You can use static text and/or Workflow variables, data and lookup functions in all of the fields on this tab. Right-clicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 49).
Note: The drop-down list display can be customized by entering a search string in the entry field atop the Field Picker box. This restricts the listed fields to just those containing the search string. l Value. Add the value to apply. You can add or remove search criteria using the following options: l Populate the table with all the available Index Field options at any time by selecting the Add missing fields ( ) button. If selected initially this will add all the available fields to the table.
variable. So using dwresponse as the variable name would mean that DocuWare Download searches for the local variable of that name. DocuWare Upload The DocuWare Upload plugin uploads a single file of any file type to a dedicated DocuWare CRM system with related index information. DocuWare is organized in so called "File Cabinets", where each cabinet can have its own, specific set of index fields. This plugin allows defining of the target File Cabinet and respective index values.
It has not been designed for parallellization in regards to internal resource usage, file and data access, or logged-on users. Output The output of this task is the unchanged Job File. Task properties Connection tab The Connection tab fields set the connection parameters. You can use static text and/or Workflow variables, data and lookup functions. Right-clicking a field opens the contextual menu that allows to add variables, data and lookup functions (see "Data selections" on page 49), where available.
Test Connection This button tests the connection details entered in the Connections tab. If a successful connection is made, then Connection Success will appear as the current status. When a successful connection is made a listing of all the available cabinets and fields for that login will be downloaded and stored locally, for use in the Upload tab. Once a connection has been established and the cabinet and file information obtained, the plugin will open upon the Upload tab when next plugin is next opened.
The File type entry is directly editable so your can enter your own file type, should it be missing from the list. Destination In order to upload a file the plugin needs to know to which File Cabinet it must be directed to. The details for this are all contained in this Destination frame. l File Cabinet: You can select a File Cabinet from the drop-down list if the Test Connection was run successfully. The plugin will have a list of available File Cabinets, extracted from the DocuWare server.
Note: The pick list display can be customized by entering a search string in the entry field atop the Field Picker box. This restricts the listed fields to just those containing the search string. l Value. Add the value to apply. You can use static text and/or Workflow variables, data and lookup functions. Rightclicking in the field opens the contextual menu that allows adding variables, data and lookup functions (see "Data selections" on page 49).
defined inside DocuWare. l Date values Any date values must be entered in unified UTC format. Generally allowed formats are: l l yyyy-mm-dd l yyyy-mm-dd HH:MM:SS Yes/No, True/False, 0/1 values: Such values may be entered as either "Yes", "1", "True" or "No", "0", "False". Any other value will raise an error. Also note that index names are case-sensitive. Note: Fields with empty values will not be saved when the OK button is pressed.
Plugin legal notices and acknowledgments Copyright © 2019 Objectif Lune Incorporated. All rights reserved. M-Files Download The M-Files Upload plugin downloads a single file from an M-Files system (see "M-Files" on the previous page). This Action plugin is not initially installed with Workflow. It is available for download on the Resource Center (help.objectiflune.com). After downloading the .PPK file, you have to import it into Workflow;see see Importing a plugin.
Connection Tab The plugin needs your M-Files Server's credentials and a Vault name in order to start communicating with the M-Files erver. l M-Files Server: Enter the address of the M-Files Server (e.g. https://mycloud.sample.com/mfiles). l Vault: Enter the name of the desired Vault. This is required. l Username, Password: Enter the user name and password that the plugin can use to send a login request to the M-Files Server.
l , Add and removeproperties. l , Change the order of the properties by moving them up or down. This is for convenience only; to the M-Files Server, this order is not important. l Validate properties and check for duplicates. Any properties that have already been defined higher up in the list are displayed in orange. Any properties that are not defined in the Metadata Structure for the selected Document Class are displayed in red. Note that values arenotvalidated. l Add missing 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. M-Files Upload The M-Files Upload plugin uploads a single file to an M-Files system (see "M-Files" on page 576). This Action plugin is not initially installed with Workflow. It is available for download on the (help.objectiflune.com). After downloading the .PPK file, you have to import it into Workflow; see Importing a plugin.
Connection Tab The plugin needs your M-Files Server's credentials and a Vault name in order to start communicating with the M-Files Server. l M-Files Server: Enter the address of the M-Files Server (e.g. https://mycloud.sample.com/mfiles). l Vault: Enter the name of the desired Vault. This is required. The uploaded file will be stored in this Vault. l Username, Password: Enter the user name and password that the plugin can use to send a login request to the M-Files Server.
should uniquely identify the document. When multiple documents are found, this will result in an error. l Index data: Specify properties that must be set in M-Files as metadata for the uploaded file. Any existing values will be replaced with the given value. l Field: Enter a property, or click the button between the Field and Value columns to select one of the properties defined for this particular Document Class in the Metadata Structure of the Vault on the M-Files server.
Input from SharePoint The Input from SharePoint task can be used to retrieve files from a SharePoint server on your network, filtering on your template fields and creating Metadata to use in your process. When the Input from SharePoint task runs, it first lists all of the files to download then runs the process once for each file in the list. If any new files are added during the process, they will not be touched until the next time the process is scheduled.
Task properties General Tab Note: For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab. l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. l Document Library: The document library where you want to retrieve the files.
l User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries. l Password: The correct password for the user name. "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.
Licensing This plugin requires the OL Connect Workflow Imaging license. Workflow Imaging is an add-on license bundle for OL Connect Workflow that includes the Image and Fax plugins; see "About PlanetPress Image" on page 279 and "About PlanetPress 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, with optional Metadata.
l Field Name: Name of the field as set in SharePoint Document Library. l Field Information: The information to enter in the SharePoint Document's Metadata for this field. l Use PDF/A: Check to use the information contained within an PDF. This PDF must have been created with PlanetPress Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library.
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. Email Services Email Services tasks send emails to an Email Service Provider (ESP) using the ESP's Web API. These OL Connect tasks are not initially installed with Workflow but they are available for download on the Resource Center (help.objectiflune.com). After downloading a .
l Add headers specifying specific handling instructions for your email. You could set an existing header like the Sensitivity or X-priority header (see https://tools.ietf.org/html/rfc1327), or create a custom header. Installing the plugin First unzip the contents of the ZIP file and then install using the wizard. Click Yes to replace any previously installed version of the plugin. 1. Open the Workflow Configuration tool . 2.
or a Connect File Store ID ("fileid"), for example: [{"fileid":100034, "disposition":"attachment"}] Optionally, you may provide a name ("name") to override the name that the plugin creates for an extra attachment. Examples: [{"fileid":100034,"name":"example.pdf","disposition":"attachment"}] [{"url":"file:///C:/Terms-and-Conditions.pdf","name":"terms.pdf","disposition":"attachment"}] All attachments should be combined in one array: [{"url":"file:///C:/Terms-and-Conditions.
l Headers (optional): A JSON object containing one or more key/value pairs of header names and the value to substitute for them:. For example: {"Sensitivity":"CompanyConfidential","X-Priority":"1"} If they contain Unicode characters, you must ensure that these are properly encoded. Custom header names normally start with "x-": {"x-my-header":"my-value"}. l Debug settings: l Send all messages to the Test Address: When this option is checked, Mailjet will only send the emails to the given Test Address.
documentation). Note that any other custom headers will not be processed. Only the asm header will be used. Input Extra attachments To specify an extra attachment, you have to use the key/value pair "disposition":"attachment". To let the plugin know where it can find the attachment, you can either provide a full path ("url"), for example: [{"url":"file:///C:/Terms-and-Conditions.pdf","disposition":"attachment"}] or [{"url":"http://www.example.com/image.
Properties General Tab l SendGrid API: l API Key: Enter your API key, retrieved from SendGrid. It will be used for authentication with the SendGrid v3 Web API. A valid key is required to send email messages. l Data Source (see "Input" on the previous page): l Categories (optional): Enter a single category name (e.g. invoice) or an array of category names (e.g. ["invoice","brand1"]) for the messages. The maximum length of each category name is 255 characters.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Legacy tasks The Legacy section of the Plug-in Bar contains the older deprecated plugins which aren't expected to be used in a modern Workflow, but have been retained for backwards compatibility. In some cases, a plug-in's name was changed when it was added to the Legacy section. In this case, the original name is shown in parentheses following the new name.
Add document Note: This plug-in has been moved to the Legacy group. The Add document action task prepares a printer-centric PostScript job by adding a PostScript version of a selected PlanetPress Connect document and the trigger to execute it before the active data file. For more information about printer-centric printing see "Printer-centric printing" on page 94.
The Create MRDX Action task is used to register a job on a SureTrac server using an MRDX file. The MRDX contains information about the job and its finishing, as well as integrity features use by SureTrac. This task requires a PDF file as an input, along with metadata generated through a document that contains PitneyBowes Scan Codes. Task properties General Tab l Register Job to the SureTrac Server group: Check this option to enable the group. l Server Name: The complete URL of the SureTrac server.
You can use Download to Printer action tasks to send various types of files, such as attachments, documents and fonts that are used in PlanetPress Design documents that are executed directly on the printers (see "PlanetPress Design documents" on page 42 and "About printing" on page 92). For images you should rather use Send Images to Printer action tasks (See "Send Images to Printer" on page 612), as they provide image quality and conversion options. Input Any file that you wish to upload to the printer.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Generic Splitter Note: This plug-in has been moved to the Legacy group. The Generic Splitter is a legacy task which is kept for backwards compatibility. In previous versions of PlanetPress Workflow, it was the only splitter available. While this splitter seems to have more options than the other ones, this is only because it contains combined features from these other splitters.
l A word: If you choose “A word” in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed: l Word: Enter the string of characters to search for as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. l Get: Click to get a static string of characters from the sample data file.
l A word change: If you choose A word change in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l Get: Click to select a search region. The coordinates of the selected region will be added to the Word is in line box and the Word is between columns group below. The Generic Splitter will look for changes in the string of characters appearing in that region. l Word is in line: Enter the line on which to search for the word change.
10 page file would be split in 4 files, the first three being three pages long and the last one only 1 page long. l l View data file: Click to view the sample data file and to cycle through the pages. A database field value: If you choose A database value in the Split data file on list box (the Use emulation option must be selected), the following box is displayed.
l A database field change: If you choose A database field change in the Split data file on list box (the Use emulation option must be selected), the following box is displayed. l Field name: Enter the name of the field that the Generic Splitter must check. If you enter “ID”, for example, the Generic Splitter will only look in the field named “ID” for the value entered below. In this variable property box, you may enter static characters, variables, job information elements or any combination of these.
Instead of using the HTTP Server Input task, you should consider using the NodeJS Server Input task which is more secure, more up-to-date and more standardized. For more information see: "NodeJS Server Input" on page 328.
XML file cannot be more than 400MB, which because of CDATA is reduced to around 200MB. To help in this situation, you may elect to omit from the attachment, which can be changed in HTTP Server Input User Options. Please note that incoming binary files (sent through file upload in a form) can never be larger than 400 MB. Processing Depending on the options chosen in the HTTP Server Input task properties, the task may choose to ignore some of the files.
l Do not include XML envelope: Only active when the previous Loop option is checked. When checked, the XML file containing the request data will not be available. Only the attachment itself is sent as a data file. l Respond on error: Enter a message to be sent to the client as the output file if the process encounters an error and is unable to send a reply that includes the actual output file. The information can be in any desired format such as HTML or plain text.
"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 PlanetPress Workflow Tools working folders under the "Backup" folder.
The Microsoft® Word® Documents to PDF Conversion action task can be used to convert a Word® document into a PDF file that can be used in your PlanetPress Workflow process. It can also do a Mail Merge as it runs the task. Caution: As of Microsoft Office 2010, running an Office application in a service context is no longer supported by Microsoft.
Processing The Word document is converted into a PDF file. If a Mail Merge is made, the mail merge is done in the document before the document is converted into a PDF file. The conversion is done through the use of a printer queue - the document is printed to this queue and the print job is converted to PDF. This is the same technique as used in the "WinQueue Input" on page 349 when generating PDF files. Output The output is either: l A PDF file accompanied with basic PDF metadata.
that no validation is made on SQL statements except if they are for Microsoft Access and Excel data files. You can use the Test Connection button to test the SQL and connection string. l Test connection: Checks if the Connection String and SQL Statement are valid, and if the resulting recordset is understood by the Microsoft® Word® document. This is optional, though highly recommended. l Output Type: l .
l You must have at least one printer using a PostScript driver on your system in order to produce PDF output. It is highly recommended that a PostScript printer be set as the default system printer in order to act as a fallback if the selected printer is unreachable. l PlanetPress Workflow Service must be configured with a user name and password that have access to the required printer(s). The Local System Account setting will not work. Input A data file compatible with a PrintShop Mail Document.
ard PostScript file that can then be sent to any PostScript printer. l l Select JPG to generate a JPG image file. Data file type: Select the data file type that is sent to this task, and used as a database for the PrintShop Mail document. l Distilling options file: Enter the name and path of a distilling options file (or "joboptions" file) or use the Browse button to navigate to that file. This option is only available when PDF is selected in the Output type box.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send Images to Printer Note: This plug-in has been moved to the Legacy group. The Send Images to Printer Action task is used to send images to a printer so they can be used as resources by PlanetPress Suite (Design) documents run on the printer. It is comparable to the Download to Printer Action task (see "Download to Printer" on page 596), but includes image specific options.
second one with a different Send Images to Printer action task with the scan orientation set to Top to bottom, each one typically being included on two different branches of the same process. l Color conversion: Select As is to keep the color information included in the images. Select Grayscale to convert color images to gray scale. l Naming convention: Select ’File name, original’ to store the file under its original file name.
XML format used to communicate among systems across different architectures, languages, and operating systems. A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol. The payload of the SOAP packet is an XML document that specifies the call being made and the parameters being passed. Web services, a SOAP class of applications, expose their services via the Internet in a manner that lets other applications access them, as well as use and combine them as required.
Note: The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l Get: Click to get the WSDL file from the SOAP server and populate the Service box below. l Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found.
l Username: Enter the user name for the authentication, if required. l Password: Enter the password for the above user name. l Allow invalid security certificate: Check to ignore SSL certificates that are invalid. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Action-EMF Converter (Windows Print Converter) Note: This plug-in has been moved to the Legacy group.
Task properties General Tab l EMF to XY group: Select this option if the file received by this task is a Windows print file. This will prompt the task to perform the first phase of the process, and thus convert the file to an XML file. If this option is not selected, the input file will not be converted to an XML file (note that the task will fail if the file it receives is not an XML file). The settings included in this group fine tune the process.
the first one's mean character width, multiplied by factor 1.0. The two text passages are found to not belong together. l Vertical distance: Indicates the biggest acceptable vertical distance between two text passages so that they're still recognized as belonging together. This is the factor the font's height and size is multiplied with. The value for the font's height therefore is taken from the corresponding font's attributes. For example, if the height of that font example in 10 point size is 0.32 cm.
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 230. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
Task properties General Tab l Document Origin: 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. This document does not need to be loaded as a data file or its Metadata manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database.
l Capture Field-based condition: Select to base the condition on the state of one or more fields of your document. l Field Name: The name of the field on which to base your condition. This is equivalent to the name of the Capture Field Object in PlanetPress Design. Note: In this field in particular, the right-click menu displays a unique option, 'Open Document Preview'. This option displays a list of existing documents.
l Pen Id: Triggered by the ID (serial number) of the pen. A box provides a way to specify which Pen ID will trigger this condition to be true. l Field List Value: Triggered only on Field List Capture Fields. A box provides a way to specify which value will trigger this condition to be true. l Content Status: Triggered when the field is in a specific status. A Drop-down provides a way to select which status will trigger this condition to be true.
l On each pages: The task will return true only if the condition set is true for all of the pages of the document. l Invert condition: Inverts the result of the task. 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. Capture-Fields generator Note: This plug-in has been moved to the Legacy group.
tab, to set it to stop the branch if any errors occur. This is to ensure that if such an error occurs most of your document sequences will get generated and you will not have to start the job over from the beginning. Processing The Capture Fields Generator action task uses an existing PlanetPress Design document containing Capture fields and assigns a unique Capture pattern to each printed page. The task then locks each pattern that it used so it cannot be reassigned to any other document.
l Output Format group l Continue process with optimized postscript (no metadata): The job file coming out of the task will be a PostScript file that can be sent to any postscript printer or saved locally. l Continue process with PDF (with new metadata): The job file coming out of the task will be a PDF with accompanying metadata for that PDF (previous metadata is lost).
Input This task requires a PGC file that has been obtained from an Anoto Digital Pen that was used to write on documents generated from the same PlanetPress Workflow installation. Processing The PlanetPress Capture Fields Processor action task receives and processes the information sent by the Anoto digital pen and updates all the documents in the PlanetPress Capture Database using the information from the pen. Any ink in the pen is added as an EPS (image) layer on the PDF inside the Capture Database.
l CapDocName: The name of the document as specified in the Capture Field Generator. l CapOpenDate: The date at which the document was created by the Capture Field Generator. l CapPatternSequence: The value of the pattern sequence assigned to the document.
l Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the Pattern Sequence to be used. l ICR Settings group l Perform ICR Recognition: Triggers the PlanetPress Capture ICR engine. For more information, see PlanetPress Capture ICR. l Engine Language: Define the language the ICR engine will use for text recognition.
Capture-PGC splitter Note: This plug-in has been moved to the Legacy group. The Capture-PGC splitter task can be used to separate each document into its own PGC file so they can be processed separately. The splitter then sends each document PGC to the next action, which should be the Capture-Fields processor task. Note that using the Capture-PGC splitter will cause your process to take more time, since each PGC must pass through the Capture-Fields processor and then the Capture-Get document task.
l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. l Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the pattern sequence to be used. Miscellaneous Tab The Miscellaneous tab is common to all tasks. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Task properties General Tab l Document ID: A variable data field that corresponds to the database ID of the document from which you want to retrieve ICR data. The Document ID is generated by the system through the Capture Fields Generator. The ID must correspond to a document in the Capture database, or the task will fail with an error. l Metadata Level: A drop-down list containing all of the levels of Metadata. Choose the one where the ICR data will be added.
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. Output The data file generated by this task is an XML structure containing the data about each document.
l Template name: The name of the PlanetPress Design document used to generate the Capture document. This is set in the document's properties, in PlanetPress Design. l Pattern ID: The exact ID of the Anoto Pattern used. This is also called "Pattern Trace Code". l Content Status: The status of the document as a whole. A document can be Empty (no ink), Partial (some ink but still open), Complete (all mandatory ink is present) or in Error (logical or process error).
l Older than: Date comparison, documents of which the date is older than the specified interval are included (Date Generated and Date Closed filters only). l Condition: The condition or value the document needs to meet. The condition is variable dependent on the chosen filter. It can be a drop-down of values, an alphanumerical or numerical value. l Add button: Click to add a condition row to the grid. l Remove button: Click to remove the currently selected condition from the grid.
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 625 or "Capture-Find document" on page 631 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.
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. This document does not need to be loaded as a data file or its Metadata manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database.
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. Processing The ink contained in the PGC file is converted into an EPS layer, which is then applied on an blank, empty PDF file of the size specified in the task's properties. If more than one Pattern ID is found in the PGC file, each separate Pattern ID will generate a new page on which its ink is applied.
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 Opening a configuration that contains additional plugins that are not installed on that system will cause these plugins to be replaced by Unknown tasks. Installing the additional plugins and reopening the configuration will restore the plugins and their properties.
l Plug-in: l "General and logging preferences" on page 656 l "Messenger plugin preferences" on page 658 l "HTTP Server Input plugin preferences 1" on page 658 l "HTTP Server Input plugin preferences 2" on page 662 l "LPD Input plugin preferences" on page 663 l "NodeJS Server Input plugin preferences 1" on page 664 l "NodeJS Server Input plugin preferences 2" on page 666 l "NodeJS Server Input plugin preferences 3" on page 666 l "Serial Input plugin preferences" on page 668 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 PlanetPress 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 PlanetPress 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 PlanetPress Workflow prompt for confirmation when deleting a document.
l No registry: Select to have PlanetPress 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 PlanetPress Watch 3 documents and job commands transfer: Select to have PlanetPress Workflow display a prompt when you import a configuration from PlanetPress Watch 3 that allows you to transfer documents and job commands.
l Prompt on Form Refresh: Select to have PlanetPress Workflow prompt for confirmation when recompiling the PostScript (PSx) version of a PlanetPress Connect Document. Refreshing PlanetPress Connect Documents that are currently in use can lead to unexpected results.
Preferences l NetWare Login: Check to enable the options PlanetPress 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 PlanetPress 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 PlanetPress 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 623 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 PlanetPress Workflow Service Console. Note: Each individual process has the option to produce 'minimal logs' (see "Process properties" on page 724). 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 PlanetPress Workflow service is started and stopped.
Messenger plugin preferences Apart from enabling communication between the various parts of PlanetPress Workflow, the PlanetPress Workflow Messenger also manages local instances of the PlanetPress Workflow Alambic. The Messenger service uses the SSL 2.3 protocol. Preferences l PlanetPress 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 PlanetPress 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 664. 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 662
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.
received by PlanetPress 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 PlanetPress 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 PlanetPress 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 658. 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 PlanetPress 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.
Note: If the Root Certificate and Certificate file are identical, this is considered a selfsigned certificate, which is considered unsecured by most browsers. For more information about certificates see: "Obtaining a certificate" on page 31. 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.
should consider changing the PlanetPress Fax user options on the computer that actually performs the PlanetPress Workflow Fax output tasks. The changes you make to the PlanetPress Workflow Fax plugin preferences are stored in the PlanetPress Fax configuration file. They will be applied when PlanetPress Fax is started. Preferences l Delete log after: Enter the number of days after which to delete the PlanetPress Fax service log.
will not be reported but an error will be logged. l Report Successes: Select to have PlanetPress Fax generate a report whenever one of the faxes in the PlanetPress Fax Job reaches its destination successfully or at least as far as the Windows Fax service is concerned. l Folder: Enter or select the location of the report file. PlanetPress Fax generates report file names automatically with the file name extension PFX.
l Expand folder paths in UNC (Universal Naming Conventions) format: Select to have PlanetPress Fax use complete network server path names (\\servername\sharename\path\filename). This naming convention works well with Windows operating systems, Novell NetWare, and other operating systems when using a local naming system (such as the DOS naming system in Windows) would result in “File not found” error messages. l Dialing options button: Click to set the appropriate options as required.
output, which in turn uses the FTP output service. Log files are kept in the Log folder, which is located in the PlanetPress Workflow installation folder. They are named ftpdate.log, where date is the current date in yyyymmdd numerical format. Note that changing this option also affects the log displayed in the PlanetPress Workflow Service Console. l Interval: Select the interval (in seconds) at which the FTP service is to dispatch jobs from the ftpPut folder to the FTP sites.
l Error file: When enabled, sends an e-mail with an attachment of the offending file when an error occurs in the PlanetPress Image output task. Additionally, a backup of the job is created in the Error folder, which is located in the PlanetPress Workflow installation folder. l Name or address not resolved: Select to send an email to the administrator when a name or address in the document selected to be used in PlanetPress Image cannot be resolved.
l Data source name: Enter the name of the computer on which the database runs. This option is available only when you select SQL Server database or Oracle database in the Database type box. l Use default database: Select to use the default database associated with your user profile on that SQL Server or Oracle database. Clear to enter the name of the database in the box that appears. l Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database.
l Email address: Enter the email address of the user sending the error messages to the administrators. l Reply address: Enter the reply address that recipients use to reply to the error messages. l Outgoing mail (SMTP): Enter the IP address of the server that PlanetPress Workflow uses to send the emails via SMTP. l Server requires authentication: Select if the outgoing server used to send the emails via SMTP requires authentication.
l Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service. l Error handling group l Max. retry period: Select the maximum time period, in hours, within which PlanetPress Workflow attempts to dispatch the job using the LPR output before giving up. Note that entering a maximum retry period of 0 hours disables retries altogether.
Editor Options The Script Editor is used to edit scripts used in Run Script tasks and the XSLT Editor is used to edit scripts used in Open XSLT action tasks (see "Using Scripts" on page 117 and "The Script Editor and XSLT Editor" on page 118). There are a number of options for the editors, which you can set via the menu: Tools > Options, in the editor. Most of the options listed below are valid for both editors. Those options which are only valid for a specific editor are identified as such.
or a press on any other key. A group of editing commands is a sequence of a single type of editing command. Clear to set the undo feature to undo only the last command entered. l Cursor beyond EOF: Select to make it possible to position the pointer beyond the end of the program file. Clear to prevent this. If you clear Insert mode and select Cursor beyond EOF, you can only overwrite the existing lines of the program; you cannot add lines to it.
l Block indent: Enter the number of spaces to jump for each block indent. The default is 2 and the maximum is 16. The Block indent typically should agree with the tab stops in the Tab stops option. Perform a block indent by selecting a region of code and pressing CTRL+SHIFT+I (to indent the code to the right) or CTRL+SHIFT+U (to move the code to the left). l Tab stops: Use to set the number of spaces to advance when you enter a tab character or to set a series of tab stops.
l Gutter: Select to have the Editor display a gutter between the Commands and Code areas. Use the Gutter width option to set the width of the gutter. Select the Line numbers on gutter option to display line numbers in this area. l Gutter width: Enter the width, in pixels, of the gutter. Use the drop-down list to select a previously-entered gutter width. l Line numbers on page: Select to display code line numbers at the left edge of the Code area.
l Underline: Select to underline the element highlighted in the Element list box when it is displayed in the Script Editor. The user interface This chapter centers on the PlanetPress Workflow Configuration program, which you use to create and edit your configurations. The basic user interface elements are as follows: l "PlanetPress Workflow Button" on page 691. l " The Quick Access Toolbar" on page 745. This toolbar is customizable.
Customizing the Workspace You can combine and attach the Configuration Components pane, Messages area and Object Inspector into a single secondary window that can be docked to and undocked from the main PlanetPress Workflow Configuration program window. Combining and attaching areas can facilitate the management of your screen real estate. It lets you reposition multiple areas in a single operation.
The Configuration Components pane, the Object Inspector and the Messages area can each be displayed inside its own window, whether docked or undocked, but they can also be displayed attached or combined inside the same window. l When separate areas are displayed simultaneously, they appear in different sections of the Program window. l When attached areas are displayed simultaneously, they appear side-by-side or above one another inside sub-windows.
A "highlighted" (orange) button means the area is displayed somewhere on your screen(s). A dim (blue) button means the area is hidden. Note: The Process Area is always visible and cannot be hidden. Combine and attach areas The Configuration Components pane, the Object Inspector, and the Messages area can be attached or combined to one another and share the same space. However they are displayed, you can always drag, dock, or undock any area as desired.
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. Image: Dragging a combined area to new position.
3. Resize each part of the new group as desired. Image: Attaching an area to a group of combined areas. The rectangle showing the landing position is not tabbed and the area will therefore be moved next to the combined area. Maximize or restore attached areas To maximize or restore attached areas, do one of the following. l To maximize a vertically attached area, click the upward pointing arrow on its title bar.
Image: A) Click to maximize this area. B) Click to restore this currently maximized area.
Image: C) Click to maximize this area. D) Click to restore this currently maximized area. Taking an attached area out of a group To take an attached area out of a group, do one of the following: l 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.
Note: If you plan to enter and process information in non-European languages, you should know that PlanetPress Workflow uses codepages when storing and retrieving information (a codepage is a mapping used to convert back and forth the letters and numbers used by humans to the numeric characters used by computers).
l Recent Documents: Displays a list of the 9 most recently opened configuration files. Click on any of them to open it. l Select Language: Click to display the language selection dialog, which changes PlanetPress Workflow interface language. See " Change the Interface language" on page 690. l Preferences: Displays the Options dialog. See "Preferences" on page 638. l Exit: Closes PlanetPress Workflow. See " Exit PlanetPress Workflow Configuration program" on page 37.
l Subprocesses: Displays a list of subprocesses in your configuration (see: "About processes and subprocesses" on page 105). Right-click on a subprocess to access a drop-down menu that offers these choices: l l Insert Subprocess: Inserts a new subprocess with a default input and output task. 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 subprocess from the configuration.
l Sample Data File(s): Displays a list of sample files that are included in the data mapping configuration. Double-click on a file to use it as a sample data file for the active process. l Document Templates: Displays a list of templates that can be used in content creation tasks: "Create Email Content" on page 502, "Create Web Content" on page 518 and "Create Print Content" on page 515. l Job Presets: Displays a list of Job Presets that can be used in the "Create Job" on page 506 task.
l PS Test Page: Prints a test page in PostScript format. Useful for validating whether the printer supports PostScript. l Text Test Page: Prints a text-only test page on the printer. l Properties...: Displays the printer queue properties. Note: Deleting a component that is currently used by a process will cause this process to stop working and trigger an error, until the task that causes the error is removed, or changed to point to another existing component.
l Version: The version of PlanetPress Workflow in which the document was originally created. Printer-resident documents are identified as such. l Document name: The name of the document as entered in PlanetPress Design. You can enter a name for printer-resident document here; the name does not have to match the name given it in PlanetPress Design.
l Document Update group (enabled only when using printer-centric mode and the document is on the printer) l Automatically update: PlanetPress Workflow will send a new version of the document to the printer automatically if the document has been changed since it was last used. If unchecked, you will have to manually update the document on the printer from the Update Instances button or by sending the document to the printer from PlanetPress Design.
Prohibited mouse pointer Moving Configuration Components You can move components in the Configuration Components pane in a number of ways; see below. Note that moving a configuration component does not change the order in which the components are used. However they can affect your process if, for example, you move a local variable from one process to another and the local variable is still used in the first process.
Using the keyboard shortcuts l Click on the component you want to move. l Do CTRL+X (cut) on your keyboard. l Click on the new location where you want the component. l Do CTRL+V (paste) on your keyboard. Copying components You can make a copy of any component in the Configuration Components pane, except resource files (of which you can only have one copy).
To rename a PlanetPress Design printer-resident document: 1. In the PPD/PSM Documents section of the Configuration Components pane, double-click a printer-resident document. The PlanetPress Design Document Options dialog box is opened. 2. In the Document name box, enter the new document name and click OK. Reordering objects in the Configuration Components pane There are multiple ways you can reorder objects in the Configuration Components pane.
Items or processes, and groups, can only be grouped within their own category. Thus you can only group processes with other processes, resource documents with other resource documents, and printer queues with other printer queues. In the resource documents category, you can only group documents with others of the same version and type. For example, you can only group documents from PlanetPress Design (files with a PTK extension) with other PTK files, not with printer-resident documents.
Expanding and collapsing categories and groups in the Configuration Components pane You can expand and collapse the Processes, Global Variables, PPD/PSM Documents and Printers Queues categories, and groups, in the Configuration Components pane. To do this, click the Expand / Collapse button to the left of the item. Deleting something from the Configuration Components pane To delete a process, document, or printer queue: l Click a process, document, or printer queue, then press the Delete key.
The Access Manager dialog box is displayed. It lists all IP addresses and IP ranges that have PlanetPress Connect modules installed in the same network. 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 127.0.0.1: The local computer. Typically this IP should have all the accesses checked. l 255.255.255.255: Everyone on the same subnet. This is equivalent to hard-coding the current subnet, such as 192.168.1.255 or 10.0.0.255. l 192.168.0.42: A single IP address. This can be any valid address on the same subnet. l 10.0.255.255: Any IP in the 10.0.X.X range.
l HTTP, FTP and SOAP communication is not limited to the local subnet on any version where these plugins appear. l Any change to the Access Manager requires a restart of the Messenger server which can be done in "The PlanetPress Workflow Service Console" on page 749. Modifying permissions Permissions are given simply by adding and removing options in the permission grid.
Adding a new SOAP user To add a new SOAP user: 1. Click on the button. 2. Enter the following information under the Username column for the new entry that was created: l User name: An alphanumerical user name for the user. l Password: A password to protect the user. Note that the password will always revert to ******** (8 stars) when clicking outside of this box - that is normal and is meant to protect the length of the password as much as its contents.
3. Define the permissions for the user (see below). 4. Click OK to save the changes. Defining or changing permissions The Permissions section of the SOAP tab displays all of the processes that are available in the live configuration (the one that the PlanetPress service uses). To change or define the permissions for a SOAP user: 1. In the top Username section, click on the user name of which to modify permissions. 2. Place a checkmark in each process that the user should have access to. 3.
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. The XML nodes in the file are equivalent to those in the Access Manager: l : Grants access to the remote computer to send new or updated PlanetPress Design Documents to this server.
l Printer Name (Optional): Name and/or model of the printer. l Comments (Optional): Comments about the printer. The following buttons are available in this dialog: l Add: Brings up the Printer Activation dialog. This dialog lets you enter the information for the printer (see previous section), then click OK to save the new activation. l Delete: Removes the currently selected activation from the list. l Web Activation: Click to access the online activation manager on our website.
task will trigger an error. l Test SQL button: Verify the SQL statement's validity. Data Repository Manager The Data Repository Manager is an interface that manages the PlanetPress Workflow "Data Repository" on page 80. This feature, introduced in version 8.5, is a persistent data store used to save any sort of textual data in a table format. Accessing the Data Repository Manager To access the Data Repository Manager: l Open PlanetPress Workflow l Go to the Tools tab.
l Delete Key: Click to remove the currently selected key in the group. This will remove the key and all the data for this key in each existing key set. Warning: This action cannot be undone. l Key Set section l Add Key Set: Click to add a new key set to the currently selected group. Displays a dialog with all the keys in the group, asking for a value for each of the keys. Enter the values then click OK. The key set will display in the right part of the repository manager.
l mm = two digits of minute (00 through 59) l ss = two digits of second (00 through 59) l s = one or more digits representing a decimal fraction of a second l Z = literal constant representing the UTC time zone designator. Repository structure pane This section of the Data Repository display a tree view of all groups in the data repository as well as all the keys under each of those groups. l To add, delete or edit a group, use the contextual menu (right-click).
l Press Delete to remove a group or key from the Repository, or a key set from the Key Sets pane. Tip: You can look up these shortcuts by right-clicking the item you want to interact with, and looking at the contextual menu. The Data Selector The Data Selector is the tool you use to choose your sample data and Metadata files, to select the appropriate emulation, to make data selections, and to stabilize your data.
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 598) 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.
PlanetPress 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 PlanetPress 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 systemlevel 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 Date/Time: This type may contain a date and time. 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 PlanetPress 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.
Printer utilities Printer Utilities are options for customers using "PlanetPress Design documents" on page 42. 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 PlanetPress 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 478 l "Input from SharePoint" on page 583 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 49) and the Data Repository Manager (see "Data Repository Manager" on page 710). Wildcard parameter Expressions may contain metadata/data selection functions (see "Data selections" on page 49).
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 PlanetPress 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 OL Connect; see "OL Connect tasks" on page 494. l Document Management; see "Document Management tasks" on page 565. l Outputs; see "Output tasks" on page 545. l Legacy; see "Legacy tasks" on page 594. Note: An Uncategorized category is dynamically created if your PlanetPress 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 745 l "Redo a command" on page 743 l "Highlight a task or branch" on the facing page l "Collapse and expand branches and conditions" on page 744 l "Resize the rows and columns of the Process area" on page 744 l "Zoom in or out within the Process Area" on page 745 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 s
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 745). 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 PlanetPress Workflow Configuration preferences (see "Colors" on page 640). 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.
Moving a task or branch using drag-and-drop To move a task or branch using drag and drop: 1. In the PlanetPress Workflow Process area, click the icon of the task or branch you want to move. 2. While holding down the mouse button, drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item. The dropped task or branch is moved above the item over which it was dropped. When you move a branch, all its tasks are also moved.
When you remove a branch, all the tasks located in that branch are also deleted. When you delete a task, only that task is deleted. 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 637). To delete the path below a branch crossing (instead of the path to the right of the branch): l Press Shift+CTRL+Delete.
A collapsed Branch or Condition can be expanded at any time. When expanding any branch, all its subbranches will be expanded as well automatically. 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.
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 105).
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 PlanetPress Workflow installation. This feature is specific to PlanetPress Suite. l The Virtual Drive Manager control loads the "Virtual Drive Manager" on page 734. This feature is specific to PlanetPress Suite.
l The Text Test Page control allows to print a raw text test page for the selected printer queue. If no printer queue is selected in the Configuration Components pane, the control is disabled. 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.
1. Right-click on the running service. 2. Click on Stop. If the service is currently processing a file (if a process is running, output is being generated, job being received, etc), the service will wait for this action to complete before stopping. To pause a service temporarily: 1. Right-click on the running service. 2. Click on Active to remove the checkmark. If the service was currently processing a file, the service will wait for this action to complete before pausing.
3. Click on the log file and click Open. The log file is added, by name, at the end of the list of PlanetPress 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. The display of the sessions, processes and tasks is the same.
l c3p0 which is licensed under the terms of the Lesser General Public License (LGPL) Version 2.1. The source code can be obtained from the following location: https://github.com/swaldman/c3p0 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.
l JavaX Mail which is distributed under the terms of the Common Development and Distribution License (CDDL) Version 1.1. The source code for this can be obtained from the following location: https://java.net/projects/javamail/downloads/directory/source 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.
l Saxon which is distributed under the terms of the Mozilla Public License (MPL) Version 2.0. The source code for this can be obtained from the following location: http://sourceforge.net/projects/saxon/files/Saxon-HE/9.6/ 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.
l Apache ActiveMQ l Apache Batik 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 PO
l Jackson JSON processor l Jetty 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.
Java SE framework and platform: This application uses the Java SE framework and platform which is distributed under the terms of the 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.
