-
User Guide Version: 2019.
-
-
User Guide Version 2019.1 Last Revision: 2019-06-10 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 2019.
-
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 Preferen
-
PlanetPress Capture preferences PlanetPress Capture Server/Client PlanetPress Document Manager PlanetPress Capture ODBC Settings PlanetPress Capture Pen Management Tool PlanetPress Capture License Management OL Connect preferences PDF text extraction tolerance factors General and logging preferences Messenger plugin preferences Preferences HTTP Server Input plugin preferences 1 Preferences HTTP Server Input plugin preferences 2 LPD Input plugin preferences Preferences NodeJS Server Input plugin preferences
-
Combine and attach areas Resize the program window areas Change the Interface language PlanetPress Workflow Button Options Configuration Components pane Components Area Sections Process properties PlanetPress Design document properties Moving and copying configuration components Renaming objects in the Configuration Components Pane Reordering objects in the Configuration Components pane Grouping Configuration Components Expanding and collapsing categories and groups in the Configuration Components pane Dele
-
Cutting, copying and pasting tasks and branches Highlight a task or branch Disabling tasks and branches Moving a task or branch using drag-and-drop Redo a command Removing tasks or branches Replacing tasks, conditions or branches Resizing the rows and columns of the Process area Undo a command Zoom in or out within Process Area The Quick Access Toolbar Adding buttons Removing buttons Moving the toolbar The PlanetPress Workflow Ribbon The Task Comments Pane Knowledge Base 770 772 772 773 774 774 775 775 776
-
Welcome to PlanetPress Workflow 2019.1 This PDF documentation covers version 2019.1. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow is the heart of all of our solutions.
-
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 2019.1.
-
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 762).
-
account. When you do this, you grant PlanetPress Workflow and all its services the same rights associated with the selected 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 719.
-
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.
-
The default input task and output task depend on your preferences ("Default configuration behavior preferences" on page 662). If the active configuration file is currently opened, and if it includes unsaved modifications, PlanetPress Workflow asks you whether to send the configuration to the PlanetPress Watch service before creating the new configuration. Select the Always send without prompting for confirmation option to automatically send the edited version of the configuration.
-
configuration file. The PlanetPress Workflow Configuration tool lets you create, edit, save and send configuration files. As you are working on your configuration, you can save that configuration file as a file on your local hard drive. Saving a configuration file never replaces the current PlanetPress Watch service configuration. To do this, you must use the Send Configuration command.
-
When you use the Send command, the PlanetPress Workflow Configuration program uses the currently opened configuration (Any_name.OL-workflow) to overwrite the PlanetPress Workflow Service's current configuration (ppwatch.cfg). 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 a server is grayed out, this may mean you do not have access to send a configuration remotely to it. For more information, please see "Access Manager" on page 736. 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.
-
If a file different from the default configuration file is currently opened, and if it includes unsaved modifications, the PlanetPress Workflow Configuration program asks you whether to save the configuration before exiting. Select the Always save without prompting for confirmation option to automatically save any unsaved work before exiting. Workflow Configuration resource files Workflow serves as automation tool in a number of distinct products.
-
l Sample Data File(s): Displays a list of sample files that are included in the data mapping configuration. (See also: "Sample Data" on page 64.) 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 531, "Create Web Content" on page 551 and "Create Print Content" on page 547.
-
When you select a package file, the individual resources contained within that package will be imported. Tip You can import multiple files at once. Resource 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 (.
-
l template contains archives of the templates (.OL-template) l workflow contains archives of Workflow configurations received by the server. 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.
-
2. Expand the data mapping configuration (name.OL-datamapper) by clicking the button. 3. Double-click on the data file to open the data selector (see "The Data Selector" on page 747). 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.
-
For information about the options in the selection list, see Selecting a resource file in task properties. 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.
-
1. In the PlanetPress WorkflowConfiguration Components pane, right-click PPS/PSM Documents and choose Insert > Insert Resident Document. The Add Resident Document dialog box is displayed. 2. Enter the document’s name. Note that the name you enter must exactly match the actual document name or PlanetPress Workflow will not be able to use it on the printer or remote PlanetPress Workflow server. 3. Click OK.
-
Setting an attached data file as a sample data file in a process The attached data file can be used as a sample data file in a process. This sets the emulation of the process ("About data emulation" on page 54) and makes it possible to debug it (see "Debugging your PlanetPress Workflow process" on page 95). 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.
-
not appear in the Configuration Components pane but it follows the data file and can be viewed from the Metadata tab whenever the data file is viewed through the Data Selector. 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.
-
l In the Configuration Components pane, under PPS/PSM Documents, double-click any Design document to display its properties in the PlanetPress Design Document Options dialog box. For a list of all properties, see "PlanetPress Design document properties" on page 727.
-
the documents to the Documents folder relative to the install folder of PlanetPress Workflow. For help on importing PrintShopMail Connect templates, see "Connect resources" on page 35. 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.
-
In PlanetPress Connect, variable data is usually retrieved from a data file (the job file) using the OLConnect Execute Data Mapping task. This task uses a data mapping configuration file, created with the DataMapper, to produce a record set. A data mapping configuration contains a data model. Any Connect template constructed using the same data model can be merged with the resulting record set by an OLConnect Create Content task.
-
and debug PlanetPress Workflow configurations (see "Debugging your PlanetPress Workflow process" on page 95). 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.
-
One last consideration regarding output file names has to do with standard JPEG and TIFF files generated by PlanetPress Image. When an output job contains multiple pages, multiple JPEG 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.
-
Manager, but once selected, the value becomes static and does not change between each data page and job file. After opening a sample of the data (see "Choosing a sample data file" on page 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.
-
Syntax @(page number, from line, to line, from column, to column, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l l @(): Always surrounds a data selection. 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 Field Name: The name of the field you want to retrieve. l Case Option: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent. 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.
-
Note that when adding a metadata field, if you perform a multi-line data selection on a PDF region, only the first line of that region will be set to the metadata field. Syntax region(page, left, top, right, bottom, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l region(): Always surrounds PDF data selections. l Page: The page of the PDF from which to retrieve the data.
-
Here is a breakdown of the syntax: l l GetMeta(): Always surrounds metadata selections. Field/Attribute Name: specifies the name of the field (or attribute, if the GetAttribute option flag is set) to retrieve (see "Metadata" on page 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 316 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 326. 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 747). 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 326. 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 489). The things that you have to know in order to use the Metadata tasks effectively are set out in another topic: Working with Metadata.
-
When Metadata is produced for a given job, a hierarchical (i.e. tree-like) structure is created, composed of the above elements in the following order: Job > Group(s) > Document(s) > Datapage(s) > Page(s). For example: 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.
-
The Metadata related plugins (see "Metadata Tasks" on page 489) can be used in conjunction with OL Connect tasks nonetheless; see How Metadata will or can affect the output. 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.
-
Index/Count attributes are not part of the original Metadata file. They are evaluated dynamically, based on the content of the Metadata. Note Metadata Index/Count values are one-based when viewed in the user interface: the first element in any collection has an index of 1 and the last element's index corresponds to the collection's length.
-
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge used by the PlanetPress Design 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 data is intended. 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.
-
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge effort" and is devicedependent. 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.
-
Attribute Description Categor y dependent type of the media. g Index 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 DatapageCount Index/C ount X X 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.
-
Attribute Description Categor y J o b SelectedIndexInJob Returns the Absolute index of the node within all the selected nodes under the parent Job. Index/C ount 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 more KeySets (rows) within it. 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 356 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.
-
Variable Name % {error.taskindex} The position of the task in the process %{error.errormsg} The error message, as entered in the OnError tab of the task. This is the same message as appears in PlanetPress Workflow Log file. %{error.errorid} The error ID, as entered in the OnError tab of the task. This is the same ID that appears in the Windows Event Viewer.
-
3. When any job or file is processed by the selected service, the processing logs will be displayed in the window on the right. Note The information that is displayed here is the same as in PlanetPress Workflow logs and depends on the logging level that you set in the "General and logging preferences" on page 679 and on the 'Minimal logs' option in the "Process properties" on page 756.
-
Backup input files option, then type in a unique file name for the backup file (this should be variable; see "Variable task properties" on page 236). But if, for a given input task, you did select this option and something goes wrong and an original input file is lost or corrupted, you will have the option to use the Resubmit Job command to pull the backed up input file into the process. Granted that you have backup copies of the files polled by an Input task, you may resubmit them as required.
-
4. In the list of backed up input files, select the file you want to resubmit (see "Knowing what to resubmit" below). 5. Using the From page and To page boxes, select the data pages that you want to resubmit. (Data pages refers to blocks of data between natural delimiters in a data file, such as lines in a CSV file.) If you want to resubmit all the data pages from the selected input file, enter 0 in both boxes.
-
Debugging your PlanetPress Workflow process After designing a process, which is to add the different tasks, branches and conditions to the process and configuring them (see "About processes and subprocesses" on page 114), you can test whether or not the process and configuration actually work. Once you have created and fully debugged all your processes, you will be ready to send it to PlanetPress Workflow service. See "Saving and sending a Workflow Configuration" on page 127.
-
different, a job that runs in debug mode may fail at run-time if the permissions are not available to the Service. Please see "Workflow Services" on page 762 for more details. Running in Debug mode Debugging can be run in different ways: l l l From the Debug tab, click on Run. This executes the complete process, step by step, until it is completed. From the Debug tab, click on Step. This executes only the first task in the process and waits for further action.
-
l l l l l l Click on View as PDF to view the current job file in Adobe Acrobat if it is present (this will work only for PDF job files). Click on View Metadata to open the data selector and see the current state of the process' Metadata. Click on View as Hex to view the current job file in the internal Hex editor. Click on the Stop button to stop the debugging process. If you use Run, Step or Skip after stopping the process, debugging starts over from the top.
-
l l l l l Step through the process in Debug mode until you reach the emulation or data change. Click on View as Text (or View as PDF if your data is PDF at this point) in the Data group of the Debug tab. In the viewer that appears, save the file to a location on your hard drive. Stop the process, and select the file you saved as your process's sample data file (see "Choosing a sample data file" on page 65).
-
only supported with PlanetPress Design documents, and requires that this feature be available on the printer. OL Connect print jobs There are two OL Connect tasks designed to create print output based on a Connect Designer template: the "Create Output" on page 537 task, and the "All In One" on page 524 task, which combines 4 different OL Connect tasks, including the Create Output task, within a single one.
-
Using a Printer Queue requires creating the appropriate Printer Queue in the Workflow Configuration tool first. In the Output to Printer Queue task, select No document to let the spool file pass through it. PlanetPress Suite print jobs In PlanetPress Suite, the printer model and settings are defined in the Design document itself (see "PlanetPress Design documents" on page 39). Print output is normally generated by an Output task that merges a PlanetPress Design document with a data file (i.e.
-
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. LPR Output printer queues are used to send print jobs to printers via the LPR/LPD protocol. See "LPR Output Printer Queue" on page 104. FTP Output printer queues are typically used to send print jobs to FTP sites. See "FTP Output Printer Queue" on page 106. Send to Folder printer queues are typically used to send print jobs to local or network folders.
-
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.
-
Character name: Character code: Typical use in printing context: 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 printer queues set up in the Windows session in which PlanetPress Workflow is running.
-
l l l l l l 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. Selected: Select either Pre-job commands or Post-job commands to add new commands to the appropriate list and to see those commands that have already selected. Double-click a command to remove it from the selected list.
-
l (n) Ditroff format if the job file contains data in device independent troff. l (t) Troff format if the job file contains data in troff. l l l (v) Sun raster file if the job file contains raster images. This ensures that the printer uses the correct filter to interpret the data. 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.
-
generated 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.
-
print job under an existing name, it appends the content of the new print job file to that of the existing file, instead of overwriting it. l Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected. Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue.
-
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 unlink the document. 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 can capture the incoming stream and optionally convert it to 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.
-
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. Choose the same Windows print queue as in step 4. Note Steps 6-8 can be performed at any time, even if PlanetPress Workflow is not yet started. This is because every Windows printer queue using Objectif Lune Printer Driver (PS) is paused by default.
-
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 409 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 609. 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 128). 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 596). 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 703. 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 744. 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.
-
Gender=""F"" AND MaritalStatus=""Married"" " repoObject.SetValue "Users", "FormOfAddress", "Miss", " Gender=""F"" AND MaritalStatus="""" " SetValueByID Updates KeyName with Value in group GroupName, where the KeySet's ID matches the ID parameter. KeyName must exist in GroupName, otherwise an error is raised. The method returns the ID of the keyset that was updated or -1 if the keyset was not updated. The KeySet ID can be retrieved with GetValue() ("GetValue" on page 172).
-
/* both methods perform the same task */ repoObject.SetValueByID "Users", "FormOfAddress", "Mr.", 10 repoObject.SetValue "Users", "FormOfAddress", "Mr.", "ID=10" Updating a row There is currently no 'update' feature in the API for a whole KeySet. This JavaScript example retrieves the KeySet ID, which is then used to update values in the row. /* Get KeySet ID */ var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var keySetID = repoObject.
-
the Raise method properties and this page for a list of available errors to raise. In the case of VBScript, the error number used will determine the message shown in the log. Dim s s = Watch.GetJobInfo(9) If (s = "") Then Err.Raise 449 ' Raises Error #449: "Argument is not optional" Else ' Do something with Job Info 9! Watch.
-
$s = $Watch->GetJobInfo(9); if (s = "") { die "Value cannot be empty"; } else { # Do something with Job Info 9! $Watch->Log("Job Info 9's value is: " . $s,4); } Special workflow types 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.
-
OL Connect Send (see "OL Connect Send" on page 510) needs one Workflow process to handle the job transfer, and in licensed mode it needs at least one other process to interact with the user. Reports about the use of OL Connect Send might be produced in yet another Workflow process. For examples of these processes see "Workflow processes in a Connect Send solution" on page 640. SOAP Workflow As SOAP can be either a client or a server, two workflows will be presented.
-
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 You can control access to the PlanetPress Workflow Tools HTTP Server via the Access 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.
-
http://127.0.0.1:8080/static/css/style.css will immediately load and return the file c:\PlanetPress\http\css\style.css . This does not require any process to work - everything is handled directly by the HTTP Server Input and files are returned immediately. This feature is very useful when dealing with stylesheets, images, browser JavaScript, or static html files that do not require any processing. Note As of PlanetPress Workflow 8.
-
l l l l l The HTTP Action corresponds precisely to the name immediately following the first slash of your address. That is to say, placing the action myaction here means the process would be triggered by opening http://127.0.0.1:8080/myaction in your browser. The HTTP service accepts both POST and GET requests. Other than the presence of file attachments, there is little difference in how these are handled.
-
6. The process runs its course just like any other process would (including subprocesses, send to process, etc). 7. The very last file that is active when the process finishes is then returned to the HTTP service. 8. The HTTP service returns the file to the client and then closes the connection. 9. If, during this time, the timeout has expired (if the process takes more than 120 seconds), the HTTP service returns a "timeout" to the client, but the process stills finishes on its own.
-
l l http:// : transfer protocol. This could be HTTPS if the SSL certificates are activated in the preferences. ppworkflowserver : name of the machine. This could also be an IP (192.168.1.123) or a full domain name (www.myserver.com), depending on the connectivity between the client and PlanetPress Workflow Server. l :8080 : The default PlanetPress Workflow HTTP Port, set in the preferences. l /getinvoice : The HTTP Action Name, as set in the HTTP Server Input task.
-
found: c:\PlanetPress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value,KeepCase,NoTrim).pdf Here, the xmlget() function grabs the invoicenum variable from the GET request, which would be INV999999.pdf in the specified folder. l l If the file is not found, then a simple, basic HTML page is created indicating the invoice was not found. For this, a "Create File" on page 241 task will suffice, followed by the Delete output task.
-
Task Breakdown l l l The HTTP Server Input receives the initial request from the browser. Because this is a demonstration, a backup is made of the XML request. It's not suggested to do this every time, especially on servers receiving a large number of requests, as these files do take some amount of space for each request. A condition checks whether the form has been submitted, by verifying that one of the required fields is empty.
-
l "Create PDF" on page 321 In most cases, this kind of workflow also implies the use of Metadata tasks (see "Metadata Tasks" on page 489). You can use Metadata tasks to group, sort and sequence (split) the PDF data. The Create PDF task will apply the active Metadata to the PDF data file before creating the PDF output. Things to keep in mind while working with Metadata are set forth in another topic: Working with Metadata.
-
l l l l l l l l The "Metadata Level Creation" on page 500 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 493 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. These fields are used for the following Metadata tasks.
-
Resources l PDF-DailySalesReport-Workflow.zip Task Breakdown l l l l l l l l l The initial input is the "Merge PDF Files" on page 271, which retrieves and merges all the PDF files inside of the specified folder. Once a single PDF is created, the task also optimizes the PDF (to avoid duplicating images and font definitions for each page) as well as generates a basic Metadata structure containing a single document with one Data Page per captured PDF.
-
PlanetPress Capture Workflow PlanetPress Capture, introduced in PlanetPress 7.2 and enhanced ever since, is a set of tools that is used to simplify digital archiving processes by capturing information from a special pen which records everything it writes on paper, as long as this paper contains special Anoto Patterns. Warning There are important considerations to keep in mind when dealing with PlanetPress Capture. Please review them in "PlanetPress Capture Implementation Restrictions" on page 625.
-
Generating the Capture Patterns Once your document is created, the Capture Fields Generator action task is used to apply the capture patterns to each of your documents and send them to the printer. This printing process will consist of: l Retrieving your data file. l Creating metadata (See "Create Metadata" on page 490). l l l Separating each individual document in the metadata (this can be done in your Design document or through the "Metadata Level Creation" on page 500 action task).
-
always be self-replicating and have a short polling interval set in their properties. Managing and Post-Processing There are a couple of things that can be done even after documents have been inked. As long as a document remains open, it is still present in the Capture database and be used in a process: l l The "Find Capture Documents" on page 481 input task is used to retrieve a list of documents under specific criteria.
-
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.
-
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 490 l "Capture Fields Generator" on page 469 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 485 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 510) 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 510.) 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 301 l "Data Splitters" on page 381 l "Process Logic tasks" on page 404 l "Connector Tasks" on page 423 l "PlanetPress Capture" on page 610 l "Metadata Tasks" on page 489 l "OL Connect tasks" on page 524 l "OL Connect Send" on page 510 l "Output Tasks" on page 574 l "Unknown tasks" on page 595 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 769. 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 598. 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 744. 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.
-
This task is put into effect in the following use cases and example processes: l HTTP PDF Invoice Request l HTTP Brochure Request Input Create File does not capture any file and, if it is a secondary input task, discards the current data file. Processing Create File generates a job file with the contents of 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 l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. 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.
-
Email Input The Email Input task retrieves email data through a Microsoft Outlook or POP3 connection. Note If Microsoft Outlook connection is used, Microsoft Outlook 2000 or higher must be installed on the computer where PlanetPress Workflow is located. Input Email Input captures all emails and their attachments from the selected inbox, when those emails correspond to the rules defined in the General tab. If no rule is defined, all emails in the inbox are retrieved.
-
Task properties General Tab l Data Location group l l l Message body: Select to use the data found in the body of the email. Attached file: Select to use the data found in the email’s attachment. If both the Message body and Attached files options are selected, the message’s body and the message’s attachment are treated as separate data files and processed one after the other. Unzip attached file: Select to unzip the attached files.
-
Login Tab l Use Microsoft Outlook: Select to use the Microsoft Outlook email account of the current user to receive emails. The current user is the one defined in PlanetPress Workflow Service Logon. l l Move message after processing to folder: Enter the name of an Outlook Folder to keep copies of the emails taken by this email input task. You should enter only the name of the folder as it appears in Outlook’s Folder List area, regardless of whether it is a child of another folder.
-
l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l l l l %1 - Date received. Contains the date of the reception of the email (and not the date of retrieval by PlanetPress Workflow). The format is YYYY/MM/DD HH:MM:SS.
-
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.
-
be aware of where you are capturing. Processing Each file capture by the input is sent down through the process, one at a time. When the file is finished, the process goes back to the input which feeds another file down, as long as there are files in the queue. Once all the files are gone, the task polls the input folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends.
-
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. Sort order: If you selected a sorting method in the Sort files by box, select the order in which you want the files to be sorted.
-
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 %1 - Source File Name. Contains the file name (excluding path but including extension) of the file name that is captured. Equivalent to using the %o system variable. %2 - Folder: Contains the folder from which the data was captured.
-
Input Folder Listing captures nothing, however it does read the input folders (and, if selected, subfolders) and gathers information about each file in that folder. Processing Folder Listing loops through the files and, for each file, generates an XML node with information about the file. Output The output is an XML file containing information about each file. If the Sub-directories option was checked, the structure of the XML also contains the folder structure as it is present on the drive.
-
Note The
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous 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.
-
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 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.
-
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.
-
off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. HTTP Client Input HTTP Client Input tasks use the HTTP protocol to issue HTTP GET commands (queries) to HTTP servers. Replies received from the HTTP servers are used as jobfiles and are thus passed on to following tasks. Input This initial input task retrieves a single file as specified in the URL option.
-
"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.
-
or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.
-
replicating and to reduce their polling interval in the "Process properties" on page 756. Examples This task is put into effect in the following example processes: l HTTP PDF Invoice Request l HTTP Brochure Request l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite. Input The HTTP Server Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received.
-
Processing Depending on the options chosen in the HTTP Server Input task properties, the task may choose to ignore some of the files. For example, using the "Do not include XML envelope" means that only the POST attachments will be used in the process, the XML file will be discarded. Attachments are always saved on disk in a specific location, which is accessible either directly in the XML or directly as a data file through the "Loop each attachment as data file" option.
-
l Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the HTTP Server Input task loop through each attachment. Each data file is an XML with the accompanied file. l l l l Do not include XML envelope: Only active when the previous Loop option is checked. When checked, the XML file containing the request data will not be available. Only the attachment itself is sent as a data file.
-
l l l l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. 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.
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
Output The output of this task is the same as the input - a data file and job infos that are sent 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.
-
Miscellaneous Tab The Miscellaneous 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 This task does not poll any location by itself. It sits there waiting for requests coming in through WSDL (SOAP communication) and, when it receives a request, runs the process and returns the last output generated by the process to the client. Processing No processing is done. The request that is received by this task is XML and it is maintained as such. Output As with the HTTP Server Input, this task has a dual-output purpose.
-
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 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.
-
To prevent conflicts between competing LPD servers, you must not run any other LPD server than the PlanetPress Workflow LPD server on PlanetPress Workflow workstation. LPD Input tasks are configured primarily through user options (see "LPD Input plugin preferences" on page 687). The only LDP information you enter in each LPD task is the queue name. Input This task does not poll an input, it sits there and waits for a job file to be sent through the LPR port.
-
l l Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user for which a software sending the job was logged in under.
-
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. 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 489. "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.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
Before using this plugin Configure the NodeJS Server using its three settings dialogs in the Preferences (Workflow button > Preferences): "NodeJS Server Input plugin preferences 1" on page 688, "NodeJS Server Input plugin preferences 2" on page 690 and "NodeJS Server Input plugin preferences 3" on page 691.
-
Input The NodeJS Server Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received. Actually, it is the NodeJS service that receives the requests and places them in a specific location on the drive. When a request is received, the NodeJS Server Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received first.
-
part is considered to be the element's name. All content after the first underscore (preferably an integer) will be used as index, which is given as an attribute of the element (e.g. ). This makes it easy to select all elements on the same level in a data mapping configuration, and to convert the XML to a JSON object. For an example see "Incoming HTML" on page 684 and "Resulting XML structure with Enhanced PHP-like arrays" on page 685.
-
Note The following characters are not allowed in an action name: $ * ? #, spaces, and any characters that are not permitted in Windows folder names, such as \ / : ? ” < > | . Action names are not case sensitive. l l MIME Type: Select the MIME type of the file that will be returned by the plugin. Form Data Encoding: Specifies how this endpoint will interpret any form data received by the web server.
-
l Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the NodeJS Server Input task loop through each attachment. Each data file is an XML with the accompanied file. 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.
-
"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.
-
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.
-
Note When using the POP3 method, the plug-in will run very slowly if the inbox contains a large number of emails. Always use IMAP when possible. Emails retrieved using POP3 are deleted from the server; emails retrieved using IMAP can either be deleted or marked as read. Output Once the plugin is done processing, an XML file is created with the email’s details and location of the body and any attachments. The encoding of the XML file is Windows-1252.
-
8\PlanetPress Watch\Debug\0103W5GQXZR2F0A\ Priorities.xlsx Attachment C:\ProgramData\Objectif Lune\PlanetPress Wo 8\PlanetPress Watch\Debug\0103W5GQXZR2F0A\ Bill of Lading (BOL).pdf The most pertinent information is located at the top level, under . The sub node contains all the files for the email.
-
Login Tab Specify the connection information and options. l Login: l l Enter the address of the incoming mail server (POP3 or IMAP), the port (the default port is 993 for IMAP and 995 for POP), protocol (POP3 or IMAP), and encryption method used. The usual server name for an Office365 server is outlook.office365.com while the usual server name for GMail is imap.gmail.com. Note that these values may be different for some implementations or may change in the future.
-
they will be appended with a numeric suffix, for example: File.pdf, File (1).pdf, File (2).pdf. "Other" Tab l Job Information group l 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.
-
off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. Serial Input Serial Input tasks receive files sent to a serial port on the computer running PlanetPress Workflow. All the Serial Input tasks in a PlanetPress Workflow configuration share the same general properties, which are configured through user options (see "Serial Input plugin preferences" on page 692).
-
l l l l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. 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.
-
SFTP Input The SFTP Input task retrieves files from a secure FTP site through an encrypted connection. Masks are typically used to select multiple files to be retrieved from the server. Input The SFTP Input connects to the specified FTP server and path, and retrieves a list of all files corresponding to the specified mask. These files may be of any format, even formats that are not readable by PlanetPress Workflow. The files are not deleted from the server when they are downloaded.
-
l Port Number Group l l l Use default port: Check to use the default port used by the protocol selected above. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another PlanetPress Workflow task. File Options group l Directory: Enter the path of the folder to poll on the FTP server.
-
l l l l Accept all certificates: Check this option to automatically accept the certificates returned by the FTP server. Otherwise, in order for a connection to work, you have to establish a connection first and then accept a certificate from the List of known servers up to the Approved server list. Approved Server list: Displays a list of servers that were approved for connection: l Server: The name of the server the certificate belongs to. l Fingerprint: The RSA fingerprint of the server.
-
Job Information definitions l l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically. %2 - FTP Server: Contains the FTP address of the server from which the files were retrieved. %3 - Source file name: Contains the name of the current file that was retrieved from the server. %4 - Folder: Contains the FTP folder from which the current file was retrieved.
-
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. Warning Emails received through this task will not reach their intended destination if the process does not end with a Send Email Output Task, or contain the PlanetPress Connect "Create Email Content" on page 531 task.
-
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).
-
off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. Telnet Input The Telnet Input task (also known as the Raw Socket Printing Input) receives files sent to a specific port. If you want PlanetPress Workflow to receive data using multiple ports, you must use multiple Telnet input tasks.
-
"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.
-
off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. WinQueue Input WinQueue Input tasks capture print jobs received by a Windows printer queue. Note Before configuring this task, on the computer running PlanetPress Workflow you will need to create a local printer queue that will be used to receive data files in the form of print jobs.
-
Task properties General Tab l l Printer queue: Select the PlanetPress Workflow Printer Queue (the one to which data files are going to be sent; see: "PlanetPress Workflow printer queues" on page 100). Printer properties group l l Spool Print Job ins EMF Format (Advanced printing features): Select to create EMF files for Windows Print Converter action tasks (see "Windows Print Converter" on page 376). Note that this option must not be selected when capturing generic text type data.
-
Job Information definitions l l l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user un which a software sending the job was logged in under. %2 - Host computer: Contains the name of the computer from which the job was sent. %3 - Printer name: Contains the name of the printer in which the job was received. Is the same for all jobs received on any given printer.
-
The difference between an action task and an input task is that an action task can never be the first task of a process. In the same fashion, the difference between an action task and an output task, is that an action task can never appear at the end of a process. In other words, action tasks are always placed between other tasks. This section covers all the action tasks available in PlanetPress Workflow.
-
l "Translator" on page 374 l "Windows Print Converter" on page 376 Add Document The Add Document action task prepares a printer-centric PostScript job by adding a PostScript version of a selected PlanetPress Connect document and the trigger to execute it before the active data file. For more information about printer-centric printing see "Printer-centric printing" on page 100.
-
Miscellaneous Tab The Miscellaneous 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.
-
Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General tab l l l l l l l l Action group l Add: Select if you want the task to add content to the job file. l Remove: Select if you want the task to remove content from the job file. Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file.
-
Miscellaneous Tab The Miscellaneous 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.
-
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. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
-
l Tag Image File Format (TIFF) l Portable Document Format (PDF) l Joint Photographic Experts Group (JPEG and JPG) l Portable Network Graphics (PNG) l Bitmap (BMP) Processing The task reads the image and detects the presence of the selected supported barcode types. When a barcode is detected, the data it contains is read and added to the Data Page level of the Metadata. Note This task does not recognize more than one level of the Metadata Document.
-
Barcode types Description UPCE UPCE symbology. Short version of UPC symbol, 6 characters. Code11 Code 11 symbology. Used to identify telecommunications equipment Code39 Code 39 symbology. U.S. Government and military use, required for DoD applications Code93 Code 93 symbology. Compressed form of Code 39. Code128 Code128 symbology. Very dense code, used extensively worldwide. Codabar Codabar symbology. Used in libraries and blood banks. Inter2of5 Interleaved 2 of 5 symbology.
-
Barcode types Description RM4SCC RM4SCC symbology. Used by the Royal Mail. Note The fewer barcode types are selected, the faster the plugin performs. Selecting only the expected barcodes is therefore a good practice. Barcode orientations Barcode orientations represent a barcode orientation on an image. 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.
-
l l l l Process by File: The task will process the file once and will insert the barcode information in one Metadata file. Metadata will be created if it does not exist or will be enhanced with the values if it already exists. Replace non-printable character with: Enter a character that will be used as a replacement for all non-printable characters read from the barcode.Some barcode types like Data Matrix can store non-printable characters that Metadata does not support.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
l l l l l l l l Barcode_1_Value: Metadata field representing the value of the first barcode on the page. Note that this field (Barcode_1_Value) contains the same value as the first occurrence of BarcodeValue. BarcodeBase64_1_Value: Metadata field containing the value of the first barcode, encoded in Base64. Barcode_1_Type: Metadata field containing the type of the first barcode (ex. EAN13, UPCA …). Barcode_1_Orientation: Metadata field containing the orientation of the first barcode.
-
being created for each data file captured. To work around this issue, simply add a Rename action task to set a unique file name (Ex. %u) to each new file before the Barcode Scan task, after each secondary input. Change Emulation Change Emulation action tasks are used to tell the tasks that follow them to use a different emulation to format the data they receive (see: "About data emulation" on page 54).
-
Add/remove characters: Enter the number of characters to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add characters; negative values remove characters. This is useful when one or more characters of input data precede the start of the first data page. Note that certain control characters can be problematic.
-
Emulation. The available emulations are: l Line printer. (Nothing to configure.) l ASCII. l l l l Tab on CR: Select to have the document insert a tab after each carriage return character it encounters. Set the number of spaces in the tab using the Number of spaces in the tab box. This option is available only if you selected the Read in binary mode option. If you cleared Read in binary mode, the printer replaces any end of line characters (CR, LF, or CRLF) it encounters with a LF.
-
l Channel skip. l l l l Skip page: Enter the channel skip code that, in your data, signals the start of a new data page. In standard channel skip emulation, a 1 (one) signals the start of a new data page. If a 1 appears in the first column of your data, it is likely the channel skip codes are standard, and that only minor adjustments to the other codes, if any, will be necessary.
-
l Go to column: Use this to enter the channel skip code in your data that tells the document to advance to a specific column. Enter the code in the Char box to the left of the Go to column label, and use the box on the right of the Go to column label to set the column number. This is useful when your data contains redundant lines that were originally created to bold a line on a line printer.
-
off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. Create PDF The Create PDF Action task creates simple PDF files using the default quality. It is very similar to the Digital Action task (see "Digital Action" on page 333) but is more limited.
-
Output The output of this task is always, exclusively, a PDF file, optionally optimized and optionally with fresh Metadata. For the PDF values for files generated with this plugin, see "PDF Values" on page 324. Task properties General tab l l Documents: Select None to use the job file as-is. Alternatively, select a specific PlanetPress Design document if you want all the jobs to be generated with that document.
-
options of the generated PDF files. l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l l l l l Allow form filling: Select to let users enter information in the form fields included in the generated PDF files. PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files.
-
contents of the Bookmarks tab (you use data selection objects to create bookmarks in PlanetPress) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages. 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. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88.
-
l General: l Compress text and line art l Auto-rotate pages l Optimize for fast web view l Author: PlanetPress l Keywords: PlanetPress; Create PDF plugin l Monochrome images: l l l l l l Compression: CCITT l Pixels per inch: 1200 Grayscale images: l Compression: Auto l down sampling: Bicubic l Pixels per inch: 300 Color images: l Compression: Auto l down sampling: Bicubic l Pixels per inch: 150 Security: l Allow printing l Allow changing the document l Allow content co
-
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. Although they cannot be used to get the process’s initial input, they can be used to gather secondary input (see "Input tasks" on page 239).
-
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. Task properties Database Connection Tab l Database group l l l Table/Query: Select the table or query containing the information you need as your input data.
-
l l l 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. Emulation options group: Options from this group change based on the selected output file emulation.
-
l l l l l l l Configure Width: Click to set the width of each field in the generated file. The displayed Configure Width dialog box lists all the fields in the file that will be generated and indicates their widths. To change the indicated widths, simply click the values displayed in the Width column and enter new values. Click OK when you are done to close the dialog box. You will then no longer be able to use the Default width box.
-
Advanced SQL Statement dialog box. The alternate syntax may be required for some database types. l l l Edit SQL: Click to create and test an advanced SQL query; see "Advanced SQL Statement Dialog" on page 743. Import Config: If you previously created and exported a PlanetPress Workflow Database Connection configuration, click this button to import it. This saves you the trouble of configuring the connection every time.
-
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.
-
Input This task only accepts ZIP files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself. Processing Every file in the ZIP is extracted to the specified location. If a folder structure exists in the ZIP, it is respected in the output folder. Output This task outputs the data file it received with no modification. Metadata and job files are not touched either.
-
Miscellaneous Tab The Miscellaneous 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 Digital Action can accept PDF/VT and PostScript (.ps) files as an input, even if they are not generated by any PlanetPress Workflow tools. Task properties General Tab l l l Host: Select the IP address of the PlanetPress Image host to which you want the request to be sent. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box.
-
l Output type: Select the output file type that you want. l l l l l l l l PDF: The output will be a PDF file. If you select PDF, the DPI and Color Depth options (see below) are disabled and the options available in the PDF tab are enabled. JPEG: The output will be a JPEG file. JPEG is a lossy compression image format that creates small files, compressing continuous tone images (such as scanned photographs) well. TIFF: The output will be a TIFF file.
-
This option goes with the Multiple TIFF option and is only visible if either the AutoStore, DocAccel or KYOcapture format is selected. l Data Stream group: Determines what is output by the Digital Action task: l l l l l l l l Use Digital as new data stream: Use the file generated by the task for the rest of the process. Use original data stream (without document): Use the same data file as what was input to this task.
-
l l l PDI: Select if you want this task to add a PDI index file to the generated document. XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document. Use Title as FormName for PDF/VT document: Check to use the Title (defined on the Job Options tab) as the PDF's FormName in the PDI, instead of the incoming PDF/VT document's dc.title meta data tag. If the Title is empty, a warning is logged and the FormName is not changed.
-
l l l l Subject: You may enter the subject of the document. Since this is a variable property box, you may use variables and data selections and let PlanetPress Workflow interpret this information at run-time. Note that if you use a data selection in this box, you must be sure that the data that will be selected at run-time will not contain any parentheses, as this would cause the task to fail.
-
l l l Grayscale down sampling: Select the down sampling option. down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels. The Grayscale resolution you enter in the following box is used to control the down sampling process. Select None to prevent grayscale down sampling . Select Average to average pixel shades in each sample area and to replace the entire area with a pixel of the average shade.
-
l Security group l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files.
-
window option to display the entire page using the available screen space, or choose a percentage of the actual document size. l l Font group l l l Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty.
-
PlanetPress Search Database Tab If PlanetPress Workflow is configured to automatically update a PlanetPress Search database (See "PlanetPress Image preferences" on page 698), this tab can be used to override the global settings so that the task updates a different database than the one set in that global configuration. In order for the settings to work, the Add PDF to PlanetPress Search database must be checked.
-
Download to Printer Download to Printer Action tasks are used to warn printers that the files that will be sent to them are to be stored to a specific location rather than printed. Note that each Download to Printer Action task must be followed by a Printer Queue Output task set to "pass-through", in order for it to be sent to the printer and not merged with a PlanetPress Design document.
-
l l l File name case: l Do not modify: keeps the character casing of the file name as is. l All uppercase: changes all characters to upper case (README.TXT, for example). l All lower case: changes all characters to lowercase (readme.txt, for example). Keep file extension: Select to use extensions when saving files.
-
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. There are some important things to consider when using the External Program task: l l The executable file must accept so-called "command-line options" and be able to run without any sort of user interaction.
-
run in command mode. Note that the program will be run without user interaction. Although it may display progress information, it is better if the application has no user interface. l l l l Start in: Enter the folder in which the external program is to run. This is important, for example, if the program is to generate files that are to be picked up in a specific location for further processing, or if it requires resources that are located in a specific folder.
-
condition set will cause be considered a success and any other exit code will cause the On Error tab to be triggered. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous 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 external file specified in the task's properties is loaded and replaces the current data file. Output The loaded file is output. Metadata is not modified in any way, neither are Job Info variables. Task properties General Tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88.
-
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 596). 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 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. For job information use %1 through %9, for local variables use %{variable} and for global variables use %{global.variable}.
-
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).
-
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). Script running from: Choose if the script should be run from the editor text box, or from an external script file.
-
If the job file is the target file to which the attachments must be added, it should be a PDF/A-3 file. Note, however, that the task doesn't verify that the input file is PDF/A-3 compliant. Processing The task reads each of the files that are listed as attachments and adds it to the target PDF with the name that was specified for that attachment. The target file can be either the job file or an external PDF/A-3 file. The job file can also be used as one of the attachments.
-
whenever the process runs. l Filename: The file that should be used as an attachment. You can enter %F to attach the current job file to the target file (see "Standard variables" on page 598). Note The target file cannot be attached to itself. l Attachment Name: The name by which the attached file will go in the target file. If you want it to have a file extension, include that in the attachment name.
-
e-Invoicing metadata Tab Optionally, the PDF/A-3 file can be extended with metadata that describe the PDF as an invoice that conforms to a certain standard. This is either the ZUGFeRD 1.0 or the FacturX/ZUGFeRD 2.0 standard. The plugin doesn't verify that the resulting PDF/A-3 file and attachment conform to the chosen standard; it is up to you to ensure that it does. Note The ZUGFeRD and Factur-X standards require XML invoice data to be attached to the PDF/A-3 document.
-
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 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.
-
Miscellaneous Tab The Miscellaneous 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 New file name: Enter the job file’s new name.You can use any combination of text, variables and data selections; see "Variable task properties" on page 236. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
-
The Run Script task can be used either as an Action or a Condition. When dragging and dropping a Run Script task on a given process, you select whether to use this task as an Action or a Condition from a contextual menu. 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.
-
l Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l l Delete: Delete the current selection (only available if there is selected text in the editor). Select All: Select all of the contents of the editor. l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog.
-
l Script filename and path: Either the full path of the script, or click the Browse button to navigate to the file. This option is only available if you choose external script file in the Script running from option. Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties.
-
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 306. Input Any text-based file can be used in this task, even formats that are not directly compatible with PlanetPress.
-
l Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies. 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. l button: Move the currently selected line up one position. l button: Move the currently selected line down one position.
-
Queue Output task set to 'pass-through' (No document), in order for the images to be actually sent to that printer. Note Images sent to a printer are stored in the root folder of the printer’s hard disk, while images sent to the virtual drive of another computer are stored in a sub-folder of the 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.
-
l l l l l l l l Color conversion: Select As is to keep the color information included in the images. Select Grayscale to convert color images to gray scale. Naming convention: Select ’File name, original’ to store the file under its original file name. Select ’File name, no extension’ to store the file without its original file name extension. Note that all characters are converted to uppercase and that extended characters (characters, such as é, for example) are not recommended in image file names.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
Task properties General Tab l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names. You can use any combination of text, variables and data selections; see "Variable task properties" on page 236.
-
Set Job Infos and Variables Add Set Job Infos and Variables action tasks to set Job Info elements as well as custom variables (see "About variables" on page 596). You can set multiple variables and Job Info values in a single task. Be aware that lines are processed from top to bottom. Input Any data file in any format. Processing This task assigns the defined values to local or global variables or Job Info variables. It does not modify the data file nor the Metadata.
-
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.
-
If firewalls control communication between the SOAP client and the Web servers, they must be configured so as not to block client-server communication. In the case of "string" type data, SOAP Client plugin tasks normalize all line endings to a single line feed character. 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.
-
l l l l l Name: Displays the name of the arguments associated with the selected method. Note that you may also manually enter new arguments, change or delete existing ones, as well as change their order if needed. Type: Displays the argument type. 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).
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
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. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
-
The Translator action task is useful for data files using foreign languages, as well as to convert Unicode data files (which are not supported by PlanetPress Workflow). Note You can create your own translation matrix files for the Translation Action Task by adding them to the following folder: %CommonProgramFiles%\Objectif Lune\PlanetPress Workflow 7\Plugins\Translator Two examples are already present, converting ASCII to and from IBMEBCDIC.
-
include the character encoding signature—also known as the byte order mark—at the beginning of the target string. l Default character on translation: You may enter a character to be used to replace all those characters that cannot be found in the source encoding. If you leave this box empty, they will be simply stripped from the data, so you may consider using a space as a place holder for unidentified characters.
-
l l The Windows print file is first converted into an XML file in which each printable character appears with its horizontal and vertical coordinates. The XML file is then converted into a standard Line Printer file. Note Although it is more common to perform both phases in a single pass, each phase can be performed selectively, as required. Input A print job in EMF format, generally captured from a WinQueue input task.
-
distance lie within the tolerance, outputting it in one line. At the output, these text passages are separated by a tabulator (ASCII code 9). l l Font size difference: Indicates the smallest acceptable factor between maximum and minimum font size within one line. A value of 0.60 means that with a ratio from maximum to minimum font size (in points), that is less than 0.60, two text passages are not recognized as belonging together. For example, if two text passages are formatted with different font sizes.
-
l l Vertical distance: Indicates the biggest acceptable vertical distance between two text passages so that they're still recognized as belonging together. This is the factor the font's height and size is multiplied with. The value for the font's height therefore is taken from the corresponding font's attributes. For example, if the height of that font example in 10 point size is 0.32 cm. There is a passage found that is positioned 0.15 cm above - which means 0.15/0.31 = 0.48 < 0.
-
Input The current job file. Processing The current job file is converted from XML to JSON or from JSON to XML. When converting from JSON to XML, the encoding of the resulting XML file is always set to UTF-8 (which is the default format for JSON). The converted job file gets the appropriate extension (.JSON or .XML).
-
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. l XML to JSON: the task only converts XML files to JSON.
-
each contain a single client statement. Each statement can then be printed and sent by snail mail, or even emailed directly from PlanetPress Workflow, to each individual client. 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.
-
...and so forth... Once split, the first file generated by the action task would look like this: Data line1 of page 1 Data line2 of page 1 Data line2 of page 1 Last data line of page 1 But when opened with PlanetPress Design or a 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.
-
Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task. Task properties General Tab l l l l l Split group: Use this group to indicate how you want the file to be split. Field value change: Select if you want the file to be split based on changes in the values of a selected database field (the value in the ClientID field changes, for example).
-
l l l l l l Pages or records: Enter the number of pages or records before or after which the file is to be split. Enter 0 if you want the file to be split right before or after the page or record that matches the set condition. Before or after: Options from this list box are used to define exactly how the file is to be split. Select Records before if you want the file to be split a given number of records before the field that matches the set condition.
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task. Task properties General Tab l Split data file on emulated page group: Select to split the data file based on pages (rather than on a word found within the emulated data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place.
-
l l l l 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. Note that this setting applies both to the Specific Word and Word change options. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Trim selection: Select to force the splitter to strip empty trailing characters.
-
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.
-
Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, Job Infos and other variables are not modified by this task. Task properties General Tab l l l Split data file on: Use this box to choose the item on which top split the file. The options available depend on whether or not the Use emulation box is checked (see below). Use emulation: Check to emulate the data before splitting the file.
-
l Word is between columns l l l l l Consider case: Select to force the Generic Splitter to match the character casing of the string of characters entered above with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Where to split group l l From and To: Enter a horizontal search region defined as starting from a given column and ending at a given column.
-
first columns of the line selected above. l l l l l Pages: Enter exactly where to split the file. Enter 1 to split the file 1 page before or after the string, 2 to split the file 2 pages before or after the string, or 0 to split the file immediately before or after the string. Before or after: In the previous box, you entered exactly where you wanted to split the file, here is where you specify whether you want the split before or after.
-
match (“day“ and “day“, for example). If you select Contains, the Generic Splitter will consider that the condition is met whenever it finds the string of characters entered in the Value box, even if the database field contains additional characters (“day“ and “days“, for example, would be considered a match). l l l Value: Enter the string of characters to search for as the splitting criteria. Like the Field box, this is also a variable property box.
-
l Where to split group l l l Pages or records: Enter exactly where to split the file. Enter 1 to split the file 1 page or record before or after the string, 2 to split the file 2 pages or records before or after the string, or 0 to split the file immediately before or after the string. Before or after: In the previous box, you entered where you wanted to split the file.
-
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 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”.
-
off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. PDF Splitter PDF Splitter Action tasks are used to split emulated PDF data files into multiple data files that are passed to subsequent tasks in the process. 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.
-
Task properties General Tab l Split on page: Select to split the data file based on pages (rather than on a word found within the PDF data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place. l l Page(s) per output: Enter the number of pages to include in the file generated by the splitter in this edit box below or use the spin buttons.
-
l l l l l l Trim selection: Select to force the splitter to strip empty trailing characters. When this option is not selected, blank trailing characters, if any, are considered in the matching process, so the word “DAY” will not be considered as matching the word “DAY”. Note that this setting applies only to the On region change option. Where to split: By default, the task splits the file at the beginning of the line on which the condition is met (the default value is 0).
-
attribute / field is compared with the one in memory. If they are different, either a new sequence starts or the current sequence is ended. The next sequence starts with the next Metadata level being processed. For details see the Rule Interface. 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.
-
XML Splitter XML Splitter action tasks use the XSLT language to split XML data files into multiple XML data files that are passed to subsequent tasks in the process. The XML splitter includes options to add a new root node within the generated files, as well as to change the original file’s encoding to UTF8. Note that the XML Splitter cannot process files larger than 30 megabytes. Input An XML file (see "XML Emulation" on page 63).
-
l l l l l l l l l l l Condition group: Use this group to indicate whether you want the file to be split whenever this node is encountered or whenever the information in this node changes. When condition node is found: Select if you want the file to be split whenever the node selected in the Condition node path box is encountered. When condition node content changes: Select if you want the file to be split whenever the information stored in node selected in the Condition node path box changes.
-
l {WATCHTEMPFOLDER} file separator: Use this box to edit the default XML file separator (/). Alternate XSLT Engine tab This tab lets you choose the splitter settings for your own XSLT engine. If you want to use the default PlanetPress Workflow XSLT engine, click the General tab. l l l l l l Use alternate XSLT engine group: Select this option to enable the box and the buttons included in this group.
-
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.
-
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). As your job file goes down the process, when a branch is encountered, a copy of the job file will go in that branch. In the branch, all tasks up to the Output task will be performed, before returning to the main trunk to continue processes.
-
job file (as split by the splitter task). If the secondary branch ends with a PlanetPress Fax or PlanetPress Image output task, the main branch will receive a PostScript file. l l l Backup job information: Select if you want PlanetPress Workflow to use identical copies of the job file information for the main and secondary branches. When this option is not selected, the job file information that reaches the output task located at the end of the secondary branch is used for the main branch.
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
Miscellaneous Tab The Miscellaneous 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. Miscellaneous Tab The Miscellaneous 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.
-
subprocess from any GoSub action, in order to avoid circular referencing (aka an infinite loop). Task properties General Tab l l l l l Subprocess: Drop down list containing all the available subprocesses in the current configuration. Backup job file: Select if you want to use identical copies of the job file for the main process and the subprocess. Backup job information: Select if you want to use identical copies of the job file information for the main process and subprocess.
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
with a Printer Queue Output task, for example, the second time the Loop action task will be performed, it will use the PostScript file generated by the output task. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
-
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. Note When using Run Script as a Condition, the output of the task can be within the branch or on the main trunk. To control the output, use the "Script.ReturnValue" on page 159 variable in your script.
-
l l l l 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. Tools l l Select All: Select all of the contents of the editor.
-
The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from within your script. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
-
In either case, the called process will ignore the input task along with its Job Info variables and schedule, and use the job file, Job Info variables, Metadata and variables from the current process. 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.
-
retrieve error and other status messages that printers send out, such as being out of paper or having low toner. PlanetPress Workflow uses the SNMP protocol in the form of an SNMP Condition, in two ways: l l To check the status of printers on your network against values you set in a condition, and to return a true or false value. This is called setting a Printer condition in the SNMP condition's Properties dialog box.
-
the device which rights to grant PlanetPress Workflow (required to perform the test). l l l l l l Get info: Click to retrieve information corresponding to the IP address you entered. If the information is successfully retrieved and it corresponds to a printer, the Host name and Description of the printer (or other device) appears in the corresponding boxes. Host name: When you click Get info, if PlanetPress Workflow is able to communicate with the device, it displays its name here.
-
l l Value: Enter a specific object status. Vendors of SNMP compliant devices sometimes list possible object states in their documentation. Invert condition result: Select to toggle the result of the whole SNMP condition (true becomes false and vice versa). On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
-
member” at a given location in the job file (using a data selection), but the other operators can be used to test whether or not the first string is equal to the second one, whether it is equal or lower than the second one, etc. The logic of text conditions can sometimes be tricky, especially if it includes variable strings, so you should test it thoroughly.
-
enter a range of lines and columns. If you select “on the page”, the search area will cover the whole data page (as defined below). l l l l Compare to string: You cannot enter a comparison string when either “Is found” or “Is not found” is selected in the Operator box. Enter the second string of the comparison in this box. As with the String box, you can enter a static string, a variable or a data selection in this box. Page range: Select Any page if you do not want to specify a precise data page.
-
Time of Day Condition Time of Day Condition tasks test the current time and day. Using a time and day grid, you can select blocks that correspond to time and day coordinates. Various settings can be used to change time intervals, for instance, that range from 15 minutes to 24 hours. You may choose to use days or dates, and you may also select specific weeks or months.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous 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 "Output to SharePoint" on page 443 l "PlanetPress Fax" on page 446 l "PlanetPress Image" on page 448 l "PReS Print Controls" on page 457 l "PrintShop Mail" on page 461 l "ZUGFeRD plugin" on page 642 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. Miscellaneous Tab The Miscellaneous 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.
-
Processing This task connects to a Capture OnTheGo Repository and requests removal of a document with a given document ID. Output When used as a Condition task, the success of the delete operation determines whether the task returns True or False. Task properties General Tab The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document. l Repository ID: Enter a valid Capture OnTheGo Repository ID.
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
Processing The task connects to the selected Document store and retrieves a copy of files according to the specified rules. The files may be deleted or marked as checked out depending on the options selected, otherwise they are untouched. Output The output to this task is a series of individual files, one after the other. Task properties General Tab Note For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab.
-
l Action Group l l l Download the document: Simply download the document and do not modify it in SharePoint. Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint. This is useful for preventing files to be downloaded more than once. Download the document and delete it from SharePoint: Download the document and delete it from the SharePoint server. Connection Tab l l l l Server Name: The name of the SharePoint server.
-
Job Information definitions l l %1 - Source file name: Contains the name of the current captured file. %2 - Directory: Contains the name of the SharePoint director from which the current file was captured. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Laserfiche Repository Output The Laserfiche Repository Output task publishes files - and optionally sets index values into a Laserfiche server.
-
Output The output from this task is the specified file along with the metadata within the Laserfiche server. The file is not directly modified by this task. Task Properties General Tab l Laserfiche configuration group l l Folder: Enter the Laserfiche client repository folder where the documents will be exported. The user can specify the remote folder by clicking the Browse… button.
-
l The indexes in the PlanetPress Design document must match the ones in the Laserfiche server. Connection Tab l Server Name: The server name or IP address of the server you wish to connect to. l Repository: The name of the repository you wish to send the files to. l user name: A user name in Laserfiche that has access to the above repository. l Password: The password for the above user name.
-
l The Laserfiche output task will only work if an activated PlanetPress Image is found, either locally or on the network. Lookup in Microsoft® Excel® Documents The Lookup in Microsoft® Excel® Documents action task is used to complement your job file's Metadata by retrieving data from a Microsoft® Excel® spreadsheet on your system. The data retrieved is based on existing data in your Metadata, and it will either be added to your Metadata or will append or replace your existing Metadata if it exists.
-
item description as found on a region of the current data page. The line item descriptions appearing on the resulting page produced by the design tool are custom data selections whose value come from the corresponding ItemDesc Metadata fields. The Lookup in Microsoft® Excel® Documents action task updates the value of all 'ItemDesc' Metadata fields with their corresponding foreign language descriptions. Input Any compatible data file. This task requires Metadata to be present.
-
l Action: What to do with the resulting data from the Microsoft® Excel® worksheet. This can be: l l l l l l l Add Field: Creates a new field with the data. This may cause multiple fields to be created. Replace field value: Replaces any existing field with the new content. Only the last result will be displayed. If the field does not exist, it will create it. Append field value: Ads the data to the existing field within the same one. No "separator" is added.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
path entered. The Microsoft® Word® to PDF action task allows specifying the path of the database and the query to use. The Use custom settings option is very usefully for using different databases and queries in a single process. l If the database is the same for 2 processes, one of two processes aborts. Each process has to use different databases, or no more than one process with a Microsoft® Word® to PDF task. Input A compatible Microsoft Word Document.
-
Task properties General Tab l l Microsoft Word Document: Enter a Microsoft® Word® document or template, or click the browse button to navigate to the location of the document. The supported extensions are: *.doc, *.docx, *.dot and *.dotx. Perform Mail Merge: Check when providing a Microsoft® Word® document or template configured for mail merge. l l l l l l Use settings specified in document: Selected to instruct the task to use the connection string and SQL statements stored in the DOC file.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous 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.
-
Processing This task does not process the data or Metadata file. The information entered in the Deposit tab of this task is sent to the repository configured in the Repository tab. Output The output that this task produces is the information sent to the Capture OnTheGo online repository (the document ID). Task properties Repository Tab The Repository tab is where you enter the connection information necessary to create the link between OL Connect or PlanetPress and CaptureOnTheGo.
-
an image on the local drive. The Cover Image is optional and, if omitted, displays a default image based on the file type. 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 Title: Enter the document name that Capture OnTheGo users will see on their device. Choose a name that will let users clearly identify the document.
-
Advanced Tab The Advanced tab is where you specify the document's time to live either in the repository or the user's device. l Document Handling Options group: l l l l Customize: You must check this box if you want the options included in this group to be used. When this option is not checked, the other boxes included in this group are faded.
-
Until box above, the computer’s time zone appears in this box. You may select a different time zone if required. l Document Tracking: l l l Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server. This tracking is done through the COTGDefaul.mdb database located in %ProgramData%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\COTG , and includes most of the information set in this task, as well as information returned from the server.
-
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. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to send the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously.
-
l Single line of text: This type may contain a string of any type of characters. This is the most flexible type of field. Use this type when you are not sure if the constraints of the other types of fields will be appropriate. l Multiple line of text: This type may contain multiple lines of text. l Choice: This type contains the menu to choose from. l Number: This type may contain a number (1, 1.0, 100). The decimal separator is “.” in the plugin. l Currency: This type contains the currency ($ …).
-
Miscellaneous Tab The Miscellaneous 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.
-
Processing If a data file with metadata is used, the data file is merged with the selected PlanetPress Design document, converted into a multi-page TIFF file with CCITT Group 4 compression, and sent to 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.
-
PlanetPress Image PlanetPress Image Output tasks are used to make requests to PlanetPress Image, which creates image files which it then archives or emails. For more information about this product, see "About PlanetPress Image" on page 639. 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 333 task should be used instead.
-
in the document, which is not available in output generated using any other means. Note however that "Digital Action" on page 333 does have the ability, in most cases, to generate output using third-party PostScript files.
-
enable the dynamic document name box, click inside it. To disable it, press Enter. Note that in the latter case, you must be certain that the documents that will be chosen at runtime will in fact be available locally or at the selected host. l l List only documents using VDX compilation: Check to ensure that only documents that are compatible with the VDX compilation method are shown in the list, if producing VDX output.
-
l l l l l l l l DPI: Enter the dots per inch (dpi) resolution of the output image. This property is enabled for all output types except PDF. Color depth: Enter the color depth of the output image in bits per pixel (bpp). The color depth is measured in bits, because each pixel of the output image can be described with a varied number of bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images.
-
Statement.2005.255842.pdf, or Job.tif instead of Job.544872.tif). Failing to add the quotation marks may result in files being overwritten. 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.
-
elements with large areas of single colors or repeating patterns, as well as on blackand-white elements that contain repeating patterns. l l l l l l l Auto-rotate pages: Select to automatically rotate pages based on the orientation of the text or DSC comments. 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.
-
l Grayscale images group l l l l Compression: Select the compression to use for the grayscale images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs.
-
l l l Downsampling: Select the down sampling option. Down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels. The Color resolution you enter in the following box is used to control the down sampling process. Select None to prevent grayscale down sampling. Select Average to average pixel color in each sample area and to replace the entire area with a pixel of the average color.
-
in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font. 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.
-
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.
-
Limitations In order for PReS Print Control tasks to be functional, some pre-requisites must first be met: l l PReS Classic 6.3.0 or higher must be installed on the same system. A valid PReS Classic license (either dongle or software based) must be available on the same system. Note All PReS Classic licenses are issued and controlled by the PReS License Server and not Connect. Thus a separate PReS Classic license is required. Input A PReS Classic job and the resources it needs.
-
Task properties General Tab l PDC File: Select either an un-compiled PReS Classic script file (PDS) which will need to be compiled on the fly, or a pre-compiled PReS Classic job file (PDC). The job needs to be specified exactly. If you want to compile the job at run time, then you must select a PDS file. If you wish to use a pre-compiled PReS Classic job, then select the PDC file, rather than the PDS.
-
Note If the PDC File selection contains a folder path and the Working Folder also has an entry, then the PDC File entry will be appended to the Working Folder entry. One should be very cautious doing this, as it could easily lead to errors. l PDL Type: Select the desired PReS Classic output type for the job. Note Not all PReS Classic jobs can be swapped between output types. Jobs designed for certain output types (such as AFPDS) will likely have settings specific to the original output type.
-
Note It is heavily recommended that this setting be left as ‘Auto’, as PReS Classic licenses being assigned to different PRNx instances is extremely rare. l Time-out: The time in seconds that the Connect Workflow waits for a response from the PReS Print Control to make sure it is running. If Connect Workflow does not receive a response in the allotted time it will terminate the Print Control and continue to the next step in the workflow.
-
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. PrintShop Mail 7 can also output PDF/VT and PPML/VDX.
-
l l l l l l l l l Distilling options file: Enter the name and path of a distilling options file (or "joboptions" file) or use the Browse button to navigate to that file. This option is only available when PDF is selected in the Output type box. 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.
-
Miscellaneous Tab The Miscellaneous 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. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011. Capture Condition The Capture Condition task checks the status or field contents of a Capture document that has been processed by the Capture Field Processor action task.
-
l Document Origin: l Document to process: Determines where the document information is read l l l From Specific ID: Select to specify an exact Document ID from the database. This document does not need to be loaded as a data file or its Metadata manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database.
-
l Capture Field-based condition: Select to base the condition on the state of one or more fields of your document. l Field Name: The name of the field on which to base your condition. This is equivalent to the name of the Capture Field Object in PlanetPress Design. Note In this field in particular, the right-click menu displays a unique option, 'Open Document Preview'. This option displays a list of existing documents.
-
l l l l l End timestamp: Triggered when the last stroke finishes in the field. (see Start Timestamp for detailed options) Pen Id: Triggered by the ID (serial number) of the pen. A box provides a way to specify which Pen ID will trigger this condition to be true. Field List Value: Triggered only on Field List Capture Fields. A box provides a way to specify which value will trigger this condition to be true. Content Status: Triggered when the field is in a specific status.
-
l l l At least one item is met: The task will return true if ANY of the combined conditions is true. Condition Scope: Determines whether the conditions need to be true for all the pages of the document, or any one of them. l l l All items are met: The task will return true if ALL the combined conditions are true. In the document (occurrence): The task will return true if the condition set it true for any page of the document.
-
database and does some operations. 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.
-
Processing The Capture Fields Generator action task uses an existing PlanetPress Design document containing Capture fields and assigns a unique Capture pattern to each printed page. The task then locks each pattern that it used so it cannot be reassigned to any other document. The whole job is then converted into a PDF file which is stored, without the patterns, in the Capture Database. This PDF file is later used by the "Capture Fields Processor" on page 473 to be merged with ink from the pen.
-
l l Output Format group l l l l l Custom: Use the title in the input field as set by the user. The field is variable so the title can be set on a per-document basis using data or metadata selections. Continue process with optimized postscript (no metadata): The job file coming out of the task will be a PostScript file that can be sent to any postscript printer or saved locally.
-
or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
-
From version 7.5 and onwards, ICR is done on the ink, if the "Perform ICR Recognition" option is checked. Error handling If the Capture Fields Processor generates a critical error during the processing of any document in the PGC file, all of its actions will be reverted. If your PGC file contains multiple documents, even those documents that were processed before will revert.
-
l l l 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. Page Level: l CaptureField: Information on each capture field on the page. Repeated for each capture field that is present.
-
l ICR Settings group l l l l l l Perform ICR Recognition: Triggers the PlanetPress Capture ICR engine. For more information, see PlanetPress Capture ICR. Engine Language: Define the language the ICR engine will use for text recognition. This has a major effect on the way text is recognized, as different languages use different databases to recognize letters, numbers and characters. For example, accented letters are not correctly recognized in the English ICR database.
-
Miscellaneous Tab The Miscellaneous 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.
-
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.
-
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.
-
Output The original data file is output by this task, along with the original Metadata file that has been enhanced with the ICR data at the selected level. Task properties General Tab l l Document ID: A variable data field that corresponds to the database ID of the document from which you want to retrieve ICR data. The Document ID is generated by the system through the Capture Fields Generator. The ID must correspond to a document in the Capture database, or the task will fail with an error.
-
Find Capture Documents The Find Capture Document task retrieves a list of pertinent information about Capture documents present in the Capture database according to a specified set of rules. This task is most often useful as the beginning of an automated process using a series of Capture documents, for example one that removes old documents to unlock patterns. However, it can also be used as a secondary input in order to retrieve one or more documents after some operations.
-
Task properties General Tab l Document-ID Based Condition: Select this option for this task to filter its results using a specific Document ID. l l Document ID: Enter the ID on which you want to filter. The Document ID is a unique identifier of the document when it is stored in the database. It is attributed to the job metadata when the "Capture Fields Generator" on page 469 ads it to the Capture database.
-
l l Content Status: The status of the document as a whole. A document can be Empty (no ink), Partial (some ink but still open), Complete (all mandatory ink is present) or in Error (logical or process error). Operator: The choice of the condition operator. The available choices are variable depending on the filter but will be part of the following choices: l l l l l l l l l l l l Equal: Inclusive filter, where anything equal (either by string or numeric comparison) is included in the results.
-
l l l l l Condition: The condition or value the document needs to meet. The condition is variable dependent on the chosen filter. It can be a drop-down of values, an alphanumerical or numerical value. Add button: Click to add a condition row to the grid. Remove button: Click to remove the currently selected condition from the grid. To select a row, simply click on any of its 3 components.
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
Note Performance-wise, when this plugin retrieves a document from a 10,000 page PDF in the database, it will take more time then if it retrieved it from a 100 page PDF. Output The Get Capture Document action task is a loop that outputs a PDF version of the Capture Document. The PDF contains the original document, any ink added by the "Capture Fields Processor" on page 473 action task.
-
l l l Get closed documents only: Get only the documents that have been closed in this process, according to the Metadata. Close document after retrieval: Once the task has retrieved the document from the Capture database, the document will be closed even if it is incomplete. Annotate PDF: Add annotations to the PDF that describe each Capture field and the ink that is included in those fields. Note that not all PDF readers support annotations.
-
Note When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False. This task is put into effect in the following use cases and example processes: l PlanetPress Capture Workflow Input A PGC file received from an Anoto digital pen.
-
Properties... On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous 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 "Metadata Sequencer" on page 503 l "Metadata Sorter" on page 504 l "Metadata to PDI" on page 506 l "Metadata-Based N-Up" on page 508 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.
-
and Document, Metadata fields, etc. Note that: l l In PDF emulation, the size and orientation attributes for each page are set in the Metadata. In all other emulations, those attributes remain blank. 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.
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
and it becomes the current Metadata from this point on, overwriting any current Metadata file that may already be set. l Embed Metadata from PDF job file: the current Metadata file is inserted in the current data file, which is assumed to be a PDF file. If the original PDF is PDF/X or PDF/A compliant, the resulting PDF file will also be compliant. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88.
-
Note This task will automatically loop through the Metadata and repeat its action for each of your Metadata's datapages. This task should not be placed after a Metadata Sequencer. Input Any data file with accompanying Metadata. Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties.
-
Task properties General Tab l Action: Select the type of Metadata Field Management action to perform. Five action types are available: l l l l l l Add/Replace: Create a new Metadata field. If the name already exists, the value is overwritten with the new one. Duplicate: Create a new Metadata field. If the field already exists, a new instance is created. Append: Append the new value at the end of the current one. If no field with that name exists, a new one is created.
-
l l l l Auto-detect: Interpret automatically the value. This option is ideal for documents using mixed decimal separators. Note that the auto-detect option encountering the value 1,000 (with a comma separator), interprets it as a thousand while interpreting 1.000 (with a dot separator), as one. .: Treat every value with the dot (".") decimal separator. Commas (",") are treated as thousand separator. ,: Treat every value with the comma (",") decimal separator. Dots (".
-
Metadata File Management The Metadata File Management action task is used to execute actions on Metadata files. This task does not modify the data, Job Info variables, other variables or any other part of your 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.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous 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.
-
they are disabled and ignored on all tasks that use Metadata afterward. Output The original data file is output, along with the modified Metadata. Task properties General Tab l Filter levels: Rules for deselecting nodes at the Group, Document or Data page level. Note that currently unselected nodes are ignored. 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).
-
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.
-
Used in a rule, it indicates that a dynamic update of the current data page or level is required before evaluating the condition. For examples of how to use the wildcard parameter, see "Data selections" on page 48.
-
Task properties General Tab l l Document: Create a new Document level. Note: Attributes and Fields are deleted for all new Document levels created as well as existing Groups. Group: Create a new Group level. Note Attributes and Fields are deleted for all new Group levels created. l l Delimiter defines if the Condition parameter is triggering the beginning or the end of a Group or Document. If the delimiter option is set to None, the action is not performed.
-
off and close the dialog with the OK button; then turn highlighting back on. Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. Metadata Sequencer Although the Metadata Sequencer acts as a splitter, the data file itself remains untouched, as neither the data nor the Metadata are actually being split through this task. With each sequence, the entire data file still gets carried from one task to another.
-
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. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
Task properties General Tab l l l Archive Folder: Specifies where the PDI file should be saved. This should be the same location as the PDF file that the PDI refers to. Filename: The file name for the PDI. This name should correspond exactly with the name of the PDF that the PDI file refers to. 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).
-
Metadata-Based N-Up The Metadata-based N-Up action task works in conjunction with the PlanetPress Design tool's N-Up functionality. It allows to specify how many virtual pages will appear on each physical page of the PlanetPress Design template to be used with the current data file. The task rearranges the Metadata accordingly, which greatly facilitates the set up of the N-Up functionality in the design tool, especially when the solution includes duplex printing with variable data on both sides.
-
Task properties General Tab l l Number of virtual pages that appear on each physical page: This is equivalent to the N in N-Up. This number should be equal to the total number of virtual pages in your PlanetPress Design document. For example, a 2 horizontal x 3 vertical is 6-up, so this number should be 6.
-
OL Connect Send Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application. It is in fact an application with two components. The first is a Windows printer driver while the other is a group of Workflow plugins (Job Processor, Get Job Data and Get Data). These two components work together indiscriminately, each needing the other to function. Connect Send can be used in unlicensed mode and licensed mode.
-
Properties General Tab Filter options Filters are required for: l Start and end date (down to minutes) l Domain(s) l User(s) l Machine name(s) Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: l Workflow variables l Job variables l Names. Tip No spaces are allowed around the listed names, respectively before or after a semicolon. Operators l Searches are case-insensitive.
-
This would look for all entries, where the user name is either: l as currently stored in the global Workflow variable User l "helen" l as stored in the job variable number 1 l equals "george napier" (case insensitive). These search criteria are combined with OR. Example 2 The domain name entered in the Filter Domains field is objmtl.objectiflune.com and the user name entered in the Filter Users field is rentel.
-
Results For each job that matches the search criteria, the following information will be put into the resulting data file: l Job UID l Date/Time stamp l Number of Copies l Number of pages l User name l Original file name l Original file size l Domain (workgroup) name l Domain / Workgroup Indicator l Machine name l Machine GUID. Results File Format The following result file formats are selectable: l XML l JSON l CSV (Separator = semicolon (0x3B), string indicator = quote (0x22)).
-
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.
-
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.
-
Input The Job Processor plugin must be added to a Workflow job transfer process that starts with an HTTP Server Input. The Job Processor plugin is the only other task in that process. The action name of the HTTP Input task must match the last part of the URL for print job submission, set in the OL Connect Send Printer Driver installer. By default this is olcs_transfer.
-
Timeout During a job transfer from the OL Connect Send Printer Driver to Workflow, a timeout could occur (indicated by a log entry like “ERROR: sendBinaryContents: Could not open request. Reason: 12002”). In this case, the timeout for the HTTP service in Workflow needs to be increased. It is recommended to use a value of more than 10 minutes (>600 seconds). Additionally, the timeout in the browser on the client side should be enhanced. Please see the help pages for your browser about how to do this.
-
“%CommonProgramFiles(x86)%\Objectif Lune\\Plugins\CPD”. By adding the entry “DBPort = ” under [HSQLDBSETTINGS] and then restarting the service, the communication port is changed. Note that Workflow has to be restarted after such a modification. Output The plugin stores the incoming print job in the target folder with the file name specified in the plugin. If no extension is defined by the user for the file name, the default “.
-
To facilitate using job related information for the creation of the target folder and file name/s, the Job Processor plugin maps job relevant information to the standard Workflow variables (%1 to %8). The following mappings apply: Information Workflow Variable When licensed When unlicensed Job ID %1 Job ID Job ID 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.
-
Any OL Connect Send Printer Driver can communicate with any plugin, as long as this third version number part is identical. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in the Task Comments Pane.
-
This task is a combination of the 4 different OL Connect tasks that are normally used in conjunction to generate Print output: "Execute Data Mapping" on page 555, "Create Print Content" on page 547, "Create Job" on page 535, and "Create Output" on page 537. Combining them in a single task makes creating Print content easier and faster, as the task is optimized for this specific purpose.
-
l l l l "%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. Adding configurations is done through the Send to Workflow option in the DataMapper Module.
-
l l l l l l Import a rule: Click to open the Browse dialog and load a Rules file. This will load its rules into the list. Export the rule: Click to open a Save dialog and save the Rules file to disk. Rule Viewer: Displays a text-based view of the condition using operators and parentheses. Sort contents: Defines how records are sorted. l l Clear the rule: Click to delete all rules in the list. Note: This cannot be undone. Sort items based on: Displays the current sorting method.
-
l l Template Names: Select the appropriate template name from the list. Adding templates is done from the Send to Workflow option in the Designer Module. Preview: Displays a preview of the output generated by the Print context of the selected Template. Not available for the PDF/VT or dynamic template names. By default the entire Print context is printed. Printing selected Print sections can only be achieved with a Control Script in the template (see Control Scripts in the Designer Help).
-
l Output Management group: l l As defined by Output Preset: Select to send the output of the job to the location set in the Print Preset (file, printer, etc). Through Workflow: Select to replace the current job file with the output produced by the server. Every option in the Output Preset is still used, except for the output location.
-
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.
-
Create Email Content The Create Email Content task generates a set of email content items from a template's Email Context, which are then sent directly to the recipient set in each record. Input This task must receive either Metadata containing information regarding a valid Record Set, or JSON data. Metadata The "Execute Data Mapping" on page 555 task and the "Retrieve Items" on page 567 task output metadata containing information regarding a Record Set.
-
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 Within the Workflow process, the output to this task is only modified metadata indicating that the task is complete. It is the Server component that outputs the emails themselves and sends them to each recipient.
-
l JSON: l JSON String: a JSON object or an array of JSON objects representing records (see "JSON string examples" on page 81) or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 82). This option requires that keys in the JSON data have matching field names in the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields.
-
l Attachments: l l l Print Context as PDF document: Check to generate the Print Context in the template as a PDF and send it with the email as an attachment. Web Content as HTML page: Check to generate the active Web section in the template as an HTML page and send it with the email as an attachment Test SMTP settings: Validates the format of the sender's address and mail host and tries to send a test email. This won't work when the option Start TLS is checked.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
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 l l l Default: The IDs in the Metadata are used instead of a job preset file. Select this option if the Print Content Set is the result of the Retrieve Items task. "%o": Select to use a dynamic preset name.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous 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.
-
Note When added as an Output task, the Create Output plugin works asynchronously to the Workflow process. 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.
-
location. Note that when the output is separated, the current job file is not replaced with the actual output files but with a CSV file that lists the paths to the outputted files (e.g. “C:\Users\Administrator\Connect\filestore\3836.2859982401376467470\template_ 0001.pdf,C:\Users\Administrator\Connect\filestore\3836.2859982401376467470\te mplate_0002.pdf,…”). OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
l l Recipient Node: Use the drop-down to select which level of the metadata is used as the "Recipient" node. The Recipient node defines each Record in the output when used with the Create Print Content task. Add job information to document: Check to add the 9 Job Info variables to the PDF/VT metadata at the root level. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous tab is common to all tasks.
-
To make the rendering process as fast as possible, the generated PDF isn't optimized for print production purposes. 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. Properties Datamapper tab The Create Preview PDF plugin gets one record from the source selected on the Datamapper tab.
-
Note When the data mapping configuration provides multiple records, the preview is created based on the first record. Note The Create Preview PDF plugin cannot parse Workflow automation variables. Instead it uses the default values set up in the Preprocessor of the data mapping configuration.
-
l Metadata uses existing metadata, generally the output of a Create Record Set or a Retrieve Items task set to retrieve a record. Update fields with metadata: when this option is selected, the plugin will update fields in the Connect database based on the metadata content. This is only useful if the Workflow process has modified the metadata and the corresponding fields should be updated in the database before creating the preview PDF.
-
A JSON string with references to local variables and Job Info 2: { "first":"%{first}", "last":"%{last}", "email":"%2" } A JSON string containing a local variable and various lookups: { "jobid":"%{jobid}", "account":"lookup(OLCS_jobs, account, jobid, '%{jobid}')", "datafile_name":"lookup(OLCS_jobs, datafile_name, jobid, '% {jobid}')", "pages":"lookup(OLCS_jobs, pages, jobid, '%{jobid}')", "documents":"lookup(OLCS_jobs, documents, jobid, '%{jobid}')", "recordsetid":"lookup(OLCS_jobs, recordsetid, jobid, '%{jo
-
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. The record is then merged with the template to create a preview PDF. Select the appropriate template or option: 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.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
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. Note When JSON data is used as input, the "Create Job" on page 535 plugin (the next task in a print process) cannot use a Job Creation Preset. The Create Print Content task doesn't create a record set based on the provided data, like the "Execute Data Mapping" on page 555 task does.
-
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.
-
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon. Create Web Content The Create Web Content task generates the output of the Web Context of a specified template for a single record and returns the HTML code to PlanetPress Workflow for further processing and return to the requester. Generally, this task is placed within an HTTP Server Workflow.
-
Note that only the first JSON object is processed, as the endpoint generates HTML output for a single record. Processing For a single record, this task generates the output for the Web Context of the specified template. Any external resources such as images, CSS style sheets or JavaScript files, are also produced and put aside on the OL Connect Server component. Note Content creation may be aborted by a script in a Connect template that raises a fatal error.
-
the metadata. Right-click the field to access other data selection methods (see "Data selections" on page 48). l l Update Records from Metadata: If the process's Metadata has been modified by any of the Metadata Tasks, check this option to update the records in the Connect database with the Metadata and use the updated records.
-
Note By default, the Create Web Content task inserts a meta tag in the generated HTML, specifying a default URL and target for all links on the web page. By pointing to the Connect Server the job was sent to, the tag enables the HTTP server to retrieve the resources that were saved with the Designer template. Since the tag corrupts local anchors - links to another location in the same web page -, the task also replaces the HREF attribute of local anchors with JavaScript code.
-
Miscellaneous Tab The Miscellaneous 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.
-
If the data mapping configuration expects a database data source, the Data Source option is ignored and the database is accessed instead. If a PDF/VT file is used, the data mapping configuration option is optional - if one is present, it must be able to read the PDF/VT. Output The output to this task is twofold. On the OL Connect Server side, a Record Set containing multiple records is created and saved.
-
l l l Output records in Metadata: Select to output the full Record table (no Details table) as Metadata in the task. It is then possible to sort and filter the Metadata using the regular Metadata tools, as long as the Update Records from Metadata option is used in further tasks to use the modified Metadata. Output results in XML data file: Select to output an XML structure containing the full Record Set including all details table.
-
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.
-
File Store - Delete File The File Store - Delete File task deletes a file from the OL Connect File Store, using either a file name or File Store ID. Input The task requires either the name of the file in the OL Connect File Store or its File Store ID. The name of a file is chosen and its File Store ID is returned when uploading it with the "File Store - Upload File" on page 562 task.
-
l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
-
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.
-
Miscellaneous Tab The Miscellaneous 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 l l Filename: Enter the file name or a JobInfo, local or global variable that contains the file name, to use when saving the file in the OL Connect File Store. The default is %f, the name of the job file. Right-click the field to select another variable. When you specify %o as the file name, the file in the OL Connect File Store will have the same name as the original file.
-
Miscellaneous Tab The Miscellaneous 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 Set types to mark for deletion based on metadata content: l l l Job Set: Tag any Job set created by the Create Job task or the Retrieve Items task set to retrieve Job Sets. Content Set: Tag any Content set created by the Create Print Content task or the Retrieve Items task set to retrieve Content Sets. Record Set: Tag any Record set created by the Execute Data Mapping task or the Retrieve Items task set to retrieve Record Sets.
-
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. Miscellaneous Tab The Miscellaneous 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.
-
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 535 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. Miscellaneous Tab The Miscellaneous 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 Validate Names: Click to check the each of line in the list against the currently active Metadata (see "Metadata" on page 69). Metadata must be loaded in "The Data Selector" on page 747 or through the use of the Debugging feature. Set Properties The Set Properties Action task defines properties for entities saved in the OL Connect Database (Records, Content, and Jobs). These properties are applied to the entities and can then be used to retrieve them using the Retrieve Entities task.
-
l Remove entry: Click to delete the currently selected line in the Properties list. l Move entry up: Click to move the currently selected line up in the Properties list. l Move entry down: Click to move the currently selected line down in the Properties list. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences.
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
l "PlanetPress Fax" on page 446 l "FTP Output" on the next page l "PlanetPress Image" on page 448 l "Print using a Windows driver" on page 581 l "Printer Queue Output" on page 583 l "Secure Email Output" on page 587 l "Send Email" on page 590 l "Send to Folder" on page 594 l "SOAP Client plugin" on page 578 Delete Delete output tasks simply delete the job files they receive. They are often used after conditions to get rid of those files that did not meet the requirements of the condition.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous 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. 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. Note: There is no validation to ensure the port is available.
-
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.
-
If firewalls control communication between the SOAP client and the Web servers, they must be configured so as not to block client-server communication. In the case of "string" type data, SOAP Client plugin tasks normalize all line endings to a single line feed character. 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.
-
l l l l l Name: Displays the name of the arguments associated with the selected method. Note that you may also manually enter new arguments, change or delete existing ones, as well as change their order if needed. Type: Displays the argument type. 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).
-
The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab. To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
-
Task properties General Tab l l l l Printer queue: Select the queues to which you want to send the output. Note that this is a variable property box, so you can use various schemes to use printer queue names that change with each job at run-time. Properties: Click to change the current printer queue properties.
-
Note Known issue: If a data file with Metadata is resubmitted to such a process, the from/to page values set by the user in the Resubmit interface are ignored. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 88. Miscellaneous Tab The Miscellaneous tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
-
The task can create print output as well, by merging the data file with a PlanetPress Design document (see "PlanetPress Design documents" on page 39). This requires at least one PlanetPress Design document to be associated with a Workflow printer queue (see "Associating PlanetPress Design documents and PlanetPress printer queues" on page 109). For more information about printing see "About printing" on page 98. Input Any data file.
-
version number, you can use an Add Document action task instead of a Printer Queue Output task, and then use an Add / Remove Text Action task to add a version number in the document trigger (for more information, refer to the Control Versions of a Document section of the PlanetPress Design User Guide). Note It is not possible to select a Connect template with this task.
-
queues were selected, the first one sending jobs to a printer that prints 500 pages a minute, and the second one sending jobs to a smaller printer printing 50 pages a minute, the first queue will receive roughly ten times more pages than the second one. l l Page delimiter group: These options are enabled when you choose Split job or Queue balancing load balancing options. They are used to determine how each job is to be split before being sent to the Workflow printer queues.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. The tab also provides an option to highlight the task in "The Process area" on page 769 with the default color, set in the Preferences (see "General appearance preferences" on page 659), or the color selected or defined under Highlight color on this tab.
-
"Variable task properties" on page 236. Note When specifying multiple recipients for the To, CC and BCC fields, separate the e-mail addresses with semi-colons (;). l To: Enter the email address(es) of the recipient(s). l Cc: Specify addresses to which a copy of the generated emails are to be sent. l l l Bcc: Specify discreet addresses (other recipients will not be able to see these addresses) to which a copy of the generated emails are to be sent. Subject: Enter the subject of the email.
-
Attachments Tab Use this tab to specify what files to attach to the e-mail. l l l l Attach input job file: Select to attach the current job file to the email that the task sends. Rename to: Check this option to rename the job file before attaching it to the email, and enter a name. You may use text, variables and data selections (see "Variable task properties" on page 236). File: Select additional or more additional files to include as attachments.
-
Miscellaneous Tab The Miscellaneous 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 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. Once the contents of the file and attachments are determined, the email (including attachments) is either sent directly to the selected SMTP server, or is deposited in the "Outbox" folder of the local Microsoft Outlook account.
-
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).
-
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 Concatenate files: If this option is selected, when PlanetPress Workflow tries to save the job file under an existing name, it appends the content of the new job file to that of the existing file, instead of overwriting it. In the case of a PDF, this will act like the "Merge PDF Files" on page 271 input task, merging the PDF logically. Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected.
-
l l l l Creating a new branch will create an Unknown output task in that branch. See "Adding tasks" on page 233. Using Branch From Here... will create an Unknown output task below that branch. See "Adding tasks" on page 233. Opening a configuration that contains additional plugins that are not installed on that system will cause these plugins to be replaced by Unknown tasks. Installing the additional plugins and re-opening the configuration will restore the plugins and their properties.
-
cannot be modified. They provide information about the job, process, and PlanetPress Workflow environment. For more information see "Standard variables" on the next page. All the variables in PlanetPress Workflow are considered strings, even if the information itself can be a number. There are no other types of variables (such as arrays, floating point numerical values or booleans) in PlanetPress Workflow.
-
Designer). They contain a data model and instructions on how to extract data from a job file and are used by the All in One task and the Execute Data Mapping task. Job Infos are passed to the task so the trick is to transfer the value of the Job Info to a field in the data model. To do that, simply add a property-based field to the Data Model and select a Job Info from the list of properties; see Adding a property-based field. Note that Job Infos don't change whilst the task executes.
-
Variable Name Example value when interpreted original format %F Job file path and name C:\Program Files\PlanetPress Workflow 7\PlanetPress Watch\Spool\job1D80328.dat %f Job file name including the file extension job1D80328.dat %z Job file size in bytes 34134 %o Original file name invoice_june2nd.
-
Variable Name Example value when interpreted %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 time it is used) 0ZIS4CW8U47VI00 %U Unique 36character string consisting of 32 alphanumeric, lower case characters and four hyphens.
-
Variable Name Example value when interpreted xxxxxxxxxxxxxxxx (8-4-4-4-12 characters). %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.meta %E Current Metadata path and file name C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool\5.tmp\job00ZAIZ2C4FXON16CE6C566.dat.
-
Initial input tasks do not modify the value of %i. However, the following tasks do trigger the variable: l Barcode scan l Capture Field Processor l All Splitters (Including the Metadata Sequencer) l Get Capture Document l Loop l Capture PGC Splitter l PrintShop Mail Error handling variables The error handling variables are read only and are filled by the On Error mechanism.
-
Variable Name %{error.process} Name of the process where the error was triggered. %{error.tasktype} The type of task that triggered the error % {error.taskname} The name of the task that triggered the error % {error.taskindex} The position of the task in the process %{error.errormsg} The error message, as entered in the OnError tab of the task. This is the same message as appears in PlanetPress Workflow Log file. %{error.errorid} The error ID, as entered in the OnError tab of the task.
-
1. Select the process where you want to add the variable. 2. Now you can use one of two methods: l l Click on the Home tab of the PlanetPress Workflow Ribbon, then click Local Variable in the Variables group. Right-click on the process in the Configuration Components area, then click on Insert Local Variable. Deleting a variable l Right-click on the variable name in the Configuration Components pane and click Delete. Note Deleting a variable does not delete any reference to it.
-
Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" on page 607). Global variables Global variables are set at the level of the configuration file and are shared between all processes and tasks. To refer to a global variable, for example in a variable task property (see: "About Tasks" on page 232), use its name preceded by "global." and surrounded by curly brackets, for example: % {global.myGlobalVariable}.
-
1. Double-click on the global variable in the Configuration Components pane. (Rightclicking then clicking Properties also works.) 2. Enter the new value for your global variable. 3. Click OK to save the new value. Deleting a variable l Right-click on the variable name in the Configuration Components pane and click Delete. Note Deleting a variable does not delete any reference to it.
-
Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" below). Variable task properties When you edit tasks, you may notice that some of the properties that you can modify have a red (or more precisely, a maroon) title. This means that the property can be dynamically determined whenever your process runs, that is to say it will not remain static.
-
an output file name: %O_@(1,1,1,30, KeepCase,Trim)_%y-%m-%d.txt. This would translate in the original file name, followed by part of the first line of a text data file, then the current date. Inserting variables in task properties In any variable properties box, you may use the contextual (right-click) menu to add variables and control characters, as well as to get data and make data selections.
-
You can quickly identify variable information that is already present in your variable properties as such: l l l l l A percentage sign identifies standard variables, as well as standard and custom job info variables — %f, for example. A backslash indicates a control character — \004, for example. An at sign (@) indicates a data selection for emulations other than database — @ (1,1,1,1,17,KeepCase,Trim), for example.
-
OL Connect Send processes Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application. It is in fact an application with two components. The first is a Windows printer driver while the other is a group of Workflow plugins (Job Processor, Get Job Data and Get Data). These two components work together indiscriminately, each needing the other to function.
-
containing a camera, processor, memory and communication capabilities and they can recognize their location on any paper where a special Anoto pattern is printed. For more information on building and using PlanetPress Capture processes, please see "PlanetPress Capture Workflow" on page 195. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
-
or the presence (or absence) of ink on any of the Capture Fields on the document. Capture-Ready Document A PlanetPress Connect document (*.pp7) that contains at least one Capture Field on at least one page. Capture Document Manager A tool that lets a user search through the available documents in the Capture Database. The documents can be search through a few different criteria and can be displayed as PDF files, individually or as a group. Documents can also be closed or deleted from this interface.
-
ICR (Intelligent Character Recognition) Recognizing text that has been hand-written with the Anoto Digital Pen. This feature is currently not implemented in PlanetPress Capture, but will be in the (near) future. Ink Data The pen stroke information contained within the PGC file. This is the actual data applied to the document (lines, signatures, text, etc).
-
Pidget Type of PlanetPress Capture object. Page element used to give instructions to the Anoto pen, as opposed to recording ink. PlanetPress Capture Database A database containing the list of patterns, sequences, registered pens and documents. The Capture Database can be used by a single server, or by multiple servers in a Client/Server architecture. Session The time spent by the pen between events that trigger a new session.
-
bit and cannot access the 64-bit data sources. In order to create an ODBC connection visible by PlanetPress, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\odbcad32.exe . The following considerations should be kept in mind while working with ODBC Databases in PlanetPress Suite. l All databases l l l l l l Minimum 100MB of database size is required as a minimum, but the space requirement depends on the implementation.
-
l MSSQL (Microsoft SQL Server) l l l l All versions of the SQL Server are supported, including all Express versions. Database can be in any location, but performance will depend on the speed of the connection between PlanetPress Production and the SQL server. In the event where 2 requests are made simultaneously on the same record, SQL Server will drop the most complex request. Resubmitting the PGC for processing should resolve this issue. This, however, should happen only rarely.
-
signed document has, by definition, a longer life span than the temporary storage location of the digital pen. Consequently, it is still the most vulnerable piece of the workflow and as such, it should be the first objective of any security effort. In other words, as long as the physical piece of paper bearing markings is accessible to malicious users, no amount of security protocols can protect the signed contents.
-
l The same rules apply to PDF files as with PGC files, especially when they contain a signature from the pen. If you are already securing digital scanned copies of signed documents, the PDFs should be secured in similar ways. However, remember that as with most security concerns, in order to be a “threat”, someone would have to have a high level or working knowledge of either the Anoto SDK (which is not easily obtainable) or PlanetPress Workflow and PlanetPress Capture.
-
and cannot be re-used. Then, when someone writes on the document and sends the pen data to PlanetPress Workflow (through a docking station or through Bluetooth), if the required conditions have been met, the document will be "closed", its pattern released and available to be used immediately. An open document can also be called a "live" document, in the sense that it is only active between the time where it is printed and the time where ink from the Anoto Digital Pen is processed and the document is closed.
-
Extending There are actually 2 ways of dealing with extending the number of patterns using the currently available tools, each with its own advantages and disadvantages. Using separate PlanetPress Workflow servers and licenses. In a scenario where there are multiple locations that use PlanetPress Capture and where neither pen nor paper has any risk of being moved from one location to another, the easiest (but costlier) solution is to have a separate installation of PlanetPress Workflow in each location.
-
Note It's very important to note here that the Anoto Digital Pen has absolutely no concept of Pattern Sequences. When "attributing" a sequence to a pen, this is fully on the PlanetPress Workflow side, in the Capture Database. This means that if a pen is mislabeled or someone picks up the wrong pen, this pen has absolutely no way to know that it is writing on the wrong paper. more about this in the Contamination section below.
-
contamination. A simple example in a basic implementation would be to print a document with a pattern on it, put this paper aside (or lose it on a desk somewhere) and forget about it. Assuming proper processes were put in place, this document would eventually be closed by a manual or automatic procedure. However, the physical document with the pattern still exists even if it is closed in regards to the PlanetPress Capture database.
-
l l PlanetPress Capture checks for pattern size and placement. If the data contains ink for a specific pattern but the ink location does not correspond to the Capture Fields of the document it's updating, it will fail. Errors can be set to stop and revert the whole current batch. If a single error occurs during the pen data processing, it is possible for this processing to be stopped and all changes the Capture Database reverted.
-
To configure this communication: 1. Open penDirector setup by right-clicking on its icon in the Windows System Tray, and selecting penDispatcher. 2. Double-click on the PlanetPress Capture entry. 3. Change the PGC Storage folder or PGC POST URL settings to your liking. 4. Click OK, then OK again. The PGC POST URL should correspond to your server name or IP, Port and the HTTP Action task of your HTTP Input, if that is what you are using. Example: http://127.0.0.
-
Warning Because the Bluetooth configuration only handles a single route, it is not possible to use the Design preview patter, or the special registration pattern, using Bluetooth connectivity. To use the preview Pattern in PlanetPress Design or use the special registration pattern, the pen's docking station must be used. To specify where to send the PGC files received through Bluetooth: 1. Open penDirector. 2. Go to the Bluetooth tab 3. Click on the paired pen that you want to configure 4.
-
Black ink close to patterns Because the Anoto Pen & Paper technology relies on infrared to read pure-black dots on the paper, it is imperative that no other black ink interfere with this reading. Though it is possible to print Capture documents on a black & white laser printer as long as there is no other ink on top of, or close to, the patterns, this is not recommended. A color laser printer should be used, and any elements placed close to, or on top of, the Capture Patterns should be printed in color.
-
Pattern sizes The absolute minimum required for an Anoto Digital Pen to read the pattern and know it's position on the page is 7mm (1/4"). Any pattern smaller than this will not be readable. However, at 7mm width and height, the pen can only recognize a single dot within that pattern, at the top of the field. 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 698. 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 515.) 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 641. Input A PDF file that is PDF/A compliant. The PDF/A conformity level doesn't matter. It may be 1, 2 or 3. Processing The plugin first checks that the PDF is PDF/A compliant, and doesn't already contain ZUGFeRD data. If it is, then the PDF is processed. Output A PDF/A-3 file with the selected ZUGFeRD data included.
-
l Zu verwendendes PDF group: Allows selection of the PDF file to process and enrich with the ZUGFeRD-XML information. Select from: l l Workflow Jobdatei: Use the incoming Workflow Job File. Datei: Specify a specific PDF. Use the browse button the file path and name into the edit box. to select a file, or paste The file path and name can be given and defined via variables, so the file selection can be dynamic. Note The PDF selected must already be PDF/A compliant.
-
Note The date entry 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. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Adresse: The postal address (sans post code and city entries). Two address lines can be included in this entry.
-
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. The choices are either "VA" (Umsatzsteueridentifikationsnummer (UStID)) or "FC" (Steuernummer (national)).
-
Note No postal code validation is done by the plugin, so it is up to the user to make sure that the postal code entry is valid and in the correct format for the indicated country. This field can be set via Workflow data and/or variables. l l Ort: The postal address city/town. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Ländercode: A 2-letter country code as defined by the industry standard ISO 31661 alpha-2.
-
l Zahlungsinformationen group contains payment related information. l l Zahlungsreferenz: The payment reference, purpose, or payment number serving as identifier for the payment. This field supports alphanumeric strings and can be set via Workflow data and/or variables. Währung: This is a 3-letter currency code, as defined in the ISO 4217 3A standard. The plugin offers some predefined common currency codes in the pull down list box. Other codes can be entered manually or via variables.
-
standard), a 2-character (letter or digits) location code and an optional 3-character (letter or digits) branch code. Note The plugin does not validate bank IBAN/BIC codes. It is the responsibility of the user to ensure that valid codes are entered. This field can be set via Workflow data and/or variables. l Allgemeine steuerliche Informationen group contains taxation related general information. l Steuerart: The trade tax code following the international UNCL 5153 standard.
-
l Detaillierte steuerliche Informationen group contains detailed taxation information. l l l l l l Gesamtbetrag der Positionen: The total amount. This entry should be a numeric currency entry, which can be set via Workflow data and/or variables. Bruttosumme: The grand total amount. This entry should be a numeric currency entry, which can be set via Workflow data and/or variables. Gesamtbetrag der Zuschläge: The charge amount.
-
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. 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.
-
Preferences PlanetPress Workflow Configuration program lets you configure a variety of options, from how the application itself looks or behaves, to plugin specific options. Most of PlanetPress Workflow preferences are located in the PlanetPress Workflow Preferences window, accessible through the Preferences button in the PlanetPress Workflow button, or the key combination Ctrl+Alt+P.
-
l "Telnet Input plugin preferences" on page 693 l "PlanetPress Fax plugin preferences" on page 694 l "FTP Output Service preferences" on page 697 l "PlanetPress Image preferences" on page 698 l "LPR Output preferences" on page 701 l "PrintShop Web Connect Service preferences" on page 703 Note Preferences are saved automatically and applied immediately.
-
l l Highlighted tasks and branches: Select the background color for highlighted tasks and branches in the Process Area’s invisible grid. Disabled tasks and branches: Select the background color for disabled tasks and branches in the Process Area’s invisible grid. Inactive process l Color: Select the color to use to identify inactive processes in the Configuration Components pane. l Bold: Select to use a bold font to display inactive processes.
-
l Reset to default button: Click to reset all the Object Inspector options to their default values. Configuration Components pane appearance preferences Colors This window lets you set the color of individual Configuration Components pane elements. To change the color of a given element, select it in the list box above and then choose a color from the drop-down list below.
-
Default configuration behavior preferences l Use default configuration: Check to use default input and output tasks when you create a new process. If this group is not selected, each new process you will add will begin and end with unknown tasks. l l l l l l l 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.
-
Preferences l l l l l l l l l l l l User mismatch: Select to have PlanetPress Workflow display a prompt when a different user opens the application. Task deletion: Select to prompt for confirmation when deleting a task. Document deletion: Select to have PlanetPress Workflow prompt for confirmation when deleting a document.
-
l l l l l l l l l l l l No registry: Select to have PlanetPress Workflow notify you if it cannot find an install location in the registry. In such cases, the path of the currently running software executable is used as the install path. PlanetPress Watch 3 documents and job commands transfer: Select to have PlanetPress Workflow display a prompt when you import a configuration from PlanetPress Watch 3 that allows you to transfer documents and job commands.
-
Refreshing PlanetPress Connect Documents that are currently in use can lead to unexpected results. l l l Prompt on Saving with Unknown Task: Select to have PlanetPress Workflow prompt for confirmation when saving a configuration file or sending the configuration to the PlanetPress Watch service, when any process contains "Unknown tasks" on page 595.
-
Network behavior preferences Network behavior preferences let you configure NetWare® Login user options, so that PlanetPress Workflow can access your Novell® NetWare network. The following procedure also lets you choose the Universal Naming Convention (UNC), which removes inconsistencies when accessing paths on Novell and other networks. Preferences l NetWare Login: Check to enable the options PlanetPress Workflow requires to access NetWare resources.
-
Note You can leave the Context box empty if there is a single root context on your NDS tree, if you can perform a context-free log in, or if you enter a server name in the Server box. PlanetPress Workflow and PlanetPress Image use the same security context when connected to a NetWare server and they each use one connection. Also note that using erroneous Tree or Context information may cause PlanetPress Workflow and its services to crash.
-
l Pen Database group l l l Register pens on first use: Check if you want any new pen that sends a PGC to be added to the pen database. Newly registered pens will not have any Pattern Sequence or owner information. Manage Pens...: Click to open the "PlanetPress Capture Pen Management Tool" on page 673 dialog. License Manager...: Click to open the "PlanetPress Capture License Management" on page 675 dialog.
-
Options and Controls Documents Lookup Group l Filter by: Select what information you want to look for in the documents database. l l l l l l l l l l Document ID: Search using the Document ID, a unique and automatic identifier attributed to each document by the Capture Field Generator task. Document Title: Search in document title as specified in the Capture Field Generator task.
-
l l Contains: The mask is contained within the database information, at any location within the information. Does not contain: The mask is not contained within the database information. l Mask: Enter the text or number to compare with the database information. l Search: Click to start the search.
-
Settings l l l l Name: Click to displays and choose from a drop-down of each DSN (Data Source Name) available on the system, along with it's source (User DSN or System DSN) and the driver it uses (database type). 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.
-
Database considerations (ODBC) Note On 64-bit operating systems, the ODBC Data Sources created by the Data Source (ODBC) icon in the Administrative Tools will not appear here, as PlanetPress Suite is 32bit and cannot access the 64-bit data sources. In order to create an ODBC connection visible by PlanetPress, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\odbcad32.exe .
-
l l l l 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. In the event where 2 requests are made simultaneously on the same record, MySQL will queue one of the requests and execute it once the first one is done. In extremely rare cases this may cause a timeout on very large requests.
-
Pen Data List: Displays a list of registered pens and those pens you just added. l l l Pen ID: The serial number of pen, as written on the Anoto Digital Pen. You can doubleclick this area to edit the Pen ID if necessary. Pattern Sequence: The pattern sequence the pen is assigned to. You can double-click this area and edit the pattern sequence as required. User ID: The name of the user assigned to this pen. You can double-click this area to edit the user ID. This can also be custom information.
-
Multiple pens can be registered at once simply by writing on the registration pattern and then docking each pen before clicking the Read PGC File button. If the pen that is being registered already exists in the pen database, the Replace User ID (Description) dialog appears, with the following options: l Pen ID: Displays the Pen ID (serial number) to identify the pen l Old desc.: Displays the content of the User ID field for the pen as it is now. l New desc.
-
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 PPLIC overwrites your current license, however it may contain more than one Pen Pack (your previous one and one you just purchased) and will display them individually. License List: Displays the licenses that have been added to this system.
-
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. Password: Enter the password expected by the OL Connect Server for the above user name. Email Creation Settings l l Mail Host: Enter the default SMTP Server host or IP Address.
-
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. When this value is at 1, a very large space or overlap will be 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. The lower this value, the higher the chance of a space being added between two characters.
-
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.
-
Preferences l l l Port: Select the port to use. The default port is 8080, the official HTTP alternate port, so as not to interfere with the standard HTTP port (80). To block any regular HTTP traffic (for example if only using HTTPS connections) the port can be set to 0. Note that it is possible to use both the NodeJS Server and the standard HTTP Server simultaneously, provided that they are not set to listen to the same port. See "NodeJS Server Input plugin preferences 1" on page 688.
-
l Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. 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.
-
see "PHP arrays example" below). This option makes it much easier to select all elements on the same level in a data mapping configuration, and to convert the XML to a JSON object. 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.
-
Peter Parker Objectif Lune 122 253 dent 361 341 dent Resulting XML structure with Enhanced PHP-like arrays email@example.
-
HTML response file and do not pass through a process to get served so the process is very quick. Static resources are especially useful for additional formatting of HTML files such as JS (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.
-
l l System language: Sets the encoding attribute in the request XML file to the system codepage (e.g. Windows-1252). UTF-8: Causes all parameters as well as file names from the request to be interpreted as a UTF-8 text stream. With this option enabled, POST attachment file names will be randomized on disk to avoid misinterpretation. If the original file name is needed, it can be found in the original attribute of the file tag in the request XML.
-
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. Log files are kept in the Log folder, which is located in the PlanetPress Workflow installation folder. They are named lpddate.log, where date is the current date in the yyyymmdd numerical format.
-
Note 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. Note that it is possible to use both the NodeJS Server and the standard HTTP Server simultaneously, provided that they are not set to listen to the same port. See "HTTP Server Input plugin preferences 1" on page 681. Time out: Set the timeout period in seconds. The default value is 120 seconds.
-
l l l l Key: Enter the absolute path to the Private Key File. This file generally ends with a .key extension. Password: Enter the password (or passkey) for the Private Key File. Verbose log: Select to enable to keep a verbose log. Note that a communication log is generated whether or not this option is selected. If you use a secure connection, the log will contain extra information. Disable SOAP Server: Check to disable all SOAP Server functionality.
-
Note The 'Forward all HTTP traffic to HTTPS' option (see "NodeJS Server Input plugin preferences 1" on page 688) 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.example.com).
-
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. Serial Input plugin preferences Serial input plugin preferences control certain functions of the PlanetPress Serial Capture service, which in turn has a direct impact on all Serial input tasks performed by PlanetPress Workflow on a given computer.
-
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. The start bit is always 0 to mark the beginning of the byte, but the stop bit can be a single 1, or two bits each with a value of 1.
-
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.
-
parentheses that appear in the data selection, and sending the result to WinFax PRO. WinFax PRO dials the result exactly as it receives it from 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.
-
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.
-
output. These messages are related to jobs being sent from PlanetPress Workflow to an LPD or LPD-compatible printer. Logs are kept in a Log folder relative to your 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.
-
PrintShop Web Connect Service preferences PrintShop Web Connect service preferences control the credentials to log into the PrintShop Web server. The available preferences are as follows: l l User name: Enter the user name of a valid PrintShop Web user, mostly operators. 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 *.
-
l l l l l l l l l Insert mode: Select to use Insert mode and clear to use Overwrite mode. In Insert mode, when you enter text, existing text shifts to accommodate it. In Overwrite mode, text you enter overwrites existing text. You can also press INSERT to toggle between the two modes. Use tab character: Select to use the tab character instead of spaces to represent tabs in the program file. Clear to use spaces to represent tabs. You must clear the Smart tab option to use this option.
-
l l l l l l l l l Keep trailing blanks: Select to preserve any blank spaces occurring at the end of a line. Clear to remove those blank spaces. Persistent blocks: Select to have any text you enter immediately after selecting a block of code appended to that block of code as part of the selection. When you select this option, you can also use the arrow keys to move within the code without affecting the selected code. You must select the Enable selection option to use the Persistent blocks option.
-
l l Tab stops: Use to set the number of spaces to advance when you enter a tab character or to set a series of tab stops. Enter a single integer to set the number of spaces to advance with each tab. Enter a sequence of two or more integers, each separated by a space, to specify tab stops. The sequence must be in ascending order. Tab stops are measured in number of space characters. For example, a value of 20 places the tab stop at the 20th space character.
-
l l l l Gutter width: Enter the width, in pixels, of the gutter. Use the drop-down list to select a previously-entered gutter width. Line numbers on page: Select to display code line numbers at the left edge of the Code area. If you clear both this and the Line numbers on gutter option, no line numbers appear alongside the lines of code. Line numbers on gutter: Select to display code line numbers in the gutter between the Commands and Code areas.
-
The user interface This chapter centers on the 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 718. l " The Quick Access Toolbar" on page 776. This toolbar is customizable. l The ribbon tabs; see "The PlanetPress Workflow Ribbon" on page 777. l "The Process area" on page 769 l "Configuration Components pane" on page 719.
-
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.
-
above it (undocked position). You dock a window when you attach it to the Program window, and you undock it when you detach it from the Program window. The Configuration Components pane, the Object Inspector and the Messages area can each be displayed inside its own window, whether docked or undocked, but they can also be displayed attached or combined inside the same window. l l l When separate areas are displayed simultaneously, they appear in different sections of the Program window.
-
the Messages area. The area will jump from an undocked to a docked position and viceversa. Show or hide areas of the program window You can choose to hide or display any of the customizable areas in PlanetPress Workflow program. Hidden areas will still contain the same information but will not be visible. To show or hide a Program window area: 1. In the PlanetPress Workflow Ribbon, click the View tab. 2. From the Show/Hide group, click on any area name to hide or display it.
-
a tab appears at the bottom of the rectangle. Switching between combined areas At the bottom of the combined area, click the tab of the area you want to bring to the top. If all the tabs are not displayed, use the left and right arrows to navigate between them. Image: The left and right arrows let you show hidden tabs. Reordering tabs in a combined area At the bottom of the combined area, click the tab of the area you want to move, drag it to the left or right and drop it at the desired position.
-
Taking an area out of a combined area To take an area out of a combined area, do one of the following: l l Click the tab displaying the name of the area you want to take out and move the mouse pointer so as to drag the area away from the combined area. As you drag, a rectangle is displayed to show the landing position. Release the mouse button when the rectangle is away from the combined area. Double-click the tab of the area you want to take out of the combined area.
-
Image: Attaching an area to a group of combined areas. The rectangle showing the landing position is not tabbed and the area will therefore be moved next to the combined area. Maximize or restore attached areas To maximize or restore attached areas, do one of the following. l To maximize a vertically attached area, click the upward pointing arrow on its title bar. l To restore a vertically attached area, click the downward pointing arrow on its title bar.
-
Image: A) Click to maximize this area. B) Click to restore this currently maximized area.
-
Image: C) Click to maximize this area. D) Click to restore this currently maximized area. Taking an attached area out of a group To take an attached area out of a group, do one of the following: l l Click the title bar displaying the name of the attached area you want to take out and move the mouse pointer so as to drag the area away from the group. As you drag, a rectangle is displayed to show the landing position. Release the mouse button when the rectangle is away from the group.
-
To resize a program window area: 1. Move the pointer to an edge of the area that you want to resize, to display the resize pointer. 2. Then click and drag to resize the area. Change the Interface language 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 114).
-
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 115). 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 key groups. Delete Key: Click to remove the currently selected key in the group.
-
l l l Clear All Data: Click to delete every key set of every group in the Repository. Warning: This action deletes all your data and cannot be undone. Clear Repository: Click to delete every group in the repository, including all their data. Warning: This action deletes all your data and cannot be undone. Show/Hide System Keys: Click to show or hide the ID, DateC (creation date) and DateM (modification date) keys.
-
l To add a key set, press Insert. The Add Key Set dialog will appear. Use the arrow buttons to browse through the keys in the key set and add values to them. This dialog has a button at the bottom to add another key set. Navigating with the keyboard Though of course the mouse is the easiest way to navigate through the Data Repository, the keyboard can be used as well. l Press Tab to switch between the Repository Structure, Group Key Sets, Lookup Function Syntax and the Close and Help buttons.
-
l l Right-click a task property that may contain variables (recognizable by the color of its field label, which is maroon by default) and choose one of the Get Data ... or Get Metadata ... options. Debug your configuration and step through it until the option Debug > View Metadata gets enabled. This happens when the Metadata file has been created by a task in the process.
-
The Data Selector is essentially the same as the one used in PlanetPress Design. The File Viewer is like a Data Selector without any data related options, such as emulation settings. It is displayed when doing a data selection from the Generic Splitter task (see "Generic Splitter" on page 389) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks.
-
PDF Emulation l l l If you use a PDF emulation, the Data pane displays the data as you would see it in any PDF reader. A new zoom drop-down list is displayed to let you set the zoom in percentage or fit the PDF to the window or the width of the window. A new status bar, displaying the (Left, Top) and (Right, Bottom) coordinate pairs, is shown under the Data pane. XML Emulation l XML data is represented in a tree structure which corresponds to the data in the XML file.
-
on page 52). This expression is editable, which allows you to customize the string returned by the Metadata selector. Tip The wildcard parameter '?' indicates that the function operates on all nodes (not just one) of a given level; see "Wild card parameter "?"" on page 49. The Enable search on multiple levels option is available when a Metadata is selected under Production information or User defined information. If it is not selected, the option flag includes NoCascade (+2).
-
Data Selector display preferences The Data Selector Preferences are accessible through the Selector Options tab in the Data tab of the Data Selector. It controls how text-based data files (such as Line Printer, ASCII and Channel Skip) are displayed in the data selector.
-
1. In the Data Selector, click the Selector Options tab. 2. Change the options that modify the appearance and behavior of the Data pane: l l l l l l l View size: Use to adjust the size of each cell in the Data Pane, and the amount of visible data that is visible. Show used cells: Select this to display in green all cells that contain data.
-
Font To set the font the Data Selector uses for all emulations except XML and PDF: 1. In the Data Selector, click the Selector Options tab. 2. Click Select Font. 3. In the Font dialog box, set the font you want PlanetPress Workflow to use to display the sample data file in the Data Pane. l Font: Select the font you want to use to display the sample data file in the Data Pane. l Font style: Select a weight for the font. l Size: Select the point size for the font.
-
The PDF Viewer To open the PDF Viewer: In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer.
-
The PDF Viewer is accessible through one of the following methods: l l l In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer. Click View as PDF in the Debug toolbar. This will show the current data file in the viewer (assuming it is a PDF). If the viewer is opened during debugging, the current state of the PDF will be displayed (instead of the original data file).
-
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 115). 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 343. l Send one or more images to the printer: see "Send Images to Printer" on page 364. 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 597). Local Variables: Displays all the variables local to this process (see "Local variables" on page 603).
-
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. The Process area The Process area, which is always available and visible, holds all the tasks, branches, conditions and comments that make up the selected process (see "About processes and subprocesses" on page 114 and "About Tasks" on page 232).
-
l "Undo a command" on page 776 l "Redo a command" on page 774 l "Highlight a task or branch" on page 772 l "Resizing the rows and columns of the Process area" on page 775 l "Zoom in or out within Process Area" on page 776 Cutting, copying and pasting tasks and branches Using cut and paste, and copy and paste, you can move as well as duplicate tasks and branches within a given process as well as between different processes and subprocesses. To cut and paste tasks or branches: 1.
-
l l l When you cut an Input or Output task, it is replaced with an Unknown Task, that you will need to replace with another task for the process to be functional. If you cut one task or branch, then cut another one, the first one is lost and replaced by the second. Remember however that you can always undo the command to retrieve it (see Undo a Command). Tasks and branches will always appear on top of (in other words, before) the task or branch where you paste it.
-
Highlight a task or branch The Highlight command lets you toggle the background color of selected tasks and branches. There are several ways to highlight a Process area square. l Right-click it and select Highlight from the contextual menu. l Double-click it, open the Miscellaneous tab and select the Highlight option. l Select a square, open the View ribbon and select Highlight from the Navigate group. To remove the highlight, repeat the procedure.
-
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. If the task or branch was enabled, it is now disabled, and vice versa. Moving a task or branch using drag-and-drop When you want to move a given task or branch, the simplest way is to use drag-and-drop. Using the mouse, you can drag and drop tasks and branches only within a given process.
-
Duplicating a task or branch To duplicate a task or branch, the same method as for moving them applies but with a slight difference: 1. In PlanetPress Workflow Process area, click the icon of the task or branch you want to duplicate. 2. While holding down the mouse button, press and hold down the CTRL key and drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item and release the CTRL key.
-
Note You cannot use the Delete option to remove an input or output task, but you can rightclick on them and click Cut instead. This replaces the task with an Unknown task (see "Unknown tasks" on page 595). To delete the path below a branch crossing (instead of the path to the right of the branch): l Press Shift+CTRL+Delete. l From the right-click menu, choose Edit | Delete| Delete Below the Branch.
-
To 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. When the cursor changes appearance, click and drag up or down to resize rows, or left or right to resize columns. A dashed line appears as you drag indicating the new separation. The row or column, with all its tasks, moves accordingly.
-
Adding buttons To add a new button to the Quick Access Toolbar: 1. Locate the button you want to add in one of the tabs of the Ribbon. 2. Right-click on the button. 3. Select Add to Quick Access toolbar. Note The Quick Access Toolbar buttons cannot be moved or reordered. If you wish to reorder them, you will need to remove all the buttons and re-add them in the desired order. Removing buttons To remove a button from the Quick Access Toolbar: 1.
-
commands that are frequently used and convenient to keep close at hand. You can minimize the Ribbon, and choose the position of the Quick Access Toolbar, as well as the commands it displays. l You can minimize the Ribbon by right-clicking on it and selecting Minimize the Ribbon. l You can also customize the Ribbon's color scheme in the Preferences window. The PlanetPress Workflow Ribbon has five tabs: the Home tab, the View tab, the Debug tab, the Tools tab and the Help tab.
-
Child/Go to Parent to move around a given process logical nodes (branches or conditions). l l The Debug tab includes the Data, Debug and Debug Messages groups. l l l l The Show/Hide group contains four controls to display or hide any of the four panes; the Configuration Components pane, the Object Inspector pane, the Message pane, the Debug Info pane and the Plug-in Bar.
-
l l l l The Document Manager button opens the PlanetPress Capture Document Manager. The Pen Manager button opens the PlanetPress Capture Pen Management Tool. The Test Page group: l l l The Service Console button opens the The PlanetPress Workflow Service Console, allowing to monitor real-time information on the configuration execution.
-
changed in the Comments tab.
-
Knowledge Base You can find extra information in Connect Knowledge Bases which complement the information contained in this manual.
-
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.
-
