-
User Guide Version: 2018.
-
-
User Guide Version 2018.2 Last Revision: 2019-01-29 Objectif Lune, Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 +1 (514) 875-5863 www.objectiflune.com All trademarks displayed are the property of their respective owners. © Objectif Lune, Inc. 1994-2019. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc. Inc. Objectif Lune Inc. Inc.
-
Table of Contents Table of Contents 4 Welcome to PlanetPress Workflow 2018.
-
Exit PlanetPress Workflow Configuration program Workflow Configuration resource files Connect resources PlanetPress Design documents PrintShop Mail documents About data About documents and variable data Job file Job file names and output file names Data selections About data emulation Sample Data Metadata Working with JSON Data Repository Structure Accessing the Data Repository Where to find the Data Repository Debugging and error handling About error handling Using the On Error tab Creating and using Error
-
Objectif Lune Printer Driver (PS) About processes and subprocesses Processes Startup processes Subprocesses Creating a process Importing processes Activating or deactivating a process Process properties About branches and conditions Converting a branch to a subprocess Running a process on desktop Saving and sending a Workflow Configuration Using Scripts Run Script task APIs The Script Editor and XSLT Editor SOAP Server API Reference The Watch Object Data Repository API Stopping execution Special workflow ty
-
Metadata Tasks OL Connect Send OL Connect tasks Output Tasks Unknown tasks About variables Job Info variables Standard variables Local variables Global variables Variable task properties Special workflow types PlanetPress Capture About PlanetPress Fax About PlanetPress Image Workflow processes in a Connect Send solution ZUGFeRD About related programs and services Available Input services Available Output services Start and stop PlanetPress Workflow Service Users and configurations Workflow Services The user
-
Renaming objects in the Configuration Components Pane Reordering objects in the Configuration Components pane Grouping Configuration Components Expanding and collapsing categories and groups in the Configuration Components pane Deleting something from the Configuration Components pane Dialogs Access Manager Activate a printer Advanced SQL Statement Dialog Data Repository Manager The Data Selector The File Viewer Data Selector display preferences PDF Viewer Process properties Update document Virtual Drive Ma
-
PDF text extraction tolerance factors General and logging preferences Messenger plugin preferences HTTP Server Input plugin preferences 1 HTTP Server Input plugin preferences 2 LPD Input plugin preferences NodeJS Server Input plugin preferences 1 NodeJS Server Input plugin preferences 2 NodeJS Server Input plugin preferences 3 Serial Input plugin preferences Telnet Input plugin preferences PlanetPress Fax plugin preferences FTP Output Service preferences PlanetPress Image preferences LPR Output preferences
-
Legal Notices and Acknowledgements 743 Page 10
-
Welcome to PlanetPress Workflow 2018.2 This PDF documentation covers version 2018.2. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow is the heart of all of our solutions.
-
Warning Information that is potentially critical to using PlanetPress Workflow. Technical Background information.
-
Installation and setup This chapter describes the different considerations that are important in regards to the installation and use of PlanetPress Workflow. l "System Requirements" below l "Environment considerations" on the facing page l "Setting up the working environment" on page 17 l "Known Issues" on page 21 System Requirements These are the system requirements for PlanetPress Workflow 2018.2.
-
l 8GB RAM (16GB Recommended) l Disk Space: At least 10GB (20GB recommended) Environment considerations This page is intended to provide technical information about the environment in which PlanetPress Workflow is intended to run. Terminal Services PlanetPress Workflow does not support Terminal Services environment as possible under Windows 2000, 2003 and 2008.
-
may work, and they are properly detected by PlanetPress Suite 7.5.1 and higher, we have not tested them and cannot offer support for them. Warning The 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.
-
Warning Disabling any antivirus scanning permanently on any folder or program is not recommended, and Objectif Lune cannot be held reliable for any consequence of disabling your antivirus or whitelisting the folders or executables listed here, or any other change in your antivirus protection setup! l On Windows 7/2008: l l l l C:\Users\planetpress\AppData\Local\Temp\ (where planetpress is the user under which Workflow is configured) C:\Users\planetpress\Connect (where planetpress is the user under whic
-
Microsoft Office compatibility The Microsoft Office 2010 line of products, other than Pro and Enterprise, has not been certified for use with PlanetPress Workflow. Some of its products may not be compatible with the connectors included in the Suite. Setting up the working environment After installation, the working environment needs to be set up before you start using Workflow. This involves: l l l Configuring PlanetPress Workflow Services (see "Workflow Services" on page 674).
-
associated with the selected account (except for PlanetPress Messenger Service which always runs on the Local System account). When you are running PlanetPress Workflow Configuration program on a workstation, if it is associated with an account that is different from your account, the following icon is displayed in the lower right corner of PlanetPress Workflow Configuration program: .
-
Network ports used by each service The port configuration for each PlanetPress Workflow component is described in the following table. The port number assignments comply with Internet standards. If PlanetPress Workflow component is not active, the port is not used.
-
Component Protocol Local Port Remote Port Send to Folder Windows Queue Output TCP Default1 Standard Windows file and printer sharing ports2: l l 137, 138 and/or 139 (NetBIOS over TCP/IP (NetBT)) 445 (SMB Over TCP/IP) LPR Output TCP Default or 721 to 7313 515 PlanetPress Database TCP or UDP Unknown4 Unknown4 SNMP Condition UDP Default1 161 1 Value is greater than 1024 and is assigned by Windows XP. This is the default. 2 Windows NT 4.
-
Known Issues Microsoft patch causing handling of XLS to fail Some recent Windows updates from Microsoft have impacted the handling of XLS sources in PReS\PlanetPress Workflow 8. The Microsoft updates concerned are as follows: l KB4041693 for Windows 8.
-
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. Other known issues l l l l l l l l l Anoto Pen Director 2.8 is not supported on Windows Server 2012 and Windows 10. 22356: Using the PT-PT setting to perform ICR on AlphaNumeric fields may not work properly.
-
l l l l l l When the PlanetPress Capture database is set to MS Access, it is considered good practice to have a single process generate Patterns for documents because the Access engine may lock the other process out of the database as the first process updates it. After the initial installation, the PlanetPress Workflow Configuration tool may display an error message the first time you launch it if you had already sent a PlanetPress Workflow Document to it.
-
l l l l l l The WordToPDF task relies on MS-Word to perform its functions. However, MS-Word sometimes displays confirmation dialogs when it encounters a situation requiring user input. Such dialog windows cannot be displayed when PlanetPress Workflow runs as a service. As a result, the process may seem to hang because it is awaiting user input on a window that isn't displayed. The only way to resolve this situation is to kill the PlanetPress Workflow service.
-
Server™ 2003) or Symantec WinFax PRO, as well as via a faxing server, such as Captaris RightFax. Note that it is these applications that do the actual faxing. l l 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. 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).
-
The generated files can be archived and, depending on whether you use a PlanetPress Image Output task or a Digital Action task, sent via email. Note that you can use PlanetPress Search, another program included in PlanetPress Workflow, to search through archived PDF files. Note All raster images, such as GIFs or JPEGs, generated by PlanetPress Image are portrait oriented.
-
Basics PlanetPress Workflow is a tool to automate the processing, distribution and printing of your business documents. Once installed on the server, it can be set up to automate all tasks related to document processing (see "Setting up the working environment" on page 17). When you're all set up, you can start using the Workflow Configuration tool, assuming that you have already done research on the processes that need to be automated. Working with Workflow implies the following basic steps: 1.
-
The product-specific files need to be sent to, or imported into, Workflow before they can be used in conjunction with a task (see "Workflow Configuration resource files" on page 35). They become visible in the "Configuration Components pane" on page 630.
-
Features PlanetPress Workflow are input driven applications designed to output data in a variety of ways through diverse means to various applications and devices. PlanetPress Workflowcan be used as simple go between, passing along input data to output devices, but it can also perform various types of data processing. You can combine the various PlanetPress Workflow services to set up versatile automated processes to print jobs as well as generate other types of output.
-
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.
-
If a file that is different from the default configuration file is currently opened, and if it includes unsaved modifications, PlanetPress Workflow asks you whether to save the configuration before creating the new configuration. Select the Always save without prompting for confirmation option to automatically save any unsaved work.
-
Saving a configuration file never replaces the current PlanetPress Watch service configuration. To do this, you must use the Send Configuration command. When the PlanetPress Workflow Configuration program sends a configuration, the PlanetPress Workflow service is stopped and restarted, if it is currently running, and the new configuration starts being applied immediately.
-
Note .OL-workflow files are equivalent to .pp7 files made with older versions of PlanetPress Workflow. They contain the processes and such used by Workflow. If the PlanetPress Workflow Service is running when you send a new configuration, it stops and restarts automatically with the new configuration. If the service is stopped before sending the configuration, it will not restart automatically.
-
Note If PlanetPress Workflow service is paused when you send a new configuration, it will not stop and restart. Since PlanetPress Workflow service reads its configuration file when it starts up, when you resume processing, PlanetPress Workflow service will continue using the old configuration. Exit PlanetPress Workflow Configuration program Once you are done using the PlanetPress Workflow Configuration program, you can close it.
-
configuration before exiting. Select the Always save without prompting for confirmation option to automatically save any unsaved work before exiting. Workflow Configuration resource files Workflow serves as automation tool in a number of distinct products.
-
Tip Double-click on a sample data file to use it as a sample data file for the active process. l l l Document Templates: Templates can be used in content creation tasks: "Create Email Content" on page 500, "Create Web Content" on page 518 and "Create Print Content" on page 515. Job Presets: Job Presets can be used in the "Create Job" on page 504 task to filter and rearrange print content items. Output Presets: Output Presets contain settings for Print output.
-
Tip You can import multiple files at once. Resource Save location Any resource sent to PlanetPress Workflow from PlanetPress Connect is saved locally at the following location: %PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\OLConnect Resources are saved in their appropriate folder: l DataMapper contains the data mapping configurations (.OL-datamapper) l JobCreation contains the Job Presets (.OL-jobpreset) l OutputCreation contains the Output Presets (.
-
The archives are saved using the template named followed by a timestamp. A maximum of 30 of each instance of a resource is kept (meaning if you have 10 different templates, a maximum of 300 files will be present in the archive\template folder). Older archives are deleted automatically as new archives are created. Using Connect Resources in tasks A number of OL Connect tasks (see "OL Connect tasks" on page 494) let you select a Connect resource file to be used with the task.
-
Note Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file. Clicking Cancel instead of OK after viewing will prevent this action from being taken. Saving an attached data file to disk 1. Make sure the Connect Resources section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Right-click on the data file, then click Save sample data file.
-
Printer-centric printing PlanetPress Design lets you send documents to printers as well as to PlanetPress Workflow servers. l l l If you send a document to printers only and not to any PlanetPress Workflow server, you will not be able to see this document in the PlanetPress Workflow Configuration program.
-
2. Enter the document’s name. Note that the name you enter must exactly match the actual document name or PlanetPress Workflow will not be able to use it on the printer or remote PlanetPress Workflow server. 3. Click OK. Importing PlanetPress Design documents This procedure describes how to import PlanetPress Design documents into PlanetPress Workflow. Importing documents can be useful when transferring configurations between PlanetPress Workflow installations.
-
1. Make sure the PPS/PSM Documents section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Right-click on the data file, then click Set as sample data file. Viewing an attached data file 1. Make sure the PPS/PSM Documents section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Double-click on the data file to open the data selector (see "The Data Selector" on page 658).
-
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.
-
The PlanetPress Workflow Configuration tool lets you view a number of the properties associated with the PlanetPress Design documents you use, but most of those properties are set in PlanetPress Design and cannot be edited using the PlanetPress Workflow Configuration program. The Document name of printer-resident documents can be changed using PlanetPress Workflow Configuration program simply because it is initially set using that program.
-
About data Data is what drives your business, and our software. We define data as anything that is obtained through an Input task and used within the process itself. Once the data is obtained, it becomes the job file that is passed from one task to another and generally used to generate output (see "Job file" on the facing page). Data can be manipulated using the tasks in the process, used as comparison for conditions and loops, complemented with data from other sources, and used to generate your output.
-
In PlanetPress Suite, Design documents are typically associated with an Output task. PlanetPress Workflow dispatches captured data (the job file) to PlanetPress Design documents directly. It is therefore critical that a process and a document use the same emulation (see "About data emulation" on page 54). PlanetPress Suite users are advised to review the PlanetPress Design User Guide, especially the Selecting an Emulation section.
-
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. l l If the job file comes to a branch in the process, PlanetPress Workflow makes a copy of the job file and gives the new file a new job file name.
-
or TIFF files are generated (one image per file), each one identified by a sequence number appended to its name (this is managed by your PlanetPress Workflow). A three page job to be called Invoice, for example, will 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 341).
-
After opening a sample of the data (see "Choosing a sample data file" on page 65) and/or Metadata, you can easily make a selection. It is also possible to manually enter a data selection, or to change it after making a selection with the mouse pointer. Data selections can also be used in a PlanetPress Design document that is being merged with the data (for example in a printed output); for more information, see PlanetPress Design User Guide.
-
l l @(): Always surrounds a data selection. Page Number: The data page number from which you want the data selection to grab the data. If you want to get data from each page individually, this has to be done after a splitter. l From Line: The starting line of the data selection. l To Line: the last line of the data selection. l From Column: the leftmost character position of the data selection. l To Column: the rightmost character position of the data selection.
-
l l Case Option: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent. l LowerCase: Converts all letters to their lowercase equivalent. Trim Option: Can either be "Trim" if you want to trim empty spaces before and after the data selection or "NoTrim" if you want to retain the extra spaces. Data Repository lookups The Data Repository selections are made through the lookup function.
-
Syntax region(page, left, top, right, bottom, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l region(): Always surrounds PDF data selections. l Page: The page of the PDF from which to retrieve the data. l Left: Exact horizontal position (in inches) that defines the left of the selection region. l Top: Exact vertical position (in inches) that defines the top of the selection region.
-
l l GetMeta(): Always surrounds metadata selections. Field/Attribute Name: specifies the name of the field (or attribute, if the GetAttribute option flag is set) to retrieve (see "Metadata" on page 69). l Option Flag (optional): Sets the options for the selection (see table below). l Metadata Path (optional): Defines the precise path where the Metadata Field is located.
-
XML data selections XML data selections are used to retrieve an element's name, value or count from an XML file. Syntax xmlget(XPath[, Value option, Case option, Trim option]) Here is a breakdown of the syntax: l xmlget(): Always surrounds a data selection. l Value Options: l l l Count: The number of elements on the same level in the same node that have the same name. l Name: The element's name. l Value: The element's value.
-
A process's emulation can be changed either by choosing another sample data file (see "Choosing a sample data file" on page 65) or by inserting a "Change Emulation" on page 304 task in the process. Changing the emulation is particularly important if you want to make a data selection in a file after it has been changed to another format (see "Data selections" on page 48). Note Even during debugging, selecting a sample data file with a different format will cause the emulation of a process to change.
-
Pages in buffer: Enter the number of data pages you want the data page buffer to contain, or use the spin buttons to increment or decrement the value. Read in binary mode (ASCII emulation only): Select to read the data file in binary mode. You select this if you intend to run a PlanetPress Design document on a printer queue that is set to binary mode. In binary mode, the printer reads the end of line characters (CR, LF, and CRLF) as they appear in the data stream and does not perform any substitution.
-
because it uses PlanetPress Talk code, which is not available within the PlanetPress Workflow Configuration program. The emulation that is used in your process can change during the process, and can be different than the one used in any PlanetPress Design document used in your process. PlanetPress Design Documents use their own emulations, as defined in the document itself from PlanetPress Design. For more information about emulations in PlanetPress Design see PlanetPress Design User Guide.
-
ASCII emulation options l Tab on carriage return: Select this option to fix formatting problems caused by isolated CR characters found within the data. When this option is selected, isolated CR characters are spaces, as defined in the Number of spaces in the tab box below. Note that this option is available only when the Read in binary mode option is selected.
-
CSV emulation options l l l l Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the data is split into two fields. If you want to use a backslash character (\) as a delimiter, you must precede it with another backslash character (thus you would enter \\).
-
Note You can also use the PlanetPress Workflow Database Action task to get data from a database, and output in multiple different formats such as CSV. See "Database Query" on page 314. Bear the following in mind: l l l l The person or plugin performing the query must have full access to the database. The data is extracted at the time of the query. A new query must be performed whenever the data needs to be updated.
-
Note Line printer emulation is only used when merging line printer data with a PlanetPress Design document. When choosing a line printer sample data file to be merged with a Connect template, select Text emulation (see "Text-based emulation" on the facing page). Line printer emulation options The line printer emulation does not have any options other than the general text-based emulation options (see "Text-based emulation" on the facing page).
-
Text-based emulation Text-based emulations display your data in plain text in the Data Selector and the Data Pane, one line at a time, up to the limit you specify in the emulation properties (by default, 66 lines). This is especially useful for legacy systems (such as AS/400 computers) that send data as text meant for older line printers using pre-printed forms. The emulation options are used to make sure your data is stable.
-
Note for PlanetPress Suite users: You should also consider using the N-Up Object if you want to display multiple data pages; see thePlanetPress Design user guide. l l l Cut on FF character: Select to have a new data page when a form feed character is encountered in the data stream. If you select the Cut on FF character option, there are two conditions that signal the end of a data page: the form feed character and the number of lines set in the Lines per page option.
-
XML emulation options l Cache XML data: When this option is selected, 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. 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.
-
emulation of a process to change. In order to avoid errors, change the emulation back to the format of the original input file before using the process again. Choosing a sample data file In order to create your PlanetPress Workflow process, the sample data you are going to use has to correspond precisely to the job files that will be treated by that process, at least in terms of structure.
-
Tip Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file. Clicking Cancel instead of OK after viewing will prevent this action from being taken. Choosing a database sample file To choose a database sample file: 1. Open the Data Selector (see "The Data Selector" on page 658). 2. From the Emulation drop-down list, select Database. 3. Next to the Sample data file field, click the Configure Database button. 4. Associate a database.
-
5. Click Edit SQL to create the SQL query by hand to define the SQL query that retrieves the data your document requires. 6. Set the properties that define a record set: l l l Condition: Select the condition that signals the end of a record set. Three possibilities exist: create a new record set for each record, create a new record set after every x records, or create a new record set when the value of a specific field changes.
-
Alternate syntax(not recommended): Select to prevent PlanetPress Design from automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the advanced SQL Statement dialog box. 6. Client side cursor: Select to download result sets to client computer running the SQL query.
-
Note You can also use the PlanetPress Workflow Database Action task to get data from a database, and output in multiple different formats such as CSV. See "Database Query" on page 314. Bear the following in mind: l l l l The person or plugin performing the query must have full access to the database. The data is extracted at the time of the query. A new query must be performed whenever the data needs to be updated.
-
Design document, 'User defined information' (sometimes created by regular tasks) and in some cases page properties and page counts. Some of the Action and Output tasks produce, alter, or use the Metadata. In addition to that, PlanetPress Workflow provides a whole series of plugins to create and edit Metadata during a Workflow process (see "Metadata Tasks" on page 462). The things that you have to know in order to use the Metadata tasks effectively are set out in another topic: Working with 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. Metadata in OL Connect jobs In PlanetPress Suite, all levels in the Metadata hold information about an actual job. In Connect, that isn't the case. The Metadata file created and maintained by OL Connect tasks looks the same, but contains less information.
-
Metadata elements Each Metadata node (i.e. Job, Group, Document, etc.) is described with a series of elements, that is, system-defined attributes or user-defined fields holding static or dynamic information about the node they are attached to. Each element has a name and a value. More specifically, here is a definition of these 2 types of elements: l l Attribute: A read-only, system-defined element which holds certain information about a certain node in the Metadata structure.
-
Note Metadata Index/Count values are one-based when viewed in the user interface: the first element in any collection has an index of 1 and the last element's index corresponds to the collection's length. However, in the API and in Metadata selections, they are zerobased: the first element in any collection has an index of 0 and the last element's index corresponds to the collection's length minus 1.
-
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Document. Date Date the Metadata was created in ISO format. Producti on X X X Time Time the Metadata was created in ISO format. Producti on X X X Title Title of the source document. Producti on X X X Producer Name of the software that created the Metadata. Producti on X X X Creator Name of the software that created the source of the Metadata.
-
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Dimension Two floatingpoint values separated by a colon indicating the media size in typographical points (ex: 612:792). Finishin g X X X X X Orientation "Rotate0", "Rotate90", "Rotate180" or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape. Finishin g X X X X X Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet.
-
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicates a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source. Finishin g X X X X X OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedependent color of the media.
-
Attribute Description Index Categor y J o b Index/C ount IndexInDocument Returns the Absolute index of the node within all the nodes under the parent Document. Index/C ount IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group. Index/C ount IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
-
Attribute Description Categor y J o b Gro up Docum ent PageCount Index/C ount X X X SelectedCount Index/C ount X X X SelectedDocument Count Index/C ount X SelectedDatapage Count Index/C ount X X SelectedPageCoun t Index/C ount X X SelectedIndexInDo cument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInGro up Returns the Absolute index of the node within all the selected nodes under the parent Group.
-
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge of the node within all the selected nodes under the parent Job. NumCopies Indicates how many times the job is set to execute, as set when printing using a Windows driver. Index/C ount X Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input.
-
Working with JSON In online processes, it is common to send data to and retrieve data from a server. That data is often exchanged in JSON format. JSON is short for JavaScript Object Notation. It is a way to store information in a structured and easy-to-read format. It is often referred to as "XML without nodes" and it is designed for exchanging data. Refer to the following online resources for more information on JSON and its syntax: l www.json.org l www.w3schools.
-
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.
-
A JSON string constructed with information retrieved from an XML job data file (see "XML data selections" on page 54): { "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"},
-
"columns": { "ItemUnitPrice": "CURRENCY", "ItemOrdered": "INTEGER" } } } }, "id": 3678077, "datasetid": 2392921, "fields": { "ID": "CU19762514", "Date": 1331096400000 }, "tables": { "detail": [{ "id": 3678078, "fields": { "ItemTotal": "2300.00", "ItemShipped": 2.0, "ItemOrdered": false } }, { "id": 3678079, "fields": { "ItemTotal": "29.99", "ItemShipped": 1.0, "ItemOrdered": "false" } }], "detail2": [{ "id": 3678080, "fields": { "ItemUnitPrice": "1150.
-
} } ] 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.
-
Feature Name Description Equivalent Database Terminology Key A Key is defined only by its name. The Data Repository only supports STRING values and any data inserted into it is converted to string automatically. The maximum size of a single key is 1 billion bytes. Column/Field KeySet A group may contain as many KeySets (rows), which contain variable data, as necessary. A KeySet is inserted using the "Push to Repository" on page 339 task.
-
The syntax is of the Lookup function is: Lookup(Group_Name, Key_To_Retrieve, Key_To_Match, 'Value_To_Match') Note Value_To_Matchcan be a static string, a jobInfo or a variable, but not a data selection. For the Value_To_Match parameter, the single-quotes surrounding the value are mandatory even if the value is dynamic. This function may also be used anywhere else where the contextual menu gives access to it.
-
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. It is also possible to create a Repository at a custom location; see ConnectionString.
-
By default, when an error occurs, the task is skipped and the unmodified job file is passed on to the next task. You can overwrite this behavior by changing the options of the On Error tab of the process - which sets the default error handling behavior for all the tasks in that process - or of an individual task.
-
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
-
appears on a customer's online order. You could also zip the order up and send it to an administrator, while simultaneously advising the person that sent the job that it failed. You can have as many error processes as you can normal processes - that is, you are limited to 512 processes, subprocesses, startup processes and error processes combined. Information available in an Error process The following information is available from within your Error process when it is triggered.
-
l Serial Capture l HTTP/SOAP Server l LPR Client l FTP Client l PlanetPress Image l PlanetPress Fax l PlanetPress Messenger 3. When any job or file is processed by the selected service, the processing logs will be displayed in the window on the right.
-
the Watch folder, go up one level then go in either folders, under which you will find the Log folder for that specific software within the suite. Resubmit backed up input files to a process Each Input task includes an option that lets you back up input files. This option is not selected by default, since it has the potential to generate a very large number of backup files.
-
1. In the PlanetPress Workflow Ribbon, go to the Tools tab then click Resubmit Job in the Services group. The File Resubmission dialog box is displayed. 2. From the Process box, select the process for which you want to resubmit the backed up input files. 3. From the Task index box, select the index level to which you want the data to be sent. The index is the position in the process where you want to submit the job file. The numbers on the left in the Process area indicate the task index. 4.
-
In addition it may be useful to know the number of each failed page. If a job contains 1000 documents and if documents 1 to 950 were printed correctly, you might not need to resubmit the entire job, but only the input data for the 50 last documents. However this is only useful if the relationship between the input data and actual output documents is easy to determine.
-
Action task to actually run in the process). Do not forget, however, to remove this duplicate task before saving the configuration! l l If any task makes an operation on the system (for example, capturing files, sending data, printing, etc), it is actually executed, not simulated. Any task is executed with the permissions of the user that is currently running the PlanetPress Workflow Configuration tool. When running in Service mode, the user configured in the Configure Services dialog is used instead.
-
l l l l l l l l Click on Skip to ignore the next task or branch and go to the subsequent one. The job file is not modified in any way. Click on View as Text in the Data group of the Debug tab to view the current job file using a text editor (Notepad by default). Click on View as PDF to view the current job file in Adobe Acrobat if it is present (this will work only for PDF job files). Click on View Metadata to open the data selector and see the current state of the process' Metadata.
-
This method does not allow you to add, remove or move tasks, however. The second method can be used when that is required. l l l l l Step through the process in Debug mode until you reach the emulation or data change. Click on View as Text (or View as PDF if your data is PDF at this point) in the Data group of the Debug tab. In the viewer that appears, save the file to a location on your hard drive.
-
Printing can be done locally or remotely. The spool file is sent to the printer by the Output task itself, or by Workflow if the file is placed in a Workflow Printer Queue. Printer-centric printing - which means that a document and data are merged on a printer - is only supported with PlanetPress Design documents, and requires that this feature is available on the printer.
-
l Easier debugging. If the output file is a PDF, for example, you can open it inside Workflow once it has been sent back to the process (see "Debugging your PlanetPress Workflow process" on page 94). Using a Printer Queue requires creating the appropriate Printer Queue in the Workflow Configuration tool first. In the Output to Printer Queue task, select No document to let the spool file pass through it.
-
you start building a PlanetPress Workflow configuration it contains no printer queues. If you want Workflow to dispatch spool files to printer queues, you have to create queues in Workflow and set each one’s properties. Printer Queue types The PlanetPress Workflow Configuration program lets you create four types of printer queues: l l l l Windows Output printer queues are used to send print jobs to local or network printers. See "Windows Output printer queue" on page 103.
-
Shared printer queue properties The options on a printer queue’s Advanced properties tab are common to all printer queues. They include the printer’s speed and any special pre- or post-job commands required for printer specific reasons. Pre-job commands are added right before the data in the data file, while postjob commands are placed at the end of the data file. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue.
-
Character name: Character code: Typical use in printing context: Horizontal Tab \t Adds a horizontal tab Line Feed \012 Moves to the next line Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape character New Line (CRLF) \n Goes to a new line Windows Output printer queue Windows output printer queues send print jobs to local or network pr
-
Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing. Commands: The list of available commands appears in this box. Select either Pre-job commands or Post-job commands in the Selected box, and double-click a command from this list to add it to the appropriate list.
-
standard FORTRAN carriage control character. Select (d) DVI file if the job file contains data in the TeX DVI format. Select (o) PostScript file if the job file is a PostScript file. Select (n) Ditroff format if the job file contains data in device independent troff. Select (t) Troff format if the job file contains data in troff. Select (v) Sun raster file if the job file contains raster images. This ensures that the printer uses the correct filter to interpret the data.
-
using the Optimized PostScript Stream option, you should not enter data selections in the Printer address and Queue name variable property boxes. If you do need to use information stored in the data to configure the LPR output printer queue, you should first use Job info variables to store the information, and then use these variables in the Printer address and Queue name variable property boxes.
-
Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing. Commands: The list of available commands appears in this box. Select either Pre-job commands or Post-job commands in the Selected box, and double-click a command from this list to add it to the appropriate list.
-
l 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. Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected.
-
In the General tab of the Printer Queue Output Properties dialog box, you may select multiple printers, and in the Advanced tab, you can set the load balancing options for the selected printers. 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.
-
2. In the Printer Queue list, select all those Workflow printer queues for which you want the printer queue—document association to be broken. 3. Click OK. Modifying Design document settings To modify the settings of a PlanetPress Design document assigned to a Workflow printer queue: l Double-click on the document located within a printer queue. The Document Properties dialog appears.
-
Objectif Lune Printer Driver (PS) Introduction The Objectif Lune Printer Driver (PS) allows end-users to print directly to PlanetPress Workflow from any Windows application, by using the familiar File|Print option. At the other end, PlanetPress Workflow specifically can capture the incoming stream and convert it internally into a PDF file along with its metadata.
-
Printer Properties setup PlanetPress Workflow WinQueue Input task can be configured to set a Windows printer queue using Objectif Lune Printer Driver (PS) to produce one of 3 different types of data files: EMF, PostScript, or PDF. Printer properties settings Spool Print Jobs in EMF Format l This will create an EMF data file. l This format is usually reserved for use with the Windows Print Converter action plugin. l This format can be obtained using PlanetPress Workflow.
-
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.
-
About processes and subprocesses Processes A process is a single workflow within a configuration (see "About Workflow Configurations" on page 29). A process begins with a single input task, contains one or more tasks and/or branches, and 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.
-
replicating process polls its source once, determines the number of files to process, then replicates itself up to the maximum allowed and treats the files simultaneously. The initial process runs again once it has completed itself and replicates again as necessary, until all files have been processed.
-
To call a subprocess from another process, use the "Go Sub" on page 387 Process logic task. Whenever a process calls a subprocess, the main process (the caller) will wait for the called subprocess to finish its execution before carrying on with its own. This means the subprocess feature is synchronous with the main process. This also means the calling process actually appends the subprocess to its own workflow.
-
l Right-click a regular process and select Startup to convert the process into a startup process. Note that a self-replicating process can't be converted into a startup process. Adding a subprocess To add a PlanetPress Workflow subprocess: l l In the Ribbon, go to the Home tab and click the Subprocess button in the Processes group. In the Configuration Components pane, right-click on the Subprocesses folder and select Insert > Insert Subprocess.
-
and at least one example of an implementation that uses them in the chapter: "Special workflow types" on page 569. Importing processes You can import individual processes or groups of processes from another PlanetPress Workflow configuration file without having to import the contents of the entire configuration file. The PlanetPress Workflow Configuration tool imports everything necessary to run the processes, including configured tasks and some configuration components.
-
l l References to specific PlanetPress Design or PrintShop Mail documents. Note that the documents themselves must be imported separately. 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.
-
have to send the edited configuration to your PlanetPress Workflow Service (see "Sending a configuration" on page 127). 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.
-
l l l l l l l Self Replicating: Check this if you want the process to replicate itself in the background when multiple input files are received simultaneously. When this is checked, the input task polls its source once, determines the number of files to process, then replicates itself up to the maximum allowed and treats the files simultaneously. The initial process runs again once it has completed itself and replicates again as necessary, until all files have been processed.
-
l l l l l Select First, Second, Third or Fourth to have the process run on the first, second, third or fourth week. Select Last to have the process run only on the last week. Time division: Select the duration of each daily segment in the time grid. If you select 00:15, each segment will represent only 15 minutes and each day will be made up of 96 blocks (4 blocks per hour times 24 hours). If you select 24:00, each segment will represent an entire day.
-
l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two. l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
-
l l l To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler. To deselect all the days or dates for a given time segment, CTRL+click the time segment on the left grid ruler.
-
On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings. The Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
-
You can add a new branch, by dragging and dropping a branch, from the Process Logic category of the Plug-in Bar, into your process. Branches can thus be added like a task; see "Adding tasks" on page 233. You can add a new branch that contains all of the tasks below the point where you insert the branch. To do this, right-click on the first task that you want to include in the branch, and select Branch From Here.... An Unknown task will be created as an output below the branch.
-
If any task converted into a subprocess was previously using local variables, these variables must be removed or transferred to global variables or Job Information variables to be usable in the newly created subprocess (see "About variables" on page 556). Running a process on desktop Since PlanetPress Workflow configurations are typically meant to run without user interaction, all of their processes are set to run in the background by default.
-
Saving a configuration file never replaces the current PlanetPress Watch service configuration. To do this, you must use the Send Configuration command. When the PlanetPress Workflow Configuration program sends a configuration, the PlanetPress Workflow service is stopped and restarted, if it is currently running, and the new configuration starts being applied immediately.
-
Note .OL-workflow files are equivalent to .pp7 files made with older versions of PlanetPress Workflow. They contain the processes and such used by Workflow. If the PlanetPress Workflow Service is running when you send a new configuration, it stops and restarts automatically with the new configuration. If the service is stopped before sending the configuration, it will not restart automatically.
-
Note If PlanetPress Workflow service is paused when you send a new configuration, it will not stop and restart. Since PlanetPress Workflow service reads its configuration file when it starts up, when you resume processing, PlanetPress Workflow service will continue using the old configuration.
-
-
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.
-
Note l l The JavaScript engine is Microsoft’s JScript 5.8, which is the equivalent of JavaScript 1.5 (ECMA-262 3rd edition + ECMA-327 (ES-CP) + JSON). 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. For Python ActivePython (version 2.7.13 ) can be installed.
-
button from the task's Properties dialog. When you do so, the script currently displayed in the dialog box is pasted to the editor’s scripting box. Both editors are visually identical and share almost exactly the same commands. They let you import and export scripts, perform common editing, such as search and replace, and feature syntax highlighting and formatting.
-
4. Click OK. The script is imported, displayed and formatted according to the syntax of the language selected in the editor. If the imported file had the extension of a recognized scripting language (.vbs or .js, for example), the editor language is automatically changed. Exporting a script To export a script: 1. In the editor, choose File > Export. The Save As dialog box appears. 2.
-
l l l l l l l l Whole words only: Select to limit the search to complete words matching the text in the Text to find box. Whole words are defined as strings that have a space or punctuation before and after the word. Regular expressions: Select to treat the regular expressions of the scripting language as text to search. If you clear this option, the regular expressions of the language are not included in the search. Global: Select to search the entire content of the script.
-
1. Choose Search | Replace, or press CTRL+R. The Replace With dialog box appears. The last used strings are displayed in the Text to find and Replace with boxes. 2. Set the replacement settings and options. l l l l l l l l l l Text to find: Enter a new search string or select a previous search from the dropdown list. Replace with: Enter the string that will replace the string displayed in the Text to find box.
-
reaches the beginning of the script or script selection, the search finishes. It does not loop back to the beginning. l l From cursor: Select to start the search from the position of the cursor. Entire scope: Select to search either the entire script, or a script selection. The scope corresponds to a script selection if you make a selection before executing the Find. 3. Do one of the following: l l Click OK to replace the first string encountered.
-
Bookmarks are displayed in the editor’s gutter, so you will not be able to see them unless the gutter is both visible and sufficiently wide. If line numbers are also displayed in the gutter, bookmarks may be harder to see. To control line number and gutter display, see "Editor Options" on page 724. Note Bookmarks are not preserved when you close the editor.
-
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. Note PlanetPress Workflow already come with a SOAP Client plugin, which can be used as an input, action or output; this task was renamed Legacy SOAP Client.
-
Return Value SubmitJobResult: Structure containing the following information: l l l l Success: Integer indicating the Success/Error level of the operation. A result of 0 means the operation was successful. Message: String containing text information about the Success/Failure status. SubmitJobInfStruc: Structure containing any required information to prepare the file for a valid insertion into a PlanetPress Workflow process (see "SOAP API - SubmitJobInfStruc" on page 145). ResultFile: base64Binary.
-
SOAP API - PostJob Syntax PostJob (File, PostJobInfStruc , user name, Password) : PostJobResult Description The PostJob method allows users to remotely submit files to PlanetPress Workflow by using the Resubmit from here feature. The main advantage of this feature is that it allows a user to specify a starting task index from which the File is to be processed. Parameters l l File: base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64).
-
Note The PostJob method can never return a file to the calling application. SOAP API - GetProcessList Syntax GetProcessList (user name, Password) : GetProcessListResult Description The GetProcessList function allows SOAP clients to request the list of available PlanetPress Workflow processes, based on their authentication credentials. Parameters l user name: String containing the user name. l Password: String containing the password. This is case sensitive.
-
SOAP API - GetProcessTaskList Syntax GetProcessTaskList (ProcessName, user name, Password) : GetProcessTaskListResult Description The GetProcessTaskList function will allow a user to remotely request the tasks list of a process. This will be useful with the PostJob API since it needs a TaskIndex. Parameters l ProcessName: The Name of the PlanetPress Workflow process. l user name: String containing the user name. l Password: String containing the password. This is case sensitive.
-
SOAP API - GetSOAPProcessList Syntax GetSOAPProcessList (user name, Password) : GetSOAPProcessListResult Description 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 API since it requires a SOAPActionName. Parameters l user name: String containing the user name. l Password: String containing the password. This is case sensitive.
-
SOAP API - PostJobInfoStruc Structure containing any required information to prepare the file for resubmission into a PlanetPress Workflow process. l VariableList – Array of complex type, containing pairs of variable names and variables value. The list also contains the Job Info variables. l VariableName: String l VariableValue: String l ProcessName: String: name of the PlanetPress Workflow process. l TaskIndex: Integer: 1 based index of the task where the resubmission should start.
-
Note While the functions here are in mixed case to simplify reading, it's important to note that some languages (especially JavaScript) are case-sensitive and will require the proper case. Examples in this chapter will always use the proper case when relevant. Here is a list of the methods and functions that are available to you through the automation object (or "Watch" object).
-
Variable Name Description Example Usage (VBScript) "Watch.GetVariable" on page 155 Retrieves the content of a local or global variable by name. Example Usage: str = Watch.getvariable("Varname") "Watch.ExpandString" on page 156 Retrieves the content of any Workflow string, containing any variable available to Watch, including data selections. Example Usage: watchDate = Watch.expandstring("%y-%m-%d") "Watch.
-
Variable Name Description Example Usage (VBScript) by name. Example Usage: Watch.setvariable "global.GlobalVar", "Hello World!" "Watch.Sleep" on page 159 Pauses all processing for X milliseconds. Example Usage: Watch.sleep(1000) "Watch.ExecuteExternalProgram" on the facing page Calls and executes an external program in the command line. Example Usage: Watch.executeexternalprogram "del *.ps" "c:\" 0 true "Script.
-
VBScript Watch.ShowMessage("test message") JavaScript Watch.ShowMessage("test message"); Python Watch.ShowMessage("test message") Perl $Watch->ShowMessage("test message"); Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line. The program's execution will be directed by the appropriate flags specified as this method's parameters. Syntax Watch.
-
Flag Effect 2 Display the window minimized. 3 Display the window maximized. 4 Makes the window visible and brings it to the top, but does not make it the active window. WaitForTerminate : A Boolean value that, if true, pauses the script until the command line has been fully executed. Examples VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true JavaScript Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); Pyth
-
Example In the following example, GetJobFileName() retrieves the name of the job file, which is then logged using "Watch.Log" on page 157. VBScript Dim s s = Watch.GetJobFileName Watch.Log "The job filename is: " + s, 3 JavaScript var s; s = Watch.GetJobFilename(); Watch.Log("The job filename is: " + s, 3); Python s = Watch.GetJobFileName() Watch.Log("The job filename is: " + s, 3) Perl $s = $Watch->GetJobFileName; $Watch->Log("The job filename is: " + $s, 3); Watch.
-
Perl $Watch->GetOriginalFileName(); Watch.GetMetadataFilename Returns the complete path and file name of the metadata file associated with the current job file. Example VBScript Watch.GetMetadataFileName JavaScript Watch.GetMetadataFileName(); Python Watch.GetMetadataFileName() Perl $Watch->GetMetadataFileName(); Watch.InputBox Warning Starting version 7.0, the Watch.InputBox function is deprecated and may no longer work due to changes in the way in which the Watch Service functions.
-
You must enable the “Run on desktop” option for the PlanetPress Workflow process whose script calls Watch.InputBox. Otherwise PlanetPress Workflow application may stop working and require a reboot. Example s = watch.inputbox("caption", "message", "default") watch.showmessage(s) Examples In the following example,Watch.InputBox requires the user to enter a line of text. The script the displays a pop-up of the message contents using "Watch.ShowMessage" on page 148. VBScript s = Watch.
-
Syntax Watch.GetJobInfo(Index: integer): string Example VBScript Dim s s = Watch.GetJobInfo(3) Watch.Log "Jobinfo 3's value is: " + s, 2 JavaScript var s; s = Watch.GetJobInfo(3); Watch.Log("Jobinfo 3's value is: " + s, 2); Python s = Watch.GetJobInfo(3) Watch.Log("Jobinfo 3's value is: " + s, 2) Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("Jobinfo 3's value is: " . $s, 2); Watch.SetJobInfo Sets the job information index to a specified string value. Syntax Watch.
-
Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); 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 VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.Log "MyVariable's value is: " + s, 2 s = Watch.GetVariable("global.MyVariable") Watch.Log "global.
-
Watch.SetVariable Sets the variable to a specified string value. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.SetVariable Name: String; Value: String Example VBScript Watch.SetVariable "MyVariable", "Desired value" Watch.SetVariable "global.MyVariable", "Desired value"/ JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); Python Watch.SetVariable("MyVariable", "Desired value") Watch.
-
Example This example results in expanding the string of the variables to the date value in the following format: “YYYY-MM-DD”. VBScript Dim s s= Watch.ExpandString("%y-%m-%d") Watch.Log "Current Date is: " + s, 2 JavaScript var 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.
-
Level Type Text Color in Service Console 3 Information Black 4 Debug Grey Arguments Message—A string representing the message that is logged in the log file. Note that the text of the message must use the locale encoding of the system where the PlanetPress Workflow software will be running, otherwise it will be unreadable. Level—An integer between 1 and 4, specifying the severity level of the error message.
-
Python Watch.Log("this is a log",3) Perl $Watch->Log("this is a log",3); Watch.Sleep Pauses the process for the specified number of milliseconds. This can be used while waiting for something else to happen when the delay is known. Syntax Watch.Sleep Milliseconds: integer Example In the following example, sleep() pauses the process for 1 second (1000 milliseconds) VBScript Watch.Sleep 1000 JavaScript Watch.Sleep(1000); Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.
-
Example This example will always return true, as the condition is static. It is, after all, simply an example. You get the idea. VBScript Dim everythingOK everythingOK = true if (everythingOK = true) then Script.ReturnValue = 1 else Script.ReturnValue = 0 end if JavaScript var everythingOK; everythingOK = true; if(everythingOK){ Script.ReturnValue = 1; } else { Script.ReturnValue = 0 } Python everythingOK = True if everythingOK: Script.ReturnValue = 1 else: Script.
-
Data Repository API The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes. The Data Repository can be accessed at runtime by the Push To Repository plugin and other tasks (see "Data Repository" on page 84) and at design time via the "Data Repository Manager" on page 655. This topic explains how to access the Data Repository in script. For a quick start, turn to this How-to: Interacting with the Data Repository API.
-
API Reference Obtaining an instance of the Repository Object The Data Repository is accessed via a COM object that exposes methods to store and retrieve data within the Repository. JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); VB Script set repoObject = CreateObject("RepositoryLib.WorkflowRepository") In each example in this documentation, the object repoObject is deemed having been obtained through the above call to the COM object.
-
many resources on the Web that propose ways of implementing JSON parsing in VB Script so you can implement whichever you see fit. However, using JavaScript is highly recommended. Repository management methods Name Description CheckRepository Verifies the integrity of the repository and recovers unused space left by deleted keysets. Similar to packing a database, the operation is non-destructive but it does require exclusive access to the Repository.
-
Name Description ListGroups Retrieves the list of all group names in the Repository, stored in a JSONStringArray.. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys. RenameGroup Renames group oldName to newName. While this operation has no impact on the data stored in the specified group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Key Methods Name Description AddKey Adds key KeyName to group GroupName.
-
Name Description Group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Value Methods Name Description 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() for information on adding a key to a group. Upon successful completion, the method returns the ID of the newly created KeySet.
-
Name Description the keyset was not updated. Note that this method is functionally equivalent to using SetValue() with its Condition parameter set to "ID=ID". KeySet methods Name Description 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.
-
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 162). JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.
-
repoObject.AddKey("Users", "email"); VB Script repoObject.AddKey "Users", "email" AddKeySets Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues must exist otherwise an error is raised. However, it is not required to specify all available keys in KeyValues. Only the keys specified are updated in GroupName while unspecified keys are set to an empty string.
-
var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); repoObject.AddKeySets("customers", '[{"CustomerID": "CUJS123456", "FirstName": "John","LastName": "Smith"}, {"CustomerID": "CURD654321", "FirstName": "Richard", "LastName": "Doe"}]'); Tip: to update a row instead of adding it, use the GetValue() function to get the KeySet ID; then update each individual value using SetValueByID() (see "GetValue" on page 172 and "SetValueByID" on page 180).
-
CheckRepository Verifies the integrity of the repository and recovers unused space left by deleted keysets. Similar to packing a database, the operation is non-destructive but it does require exclusive access to the Repository. You should therefore only perform this operation when you know for sure no other process is accessing the Data Repository. Syntax CheckRepository() ClearAllData Delete all keysets in all groups, while retaining the existing key structure.
-
When Condition is left empty, all keysets are retrieved, which is useful for reports, cleanup, or custom filters based on more complex conditions. GetKeySets() converts the results coming from the Repository from UTF8 to Ansi, in order to make results with special characters like 'éèêë?æ' compatible with scripting. To obtain the UTF8 value, without conversion, use GetKeySetsW().
-
By replacing the last option from GetKeySets (the filter on CustomerID) with an asterisk, you can get all the rows from the data repository.
-
LastName='Smith' "); /* retrieves email for first user named Smith */ var myValue = repoObject.GetValue("Users", "email", ""); /* retrieves email for first user */ VB Script myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" AND FirstName=""John"" ") /* retrieves email for John Smith */ myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" ") /* retrieves email for first user named Smith */ myValue = repoObject.
-
Repository Object" on page 162). JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListGroups()); for (var i=0; i
-
Sample return value '{"ID": "meta", "FirstName": "string", "LastName": "string", "email": "string", "DateC": "meta", "DateM": "meta"}' As shown in the sample, the value associated with each key name is actually the data type for that key. Only two values are currently possible: string and meta, where meta denotes an internally generated key. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys.
-
Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 162). JavaScript repoObject.RemoveKey("Users", "email"); VB Script repoObject.RemoveKey "Users", "email" RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise.
-
/* both methods perform the same task */ repoObject.RemoveKeySetByID "Users", 10 repoObject.RemoveKeySets "Users", "ID=10" RemoveKeySets Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. The method returns the number of keysets that were deleted. When passing 'ID' as the Condition, all keysets in GroupName will be deleted.
-
RenameGroup Renames group oldName to newName. While this operation has no impact on the data stored in the specified group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Syntax RenameGroup(oldName, newName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 162). JavaScript repoObject.
-
VB Script repoObject.RenameGroup "Users", "LastName", "SurName" SetValue Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition. The condition is specified using basic SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note that KeyName must exist in GroupName, otherwise an error is raised.
-
SetValueByID Updates KeyName with Value in group GroupName, where the KeySet's ID matches the ID parameter. KeyName must exist in GroupName, otherwise an error is raised. The method returns the ID of the keyset that was updated or -1 if the keyset was not updated. The KeySet ID can be retrieved with GetValue() ("GetValue" on page 172).
-
("RepositoryLib.WorkflowRepository"); var keySetID = repoObject.GetValue("customers", "ID", "CustomerID='CURD654321'"); /* Update Values */ repoObject.SetValueByID("customers", "FormOfAddress", "Mr.", keySetID); repoObject.SetValueByID("customers", "Country", "US", keySetID); repoObject.SetValueByID("customers", "Language", "EN", keySetID); Version Returns the version of the DLL library used by the Repository.
-
JavaScript JavaScript uses the throw statement within try to create an exception which, if not caught using catch() , will cause the script execution to stop and the On Error tab to be triggered. See the JavaScript errors page on W3Schools. var s; s = Watch.GetJobInfo(9); if (s == "") { throw "Value Cannot be empty"; } else { // Do something with Job Info 9! Watch.
-
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. However, some types of processes like PDF and HTTP processes, and processes related to another product, are important enough to pay some attention to them. This chapter will describe each of these special workflow types and give at least one example of an implementation that uses them.
-
SOAP Workflow As SOAP can be either a client or a server, two workflows will be presented. The SOAP Client workflow presents PlanetPress Workflow as the client and will explore how to retrieve WSDL information and how to make a SOAP request as a client. The SOAP Server workflow will show how to create a process that responds to SOAP requests, and where our own WSDL is located.
-
Manager. Important Configuration, Setup and Options Before starting to work with HTTP workflows, there are a few key points to keep in mind in terms of configuration. First of all, the following options are available in PlanetPress Workflow Preference screen, under the HTTP Server Input 1 and HTTP Server Input 2 sections: l l l l Port (default value: 8080 recommended): The port number is the one in which a browser needs to make a request to PlanetPress Workflow.
-
Note As of PlanetPress Workflow 8.1, it is possible to serve a default HTML file when no action is specified, for example http://localhost:8080/ . This is done by creating an index.html file in the Resource Folder defined above. However, resources called by this index.html must still use the Resource action name, for example a stylesheet would still point to http://127.0.0.1:8080/static/css/style.css or more simply static/css/style.css.
-
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. l l l When doing POST requests and uploading files, always make sure to include the "multipart" option in the
-
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. If the last output task generates a PostScript file for printing, this PostScript is returned to the client. In most cases, what is returned is what remains after the last task, but only if this task's processing is done in PlanetPress Workflow.
-
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 l l The HTTP Server Input task receives a request through the /getinvoice HTTP Action. Because this task either returns an HTML page with an error message or a PDF, the MIME type is Auto-Detect.
-
deleting the data file only means you are not doing anything with it locally - it is still returned to the client. l If, however, the file is found, then it is loaded with the "Load External File" on page 335 task, and then deleted (for the same reasons).
-
l l l l l If this is the initial request, an HTML page is created which contains a form asking the client for a required full name and email, and optional company name. A checkmark also offers to subscribe to a newsletter (it is unchecked by default!). The form submits back to the same URL, meaning it is handled by the same process. The file is renamed with the .html extension, so that both the HTTP service and the browser will recognize it as an HTML page.
-
Note In Connect it is also possible to group, sort and split PDF data using "OL Connect tasks" on page 494. Example: Daily sales report from PDF files This workflow makes heavy use of PDF tasks and Metadata, and assumes that you are using PlanetPress Workflow version 7.3 or higher. This single process workflow generates a daily sales report for any sales representative inside of a company which made at least one sale.
-
l l l l l The "Metadata Sorter" on page 475 then re-orders the Metadata documents by Rep ID, so that all of the invoices for any particular sales representative are all together. "Lookup in Microsoft® Excel® Documents" on page 408 then uses the Rep ID field to retrieve each sales representative's email from a specific Excel spreadsheet. The "Metadata Sequencer" on page 474 acts like a splitter, where the separation happens whenever the Rep ID changes.
-
l l l l l l l l The "Metadata Level Creation" on page 472 creates the Document level of the metadata by placing each PDF data file in its own Document level. It does this by detecting when the Address in the document changes. Then, the "Metadata Fields Management" on page 466 adds a few fields at the Document level in order to properly tag each document with the appropriate information, in this case the Customer ID, Country and Rep ID.
-
Capture. Please review them in "PlanetPress Capture Implementation Restrictions" on page 586. In order to properly build a PlanetPress Capture workflow, it is very important to understand the terminology, implications and limitations of the technology.
-
l l Using the "Capture Fields Generator" on page 444 action task to generate the capture patterns Printing your documents. 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.
-
l The Capture Condition and Get Capture Document tasks are used to effect postprocessing and retrieve document from the Capture database. Error Handling Whenever an error occurs during the Capture Field Processor phase, it is of course important to be able to handles these errors. For this purpose, the "PGC to PDF Converter" on page 461 task was added with PlanetPress 7.4, adding the ability to quickly and directly convert a PGC file to a blank PDF file containing the ink data as an EPS layer.
-
Anoto Pattern A series of dots placed in a pattern that is unique to each page where the pattern is printed. The Anoto Digital Pen identifies this pattern and its location on the page. PlanetPress Capture contains 20,000 patterns (8 in demo mode, See "PlanetPress Capture License Management" on page 697) which can be used to generate documents. Capture Condition PlanetPress Workflow task that is used for post-processing of documents after they have been processed by the Capture Fields Processor.
-
Closed Document A document still within the PlanetPress Capture Database of which all the required fields have been filled by the Capture Field Processor from a PGC. A closed document will only remain in the database until it is retrieved with the Get Capture Document task, after which it is deleted. Contamination The act of writing on a "wrong" document, aka one that has a Pattern Sequence different that the one for which it was produced..
-
that of the document causes Contamination, which can cause errors or ink to be placed on the wrong document. Pen ID The serial number of the Anoto Digital Pen. It is registered in the PlanetPress Capture database and is present in each PGC file. PGC File Pen Generated Coordinates; PGC File containing all ink processed while the pen was undocked along with the Pen ID. It is possible that a single document requires multiple PGC, just as it is possible that a single PGC have multiple documents.
-
Warning PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently. In order to design a document with Capture Fields, you must review and understand the Critical PlanetPress Capture Implementation Restrictions.
-
l l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database can be in any location, but performance will depend on the speed of the connection between PlanetPress and the MySQL server. MySQL's performance has been slower than SQL Server and SQL Server Express during our tests. By default, MySQL is configured not to allow any SQL request larger than 16 megs.
-
l l Also in MySQL, if a timeout occurs on simultaneous record access, resubmitting the PGC for processing should resolve the issue. In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue. Security Considerations PlanetPress Capture introduces new and efficient methods for digitally capturing the contents of ink laded out on physical paper.
-
document of their choice. It is always better to secure this folder properly. You could also use third-party encryption software to secure the files, and decrypt them as necessary for reprocessing. l l l l The transfer between the Anoto penDirector and PlanetPress Workflow is not encrypted due to a limitation of penDirector which does not support SSL connections.
-
The Numbers First and foremost, the 20,000 patterns is a fixed number - PlanetPress can only generate 20,000 unique patterns as this is the number of patterns that we license through Anoto. The 20,000 patterns are, however, not all available when generating documents. There are 8 "demo" patterns that are used to generate documents when PlanetPress Capture is in demo mode (no license activated), and react the same way that the bulk of the 20,000 patterns.
-
Example Say you print 19,000 pages containing a pattern, every day. You may think you'll "run out of patterns" after a single day. But if 18,900 of these documents are being written to and processed within the day, at the end of the day you only have a 100 page difference, possibly due to mistakes, lost pages, or errors during processing. In this specific example, you would run out of patterns only after 10 days, assuming the numbers remained completely static.
-
"tag" that is added after the pattern's identification (Pattern ID). When a Pattern Sequence is used, each Pattern Sequence can re-use each of the 20,000 available patterns. "Zones", in this case, could refer to a specific region within a city, or a whole city or a province, whatever fits your needs. Pattern Sequences can be handled in 2 different ways: by attaching a Pattern Sequence to a specific pen, or by attaching it to a specific PlanetPress Workflow process.
-
Note The mobile phone application, "PlanetPress Mobile", which uses Bluetooth communication to receive pen data and transmit it to PlanetPress Workflow, can still be used with both pattern sequence methods, as it is the equivalent of a docking station on the web. PlanetPress Mobile was added to PlanetPress Capture in version 7.4. Contamination The single but critical danger with any implementation that deals with PlanetPress Capture is "Contamination".
-
Third, contamination (the most common one) can happen if pattern sequences get mixed up, if pens or paper gets swapped between users, etc. For example, again using a shipping company (with example 2-A), if two of the drivers were to meet for a coffee and exchange their pens inadvertently (we hope, anyways), the pens would be signing the "wrong" documents all day and, when docked, would update the wrong documents in the database.
-
Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc. The penDirector creates a bridge between the Anoto Digital Pen and a PlanetPress Capture workflow in 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. The setup will install a preconfigured version of penDirector which can be immediately used with PlanetPress Capture.
-
3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4. Go in the Bluetooth tab of penDirector and click on Add Pen. 5. Click on Search while the cap is off on the pen. 6. 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.
-
PlanetPress Capture Implementation Restrictions This document describes the limitations of the Anoto Digital Pen & Paper Technology, especially in regards to using it within a PlanetPress Workflow implementation. Note that these limitations apply to any Anoto technology implementation and not just our own. Printer limitations Any document printed with Capture Fields (aka Anoto Patterns) must be sent through a Laser printer.
-
Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
-
This is because the pen's camera (which captures the position of the pen) is located under the pen tip and must fully see the pattern.
-
Knowing this, the best practice when creating fields is that they have, at the very least, a 7mm margin on each size of the actual area you want to capture from. For example, an effective 30mm wide pattern will actually be 44mm wide using these margins. The margin should be for both the vertical size and the horizontal size.
-
PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition". The difference between the two is easily explained: While OCR can only recognize characters using the finished shape (for example, in scanned documents and pictures), ICR relies on much more data which is provided by the Anoto Digital Pen: the path that the pen takes, the exact timing of this path, start and stop points, etc.
-
Guide). This must be either a Multi-Area Field or a Text Field. l l l The Capture Fields Processor must have the Perform ICR Recognition option checked, and language needs to be selected. Once the ICR data is available, do something with it. This is done by reading the ICR data that is available in the metadata generated by the Get Capture Document task. The metadata is also readable by the Capture Condition task, including the captured text and the reliability of this text.
-
l l l ICR Value: The alpha, numeric or alphanumeric value that was determined by the ICR engine. ICR Confidence: A percentage value that the ICR engine gives to any specific value, when comparing the pen data with it's character database. ICR Resemblance: A percentage value that defines how closely the value resembles the "average" character shape. Both the Confidence and Resemblance can be used together to make an informed decision on the contents received by ICR.
-
The following guidelines are applicable when configuring a PlanetPress Capture object that utilizes ICR: l l l l l l l The collected data is expected to be a number, therefore the numeric mask type must be selected, or The collected data is expected to be a letter, therefore the alphabet mask type must be selected, If upper case letters are expected, select Upper case in the Case option menu. The captured characters would be immediately converted to capital letter i.e.
-
The following diagram illustrates the available mask types. It is recommended to select the mask type that is the closest to the desired result. An alphanumeric field should be used as a last resort. Guidelines for Capture-Ready Fields l l Target: Form designer What: Only one character per Capture field can be recognized. When expecting multiple characters making up a word or phrase, you must make sure that the user only writes one character per field.
-
Why: To avoid any ink marks that would spill over from one field to another. If both fields A and B are to close in proximity and the ink marks from field A spill over to field B, then the marks captured on field B would be considered as being part of a character written on field B. For example, if a number spills over and is written over two fields like numbers 9, 1 or 7; then the bottom tip of these numbers could be considered as number 1 in the second field.
-
How: Make sure there’s enough space between each field. You must re-design the document if that’s the case. There’s no minimum value that is required as the distance between 2 fields, except for the 7mm border that is required in order for the Anoto digital pen to recognize the pattern being used. Writing in a Legible Way l l Target: User. What: It is important to write in a legible way i.e. applying yourself by writing well defined numbers and letter that are easily interpreted.
-
Why: The available filters to interpret the ink marks done with the Anoto digital pen, allow you to select the engine language to be used. Doing so will give you results that are the closest match to the captured data. Multiple cultural characters can be interpreted with ICR once the correct language is selected such as û, à, é, etc. How: This option is available from the Capture Fields Processor task.
-
Possibility of Interpretation Error in an Automated Process l l Target: Workflow designer What: We cannot be 100% sure that a character would be recognized by PlanetPress Capture as it should. Therefore, the analysis of a value interpreted with ICR should only occur if the level of confidence is superior to a determined level. Why: An automated process can treat the characters incorrectly due to an incorrect interpretation of a value. This occurrence should be minimized as much as possible.
-
l Any input task l "Create Metadata" on page 463 l "Capture Fields Generator" on page 444 l Print output PGC Handling Process The second process is the PGC Handling process. It receives data from the Anoto Digital pen, updates the Capture database and releases patterns as appropriate.
-
l "Get Capture Document" on page 458 l Archive or Print output Capture Post Processing Workflow Though the "Basic Functional Capture Workflow" on page 224 is minimal functional one, it will most likely not be enough for most actual implementations. The goal with PlanetPress Capture (and PlanetPress Workflow in general) being to automate as much as possible, there are some tools within the PlanetPress Capture tasks that can greatly help with this goal.
-
Task Breakdown: l l l The HTTP Server Input receives a POST request sent either by the Anoto penDirector or the PlanetPress Mobile Application. This requests contains information sent by the pen as well as a PGC file as an attachment. Because we're only concerned about the PGC, the task is configured to ignore the XML envelope as well as loop through each attachments (of which there is only one). So, the output of the task is the PGC file alone.
-
After Retrieving Information from the Capture Database There are two basic ways in which the Find Capture Document task can be used. First, in an automated process that runs at specified intervals. For example, the following process which sends a daily report of all incomplete and "in error" documents to an agent who would presumably take action on each document through the document manager.
-
Task Breakdown l l The Find Capture Documents task queries the Capture database for documents that correspond to certain specific conditions. For example, here we would look for all documents that are either in an "Error" or a "Partial" state, which means they received ink but are not completed correctly. To do this, the "Content Status" filter and setting it "Equal to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met".
-
3. Import the invoice.pp7 Design document into Workflow, or open it in PlanetPress Design and send it towards your local PlanetPress Workflow server (localhost or 127.0.0.1). 4. Open the configuration file CaptureExampleProcess.pw7 5. Click the PlanetPress Workflow button (File menu) and go in Preferences. 6. In the HTTP Server Input 2 section, check the Serve HTTP resources option, change the Resource action name box to static , and the Resource folder to c:\PlanetPress\http . Then, click OK. 7.
-
Workflow processes in a Connect Send solution OL Connect Send (see "OL Connect Send" on page 480) 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. Each OL Connect Send solution will require the Workflow processes to be configured differently, but certain plugins will always be part of the solution.
-
Production report process The key plugin in a process that produces reports about jobs received with OL Connect Send is the Get Data plugin. It allows to query the OL Connect Send database. (See "Get Data" on page 480.) Sample project The Ad Hoc Mail Consolidation sample project may help you understand the Workflow processes for OL Connect Send and configure your own. l l Watch the sample in action on demo.objectiflune.com. Under Ad Hoc Mail Consolidation, click Demo and follow the instructions.
-
For more information on the tasks that are by default available to you in PlanetPress Workflow, see the following pages: l "Input tasks" on page 239 l "Action Tasks" on page 291 l "Data Splitters" on page 361 l "Process Logic tasks" on page 382 l "Connector Tasks" on page 399 l "PlanetPress Capture" on page 571 l "Metadata Tasks" on page 462 l "OL Connect tasks" on page 494 l "OL Connect Send" on page 480 l "Output Tasks" on page 539 l "Unknown tasks" on page 556 Note Completely empty
-
2. Locate the task you want to add to your process. You can navigate between the different task categories by clicking the icons at the bottom of the Plug-in Bar. 3. Using your mouse, click and drag the task in your process at the place you want to insert it. 4. Depending on where you place your mouse, you may see that you can replace or insert existing tasks, or not place it at that location at all. 5.
-
Note For the list of operations you can perform on tasks in a process via the Process area, please refer to "The Process area" on page 728. Task properties Any task you add to your PlanetPress Workflow process must be configured using its Properties dialog. It appears as soon as you add a task to a process, or when you double-click on a task. Each task's Properties dialog will give you the options to configure that specific, individual task.
-
Variable task properties When you edit tasks, you may notice that some of the properties that you can modify have a red (or more precisely, a maroon) title. This means that the property can be dynamically determined whenever your process runs, that is to say it will not remain static. This can be extremely useful when, for example, you want to determine how many copies you will print out depending on your data, or what document will be used in the printout depending on the department it came from.
-
l Variables l System: Contains system variables, also called "Standard variables" on page 559. l Job Info: Contains Job Info variables from %1 to %9 l l l l l l l l l Local Variables: Contains a list of local variables in this process. If no local variables exist, this item is disabled. Global Variables: Contains a list of global variables in this configuration. If no global variables exist, this item is disabled.
-
l l Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example. The lookup() function indicates a lookup in the "Data Repository Manager" on page 655. Masks Certain tasks, such as the Folder Capture Input task and the File Name Condition task, allow for entering a mask instead of a file name. See Masks. Date and Time Format To simplify things and to prevent errors, date and time formats have been standardized.
-
Input tasks Input tasks are the starting point to any process and determine what file this process will being with. Each process must begin with an Input task, and although a given process may have multiple Input tasks, no task can have more than one initial Input task. Initial Input tasks Initial Input tasks are always at the beginning of a process and are always triggered when the process starts.
-
This is an important consideration when scheduling a task, as the Folder Capture task will keep capturing files as long as new files are added, even if it means continuing to capture and process outside its scheduled time. It is also important that while the Folder Capture input task is processing files it keeps a copy of each file in a temporary folder, and will not delete any of these files until it has finished processing all of them. This may cause issues with running out of disk space.
-
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
-
l 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 it's text. If variables and control characters are present, they are evaluated at run-time when the task is executed. Output The output is the job file.
-
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
-
inbox are retrieved. Emails retrieved using POP3 are deleted from the server, emails retrieved from an Outlook inbox are moved to the Deleted Items folder by default. Processing Depending on the options selected below, each email is converted into a text-only data file, and each attachment is separated from the email. Output Depending on the options, each email is sent as a data file, followed by each of its attachments sequentially.
-
Note Since characters '?' and '*' are considered valid to define the subject of an email, their use as wildcards is not supported . l l l Nothing: Select to limit those messages used by this task to those that do not specify any subject. “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.
-
l Password: Enter the password required to unlock the selected account on the POP3 mail server. This box is only enabled when the Use POP3 mail option is selected. "Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
-
Note Because of the way Microsoft Exchange works, when receiving an email from a user on the same local Exchange server, the email address may not be available. See FAQ-1509 in the Knowledge Base of PlanetPress Workflow. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
-
Warning If you create a Folder Capture input task that takes any file it finds in the root folder of one of your hard disks, then 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.
-
elements of the RegEx syntax, therefore they cannot be mixed and matched with Workflow variable data syntax (e.g. %1, ${global.myvar}, etc.). Also, there is no validation of the RegEx being specified. l l l l l l l Sort files by: Select a given sorting method to prompt PlanetPress Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order). Select None to let PlanetPress Workflow take the files without sorting them first.
-
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
-
Processing Folder Listing loops through the files and, for each file, generates an XML node with information about the file. Output The output is an XML file containing information about each file. If the Sub-directories option was checked, the structure of the XML also contains the folder structure as it is present on the drive. Here is a sample of the XML that is generated: C:\Samples\ invoice.
-
Note The
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. 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 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 l l Password: If account named in the User name box is password protected, enter the password here. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available.
-
l Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically. %2 - FTP Server: Contains the FTP address of the server from which the files were retrieved.
-
Processing No processing is done by this task. The file retrieved is not changed in any way. Output HTTP Client Input will output a single file which was retrieved from the web. Metadata is not generated by this task. Task properties General Tab l l URL: Enter the URL of the HTTP server from which the file must be downloaded. Since this is a variable property box, variables may be used, as well as the Get Data and Select Data commands (see "Variable task properties" on page 236).
-
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. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
-
Note Athough Workflow can serve both static and dynamic resources to a web browser, it is not meant to be used as a fully featured web server as it is not built for responsiveness nor guaranteed uptime. It is recommended to use a common web server (for example, IIS or Apache) to serve your contents and to let Workflow process things only it can do. For more information on how to serve HTML and PDF generated by Connect through IIS, watch the Connect with Evie - IIS series.
-
Note By default, the request XML also contains a CDATA section which contains the raw input data, effectively doubling the size of the incoming file. Due to technical restrictions, the incoming XML file cannot be more than 400MB, which because of 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.
-
Task properties General Tab l l l HTTP action: Enter the name of the action requested of PlanetPress Workflow by the client. This name corresponds to the URL that the client will be accessing. For example, if you enter "MakePDF" here, you could trigger the process by accessing http://127.0.0.1:8080/MakePDF . This is also what your HTML Form's action should be. MIME Type: Select the MIME type of the file that will be returned by the plugin.
-
"Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Workflow Tools working folders under the "Backup" folder.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Input Error Bin The Input Error Bin task is used specifically and only to create error management processes. These processes do not run on their own but are rather triggered by the On Error tab of tasks in other processes, when that task fails. Input This task receives a data file from a task that generated an error.
-
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 87. "Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Input SOAP The Input SOAP task is used to answer calls from a remote SOAP client and to return a response to that request. It is similar in functionality to the "HTTP Server Input" on page 257 task. Note SOAP communication is non-trivial and requires a certain understanding of XML and the SOAP protocol.
-
Task properties General Tab l SOAP Action: The SOAP action is used with the SubmitJob action. It’s the equivalent of the process name. The difference is that more than one processes can share the same SOAP action. That way more than 1 CPU can be used to process all the incoming requests however this means that all process sharing the same SOAP action must be identical because there is no way to decide the execution order of all the process.
-
the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. LPD Input LPD (Line Printer Daemon) Input tasks retrieve data in the form of print files sent from remote computers using the LPD/LPR protocol. The PlanetPress Workflow LPD server starts automatically when a configuration that includes at least one active LPD Input task is started.
-
"Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Workflow Tools working folders under the "Backup" folder.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Merge PDF Files The Merge PDF Files Input task (formerly named "Concatenate PDF Files") captures all PDF files in a given folder and merges them into a single PDF file. This task is put into effect in the following example process: "Example: Daily sales report from PDF files" on page 192. Input This task captures all of the PDF files present in a specific folder, in one operation.
-
Task properties General Tab l l l l l l l l l Folder: Enter the full path of the folder from which the input files are to be taken. Masks: Enter a single or multiple file names or use file name masks. See Masks. Since this task only supports PDF files, make sure your extension remains .PDF for all your masks. Sort files by: Select a given sorting method to prompt PlanetPress Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order).
-
Note Metadata can be manipulated with Metadata tasks; see "Metadata Tasks" on page 462. "Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input.
-
NodeJS Server Input NodeJS Server Input tasks are used to receive HTTP requests and to send replies to the servers from which the requests were made. Essentially this task does the same as the HTTP Server Input task, but it uses a NodeJS Server (installed by Workflow) instead of Workflow's custom server component. The NodeJS Server is more secure, more up to date and more standardized.
-
watch the Connect with Evie - IIS series. Note While you can insert the NodeJS Server Input task anywhere in your process as a secondary input task, in reality the NodeJS Server Input task will only function when used as the initial input, as it is triggered when Workflow's NodeJS Server receives a request and passes it on to the correct task.
-
Note Currently the NodeJS Server Input task only supports basic content-types: l multipart/form-data l application/x-www-urlencoded l application/octet-stream Any raw body content-type (application/json, application/xml, text/html or any other not mentioned above) might not behave as expected and will be supported in the next version. Processing Depending on the options chosen in the NodeJS Server Input task properties, the task may choose to ignore some of the files.
-
If the Send Immediate Response to client option is selected, the response file is sent back right away and the involvement of the input task ends then. However, if this option is not checked, it means there is a second output that comes out of the 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.
-
l l 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, but most browsers will interpret it as plain text. Note that this is a variable property box. You can use any combination of text, variables and data selections; see "Variable task properties" on page 236.
-
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
-
Input This task does not poll an input, it sits there and waits for a job file to be sent through the Serial connection. 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.
-
Job Information definitions l %1 - Source file name: Contains the name of the job file as specified by the software that sent the job. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
-
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 FTP server. Task properties General Tab l Server Settings group l FTP Server: Enter the IP address or host name of the FTP server to poll. l User name: Enter the name of a user account on the FTP server. l l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH).
-
entered, it does not point to the "/tmp/temp/copy_pending" directory but to the "/users/support/tmp/temp/copy_pending" directory. l l l Delete remote file: Check this option to delete the file after it has been retrieved by Workflow. Connection mode group: This group is only relevant to the FTPS protocol and appears when it is selected. SFTP uses a single connection to download all files. l l l Masks: Enter a single file name mask. Multiple entries are not allowed in this box.
-
"Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Workflow Tools working folders under the "Backup" folder.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SMTP Input SMTP Input tasks are used to receive SMTP requests made by any email client or other SMTP commands and can act as an SMTP proxy, processing emails before they are sent to another SMTP server. In order for this task to receive files, the SMTP Server (also called "Outgoing Email Server") in the email client must point to PlanetPress Workflow server's IP or hostname.
-
Input The SMTP Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received.
-
places them in a specific location on the drive. When a request is received, the SMTP Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received. Warning Due to a technical limitation the SMTP Input task does NOT receive the BCC addresses from most emails sent to it. Processing The task reads the incoming SMTP request and provides the data within its body.
-
Task properties General Tab l l Data location: Determines what files are sent into the process: l Envelope: Only the request envelope is sent to the process (see above). l Attachments: Each attachment is sent down the process (see above). Unzip attached file: Select to unzip the attached files. l l Zip password: Enter the password required to unzip the attached files (if any). Note that you can use variables and data selections.
-
l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l %1 - Date Received: Contains the date and time at which the email was received. l %2 - Originator Name: Contains the Name of the sender (in the from field).
-
use multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see "Telnet Input plugin preferences" on page 714). 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.
-
l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions This task does not generate any job information. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks.
-
Input The WinQueue input regularly polls the selected printer queue for new jobs. When a new job is available, it is captured automatically by this task. Processing The print job, by default, is in EMF format. If this option is selected, no action is taken on the data file. However, if the RAW format is selected, the job is converted to RAW. Furthermore, if the Create PDF option is selected, the file is converted to a PDF, including metadata.
-
l Include empty files: Check to process empty incoming jobs. The output will be empty, the job is deleted from the print queue, but the job information is available in the process (sending computer and user name, etc). "Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Action Tasks Use action tasks in PlanetPress Workflow to perform a wide variety of operations.
-
l "Mathematical Operations" on page 336 l "Open XSLT" on page 337 l "Push to Repository" on page 339 l "Rename" on page 341 l "Run Script" on page 389 l "Search and Replace" on page 345 l "Send Images to Printer" on page 346 l "Send to Folder" on page 348 l "Set Job Infos and Variables" on page 350 l "SOAP Client plugin" on page 543 l "Standard Filter" on page 354 l "Translator" on page 355 l "Windows Print Converter" on page 357 Add Document The Add Document action task prepares a
-
Output The output is a PostScript job that can be sent to any output task in "passthrough" mode, for example Create PDF, PlanetPress Image, etc. Metadata is not generated by this task. Task properties General tab l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be merged with that document (see "PlanetPress Design documents" on page 39).
-
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 selected operation (adding or removing lines, text or pages) is made on the data file. Output The modified data file is output from this task. Metadata is not modified in any way if it is present.
-
l l l Characters: Enter the string of characters to be added to the job file. This box is only displayed when the Characters option is selected in the Content box. Lines: Enter the lines of text to be added to the job file. This box is only displayed when the Lines option is selected in the Content box. Remove: Enter the number of characters or lines to be removed from the job file.
-
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 Search mode group: Select your chosen search mode within this group. l l l l 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).
-
l Position options group: Specify the location where the string must be found using this group. Note that this whole group is disabled when the Treat as regular expression option is selected. l l l l l l Anywhere on the line: Select to indicate that the search string can be anywhere on the line. At the beginning of a line: Select to indicate that the search string must be the first string on the line. At the end of a line: Select to indicate that the search string must be the last string on the line.
-
l l All before occurrence: All occurrences of the search string will be replaced until the specified number of occurrences has been reached. Specifying 5 occurrences, for instance, means that the four first occurrences will be replaced. Replace with: Enter the string that must be used as the replacement sting when a match is found. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks.
-
Processing The task reads the image and detects the presence of the selected supported barcode types. When a barcode is detected, the data it contains is read and added to the Data Page level of the Metadata. Note This task does not recognize more than one level of the Metadata Document. This means that if you are intending to define separate documents, you should use the Metadata Level Creation task after the Barcode Scan.
-
Barcode types Description Code93 Code 93 symbology. Compressed form of Code 39. Code128 Code128 symbology. Very dense code, used extensively worldwide. Codabar Codabar symbology. Used in libraries and blood banks. Inter2of5 Interleaved 2 of 5 symbology. Used in warehouse, industrial applications. Add2 2 additional digits code for UPC-based symbologies. Used to indicate magazines and newspaper issue numbers. Add5 5 additional digits code for UPC-based symbologies.
-
Note The fewer barcode types are selected, the faster the plugin performs. Selecting only the expected barcodes is therefore a good practice. Barcode orientations Barcode orientations represent a barcode orientation on an image. For example, when the leftto-right option is checked, the task will try to read the barcode value assuming that the barcode data should be read in a left-to-right fashion. Note The fewer orientations are selected, the faster the task performs.
-
Barcode Scan task character replacement option will allow successful barcode reading of all non-printable characters in a given barcode. The value specified in the Replace non-printable character with option will be found in place of any non-printable character in the BarcodeValue and Barcode_x_Value Metadata fields, while the original barcode value (i.e. with non-printable characters) will be available in the BarcodeBase64_x_value Metadata field. This option allows only one printable replacement character.
-
l l If the selected option is process by page, then the Metadata file is created and overwritten for each new scanned page. 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.
-
l l Barcode_1_Left: Metadata field providing the distance (in pixels) from the left of the page to the left side part of the first barcode. Barcode_1_Right: Metadata field providing the distance (in pixels) from the left of the page to the right side part of the first barcode. 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.
-
Emulation action task. All the tasks that follow on the same branch will use the emulation chosen in the Change Emulation task. Input Any data file. Processing The emulation for the following tasks is changed to the selected emulation. Output The original data file, metadata and job infos are not modified. Only the emulation is changed.
-
start of the first data page. Note that you cannot add lines in either a CSV or user defined emulation. Lines per page: Enter the number of lines each data page contains, or use the spin buttons to increment or decrement the value. Pages in buffer: Enter the number of data pages you want the data page buffer to contain, or use the spin buttons to increment or decrement the value. Read in binary mode (ASCII emulation only): Select to read the data file in binary mode.
-
l l CSV (comma separated values). l l l l l Remove HP PCL escapes: Select to have the document remove any Hewlett Packard Printer Control Language (HP PCL) escape sequences it encounters. Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the document splits that data into two fields. If you want to use a backslash character (\) as a delimiter, you m
-
the underscore characters of the underline on the following line. The first character of the line with the text is a code that tells the printer to ignore the LF at the end of that line. The result is underlined text. It is important to understand what happens when you tell the channel skip emulation in PlanetPress Design to ignore the LF at the end of a line.
-
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. For single runs the performance gain is less noticeable than in loops (either through a splitter, a Loop task or a metadata filter) where the XML file would be loaded repeatedly. l PDF. (Nothing to configure.
-
Input Any data file supported by PlanetPress Workflow, or a PostScript file. 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 191 and Working with Metadata).
-
l l 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 it 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 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. Note that if more than 35% of the characters included in a font are used in the document, the entire font is embedded. This option often produces smaller PDF files and ensures proper PDF display.
-
l PDF version: 1.
-
l Open options: l Zoom factor: Fit in window l Default view: Page only Database Query The Database Query action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format. Database Query action tasks are not considered input tasks as such, because they cannot be used to start a process.
-
Input Any data file. The data file will be discarded by the task. Processing A connection to the selected database is made, the data is retrieved, and an output in the selected emulation format is generated. Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and Job Info variables are not modified in any way.
-
l l l l Output file emulation: Select the emulation corresponding to the type of output file you want the PlanetPress Workflow Database action task to generate. CR-LF replacement: If you want CR-LF (Carriage Return-Line Feed) characters within the data file to be replaced by another character, use this box to indicate which character to use. You may select the replacement character from the list or type your own.
-
l l l l Default width: This box is used to set the default width for all fields. It is set to 60 by default, but can be set to any value between 1 and 65535. This value is applied to all the fields in the generated file. To set different widths for each field, use the Configure Width button. Doing this disables the Default width box. Configure Width: Click to set the width of each field in the generated file.
-
l l l l Alternate syntax: Select to prevent automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the Advanced SQL Statement dialog box. The alternate syntax may be required for some database types. Edit SQL: Click to create and test an advanced SQL query. Import Config: If you previously created and exported a PlanetPress Workflow Database Connection configuration, click this button to import it.
-
l l Database connection string: Enter a variable connection string in this box. To do this you may begin by clicking to create an ODBC connection string to the data source and paste the string automatically to this box. 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.
-
Output This task outputs the data file it received with no modification. Metadata and job files are not touched either. Task properties General Tab l l l l l l l Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Output folder: Enter the name of the folder in which you want the decompressed files to be stored.
-
Digital Action Digital Action Action tasks generate the same types of documents as generated by PlanetPress Image output tasks (see "PlanetPress Image" on page 422). Since Digital Action tasks are not Output tasks, the documents they create are typically passed on to the following task. The image files they generate are always saved, along with their index files (if any), to an archive folder.
-
Digital Action tasks, in a PDF/VT file created with Connect, see the Connect Online Help: Generating tags for Image output. Alternatively, select a PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections. To enable the dynamic document name box, click inside it. To disable it, press Enter.
-
the digital masters. The TIFF Group 3 and Group 4 formats are efficient for document storage. l l l l l l VDX: The output will be a VDX file, which is a PDF file with some PPML code inside of it to enhance performance by doing caching/image reusing. The output can only be used on devices that support the VDX technology. DPI: Enter the dots per inch (dpi) resolution of the output image. This property is enabled for all output types except PDF.
-
l l l l Folder and filename: Enter the path of the folder to which output files generated by this task are to be archived. PDF index files (PDI and XML) are also put in this folder. This edit box is enabled when the Save a copy option is selected. To prevent each new file from overwriting the previous one, you should use variable names. As with any variable property box, you can use any combination of text, variables and data selections.
-
l l Job options: Select the PDF output option that best describes your needs. This loads all the standard settings for the selected usage scenario. These settings can be changed as required. Note that if you make changes and then select a different output option, your changes will be lost. PlanetPress Image supports numerous PDF standards: Standard, High Quality, Custom, and a variety of PDF/VT, PDF/A and PDF/X formats.
-
l l Monochrome images group l l l Keywords: You may enter keywords for the document. Since this is a variable property box, you may use variables and data selections and let PlanetPress Workflow interpret this information at run-time. Monochrome compression: Select the compression to use for the monochrome images. Flate compression is lossless, so no data is lost during compression.
-
shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l l Color images group l l l l Grayscale resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. Color compression: Select the compression to use for the color images. Flate is a lossless compression method, so no data is lost in the process.
-
l l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files. PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files. Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128).
-
pages. Select Full screen to hide all screen contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen. l Font group l l l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded.
-
in this window, Override global PlanetPress Search Database settings. The database options then activate. l l l l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server). Connection time-out: Enter the time, in seconds, that the connection to the database is maintained while no action is taking place before the connection is severed.
-
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 39 and "About printing" on page 98). For images you should rather use Send Images to Printer action tasks (See "Send Images to Printer" on page 346), as they provide image quality and conversion options. Input Any file that you wish to upload to the printer.
-
l l Keep file extension: Select to use extensions when saving files. When this option is selected, if the task receives a file with the “txt” extension, for example, it will keep this extension even if it renames the file (as specified in the File name box). Print confirmation page: Select to print the Variable content document download confirmation page when the download is successful. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88.
-
l The process will always wait for the executable file to finish before it continues to the next task, and does not have any timeout setting. This mean that if your program fails to exit for any reason, your process will hang. Input Any active data file, in any format. 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.
-
l l Program output capture group l l l Run minimized: Select to prevent a window (a DOS box, for instance) from being displayed on the desktop. When selected, the program runs in a background window. Log the program output: Check to store the program output (messages generated by the execution of the external program) inside of a job info or variable. Store the program output in variable: Use the drop-down to select which variable or job info to will be used to store the program output.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Load External File Load External File action tasks are used to replace the current job file by the designated text file. Loading an external file does not delete the original file or modify it in any way. This task is put into effect in the following example process: l HTTP PDF Invoice Request Input The current data file in the process will be discarded.
-
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 556). Note When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action.
-
variables and VBScript mathematical expressions. For example, to multiply Job Info 9 by 2, the expression would be %9*2 . Note The expression itself must be written in a format understood by the VBSCript scripting language. For more information, please see Mathematical Functions in VBSCript and VBSCript Math Operators. l l Store result in: Variable data field containing the job information, local or global variable in which to store the result.
-
Processing The XSLT is applied to the XML data file. Output The modified XML data file is output. Metadata and Job Info variables are not modified. l l File l Import: Lets you open an existing XSLT script from an XSL, XSLT or TXT file. l Export: Lets you save the current XSLT script as a file. l Print: Prints the current XSLT script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor).
-
l Tools l l Editor Options...: Opens the "Editor Options" on page 724. Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l l l The script editor text box: This is where you enter your XSLT Script that will be used. If you use an external script file, this will display the content of the file (note however that modifying the script in this case does not modify the external file and changes are not saved).
-
Task properties General tab l l Group: Use the drop-down to select into which group the KeySet is inserted, or in which group the KeySet should be updated. Key set: Displays a list of keys for the selected group. l l l l l l l Key: Displays the key name in the group. Value: Enter a value for the key, which will be inserted in the KeySet. This value can be dynamic, including data selections, metadata selections, variables and other data. Update: Check to update the key with new data.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Rename Rename action tasks are used to rename the job files they receive.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. 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.
-
on the main trunk. To control the output, use the "Script.ReturnValue" on page 159 variable in your script. Properties The Script Editor menu options are as follows. l File l l l Export: Lets you save the current script as a file. l Print: Prints the current script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l Copy: Copy the current selection (only available if there is selected text in the editor).
-
l Tools l l Editor Options...: Opens the "Editor Options" on page 724. Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l l l The script editor text box: This is where you enter your script that will be used. If you use an external script file, this will display the content of the file (note however that modifying the script in this case does not modify the external file and changes are not saved).
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Search and Replace Search and Replace Action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data. Note that this Action task cannot be used with binary files. For more advanced search and replace functionality, see "Advanced Search and Replace" on page 295.
-
l l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies. l button: Click to add a new line to the list of words to find and replace. l button: Click to remove the currently selected line from the list.
-
images sent to the virtual drive of another computer are stored in a sub-folder of the PlanetPress Workflow folder. Input Any image file that you wish to upload to the printer. Processing The currently active image data file converted to PostScript. The image's resolution, scan orientation, and quality can be modified, depending on the selected option. All files are converted into PostScript format for storage on the printer. If a virtual drive, the file is automatically sent to it.
-
characters (characters, such as é, for example) are not recommended in image file names. l l l l l l Image quality: Select the same image quality chosen in the PlanetPress Design documents that reference the image files you are sending. In PlanetPress Design, this setting is included in the document’s resource options. Image compression level: Select the level at which you want images to be compressed. Values can range from 1 (compress up to 1% of the image’s original size) to 100 (do not compress).
-
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. Please refer to the "Network considerations" on page 17 page. Input Any data file in any format. Processing A copy of the data file is saved on the hard drive at the specified location.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
l Value: Enter the value that you want to associate with the selected Job Info variable or custom variable. l button: Adds a new line and lets you define the variable and value to set. l button: Removes the line that is currently selected (highlighted). l button: Moves the line up so it is processed before. l button: Moves the line down so it is processed after. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88.
-
To configure a given SOAP Client plugin task in the PlanetPress Workflow Configuration program, you must first get its WSDL file (note that you cannot download the WSDL file over an HTTPS connection, so you should use an HTTP connection to get the file and then switch back to a secure connection). This lets you know which services the SOAP server provides, as well as each service’s methods and name spaces.
-
l l l l l l l Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below. As script: Click to apply the options you chose above and to display information on the chosen Web service in JavaScript format in a script viewer. You should use this option if the Web service is too complex to be interpreted correctly by the SOAP Client plugin. Name: Displays the name of the arguments associated with the selected method.
-
the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Standard Filter Standard Filter Action tasks can be used to remove HP Escape characters from data files, as well as to eliminate spacing problems caused by LF-CR end-of-line sequences.
-
Task properties General Tab l l Process job using ASCII emulation: Select to use the ASCII emulation to process the job file. This reverses LF-CR end-of-line sequences that may result in unwanted doublespacing. Remove and convert HP escape characters: Select to filter HP escape character sequences from the job file. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks.
-
Codepage 1252 (ANSI - Latin 1) is used for many Latin language documents, since it can be used for Afrikaans, Basque, Catalan, Danish, Dutch, English, Faroese, Finnish, French, Galician, German, Icelandic, Indonesian, Italian, Malay, Norwegian, Portuguese, Spanish, Swahili and Swedish. Codepage 932 is often used for Japanese. Input Any text-based data file. Processing The characters in the data file are converted from the old encoding to the new one. Output The data file in its new encoding format.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. 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 EMF to XY group: Select this option if the file received by this task is a Windows print file. This will prompt the task to perform the first phase of the process, and thus convert the file to an XML file. If this option is not selected, the input file will not be converted to an XML file (note that the task will fail if the file it receives is not an XML file). The settings included in this group fine tune the process.
-
font's mean character width is multiplied with. The value for the mean character width is taken from the corresponding font's attributes (for texts which are printed justified, it is suggested to raise this value up to about 2). For example, if the mean character width of the font example shown here corresponds to the width of the blank character (for other fonts it may be another sign).
-
l l Character per inch (CPI): The number of individual characters per inch on a line of text. Line per inch (LPI): The number of lines of text per inch. XML/JSON Conversion The XML/JSON Action task converts an XML job file to JSON or a JSON job file to XML. This task makes parsing XML/JSON files much simpler in a JavaScript environment and also allows processes to natively send JSON to a Connect template or data mapping configuration. Input The current job file.
-
practices, see: XML elements on W3Schools. Output The output is the modified job file, which replaces the input job file. The metadata are reset. Task properties General tab l Automatic detection: By default, the format of the job file is detected automatically. If the source file is a JSON file, it will be converted to XML. If it is an XML file, it will be converted to JSON. Uncheck this option to limit the task to one type of conversion. l JSON to XML: the task only converts JSON files to XML.
-
Splitters initiate a recurring cycle that stops only when the original file has been completely processed. When a given splitter creates a file, it hands it down to the task that follows, and all the tasks on the same branch are performed until the output task. Then the splitter task creates yet another file that is again handed down to the next task, and so forth until the cycle ends (when there is no more data in the original file).
-
Once split, the first file generated by the action task would look like this: Data line1 of page 1 Data line2 of page 1 Data line2 of page 1 Last data line of page 1 But when opened with PlanetPress Design or a 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.
-
Task properties General Tab l l l l l Split group: Use this group to indicate how you want the file to be split. Field value change: Select if you want the file to be split based on changes in the values of a selected database field (the value in the ClientID field changes, for example). Field value condition: Select if you want the file to be split based on a condition set for the values of a selected database field (the value in the Order field equals 1, for example).
-
Pages before if you want the file to be split a given number of pages before the field that matches the set condition. Select Pages after if you want the file to be split a given number of pages after the field that matches the set condition. l l l l Split when condition is found group: Use this group if you want the condition to be met a multiple number of times before splitting the file.
-
Using an emulation to format the data before splitting provides the most splitting options, but slows down the process. Splitting a data file containing a few hundred thousand pages may take several hours. So you may choose to use non-emulated data to speed up the splitting process (See "In-Stream Splitter" on page 374). Example This task is put into effect in the following example process: l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite.
-
are used to tailor exactly how you want the word based splitting process to take place. l l l l l l l l l l Word change: Select if you want the data file to be split when the word found at a given location changes. Get: Click to go to the Data Selector and select the location associated with the Word change option. Specific word: Enter the word to use as the splitting criteria.
-
which the condition is met. l l l After: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines after the line on which the condition is met. When condition is found: By default, the task splits the file every time the condition is met (the default value is 1). If you want the task to split the file only when the condition has been met twice, for example, enter the number 2 in this box.
-
by an order of magnitude. Whenever encountering the Generic Splitter, it is always recommended to replace it with a more appropriate splitter instead. Input Any data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, Job Infos and other variables are not modified by this task.
-
elements or any combination of these. l l Get: Click to get a static string of characters from the sample data file. If you use this button, the coordinates of the data you will select will be added to the Word is between lines and Word is between columns groups below. Word is between lines l l Word is between columns l l l l l From and To: Enter a horizontal search region defined as starting from a given column and ending at a given column.
-
l l 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. Word is in line: Enter the line on which to search for the word change. If you enter 1, the Generic Splitter will consider only in the first line of every page.
-
three pages. A 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 l Split when condition found: You may not want to split the file every time the string of characters entered in the Value box is found, but only every other time, or every third time. If so, enter the number of times in this box. 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 l l Field name: Enter the name of the field that the Generic Splitter must check.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. In-Stream Splitter In-Stream Splitter action tasks are used to split non-emulated data files into multiple data files that are passed to subsequent tasks in the process. Note Performing the splitting process on raw, non-emulated data speeds up the splitting process.
-
l l l l l l l From column: Enter a value corresponding to the first column in which the splitter must start searching for the word. To column: Enter a value corresponding to the last column in which the splitter must start searching for the word. Match case: Select to force the splitter to match the character casing of the string of characters entered above with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”.
-
When using a PlanetPress Design document, the PDF Splitter will do the job quicker than the Metadata Sequencer task that can also be used to split PDFs. However, when using a PDF as input, the Metadata Sequencer might perform better. For more information and some test results, see this How-to: Performance testing grounds. In the case of Connect Print output, using Print Presets to separate the output is preferable to using the PDF Splitter.
-
l Split PDF file on a word: Select to split the data file whenever a given region is found within the PDF data file (rather than on based on pages), or whenever the region found at a given location changes, and to activate the options from this group, which are used to tailor exactly how you want the region based splitting process to take place. l l l l l l l l l l On region content change: Select if you want the data file to be split when the word found at a given location changes.
-
l l l l Before: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines before the line on which the condition is met. After: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines after the line on which the condition is met. When condition is found: By default, the task splits the file every time the condition is met (the default value is 1).
-
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 Reset Metadata according to new PDF: Metadata will be recreated according to the new PDF that was created, including page numbering, etc. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks.
-
Task properties General Tab This tab lets you choose the splitter settings for the default PlanetPress Workflow XSLT engine. If you want to use your own XSLT engine, click the Alternate XSLT Engine tab. l Split method: Use this box only if you want to edit the standard XSLT script that will be used to split the XML file. First use the Standard XML splitter option to define the standard settings. Then, to change the standard XSLT script, select Advanced XML splitter and edit the script as required.
-
l l l l l l Encoding group: This group lets you indicate whether you want the splitter to use the file’s own encoding or the universal encoding UTF8 to process the file. Note that if the file contains no indication as to which encoding should be used, the default system encoding will be used. This may result in errors being generated or split files that contain bad data. Using the UTF8 encoding can prevent such errors. Use UTF8 encoding: Select if you want to use the UTF8 encoding to process the file.
-
l l l l XSLT file button: Click to add the {XSLTFILE} variable to the command prompt displayed in the box above. Data file button: Click to add the {DATAFILE} variable to the command prompt displayed in the box above. Output file(s) button: Click to add the {OUTPUTFILE} variable to the command prompt displayed in the box above. Browse button: Click this button and browse to select the XSLT engine you want the XML splitter to use.
-
may change system variables. The only exception is the Run Script action, which can be a condition that also modifies the data. Warning Branches, Loops and Conditions do NOT modify metadata in any way. Furthermore, even if a branch does a backup of Job Info variables and the data file, it does not back up the metadata. Keep this in mind when designing a process. A Branch is effectively a doubling of your job file (see "Job file" on page 46).
-
Task properties Backup Tab l l l l Backup job file: Select if you want PlanetPress Workflow to use identical copies of the job file for the main and secondary branches. When this option is not selected, the file generated by the output task located at the end of the secondary branch is used as the job file for the main branch. Note that if the secondary branch ends with a Delete output task, the main branch will receive the job file in the state it was just before the delete.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
l 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. Retrieve subprocess error: Select if you want to receive error(s) from the subprocess in order to handle them on its own. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88.
-
l l l Store current iteration in Job Info #: The Job Info in which the loop's iteration should be stored. Useful for sequential file names or conditions based on the iteration. The value of this Variable Properties box should be a digit between 1 and 9 (see "Job Info variables" on page 557).
-
For more information on scripts, what languages are supported and how to write scripts and conditions, please see the related chapter, "Using Scripts" on page 131. Input Any data file, in any format. Processing The script is executed. The script can modify anything such as the data file, Job Info variables, Metadata, or even other files on the operating system. Output Whatever file the Run Script action generates, Metadata it modifies or creates, etc.
-
l l l l l Select All: Select all of the contents of the editor. l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog. Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Language: Select the language in which your script is written. Choices are VBScript, JavaScript, Perl or Python.
-
Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties. 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. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks.
-
Task properties General Tab l Process: The name of the target process to send the current job to. Note that startup processes and subprocesses are not available. You can either enter the name of a process (or use variable properties) or use the drop-down to list existing processes. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks.
-
Management Information Base Object Identifiers A Management Information Base (MIB) is a database of Object Identifiers (OIDs) that can be used to monitor device objects using SNMP. An MIB OID can point be a printer tray, cartridge or hard disk, or to modem mode. Using an SNMP condition, PlanetPress Workflow can communicate with a device located at a given IP address and request the status of the object identified by a given MIB OID number.
-
l l Printer Queue group (displayed when Printer Queue is selected in the Condition Type box) l l l l Condition type: Select Printer Queue to test a standard printer status condition or User Defined to test a status identified using a printer specific identification code. Bear in mind that the failure to comply with any of the test conditions selected below will make the whole condition False. Printer status: Select Idle or Printing to test whether the printer is currently idle or printing.
-
the OK button, and are displayed in the Task Comments Pane. 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 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.
-
PlanetPress Workflow to convert the string to uppercase before performing the comparison. l l l l l l l Numeric comparison: This option is not displayed when either “Is found” or “Is not found” is selected in the Operator box. Select to convert the strings from the String and Comparison string boxes to their corresponding numeric values before performing the comparison. If you chose an operator that compares numeric values, you should select this option.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Time of Day Condition Time of Day Condition tasks test the current time and day.
-
l l Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). Grid: Select separate or contiguous time blocks. Click a block to toggle it on or off. Click and drag to toggle multiple blocks on or off. Click date or day at the top of the grid to toggle the whole date or day on or off. Click a time interval on the left margin of the grid to toggle the whole time interval on or off. l Select All: Click to toggle all the time blocks on.
-
l "Output to SharePoint" on page 418 l "PlanetPress Fax" on page 421 l "PlanetPress Image" on page 422 l "PReS Print Controls" on page 432 l "PrintShop Mail" on page 436 l "ZUGFeRD plugin" on page 603 Create MRDX 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.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. 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 The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document. l Repository ID: Enter a valid Capture OnTheGo Repository ID. l Password: Enter the password that corresponds to the Repository ID entered above. l Document ID: Enter the ID of the document to delete from the Repository.
-
l Microsoft SharePoint 2007 l Microsoft SharePoint 2010 l Windows SharePoint Services 3.0 SP2 l SharePoint Foundation 2010 Note Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PlanetPress 7.5 and higher only. Input Any data file present on a SharePoint document store, even those not compatible with PlanetPress Workflow emulations, and the properties of these files.
-
l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously. Folder: The folder in the document library where your files are located.
-
"Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Workflow Tools working folders under the "Backup" folder.
-
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. 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/.
-
Laserfiche Image Viewer. l l l l l l Electronic files: All files will be stored in their original format in Laserfiche. When double-clicking on the document in Laserfiche the native Windows application associated with the file extension of the archive will be opened. Force folder creation: Select to force the folder creation if it does not already exist on the Laserfiche server. Volume: A list allowing to choose among available Laserfiche volumes.
-
Restrictions l l Each Laserfiche Repository Output task uses a connection to Laserfiche. You can use as many Laserfiche Repository Output tasks at the same time as your Laserfiche license allows. If you see the error message ‘The session number was exceeded’ in the PlanetPress Workflow Service Console, it means you have exceeded your allowed number of connections.
-
task, otherwise it will run as many times as there are Metadata sequences, which will result in decreased performance. Use cases Here are some examples of how the Lookup in Microsoft® Excel® Documents task could be used in combination with PlanetPress Design documents. Use case 1: Send personalized emails with promotional document attached A PlanetPress Design document takes a PDF file as the input data file, and reproduces it exactly as it enters.
-
Output The original data file is unchanged. Metadata is updated according to the specified criteria. Task properties General Tab l Excel group l l l l Excel workbook: The full path and file name of a Microsoft® Excel® workbook (.xls or .xslx file). You can use the Browse button on the right to browse to the file on your computer. Excel worksheet: The name of the worksheet you want to use. Once a workbook is open, this drop-down will automatically list all the available worksheets.
-
l l button: Ads a new lookup line. You can have as many lines as you want. The lines will be executed in order from top to bottom, so you can rely on a previous line to bring additional information. l button: Removes the currently selected (highlighted) line. l button: Moves the currently selected line up one place. l button: Moves the currently selected line down one place.
-
l l l l l While debugging this task, the printer shows the message that the document can not be printed. This message is normal and will not appear when running a live configuration. The task uses a printer queue set with the “PlanetPress Word to PDF Printer” driver, which is created and set by default on-the-fly the first time a Microsoft® Word® Documents to PDF Conversion action task is run.
-
PDF page generated by the document. When Mail Merge is not selected, this is the only available choice. Note The Objectif Lune Printer Driver will naturally add a margin to the PDF generated by this task. If your PDF is full bleed you will not get the desired results using this option. l A DOC (Word Document) file which is the result of the mail merge. This output is only available when doing a mail merge.
-
l l Test connection: Checks if the Connection String and SQL Statement are valid, and if the resulting recordset is understood by the Microsoft® Word® document. This is optional, though highly recommended. Output Type: l l .PDF File (with metadata): The result will be a PDF file with the number of pages generated by the combination of the template and record set. Metadata is also included that complement the PDF. .DOC file: The result is a Microsoft® Word® document in .doc format.
-
Input This task ignores the input data file and any metadata it unless data selections are used in the variable data fields. Processing This task does not process the data or metadata file. The information entered in the Deposit tab of this task is sent to the repository configured in the Repository tab. Output The output that this task produces is the information sent to the Capture OnTheGo online repository (the document ID).
-
out, and PDF for documents users can read. l l Document Information group: In this group, you enter information that will help users identify the document. It is mandatory to enter valid information in all the boxes included in this group. l l Cover Image: Enter the path to a cover image that is shown in the repository and library list, as well as the document property. The maximum image size is 512x512 px and it is required to be in JPG or PNG format.
-
OnTheGo Server. If this option is not selected, and if some of the listed categories are not present on the Capture OnTheGo Server, the process will go through and the listed categories will be added to the Server. Advanced Tab The Advanced tab is where you specify the document's time to live either in the repository or the user's device. l Document Handling Options group: l l l l Customize: You must check this box if you want the options included in this group to be used.
-
document will not be removed from the repository based on this setting. Note that the date you enter will automatically be reflected in the For box above. l l Document Tracking: l l l Time zone: When you enter a number of days in the For box or a date in the Until box above, the computer’s time zone appears in this box. You may select a different time zone if required. Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server.
-
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 l l SharePoint Site: The name of the SharePoint site where you want to send the files.
-
l 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. If this option is checked, the Field Information will change to "Use PlanetPress Index (PDF/A)". Field Type: The type of field as set in the SharePoint Document Library.
-
l l User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries. Password: The correct password for the user name. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
-
the PlanetPress Fax host specified in the properties. If the file is a TIFF file in the proper format and the "Pass-through" option is selected, no processing is done, the file is sent as-is. Output A TIFF in the CCITT Group 4 compression, and information for the FAX server to know where to send the file. Task properties General Tab l l l l l Host: Select the IP address of the PlanetPress Fax host to which you want the request to be sent.
-
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 321 task should be used instead. In addition to the job-specific PlanetPress Image properties 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 719).
-
Processing & Output Multiple things can happen, depending on the options chosen and the type of data this task receives: l l l If the data file and a document are selected, and Printer Centric mode is used, the data file is sent to the PlanetPress Image host which merges the data and document to produce output.
-
l l List only documents using VDX compilation: Check to ensure that only documents that are compatible with the VDX compilation method are shown in the list, if producing VDX output. Run mode group (only with PlanetPress Design document) l l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PlanetPress Image. Note that some features, such as the Time and Date functions, require that this option be selected.
-
l l l l l l l Color depth: Enter the color depth of the output image in bits per pixel (bpp). The color depth is measured in bits, because each pixel of the output image can be described with a varied number of bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images.
-
l l Automatically Add Extension: Check if you want the correct extension for the image type to be appended to the file name automatically, rather than having to add it in the Filename box. The Output Type determines the extension to be used. Index group: This group lets you specify which type of index must be created for each document generated by this task. PDI files are used by PlanetPress Search as indexing information.
-
l l l l l l l Optimize for fast web view: Select to minimize file size and facilitate page downloading. Title: Enter a title for the document. If you leave this box empty, the document’s name will be used as the document’s title. Since this is a variable property box, you may use variables and data selections and let PlanetPress Workflow interpret this information at run-time. Author: You may enter the name of the author of the document.
-
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. Since JPEG eliminates data, it can achieve much smaller file sizes than Flate compression. Select Auto to let the application choose the best compression method automatically.
-
sampling. Select Average to average pixel color in each sample area and to replace the entire area with a pixel of the average color. Select Subsample to use a pixel in the center of the sample area and replace the entire area with that pixel value. This method is significantly faster, but results in images that are less smooth. Select Bicubic to use a weighted average to determine pixel shades. This method is the slowest but most precise and results in the smoothest tonal gradations.
-
actually used in the document. This option can only be used if the Embed all fonts option is selected. Note that if more than 35% of the characters included in a font are used in the document, the entire font is embedded. This option often produces smaller PDF files and ensures proper PDF display. l Initial view group l l Zoom factor: Select the magnification at which you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to open the generated PDF.
-
l l l l l l 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. 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 l PReS Classic 6.3.0 or higher must be installed on the same system. A valid PReS Classic license (either dongle or software based) must be available on the same system. Note All PReS Classic licenses are issued and controlled by the PReS License Server and not Connect. Thus a separate PReS Classic license is required. Input A PReS Classic job and the resources it needs.
-
Task properties General Tab l PDC File: Select either an un-compiled PReS Classic script file (PDS) which will need to be compiled on the fly, or a pre-compiled PReS Classic job file (PDC). The job needs to be specified exactly. If you want to compile the job at run time, then you must select a PDS file. If you wish to use a pre-compiled PReS Classic job, then select the PDC file, rather than the PDS.
-
Note If the PDC File selection contains a folder path and the Working Folder also has an entry, then the PDC File entry will be appended to the Working Folder entry. One should be very cautious doing this, as it could easily lead to errors. l PDL Type: Select the desired PReS Classic output type for the job. Note Not all PReS Classic jobs can be swapped between output types. Jobs designed for certain output types (such as AFPDS) will likely have settings specific to the original output type.
-
Note It is heavily recommended that this setting be left as ‘Auto’, as PReS Classic licenses being assigned to different PRNx instances is extremely rare. l Time-out: The time in seconds that the Connect Workflow waits for a response from the PReS Print Control to make sure it is running. If Connect Workflow does not receive a response in the allotted time it will terminate the Print Control and continue to the next step in the workflow.
-
Processing The data file is merged with the selected PrintShop Mail Design document, producing the number of records selected in the task properties. This merging uses the PrintShop Mail engine (PSMail.exe) to generate the output. Output The output produced by this task is dependent on the options selected: it can be PDF, a Windows EMF print job, a PostScript print job or a JPG file. Note that the Preflight output type doesn't actually produce printable or viewable output.
-
l l l l l l l l PDF Type: Select Preview or Print to select which type of PDF should be generated. This option is only available when PDF is selected in the Output type box. PostScript Driver: Select which driver to use to generate the job. This should be the same as the printer selected in your PrintShop Mail document when designing it. This option only appears in the PDF and Produce PostScript output types.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Suite Production. It is not available in older versions nor is it available in the Office and Watch versions of PlanetPress Suite. PlanetPress Capture is not compatible with Connect Designer templates.
-
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 447 or "Find Capture Documents" on page 454 task. However, it is also possible to directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and Metadata are completely ignored by this task's condition rules, and the database information is used instead.
-
l l l l l Document is partial: Condition will be true if the document is still open but only part of the appropriate Capture Fields are filled. Document is empty: Condition will be true if the document is open but no Capture Field is filled. Document is on error: Condition will be true if a logical error was triggered while processing the PGC. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc.
-
l Condition: Defines what should trigger the condition: l Ink is Present: Triggered by the presence or absence of ink in the field. l l l l l l l l l l All: Ink should be present in all fields of this name in your document. Index: The specified index of the Capture Field of this name should contain ink. The Index property is generated when a Capture Field object is repeated or is part of a runpage. This index is 1-based.
-
l l l l Error: A logical error was detected in the field. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc. ICR Value: Triggered when the value given by the ICR engine compares with the specified value. Operators are available for the comparison (such as Equal, Not Equal, Lower or Higher Than, Contains and etc).
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
You may also use a Metadata Sequencer task in order to split the job into multiple parts. This both creates multiple smaller outputs, as well as multiple smaller PDFs in the Capture database. While it is not recommended to separate each document on its own as it removes all optimization and makes the database much larger, you may split into document batches such as 250, 1000 or 2500 documents.
-
l l l Capture Document: Choose the PlanetPress Design capture ready document that will be used to generate the output including the capture fields. Document Title: Enter a name for the document that will be saved inside the PlanetPress Capture Database. This name should be unique and recognizable and will be used later to retrieve the document form using the Get Capture Document action task. Document Title group: Determines a Title for the document.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
-
During processing, ink is always applied to the document first and then the logic is applied for releasing patterns. This means that even if a document is closed by a field set as Final that was checked first, ink present in other fields will still be applied to the document. From version 7.5 and onwards, ICR is done on the ink, if the "Perform ICR Recognition" option is checked.
-
l l l l l CapPatternSequence: The value of the pattern sequence assigned to the document. CapPGCName: The name of each PGC file that was used to update this document (will repeat for each PGC file) CapStatus: Current status of the document: l 0: Open l 1: Closed by an optional field l 2: Closed by a mandatory field l 3: Closed by a final field CapTemplateName: Name of the PlanetPress Connect document used to generate the document.
-
l l l l l l 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. ICR Settings group l l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. Perform ICR Recognition: Triggers the PlanetPress Capture ICR engine. For more information, see PlanetPress Capture ICR.
-
another split generates an error, it also triggers the On Error tab. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
-
Processing The PGC file is split by document, if a document can be matched for each pattern ID found in the PGC. The match is made by comparing each Pattern ID with the information found in the Capture database. If more than one pattern is used in a document (pattern on multiple pages of the document), all of the information for this document (more than one Pattern ID) is sent down as a split. Patterns that do not match any document are sent individually, one Pattern ID per split.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011.
-
l Metadata Level: A drop-down list containing all of the levels of Metadata. Choose the one where the ICR data will be added. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
-
Input Because this task in an Input task, it does not use the current job file in your process, even when used as a secondary input task. Processing This task connects to the Capture database and looks up all available documents that meet the criteria specified in the plugin. Then it does further processing to retrieve relevant information about each document and places the information in the data file it generates.
-
l l l l l l l l Date Closed: The date, in YYYY-MM-DD format, when the document was closed by the Capture Field Processor or Get Capture Document tasks. This field is empty in documents that are still open. Pen user (by description): The description of the pen, as entered in the "PlanetPress Capture Pen Management Tool" on page 695. Generally, this is the name of the owner of the pen.
-
l l l l l l l l l l l Contains: Inclusive string comparison, documents where the specified value is present within the chosen filter are included. Does not contain: Exclusive string comparison, documents where the specified value is not present within the chosen filter are included. Before: Date comparison, documents of which the date is previous to the specified value are included (Date Generated and Date Closed filters only).
-
this option unless you are aware of the loss of performance and actually need to access each field's properties individually! On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
-
Processing One PDF, corresponding to the information present either in the Metadata or specified in the task, is extracted from the Capture database. When retrieving documents from the database, the PDF from which the document is obtained will remain in the database until each document contained in it is retrieved from it. For example, if a 10-page PDF contains 5 documents, the 10 pages remain in that PDF until all 5 documents have received ink, been closed and retrieved from the database.
-
Task properties General Tab l Document Origin group: l Document to process: Determines where the document information is read l l l l l From Specific ID: Select to specify an exact Document ID from the database. This document does not need to be loaded as a data file or its Metadata manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database.
-
PGC to PDF Converter The PGC to PDF Converter task extracts the digital ink located in a PGC file and adds it to a blank PDF, creating one page per document in the PGC. It's main use is to process PGCs that generated errors when processing them, as part of an Error Handling process. Note When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False.
-
Note This task was built using a custom plugin system and does not display the On Error tab in the regular view. To access the On Error tab, right-click on the task and select Advanced Properties... On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
-
Create Metadata Creates all the Metadata that is either the information about a data file, or the result of the merging between a data file and a PlanetPress Design document. For more information about Metadata see: "Metadata" on page 69. This task is put into effect in the following example processes. l "Example: Daily sales report from PDF files" on page 192 l Basic Functional Capture Workflow l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite.
-
l In XML emulation, the Metadata file is always created as if the user had specified the "Second Level" parameter in PlanetPress Design. Output The original data file is output, along with the newly generated Metadata file. Job Info variables are not changed. Task properties General Tab l l Documents: Select the Do not use a document (passthrough) option to create Metadata based on the data file alone.
-
Input A PDF File, either with no Metadata and along with Metadata that presumably corresponds to the PDF file, or a PDF file with embedded Metadata. Processing If the Embed option is used, the Metadata information is embedded directly into the PDF File as binary data. This does not change the way the PDF is viewed by any PDF viewer. If the Extract option is used, Metadata present inside of the PDF file is extracted from it. If no Metadata is embedded, the task generates an error: W3976.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata Fields Management The Metadata Fields Management task can be used to add new fields into your Metadata, either for every element or through conditions. For more information about Metadata see "Metadata" on page 69. Note This task will automatically loop through the Metadata and repeat its action for each of your Metadata's datapages.
-
l l Metadata Fields Management actions on the page level are not possible since the entire task execution is based on the data page node. 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.
-
l l Field Value: Enter the Metadata field value. Note that if the chosen action is Delete, this parameter is disabled. For other action types, in order to set the field value, click the [...] button. This button opens the Data Selector, which allows to specify a data selection as the field's value. 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.
-
process. For more information about Metadata see "Metadata" on page 69. Input This task takes any file as input and does not modify it. Process This task does not execute any change to the process, its files or variables. It only executes the selected action on Metadata. Output This task outputs the exact same data that was given to it. Its Metadata will either be missing (Delete Metadata), Changed (Load Metadata) or the same (Save Metadata).
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
l l l l l Group: Select the Metadata Group nodes (the nodes only) based on the specified rule(s). Document: Select the Metadata Document nodes (the nodes only) based on the specified rule(s). Datapage: Select the Metadata Datapage nodes (the nodes only) based on the specified rule(s). Rules: Define according to which criteria the action must to be performed. The condition must be TRUE to execute the action. All nodes on a specific level with false condition become unselected.
-
Metadata Level Creation The Metadata Level Creation task conditionally creates new Metadata groups or documents. This task is only functional if Metadata already exists for the current job. For more information about Metadata see "Metadata" on page 69. The task enables users to merge data pages into Documents and/or merge Documents into Groups, based on conditions. Unselected Data pages are ignored, but are moved with other Data pages if the action is applied to the current parent node.
-
With this example, before the Metadata Level Creation task, the Metadata structure contains one group containing one document (containing multiple data pages). After the Metadata Level Creation task, the Metadata structure contains one group containing multiple documents. Input Any data file with accompanying Metadata. Processing The Metadata file is split on the selected level. Output The original data file is output, along with the modified Metadata.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. 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 Metadata level: Select the Metadata level to process. l Sequencing is based on l l l The following number of occurrences of the level: Determine a sequence based on the number of instances found for the Metadata level currently processed. For example, if the Metadata level is set to Group, and this value is set to 3, each sequence contains 3 groups (except, possibly, the last one, depending on the number of groups left in the last sequence).
-
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.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata to PDI The Metadata to PDI task takes the active metadata and generates a PDI using the information in that metadata. It is generally used in conjunction with a PDF data file and is used to generate the PDI file which is used by PlanetPress Search when building, refreshing or rebuilding its database. For more information about Metadata see "Metadata" on page 69.
-
l Index Group: l l PDI: Only generate a PDI file. PDI and XML: Generate both the PDI and an XML equivalent (not used by PlanetPress Search). On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
-
Tip To print a Connect template with an N-Up print layout you need an Output Creation Preset with the correct production options. See "OL Connect print jobs" on page 98. Also see Output Creation Preset and Print Options in Connect's Online Help. Input Any data file with accompanying Metadata. Processing The Metadata is re-arranged and/or duplicated in order to correspond to the options set forth in this task's properties. Output The original data file is output, along with the modified Metadata.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. OL Connect Send Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application.
-
All job info that could be retrieved will be written to a temporary results file that is then passed on as the new Workflow job file. It can be used right after the Get Job data plugin in the same Workflow configuration. It could for example be saved using a Send to Folder plugin. Note The Get Data plugin gets data from the OL Connect Send database which means it only works when Connect is in LICENSED mode.
-
Operators l Searches are case-insensitive. l Multiple entries in one filter field are combined with: OR. l Entries in different filter fields are combined with: AND. Example 1 A valid user name search string, entered in the Filter Users field, would be: %\{global.
-
2016-07-12 It is possible to only define a date without a time. 2016-%m-%d Standard Workflow variables for year, month and day are allowed. 2016-07-12 11:00 From and To dates may also have a time indicator (24 hour notation, separator from the date is a space character, separator between hour and minute is a colon) It is possible to define the same date for From Date/Time as for To Date/Time. However, entering the same info (without time information) would lead to getting no entries.
-
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. Returned information For each job received by the OL Connect Send Job Processor plugin the following values will be available. l l Job UID: This is the 10 (ten) character long Unique Job Identifier string.
-
l l l l l l l User name: This is the Windows user name of the user who started the application to produce the print job. It is not - in all cases - the user name of the user who is currently logged into the system. Original file name: This is the "file name" as sent from the application to the Windows spooling system. It is taken from the name as it arrives in the spooler. Some applications add info to the name (like Notepad++) while others don’t (like Adobe Reader).
-
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 from 10 upper- and lowercase letters and digits e.g. “ri0zZdluLp”.
-
processing. l Read from Variable: When selecting this option, any existing Workflow variable can be chosen via the drop-down field. In this case, the plugin reads the Job ID from that variable. Select Returning Type Depending on this setting the plugin gets status information about the job before it has arrived or it gets information after the job has been completely received.
-
l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Date/Time stamp: This is the time when the matching job was initially created in the database. It is stored in UTC format plus time zone indicator inside the database. It will differ from the time stamp logged by the OL Connect Send Printer Driver as well as by the OL Connect Send Job Processor. Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value.
-
l l l Domain / Workgroup Indicator: This domain name is the real domain name or only a workgroup name. For explanations about domains, domain names, users, user names, user domains, logged on users vs. application running users, machine names etc. please refer to the respective Windows help pages or ask your system administrator. Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API.
-
Note It is strongly recommended that a single job transfer process for all OL Connect Send Printer Drivers is created, using the domain or machine’s or user information to divert to any follow-up processes. This single transfer process can be set to "Self Replicating", so that parallelization is possible.
-
Security In order to provide security when printing over the internet, OL Connect Send includes several protective features. HTTPS Communication The OL Connect Send Printer Driver can be set to use HTTPS for any job transfer. To do this, Workflow must also be set to use HTTPS. Job Origin Each print job will include unique information about the machine it has been sent from. This unique machine ID is calculated with a proven method and will be transferred, encrypted and enhanced.
-
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. In unlicensed mode, the user name, machine name and domain/workgroup name will not be available through the metadata.
-
Information Workflow Variable When licensed When unlicensed License status for this job %2 "Licensed" "Unlicensed" Username 1 %3 The user name "na" IP Address 1 %4 The IP address The IP address No. of Pages 1 %5 Number of pages of the job Number of pages of the job No.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. OL Connect tasks OL Connect tasks are available in PlanetPress Workflow 8.0 and up.
-
Note When added as an Output task, the All In One plugin works asynchronously to the Workflow process. Task properties Data Mapper Tab The Data Mapper step generates a Record Set from a specific source: data mapping on the appropriate source (Current Data File, Database or PDF/VT data file), Retrieving items from the Connect Database (filter setting) or uses the current job Metadata. The resulting Record Set is given to the Content Creation part of the task.
-
as well as the time required for the cleanup process. However, since the data is not written to the database, there is no way to do post-processing on the extracted data after the All In One operation has completed. Any postprocessors defined in the data mapping configuration will be disabled. This option is unchecked by default. l Filter: Retrieves records from the Connect Database. This is identical to using the Retrieve Entities task.
-
l l Metadata: Uses existing Metadata, generally the output of a "Execute Data Mapping" on page 522 or a "Retrieve Items" on page 533 task set to retrieve Records or Record Sets. This source has no options as it expects valid Metadata. PDF/VT with Content Creation: Expects a PDF/VT file as an input and executes basic data mapping on the file. This is the same as using the passthrough option in the "Execute Data Mapping" on page 522 task. Content Items are created automatically.
-
l Job Preset file: Select which Job Preset to use to generate the job. l l l l Default: The IDs in the Metadata are used instead of a job preset file. None: Select this option to prevent the execution of Job Creation and Output Creation. In this case you also have to select 'None' on the Output Creation tab as well. "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below.
-
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 User Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server.
-
l Sort items based on: Lists the different sorts to apply to the entities. l l l Name: Click and enter the name for the Value or the Property to sort on. Type: Select whether the Name option refers to a Property or a Value within the entity. Order: Select how to sort, either Ascending or Descending alphabetical order. l Add: Click to add a new line to the sort list. l Remove: Click to remove the currently selected line in the sort list.
-
l A JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 82). When the "Retrieve Items" on page 533 task is set to output Records in JSON, it outputs this kind of JSON data. If the input is JSON, the task performs a REST call to the /rest/serverengine/workflow/contentcreation/email/{templateId} endpoint on the Connect Server. For more information see the REST API Cookbook.
-
Properties General Tab l Template l l l l "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template. Adding template is done through the Send to Workflow option in the Designer Module. Section: Enter the section name that will generate output. Only one section can be output. If no section is defined or if the section name is invalid, the default section will be output.
-
Email Info tab l l l l l l Sender Address: Enter the email address that appears in the "From" field of the email. Mail host: Enter the address of the SMTP server through which emails should be routed. The address can include a port number. This information should be available from your IT staff. Send emails to sender (test mode): Check to ignore the email address from each record and send all emails to the address entered in the Sender Address field instead.
-
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88.
-
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 task for printing. Task properties General Tab l Job Preset file: Select which Job Preset to use to generate the job. To be used in this dialog, a preset must have been sent to PlanetPress Workflow using the Package File function in PlanetPress Connect.
-
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88.
-
Input The task requires a valid Job Metadata file, normally output from a Create Job or Merge Jobs task. Processing The job is sent to the OL Connect Server for processing. Output Depending on the options set, either a simple metadata file with information about processing is returned, or the actual output file created by the server. Properties The Create Output task properties are as follows: General Tab l Output Preset file: Select which Output Preset to use to generate the output.
-
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 User Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server.
-
Processing The 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.
-
Create Preview PDF The Create Preview PDF plugin generates a PDF preview for a single record as fast as possible. This preview is typically used for previews embedded in web pages. The plugin retrieves the resulting PDF from the file store and makes it available to the process as the job data file. The job file name extension is .pdf.
-
model attached to the chosen configuration in the DataMapper module, to verify that the right one is used. l No storing or post-processing of the data records (faster): This option prevents data from being written to the database. Instead, records are streamed directly into the Content Creation process for immediate merging. Turning this feature on can improve data mapping performance significantly, as well as the time required for the cleanup process.
-
message. Note This option requires that keys in the JSON string have matching field names in the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data). l Metadata uses existing metadata, generally the output of a Create Record Set or a Retrieve Items task set to retrieve a record.
-
JSON string samples The following JSON string samples show various techniques to incorporate data in a JSON string.
-
[1]',Value,KeepCase,NoTrim)" } A JSON string that contains nested data: { "name":"Peter Parker", "email":"parkerp@localhostcom", "ExtraData":"foobar", "detail": [{"id":"inv123","ExtraData":"hello"}, {"id":"456","ExtraData":"world"}] } Content Creation tab The Create Preview PDF plugin creates a preview PDF from a template selected on the Content Creation tab, using the record that results from the data source selected on the Datamapper tab.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
l A JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 82). When the "Retrieve Items" on page 533 task is set to output Records in JSON, it outputs this kind of JSON data. If the input is JSON, the task performs a REST call to the /rest/serverengine/workflow/contentcreation/{templateId} endpoint on the Connect Server. For more information see the REST API Cookbook.
-
Properties General Tab l Template File: l l l l "None" File name: Select to accept a PDF/VT file as an input and automatically create content items based on the PDF/VT. "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template. Adding a template to the resources is done through the Send to Workflow option in the Designer Module.
-
OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences. 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.
-
This task can be added as an Action task (see "Action Tasks" on page 291) or as an Output task (see "Output Tasks" on page 539). 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 must receive either a valid Record ID or a JSON object. Record ID A valid Record ID can be retrieved from various data sources.
-
Note Content creation may be aborted by a script in a Connect template that raises a fatal error. This triggers the On Error tab of the Content Creation task. See Designer Script API. Output The task outputs HTML code as a job file. Within this HTML code, references to external resources point to the local OL Connect Server and are served to the requester directly when the HTML file is opened in a browser. Properties General Tab l Template File: l l l l "%o": Select to use a dynamic template name.
-
the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data.) Warning The JSON format is not validated by the plugin; it is passed as is to the server. Note Only the first record or JSON object is processed, since this task can only generate HTML output for a single record.
-
isn't added and local anchors aren't modified. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences. 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.
-
without using a data mapping configuration. Input Optional. Both main options can refer to external files, but either one can be the active data file using %F. By default the Data Source is set to use the active data file as input. Note To open a Microsoft Access database, you have to use the Load External File task just before the Execute Data Mapping task.
-
l l l l "None": Select to execute default, basic data mapping on the input PDV/VT file. "%o": Select to use a dynamic data mapping configuration name. Click on %o to change the expression that determines the name of the data mapping configuration to use. Right-click it to open the contextual menu that allows to select variables, data and lookup functions (see "Data selections" on page 48). Configuration Names: Select the appropriate data mapping configuration.
-
error: The error message, or an empty string when no errors have been reported for this record. Document nodes with an error are selected, while those without an error are unselected, to make looping through all errors easy. l Tip To determine if there were any errors in a job and handle it accordingly, you can use a Condition that checks if GetMeta(SelectedCount[0], 11, Job.Group[0]) is greater than 0, immediately after the task (see "Conditions" on page 125).
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name.
-
Processing The task tries to download the requested file from the OL Connect File Store by performing a call to the /rest/serverengine/filestore/file/{fileId} REST endpoint; see File Store Service: Download File in the REST API Cookbook. Output The downloaded file becomes the current job file and retains the file name that it had in the OL Connect File Store. Task properties General Tab l Filename or File Store ID: Enter the name of the file in the OL Connect File Store or its File Store ID.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Store - Upload File The File Store - Upload File task uploads the current Job File to the OL Connect File Store.
-
l l Save File Store ID in variable: Select the variable in which to store the File Store ID that is returned after a file has been successfully uploaded to the File Store. This ID can be used to download or delete the file from the OL Connect File Store. Mark as permanent: When this option is checked, the file will never be removed automatically by Connect's Clean-Up Service. Non-permanent files may be removed if there are no remaining references to them in the Connect Database.
-
Mark Connect Sets for Deletion The Mark Connect Sets for Deletion task indicates that an item in the Connect Database should be deleted the next time the Database Cleanup runs. This means that whatever item is set for deletion will no longer be available from the database. Input The task requires a valid Metadata file containing items for deletion, including Job Sets, Content Sets and Data Sets. These can be created by the Execute Data Mapping, Create Print Content and Create Job tasks.
-
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.
-
Output The task outputs a merged Metadata Job File which can be used in the Create Output 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. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks.
-
Output The task outputs Metadata that is equivalent to the output of the appropriate task that would normally create the items, or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 82). Note The result of a Retrieve Items task can be used with the "Create Job" on page 504 task if it is a Content Item or Content Set, but it cannot be used in combination with a Job Preset. Note Content Creation tasks accept Metadata as well as JSON data as input.
-
l Retrieve by: l l l l l l l l l ID: Depending on the option selected under Entity to retrieve this is a Record ID, Record Set ID, Content Item ID, Content Set ID, Job ID or Job Set ID. Multiple entities can be retrieved by entering multiple ID's, each on a new line. Conditions: l l Condition: Select entities based on one or more conditions, the value of a metadata field for example. Add a condition: Click to add a new condition line.
-
to retrieve drop-down. To modify any of the following options, click in the Parameters box and then click the [...] button that appears. l Document contents: Defines the Document ("Mail Piece") level and how they are built. l l l Pick items based on: Use the [...] to open the "Pick Parameters" on the facing page dialog and define how to pick which items will be placed in each document. Content items picked using this method will be part of the same mail piece. Sort items based on: Use the [...
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
Input The task must receive Metadata that contains appropriate entities, generally from the Create Record Set, Create Print Content, Create HTML Content Set or the Create Job tasks. Processing The task sets the chosen properties to all entities present in the Metadata. These properties are added to the entities on the OL Connect Server. Note that the properties are calculated only once, and are applied identically to all entities.
-
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.
-
has sent its request to PlanetPress Image, not once PlanetPress Image has finished generating the actual image file. Other tasks available in PlanetPress Workflow can also be used to generate output, such as Digital Action, Create VDX and PrintForm Action tasks. Unlike Output tasks, Action tasks are only considered completed once the output file has been generated.
-
Input Any data file, with optional metadata. Processing The data file is either deleted directly or sent to the Windows Recycle Bin. Task properties General tab l Move to recycle bin: Select to send the deleted files to the Windows recycle bin. When this option is not selected, files are deleted permanently. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Comments Tab The Comments tab is common to all tasks.
-
Processing The file is sent to the FTP Server and location defined in the task properties. Task properties General Tab l FTP Server: Enter the IP address or host name of the FTP server. l Port number: Set the plugin to use a specific port number. l l Use FTP Client default port number: Use the value as specified in the Preferences (port 21 is the default value). FTP Port: Enter the specific port number to use when Use FTP Client default port number is unchecked. Enter a value between 1 and 9999.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SOAP Client plugin SOAP Client plugin tasks can be used as Input, Output and Action tasks, although their basic function is to generate output.
-
Task properties General Tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the drop-down list. Note The WSDL Address of a 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 l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
-
l l l Value: Lets you enter fixed or variable values. To exchange variable information between the Web service and PlanetPress Workflow, you must use job information variables %1 to %9 or variable %c (which contains the entire job file). Note that return values (arguments which are used to return information to the SOAP Client) are displayed in bold font. Namespace: Displays the namespace of the arguments associated with the selected method.
-
file, so this task will always generate a larger and slower print job. However, this Output task can work with non-PostScript printers such as HP PCL printers. The Print Using a Windows Driver Output task requires a PlanetPress Workflow license, otherwise this plugin will cause a watermark. Note This type of output task does not support PDF transparency and duo-tone features, so you should not use it with PlanetPress Design documents that use those features.
-
l 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. 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).
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
-
place the file in the destination. Sending this same file to an LPR or Windows queue will produce no output as these queues expect valid PostScript. Task properties General Tab l l Queues: Select the queues to which you want to send the output (see "PlanetPress Workflow printer queues" on page 100). Documents: Select None if you want the job file to be printed as is.
-
Advanced Tab l l Copies: Enter the number of copies to be printed outputs. Since this is a variable property box, you may enter a fixed value or use a data selection. Note that load balancing options have an impact on how copies are printed as well as on the total number of printed copies. Load balancing group (Options from this group are only valid if multiple Workflow printer queues were selected.
-
l l 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. Add job information to the document: Includes the current "Job Info variables" on page 557 to the job output. This option is only available if a document was selected in the General tab.
-
l Capture Post Processing Workflow Note that Capture is only available to PlanetPress Suite users. Input Any data file. Processing While an email is always sent by this task (or at least attempted to be sent), the contents of the file and presence of attachments depends on the selected option. Refer to the property descriptions below to know what each option does.
-
Note Different email clients have different support for various features, especially with HTML emails. In most cases, if you want to send your email as an HTML message, your very first line should start with or . It should not be any other character). Also note that it is not currently possible to send both an HTML and plain-text version of your message.
-
Login Tab l l l l l l l l l l 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. Use SMTP mail: Select to use Simple Mail Transfer Protocol (SMTP) to send the emails (and attachments).
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send to Folder Send to Folder Output tasks send the files they receive to a local folder. They perform the same function as Send to Folder Action tasks, with the only difference being that in this case, PlanetPress Workflow will not wait for the task to be completed before going on to the next task in the configuration. Input Any data file.
-
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Unknown tasks An Unknown task is a task location that is not linked to any existing known task.
-
l l l l Global variables are available to all processes and tasks within the configuration, and any modification made to them affects all tasks and configurations. For more information see "Global variables" on page 565. Local variables are specific to an instance of a process. That is to say, when a process changes the information in a local variable, it changes it only for that process and only for that specific instance of the process. For more information see "Local variables" on page 564.
-
Note l l While the initial Job Infos are created by the input task, they can be overwritten by the Set Job Info and Variables Action task, by a Script, or by any secondary input task in the process. Whenever you use a job info in your process, make sure it contains the value that you want, and not one that has been overwritten by another task. Job infos are limited in quantity and are slowly being deprecated when transferring data to your documents.
-
ExpandString() function. For more information, please see the PlanetPress Design User Guide. Standard variables Standard variables, also known as "system variables", are variables that are 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.
-
Variable Name Example value when interpreted %y Current year 2010 %m Current month (numeric) 06 %M Current month (text) June %L Current month (short text) JUN %d Current day (numeric) 16 %D Current day (text) Monday %l Current day (short text) MON %h Current hour 18 %n Current minute 03 %s Current second 41 %v Current millisecond 24 %u Unique 13char string (will be different every 0ZIS4CW8U47VI00 Page 560
-
Variable Name Example value when interpreted time it is used) %U Unique 36character string consisting of 32 alphanumeric, lower case characters and four hyphens. Format: xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx (8-4-4-4-12 characters). 123e4567-e89b-12d3-a456-426655440000 %t Current temporary folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool\6.tmp\ %e Current Metadata file name job00ZAIZ2C4FXON16CE6C566.dat.
-
Variable Name Example value when interpreted %w Current process name My Process %i Current Loop iteration index (always the innermost loop) 2 The %i Loop Count variable The value of the %i variable is equivalent to the current iteration of loops inside of a process. It always contains the value of the innermost loop, and only certain tasks trigger the counter to start.
-
l 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 following variables are available in error-handling tasks (that start with the Error Bin Input task). Note that these are new in PlanetPress Workflow 7.4 and are not available in previous versions. Variable Name % {error.process} Name of the process where the error was triggered % {error.
-
Local variables Local variables are set at the level of a process and are not shared with any other process or instance of that process. Local variables can be used anywhere where a variable is accepted by using its name, surrounded by curly brackets and preceded by a percent sign, for example: % {myLocalVariable}. When the process ends, the local variable forgets whatever value was given to it by the process and goes back to its default value.
-
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.
-
configuration file to another installation of the Workflow tools where this information is different, or to quickly modify specific information if something changes on the server. You can have as many global variables as you want in any given configuration. Adding a global variable To add a global variable from the Configuration Components pane: 1. Right-Click on Global Variables. 2. Click Insert, then Insert Global Variable.
-
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 Static data. l Standard Variables. See "Standard variables" on page 559. l Local and Global Variables. See "Local variables" on page 564. l Job Infos. See "Job Info variables" on page 557. l Data and Metadata Selections. See "Data selections" on page 48. l Printer Control Characters. See "Shared printer queue properties" on page 101. These are normally only used in printer outputs.
-
l l l l l l Get Data Value: Brings up the Data Selector, retrieves the value you select and places it in the variable properties box. This information becomes static and does not change between each datapage and job file. Get Data Location: Brings up the Data Selector and records your selection. The data selection is dynamic, meaning it will get the data located in the area you choose, every time a new data file passes through it.
-
some types of processes like PDF and HTTP processes, and processes related to another product, are important enough to pay some attention to them. This chapter will describe each of these special workflow types and give at least one example of an implementation that uses them. HTTP Server workflow An HTTP workflow receives requests from a client via a GET or POST request, sometimes only with information, sometimes with attached files.
-
PlanetPress Capture Workflow (PlanetPress Suite only) A Capture workflow is divided in two steps: Creating an output of documents containing the PlanetPress Capture Fields, and retrieving the information from the Anoto Digital Pen to merge it with the original documents. See "PlanetPress Capture Workflow" on page 194 for more details. PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Suite Production.
-
Anoto Digital Pen A digital pen compatible with the Anoto system. These pens contain a camera, processor and memory chip which record each stroke of the pen on a printed Anoto Pattern, and are able to send this information back to PlanetPress Workflow. This document specifically refers to the Anoto DP-201 Digital Pen, not other equipment has been tested.
-
Client/Server Architecture A multi-server setup where more then one PlanetPress Workflow server are connected as clients to a single PlanetPress Workflow server which has a Capture Database. In this architecture, the Server contains the licenses for the pens, however the Client contains the database of documents and patterns. The Clients communicate with the server to authenticate pens. This architecture is only provided to simplify pen licensing for users with a large number of pens.
-
Pattern 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.
-
multiple fields in any order. A new session starts whenever a PGC is sent for processing (which erases the data from the pen). 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.
-
l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PlanetPress Workflow through an ODBC connection on the local network. Database file (mdb) must be local to the PlanetPress Workflow computer. It cannot be located on a network drive or another server. l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations.
-
l l l l In Microsoft Access, the total size of stored document cannot be larger than 2GB and this database will be very unstable in implementation with more than a few thousand pattern sequences being used simultaneously. It is only suggested for small implementation with less than 10 pens, or for demos. In MySQL, the 16 megs packet size limit can be an issue if the PDFs created by Capture are larger than this size; An error saying "MySQL Server has gone away" would appear in this case.
-
Here are a few notable points with the security of PlanetPress Capture on a network: l l l l l PGC Files, while not written in plain text, are not encrypted and are readable through either PlanetPress Workflow (even a server that did not generate the document associated with it), or through third-party applications using the Anoto SDK.
-
PlanetPress Capture implementation and then explain how the 20,000 patterns limitation can be circumvented in some cases. We will also touch upon the potential pitfalls of these workarounds as they are used. The Numbers First and foremost, the 20,000 patterns is a fixed number - PlanetPress can only generate 20,000 unique patterns as this is the number of patterns that we license through Anoto. The 20,000 patterns are, however, not all available when generating documents.
-
N of these documents are closed through regular process (writing on them with a pen and docking it) during that period, does the difference between both ever reach 20,000? Example Say you print 19,000 pages containing a pattern, every day. You may think you'll "run out of patterns" after a single day. But if 18,900 of these documents are being written to and processed within the day, at the end of the day you only have a 100 page difference, possibly due to mistakes, lost pages, or errors during processing.
-
Using Pattern Sequences In the event where a single location generates all the patterns and this output *can* be split into multiple logical zones, Pattern Sequences can be used. A Pattern Sequence is basically a "tag" that is added after the pattern's identification (Pattern ID). When a Pattern Sequence is used, each Pattern Sequence can re-use each of the 20,000 available patterns.
-
As you may have figured out by now, we are still not actually printing more than 20,000 patterns. The only distinction here is that we are re-using patterns in separate "zones" (or, well, sequences) and as long as pens and pages using capture patterns are not exchanged between these zones, they act independently with their own 20,000 pattern limitation.
-
Second, contamination can happen in method 1) above if a pen or paper is moved from one location to another. Similarly to the previous contamination example, if there exists a document in the Capture Database where the "wrong" data is processed, it will update a document where it does not belong. Again, neither the pen nor PlanetPress Workflow have any idea that this causes an error until it's too late.
-
l l l When necessary, patterns can be extended using multiple servers or Pattern Sequences (as long as these are used in separate physical locations). It is extremely critical that contamination be avoided at all costs. Whenever possible, always avoid using pattern sequences unless it is absolutely necessary to do so. Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc.
-
To pair penDirector with an Anoto Digital Pen: 1. Make sure that a Bluetooth dongle is present and enabled on the computer where penDirector is installed. 2. Note down the PIN of the Anoto Digital Pen, by docking the pen and going in the Pen settings tab of penDirector and looking at the Pen access group at the bottom of the dialog. The default PIN is 0000. 3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4.
-
PlanetPress Mobile Application The PlanetPress Mobile application can be installed on some mobile phones and enable fast and direct connectivity between the Anoto Digital Pen and PlanetPress Workflow. The connectivity between the pen and the mobile phone is done through Bluetooth, while the connectivity between the mobile phone and PlanetPress Workflow is through the currently active data plan (either wifi or the cell phone company's data plan, such as 3G).
-
Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
-
This is because the pen's camera (which captures the position of the pen) is located under the pen tip and must fully see the pattern.
-
Knowing this, the best practice when creating fields is that they have, at the very least, a 7mm margin on each size of the actual area you want to capture from. For example, an effective 30mm wide pattern will actually be 44mm wide using these margins. The margin should be for both the vertical size and the horizontal size.
-
PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition". The difference between the two is easily explained: While OCR can only recognize characters using the finished shape (for example, in scanned documents and pictures), ICR relies on much more data which is provided by the Anoto Digital Pen: the path that the pen takes, the exact timing of this path, start and stop points, etc.
-
Guide). This must be either a Multi-Area Field or a Text Field. l l l The Capture Fields Processor must have the Perform ICR Recognition option checked, and language needs to be selected. Once the ICR data is available, do something with it. This is done by reading the ICR data that is available in the metadata generated by the Get Capture Document task. The metadata is also readable by the Capture Condition task, including the captured text and the reliability of this text.
-
l l l ICR Value: The alpha, numeric or alphanumeric value that was determined by the ICR engine. ICR Confidence: A percentage value that the ICR engine gives to any specific value, when comparing the pen data with it's character database. ICR Resemblance: A percentage value that defines how closely the value resembles the "average" character shape. Both the Confidence and Resemblance can be used together to make an informed decision on the contents received by ICR.
-
The following guidelines are applicable when configuring a PlanetPress Capture object that utilizes ICR: l l l l l l l The collected data is expected to be a number, therefore the numeric mask type must be selected, or The collected data is expected to be a letter, therefore the alphabet mask type must be selected, If upper case letters are expected, select Upper case in the Case option menu. The captured characters would be immediately converted to capital letter i.e.
-
The following diagram illustrates the available mask types. It is recommended to select the mask type that is the closest to the desired result. An alphanumeric field should be used as a last resort. Guidelines for Capture-Ready Fields l l Target: Form designer What: Only one character per Capture field can be recognized. When expecting multiple characters making up a word or phrase, you must make sure that the user only writes one character per field.
-
Why: To avoid any ink marks that would spill over from one field to another. If both fields A and B are to close in proximity and the ink marks from field A spill over to field B, then the marks captured on field B would be considered as being part of a character written on field B. For example, if a number spills over and is written over two fields like numbers 9, 1 or 7; then the bottom tip of these numbers could be considered as number 1 in the second field.
-
How: Make sure there’s enough space between each field. You must re-design the document if that’s the case. There’s no minimum value that is required as the distance between 2 fields, except for the 7mm border that is required in order for the Anoto digital pen to recognize the pattern being used. Writing in a Legible Way l l Target: User. What: It is important to write in a legible way i.e. applying yourself by writing well defined numbers and letter that are easily interpreted.
-
Selecting the Correct Language When Using the Capture Field Processor Task l l Target: Workflow designer. What: It is crucial that the correct language is selected when using the ICR recognition option. This will affect how the captured data is interpreted. Why: The available filters to interpret the ink marks done with the Anoto digital pen, allow you to select the engine language to be used. Doing so will give you results that are the closest match to the captured data.
-
Possibility of Interpretation Error in an Automated Process l l Target: Workflow designer What: We cannot be 100% sure that a character would be recognized by PlanetPress Capture as it should. Therefore, the analysis of a value interpreted with ICR should only occur if the level of confidence is superior to a determined level.
-
Why: An automated process can treat the characters incorrectly due to an incorrect interpretation of a value. This occurrence should be minimized as much as possible. How: Allow for a special process (possibly manual handling) in the case the automated process didn’t reach a high confidence level in its analysis of the ink marks. Use the plugin Capture condition that includes the ICRContent option. This can be configured to be a true condition if the confidence level is greater than a certain value.
-
Note Because of technical limitations, the minimum time required to generate a PlanetPress Fax document is approximately 10 times longer on Windows 2000 than on Windows XP/2003. About PlanetPress Image PlanetPress Image is a multi-threaded service that can generate image files in PDF, JPEG and TIFF format. As PlanetPress Workflow and PlanetPress Image are compliant with AutoStore, DocAccel and KYOcapture, these formats can also be used.
-
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 719. Note that those options are specific to each PlanetPress Image installation and that they are immediately applied.
-
Workflow. This is what the OL Connect Send Get Job Data plugin is made for. (See "Get Job Data" on page 485.) l l The Create Web Content plugin. Each web page served by an interaction process is generated by this plugin. (See Create Web Content.) The Create Preview PDF plugin generates a PDF preview for a single record as fast as possible. It is typically used for previews embedded in web pages. (See Create Preview PDF.
-
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.ferdnet.de/zugferd/definition/index.html. Licensing The ZUGFeRD plugin is bound to the Connect Workflow Imaging license. Workflow Imaging is an add-on license bundle for Connect Workflow that includes the Image and Fax plugins.
-
itself. For general information on the Plugin, see "ZUGFeRD" on page 602. The ZUGFeRD plugin is not currently included in the standard Workflow installation, and must be installed via the standalone ZUGFeRD plugin installer. The ZUGFeRD plugin will be installed to the Connectors Plugin bar. Input A PDF file that is PDF/A compliant. The PDF/A conformity level doesn't matter. It may be 1, 2 or 3. Processing The plugin first checks that the PDF is PDF/A compliant, and doesn't already contain ZUGFeRD data.
-
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. For more information on Workflow context menu data selection options, see this page: Workflow Variable Properties l Zu verwendendes PDF: This group allows selection of the PDF file to process and enrich with the ZUGFeRD-XML information.
-
l Rechnungsdatum: The invoice date. This entry can be set directly, or through the date selection pop-up that appears when the drop down icon is selected. Note The date must be formatted in standardized UTC format: yyyy-mm-dd Any other formatting will lead to a run-time error. l Lieferant group contains all the required values and information related to the seller, delivery and/or the invoicing party. l l l Name: The individual or company name.
-
variables. However, the country code must always follow the standard of exactly two uppercase letters only. Note The plugin does not check if a given country code is in the list of valid country codes. It is the responsibility of the user to ensure that only valid country codes are entered. This field can be set via Workflow data and/or variables. l l Art der Steuernummer: The two letter code for the tax identity number. Select from the drop down list box.
-
l Postleitzahl: The postal address post/ZIP code. Note No postal code validation is done by the plugin, so it is up the user to make sure that the post code entry is valid and in the correct format for the indicated country. This field can be set via Workflow data and/or variables. l l Ort: The postal address city/town. This field supports alphanumeric strings, and can be set via Workflow data and/or variables. Ländercode: A 2-letter country code as defined by the industry standard ISO 31661 alpha-2.
-
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 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.
-
l BIC: This is an international bank code that identifies particular banks worldwide, using the Bank Identifier Code (BIC) standard. The standard consists of a 4-letter institution or bank code, a 2-letter country code (following the ISO 3166-1 alpha-2 standard), a 2-character (letter or digits) location code and an optional 3-character (letter or digits) branch code. Note The plugin does not validate bank IBAN/BIC codes. It is the responsibility of the user to ensure that valid codes are entered.
-
l Detaillierte steuerliche Informationen group contains detailed taxation information. l l l l l l Gesamtbetrag der Positionen: The total amount This should be a numeric currency, which can be set via Workflow data and/or variables. Bruttosumme: The grand total amount. This should be a numeric currency, which can be set via Workflow data and/or variables. Gesamtbetrag der Zuschläge: The charge amount. This should be a numeric currency, which can be set via Workflow data and/or variables.
-
About related programs and services Services are programs that run in the background and automatically perform tasks that often do not require any user interaction. With the exception of the PlanetPress Workflow Configuration tool, all the programs used by PlanetPress Workflow are run as service applications. PlanetPress Workflow can thus use them as required without the need for any user interaction.
-
l l Telnet Input service: Monitors multiple telnet ports for incoming data. Note that each Telnet input task has its own telnet port number (set in each task). HTTP/SOAP Server service: Monitors web pages and web sites as well as SOAP servers. Available Output services Output services are used to output jobs. The output services used by PlanetPress Workflow are: l l l l l l l FTP Output service: Places output jobs on a server via the FTP protocol.
-
Start and stop PlanetPress Workflow Service As with most Windows services, PlanetPress Workflow can be started and stopped automatically when a Windows session is opened and closed. The other option is to start, stop or pause PlanetPress Workflow manually using the PlanetPress Workflow Configuration program. Note The current PlanetPress Workflow status is always displayed in the lower-right corner of the PlanetPress Workflow Configuration program window. Click Tools in the PlanetPress Workflow Ribbon.
-
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.). Furthermore, local and network rights may be granted to them: the right to get documents from and to put documents in - local or network folders, for example, or the right to print on such or such printer.
-
Local settings Different users may create different printer queues. Let us say you have a big HP printer in your office. User A creates a printer queue on his system called “Big HP” for that printer, and user B creates one called “My printer” for the same printer. A configuration created on user A’s system and then used on user B’s system would generate errors trying to print to the “Big HP” printer queue. Different users may also map network drives differently.
-
requires no user name or password, and its privileges may exceed those of the user currently logged in. Running under this account rather than a user account prevents problems that may arise if the user lacks a permission the service requires. If a configuration relies on any resources mapped to a particular user, such as mapped network drives or shared printers, they are unavailable. It is recommended that you create a configuration for a particular user.
-
The account you choose will be used by PlanetPress Workflow and all its services, as well as by PlanetPress Fax and PlanetPress Image (only PlanetPress Messenger is not affected, since it always uses the Local System account). If you install PlanetPress Fax or PlanetPress Image on the same computer after performing this procedure, you will have to perform it once again, so as to choose the same account for all the installed applications.
-
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 629. l " The Quick Access Toolbar" on page 736. This toolbar is customizable. l The ribbon tabs; see "The PlanetPress Workflow Ribbon" on page 737. l "The Process area" on page 728 l "Configuration Components pane" on page 630.
-
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.
-
Dock and undock areas of the Program Window The Configuration Components pane, the Object Inspector, and the Messages area can be displayed in windows that are attached to the Program window (docked position) or that float above it (undocked position). You dock a window when you attach it to the Program window, and you undock it when you detach it from the Program window.
-
Release the mouse button when the rectangle is in a docked position (attached to the Program window). l Double-click either a title bar (separate or attached areas) or a tab (combined areas) displaying the name of the Configuration Components pane, the Object Inspector or the Messages area. The area will jump from an undocked to a docked position and viceversa. Show or hide areas of the program window You can choose to hide or display any of the customizable areas in PlanetPress Workflow program.
-
Combining areas Click either a title bar (separate or attached areas) or a tab (combined areas) displaying the name of the Configuration Components pane, the Object Inspector or the Messages area and move the mouse pointer. As you drag, a rectangle is displayed to show the landing position. Drag the rectangle directly over another area and release the mouse button when the shape of a tab appears at the bottom of the rectangle.
-
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. Taking an area out of a combined area To take an area out of a combined area, do one of the following: l l Click the tab displaying the name of the area you want to take out and move the mouse pointer so as to drag the area away from the combined area.
-
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. l To restore a vertically attached area, click the downward pointing arrow on its title bar.
-
Image: A) Click to maximize this area. B) Click to restore this currently maximized area.
-
Image: C) Click to maximize this area. D) Click to restore this currently maximized area. Taking an attached area out of a group To take an attached area out of a group, do one of the following: l l Click the title bar displaying the name of the attached area you want to take out and move the mouse pointer so as to drag the area away from the group. As you drag, a rectangle is displayed to show the landing position. Release the mouse button when the rectangle is away from the group.
-
To resize a program window area: 1. Move the pointer to an edge of the area that you want to resize, to display the resize pointer. 2. Then click and drag to resize the area. Change the Interface language PlanetPress Workflow can be used in multiple languages, and the list of available languages grows as we translate the software. The first time you use PlanetPress Workflow, it starts in the language used for the installation.
-
Japanese. PlanetPress Workflow Button The PlanetPress Workflow button provides access to the File menu options. Options l l l l l New: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. See "Creating a new configuration" on page 30. Open: Displays the dialog to open an existing configuration file. Save: Saves the current configuration.
-
l l l l l Close: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. Closing the current configuration is the same as creating a new one. Recent Documents: Displays a list of the 9 most recently opened configuration files. Click on any of them to open it. Select Language: Click to display the language selection dialog, which changes PlanetPress Workflow interface language.
-
l Cut, Copy, Paste: Controls the clipboard. l Delete: Deletes the process from the configuration. l Rename: Renames the process. l l l Startup: Triggers whether the process is a startup process (runs before any other process). l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties, for scheduling and error handling. Subprocesses: Displays a list of subprocesses in your configuration (see: "About processes and subprocesses" on page 113).
-
l l l Group, Ungroup: Triggers grouping functionality. Properties...: Displays the properties, which lets you set a default value for the global variable. Connect Resources: Displays a list of PlanetPress Connect resources that can be used in processes (see: "Connect resources" on page 35). Different resources are divided into subfolders: l Data Mapping Configurations: Displays a list of data mapping configurations used with the Execute Data Mapping task.
-
l l l Group, Ungroup: Triggers grouping functionality. Properties...: Displays the properties, which lets you see the form information and select its default printing behaviors. Printer Queues: Displays a list of printer queues in your configuration (see: "PlanetPress Workflow printer queues" on page 100). Right-click on a printer queue to access a dropdown menu that offers these choices: l l Insert Printer Queue: Creates a new printer queue in your configuration.
-
Note Subprocesses do not have the "General" tab which is only used for scheduling, but they do have the Information tab. Options General tab l l l l l l l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PlanetPress Workflow. Startup: Select to make this process a startup process (see: "Startup processes" on page 114). This option is not available for self-replicating processes and error processes.
-
that's only scheduled to run one hour per week, it will capture the input 120 times during that period. Note that the polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to process. l l Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked.
-
In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not be active. l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two.
-
l l l l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click. To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler.
-
On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings. The Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
-
l l l l l Document: The file name of the document, as entered in PlanetPress Design. This is the name of the file saved in PlanetPress Design, or the name you give it when you add a printer-resident document in your PlanetPress Workflow Configuration. It may have a PTK extension (if it has been sent to PlanetPress Workflow from PlanetPress Design), or a PS extension (if it is printer-resident). Version: The version of PlanetPress Workflow in which the document was originally created.
-
l l l l In printer flash memory: Select if the PlanetPress Design document is on the printer's flash memory. RAM: Select if the PlanetPress Design document is on the printer's RAM (Random Access Memory). Document Update group (enabled only when using printer-centric mode and the document is on the printer) l l l l On printer hard disk: Select if the PlanetPress Design document is on the printer's hard drive.
-
configuration component you are dragging. If you try to drag a configuration component in a location that is not accepted, the cursor changes to a "prohibited" icon. If you are moving a configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box. If you are copying a configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box and a plus (+) sign.
-
before it. If the dents are at the bottom, the component will be placed at the same level (group) as the component after it. If you move an object in the Configuration Components pane on top of a group, the group name turns maroon (in the default color scheme) to indicate the object will be moved in the group after all the existing objects currently in that group. Using the clipboard buttons l Click on the component you want to move. l Go to the Home tab of the ribbon.
-
l l To copy components using the clipboard buttons and contextual menu, replace Cut by Copy. Otherwise the methods are the same. To copy components using the keyboard shortcuts, replace CTRL+X by CTRL+C. Otherwise the method is the same. Note You can also copy multiple components by selecting more than one then using the methods described above. However, you can only select multiple components from within the same folder.
-
1. In the PPD/PSM Documents section of the Configuration Components pane, doubleclick a printer-resident document. The PlanetPress Design Document Options dialog box is opened. 2. In the Document name box, enter the new document name and click OK. Reordering objects in the Configuration Components pane There are multiple ways you can reorder objects in the Configuration Components pane.
-
Grouping Configuration Components Groups help you organize processes, documents, and printer queues. For example, you may create the Invoices, Checks and Reports groups in the Processes section and associate individual processes with each one of these groups. Each group may contain subgroups. Items or processes, and groups, can only be grouped within their own category.
-
Ungrouping objects To remove a group in the Configuration Components pane, but keep its contents: l Select the group and choose View > Ungroup. l Right-click on the group and select Ungroup from the contextual menu. l Select the group and press CTRL+U. The contents of the group will move one level up. To remove objects from a group, without removing the group itself, select the object or objects and use one of the methods above or drag-and-drop.
-
l Click a process group, documents group, or printer queue group, then press the Delete key. In the case of process groups and printer queue groups, the group and all its members are deleted. In the case of documents, you are first prompted to confirm the deletion of each member of the group. You can turn off this prompt in the Notification Messages User Options.
-
Messenger access Manually adding new entries to the list To grant access to the Messenger service you can manually add new entries to the list: l Open the Access Manager. l Make sure you are in the Messenger tab. l In the IP address box, enter the IP address of the remote machine. l Click on the l Add the necessary permissions. l Click OK. l Restart the Messenger service. button.
-
Note The format of the IP address must be one of the following: l l l l 127.0.0.1: The local computer. Typically this IP should have all the accesses checked. 255.255.255.255: Everyone on the same subnet. This is equivalent to hard-coding the current subnet, such as 192.168.1.255 or 10.0.0.255. 192.168.0.42 : A single IP address. This can be any valid address on the same subnet. 10.0.255.255: Any IP in the 10.0.X.X range.
-
configure IP limitations: l l l l Each permission type (column) is evaluated from top to bottom (column per column) in the order in which they are visible in the Access Manager window. This means that wide ranges should always be at the top to increase performance. For example, if you accept HTTP connections from any IP, the first entry should be 255.255.255.255 with the Allow checkmark in the HTTP Input box. PlanetPress does not continue processing after it has found an "Allow" checkmark.
-
l Send Config:Grants access to the remote computer to overwrite the configuration on the local PlanetPress Workflow service Note In order for the changes made here to be effective, you will need to restart the PlanetPress Messenger service. This can be done via the PlanetPress Workflow Service Console. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each user name entered in this dialog can have access to one or more processes.
-
Adding a new SOAP user To add a new SOAP user: 1. Click on the button. 2. Enter the following information under the Username column for the new entry that was created: l l l User name: An alphanumerical user name for the user. Password: A password to protect the user. Note that the password will always revert to ******** (8 stars) when clicking outside of this box - that is normal and is meant to protect the length of the password as much as its contents.
-
Note In order for the changes made here to be effective, you will need to restart the PlanetPress Messenger service. This can be done via the PlanetPress Workflow Service Console. Activate a printer The Activate a Printer dialog lists the existing activated printers on the system and lets you add new activations. Note Activating a printer is required when you have a PlanetPress Suite Printer License.
-
The following buttons are available in this dialog: l Add: Brings up the Printer Activation dialog. This dialog lets you enter the information for the printer (see previous section), then click OK to save the new activation. l Delete: Removes the currently selected activation from the list. l Web Activation: Click to access the online activation manager on our website. l OK: Save changes and exit. l Cancel: Exit without saving changes.
-
Note MySQL, using ODBC 5.0, must be set to use a client-side cursor. Microsoft Access will always work better when using a Server-Side cursor. l l Expect record set: Check if you are expecting a result from the database after executing the SQL query. If the query is expecting a record set in return and does not return one, the task will trigger an error. Test SQL button: Verify the SQL statement's validity.
-
keys cannot be removed or edited. l l l l DateC is the creation date of the Key Set. l DateM is the date at which the Key Set was last modified. Delete Group: Click to delete the currently selected group. Warning: This action cannot be undone. Add Key: Click to add a key to the currently selected group. Enter a key name and click OK. If adding a key to a group with existing data, the key will be empty for all existing KeyGroups. Delete Key: Click to remove the currently selected key in the group.
-
l l l Clear All Data: Click to delete every KeySet of every group in the Repository. Warning: This action deletes all your data and cannot be undone. Clear Repository: Click to delete every group in the repository, including all their data. Warning: This action deletes all your data and cannot be undone. Show/Hide System Keys: Click to show or hide the ID, DateC (creation date) and DateM (modification date) keys.
-
l To add a KeySet, press CTRL+N. The Add Key Set dialog will appear. Use the arrow buttons to browse through the keys in the KeySet and add values to them. This dialog has a button at the bottom to add another KeySet. Navigating with the Keyboard Though of course the mouse is the easiest way to navigate through the Data Repository, the keyboard can be used as well. l l Press Tab to switch between the Repository Structure, Group Key Sets, Lookup Function Syntax and the Close and Help buttons.
-
l l l Choose Debug > Select, on the menu. Right-click a task property that may contain variables (recognizable by the color of its field label, which is maroon by default) and choose one of the Get Data ... or Get Metadata ... options. Debug your configuration and step through it until the option Debug > View Metadata gets enabled. This happens when the Metadata file has been created by a task in the process.
-
The Data Selector is essentially the same as the one used in PlanetPress Design. The File Viewer is like a Data Selector without any data related options, such as emulation settings. It is displayed when doing a data selection from the Generic Splitter task (see "Generic Splitter" on page 368) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks.
-
the current task) to format the data. It displays the formatted data to let you make selections easily using the mouse pointer. Depending on the chosen emulation and data file, the options in the Data Selector, the Sample data file section and the Data pane itself may change to accommodate your choice. The Line Printer, Ascii, 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 Sample metadata filename is the path to the Metadata file describing the current sample data file. Buttons on the right can be used to load Metadata from a file or to save the current Metadata to a file. Tip To get a sample of the Metadata file, debug your process and step through it until the option Debug > View Metadata gets enabled. This happens when Metadata have been created by a task in the process. Open the Metadata viewer and save the Metadata file to use it as a sample file.
-
The User defined information lists all Metadata fields defined by the user on the current Metadata level. Note Not all of the options in the Metadata Selector in PlanetPress Design 7 are available in the user interface of PlanetPress Workflow . However, when these settings are made in PlanetPress Design 7, they will function as expected in PlanetPress Workflow2018.2. The File Viewer The File Viewer is like a Data Selector without any data related options, such as emulation settings.
-
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 l View size: Use to adjust the size of each cell in the Data Pane, and the amount of visible data that is visible. Show used cells: Select this to display in green all cells that contain data.
-
l l l l l All pages: Select to apply the Show used cells option to all pages in the sample data file. This option is not available in database emulation. Pages to analyze: Use this box to limit the number of data pages to which PlanetPress Workflow applies the Show used cells option. Enter the number of pages to which you want PlanetPress Workflow to apply the option, or use the spin buttons to adjust the value. This option is not available in database emulation.
-
l Font: Select the font you want to use to display the sample data file in the Data Pane. l Font style: Select a weight for the font. l Size: Select the point size for the font. l Sample: Displays a preview of the font selected in the Font box. l Script: Select the system-level encoding table you want to use for the font selected in the Font box.
-
The PDF Viewer To open the PDF Viewer: In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer.
-
The PDF Viewer is accessible through one of the following methods: l l l In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer. Click View as PDF in the Debug toolbar. This will show the current data file in the viewer (assuming it is a PDF). If the viewer is opened during debugging, the current state of the PDF will be displayed (instead of the original data file).
-
Note Subprocesses do not have the "General" tab which is only used for scheduling, but they do have the Information tab. Options General tab l l l l l l l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PlanetPress Workflow. Startup: Select to make this process a startup process (see: "Startup processes" on page 114). This option is not available for self-replicating processes and error processes.
-
that's only scheduled to run one hour per week, it will capture the input 120 times during that period. Note that the polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to process. l l Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked.
-
In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not be active. l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two.
-
l l l l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click. To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler.
-
On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings. The Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
-
l Send a single resource file to the printer: see "Download to Printer" on page 330. l Send one or more images to the printer: see "Send Images to Printer" on page 346. l Use PlanetPress Design: see the PlanetPress Design User Guide. To delete images from your virtual drive: 1. In the PlanetPress Workflow Ribbon, go to the Tools tab, then click on Virtual Drive Manager. The Virtual Drive Manager dialog box is displayed. It lists all the images currently stored in your computer’s virtual drive. 2.
-
become available when you clear Local System account to enter the account information—you must enter a valid user name and password to use Microsoft Outlook as your email client for Email input and Send email output tasks. l l l Display network domains and user names: Select to have PlanetPress Workflow Configuration search for existing domains and display the domains it finds in the Domain box, and the user names in those domains in the Username box.
-
The Debug Information pane The Debug Information pane displays the current values of variables and other information useful in debugging processes (see "Debugging and error handling" on page 87). It is divided in 4 sections: l l l l Job Information: Displays the Job Info variables, as well as the job's file name, size, last edit date and presence of metadata (see "Job Info variables" on page 557). Local Variables: Displays all the variables local to this process (see "Local variables" on page 564).
-
Warning Deleting an expression or clearing the expression list cannot be undone! The Message Area Pane The Messages area is used in Debug mode to indicate the status of your PlanetPress Workflow process as the sample data file is processed and used to generate output. When your PlanetPress Workflow runs in Debug mode, the Messages area displays useful processing and error information. Messages are displayed in different colors (debug levels) in the Message area.
-
The Message Area will only display information while running in Debug mode. It does not display information from other running services, and will not display the log of any process running in a live configuration (submitted to PlanetPress Workflow Service). To learn more about debugging a process, refer to "Debugging and error handling" on page 87.
-
Note If you select multiple objects in the Configuration Components window, some properties that are shared between those objects can be changed in the Object Inspector. Changing a property changes it for all the selected objects. The Plug-in Bar PlanetPress Workflow offers a constantly increasing number of plugins, while always allowing third party plugins to be installed and set up to be used by PlanetPress Workflow.
-
l OL Connect l Outputs 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 falls into such a category. Settings & Customization The Plug-in Bar can be customized according to your needs and the plugins you most frequently used.
-
To import a plugin: 1. Click on the popup control ( ). 2. Click on Import Plugin. 3. Browse to the location of the plugin DLL file. 4. Click on Open. 5. New plugins appear in the Uncategorized category. Preferences PlanetPress Workflow Configuration program lets you configure a variety of options, from how the application itself looks or behaves, to plugin specific options.
-
l "HTTP Server Input plugin preferences 2" on page 707 l "LPD Input plugin preferences" on page 708 l "NodeJS Server Input plugin preferences 1" on page 709 l "NodeJS Server Input plugin preferences 2" on page 711 l "NodeJS Server Input plugin preferences 3" on page 712 l "Serial Input plugin preferences" on page 713 l SMTP Input l "Telnet Input plugin preferences" on page 714 l "PlanetPress Fax plugin preferences" on page 715 l "FTP Output Service preferences" on page 718 l "PlanetPres
-
Colors l l l l Variable properties: Select a color for the labels identifying variable property boxes. Debug: Select the color applied to the PlanetPress Workflow Process area background when in debug mode. Highlighted tasks and branches: Select the background color for highlighted tasks and branches in the Process Area’s invisible grid. Disabled tasks and branches: Select the background color for disabled tasks and branches in the Process Area’s invisible grid.
-
l l Sunken active property: Select to use a recessed effect to display the currently selected property. Border active property: Select to display a border around the currently selected property. l Show lines: Select to display lines between elements. l Line style: Select a style for the lines. l Reset to default button: Click to reset all the Object Inspector options to their default values.
-
Default Configuration behavior preferences l Use default configuration: Check to use default input and output tasks when you create a new process. If this group is not selected, each new process you will add will begin and end with unknown tasks. l l l l l l Default input task: Select an input task to use as the default input task when you add a new process. Click the Configure button located to the right of this box to set the properties of the selected input task.
-
l l l l l l l l l l l Prompt on Document deletion when service is running: Group of documents deletion: Select to have PlanetPress Workflow prompt for confirmation when deleting a group of documents from the Configuration Components pane. Empty group deletion: Select to have PlanetPress Workflow prompt for confirmation to delete a group when you remove the last of its member objects. If you clear this option, groups are automatically deleted when their last members are removed.
-
l l l l l l l l l l l Plugin not found: Select to have PlanetPress Workflow display a prompt when you import a configuration, and one or more of the plugins used in the configuration are not found on the computer running the software. Prompt on configuration overwrite: Select to have PlanetPress Workflow prompt for confirmation when a configuration is about to overwrite a file with the same name.
-
Workflow license that is not the same as the current one, the settings for this task will be lost when saving or sending to the service. l l Display Generic Splitter Found Message: Select to have PlanetPress Workflow prompt when a Generic Splitter task is found in any of the configuration's processes. The Generic Splitter task is maintained because of its historical purpose but should no longer be used since it can almost always be replaced by more specialized and efficient splitters.
-
and Password fields, and in the NDS options group (these properties are optional) below to properly log in to NetWare. l l l l 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. Password: Enter the NetWare password corresponding to the user name you entered in the previous text box. Tree: Enter the NetWare Directory Services (NDS) tree where the user resides.
-
you manage pens, documents and licenses. The available PlanetPress Capture user options are: l Mode: Choose between Server and Client mode. Client and Server mode are used for multi-server architectures. See PlanetPress Capture Server/Client. l Port: Select the port used to connect two servers together. The default value is 5864.
-
In client mode, no pen license information is stored locally. All pens are therefore validated against the server specified in the Host address field displayed when the Client option is selected. Note that this validation occurs for every ink file (i.e. PGC file) the local system processes, which may cause a slight delay for the operation depending on the connection speed and latency between the two systems.
-
l l l Pattern ID: Search using the pattern's identification number. This can be printed on each document next to the Anoto Statement (see PlanetPress Design User Guide). Content Status: Search using the status of the document, whether it is Open, Closed, Complete, Partial or in Error. Operator: Select how to do the comparison l Equal: The mask and database information are exactly the same. l Not equal: The mask and database information are different.
-
l l View documents: Click to view all the documents along with any ink already present on them. Each PDF is opened, in sequence, in the "PDF Viewer. Close documents: Click to close the document and release the pattern it uses. Warning This will prevent the document to be further updated, may cause errors when docking any pen that signed the printed version of the document. This cannot be undone.
-
l l l Type: Click to display a drop-down of supported database types. This must correspond to the database type of the DSN chosen in the previous option. user name: If the database is secured with a user name and password, enter the user name here. Password: If the database is secured with a user name and password, enter the password here.
-
l l l Database file (mdb) must be local to the PlanetPress Workflow computer. It cannot be located on a network drive or another server. l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PlanetPress Workflow through an ODBC connection on the local network.
-
Options and Controls Top Toolbar l l l Read PGC File: Click to display a File Open dialog. Browse to an existing PGC file, and open it. PlanetPress Capture will read the serial number from the PGC file and register the pen. Print Pen Activation File: Click to print a page containing a special pattern. Any pen that writes on this pattern and is then docked will be registered in the database.
-
To register a pen using the registration pattern 1. Click on the Print pen activation file button in the top toolbar of this dialog. 2. Use the Windows Print dialog to print to the desired printer. 3. Write or make a line on the printed pattern. 4. Dock the pen in its cradle. 5. Click on the Read PGC File button in the top toolbar of this dialog. 6. If necessary, enter an optional pattern sequence and User ID for each pen.
-
Technical To add a pen pack, PlanetPress must be activated using a PlanetPress Production license. if PlanetPress Production is in trial mode, no pen pack can be added because the Pen Pack uses the serial number. Options and Controls PlanetPress Capture Pen Licenses Group l l Import License...: Click to open the Import License dialog. Browse to a PPLIC (PlanetPress License) file on your computer and open it to import the license.
-
The available OL Connect user options define the default behavior of OL Connect tasks' OL Connect Proxy tab. These values are used unless they are overwritten in a task's properties: l Server Connect Settings l l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server.
-
Warning The default values are generally correct for the greatest majority of PDF data files. Only change these values if you understand what they are for. Delta Width Defines the tolerance for the distance between two text fragments, either positive (space between fragments) or negative (kerning text where letters overlap). When this value is at 0, the two fragments will need to be exactly one beside the other with no space or overlap between them.
-
At 0, the font size must be exactly the same between two fragments. At 1, a greater variance in font size is accepted. Accepted values range from 0 to 1. The default value is 0.65, recommended values are between 0.60 and 1.00. Gap Defines how spaces between two fragments are processed. If the space between two fragments is too small, the text extraction will sometimes eliminate that space and count the two fragments as a single word. To resolve this, the Gap setting can be changed.
-
l l l l l Task success and failure with details: Select to track when the tasks in processes running in PlanetPress Workflow succeed and fail, with details. Details can include why tasks fail and how successful tasks are executed. All events with details: Select to log everything that happens in PlanetPress Workflow. This includes when it starts and stops, the success and failure of tasks, and details on the success and failure of tasks.
-
Preferences l PlanetPress Alambic options group l l l Let me set up how many instances to run: Select this option if you want to limit the number of instances of the Alambic that PlanetPress Workflow can run. Then enter the number of instances, a value ranging from 1 to 32, in the box below. When this option is not selected, PlanetPress Workflow starts a minimum of three instances and a maximum of eight, based on the number of CPUs available on the server.
-
simultaneously, provided that they are not set to listen to the same port. See "NodeJS Server Input plugin preferences 1" on page 709. l l Time out: Set the timeout period in seconds. The default value is 120 seconds. Enable server for SSL requests: Check this option to enable secure data exchange over the Web. This enables the boxes below and lets you specify your secure communication settings. Note The Root certificate, Certificate and Key files must be in the PEM format (ASCII base64 encoded).
-
Note When SSL is enabled and a user sends a query prefixed with https://, then this specific communication will be sent through port 443, which cannot be changed in Workflow. However, http:// requests will still be received on the port specified in http server preferences. Note SSL is used to accept secured, encrypted requests from web clients and requires a certificate delivered by an approved authority. When a website is secured by an SSL certificate, "https" appears in the URL.
-
l Omit attachments as CData node in the XML envelope: By default, the request XML has a CDATA node that contains the raw input data, effectively doubling the size of the incoming XML file, which due to technical restrictions cannot be larger than 400 MB. This option allows for much larger (non-binary) attachments by removing them from the XML data file. Generally attachments are both saved on disk and included as a CDATA node within the XML envelope.
-
122 253 dent 361 341 dent Resulting XML structure with Enhanced PHP-like arrays email@example.
-
(JavaScript) scripts, CSS files and images, since they are not dynamic and generally shared between multiple dynamic files. l Serve HTTP resource: Check to activate static resource serving. l l Resource action name: Enter a name that will be simulated as a folder in your HTTP structure. For example, if you enter images in this box, you would refer to any files in this folder as href="images/file.ext" .
-
Preferences l Protocol options group l l l l l Log all Winsock and network messages: Select to have PlanetPress Workflow keep a log of all Winsock and other network messages that occur through the LPD service. These are messages related to jobs being sent from other systems through LPR, and being received by PlanetPress Workflow via LPD. Since these messages can accumulate, you have the option of not logging them.
-
Click the PlanetPress Workflow button and then the Preferences button, to open the Preferences dialog. The NodeJS Server Input 1 preferences page can be found under Plugin. Note Workflow's NodeJS and ppNode folders can be found in %PROGRAMFILES%\Objectif Lune\. l l l Port: Select the port to use. The task's default port is 9090. Port numbers > 9999 are possible.
-
l l l l l l Root certificate: Enter the absolute path to the Root Certificate, or click the Browse button and select the file in the Browse dialog. The file generally ends with a .crt extension. Certificate: Enter the absolute path to the site Certificate, or click the Browse button and select the file in the Browse dialog. The file generally ends with a .crt extension. Key: Enter the absolute path to the Private Key File. This file generally ends with a .key extension.
-
change the order of the mount points in the list. l Remote site: Type the address of the server to which the request should be redirected. Note The 'Forward all HTTP traffic to HTTPS' option (see "NodeJS Server Input plugin preferences 1" on page 709) does not affect proxies. All routes set as proxy in Workflow will be forwarded to the target specified in the proxy list. l Cross-Origin Resource Sharing (CORS) l Allowed Origins: Enter an origin (everything in a URL before the path, e.g. http://www.
-
Testing the server l To test the server address and domain, enter a username and password and click the Test server button. Note The user name and password aren't part of the plugin preferences. Users will have to provide their credentials themselves and will be presented with an HTML page for that purpose.
-
transfers correctly. It is then stripped away before the data file passes through the rest of the PlanetPress Workflow process. Select None to ignore all parity bits; no error detection occurs. l l l l Stop bits: Since most serial ports operate asynchronously, the transmitted byte must be identified by start and stop bits. The start bit indicates when the data byte is about to begin and the stop bit(s) indicates when the data byte was transferred.
-
PlanetPress Fax plugin preferences PlanetPress Workflow Fax plugin preferences control certain functions of the PlanetPress Fax service, which in turn has a direct impact on all PlanetPress Workflow Fax output tasks performed on a given computer.
-
WinFax PRO. WinFax PRO dials the result exactly as it receives it from PlanetPress Fax. Note WinFax Pro scales fax pages with the following minimum settings: - Raster width: 1728 dpi - Raster height: 2158 dpi - Raster resolution: 196 dpi l Windows Fax Service l l l l Report Failures: Select to have PlanetPress Fax generate a report whenever the maximum number of retries for a single fax is exceeded. The error generated by the Windows Fax Service is also logged in the report.
-
l l Dialing options button: Click to set the appropriate options as required. Since these options are specific to the faxing program, refer to the faxing program’s documentation for more information. Captaris RightFax l l l l l Report Failures: Select to have PlanetPress Fax generate a report whenever the maximum number of retries for a single fax is exceeded. The error generated by the Windows Fax Service is also logged in the report.
-
documentation. l l l l Activation: Click to enter activation codes for the PlanetPress Image service installed on the same computer as PlanetPress Workflow. If you have already activated the PlanetPress Image service from its Control Panel applet, this is reflected when you open the Activation dialog box by clicking this button. Check for updates: Click to access the Objectif Lune website to search for updates to PlanetPress Image.
-
l FTP Port: Select the port number that you want PlanetPress Workflow to use for all FTP output tasks. The recommended port is 21 (the default setting). PlanetPress Image preferences PlanetPress Image user options control certain functions of the PlanetPress Image service, which in turn has a direct impact on all PlanetPress Image Output tasks performed on a given computer. These include error and logging options, PlanetPress Search database options, as well as networking and email options.
-
of the job is created in the Error folder, which is located in the PlanetPress Workflow installation folder. l l l l l 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. Delete log after: Enter the number of days to wait before deleting the log of the generated PlanetPress Image output.
-
l l l l l l l 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. This option is available only when you select Access database in the Database type box. 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 SMTP mail group: Check to activate this group’s options and to use Simple Mail Transfer Protocol (SMTP) to send the error messages to the administrators. Note that if you select this option, you will be required to enter information in the Name, Email address and Outgoing mail (SMTP) boxes. l l l l l l Name: Enter the name of the user sending the error messages to the administrators. Organization: Enter the name of the organization of the user sending the error messages to the administrators.
-
install folder. They are named lprdate.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 l l l No source port range restriction: Select to remove any restrictions on the port PlanetPress Workflow uses to send the job file via the LPR/LPD protocol. Clear to restrict the port used to send the job to one in the range between 721 and 731.
-
The available preferences are as follows: l l User name: Enter the user name of a valid PrintShop Web user, mostly operators. Password: Enter the password associated with the user name on the PrintShop Web server. Note It is also mandatory to send your configuration to your PlanetPress Workflow service since the PrintShop Web credentials are included in the *.
-
on the preceding line, from its current position forward. You must clear the Use tab character option to use Smart tabs. l l l l l l l l l Optimal fill: Select to optimize the indent of every auto-indented line by minimizing the number of space and/or tab characters it uses. You must select both Auto indent mode and use tab character to use this option. Backspace unindents: Select to move the insertion pointer to the previous indentation level when you press BACKSPACE.
-
l l l l l l l l Enable selection: Select to permit the creation of selections in the Code area. If selected, you can create a selection by clicking and dragging the pointer over a portion of code, or by double-clicking to highlight the word or line under the pointer (the Double click line option determines whether a word or line highlights). You can cut, copy, paste, and print selections. If you also select Enable dragging, you can drag selections to reposition them in the code.
-
in the Sample box. l l l l Size: Use to select the font size the Editor uses to display the program code. A preview of the selected font, at the selected size, appears in the Sample box. Use monospace fonts only: Select to display only fixed width fonts in the Editor font drop-down list. Every character in a fixed width font occupies the same amount of space. Sample: Displays a preview of the font selected in the Editor font option, at the size selected in the Size option.
-
l Color l l l l l Mapping: Select a mapping for the content of the script in the script editor—the mapping is used as well when the script appears in the text box of the Run Script Actions Properties dialog. Each mapping (Default, Classic, Ocean, Twilight) includes pre-set color values and attributes for each script element as listed in the Elements list box.
-
the upper left corner. When you create a new process, this first task is always followed by the default Output task in the following box.
-
5. From the Home tab in the Ribbon, choose Paste (or right-click and select Paste from the drop-down menu). To copy and paste tasks or branches: 1. In PlanetPress Workflow Process area, select the task or branch you want to copy and paste. 2. From the Home tab in the Ribbon, choose Copy (or right-click and select Copy from the drop-down menu). 3. To paste the task or branch to a different process, select that process. 4.
-
Note You can only paste the properties of an Input task on the initial Input task of your process. Similarly you can only paste the properties of an Output task on another Output task. Also, you cannot paste the properties of a task on a branch and vice versa. Copying the On Error Properties of a task or branch Instead of pasting all properties, you can paste only the properties of the On Error tab of any task or branch on another one: 1.
-
Workflow Service. l When a branch is disabled, the whole branch including the tasks inside that branch is ignored and not executed. In the case of conditional branches, this means that the tasks appearing on the True side are not executed. A task, branch or condition that was previously disabled out can be re-enabled at any time. To disable or enable a task or branch: 1. In the PlanetPress Workflow Process area, click the icon of a task or branch. 2. From the Debug tab in the Ribbon, click Ignore.
-
2. While holding down the mouse button, drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item. The dropped task or branch is moved above the item over which it was dropped. When you move a branch, all its tasks are also moved. When you move a conditional branch, all the tasks appearing on the True side of the condition are also moved.
-
l l l Click on the task or branch you want to delete, go to the Home tab of PlanetPress Workflow Ribbon and click on the Delete button in the Clipboard group. Click on the task or branch you want to delete, and press the Delete (or "Del") key on your keyboard. Right-click on the task or branch you want to delete, and select Delete from the menu. When you remove a branch, all the tasks located in that branch are also deleted. When you delete a task, only that task is deleted.
-
Warning When you replace a task, you lose all the properties you set in this task. Resizing the rows and columns of the Process area The rows and columns of PlanetPress Workflow Process area in which tasks are located can be resized to better visualize the organization of your process. To resize rows and columns of the PlanetPress Workflow Tools Process area: 1. In the PlanetPress Workflow Tools Process area, place your cursor over the separator line dividing each section of row or column rulers. 2.
-
1. Click on the View tab of the Ribbon. 2. Click on Zoom Out in the Navigate group to zoom out, and Zoom In to zoom in. The Quick Access Toolbar The PlanetPress Workflow Quick Access Toolbar is displayed, by default, on the right side of the PlanetPress Workflow Button and provides one-click shortcuts to commonly used functions and features. You can add as many buttons as you want to the Quick Access Toolbar and remove them at will. Adding buttons To add a new button to the Quick Access Toolbar: 1.
-
1. Right-click on the Quick Access Toolbar, or click on the downwards arrow at the rightmost end of the Quick Access Toolbar. 2. Click on Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon, depending on where you want it. The PlanetPress Workflow Ribbon The PlanetPress Workflow Ribbon centralizes commands, organizing them into a set of Tabs, each tab containing groups of controls.
-
l l The View tab includes the Arrange, Navigate and Show/Hide groups. l l l l The Arrange group contains the Group/Ungroup, Sort by Name and Order controls, allowing to reorder objects in the Configuration Components pane. It also includes the Undo/Redo controls, as well as a Rename control, to modify a given component's name.
-
l l l l l l l l The Launch Upgrade Wizard control, used when migrating from a previous PlanetPress Workflow version. The Services Status control allows to start, pause and stop PlanetPress Workflow service. The Configure Services control loads the PlanetPress Workflow Services dialog to configure the user account PlanetPress Workflow should use. The Service Console button opens the The PlanetPress Workflow Service Console, allowing to monitor real-time information on the configuration execution.
-
l l The Activation group contains the Software Activation and Printer Activation controls, used to enter activation codes for either the software (all users) or a given device (PlanetPress Suite users) The License group contains a link to the "PlanetPress Capture License Management" on page 697. The Task Comments Pane The Task Comments pane displays comments relevant to the currently selected items, such as the contents of the Comments tab of any task in the currently selected process.
-
Additional Information You can find additional information that complements the user manual about PlanetPress Workflow in the Workflow knowledge base and the Connect knowledge base.
-
Copyright Information Copyright © 1994-2019 Objectif Lune Inc. All Rights Reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any other language or computer language in whole or in part, in any form or by any means, whether it be electronic, mechanical, magnetic, optical, manual or otherwise, without prior written consent of Objectif Lune Inc. Objectif Lune Inc.
-
Legal Notices and Acknowledgements PlanetPress Workflow, Copyright © 2017, Objectif Lune Inc.. All rights reserved. The license agreements for the associated open source third party components can be found in the following installation folder: C:\Program Files\Objectif Lune\OL Connect\Legal Notices This application uses the following third party components: l l l l l l Adobe PDF Library which is either a registered trademark or trademark of Adobe Systems Incorporated in the United States and\or other
-
l l l l l l l l l l l l J2V8 which is distributed under the terms of the Eclipse Public License Version 1.0. The source code for J2V8 can be obtained from the following location: https://github.com/eclipsesource/j2v8 Jacob Java Com Bridge which is licensed under the terms of the GNU Lesser General Public License Version 2. The source code for this can be obtained from the following location: http://sourceforge.
-
l l l l l l l l l l l Logback which is distributed under the terms of the Eclipse Public License Version 1.0. The source code for Logback can be obtained from the following location: https://logback.qos.ch/download.html Mimepull 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://maven.java.
-
l l l XULRunner which is distributed under the terms of the Mozilla Public License Version 2.0. The source code for this can be obtained from the following location: http://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/latest/source/ zziplib which is licensed under the terms of the Mozilla License Version 1.1. The source code for this can be obtained from the following location: http://sourceforge.
-
l Apache Commons Pool l Apache Commons Text l Apache Commons Validator l Apache Commons VFS l Apache Derby l Apache Felix and dependencies l Apache Geronimo l Apache Jakarta HttpClient l Apache Log4j l Apache Neethi l Apache OpenCMIS l Apache POI l Apache ServiceMix l Apache Tomcat l Apache WSS4J l Apache Xalan l Apache Xerces2 Java Parser l Apache XMLGraphics l Apache XML-RPC l Barcode4j l Google Collections l Google GSON l Hibernate Validator l Jetty l LMA
-
l StAX l UCanAccess l XMLBeans Eclipse Technology: This Software includes unmodified Eclipse redistributables, which are available at www.eclipse.org. The Eclipse redistributables are distributed under the terms of the Eclipse Public License - v 1.0 that can be found at https://www.eclipse.org/legal/epl-v10.html. VSS Java FreeMarker: This product includes software developed by the Visigoth Software Society (http://www.visigoths.org/).
-
license from Oracle. “Commercial Features” means those features identified Table 1-1 (Commercial Features In Java SE Product Editions) of the Java SE documentation accessible at http://www.oracle.com/technetwork/java/javase/documentation/index.html. Further Components: l l l This product includes software developed by the JDOM Project (http://www.jdom.org/). Portions of this software are copyright © 2010 The FreeType Project (www.freetype.org). All rights reserved.
-
