User Guide Version: 2018.
User Guide Version 2018.1 Last Revision: 7/11/2018 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-2018. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc. Inc. Objectif Lune Inc. Inc.
Table of Contents Table of Contents 4 Welcome to PlanetPress Workflow 2018.1 10 Notes in this guide Installation and Setup 10 12 System Requirements Operating System (64-bit only) Minimum Hardware Requirements Environment considerations Terminal Services Virtual environments 32-Bit or 64-Bit? Antivirus considerations Backup considerations Microsoft Office compatibility Setting up the working environment Known Issues Upgrade to Workflow 2018.
Where to find the Data Repository Debugging and Error Handling About error handling Using the On Error tab Creating and Using Error Processes Accessing the Logs Resubmit Backed Up Input Files to a Process Knowing What to Resubmit Debugging your PlanetPress Workflow process About Printing PlanetPress Workflow Printer Queues Shared Printer Queue Properties Windows Output Printer Queue LPR Output Printer Queue FTP Output Printer Queue Send to Folder Printer Queue Triggers Load Balancing Objectif Lune Printer D
Special Workflows PlanetPress Capture Workflow Database Considerations (ODBC) HTTP Server Workflow PDF Workflow Capture OnTheGo Workflow Workflow processes in a Connect Send solution ZUGFeRD About Tasks Adding tasks Editing a task Task properties Variable Properties Input tasks Action Tasks Data Splitters Process Logic tasks Connector Tasks PlanetPress Capture Metadata Tasks OL Connect Send OL Connect tasks Output Tasks Working With Variables Types of variables Job Info Variables Standard Variables Manipula
PrintShop Mail documents About related programs and services Available Input services Available Output services Start and Stop PlanetPress Workflow Service Users and configurations Workflow Services The Interface Customizing the Workspace Dock and Undock Areas of the Program Window Show or Hide Areas of the Program Window Combine and Attach Areas Resize the Program Window Areas Change the Interface Language PlanetPress Workflow Button Options Configuration Components pane Components Area Sections Process pr
Update document Data Repository Manager Virtual Drive Manager The Debug Information Pane The Message Area Pane The Object Inspector Pane The Plug-in Bar Categories Settings & Customization Preferences Other Preferences and Settings General appearance preferences Object Inspector appearance preferences Configuration Components Pane appearance preferences Default Configuration behavior preferences Notification Messages behavior preferences Sample Data behavior preferences Network behavior preferences PlanetPr
Adding Branches Edit a Task Replacing Tasks, Conditions or Branches Remove Tasks or Branches Task Properties dialog Cutting, Copying and Pasting Tasks and Branches Moving a Task or Branch Using Drag-and-Drop Ignoring Tasks and Branches Resize Rows and Columns of the Process Area Selecting Documents in Tasks Links Highlight a Task or Branch Undo a Command Redo a Command The Quick Access Toolbar The PlanetPress Workflow Ribbon The Task Comments Pane Additional Information 652 652 653 653 654 655 657 658 658
Welcome to PlanetPress Workflow 2018.1 This PDF documentation covers version 2018.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 System Requirements These are the system requirements for PlanetPress Workflow 2018.1. Operating System (64-bit only) l Microsoft Windows 2008/2008 R2 Server l Microsoft Windows 2012/2012 R2 Server l Microsoft Windows 2016 Server l Microsoft Windows Vista l Microsoft Windows 7 l Microsoft Windows 8.1 l Microsoft Windows 10 (Pro and Enterprise versions only) Note Windows XP, Windows 2003 and older versions of Windows are not supported by PlanetPress Workflow.
Terminal Services PlanetPress Workflow does not support Terminal Services environment as possible under Windows 2000, 2003 and 2008. This is to say, if Terminal Services is installed on the server where PlanetPress Workflow is located, unexpected behaviors may occur and will not be supported by our company. Furthermore, using PlanetPress Workflow in a Terminal Service environment is probably an infringement of our End-User License Agreement.
PlanetPress Workflow software license may only be used on a single virtual or physical PC at a time. While copying a virtual machine for backup purposes is acceptable, running two instances of the same machine, using the same serial number, is strictly prohibited. 32-Bit or 64-Bit? PlanetPress Suite version 7.1.3 and higher support 64-Bit operating system.
l On all systems: l l C:\Windows\Temp\ Processes: l PPAlmbic.exe l Service.exe l PPWatchService.exe l PPImageService.exe l MessengerService.exe Note C:\Windows\Temp\ is used by multiple software which may cause risks on your computer. However, PlanetPress Workflow may use this folder as temporary storage, especially in the case of creating PDF files. We do not recommend disabling scan on this folder, unless you notice performance issues when generating PDFs, and then only as a test.
l Setting up the Workflow Configuration tool. Configure a variety of options, from how the application itself looks or behaves, to plugin specific options. These are accessible through the Preferences button under the PlanetPress Workflow Button (see "Preferences" on page 607). Known Issues Upgrade to Workflow 2018.1 leaves Uninstallation entry for earlier version If PlanetPress Workflow 2018.
Workarounds l l For the Lookup in Microsoft Excel Documents plugin (found in the Connectors tab of the plugin bar): Open the original .xls file and save it with the .xlsx format. That will force the Excel Lookup plugin to switch drivers. For the Database Query plugin (found in the Actions tab of the plugin bar) and when using Excel/Access in PlanetPress Design: Change the ODBC driver used for Excel files from JET to ACE (change the Data Source).
l l l l l l l l l 20143: The Metadata to PDI task encodes the XML using the default system encoding, not the document's. In addition, it does not discriminate between index names written in different cases (e.g. Name vs. name). Printing PDF files in passthrough mode using a Windows Printer Driver task causes jobs to be processed sequentially rather than in parallel. This is caused by a 3rd party library used in the printing process.
be the case. You can confirm this behavior by opening up the Windows Task Manager and checking whether the MSIExec application is running. In order to complete the installation of MS-Word for the LocalSystem account, follow these steps: 1. Open a command-line window (CMD.exe) 2. Type "AT 10:56 /INTERACTIVE CMD.EXE" (replace 10:56 with the next upcoming minute on your system) 3. At the specified time, a new command-line window opens.
l Barcodes produced in printer-centric mode may have a slightly different aspect from those produced in Optimized PostScript mode. This is due to the different types of 3rd party libraries being used to generate the barcodes. However, all barcodes scan correctly.
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 15). 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 528). They become visible in the "Configuration Components pane" on page 555.
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.
originates from many different sources (as many as the input tasks support), parts of it can be stored in variables, and it is always accessible by the task that currently handles it. Data is referred to in tasks using data selections; see "Data selections" on page 26. Note Null characters present in the data may not be displayed properly when using the PlanetPress Workflow Configuration tool, and they may also be printed differently by different printers.
In the PlanetPress Workflow Configuration program, you use sample data files to create, edit and debug PlanetPress Workflow configurations. 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.
Data Selector" on page 32) or Get Repository Location to open the Data Repository Manager (see "Data Repository Manager" on page 598). Note The Get (...) Value options will also open the Data Selector or the Data Repository Manager, but once selected, the value becomes static and does not change between each datapage and job file. After opening a sample of the data and/or metadata, you can easily make a selection.
columns on a given page. Syntax @(page number, from line, to line, from column, to column, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l l @(): Always surrounds a data selection. 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(): Always surrounds database field selections. l Record Set Number: The data page (or "record") of the data selection. l Child Number: Line Number in the record (if there are multiple lines returned for one single record). l Field Name: The name of the field you want to retrieve. l Case Option: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent.
Note that when adding a metadata field, if you perform a multi-line data selection on a PDF region, only the first line of that region will be set to the metadata field. Syntax region(page, left, top, right, bottom, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l region(): Always surrounds PDF data selections. l Page: The page of the PDF from which to retrieve the data.
Syntax GetMeta(Field Name [, Option Flags, Metadata Path]) Here is a breakdown of the syntax: l l GetMeta(): Always surrounds metadata selections. Field/Attribute Name: specifies the name of the field (or attribute, if the GetAttribute option flag is set) to retrieve (see "Metadata" on page 39). 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.
Name Value Behavior FailIfNotFound 4 Raise an error and crash the job is the specified name is not found instead of returning an empty string. SelectedNodesOnly 8 Returns values from the selected nodes only. The Data Selector The Data Selector is the tool you use to choose your sample data and metadata files, to select the appropriate emulation, to make data selections, and to stabilize your data. To open it: l l l Choose Debug > Select, on the menu.
Data tab The Data tab contains the Data Options, which let you select your emulation, and the Selector Options, which let you personalize the data selector's display options (see Data Selector Display Preferences). The Data Selector uses the emulation (either the emulation chosen when the sample data file was selected, or the one chosen in the last Change Emulation action task appearing above the current task) to format the data.
the Emulation section) and a grid-like display of each character on each line. The following emulations however, will be slightly different. Database Emulation l l The Database emulation changes the Browse button ( ) for the Database Emulation Configuration button ( ), which displays the Database Emulation Configuration (see Database Emulation).
Tip To get a sample of the metadata file, debug your process and step through it until the option Debug > View Metadata gets enabled. This happens when metadata have been created by a task in the process. Open the metadata viewer and save the metadata file to use it as a sample file. Click the Open a meta data file button to open the sample in the metadata selector. PlanetPress Design documents (unlike Connect Designer templates) are built to contain metadata.
Note A number of the options in the Metadata Selector in PlanetPress Design 7 are no longer available in the user interface of PlanetPress Workflow . However, when these settings are made in PlanetPress Design 7, they will function as expected in PlanetPress Workflow 2018.1. About data emulation An emulation is like a filter that can be used to read data. It specifies how to interpret a data file.
Emulations in PlanetPress Design The Data Selector in Workflow is essentially the same as the one used in PlanetPress Design. When you create a document in PlanetPress Design, you choose a sample data file and specify the emulation to use for the chosen data. Within PlanetPress Workflow, the same emulation tools as in PlanetPress Design are available throughout your process, using the Data Selector.
The sample data file should have a relatively small number of records (generally less than a hundred) in order to be processed quickly, while your actual data may be much larger and take more time to process. The sample data file should also contain at least one of every exception you may want to detect, or data used for a specific condition.
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. Opening a previously used data file PlanetPress Workflow also keeps the last 9 used data files in memory, which you can reopen to use in the same process, or in a different one. To reopen a sample data file: 1. Click the Debug tab in the PlanetPress Workflow Ribbon. 2. Click on Reopen Data File in the Data group. 3.
Metadata structure The hierarchical structure of the metadata is composed of a number of basic levels for adding information to the job. These levels are, from top to bottom: l l l Job: a file that contains 1 or more groups. Group: a logical and ordered group of documents (ex: all invoices for a specific customer number; all documents going to the same address, etc.). Document: group of 1 or more ordered datapages intended to the same recipient from the same source (ex: invoice).
l l l The job contains only invoices for clients located in Montreal. Since more than one invoice can go to the same recipient, invoices are grouped by customer. Each invoice is a document resulting from the execution of a PlanetPress Design document over one or more datapages, which results in zero or more physical pages being output.
Attributes are non-repetitive (i.e. name is unique) and do not persist through metadata recreation. l Field: A read-write, user-defined element which holds custom information about a certain node in the metadata structure. Fields are repetitive (i.e. the same field may appear multiple times) and persist through metadata recreation.
In the following table, the last 5 columns indicate at which level the corresponding attribute is available. This also depends on the type of job, however. In the metadata file created for an OL Connect job, only three levels are filled with actual data about the job: Job, Group and Document. Attribute Description Categor y J o b Gro up Docum ent DataEncoding (optional) Name of the character encoding.
Attribute Description Categor y J o b Gro up Docum ent software that created the metadata. on Creator Name of the software that created the source of the metadata. TargetDevice Datap age Pa ge Producti on X X X Name of the device for which the metadata and associated data is intended. Producti on X X X Dimension Two floats separated by a colon indicating the media size in typographical points (ex: 612:792).
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge respectively portrait, landscape, rotated portrait and rotated landscape. Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent. Finishin g X Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicates a change of the duplex status.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge identifier of the media source. OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedepedent color of the media. Finishin g X X X X X MediaType Devicedependent type of the media.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge X X X X X X X X X X under the parent Document. IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group. Index/C ount IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
Attribute Description Categor y J o b Gro up Docum ent Datap age SelectedCount Index/C ount X X X X SelectedDocument Count Index/C ount X SelectedDatapage Count Index/C ount X X SelectedPageCoun t Index/C ount X X SelectedIndexInDo cument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInGr oup Returns the Absolute index of the node within all the selected nodes under the parent Group.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge index of the node within all the selected nodes under the parent Job. NumCopies Indicates how many times the job is set to execute, as set when printing using a Windows driver. Index/C ount X Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input.
Metadata Tools in PlanetPress Design PlanetPress Design includes a complete set of metadata-related functionality, which can be referred to as Metadata Tools. These tools can be used to generate metadata, retrieve or define metadata elements, and build the metadata structure. Using PlanetPress Design, one can: l Generate metadata for any given sample datafile. l Graphically retrieve the value of a metadata attribute or field for use in any design object.
Firstly, two buttons at the top right corner of this tab allows to load or save a metadata file generated for the current sample datafile. Secondly, the metadata tab graphically displays all elements (i.e. attributes and fields) available at the current level (i.e. Page, Datapage, Document, etc.). More importantly, these elements are graphically selectable, like any other part of the sample datafile when using the 'Select Data' option inside a Text object, for example.
Metadata in document properties The Metadata tab in the properties of a PlanetPress Design document allows to easily define documents or groups.
The Metadata Fields in the structure of a PlanetPress Design document allow to easily define documents or groups, by dragging and dropping data from the Sample Data directly onto the document's Metadata Fields. Data Repository The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes. This feature was introduced in version 8.5.
Feature Name Description Equivalent Database Terminology STRING values and any data inserted into it is converted to string automatically. The maximum size of a single key is 1 billion bytes. KeySet A group may contain as many KeySets (rows), which contain variable data, as necessary. A KeySet is inserted using the "Push to Repository" on page 301 task. Row/Record Lookup A method of retrieving one or more KeySets from a group in the data repository.
Note Value_To_Match can be a static string a jobInfo or a variable but not a data selection. For the Value_To_Match parameter, the single-quotes surrounding the value are mandatory even if the value is dynamic. This function may also be used anywhere else where the contextual menu gives access to it. You could, for example, use it on the General tab of the Create File task, to fill in the value of a key/value pair in a JSON string.
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.
the process - which sets the default error handling behavior for all the tasks in that process - or of an individual task. Using the On Error tab Whenever an error is triggered either during debugging or when a process runs in production, the settings specified in the On Error tab of the task that generated the error will be used to determine a course of action. On Error Tab The On Error tab is common to all tasks and processes. It can be found in the" Task Properties dialog" on page 654.
l l l l l 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. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
You can have as many error processes as you can normal processes - that is, you are limited to 512 processes, subprocesses, startup processes and error processes combined.
l PlanetPress Image l PlanetPress Fax l PlanetPress Messenger 3. When any job or file is processed by the selected service, the processing logs will be displayed in the window on the right. 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 627. To view logs for jobs that have already processed By default, the logs are available in the following folder: C:\ProgramData\O
Resubmit Backed Up Input Files to a Process Each input task includes an option that lets you back up input files. This options is not selected by default, since it has the potential to generate a very large number of back up files. To turn on the backup option of an input task, simply open its properties, go to the Other tab and check the Backup input files option, then type in a unique file name for the backup file (this should be variable).
To resubmit backed up input data files: 1. In the PlanetPress Workflow Ribbon, go to the Tools tab then click Resubmit Job in the Services group. The File Resubmission dialog box is displayed. 2. From the Process box, select the process for which you want to resubmit the backed up input files. 3. From the Task index box, select the index level to which you want the data to be sent. The index is the position in the process where you want to submit the job file. 4.
But finding this information often poses a problem. A good way to find this information easily is to print it using small characters at the bottom of every page. To do this, you have to do the following. In PlanetPress Design: 1. Use a Set Job Info action task and associate a variable with the job’s name. 2. In the output task, make sure to select the option that adds the job information to the document.
l l l Since the initial input task is not performed, there is no actual job information to be added at the beginning of a data file. Note that you can use the Object Inspector on your process to enter sample job information as required. If any task makes an operation on the system (for example, capturing files, sending data, printing, etc), it is actually executed, not simulated. Any task is executed with the permissions of the user that is currently running the PlanetPress Workflow Configuration Tool.
l l 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 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. l In the viewer that appears, save the file to a location on your hard drive. l Stop the process, and select the file you saved as your process' data file.
l l Remote printing: l l l Send to Folder output queues let you save jobs to a local or network folder from which they can be picked up and printed. See "Send to Folder Printer Queue" on page 74. FTP output queues let you upload jobs to an FTP site from which they can be picked up and printed. See "FTP Output Printer Queue" on page 73. LPR output queues let you send print jobs to remote printers via TCP/IP using the LPR/LPD protocol. See "LPR Output Printer Queue" on page 71.
balancing or not (See "Load Balancing" on page 76). PlanetPress Workflow Printer Queues The printer queues displayed in the Configuration Components pane of the PlanetPress Workflow Configuration program are not to be confused with Windows printer queues. When you start building a PlanetPress Workflow configuration it contains no printer queues so you have to create queues and set each one’s properties.
Properties 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.
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.
data in the TeX DVI format. Select (o) PostScript file if the job file is a PostScript file. Select (n) Ditroff format if the job file contains data in device independent troff. Select (t) Troff format if the job file contains data in troff. Select (v) Sun raster file if the job file contains raster images. This ensures that the printer uses the correct filter to interpret the data. l l Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used.
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. FTP Output Printer Queue Unlike FTP output tasks, which are typically used to send data files to FTP sites, FTP output printer queues are mostly used to send print jobs to FTP sites.
Advanced tab l l l l l l l Print speed: Enter the speed, in pages per minute (PPM), of the printer associated with the printer queue. This value is used to determine how to divide jobs when you use the Queue Balancing option for load balancing. Commands: The list of available commands appears in this box. Select either Pre-job commands or Post-job commands in the Selected box, and double-click a command from this list to add it to the appropriate list.
l l Concatenate files: If this option is selected, when PlanetPress Workflow tries to save the print job under an existing name, it appends the content of the new print job file to that of the existing file, instead of overwriting it. Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected.
(trigger+document+data). l When the server running PlanetPress Workflow only sends the data to the printer, because the document is already present on the printer, it adds a trigger before the data (trigger+data). PlanetPress Workflow adds the trigger code automatically, but you may want to use custom triggers. You would do this, for example, to use special printer functions. For more on custom triggers, see the Data Capture and Trigger Implementation Guide as well as the PlanetPress Design User Guide.
Install a Objectif Lune Printer Driver (PS) The Objectif Lune Printer Driver (PS) is automatically installed during the PlanetPress Workflow setup, along with a default Windows Printer Queue called PlanetPress Printer. Install a Windows Printer Queue using the Objectif Lune Printer Driver (PS) A Windows Printer Queue using the Objectif Lune Printer Driver (PS) can be installed from PlanetPress Workflow WinQueue Input plugin properties. Creating a new Windows printer queue from any PlanetPress Workflow: 1.
l This will create a PostScript data file when the option Create Composed Document Stream (with Medatada) is unchecked. l l This format can be obtained using PlanetPress Workflow. This will create a PDF data file when the option Create Composed Document Stream (with Medatada) is checked. l This format can be obtained using PlanetPress Workflow. By default, the Create Composed Document Stream option is: l Checked if the incoming stream has been produced with the Objectif Lune Printer Driver.
Once the service has started, it captures every queued job. PDF Creation Parameters PDF files retrieved from a Windows print queue using Objectif Lune Printer Driver (PS) have the following properties: l PDF 1.4 l Optimized PDF (subject to change) l No down-sampling of images These settings are pre-configured and cannot be changed by the user. About Metadata Metadata files are files containing information on the job itself rather than containing the job per se.
l l l A Normal process will run as soon as an input file is available through its input task or, if it is scheduled not to run at that time, will start processing as soon as the schedule permits it. Startup processes are processes that run only once before every other process in a given configuration. They can be used to perform operations that need to be completed once before the configuration can actually be run, such as to map network drives.
Creating a new process You can create a new process in a two different ways: l l In the Ribbon, go to the Home tab and click the Process button in the Processes group. In the Configuration Components pane, right-click on any process or the Processes folder and select Insert Process. Regardless of the method, a new process is created with a default name (Process1, Process2, etc), Input Task and Output Task.
l Other tasks included in the process are performed regardless of schedule, granted that the previous task was performed. About branches and conditions While some processes can simply start with an input task, manipulate the data with a few action tasks and finish with an output task, in some cases you may want to have more control over the flow of your process. For example, you may want multiple outputs, such as printing to multiple printers as well as generating a PDF and emailing it.
Conditions A condition will either execute the branch it creates or the main trunk, but never both. As your job file goes down the process, when it encounters a condition it will verify whether that condition results in a "true" or "false" value. If the result is true, it goes in the branch, processes all tasks up to the output, and the process finishes. If the result is false, it goes down the main trunk and continues processing until the process finishes.
l l l l l l Max percentage of threading (%): Determines how many processes you may have running at the same time. This is a percentage of the maximum number of threads specified in the "Messenger plugin preferences" on page 628. For example if the maximum number of threads is 10 and you specify 50% here, a maximum of 5 replications will occur (the original process + 4 copies). As soon as possible: Select to have the process run continuously.
l Poll once per activity period: Select to perform this process’ initial input task no more than once for each set of contiguous blocks (blocks that are on the top of one another). Choosing this option overrides the polling interval option. By default since the Time Grid blocks are divided by hours, this option will make your polling happen once every hour. The Time Grid The PlanetPress Workflow Process Options dialog box includes a time grid that lets you set exactly when you want a process to run.
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 options in the On Error tab of the Process Properties dialog are the same as in the On Error tab in the Task Properties dialogs; see "Using the On Error tab" on page 57.
process, the branch is removed and replaced with a GoSub action task referring to the newly created subprocess. Note The Branch tasks options Backup job file, Backup job information and Backup emulation, are also automatically passed to the subprocess, which means that, if the subprocess needs to use a different emulation than the calling process, a Change Emulation task is required.
l l l Complete PlanetPress Watch 4 to 6 configurations, as well as PlanetPress Workflow 7 and 8 configurations. Specific processes from Version 6, 7 and 8 configurations, including their local variables. Specific subprocesses from any PlanetPress Workflow 7 and 8 Tools configurations. l Specific global variables from PlanetPress Workflow 7 and 8 Tools configurations. l Specific PlanetPress Design or PrintShop Mail documents. l Specific Printer Queues. 5.
Generally this will happen only when calling a third-party software using the Run External Program plugin, but is also valid if using a Script that generates a dialog that someone must click or interact with. Note The term "Desktop" is defined as the desktop of the user logged on to the computer where PlanetPress Workflow is installed. These dialogs cannot be displayed on any other computer. To toggle a process’ Run on Desktop property: 1. Select an active process in the Configuration Components pane. 2.
Executing the Processes (Sending 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.
function. The same goes for any job info, local or global variables, unless you use the "Watch.SetJobInfo" on page 116 or "Watch.SetVariable" on page 117 functions to modify them. Multiple APIs (methods of communicating with PlanetPress Workflow scripting tools) are available through the scripting engine, in all languages. l l l l l l l The Watch object is used to communicate with your current process and configuration. See "The Watch Object" on page 107.
Use the Editor The Script Editor and XSLT Editor share most of the same commands and functions. You can open the Script Editor using the Open Editor button both from the Run Script Properties dialog box and from the Open XSLT Properties dialog box. When you do so, the script currently displayed in the dialog box is pasted to the editor’s scripting box. For information on the available editor options, refer to "Editor Options" on page 646.
make a selection in the Save as type drop-down list. 6. Click OK. Find Strings in a Script The Find Text dialog box allows you to search for text strings in the editor. The available options help you limit the search, making searches quicker and easier. To find strings in a script: Note If you only want to search a particular section of the script, you should select it before performing the following procedure. 1. Choose Search | Find, or press CTRL+F. The Find Text dialog box appears.
scope to selected text, you move forward only within the selection. When the search reaches the end of the script or script selection, the search finishes. It does not loop back to the beginning.
l l l l l l l l Regular expressions: Select to treat the regular expressions of the scripting language as text. If you clear this option, the regular expressions of the language are blocked from the search. Prompt on replace: Select to have PlanetPress Workflow display a prompt before it replaces text. When you use the Replace All function, you are prompted each time matching text is found. The prompt includes an All button for replacing all matching text. This suppresses any further prompting.
Once again, if you selected Prompt on replace, a dialog box opens to ask you whether to proceed with the replacement. You can OK to replace that string only, or you can click All to replace that string as well as every other string that matches the replacement settings. Go to a Line in a Script The Go To Line dialog box lets you jump to a specific line within your script.
To toggle bookmarks: l Place the cursor on a line in your script and, from the editor’s pop-up menu, choose Toggle Bookmark and a given bookmark number. If the bookmark you selected was not displayed on any line, it is added to the line where you placed the cursor. If the bookmark you selected was displayed on the line where you placed the cursor, it is removed. If the bookmark you selected was displayed on a different line, it is moved to the line where you placed the cursor.
Since the SOAP Server API Reference is primarily targeted at programmers or systems engineers, it is rather technical. SOAP API - SubmitJob Syntax SubmitJob (File, SubmitJobInfStruc , ReturnJobFile, user name, Password) : SubmitJobResult Description The SubmitJob method allows users to remotely submit files to their PlanetPress Workflow from a SOAP client. The SOAP client has the option to wait for a response file from PlanetPress Workflow SOAP server. Arguments l l l File – base64Binary.
existed at the completion of the PlanetPress Workflow process (for instance, if the process creates a PDF and sets it as the current job file, the PDF is the file that gets returned to the calling SOAP client). Note The SubmitJob method only returns a file if the PlanetPress Workflow process contains a SOAP Input task. Note If ReturnJobFile is set to true, the schedule options of the process should be set to a pooling lower than four seconds, so the client application gets a timely response.
l PostJobInfStruc – Structure containing any required information to prepare the file for resubmission into a PlanetPress Workflow process. l user name – String containing the user name. l Password – String containing the password. This value is case sensitive. Return Value l l PostjobResult - Structure containing the following information: Success – Integer indicating the Success/Error level of the operation. A result of 0 means that the operation was successful.
Parameters l user name – String containing the user name. l Password – String containing the password. This value is case sensitive. Return Value l l GetProcessListResult - Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status.
l Password – String containing the password. This is case sensitive. Return Value l l GetProcessTaskListResult – Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status. l TaskNames – Structure containing the following information details.
Return Value l l GetSOAPProcessListResult – Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status. l ProcessList – Structure containing the following information details. l l SOAPActionName – String containing the name of the process as seen in your PlanetPress Workflow.
Note If both FirstPage and LastPage are set to 0, the entire data file is used. SOAP API - SubmitJobInfStruc SubmitJobInfStruc Structure containing any required information to prepare the file for a valid insertion into a PlanetPress Workflow process. l l VariableList – Array of complex type, containing pairs of variable name and variable value.
Variable Name Description Example Usage (VBScript) "Watch.GetJobFileName" on page 112 Retrieves a string containing the job path and file name located in the job spool folder. Example Usage: str = Watch.getjobfilename "Watch.GetOriginalFileName" on page 113 Retrieves a string containing the job's original path and filename. Note: this filename is generally no longer available if it has been captured by Watch. Example Usage: str = Watch.getoriginalfilename "Watch.
Variable Name Description Example Usage (VBScript) "Watch.Log" on page 119 Writes to the Workflow log file, or the message window when in debug - can accept multiple log levels from 1 (red) to 4 (gray). Example Usage: Watch.log "Hello, World!",1 "Watch.ShowMessage" on the next page Displays a popup dialog box to the user (user has to be logged on). Example Usage: Watch.showmessage("Hello, World!") "Watch.
Variable Name Description Example Usage (VBScript) Example Usage: Watch.executeexternalprogram "del *.ps" "c:\" 0 true "Script.ReturnValue" on page 121 Returns a boolean True or False value to a Workflow scripted condition Example Usage: Script.returnvalue = 1 Watch.GetPDFEditObject Is used to manipulate PDF files using the AlambicEdit API. See the AlambicEdit API for more information. Watch.ShowMessage Displays a message to the user. This method is the same as PW_ShowMessage.
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.ExecuteExternalProgram const CommandLine: WideString; const WorkingDir: WideString; ShowFlags: Integer; WaitForTerminate: WordBool: integer; const CommandLine: The command line to execute as a widestring.
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); Python Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, True) Perl $Watch->ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true); Watch.GetJobFileName Returns the complete path and file name of the job.
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.GetOriginalFileName Returns the original name of the file, when it was captured. This method is the same as PW_ GetOriginalFileName. Example VBScript Watch.GetOriginalFileName JavaScript Watch.GetOriginalFileName(); Python Watch.GetOriginalFileName() Perl $Watch->GetOriginalFileName(); Watch.
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. This function is completely disabled in PlanetPress Workflow 7.3 and higher. Prompts the user to enter a string. The string is displayed as the window caption. You can specify a message that is displayed above the text box. This method is the same as PW_ InputBox.
VBScript s = Watch.InputBox("Your Name", "Please enter your name", "John Doe") Watch.ShowMessage("Will the real " + s + " please stand up?") JavaScript s = Watch.InputBox("Your Name", "Please enter your name", "John Doe"); Watch.ShowMessage("Will the real " + s + " please stand up?"); Python s = Watch.InputBox("Your Name", "Please enter your name", "John Doe") Watch.
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.SetJobInfo(Index: Integer; Value: String) Example VBScript Watch.SetJobInfo 3, "Job info 3 Value" JavaScript Watch.SetJobInfo(3, "Job info 3 Value"); Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.
Example VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.Log "MyVariable's value is: " + s, 2 s = Watch.GetVariable("global.MyVariable") Watch.Log "global.MyVariable's value is: " + s, 2 JavaScript var s; s = Watch.GetVariable("MyVariable"); Watch.Log("MyVariable's value is: " + s, 2); s = Watch.GetVariable("global.MyVariable"); Watch.Log("Jobinfo 3's value is: " + s, 2); Python s = Watch.GetVariable("MyVariable") Watch.Log("global.
JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); Python Watch.SetVariable("MyVariable", "Desired value") Watch.SetVariable("global.MyVariable", "Desired value") Perl $Watch->SetVariable("MyVariable", "Desired value"); $Watch->SetVariable("global.MyVariable", "Desired value"); Watch.ExpandString Provides access to the emulated job file and to all variables. This function returns a string that is the expanded version of the input string.
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.Log Creates messages that are added to PlanetPress Workflowwatch.log file. PlanetPress Workflow watch.log file is located in ...\Program Files\PlanetPress Workflow 7\PlanetPress Watch\Log\ppw[log date].log. View error messages in the Services Console while PlanetPress Workflow is in Run mode by choosing Tools | Services | Service Console.
Level Description 1 The message is logged as an Error in the log file. 2 The message is logged as a Warning in the log file. 3 The message is logged as Information in the log file. 4 The message only appears when the application runs in Debug mode. Examples In the following example, log() will write an information entry in the watch log that says "this is a log" VBScript Watch.Log "this is a log", 3 JavaScript Watch.Log("this is a log", 3); Python Watch.
VBScript Watch.Sleep 1000 JavaScript Watch.Sleep(1000); Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.ReturnValue Set this variable to 1 (true) or 0 (false) in order to return a true or false status to PlanetPress Workflow, when using your script as a conditional branch. This variable will have no effect if the script is run as an action. Example This example will always return true, as the condition is static. It is, after all, simply an example. You get the idea.
Script.ReturnValue = 0 } Python everythingOK = True if everythingOK: Script.ReturnValue = 1 else: Script.ReturnValue = 0 Perl $everythingOK = 1; if ($everythingOK) { $Script->{ReturnValue} } else { $Script->{ReturnValue} } = 1; = 0; 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 term ... ... is the same as an Excel ... ... is the same as a Database ... Group Sheet Table Key Column Field KeySet Row Record Note Group and key names are case-insensitive. API Reference Obtaining an instance of the Repository Object The Data Repository is accessed via a COM object that exposes methods to store and retrieve data within the Repository. JavaScript var repoObject = new ActiveXObject ("RepositoryLib.
Using a JSON parameter or return value Whenever a parameter or return value is defined as a JSONStringArray type, that JSON array is itself a string. Since a JSON array internally defines double quotes as the delimiter for each element, you must enclose the entire string in single quotes. Alternatively, you can escape the double quotes inside the JSON Array. For instance, the following calls to AddGroup() are correct: RepoObject.AddGroup("MyGroup",'["FirstKey", "SecondKey"]'); RepoObject.
Name Description existing key structure. ConnectionString Creates/opens a Repository to read from and write to at a custom location. Set ConnectionString to a string containing a full path and file name. Version Returns the version of the DLL library used by the Repository. Group methods Name Description AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty.
Name Description only adds a key name to the group, not a key value. See AddValue() for information on how to set a value for a key. ListKeys Retrieves the list of all Key names and data types in Group GroupName, stored in a JSONStringObject. You should use JSON.Parse() to convert the string into an actual JavaScript object. You can then use the for…in construct to list the different properties for that object (i.e. the keys in the group). RemoveKey Removes existing key KeyName from group GroupName.
Name Description Condition may be left empty in which case the very first value found for the specified KeyName is returned. 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.
Name Description GetKeySets Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all keys are retrieved. When Condition is left empty, all keysets are retrieved. RemoveKeySets Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. Condition may be left empty, in which case all keysets in GroupName are deleted. The method returns the number of keysets that were deleted.
VB Script repoObject.AddGroup "Users", "[""FirstName"", ""LastName""]" repoObject.AddGroup "Users", "" AddKey Adds key KeyName to group GroupName. KeyName must not already exist in the specified group. Note that this method only adds a key name to the group, not a key value. See AddValue() for information on how to set a value for a key.
Examples Basic examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 123). JavaScript repoObject.AddKeySets("Users", '[{"FirstName": "John","LastName": "Smith"},{"FirstName": "Richard", "LastName": "Doe"}]'); VB Script repoObject.
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.
ClearGroupData Deletes all keysets inside GroupName while retaining the existing key structure. Syntax ClearGroupData(GroupName: string) ClearRepository Deletes all groups, keys and keysets from the repository, returning it to a blank state. Use with caution! Syntax ClearRepository() GetKeySets Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all keys are retrieved. Note In versions prior to 2018.
Examples Basic examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 123). JavaScript repoObject.GetKeySets("Users", '["FirstName","LastName"]', "Gender='M'"); VB Script myKeySet = repoObject.
The return value (saved for example in the %9 JobInfo variable, as the above example does) can be used in a number of ways: l l l It can be returned to a web page that's making an HTTP request to Workflow. JSON is the simplest way to transfer information between any system that supports JavaScript. It can be passed to Designer and loaded up directly as an object in a script there. The JSON can be converted to XML, which makes it useable in the DataMapper module.
John Smith */ myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" ") /* retrieves email for first user named Smith */ myValue = repoObject.GetValue("Users", "email", "") /* retrieves email for first user */ Retrieving a KeySet ID This JavaScript example retrieves the KeySet ID, which is then used to update values in the row. /* Get KeySet ID */ var Repo = new ActiveXObject("RepositoryLib.WorkflowRepository"); var keySetID = Repo.
Sample return value '["Users","Cart","Orders"]' ListKeys Retrieves the list of all Key names and data types in Group GroupName, stored in a JSONStringObject. You should use JSON.Parse() to convert the string into an actual JavaScript object. You can then use the for…in construct to list the different properties for that object (i.e. the keys in the group).
Syntax RemoveGroup(GroupName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 123). JavaScript repoObject.RemoveGroup("Users"); VB Script repoObject.RemoveGroup "Users" RemoveKey Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised.
RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise. Note This method is functionally equivalent to using "RemoveKeySets" below with its Condition parameter set to "ID=ID". Syntax RemoveKeySetByID(GroupName: string, ID: integer): integer Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.
Examples Basic examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 123). JavaScript repoObject.RemoveKeySets("Users", 'Gender="M"'); VB Script repoObject.RemoveKeySets "Users", "Gender='M'" Deleting a row This script attempts to delete a client from the rows, then returns "true" or "false" in JobInfo variable %9 as a response.
JavaScript repoObject.RenameGroup("Users", "Customers"); VB Script repoObject.RenameGroup "Users", "Customers" RenameKey Renames key oldName to newName in group GroupName. While this operation has no impact on the data stored in that Group, it does require any plugin and/or script that uses oldName to be modified to refer to newName.
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 123). JavaScript repoObject.SetValue("Users", ); repoObject.SetValue("Users", AND MaritalStatus='Married'" repoObject.SetValue("Users", AND MaritalStatus=''" ); "FormOfAddress", "Mr.", "Gender='M'" "FormOfAddress", "Ms.
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 123). JavaScript /* both methods perform the same task */ repoObject.SetValueByID("Users", "FormOfAddress", "Mr.", 10); repoObject.SetValue("Users", "FormOfAddress", "Mr.", "ID=10" ); VB Script /* both methods perform the same task */ repoObject.SetValueByID "Users", "FormOfAddress", "Mr.
Stopping Execution When using a script, you may come to a point where you'd like the task to fail (raise an error) and trigger your On Error tab under certain conditions. This can be done by using the scripting language's built-in error features, described here. Note that the value or description of the error will not be available to your error process if one is used. However, when available, a description of the error message will be logged in the Watch log. VBScript In VBSCript, the Err.
Python In Python, the raise statement is similar to JavaScript and will stop processing unless an except statement is used. See the python documentation. s = Watch.GetJobInfo(9) if not s: raise NameError('Value cannot be empty') else: # Do something with Job Info 9! Watch.Log("Job Info 9's value is: " + s,5) Perl In PERL, die() raises an exception and triggers the On Error tab, unless the unless command is used. See the perl documentation.
compatible with PlanetPress Suite. The Metadata Tools are extensively used in the example presented, which is a weekly sales report sent to all the sales associates of a particular company branch. See the "PDF Workflow" on page 188 for more details. PlanetPress Capture Workflow A Capture workflow is divided in two steps: Creating an output of documents containing the PlanetPress Capture Fields, and retrieving the information from the Anoto Digital Pen to merge it with the original documents.
In order to properly build a PlanetPress Capture workflow, it is very important to understand the terminology, implications and limitations of the technology.
Capturing and Archiving After the printed documents have been inked with the Anoto Digital Pen, the PGC files from the pen must be processed and merged with the appropriate documents in the PlanetPress Capture Database. A workflow process that receives PGC files and reads them in turn consists of the following actions: l l l l l An "HTTP Server Input" on page 226 task or "Folder Capture" on page 217 task that receives the PGC.
Error Handling Whenever an error occurs during the Capture Field Processor phase, it is of course important to be able to handles these errors. For this purpose, the "PGC to PDF Converter" on page 420 task was added with PlanetPress 7.4, adding the ability to quickly and directly convert a PGC file to a blank PDF file containing the ink data as an EPS layer. This is useful when, for example, data is received for a document that's already been closed.
Anoto Pattern A series of dots placed in a pattern that is unique to each page where the pattern is printed. The Anoto Digital Pen identifies this pattern and its location on the page. PlanetPress Capture contains 20,000 patterns (8 in demo mode, See "PlanetPress Capture License Management" on page 623) which can be used to generate documents. Capture Condition PlanetPress Workflow task that is used for post-processing of documents after they have been processed by the Capture Fields Processor.
Closed Document A document still within the PlanetPress Capture Database of which all the required fields have been filled by the Capture Field Processor from a PGC. A closed document will only remain in the database until it is retrieved with the Get Capture Document task, after which it is deleted. Contamination The act of writing on a "wrong" document, aka one that has a Pattern Sequence different that the one for which it was produced..
that of the document causes Contamination, which can cause errors or ink to be placed on the wrong document. Pen ID The serial number of the Anoto Digital Pen. It is registered in the PlanetPress Capture database and is present in each PGC file. PGC File Pen Generated Coordinates; PGC File containing all ink processed while the pen was undocked along with the Pen ID. It is possible that a single document requires multiple PGC, just as it is possible that a single PGC have multiple documents.
Warning PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently. In order to design a document with Capture Fields, you must review and understand the Critical PlanetPress Capture Implementation Restrictions.
l l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database can be in any location, but performance will depend on the speed of the connection between PlanetPress and the MySQL server. MySQL's performance has been slower than SQL Server and SQL Server Express during our tests. By default, MySQL is configured not to allow any SQL request larger than 16 megs.
l In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue. Security Considerations PlanetPress Capture introduces new and efficient methods for digitally capturing the contents of ink laded out on physical paper. However, because of its nature, some end users may voice concerns about security and privacy.
l l l l The transfer between the Anoto penDirector and PlanetPress Workflow is not encrypted due to a limitation of penDirector which does not support SSL connections. This means someone located anywhere between penDirector and PlanetPress Workflow could use software such as a packet sniffer to retrieve its parts and recreate the PGC files. This may be resolvable by create a secure VPN tunnel for each location where penDirector is installed instead of going through regular remote HTTP server.
mode (no license activated), and react the same way that the bulk of the 20,000 patterns. Another single pattern is used to register pens in the database, and one last single pattern is used when printing a "Preview" from PlanetPress Design. So in reality, the number of available patterns for document generation is 19990, but for simplicity's sake this FAQ uses the round number "20,000".
like this one would be perfectly functional and not be affected by the 20,000 page limit. Remember however that this means that 19,000 physical sheets of paper are printed every day, and those 19,000 documents are written on using one or more Anoto Digital Pens, which are then processed back into the system. The example above actually uses numbers that are much higher than our typical PlanetPress Capture user.
for each cases, using a typical situation of a shipping company that uses PlanetPress Capture to simplify the archiving of the client's signature on a "Confirmation of Reception" slip. l Pen-Based Sequences: In this case, each pen is attributed a specific pattern sequence. When documents are printed, they are set to attribute a pattern sequence to each document in relation to which pen it will be signed on.
added to PlanetPress Capture in version 7.4. Contamination The single but critical danger with any implementation that deals with PlanetPress Capture is "Contamination". Basically, contamination happens when an Anoto Digital Pen writes on a "wrong" document or is docked in the wrong location. This can happen any number of ways and in different situations, and can have devastating effects in some of those cases so please pay special attention to this section.
pens inadvertently (we hope, anyways), the pens would be signing the "wrong" documents all day and, when docked, would update the wrong documents in the database. In all of these cases, the errors often do not appear when the wrong document is updated - it actually occurs when the "right" data is processed.
Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc. The penDirector creates a bridge between the Anoto Digital Pen and a PlanetPress Capture workflow in PlanetPress Workflow. In order to use penDirector, it needs to be downloaded from the Objectif Lune website, on this page. This software must be installed after PlanetPress Workflow. The setup will install a preconfigured version of penDirector which can be immediately used with PlanetPress Capture.
3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4. Go in the Bluetooth tab of penDirector and click on Add Pen. 5. Click on Search while the cap is off on the pen. 6. When the pen is found, click on it and then click Add. 7. When asked for the PIN, enter the one noted above. 8. Click OK to save the settings. The settings for Bluetooth PGC handling are separate from the ones used when docking.
PlanetPress Capture Implementation Restrictions This document describes the limitations of the Anoto Digital Pen & Paper Technology, especially in regards to using it within a PlanetPress Workflow implementation. Note that these limitations apply to any Anoto technology implementation and not just our own. Printer limitations Any document printed with Capture Fields (aka Anoto Patterns) must be sent through a Laser printer.
Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
This is because the pen's camera (which captures the position of the pen) is located under the pen tip and must fully see the pattern.
Knowing this, the best practice when creating fields is that they have, at the very least, a 7mm margin on each size of the actual area you want to capture from. For example, an effective 30mm wide pattern will actually be 44mm wide using these margins. The margin should be for both the vertical size and the horizontal size.
PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition". The difference between the two is easily explained: While OCR can only recognize characters using the finished shape (for example, in scanned documents and pictures), ICR relies on much more data which is provided by the Anoto Digital Pen: the path that the pen takes, the exact timing of this path, start and stop points, etc.
User 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 422 l "Capture Fields Generator" on page 404 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.
Post-Processing is generally done using the "Capture Condition" on page 399 task, which verifies the presence or state of the ink on the document or on specific fields. After PGC Handling Here is an example of a process that receives ink data, updates the database, and then verifies whether or not a field that indicates manager attention is required (for example, a box noting the wrong number of items in a delivery slip). If attention is required, the document is sent via email to the manager.
l l The Capture Fields Processor then uses the PGC file to update any documents in the database that the pen wrote on, and closes those documents in the database when they are complete. Capture Condition is where we can check whether a specific field (a "RequireManager" field) has ink contained in it, and if it does, the branch on the right is triggered.
Task Breakdown l The Find Capture Documents task queries the Capture database for documents that correspond to certain specific conditions. For example, here we would look for all documents that are either in an "Error" or a "Partial" state, which means they received ink but are not completed correctly.
to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met". l With this list of documents in the metadata, we Branch off. This is done because we need to build a report that will be sent to an administrator, and only one email should be sent. l l To build the report, inside of the branch we use the Metadata Sequencer to create one sequence for each document, by splitting at the Document level, by 1 occurrence of the level for each sequence.
the Resource action name box to static , and the Resource folder to c:\PlanetPress\http . Then, click OK. 7. Send the configuration to your local PlanetPress Workflow server. 8. Start PlanetPress Workflow services (see "Start and Stop PlanetPress Workflow Service" on page 539). 9. Open your browser and point it to http://127.0.0.1:8080/documentlist , assuming you have not changed the default HTTP port in the HTTP Server Input 2 section.
l l HTML Form Action: An HTML Form in the browser that may contain text and attached files can be filled and sent to a process with the HTTP Server Input task. HTTP Data Submission: A custom application or a server sends the request to PlanetPress Workflow using either a POST or GET command. The application or server then waits for a response from PlanetPress Workflow Tools.
l l Enable server for SSL requests: This enables secure communication between the browser and the server via HTTPS. By enabling this option, you will need to provide for the proper certificates, key and password. While this configuration is beyond the scope of this document, there are plenty of resources on the Internet to explain these systems. Serve HTTP resources: This is where you enable static resources in PlanetPress Workflow.
new request. This should be put at 0 in order to process requests as soon as possible, meaning immediately. And finally, the HTTP Server Input task properties. While these are described in the "HTTP Server Input" on page 226 task properties page, here are a few considerations to keep in mind when using this task: l l l l l The HTTP Action corresponds precisely to the name immediately following the first slash of your address.
3. The XML request file and attachments are saved in a local folder, if the HTTP Action is a valid one (otherwise, the files are deleted). 4. The HTTP service keeps the request from the client open (it does not yet respond ot it), and waits. 5. The HTTP process corresponding to the HTTP Action captures the XML file and attachments and the process begins. 6. The process runs its course just like any other process would (including subprocesses, send to process, etc). 7.
HTTP PDF Invoice Request This straightforward workflow simply receives a GET request from a browser, loads an existing PDF invoice from a folder on the hard drive, and returns it to the browser. To do this, a client (or a web service) would request the following page: http://ppworkflowserver:8080/getinvoice?in=INV999999 Breakdown of this URL: l l http:// : transfer protocol. This could be HTTPS if the SSL certificates are activated in the preferences. ppworkflowserver : name of the machine.
Task Breakdown l l l l The HTTP Server Input task receives a request through the /getinvoice HTTP Action. Because this task either returns an HTML page with an error message or a PDF, the MIME type is Auto-Detect. It checks whether the invoice request exists by checking if the size of the file is less than 1kb using "File Size Condition" on page 348. The condition returns "true" if the file is not found: c:\PlanetPress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value,KeepCase,No
l l Open HTTPBrochureRequest.pw7 and send the configuration to your local PlanetPress Workflow service. Open your browser to http://localhost:8080/generatebrochure 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.
The idea is that a PDF file, because it is a formatted document in and of itself, doesn't absolutely need to go through PlanetPress Design to be processed and printed. Additionally, because of the PDF tools in PlanetPress Workflow, you can easily merge, split, print and take parts of the PDF file as required.
l l l l "Run Script" on page 351 tasks can also modify metadata using the Metadata API (See "Using Scripts" on page 93). The "Barcode Scan" on page 261 task can add information to the existing metadata, and creates it if there is none. The "Capture Fields Generator" on page 404, "Capture Fields Processor" on page 407, "Get Capture Document" on page 418 and "Find Capture Documents" on page 414 tasks generate their own metadata.
l l l l l l l l The "Metadata Level Creation" on page 431 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 425 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.
This section describes the implementation details for a Capture OnTheGo process, including how to create, send and submit COTG documents to the Mobile application. Workflow processes in a Connect Send solution OL Connect Send (see "OL Connect Send" on page 439) 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.
l 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.) 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 439.
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. Without a valid Imaging license, the plugin will create a valid ZUGFeRD PDF file at design time and in debug mode, but will not apply ZUGFeRD data to the PDF in runtime/production mode. An unlicensed plugin will simply will pass through any incoming PDF files untouched.
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. If the incoming PDF is not PDF/A compliant, the plugin will not touch it but will instead forward the untouched PDF as the Job File. If the incoming PDF already contains ZUGFeRD data, the plugin will not touch it but will instead forward the untouched PDF as the Job File.
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. The conformity level doesn't matter (it may be 1, 2 or 3). If the incoming PDF is not PDF/A compliant, the plugin will not touch it but will instead forward the untouched PDF as the Job File. If the incoming PDF already contains ZUGFeRD data, the plugin will not touch it but will instead forward the untouched PDF as the Job File.
variables. l l Adresse entry: The postal address (sans post code and city entries). Two address lines can be included in this entry. This field supports alphanumeric strings, and can be set via Workflow data and/or variables. Postleitzahl entry: The postal address post/ZIP code. Note No postal code validation is done by the plugin, so it is up the user to make sure that the post code entry is valid and in the correct format for the indicated country.
(Steuernummer (national)). This field can be set via Workflow data and/or variables. l Steuernummer entry: The tax identity number. This number must match with the tax type specified in the "Art der Steuernummer" selection. Note The plugin does not check if a given tax ID number conforms to any rules. It is the responsibility of the user to ensure that only valid tax ID numbers are entered. This field can be set via Workflow data and/or variables.
variables. However, the country code must always follow the standard of exactly two uppercase letters only. Note The plugin does not check if a given country code is in the list of valid country codes. It is the responsibility of the user to ensure that only valid country codes are entered. This field can be set via Workflow data and/or variables. ZUGFeRD II Tab The ZUGFeRD data entry options are too large to fit within a single entry tab, so the data entry options have been split over two tabs.
Note The plugin does not check if a given currency code is in the list of valid currency codes in the mentioned ISO. It is the responsibility of the user to ensure, that only valid currency codes are entered. This field can be set via Workflow data and/or variables. l IBAN entry: A bank account number following the International Bank Account Number (IBAN) standard.
l Steuerart entry: The trade tax code following the international UNCL 5153 standard. Generally this is "VAT" (Umsatzsteuer, value added tax). Note The plugin will accept any string. The user needs to take care to only enter valid tax codes as defined in the UNCL 5153 (see http://www.unece.org/trade/untdid/d97b/uncl/uncl5153.htm ). This field can be set via Workflow data and/or variables. l l l l Steuerprozentsatz entry: The tax rate entry.
This entry should be a numeric currency entry, which can be set via Workflow data and/or variables. l Steuergesamtbetrag entry: The total tax amount. This entry should be a numeric currency entry, which can be set via Workflow data and/or variables. Bei Fehler/ On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Anmerkungen/ Comments Tab The Comments tab is common to all tasks.
Some tasks are multipurpose and can be used as either an input, action or output task or any combination. These multipurpose tasks are indicated as such in the task description and can be found in the most relevant section of the available tasks. All plugins can be found in the Plug-In Bar ("The Plug-in Bar" on page 605).
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.
Task properties (missing or bad snippet) Some Action, Create Content and Output tasks let you select a resource file to use with the task; for more information see Selecting a resource file in task properties. Variable task properties Variable 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.
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. Contextual Menu 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.
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. Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example.
l Brackets: Specifies a set of supported characters, or range of characters. Only one character from the range is accepted, making this a subset of the ? wildcard. l l l l Sets: [13ab] defines support for one of these 4 characters. file[13ab].txt would pick up file1.txt , filea.txt , but not file13.txt or filea3.txt. Negative Sets: [!13ab] indicates the character should NOT be part of the set. file [!13ab].txt would pick up file2.txt and filec.txt but not file1.txt or fileb.
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 tasks, 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 Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
l l Add CRLF after last line: Check if you want the plugin to automatically add a new line at the end of the file. Remove the checkmark to leave the file as-is, useful in the creation of CSV files for example. Delete Metadata: Check to delete any metadata attached to your data file. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Email Input Email Input retrieves email data through a Microsoft Outlook or POP3 connection.
those used for Japanese or Chinese, for instance), it is preferable to use attachments rather than the email body to carry the data from its source to the input task, as data corruption is less likely to occur using this method. 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.
l “To” contains: Select to limit those messages used by this task to those that are sent to a specific address. The address you enter in the box below can include variables. 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 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 Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename 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.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Folder Capture Folder Capture input tasks retrieve files corresponding to a specified file mask, from a specified folder.
Warning If you create a Folder Capture input task that takes any file it finds in the root folder of one of your hard disks, then PlanetPress Workflow will try to remove all the files located in that folder, including all the system and hidden files. So when using a Folder Capture, be aware of where you are capturing. General Tab l Folder list: Enter the full path of the folder from which the input files are to be taken. l Masks: Enter a single or multiple file names or use file name masks. See Masks.
l l l l Capture files in subfolders: Select to capture files from child folders of the source folder as well. Sort directories first: If you selected a sorting method in the Sort files by box, and if you want the folders present in the source folder to be sorted first, select this option. When this option is selected, the chosen Sort order is applied to each separate folder, not across folders. The subfolders themselves are always processed in alphabetical order, regardless of the sort order.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
test1.pdf C:\Samples\ 20197 C:\Samples\manuals\ usermanual.pdf C:\Samples\manuals\ 644037 Note The
"Other" Tab l Job Information group l l l l l Information elements: indicates what job infos 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 Suite Workflow Tools working folders under the "Backup" folder.
Input FTP Input connects to the specified FTP server and path, and retrieves all files corresponding to the specified mask. These files may be of any format, even formats that are not readable by PlanetPress Workflow. 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.
l Passive: Select to prompt the ftp client to use the passive mode when retrieving files from the FTP server. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos 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.
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. 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 infos 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 Suite Workflow Tools working folders under the "Backup" folder.
server supports both HTTP and HTTPS. For HTTPS Support information, see HTTP Server Input User Options. Note While you can insert the HTTP Server Input task anywhere in your process as a secondary input task, in reality the HTTP Server Input task will only function when used as the initial input, as it is triggered when PlanetPress Workflow HTTP Server receives a request and passes it on to the correct task.
Note By default, the request XML also contains a CDATA section which contains the raw input data, effectively doubling the size of the incoming file. Due to technical restrictions, the incoming XML file cannot be more than 400MB, which because of CDATA is reduced to around 200MB. To help in this situation, you may elect to omit CDATA from the attachment, which can be changed in HTTP Server Input User Options.
HTTP Server input task properties are as follows: l l l HTTP action: Enter the name of the action requested of PlanetPress Workflow by the client. This name corresponds to the URL that the client will be accessing. For example, if you enter "MakePDF" here, you could trigger the process by accessing http://127.0.0.1:8080/MakePDF . This is also what your HTML Form's action should be. MIME Type: Select the MIME type of the file that will be returned by the plugin.
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 Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Input Error Bin The Input Error Bin Task is used specifically and only to create error management processes. These processes do not run on their own but are rather triggered by the On Error tab of tasks in other processes, when that task fails. Input This task receives a data file from a task that generated an error.
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 56. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task.
Input SOAP The Input SOAP task is used to answer calls from a remote SOAP client and to return a response to that request. It is similar in functionality to the "HTTP Server Input" on page 226 task. 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.
requests however this means that all process sharing the same SOAP action must be identical because there is no way to decide the execution order of all the process. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos 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.
LPD Input LPD (Line Printer Daemon) input tasks retrieve data in the form of print files sent from remote computers using the LPD/LPR protocol. The PlanetPress Workflow LPD server starts automatically when a configuration that includes at least one active LPD Input task is started. 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.
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 Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory.
Note This feature is part of the PDF Tools, which is only available in PlanetPress Workflow. Input This task captures all of the PDF files present in a specific folder, in one operation. The Merge PDF Files input task performs just like any other input: once the process has completed, control is transferred back to the input one last time to check if new files meeting the mask have come in.
l l l l l l 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. Use archive attribute: Select to turn on the archive attribute of the data files found in the source folder and to leave them in their original location (i.e. to take copies of the source files). Note that PlanetPress Workflow never takes source files that have their archive attribute turned on (so the source files will not be taken again and again).
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 Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
Input This task does not poll an input, it sits there and waits for a job file to be sent through the Serial connection. Processing When the job is received through the Serial connection, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. General Tab l Since Serial Input tasks have no specific task configurable properties, this section contains no property information.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Properties General tab l Server Settings group l FTP Server: Enter the IP address or host name of the FTP server to poll. l User name: Enter the name of a user account on the FTP server. l l l Protocol group l SFTP: Select if the FTP server uses SFTP (SSH). l FTPS: Select if the FTP server uses FTPS (SSL/TSL) Port Number Group l l l Password: If account named in the User name box is password protected, enter the password here.
l l l Delete remote file: Check this option to delete the file after it has been retrieved by Workflow. Connection mode group: This group is only relevant to the FTPS protocol and appears when it is selected. SFTP uses a single connection to download all files. l l l Masks: Enter a single file name mask. Multiple entries are not allowed in this box. Active: Select to prompt the ftp client to use the active mode when retrieving files from the FTP server.
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 Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory.
another SMTP server. In order for this task to receive files, the SMTP Server (also called "Outgoing Email Server") in the email client must point to PlanetPress Workflow server's IP or hostname. 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 458 task. Input The SMTP Input task does not, by itself, capture any files.
Tip Suppose we have two files named in the XML file under /ppemail[1]/@rawemail and /ppemail[1]/body[1]/@html respectively. With %t%O\xmlget('/ppemail[1]/body[1]/@html',Value,KeepCase,NoTrim) and %t%O\xmlget('/ppemail[1]/@rawemail',Value,KeepCase,NoTrim) We get both the body and the whole raw email. l Attachments: The input task loops through each attachment and sends them down through the process.
"Other" Tab l Job Information group l l l l l Information elements: indicates what job infos 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 Suite Workflow Tools working folders under the "Backup" folder.
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. Example In this example, the SMTP Input plugin is used to capture incoming emails data that must meet certain conditions as the subject that contains "Work to do" and the sender that contains "client@company.com ". The process then redirects the content of those emails to an extraction and finally to a PDF printing.
Telnet Input The Telnet Input Task (also known as the Raw Socket Printing Input) receives files sent to a specific port.
use multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see "Telnet Input plugin preferences" on page 636). Input This task does not poll an input, it sits there and waits for a job file to be sent through the Telnet port. Processing When the job is received through Telnet, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification.
l l Backup filename: Enter the filename 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 57. Comments Tab The Comments tab is common to all tasks.
Input The WinQueue input regularly polls the selected printer queue for new jobs. When a new job is available, it is captured automatically by this task. Processing The print job, by default, is in EMF format. If this option is selected, no action is taken on the data file. However, if the RAW format is selected, the job is converted to RAW. Furthermore, if the Create PDF option is selected, the file is converted to a PDF, including metadata.
l Include empty files: Check to process empty incoming jobs. The output will be empty, the job is deleted from the print queue, and the job information is available in the process (sending computer and user name, etc). "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos 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.
the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Action Tasks Use action tasks in PlanetPress Workflow to perform a wide variety of operations. PlanetPress Workflow includes more action tasks then input and output tasks combined. Action tasks can even be used to input data and to output data.
l "Rename" on page 303 l "Run Script" on page 351 l "Search and Replace" on page 307 l "Send Images to Printer" on page 309 l "Send to Folder" on page 311 l "Set Job Infos and Variables" on page 312 l "SOAP Client plugin" on page 500 l "Standard Filter" on page 316 l "Translator" on page 318 l "Windows Print Converter" on page 319 Add Document The Add Document action task prepares a printer-centric PostScript job by adding a PostScript version of a selected PlanetPress Connect document a
Properties General tab l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be merged with that document. Add job information to the document: Select to prompt your PlanetPress Workflow to add the available job information elements in the header of the generated file. Note that this option is only enabled if a document was selected. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57.
Processing The selected operation (adding or removing lines, text or pages) is made on the data file. Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task Properties General tab l l 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.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Task Properties General tab l Search mode group: Select your chosen search mode within this group. l l l l l Search whole file: Select if you want the entire data stream to be searched as if it were a single string of text. When this option is selected, PlanetPress Workflow loads the entire file in memory. It offers more flexibility, since search expressions may span across multiple lines and may result in more successful hits. Note that since this option uses more memory, it may affect performance.
l l l l l 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. At column: Select to indicate that the search string must be in a specific column. Specify the column number (the value must be greater then 0) in the Column value box below. Between specific words: Select to indicate that the search string must be between specific words.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
that if you are intending to define separate documents, you should use the Metadata Level Creation task after the Barcode Scan. Output This task outputs the original data file but with modified (or created) metadata. The format should be the same as the input. Supported Barcode Types The following types of barcodes are supported: Barcode types Description EAN13 EAN13 symbology. Used with consumer products internationally, 13 characters. EAN8 EAN8 symbology. Short version of EAN-13, 8 characters.
Barcode types Description magazines and newspaper issue numbers. Add5 5 additional digits code for UPC-based symbologies. Used to mark suggested retail price of books. PDF417 Portable Data File is a 2-dimensional barcode (also known as matrix code) used in a variety of applications, including Transport, Identification cards, and Inventory management. It is best suited for cases where information needs to move with an item or document.
Note The fewer orientations are selected, the faster the task performs. Settings l l Force checksum validation: Select to define whether the checksum validation is required for symbologies in which a checksum character is optional. The goal of checksum is to detect accidental modification such as corruption to stored data or errors in a barcode values. By default it is set to false.
example, a value of 1 means that every image line will be scanned. By default, the Scan Interval is set to 1. l Threshold level [0..255]: Set to represent the color threshold level in order to distinguish foreground pixels from background pixels in color or gray scale images. Value can be between 0 and 255, corresponding to the pixel intensity value, from 0 (black) to 255 (white).
Metadata Fields The barcode values are stored at the datapage level of the metadata. In the following defintions, the first 2 metadata fields are for standard use, while the next 8 fields contain '_1_' in their name. This number represents the barcode index on the page. If there is more than one barcode on the same page, these metadata fields will be defined as many times as there are barcodes on the page, except that the middle number (..._X_...) will increment according to the barcode index (e.g.
watch.expandstring("GetMeta(BarcodeValue[0],0,Job.Group[0].Document[0].Datapage[0])") Another method is to use a Set Job Infos and Variables task to copy a metadata field into a Workflow variable. Limitations l l Some barcodes created with PlanetPress 5 could not be read by the Barcode Scan task, so please use PlanetPress version 6 or 7 to create barcoded documents.
Properties l The options of this task are basically the same as the Data Selector in PlanetPress Design; see PlanetPress Design User Guide. General Tab Add/remove characters: Enter the number of characters to add to, or remove from, the head of the data stream, or use the spin buttons to increment or decrement the value. Positive values add characters; negative values remove characters. This is useful when one or more characters of input data precede the start of the first data page.
Cut on FF character: Select to have the document start a new data page when it encounters a form feed character in the data stream. If you select Cut on FF character, you have 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 box. View Selector: Click to go to the Data Selector to set the properties of this task. Emulation. The available emulations are: l Line printer. (Nothing to configure.) l ASCII.
want to use a backslash character (\) as a delimiter, you must precede it with another backslash character (thus you would enter \\). You can also specify an ASCII character using its octal value preceded by a backslash (for example, \041 is the exclamation mark character [!]). l l Set tab as field delimiter: Select to define a tab as the character that separates the fields of each record in the input data. Clear to use the Delimiter box to define that character. Channel skip.
l l Char, Skip to line: Use these boxes to enter any channel skip codes in your data that tell the document to skip to a specific line. Enter the code in the Char box; enter the line number in the Skip to line box or use the spin buttons to adjust its value. If you want to use a backslash character (\) as a code, you must precede it with another backslash character (thus you would enter \\). You can also specify an ASCII character as a code using its octal value preceded by a backslash (for example, \041
Create PDF The Create PDF action task allows users running PlanetPress Workflow to create native PDF outputs without an active PlanetPress Image license. It is very similar to the Digital Action task (see "Digital Action" on page 283) but is more limited. It does not contain the advanced PDF options that are offered by the PlanetPress Image solution, but is useful for creating simple PDF files using the default quality.
without using a PlanetPress Design document, in a Metadata-based workflow. l Run mode group l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to the PDF RIP. Note that some features, such as the Time and Date require that this option be selected. Options group l l l l Printer centric: Select to send the document along with the trigger and data to the PDF RIP.
l l Font group l l l Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128). It gives the task the ability to take an existing PDF in input and apply the selected password to the PDF without any change to the quality level of the original PDF. Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Other Notes Here's a list of the hard-coded PDF values for files generated with this new plugin.
l l l l Pixels per inch: 150 Security : l Allow printing l Allow changing the document l Allow content copying l Allow form filling Font : l Embed all fonts l Subset embedded fonts Open options : l Zoom factor: Fit in window l Default view: Page only Database Query 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.
l l You can use static properties (properties that will remain the same regardless of the data processed at run-time). This option lets you use an Open DataBase Connectivity (ODCB) compliant data source. You can also edit the SQL statement that assembles the database table. Note that you can import a database connection configuration that you previously exported from PlanetPress Design (when you created a document) or from PlanetPress Workflow (when you set up a sample data file for a process).
l l Range group l l l Table/Query: Select the table or query containing the information you need as your input data. All: Select this option use all the records included in the database. Records: Select this option use only some of the records in the database. Indicate the range by entering the number of the first record followed by a dash and the number of the last record. To use records 50 to 75, for example, enter 50-75.
l l Text delimiter: Select the text delimiter to be used in the generated file. l Field separator: Select the field separator to be used in the generated file. l l Add a header record with field names: Select this option if you want the generated file to have a header record (a record that includes the field names only).
or edit the configuration. You may choose any encoding listed in the dropdown list or enter your own. l l l l l l Maximum records per page: Select this option if you want to limit the number of records per page. This option is only available if you indicated that you wanted each data page to contain several records in the Create data pages as follows box.
Dynamic SQL tab l Use dynamic values at run-time: Select to use a dynamic database connection string and / or SQL statement at run-time. Check this box to enable the options included in this group (this disables the corresponding options in the General tab). l l l l Parse normally: Select to interpret any backslashes included in the database connection string as backslashes. If this option is not selected, any backslash that is not doubled will be disregarded.
Decompress File(s) Decompress file action tasks decompress zipped job files (files compressed as zip files). Input This task only accepts ZIP Files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself. Processing Every file in the ZIP is extracted to the specified location. If a folder structure exists in the ZIP, it is respected in the output folder. Output This task outputs the data file it received with no modification.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Task Properties General tab l 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. Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections.
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 640), 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.
l l The executable file must accept so-called "command-line options" and be able to run without any sort of user interaction. Only certain programs are able to do this and may refer to it as "command-line" or "automation" features. The process will always wait for the executable file to finish before it continues to the next task, and does not have any timeout setting. This mean that if your program fails to exit for any reason, your process will hang. Input Any active data file, in any format.
l l l Run minimized: Select to prevent a window (a DOS box, for instance) from being displayed on the desktop. When selected, the program runs in a background window. Program output capture group 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.
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. Load External File Load External File action tasks are used to replace the current job file by the designated text file. Loading an external file does not delete the original file or modify it in any way. Input The current data file in the process will be discarded.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Processing The task executes the mathematical operation and stores the result in the selected job info or variable. Output The input data file is returned with no modifications. Metadata is not modified. A single job info or variable is modified by this task. Properties General Tab l l l Mathematical Expression: Variable data field containing the expression to be evaluated. This expression may combine any combination of standard PlanetPress Workflow variables and VBScript mathematical expressions.
XSLT (or XSL Transformation) is a style sheet that describes how an XML document is to be transformed into another XML document. The reason to transform an XML document into another XML document is simply to rearrange the information it contains in order to make the data structure more convenient for your needs. Input A valid XML file. Processing The XSLT is applied to the XML data file. Output The modified XML data file is output. Metadata and jobinfos are not modified.
l l l XSLT Version l XSLT 1.0: Select if you will be entering or pasting XSLT version 1.0 code. l XSLT 2.0: Select if you will be entering or pasting XSLT version 2.0 code. Tools l l Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Editor Options...: Opens the "Editor Options" on page 646.
Output The unmodified input file. This task does not change the data file in any way. The only modification is a single variable or job info, if the "Store Result" option is selected. Properties The Push to Repository task options are as follows: 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 Key: Displays the key name in the group.
l Store the result ID in variable: Select a variable or Job Info in which an array of inserted or updated IDs will be placed. The array of IDs in the form of [1, 2, 3, 4, 2443, 532, 5457, ...] On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
Properties General tab l New file name: Enter the job file’s new name. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
Processing The script is executed. The script can modify anything such as the data file, job infos, metadata, or even other files on the operating system. Output Whatever file the Run Script action generates, metadata it modifies or creates, etc. Technical Note about conditions: 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 121 variable in your script.
l Search 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 l l Language l VBScript: Select if your script is written in VBScript. l JavaScript: Select if your script is written in JavaScript. l Perl: Select if your script is written in Perl. l Python: Select if your script is written in Pyton.
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 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Properties General Tab l l l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send Images to Printer The Send Images to Printer Action task is used to send images to a printer so they can be used as resources by PlanetPress Suite (Design) documents run on the printer. It is comparable to the Download to Printer Action task (see "Download to Printer" on page 293), but includes image specific options.
Properties General tab l l l l l l l l Scan orientation: Select Side to side for images that will be printed in their original orientation on a portrait oriented page, or in a rotated orientation on a landscape page. Select Top to bottom for images that will be printed in a rotated orientation on a portrait oriented page, or in a rotated orientation on a portrait oriented page.
l Print confirmation page: Select to print a confirmation page on each one of the selected printers after an image has been successfully received. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
Output The original data file, metadata and job infos are not modified, they are passed on to the next 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. As with any variable property box, you can use any combination of text, variables and data selections.
Input Any data file in any format. Processing This task assigns the defined values to each local or global variables or job information. It does not modify the data file nor the metadata. Output The original data file, metadata and job infos are not modified, they are passed on to the next task. Set Job Infos and Variables action task properties are as follows: General tab l l Var/Info#: Lists all job infos, local variables in the current process and global variables in the configuration.
SOAP Client plugin SOAP Client plugin tasks can be used as input, output and action tasks, although their basic function is to generate output. SOAP (Simple Object Access Protocol) is a light protocol that defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems. A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol.
Note The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l l l l l l l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below. Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found.
Advanced tab l Domain: Enter the domain for the authentication on the SOAP server. The Domain is optional even when authentication is used. l user name: Enter the user name for the authentication, if required. l Password: Enter the password for the above user name. l Allow invalid security certificate: Check to ignore SSL certificates that are invalid. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57.
Input Text-based data files such as Line Printer Emulation and ASCII Emulation data files, which contain HP PCL control characters. Processing All HP PCL characters are removed from the data file. Note that these characters are not interpreted, only stripped out. Output The modified data file, with stripped characters, is output from this task. Metadata, job infos and variables are not modified.
Translator PlanetPress Workflow Translator action tasks can convert your data from its current encoding to a number of different encoding. The same data may be converted back and forth as required. The Translator Action Task is useful for data file using foreign languages, as well as to convert Unicode data file (which are not supported by PlanetPress Workflow).
l l l Target encoding: Select the encoding to which you want the data to be converted. Include target encoding signature: This option is only available when converting to UTF-8 (Windows code page 65001) or UCS-4 (code page 12000 or 12001). Select to include the character encoding signature—also known as the byte order mark—at the beginning of the target string.
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. Processing The EMF job is converted into a text-only, Line Printer Emulation data file. Output A Line Printer file. Metadata, job infos and variables are not changed. Properties General tab l EMF to XY group: Select this option if the file received by this task is a Windows print file.
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. Passage 1 with 10, passage 2 with 18 point. The ratio 0.56 is smaller than the adjusted value 0.60. Therefore those two text passages are recognized as not belonging together.
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.50 - the previous text passage. So the two passages are not recognized as belonging together. l Windows Print Converter: Select this option if the task is to generate a Line Printer file.
If the current job file isn't JSON or XML (depending on the type of conversion requested), or if the conversion fails for any reason, the task raises an error and the current job file and metadata remain unchanged. JSON to XML conversion When a JSON source file contains a single JSON object, that object's key will be used as the root node name in the resulting XML file, and the root node will be populated with the data inside of the JSON object.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Data Splitters Splitter action tasks are used to single data files into multiple data files.
However, in some cases, there may be minute differences. When using the ASCII or Channel Skip emulation, if there are missing line feed characters (when lines end with a single carriage return in ASCII, or when lines start with a No line feed channel in Channel Skip), the output data will be different from the input data, but the change will not be significant.
Database Splitter Database Splitter is used to split database files into multiple data files that are passed to subsequent tasks in the process. Input A Database Emulation data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task.
l l l l l l l l l l Operator: Select the condition to fulfill for the condition to be true and thus for the splitting process to take place. Value: Enter the condition value. Note that you can use the popup menu's Get Data command to select the value and populate this box automatically Match case: Select to force the splitter to match the character casing when resolving the Field value change or Field value condition.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
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 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 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 Word 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).
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. Generic Splitter The Generic Splitter is a legacy task which is kept for backwards compatibility purpose. In previous versions of PlanetPress Workflow, it was the only splitter available. While this splitter seems to have more options than the other ones, this is only because it contains combined features from these other splitters.
l l l l l Use emulation: Check to emulate the data before splitting the file. This lets you split the file on a word, a word change, a page number, a database field value or a database field change. When this option is not checked, you can only split the file on a form feed, a specific number of lines, or a chain of characters. See below for detailed information on any of these splitting methods.
l l l 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. Split when word found: You may not want to split the file every time the string of characters entered above is found, but only every other time, or every third time. If so, enter the number of times in this box.
l l A Page Number: If you choose A page number in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l l Split when word changed: You may not want to split the file every time the string of characters entered above changes, but only every other time, or every third time. If so, enter the number of times in this box. Pages per output file: Enter a number of pages after which to split the file.
l l l Before or after: In the previous box, you entered where you wanted to split the file. Here is where you specify whether you want the Generic Splitter to split the file X number of pages or records before or after the string. Choose 5 in the Pages or records box and “Records after” in this box, for example, to split the file 5 records after the record that matches the condition.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l l l l l l l l Word: Enter the word to use as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. You may also use the Get Data button to get a static string of characters from the sample data file. If you use this option, the coordinates of the data you will select will be added to the From column and To column boxes below.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. 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. Note This feature is part of the PDF Tools, which is only available in PlanetPress Workflow. Input A PDF Emulation data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties.
l l l l l l l l l l l On region content change: Select if you want the data file to be split when the word found at a given location changes. Get button: Click to go to the Data Selector and select the location associated with the On region change option. Specific word: Enter the word to use as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these.
l l l After: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines after the line on which the condition is met. When condition is found: By default, the task splits the file every time the condition is met (the default value is 1). If you want the task to split the file only when the condition has been met twice, for example, enter the number 2 in this box.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l Split method: Use this box only if you want to edit the standard XSLT script that will be used to split the XML file. First use the Standard XML splitter option to define the standard settings. Then, to change the standard XSLT script, select Advanced XML splitter and edit the script as required. l Standard XML splitter The following options are only displayed when the Standard XML splitter option is selected in the Split method box.
l l l l l Use UTF8 encoding: Select if you want to use the UTF8 encoding to process the file. Use file’s encoding: Select if you want to use the XML file’s own encoding to process the file. Advanced XML splitter: The following options and buttons are only displayed when the Advanced XML splitter option is selected in the Split method box. Note that you should not use this option before you have completed all the required settings using the Standard XML splitter option.
l Browse button: Click this button and browse to select the XSLT engine you want the XML splitter to use. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
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 "Data file and job file" on page 24). 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.
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. Any modification performed on the secondary branch thus has an impact on the main branch.
Comments do not open, modify or otherwise process the job file in any way, and are simply ignored at run-time. They do not have an On Error tab because of this, since they cannot generate an error in any situation. Comments have a single property in the General tab, which is the box where you enter the comment itself. This box does not process variables (it is not a "variable property"), since that would be of no use at run-time.
File Size Condition File Size conditions test the size of the job file they receive. Note that the job file may include data selections, attachments and documents that were added by other tasks. If a file does not exist, it's file size will be 0kb. Properties General tab l l l File size is: Select whether the condition is to check if the job file is smaller (less than) or larger (more than) then the specified value. Kbytes: Enter the minimum (more than) or maximum (less than) size setting in kilobytes.
Every subprocess starts with a BeginSub input task and ends with a EndSub output task, both of which have nothing to configure and cannot be replaced or deleted. The simply represents entry and exit points for the subprocess. Note While it is possible to place a GoSub action within a subprocess, doing so will hide the subprocess from any GoSub action, in order to avoid circular referencing (aka an infinite loop).
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Loop Loop action tasks are used to repeat those tasks that are located after it on a given process branch. The number of repeats can be fixed or variable, as required. Properties General tab l l l l Number of iterations: The number of times the loop should be repeated. Every task after the Loop action task will be repeated this number of times.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" on page 294). However, they can be slower to execute. The Run Script action task can be used either as an action or a condition.
l File l l l Export: Lets you save the current script as a file. l Print: Prints the current script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l l Paste: Paste the last selection that was cut or copied in the location of the cursor in the text editor. Delete: Delete the current selection (only available if there is selected text in the editor). Select All: Select all of the contents of the editor.
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.
This task is dual-purpose: It can be used either as an Action task, or as an Output task. In either case, it does not directly produce an output, though the process it calls may produce one or more outputs. In either case, the called process will ignore the input task along with its job infos and schedule, and use the job file, job infos, metadata and variables from the current process. General tab l Process: The name of the target process to send current job to.
l To check different values of printers or other SNMP compatible devices against conditions you set, to return a true or false value. This is called setting a User defined condition in the SNMP condition's Properties dialog box. You indicate what is called management information bases (MIB) and object identifiers (OID) that are extensible and can be vendor specific.
l Printer Queue group (displayed when Printer Queue is selected in the Condition Type box) l l l l Printer status: Select Idle or Printing to test whether the printer is currently idle or printing. Select Do not test if you only want to test the printer’s alert status (below). Alert status: Select No alert to make the condition False whenever an alert situation is detected, regardless of its type or severity.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Text Condition Text conditions can be used to perform two different types of tests: l l To test the presence of a string within the job file.
l l l l l l l l l Operator: Select the desired operator. Note that neither the “Is found” nor the “Is not found” operator can be used to test XML data. Convert data to uppercase before comparison: This option is only displayed when either “Is found” or “Is not found” is selected in the Operator box. Select to prompt PlanetPress Workflow to convert the string to uppercase before performing the comparison.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l l l Time division: Select the desired time interval. Each block in the grid corresponds to the selected time interval. Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). Grid: Select separate or contiguous time blocks. Click a block to toggle it on or off. Click and drag to toggle multiple blocks on or off. Click date or day at the top of the grid to toggle the whole date or day on or off.
l "Output to Capture OnTheGo" on page 375 l "Output to SharePoint" on page 379 l "PlanetPress Fax" on page 382 l "PlanetPress Image" on page 383 l "PReS Print Controls" on page 392 l "PrintShop Mail" on page 396 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 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Properties General Tab The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document. l Repository ID: Enter a valid Capture OnTheGo Repository ID. l Password: Enter the password that corresponds to the Repository ID entered above. l Document ID: Enter the ID of the document to delete from the Repository.
This task can work with many of the available SharePoint servers: l Microsoft SharePoint 2007 l Microsoft SharePoint 2010 l Windows SharePoint Services 3.0 SP2 l SharePoint Foundation 2010 Technical Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PlanetPress 7.5 and higher only.
l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously. Folder: The folder in the document library where your files are located.
"Other" Tab l Job Information group l l l l l Information elements: indicates what job infos 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 Suite Workflow Tools working folders under the "Backup" folder.
Laserfiche is a provider of digital document and records management systems. Laserfiche has two components: the Laserfiche server, which hosts the repository, and the Laserfiche client, which serves as the user’s interface with the repository.
l l l l Volume: A list allowing to choose among available Laserfiche volumes. Configure Tags: Click to open the Configure Tags dialog. See LaserFiche Repository Output - Configure Tags. Configure Templates: Click to open the Configure Templates dialog. See LaserFiche Repository Output - Configure Templates. PlanetPress archive folder: Folder path of the folder capture of the current process. This field is optional and should only be set when publishing PlanetPress Workflow archives that have PDI files.
l To use the “Use PlanetPress PDF/A archives” option, make sure to: l l l l l l l Check the field as Multiple, select CHAR type and enter the width fields in Laserfiche administration console as long as your PlanetPress fields. Insert a folder path to your PDI source files in the PlanetPress Image archive folder. If a field is checked as Required in Laserfiche administration console, fill the field value.
Processing The task parses each level of the metadata and, for each field of the specified name it finds, a lookup is made. If a field of the same name appears on multiple levels, the lookup will happen for all fields, on all levels, individually. Output The original data file is unchanged. Metadata is updated according to the specified criteria. Properties General Tab l Excel group l l l l Excel workbook: The full path and file name of a Microsoft® Excel® workbook (.xls or .xslx file).
l l l l Result Field: The metadata field name in which the result should be stored. This field will appear in the same metadata level as the Lookup Field. Result Column: The name of the column where the information you want to retrieve is located. For example, this could be a client email or full name. button: Ads a new lookup line. You can have as many lines as you want. The lines will be executed in order from top to bottom, so you can rely on a previous line to bring additional information.
Documents action task will replace the value of this metadata field with the corresponding customer email. Use Case 2: Translate a list of line items descriptions into a given language A PlanetPress Design document takes as input a transactional PDF file, and reproduces it exactly as it enters. Metadata fields called ItemDesc are created, one for each line item description, at the datapage level.
Output One of: l By default, a PDF file accompanied with basic PDF metadata. The Metadata contains one "Document" level, and one data page (and page) level for each PDF page generated by the document. When Mail Merge is not selected, this is the only available choice. Technical In current versions, the Objectif Lune Printer Driver will naturally add a margin to the PDF generated by this task.
l l l SQL Statement: An SQL statement that is understood by the database you are using and that will return a series of records that the Microsoft® Word® template is expecting. Note that no validation is made on SQL statements except if they are for Microsoft Access and Excel data files. You can use the Test Connection button to test the SQL and connection string.
Document to PDF action task is run. This printer cannot be shared on the network in order to avoid confusion from network users, however it is shared between all Microsoft® Word® Document to PDF action tasks on the same system. l l l l While debugging this task, the printer shows the message that the document can not be printed. This message is normal and will not appear when running a live configuration.
Output The output that this task produces is the information sent to the Capture OnTheGo online repository (the document ID). 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. l l l Repository ID: Enter a valid Capture OnTheGo Server user name (mandatory). Password: Enter the password (mandatory) that corresponds to the Repository ID entered above.
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. l Author(s): Enter a name identifying the document’s creator(s). l Description: Enter a description helping users identify the document. Metadata group: This group lets you determine which Capture OnTheGo users can see the document and where they will see it.
are faded. l l l Auto-Download: This option determines whether the document is to be automatically downloaded to the users’ devices (documents that are not automatically downloaded are first listed on users’ devices – users must then tap the Download button, if they want to have the document on their device). You may enter ‘Yes’, ‘No’, or a variable.
server. l l Store the result ID in variable: Use the drop-down to select the variable in which you want the document ID to be stored, so that it can be used in one of the following tasks (if the Output to Capture OnTheGo task has been added as an Action). Blank Forms group: Check the This is a blank form option to make the form reusable. The Form will not be deleted from the app's form library when it is submitted, so it can be used over and over again.
l Folder: The folder location in the document library where your files will be sent. You can click the Browse button to display your folder structure. In the Browse Folders dialog, click on the folder you want to use and click OK. l Force folder creation: If the folder does not exist, it will be created. l Error if the file name exists: Task will generate an error if the file name is already there.
Technical Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PlanetPress Workflow 7.4 and higher only. Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted.
PlanetPress Fax PlanetPress Fax output tasks are used to make request to PlanetPress Fax, which creates faxes and sends them to a faxing program. In addition to the job-specific PlanetPress Fax properties you configure in the task’s Properties dialog box, there are configurable options common to all PlanetPress Fax outputs processed by a given computer (See "PlanetPress Fax plugin preferences" on page 636).
l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Run mode group l l Printer centric: Select to send the document along with the trigger and data to the component that generates fax documents. Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to the component that generates fax documents.
Input Any data file with a valid Emulation, or an Optimized PostScript Stream file (.ps) generated by PlanetPress Workflow itself. The .ps file must be the result of the merge between a PlanetPress Design document and a data file, and can be generated either with the use of "Add Document" on page 255, or a printer queue using a "Send to Folder Printer Queue" on page 74.
enable the dynamic document name box, click inside it. To disable it, press Enter. Note that in the later case, you must be certain that the documents that will be chosen at runtime will in fact be available locally or at the selected host. Note While the Do not use a document (passthrough) is visible in this list, it is not compatible with the PlanetPress Image output if the PostScript was not generated by merging a design document with data in PlanetPress Workflow.
produces the largest files with the highest quality. TIFF is a versatile and platformindependent format. It is used in many digitizing projects as the format of choice for the digital masters. The TIFF Group 3 and Group 4 formats are efficient for document storage. l l l l l l l l l The AutoStore, DocAccel and KYOcapture formats also generate TIFF files along with special XML that are meant for these specialized systems.
l l l Filename : 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. As with any variable property box, you can use any combination of text, variables and data selections. When multiple files are generated for a single job (such as for multiple TIFFs), each file name includes a sequence number, such as in Invoice0, Invoice1, Invoice2. If you use file name masks that include dots, such as Statement.%y.
l General group l l l l l l l l l ASCII format: Select to create the PDF file using ASCII characters (instead of the usual 8-bit binary format). This option produces a file suitable for transmission over a 7-bit ASCII link. This option is useful if the PDFs need to be opened in a text editor, sent across networks, or sent via email using a program that does not support binary files. This option also generates smaller files.
screen shots and simple images created with paint or drawing programs. CCITT typically yields the best compression of monochrome images. It is the compression method developed for fax transmissions. Note that configurations that were created with an earlier version of PlanetPress Workflow and that included tasks set not to use any compression will by default be set to use the Flate compression method. l l Grayscale images group l l l l Resolution: Select the resolution to use for monochrome images.
photographs containing more detail than can be reproduced onscreen or in print. Since JPEG eliminates data, it can achieve much smaller file sizes than Flate compression. Select Auto to let the application choose the best compression method automatically. Note that configurations that were created with an earlier version of PlanetPress Workflow and that included tasks set not to use any compression will by default be set to use the Flate compression method.
l Font group l l l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded. If a font is not embedded in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font.
l l l l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server). Connection time-out: Enter the time, in seconds, that the connection to the database is maintained while no action is taking place before the connection is severed. Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory.
Limitations In order for PReS Print Control tasks to be functional, some pre-requisites must first be met: l l PReS Classic 6.3.0 or higher must be installed on the same system. A valid PReS Classic license (either dongle or software based) must be available on the same system. Note All PReS Classic licenses are issued and controlled by the PReS License Server and not Connect. Thus a separate PReS Classic license is required. Input A PReS Classic job and the resources it needs.
Task Properties General tab l PDC File: Select either an un-compiled PReS Classic script file (PDS) which will need to be compiled on the fly, or a pre-compiled PReS Classic job file (PDC). The job needs to be specified exactly. If you want to compile the job at run time, then you must select a PDS file. If you wish to use a pre-compiled PReS Classic job, then select the PDC file, rather than the PDS.
contained in the PDC File entry. 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.
Selecting 1 would force Connect Workflow to use Print Control PRN1, whilst selecting 2 would launch PRN2, and so on. This is useful if you have a variety of Print Control license speeds, and each license is assigned to a different PRNx instance. This allows for manual load balancing, by selecting specific Print Control speeds for different jobs, based upon your own criteria. Such as the size or urgency of the job being processed.
Input A data file compatible with a PrintShop Mail Document. Metadata is ignored by this task. 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.
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.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Workflow.
Input A data file in PGC or PDF format that is accompanied by valid Metadata. This metadata must contain Capture information and is generally available after a "Capture Fields Processor" on page 407 or "Find Capture Documents" on page 414 task. However, it is also possible to directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and metadata are completely ignored by this task's condition rules, and the database information is used instead.
l l l l l Document is partial: Condition will be true if the document is still open but only part of the appropriate Capture Fields are filled. Document is empty: Condition will be true if the document is open but no Capture Field is filled. Document is on error: Condition will be true if a logical error was triggered while processing the PGC. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc.
l Condition: Defines what should trigger the condition: l Ink is Present: Triggered by the presence or absence of ink in the field. l l l l l l l l l l All: Ink should be present in all fields of this name in your document. Index: The specified index of the capture field of this name should contain ink. The Index property is generated when a Capture Field object is repeated or is part of a runpage. This index is 1-based.
l l l l Error: A logical error was detected in the field. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc. ICR Value: Triggered when the value given by the ICR engine compares with the specified value. Operators are available for the comparison (such as Equal, Not Equal, Lower or Higher Than, Contains and etc).
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
database. While it is not recommended to separate each document on its own as it removes all optimization and makes the database much larger, you may split into document batches such as 250, 1000 or 2500 documents. If using the Metadata Sequencer it is generally recommended to place the Sequencer and the Capture Fields Generator tasks within a branch and, within the Capture Field Generator's On Error properties tab, to set it to stop the branch if any errors occur.
l l Document Title: Enter a name for the document that will be saved inside the PlanetPress Capture Database. This name should be unique and recognizable and will be used later to retrieve the document form using the Get Capture Document action task. Document Title group: Determines a Title for the document. This title is accessible in the Capture Database and can be used to search for a document or retrieve a list of document using other tasks.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
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.
l Basic Functional Capture Workflow l Capture Web Manager Workflow On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
Processing The PGC file is split by document, if a document can be matched for each pattern ID found in the PGC. The match is made by comparing each Pattern ID with the information found in the Capture database. If more than one pattern is used in a document (pattern on multiple pages of the document), all of the information for this document (more than one Pattern ID) is sent down as a split. Patterns that do not match any document are sent individually, one Pattern ID per split.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011.
l Metadata Level: A drop-down list containing all of the levels of Metadata. Choose the one where the ICR data will be added. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
Processing This task connects to the Capture database and looks up all available documents that meet the criteria specified in the plugin. Then it does further processing to retrieve relevant information about each document and places the information in the data file it generates. Output The data file generated by this task is an XML structure containing the data about each document.
l l l l l l l Pen user (by description): The description of the pen, as entered in the "PlanetPress Capture Pen Management Tool" on page 621. Generally, this is the name of the owner of the pen. Pen user (by serial number): The serial number of the pen (aka Pen ID) Pattern Sequence: The Pattern Sequence in which a document is entered. Template name: The name of the PlanetPress Design document used to generate the Capture document. This is set in the document's properties, in PlanetPress Design.
l l l l l l l l l Before: Date comparison, documents of which the date is previous to the specified value are included (Date Generated and Date Closed filters only). After: Date comparison, documents of which the date is closer than the specified value are included (Date Generated and Date Closed filters only). Last: Date comparison, documents of which the date is within the specified interval are included (Date Generated and Date Closed filters only).
l Capture Post Processing Workflow l Capture Web Manager Workflow On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
Technical 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 407 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.
Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False. Input A PGC file received from an Anoto digital pen. Processing The ink contained in the PGC file is converted into an EPS layer, which is then applied on an blank, empty PDF file of the size specified in the task's properties. If more than one Pattern ID is found in the PGC file, each separate Pattern ID will generate a new page on which its ink is applied.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Processing If a data file and document are selected, the metadata is generated by merging the data file and document and retrieving only the metadata generated by this merge. The Metadata levels will reflect those defined in the document, including separation for Group and Document, metadata fields, etc. 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.
l Basic Functional Capture Workflow l Capture Web Manager Workflow l Daily Sales Report from PDF Files On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Embed/Extract PlanetPress Workflow Metadata Embed the current PlanetPress Workflow metadata inside the current data file in a PDF emulation. It can also extract PlanetPress Workflow metadata from the current data file and make the extracted file the new current metadata file.
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 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
Updating all nodes For a given Metadata Field Management action, all nodes of a given level might be updated with a New Field value. To accommodate this, all metadata/data selection functions accept a wildcard parameter "?", indicating the function operates on all nodes (not just one) of a given level. See: "Data selections" on page 26.
l l Delete: Delete the metadata field if it exists and disable the Field information column's Field value option. Field Information: Specify the metadata node level, field name and field value of the specified action. l l l l Level: Choose between Job, Group, Document, Datapage. The task will loop through each selected node of the chosen metadata level. l Job: Apply the action on the specified field at the Job level. l Group: Apply the action on the specified field at the Group level.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata File Management The Metadata File Management action task is used to execute actions on Metadata files.
l l Metadata Folder: Use Browse to find the location of the folder where to save the files or enter a path using variables. Not active when the delete action is chosen. Metadata Filename: Enter a static or variable name for the metadata file to load. Not active when the delete action is chosen. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks.
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). Datapage: Select the metadata Datapage nodes (the nodes only) based on the specified rule(s).
Special Considerations l l The task CANNOT re-select unselected nodes if the condition is false for those nodes. Filter rules cannot be based on the following metadata attributes: SelectedIndexInJob, SelectedIndexInGroup, SelectedIndexInDocument and SelectedIndex. Metadata Level Creation Conditionally creates new metadata groups or documents. This task is only functional if metadata already exists for the current job.
l Action: Document l Delimiter: Begins when l Rule: (@(?,1,1,1,9,KeepCase,NoTrim) IS EQUAL TO Page 1 of) 3. Metadata Sequencer: Splits the data file on each metadata document node level. With this example, before the Metadata Level Creation task, the metadata structure contains one group containing one document (containing multiple data pages). After the Metadata Level Creation task, the metadata structure contains one group containing multiple documents.
rule is not applied. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action. See the Rule Interface page for more details. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
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. Metadata records are simply selected / deselected, which has the same effect. Input Any data file with accompanying metadata.
l The following rule: Determine if a new sequence starts or if the current one ends. For each metadata level, the current value of the specified metadata attribute / field is compared with the one in memory. If they are different, either a new sequence starts or the current sequence is ended. The next sequence starts with the next metadata level being processed. For details see the Rule Interface.
l l Order: Choose Ascending (orders like a,b,c, or 1,2,3) or Descending (orders like 3,2,1 or c,b,a) order. If the Numeric sorting option is not checked, numbers are sorted like this: "1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9". Numeric Sorting: Check to sort numerically instead of alphabetically (only supports whole numbers. Currency with thousands separator and decimal points will not work). If any non-numeric value is found in the field or attribute, in any instance of the level, the task raises an error.
Output The output is the same as the input, no modification is done to either the data file or the metadata. However, a PDI file is generated and saved in the location specified in the task. Metadata to PDI Task Properties are as such: 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.
The PlanetPress Design document needs to be properly set up with the N-Up object and proper virtual pages in order to correctly use this task: l l l l All PlanetPress Design document templates must use the n-up object on both the front and the back pages of the duplex document. Each instance of the n-up object must have the “change data page with each repeat” option checked.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. OL Connect Send Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application.
Note The Get Data plugin gets data from the OL Connect Send database which means it only works when Connect is in LICENSED mode. Properties General Tab Filter options Filters are required for: l Start and end date (down to minutes) l Domain(s) l User(s) l Machine name(s) Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: l Workflow variables l Job variables l Names.
Example 1 A valid user name search string, entered in the Filter Users field, would be: %\{global.User};helen;%1;george napier This would look for all entries, where the user name is either: l as currently stored in the global Workflow variable User l "helen" l as stored in the job variable number 1 l equals "george napier" (case insensitive). These search criteria are combined with OR. Example 2 The domain name entered in the Filter Domains field is objmtl.objectiflune.
and minute is a colon) It is possible to define the same date for From Date/Time as for To Date/Time. However, entering the same info (without time information) would lead to getting no entries.
Returned information For each job received by the OL Connect Send Job Processor plugin the following values will be available. l l 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.
l l l l l Original file size: The size of the print job - NOT the size of the document file. Domain (workgroup) name: The name of the domain or workgroup the printing user belongs to. This is not necessarily the name of the domain the machine itself belongs to. 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.
upper- and lowercase letters and digits e.g. “ri0zZdluLp”. This Unique Job ID is used in any communication between the Printer Driver and the plugin and is the leading identification element for this particular job. All job related information is stored in the underlying database and linked together by this Unique Job ID. Note The Get Job Data plugin gets data from the OL Connect Send database which means it only works when Connect is in LICENSED mode.
Select Returning Type Depending on this setting the plugin gets status information about the job before it has arrived or it gets information after the job has been completely received. l l Immediately: By choosing this option, the Get Job Data plugin will return as quickly as it can, providing it can find a matching Job ID in the database. It is important to know that it will wait until any information about the job is available.
Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value. l l l l l l l Number of Copies: This is the value set by the OL Connect Send Printer Driver for the number of copies (intended number of copies required for the print job). Some applications do not use the general print job information to define the number of copies. In such (rare) cases, the Number of Copies sent in the job can differ from what the user entered in the print dialog.
l l Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API. Machine GUID: The unique machine ID of the machine on which the job was produced. It can be used as an additional identification mark to validate the origin of the job. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks.
Processing The Job Processor plugin receives a compressed PostScript file sent by the OL Connect Send Printer Driver and communicates with the Printer Driver to ensure that all data has been received correctly. If the Printer Driver has split the job into multiple chunks, the plugin combines the chunks into one PostScript file. License mode Each incoming print job is checked against the license to determine if it can be handled in licensed mode or in unlicensed mode.
HTTPS Communication The OL Connect Send Printer Driver can be set to use HTTPS for any job transfer. To do this, Workflow must also be set to use HTTPS. Job Origin Each print job will include unique information about the machine it has been sent from. This unique machine ID is calculated with a proven method and will be transferred, encrypted and enhanced. The enhancement will result in a different encrypted machine ID per print job, so that spoofing can be detected.
Metadata In addition to the print job, the plugin creates a metadata file with basic information. The values originate from the client machine. In unlicensed mode, the user name, machine name and domain/workgroup name will not be available through the metadata. Properties General tab l Data Output l Output Folder: Enter the target folder for the incoming print jobs. l Output File Name: Enter the file name for the incoming print jobs.
Information Workflow Variable When licensed When unlicensed Username 1 %3 The user name "na" IP Address 1 %4 The IP address The IP address No. of Pages 1 %5 Number of pages of the job Number of pages of the job No. of Copies 1 %6 Number of copies set by the user Number of copies set by the user Domain Name 1 %7 The Domain Name "na" Machine Name 1 %8 The Machine Name "na" 1) These values originate from the Printer Driver machine.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. OL Connect tasks OL Connect tasks are available in PlanetPress Workflow 8.0 and up.
Note When added as an Output task, the All In One plugin works asynchronously to the Workflow process. Properties The All In One task properties are as follows: Data Mapper Tab The Data Mapper tab generates a Record Set from a specific source: data mapping on the appropriate source (Current Data File, Database or PDF/VT data file), Retrieving items from the Connect Database (filter setting) or uses the current job Metadata. The resulting Record Set is given to the Content Creation part of the task.
as well as the time required for the cleanup process. However, since the data is not written to the database, there is no way to do post-processing on the extracted data after the All In One operation has completed. Any postprocessors defined in the data mapping configuration will be disabled. This option is unchecked by default. l Filter: Retrieves records from the Connect Database. This is identical to using the Retrieve Entities task.
l PDF/VT with Content Creation: Expects a PDF/VT file as an input and executes basic data mapping on the file. This is the same as using the passthrough option in the "Execute Data Mapping" on page 479 task. Content Items are created automatically. When this source is selected, the Content Creation tab is disabled. Note Once the All In One plugin has been executed with this option selected, any task that attempts to access records in the database will fail.
l l "%o": Select to use a dynamic Preset name. Click on %o to change the expression that determines the name of the Preset to use. Preset Name: Select the appropriate Preset to create output with. Adding Output Creation Presets is done from the Sent 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.
Sort Parameters The Search Parameters define how to sort the entities retrieved from the Connect Database using either the Retrieve Items task, or the Filter source in the All in One Action Task's Data Mapper task. l Sort items based on: Lists the different sorts to apply to the entities. l l l Name: Click and enter the name for the Value or the Property to sort on. Type: Select whether the Name option refers to a Property or a Value within the entity.
JSON The Create Email Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string samples" on page 470. A JSON Record Data List (see the REST API Cookbook).
l l Section: Enter the section name that will generate output. Only one section can be output. If no section is defined or if the section name is invalid, the default section will be output. Data Source (see "Input" on page 458): l Metadata: l l Update Records from Metadata: If the process metadata has been modified by any of the "Metadata Tasks" on page 422, check this option to update the records in the Connect database with the metadata and use the updated records.
l Use Authentication group: Check to enable authentication to the SMTP server. l l l l Password: Enter the password for the above user name. Start TLS: Check to send connect to the SMTP server using TLS (Transport Layer Security, also called "SSL"). Attachments: l l l User name: Enter a user name that has permission to send email through the SMTP server. 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.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Job The Create Job action task prepares a series of print content items for output generation.
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 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.
Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
General Tab l Output Preset file: Select which Output Preset to use to generate the output. To be used in this dialog, a preset must have been sent to PlanetPress Workflow using the Package File function in PlanetPress Connect. l l l "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below. Preset Names: Select the appropriate preset to generate output.
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 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
General Tab l l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. Recipient Node: Use the drop-down to select which level of the metadata is used as the "Recipient" node. The Recipient node defines each Record in the output when used with the Create Print Content. Add job information to document: Check to add the 9 jobinfo variables to the PDF/VT metadata at the root level.
Properties Datamapper tab The Create Preview PDF plugin gets one record from the source selected on the Datamapper tab. This record is then merged with the template (selected on the Content Creation tab) to create a preview PDF. The Datamapper tab can have one of the following source options: l Data mapping configuration sets the data source to a data mapping configuration. l l l %o: Select this to use a dynamic data mapping configuration name.
string. In case the JSON string is not a valid JSON object, the plugin will error out with an explicit message. Note This option requires that keys in the JSON string have matching field names in the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data).
l www.json.org l www.w3schools.com JSON string samples The following JSON string samples show various techniques to incorporate data in a JSON string.
[1]',Value,KeepCase,NoTrim)", "last":"xmlget('/request[1]/values[1]/last [1]',Value,KeepCase,NoTrim)", "email":"xmlget('/request[1]/values[1]/email [1]',Value,KeepCase,NoTrim)" } A JSON string that contains nested data: { "name":"Peter Parker", "email":"parkerp@localhostcom", "ExtraData":"foobar", "detail": [{"id":"inv123","ExtraData":"hello"}, {"id":"456","ExtraData":"world"}] } Content Creation tab The Create Preview PDF plugin creates a preview PDF from a template selected on the Content Creation tab, us
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 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
l A JSON Record Data List (see the REST API Cookbook). When the "Retrieve Items" on page 489 task is set to output Records in JSON, it outputs this kind of JSON data. If the input is JSON, the task performs a REST call to the /rest/serverengine/workflow/contentcreation/{templateId} endpoint on the Connect Server. For more information see the REST API Cookbook. Note When JSON data is used as input, the "Create Job" on page 462 plugin (the next task in a print process) cannot use a Job Creation Preset.
Properties General Tab l Template File: l l l l "None" File name: Select to accept a PDF/VT file as an input and automatically create content items based on the PDF/VT. "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template. Adding a template to the resources is done through the Send to Workflow option in the Designer Module.
OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server.
This task can be added as an Action task (see "Action Tasks" on page 254) or as an Output task. Adding it as an Action task enables the process or branch to continue after this task. An Output task is always located at the end of a process or branch. Input This task must receive either a valid Record ID or a JSON object. Record ID A valid Record ID can be retrieved from various data sources. By default, when the Record ID input option is selected, the metadata is used as input.
Output The task outputs HTML code as a job file. Within this HTML code, references to external resources point to the local OL Connect Server and are served to the requester directly when the HTML file is opened in a browser. Properties General Tab l Template File: l l l l "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template.
Warning The JSON format is not validated by the plugin; it is passed as is to the server. Note Only the first record or JSON object is processed, since this task can only generate HTML output for a single record. l l Embed all resources: Check this option to download the resources and embed them in the HTML. Do not alter HTML: Check this option to prevent the HTML tag from being added to the page.
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57.
Processing The task executes the selected data mapping configuration on the appropriate data source, or converts the PDF/VT into a Record Set directly. If the 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.
is not saved on the OL Connect Server, the data is simply returned and processing stops on the server side. This option cannot be used with other OL Connect tasks. 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.
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 484 task. Processing The task requests removal of the file by performing a call to the /rest/serverengine/filestore/delete/{fileId} REST endpoint; see File Store Service: Delete File in the REST API Cookbook. Output This task has no impact on the current Job File.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server.
Processing The task tries to upload the current job file to the OL Connect File Store by making a call to the /rest/serverengine/filestore/DataFile REST endpoint; see File Store Service: Upload File in the REST API Cookbook. Output When a file is uploaded to the Connect File Store, it is automatically assigned a File Store ID. The task stores the returned File Store ID in the specified variable. This task does not modify the Job File.
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57.
Properties 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.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Merge Jobs The Merge Jobs action task merges an external metadata file containing an OL Connect Job with the current job file. Input The task must receive a Job metadata file, which is output from the Create Job task. The selected metadata file must also be the output of a Create Job task. Processing The current metadata file is merged with the selected external metadata file.
Retrieve Items The Retrieve Items action task locates and extracts items from the OL Connect Database so they can be used with further tasks. The items are retrieved using a set of conditions working together. Since this task can retrieve items at any level, it can be used to generate metadata or JSON data used in multiple tasks. Input The task requires no input file, but any input information such as metadata, job information or a data file can be used to specify which items to retrieve.
[ { "schema": { "columns": { "ID": "STRING", "Date": "DATETIME" }, "tables" : { "detail": { "columns": { "ItemTotal": "CURRENCY", "ItemShipped": "FLOAT", "ItemOrdered": "BOOLEAN" } }, "detail2": { "columns": { "ItemUnitPrice": "CURRENCY", "ItemOrdered": "INT" } } } }, "id": 3678077, "datasetid": 2392921, "fields": { "ID": "CU19762514", "Date": 1331096400000 }, "tables": { "detail": [{ "id": 3678078, "fields": { "ItemTotal": "2300.00", "ItemShipped": 2.
} }], "detail2": [{ "id": 3678080, "fields": { "ItemUnitPrice": "1150.00", "ItemOrdered": 2 } }, { "id": 3678081, "fields": { "ItemUnitPrice": "29.99", "ItemOrdered": 1 } }] } } ] The values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.details[0].fields.ID; Properties General Tab l Entity to retrieve: Use the drop-down to select which items to retrieve. l l l l Record: Retrieves one or more Records, whether or not they are part of a Record Set.
l l l l l l l l l l Condition: Select entities based on one or more conditions, the value of a metadata field for example. 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 Job Set: Retrieves one or more Job Sets, including all their content items ready to be printed.
Commingling (available only with the appropriate license) is a method by which Print Content Items are merged together to create mail pieces going to each recipient. For instance, retrieving a letter, an invoice and a notice within the same mail piece, which presumably could be added within the same envelope. Batching is the same principle when all the Print Content Items are generated using the same Template file.
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 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane.
Input The task must receive metadata that contains appropriate entities, generally from the Create Record Set, Create Print Content, Create HTML Content Set or the Create Job tasks. Processing The task sets the chosen properties to all entities present in the metadata. These properties are added to the entities on the OL Connect Server. Note that the properties are calculated only once, and are applied identically to all entities.
Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name.
has sent its request to PlanetPress Image, not once PlanetPress Image has finished generating the actual image file. Other tasks available in PlanetPress Workflow can also be used to generate output, such as Digital Action, Create VDX and PrintForm Action tasks. Unlike Output tasks, Action tasks are only considered completed once the output file has been generated.
l Capture Web Manager Workflow On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
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.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SOAP Client plugin SOAP Client plugin tasks can be used as input, output and action tasks, although their basic function is to generate output. SOAP (Simple Object Access Protocol) is a light protocol that defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems.
Properties General tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the drop-down list. Note The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l l l l l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
l l Namespace: Displays the namespace of the arguments associated with the selected method. Use returned raw SOAP packet as new data file: Check to use the complete SOAP packet (including the passed parameters) instead of the parameters only. This option overrides any return value set to %c in the Arguments box. You should use this option when the SOAP Client plugin is not able to fully support the syntax of the response. Advanced tab l Domain: Enter the domain for the authentication on the SOAP server.
Note This type of output task does not support PDF transparency and duo-tone features, so you should not use it with PlanetPress Design documents that use those features. Input This task can accept either a data file with a correct Emulation, which is then merged to a PlanetPress Design document, or a PDF file which is to be printed natively.
Note This option is not functional when natively printing PDFs (without a document). l Documents: Select a specific PlanetPress Design document if you want all the jobs to be printed with that document. l l Natively print PDF file: This special option can be used if your job file is a PDF. The job will . Add job information to the document: Select to prompt your PlanetPress Workflow to add the available job information elements in the header of the file that will be sent to the selected printer queues.
Printer Queue Output Printer Queue Output tasks dispatch jobs to selected printer queues. Note that you must have created at least one printer queue before you can add your first Printer Queue Output task. Furthermore, to print the data file with a PlanetPress Design document, you must have associated at least one document with a printer queue. You can select multiple queues in a Printer Queue Output tasks and choose exactly how your jobs will be dispatched to the selected printers. Input Any data file.
Printer Queue output, 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). Advanced tab l l Copies: Enter the number of copies to be printed outputs. Since this is a variable property box, you may enter a fixed value or use a data selection.
l l l l Keyword: Cuts the job file after each occurrence of the specified keyword (string of characters). Custom Trigger: Enter the code of the trigger that will be sent with the data to the selected printer queues. Note that this box is only enabled if None was selected in the General tab. Add job information to the document: Includes the current JobInfos to the job output. This option is only available if a document was selected in the General tab.
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 properties' descriptions below to know what each option does. Once the contents of the file and attachments is determined, the email (and attachments) is either sent directly to the selected SMTP server, or is deposited in the "Outbox" folder of the local Microsoft Outlook account.
character). Also note that it is not currently possible to send both an HTML and plain-text version of your message. Attachments tab Use this tab to add the files received by this task (plus any other file that you may choose to attach) to the emails sent by PlanetPress. l l l l l l l Attach input job files: Select to attach the file received by this task to the emails it will generate. If this option is not selected, the recipients will not receive any of the data file.
l l l l l l l l l l Use SMTP mail: Select to use Simple Mail Transfer Protocol (SMTP) to send the emails (and attachments). To use SMTP you must enter information in the Name, Email Address and Outgoing Mail (SMTP) boxes below. Name: Enter the sender’s name that will be used in emails sent by PlanetPress Workflow for this task. Organization: Enter the organization name that will be used in emails sent by PlanetPress Workflow for this task (this is optional).
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Send to Folder Send to Folder output tasks send the files they receive to a local folder. They perform the same function as Send to Folder action tasks, with the only difference being that in this case, PlanetPress Workflow will not wait for the task to be completed before going on to the next task in the configuration.
Note This feature is part of the PDF Tools, which is only available in PlanetPress Workflow. 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. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 57. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
that specific instance of the process. For more information see "Manipulate Local Variables" on page 519. l l Job Infos are also specific to an instance of a process, however their use is different. Just after an initial or secondary input task, Job Infos contain information about the job file itself. They are generally used to gather information from the input task, or transfer information to a Connect template or PlanetPress Design document. For more information see "Job Info Variables" below.
You can set the value of a job info within your process in two ways: l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 312. You can use Scripts. See the chapter "Using Scripts" on page 93. Considerations on Job Infos: l l l While the initial job infos are created by the input task, they can be overwritten by the Set Job Info and Variables Action Task, by a Script, or by any secondary input task in the process.
Variable Name Example value when interpreted %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 %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 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 Filename job00ZAIZ2C4FXON16CE6C566.dat.meta %E Current Metadata Path and Filename C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool\5.tmp\job00ZAIZ2C4FXON16CE6C566.dat.met a %w Current process name.
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 following variables are available in error-handling tasks (that start with the Error Bin Input task). Note that these are new in PlanetPress Workflow 7.4 and are not available in previous versions.
Variable Name % {error.process} Name of the process where the error was triggered % {error.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.
When the process ends, the local variable forgets whatever value was given to it by the process and goes back to its default value. Local variables are generally used to keep information that is useful for the process itself but not to any other process or instance of the process. For example, you could store the current order ID for the process, a name or an email. You can have as many local variables as you want in any given process.
l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 312. You can use Scripts. See the chapter "Using Scripts" on page 93. Variables may be used as variable properties in variable property boxes (see Variable Properties). Manipulate Global Variables Note For information about Local Variables see Local Variables. Global Variables are set at the level of the configuration file and are shared between all processes and tasks.
2. Click Global Variable in the Variables group. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To set the value of a global variable from the Configuration Components pane: 1. Double-click on the global variable in the Configuration Components pane. (Right-clicking then clicking Properties also works) 2. Enter the new value for your global variable. 3. Click OK to save the new value.
Variables may be used as variable properties in variable property boxes (see Variable Properties). About Workflow Configurations PlanetPress Workflow configuration files are defined as a set of processes, subprocesses, variables, documents and printer queues, that work together within PlanetPress Workflow Service. 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.
configuration, PlanetPress Workflow automatically creates a process that includes a "Folder Capture" on page 217 initial input task and a "Send to Folder" on page 511 output task. You can then edit and save your new configuration. To create a new configuration, choose New from the PlanetPress Workflow Button.
PlanetPress Watch /Server configurations from Version 6) Saving and sending a Workflow Configuration The core of the PlanetPress Suite workflow tools is the PlanetPress Watch service which, once started, constantly runs in the background to perform the tasks included in its current configuration file. PlanetPress Workflow lets you create, edit and save configuration files. As you are working on your configuration, you can save that configuration file as a file on your local hard drive.
PlanetPress Workflowwhen it is started. To change any currently active configuration, 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 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.
Note If PlanetPress Workflow service is paused when you send a new configuration, it will not stop and restart. Since PlanetPress Workflow service reads its configuration file when it starts up, when you resume processing, PlanetPress Workflow service will continue using the old configuration. Exit PlanetPress Workflow Configuration Program Once you are done using PlanetPress Workflow, you can close the configuration program.
Workflow Configuration resource files Workflow serves as automation tool in a number of distinct products. Some of the tasks that can be used in a Workflow configuration only work with product-specific files: l l l PlanetPress Connect Resources. Connect Resources are files created with one of the other Connect modules - the Designer and DataMapper (see "Connect resources" on page 565). PlanetPress Suite users may use documents made with Design (see "PlanetPress Design documents" on page 532).
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 458, "Create Web Content" on page 475 and "Create Print Content" on page 472. Job Presets: Job Presets can be used in the "Create Job" on page 462 task to filter and rearrange print content items. Output Presets: Output Presets contain settings for Print output.
Tip You can import multiple files at once. Resource Save location Any resource sent to PlanetPress Workflow from PlanetPress Connect is saved locally at the following location: %PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\OLConnect Resources are saved in their appropriate folder: l DataMapper contains the data mapping configurations (.OL-datamapper) l JobCreation contains the Job Presets (.OL-jobpreset) l OutputCreation contains the Output Presets (.
of 300 files will be present in the archive\template folder). Older archives are deleted automatically as new archives are created. Using attached data files When sending a Connect data mapping configuration from the Designer to PlanetPress Workflow, all data files used in the document are automatically sent to PlanetPress Workflow along with the data mapping configuration. These data files appear under the data mapping configuration in the Connect section of the Configuration Components.
Saving an attached data file to disk 1. Make sure the Connect Resources section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Right-click on the data file, then click Save sample data file. PlanetPress Design documents A PlanetPress Design document is a file sent to PlanetPress Workflow by PlanetPress Design and is used to produce an output when merged with data (i.e. the job file).
The document is imported and displayed in the Configuration Components pane under PPS/PSM Documents. This physically installs the documents to the Documents folder relative to the install folder of PlanetPress Workflow. Adding resident documents to the Configuration Components Pane By default, the Documents group displayed in Configuration Components pane of the PlanetPress Workflow Configuration program includes all those documents that are available on your local PlanetPress Workflow server.
1. Make sure the PPS/PSM Documents section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Right-click on the data file, then click Set as sample data file. Viewing an attached data file 1. Make sure the PPS/PSM Documents section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Double-click on the data file to open the data selector (see "The Data Selector" on page 32).
Document Preview When sending a PlanetPress Design document from PlanetPress Design to PlanetPress Workflow, a PDF Preview of the job's output is automatically sent to PlanetPress Workflow along with the Design document. This preview appears under the PPS/PSM Documents section of the Configuration Components pane. The PDF contains the result of a preview with the active data file (for all data pages) run as an Optimized PostScript Stream. Viewing the Document Preview 1.
The PlanetPress Workflow Configuration tool lets you view a number of the properties associated with the PlanetPress Design documents you use, but most of those properties are set in PlanetPress Design and cannot be edited using the PlanetPress Workflow Configuration program. The Document name of printer-resident documents can be changed using PlanetPress Workflow Configuration program simply because it is initially set using that program.
About 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 PlanetPress Workflow Configuration, 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.
Note If you send a new configuration when PlanetPress Workflow is paused, it will continue using the old configuration when you resume processing until you stop and restart it. To resume your PlanetPress Workflow service after pausing it: 1. Click Tools in the PlanetPress Workflow Ribbon. 2. Click Resume in the Services Status group. The PlanetPress Workflow Tool service starts performing jobs again. Users and configurations When a user opens a session on a computer, they typically need to log in.
rights, and that this application and its services may therefore not be able to perform some of the actions you can perform when you create or edit a given configuration. The simplest thing to ensure that rights are the same across your whole network is to create an administrator network account especially for PlanetPress Workflow Tools.
The first time you start the PlanetPress Workflow Configuration program, the application automatically asks you to choose an account (see procedure below). You can also manually start this procedure from the PlanetPress Workflow Tools by following this procedure: 1. Click on the Tools tab in PlanetPress Workflow Ribbon, then click Configure Services. 2.
name box. l l Confirm password: Enter the password you entered in the Password box. Services start automatically: Select to start the required PlanetPress Workflow automatically. 3. Click OK.
The 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: 1. The PlanetPress Workflow button. See "PlanetPress Workflow Button" on page 553. 2. The Quick Access Toolbar. See " The Quick Access Toolbar" on page 661. 3. The Ribbon Tabs. See The PlanetPress Workflow Ribbon.
4. A Group within the Ribbon 5. The Process area. See "The Process area" on page 650. 6. A specific link (aka a "component", "button" or "link"). 7. The Dockable panels including "The Plug-in Bar" on page 605, " The Object Inspector Pane" on page 604 and "The Debug Information Pane" on page 602. 8. The status bar. This displays your current software version and status of the PlanetPress Service. 9. The Configuration Components pane. See "Configuration Components pane" on page 555. 10. The Messages Pane.
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. When attached areas are displayed simultaneously, they appear side-by-side or above one another inside sub-windows.
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: l In the PlanetPress Workflow Ribbon, click the View tab. l From the Show/Hide group, click on any area name to hide or display it. A "highlighted" (orange) button means the area is displayed somewhere on your screen(s).
button when the shape of a tab appears at the bottom of the rectangle. To switch between combined area: l 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. The left and right arrows lets you show hidden tabs.
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. The area will jump outside of the combined area. To attach areas: 1.
3. Resize each part of the new group as desired. 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. 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.
Page 551
A) Click to maximize this area. B) Click to restore this currently maximized area. C) Click to maximize this area. D) Click to restore this currently maximized area. 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.
To change the language used by the PlanetPress Workflow Configuration program: 1. Click the PlanetPress Workflow button, then click Select Language. The Select Language dialog box appears. This box lists all the languages that can be used by PlanetPress Workflow as well as the Use System Default Locale check box. 2. Select the desired language. 3. Use System Default Locale: Select to mirror your language settings, as defined in the Regional and Language Options of the Windows Control Panel.
l l l Save: Saves the current configuration. If the file is new and has not yet been saved, or if the configuration is the loaded directly from the service, the Save As dialog is displayed instead. See "Saving and sending a Workflow Configuration" on page 525. Save As: Saves the current configuration under a new name. It does not overwrite any existing configuration file, unless an existing file is selected and overwritten manually by the user.
Configuration Components pane The Configuration Components pane displays processes, subprocesses, variables, resource files and printer queues. It also lets you add any of these components using the right-click menu. Components Area Sections l Processes: Displays a list of processes in your configuration (see: "About Processes and Subprocesses" on page 79).
l l Rename: Renames the subprocess. l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties for error handling. Global Variables: Displays a list of variables that are shared between all your processes (see: "Types of variables" on page 512). Right-click on a Global Variable to access a drop-down menu that offers these choices: l Insert Global Variable: Creates a new global variable l Cut, Copy, Paste: Controls the clipboard.
l l PPS/PSM Documents: Displays a list of PlanetPress Suite Design and PrintShop Mail (Suite) documents that have been imported into PlanetPress Workflow (see "PlanetPress Design documents" on page 532 and "PrintShop Mail documents" on page 536). Rightclick on the section or on a document to access a drop-down menu that offers these choices: l l l Insert Resident Document: Inserts a new Resident Document, which is a placeholder for a PlanetPress Design document that resides exclusively on the printer.
Note Deleting a component that is currently used by a process will cause this process to stop working and trigger an error, until the task that causes the error is removed, or changed to point to another existing component. Process properties To have access to the properties of a process or subprocess: l Right-Click on the Process in the Configuration Components Area. l Select Properties. You can also double-click on the process to show its options.
maximum number of threads is 10 and you specify 50% here, a maximum of 5 replications will occur (the original process + 4 copies). l l l l l As soon as possible: Select to have the process run continuously. Clear to enable the Time Grid to fine-tune the schedule of the process. Day(s) to keep backup: Indicate the number of days to keep backups of jobs processed by input tasks.
The Time Grid The PlanetPress Workflow Process Options dialog box includes a time grid that lets you set exactly when you want a process to run. The grid is composed of blocks that represent time periods on a given day. To activate the Time Grid, the "As soon as possible" option must be unchecked. In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not 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 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 options in the On Error tab of the Process Properties dialog are the same as in the On Error tab in the Task Properties dialogs; see "Using the On Error tab" on page 57. Manipulate Global Variables Note For information about Local Variables see Local Variables.
2. Click Global Variable in the Variables group. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To set the value of a global variable from the Configuration Components pane: 1. Double-click on the global variable in the Configuration Components pane. (Right-clicking then clicking Properties also works) 2. Enter the new value for your global variable. 3. Click OK to save the new value.
Variables may be used as variable properties in variable property boxes (see Variable Properties). Connect resources Connect resources are files created with Connect's Designer or DataMapper (see "Connect resources" above). They are visible in The Configuration Components pane and are added by using the Send to Workflow option from the PlanetPress Connect Designer's File menu.
l Data mapping configurations l Data model l Templates l Job Presets l Output Presets Importing Connect resource files Connect resource files are added by using the Send to Workflow option from the PlanetPress Connect Designer's File menu; see Sending files to Workflow in Connect's Online Help. They can also be imported into PlanetPress Workflow as follows: 1. Click the PlanetPress Workflow button. 2. Choose Import, then Import Connect Content. The Import dialog box appears. 3.
l OutputCreation contains the Output Presets (.OL-outputpreset) l Template contains the templates (.OL-template) Note Package files are not saved anywhere. The individual resources contained within the package are extracted and placed in the folders noted above. Resource archives From version 8.2, PlanetPress Workflow maintains an archive of previous versions of resources, in the following location: %PROGRAMDATA%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\OLConnect\Archive , each in their o
1. Make sure the Connect Resources section is visible by clicking the appears. button if it 2. Expand the data mapping configuration (name.OL-datamapper) by clicking the button. 3. Right-click on the data file, then click Set as sample data file. Viewing an attached data file 1. Make sure the Connect Resources section is visible by clicking the appears. button if it 2. Expand the data mapping configuration (name.OL-datamapper) by clicking the button. 3.
set in PlanetPress Design and cannot be edited using PlanetPress Workflow Configuration program. The Document name of printer-resident documents can be changed using PlanetPress Workflow Configuration program simply because it is initially set using that program. The properties available via the Printer Settings tab define how documents are printed. They are also set using PlanetPress Workflow Configuration program and are retained when documents are assigned to printer queues.
l Last modified: The date and time the document was last uploaded to PlanetPress Workflow. Printer Settings Tab l l l Trigger Type: Select whether you want a normal trigger configuration to be used, or a custom trigger that you manually enter. Custom Trigger Box (appears only when Custom Trigger is selected in Trigger type): Lets you enter the exact trigger you want to use. This trigger must absolutely be in standard postscript language.
l l l Confirm Update: Check if you want a confirmation page to be printed stating the document has been updated, when it happens. This options is disabled if Automatically update is not selected. Update Instances: Clicking this button brings up a dialog box that lets you manually update any document on any printer. Printer-Specific folder: This option lets you enter a manual location where the documents should reside in the printer's memory.
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. To save an attached data file to disk: 1. Make sure the Documents section is visible by clicking the 2. Expand the document (name.ptk) by clicking the button if it appears. button. 3. Right-click on the data file, then click Save sample data file.
To save the Document Preview to disk: 1. Make sure the Documents section is visible by clicking the button if it appears. 2. Expand the document (name.ptk) by clicking the button. The Document Preview has the same name as the document but with a PDF extension. 3. Right-click on the Document Preview, then click Save PDF File.
2. Drag the selected documents over a PlanetPress Workflow printer queue. The selected document or the group of documents is associated with the printer queue. Each document keeps its default properties. To break the association between a document and a given printer queue: l Select the document as displayed under the printer queue in question and press Delete. To break the association between a document and multiple printer queues: 1.
Mouse cursor As you drag a configuration component, your mouse cursor will change to indicate the action you are performing, as well as whether the location where the cursor is can accept the configuration component you are dragging. If you try to drag a configuration component in a location that is not accepted, the cursor changes to a "prohibited" icon. If you are moving a configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box.
When dragging configuration components, a horizontal line appears where the component will be dropped (if the location is valid). At the end of this line will be small "dents". If these dents are on top of the line, the component will be placed at the same level (group) as the component before it. If the dents are at the bottom, the component will be placed at the same level (group) as the component after it.
same methods as moving them, with the following differences: l l To move components using the clipboard buttons and contextual menu, replace "Cut" by "Copy". Otherwise the methods are the same. To move 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. Items can only be grouped within their own category. Thus you can only group processes with other processes, documents with other documents, and printer queues with other printer queues.
Tip Groups can be copied and moved using the Clipboard and Drag & Drop; see " Using the Clipboard and Drag & Drop" on page 574. Expanding and collapsing categories and groups in the Configuration Components pane You can expand and collapse the Processes, Global Variables, PPD/PSM Documents and Printers Queues categories, and groups, in the Configuration Components pane. To do this, click the Expand / Collapse button to the left of the item.
Other Dialogs These dialogs are either accessible from the preferences or from different parts of PlanetPress Workflow. Activate Your Printers The Activate a Printer dialog lists the existing activated printers on the system and lets you add new activations. Note Printer activations are normally given to you by the activations department electronically, including a file that will automatically add all your printers in this dialog.
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. You can also double-click on any existing activation to edit it.
Domain box, and the user names in those domains in the Username box. Although this is useful if you do not know the domain name and user name of the account you want to specify, it can also be very time-consuming if there are many domains. l l Domain: Select the domain in which the user account resides, or enter the name of the domain manually. This Account: Provide a domain, user name and password to use instead of the Local System Account.
l Right-Click on the Process in the Configuration Components Area. l Select Properties. You can also double-click on the process to show its options. Note Subprocesses do not have the "General Tab" which is only used for scheduling, but they do have the Information Tab. Options General tab l 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.
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.
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 options in the On Error tab of the Process Properties dialog are the same as in the On Error tab in the Task Properties dialogs; see "Using the On Error tab" on page 57.
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. Access Manager The Access Manager controls what rights are granted to other machines (clients and servers) on the same network. It grants access to functions such as sending documents and jobs to the server. To open the Access Manager 1.
To manually add a new entry 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.
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. To automatically detect machines on the network and add them 1.
does not continue processing after it has found an "Allow" checkmark. There is no concept of "Deny", meaning if any "Allow" permission is given, there is no way to later remove it for certain IP addresses or IP ranges. l l l The configuration of the Access Manager is saved in a file on the hard drive which can be edited manually. See Access Manager hosts.allow File. HTTP, FTP and SOAP communication is not limited to the local subnet on any version where these plugins appear.
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. To add a new SOAP user 1. Click on the button. 2.
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. Administrator: Choose the permission type l l l User: Can access none, some, or all of the processes, selected individually in the Permissions section. Admin: Has access to all processes and features.
PDF Viewer The PDF Viewer, introduced in PlanetPress Tools 7.3 in some areas and expanded for use throughout the configuration tool, displays any PDF used in the configuration or process. Because this PDF viewer is integrated with the suite, it is not necessary to have any third-party tools such as Adobe Acrobat installed on the operating system. Technical The PDF Viewer is not currently standalone and cannot be used to display PDFs outside of PlanetPress Workflow.
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).
Select any document in the list (use CTRL+Click or SHIFT+Click to select multiple document or use the Select All button) and click OK to update these documents. To add any document to this list, you need to assign them to a printer queue. See Associate Documents and PlanetPress Watch Printer Queues. Data Repository Manager The Data Repository Manager is an interface that manages the PlanetPress Workflow "Data Repository" on page 53. This feature, introduced in version 8.
l l Key section l l l l l Add KeySet: Click to add a new KeySet to the currently selected group. Displays a dialog with all the Keys in the group, asking for a value for each of the keys. Enter the values then click OK. The KeySet will display in the right part of the repository manager. Delete KeySet: Click to delete the currently selected KeySet in the Group. Warning: This action cannot be undone. Edit KeySet: Click to edit the currently selected KeySet.
l YYYY = four-digit year l MM = two-digit month (01=January, etc.) l DD = two-digit day of month (01 through 31) l T = literal constant separating date from time l hh = two digits of hour (00 through 23) (am/pm NOT allowed) l mm = two digits of minute (00 through 59) l ss = two digits of second (00 through 59) l s = one or more digits representing a decimal fraction of a second l Z = literal constant representing the UTC time zone designator.
l l Press Tab to switch between the Repository Structure, Group Key Sets, Lookup Function Syntax and the Close and Help buttons. Press CTRL+N to add a new item: l If a group is selected, a new group is added. l If a key is selected, a new key is created within the selected group. l l l If a field is selected in the KeySets pane, the Add Key Set dialog will appear, allowing you to create a new keyset. Press F2 to rename a group or a key on the Repository Structure pane.
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. Select the images you want to delete. 3. Press the Delete key.
l Copy Value (only when right-clicking an existing expression): Places the resulting value of the expression in your clipboard. l Revalue all: Refreshes the value of all the expressions. l Add Expression: Creates a new expression. l l Delete Expression (only when right-clicking an existing expression): Remove the selected expression. Clear Expression List: Removes all expressions.
l l l l Press CTRL+C on your keyboard or right-click on the line and select Copy to place a copy of the line in the clipboard. Press CTRL+A on your keyboard or right-click on any line and select Select All to select all the lines in the Message Area. Right-click anywhere in the Message Area and select Clear Messages to clear the contents of the Message Area.
that are shared between those objects can be changed in the Object Inspector. Changing a property changes it for all the selected objects. The Object Inspector also displays information about the Job File while it is being processed in Debug mode. Seeing how files change as they travel down a process can provide valuable debugging information. You can even change some of the job information from the Object Inspector (such as Job Infos) while in debugging.
l Data splitters l Process logic l Connectors l PlanetPress Capture l Metadata Related l OL Connect Send 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.
l Copy plugins from one custom category to another by holding the CTRL key. l Delete plugins from any custom category by using the Delete key. l Revert to the default Plug-in Bar by selecting Reset to default. 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.
l Plug-in: l "General and logging preferences" on page 627 l "Messenger plugin preferences" on page 628 l "HTTP Server Input 1 plugin preferences" on page 629 l "HTTP Server Input 2 plugin preferences" on page 632 l "LPD Input plugin preferences" on page 633 l "Serial Input plugin preferences" on page 634 l SMTP Input l "Telnet Input plugin preferences" on page 636 l "PlanetPress Fax plugin preferences" on page 636 l "FTP Output Service preferences" on page 640 l "PlanetPress Image pre
l Black: Sets the general interface color scheme to a black (coal) color. Colors l l l l Variable properties: Select a color for the labels identifying variable property boxes. Debug: Select the color applied to the PlanetPress Workflow Process area background when in debug mode. Highlighted tasks and branches: Select the background color for highlighted tasks and branches in the Process Area’s invisible grid.
in groups, it displays an expand/collapse button to the left of the name of the group for expanding or collapsing the group. l l Sunken active property: Select to use a recessed effect to display the currently selected property. Border active property: Select to display a border around the currently selected property. l Show lines: Select to display lines between elements. l Line style: Select a style for the lines.
Default Configuration behavior preferences l Use default configuration: Check to use default input and output tasks when you create a new process. If this group is not selected, each new process you will add will begin and end with unknown tasks. l l l l l l Default input task: Select an input task to use as the default input task when you add a new process. Click the Configure button located to the right of this box to set the properties of the selected input task.
l l l l l l l l l l l Prompt on Document deletion when service is running: Group of documents deletion: Select to have PlanetPress Workflow prompt for confirmation when deleting a group of documents from the Configuration Components pane. Empty group deletion: Select to have PlanetPress Workflow prompt for confirmation to delete a group when you remove the last of its member objects. If you clear this option, groups are automatically deleted when their last members are removed.
l l l l l l l l l l l Plugin not found: Select to have PlanetPress Workflow display a prompt when you import a configuration, and one or more of the plugins used in the configuration are not found on the computer running the software. Prompt on configuration overwrite: Select to have PlanetPress Workflow prompt for confirmation when a configuration is about to overwrite a file with the same name.
license that is not the same as the current one, the settings for this task will be lost when saving or sending to the service. l l Display Generic Splitter Found Message: Select to have PlanetPress Workflow prompt when a Generic Splitter task is found in any of the configuration's processes. The Generic Splitter task is maintained because of its historical purpose but should no longer be used since it can almost always be replaced by more specialized and efficient splitters.
and Password fields, and in the NDS options group (these properties are optional) below to properly log in to NetWare. l l l l l Username: Enter your NetWare user name. This is the user the PlanetPress Workflow service uses to log in to NetWare at run-time. The service accesses resources as configured for this user. Password: Enter the NetWare password corresponding to the user name you entered in the previous text box. Tree: Enter the NetWare Directory Services (NDS) tree where the user resides.
you manage pens, documents and licenses. The available PlanetPress Capture user options are: l Mode: Choose between Server and Client mode. Client and Server mode are used for multi-server architectures. See PlanetPress Capture Server/Client. l Port: Select the port used to connect two servers together. The default value is 5864.
In client mode, no pen license information is stored locally. All pens are therefore validated against the server specified in the Host address field displayed when the Client option is selected. Note that this validation occurs for every ink file (i.e. PGC file) the local system processes, which may cause a slight delay for the operation depending on the connection speed and latency between the two systems.
l l l Pattern ID: Search using the pattern's identification number. This can be printed on each document next to the Anoto Statement (see PlanetPress Design User Guide). Content Status: Search using the status of the document, whether it is Open, Closed, Complete, Partial or in Error. Operator: Select how to do the comparison l Equal: The mask and database information are exactly the same. l Not equal: The mask and database information are different.
l Close documents: Click to close the document and release the pattern it uses. Warning This will prevent the document to be further updated, may cause errors when docking any pen that signed the printed version of the document. This cannot be undone. PlanetPress Capture ODBC Settings This dialog is used to set up the connection to a PlanetPress Capture Database through an ODBC connection. To access this dialog, See "PlanetPress Capture preferences" on page 615.
l l user name: If the database is secured with a user name and password, enter the user name here. Password: If the database is secured with a user name and password, enter the password here. Note In order for the database connection to be functional, you must ensure that the database Type correspond exactly to the one used by the DSN, and is part of the supported database types.
l Microsoft Access l l l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database file (mdb) must be local to the PlanetPress Workflow computer. It cannot be located on a network drive or another server. Database can be in any location, but performance will depend on the speed of the connection between PlanetPress and the MySQL server.
Options and Controls Top Toolbar l l l Read PGC File: Click to display a File Open dialog. Browse to an existing PGC file, and open it. PlanetPress Capture will read the serial number from the PGC file and register the pen. Print Pen Activation File: Click to print a page containing a special pattern. Any pen that writes on this pattern and is then docked will be registered in the database.
To register a pen using the registration pattern 1. Click on the Print pen activation file button in the top toolbar of this dialog. 2. Use the Windows Print dialog to print to the desired printer. 3. Write or make a line on the printed pattern. 4. Dock the pen in its cradle. 5. Click on the Read PGC File button in the top toolbar of this dialog. 6. If necessary, enter an optional pattern sequence and User ID for each pen.
Technical To add a pen pack, PlanetPress must be activated using a PlanetPress Production license. if PlanetPress Production is in trial mode, no pen pack can be added because the Pen Pack uses the serial number. Options and Controls PlanetPress Capture Pen Licenses Group l l Import License...: Click to open the Import License dialog. Browse to a PPLIC (PlanetPress License) file on your computer and open it to import the license.
The available OL Connect user options define the default behavior of OL Connect tasks' OL Connect Proxy tab. These values are used unless they are overwritten in a task's properties: l Server Connect Settings l l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server.
Warning The default values are generally correct for the greatest majority of PDF data files. Only change these values if you understand what they are for. Delta Width Defines the tolerance for the distance between two text fragments, either positive (space between fragments) or negative (kerning text where letters overlap). When this value is at 0, the two fragments will need to be exactly one beside the other with no space or overlap between them.
At 0, the font size must be exactly the same between two fragments. At 1, a greater variance in font size is accepted. Accepted values range from 0 to 1. The default value is 0.65, recommended values are between 0.60 and 1.00. Gap Defines how spaces between two fragments are processed. If the space between two fragments is too small, the text extraction will sometimes eliminate that space and count the two fragments as a single word. To resolve this, the Gap setting can be changed.
l l l Add time stamp to all processes events: Adds a time stamp to each log entry for a process event. Delete log files after: Select how many days log files are kept before being deleted. Maximum numbers of replicated processes: Set the maximum number of times a process may be replicated. Messenger plugin preferences Apart from enabling communication between the various parts of PlanetPress Workflow, the PlanetPress Workflow Messenger also manages local instances of the PlanetPress Workflow Alambic.
HTTP Server Input 1 plugin preferences HTTP Server Input 1 plugin preferences control the server protocol aspects of the PlanetPress Workflow HTTP Server Input tasks. This is where you enable and configure secure communication for the HTTP Server. Click the PlanetPress Workflow button and then the Preferences button, to open the Preferences dialog. The HTTP Server Input 1 plugin preferences can be found under Plug-in. Preferences l l l Port: Select the TCP port to use.
Note When SSL is enabled and a user sends a query prefixed with https://, then this specific communication will be sent through port 443, which cannot be changed in Workflow. However, http:// requests will still be received on the port specified in http server preferences. Note SSL is used to accept secured, encrypted requests from web clients and requires a certificate delivered by an approved authority. SSL can also be called HTTPS, though that is a misnomer.
l Omit attachments as CDATA node in the XML envelope: By default, the request XML has a CDATA node that contains the raw input data, effectively doubling the size of the incoming XML file, which due to technical restrictions cannot be larger than 400 MB. This option allows for much larger (non-binary) attachments by removing them from the XML data file. Generally attachments are both saved on disk and included as a CDATA node within the XML envelope.
253 dent 361 341 dent Resulting XML structure with Enhanced PHP-like arrays email@example.
The available HTTP Server Input 2 preferences are as follows: l Serve HTTP resource: Check to activate static resource serving. l l Resource action name: Enter a name that will be simulated as a folder in your HTTP structure. For example, if you enter images in this box, you would refer to any files in this folder as href="images/file.ext" . Resource folder: Type the path of the folder where your resources are located, or click the Browse button and choose the folder in the browse dialog.
Preferences l Protocol options group l l l l l Log all Winsock and network messages: Select to have PlanetPress Workflow keep a log of all Winsock and other network messages that occur through the LPD service. These are messages related to jobs being sent from other systems through LPR, and being received by PlanetPress Workflow via LPD. Since these messages can accumulate, you have the option of not logging them.
Preferences l Serial settings group l l l l l l l Serial port: Select the port of the computer where the Serial input is connected to (COM1 through COM8). Baud rate: Select the baud rate of the Serial input. The baud rate is the number of bits transferred per second. The transferred bits include the start bit, the data bits, the parity bit (if defined), and the stop bits. Data bits: Select the number of data bits defining the incoming data file on this serial port.
l Log (verbose): Select to keep a log of errors and other information related to the Serial input. Since these messages can accumulate, you have the option of not logging them. Telnet Input plugin preferences The Telnet input plugin preferences control the log of the PlanetPress Workflow Telnet Capture service. Since PlanetPress Workflow lets you monitor multiple Telnet inputs simultaneously, the port setting for all Telnet input tasks cannot be set in the Preferences.
Preferences l l Delete log after: Enter the number of days after which to delete the PlanetPress Fax service log. Each log covers a 24-hour period and is kept in the Log folder, which is located in the PlanetPress Workflow installation folder (on the computer that actually performs the PlanetPress Fax output tasks). Fax service: Select the faxing program to which PlanetPress Fax sends its documents for faxing.
generated by the Windows Fax Service is also logged in the report. Note that when PlanetPress Fax is unable to send a fax because an empty fax number is used as the only recipient for a document, a failure will not be reported but an error will be logged. l l l l l Report Successes: Select to have PlanetPress Fax generate a report whenever one of the faxes in the PlanetPress Fax Job reaches its destination successfully or at least as far as the Windows Fax service is concerned.
l l l Folder: Enter or select the location of the report file. PlanetPress Fax generates report file names automatically with the file name extension PFX. The report file is copied to the specified Report folder only after all fax transmissions in a PlanetPress Fax job are completed or have exceeded the maximum number of retries. This folder can then be used as an input for a PlanetPress Workflow process for monitoring the status of PlanetPress Fax jobs.
l Select Language: Click to select a different interface language for the PlanetPress Fax Configuration applet. Note that this button is not displayed if you edit the PlanetPress Fax options directly (not via PlanetPress Workflow Configuration program). FTP Output Service preferences FTP output user options control certain functions of the FTP Client service, which in turn has a direct impact on all FTP output tasks performed by PlanetPress Workflow on a given computer.
computer, typically one that runs only PlanetPress Image. When you change the user options on a given computer, only that computer is affected. So you should consider changing the PlanetPress Image user options on the computer that actually performs the PlanetPress Image output tasks. The changes you make to the PlanetPress Image user options are stored in the PlanetPress Image configuration file (ppimage.cfg). They will be applied when PlanetPress Image is started.
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 l l l l Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database. User ID: Enter the user id required to access the database to which you are adding new PDI files from the generated PDF files. If you are using an SQL database, enter the login name you chose when you configured the SQL database (refer to the “Using PlanetPressSearch with an SQL Server Database” section of the PlanetPress Search User Guide).
l l l Reply address: Enter the reply address that recipients use to reply to the error messages. Outgoing mail (SMTP): Enter the IP address of the server that PlanetPress Workflow uses to send the emails via SMTP. Server requires authentication: Select if the outgoing server used to send the emails via SMTP requires authentication. Note that if you select this option, you will be required to enter information in the Account name and Password boxes below.
l l Error handling group l l l l Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service. Max. retry period: Select the maximum time period, in hours, within which PlanetPress Workflow attempts to dispatch the job using the LPR output before giving up. Note that entering a maximum retry period of 0 hours disables retries altogether.
Note It is also mandatory to send your configuration to your PlanetPress Workflow service since the PrintShop Web credentials are included in the *.cfg file (See "Sending a configuration" on page 525), which is updated every time the configuration is sent to the service via the Send Configuration button. Editor Options The Script Editor is used to edit scripts used in Run Script and the XSLT Editor is used to edit scripts used in Open XSLT action tasks.
indentation level to enter the body of the for loop, then press BACKSPACE to enter the end for statement. You must select Auto indent mode to use this option. l l l l l l l l l Cursor through tabs: Select to move one by one through the spaces of tabs using the left or right arrow keys. Clear to have the arrow keys treat the tab as a single character. You must select Use tab character to use this option.
l l l l l l Enable search highlight: Select to highlight the search term match found in the code when you perform a search. Clear to prevent the highlighting. In both cases, the pointer appears after the last character of the search term match. Double click line: Select to highlight the complete line of code when you doubleclick that line. Clear to highlight only the word under the pointer. Find text at cursor: Use to set the behavior of the Find dialog box.
l Margin and Gutter Group l l l l l l l Right margin: Select to display a vertical gray bar as a right margin indicator. Use the Right margin position drop-down list to set the position of this indicator. This indicator is an on-screen visual reference only. It does not print, and does not enforce word wrap on lines that exceed the number of characters set for it.
attributes. Each element recognized for each scripting language, for example, a URL in a JavaScript script, is displayed with the properties you set. l l l Foreground: Select the color that the element highlighted in the Element list box is displayed with in the Script Editor. Background: Select the background color that the element highlighted in the Element list box is displayed with in the Script Editor. The color is used to highlight the element as if it was selected with the cursor.
l " Cutting, Copying and Pasting Tasks and Branches" on page 655 l " Moving a Task or Branch Using Drag-and-Drop" on page 657 l " Ignoring Tasks and Branches" on page 658 l " Resize Rows and Columns of the Process Area" on page 658 l " Selecting Documents in Tasks Links" on page 659 l " Highlight a Task or Branch" on page 660 l " Undo a Command" on page 660 l " Redo a Command" on page 660 Zoom In or Out within Process Area You can do a zoom out in the PlanetPress Workflow Process area to see
4. Depending on where you place your mouse, you may see that you can replace or insert existing tasks, or not place it at that location at all. 5. When you drop the task in the desired location, a dialog box containing the available task properties is displayed. 6. Set the task properties as required and click OK to close the dialog box. There are a few things to keep in mind when dropping tasks: l l You can insert input tasks anywhere in the process except in output task locations.
To edit a task: 1. In the PlanetPress Workflow Process area, double-click the Task icon. A dialog box containing the available task properties is displayed. 2. Edit the task properties as required. Click specific tabs to see all the properties associated with the task. 3. Click OK to close the dialog box and save the new properties. Replacing Tasks, Conditions or Branches You can replace existing tasks either by dropping a new task on it, or by pasting another task over it.
l l Click on the task or branch you want to delete, and press the Delete (or "Del") key on your keyboard. Right-click on the task or branch you want to delete, and select Delete from the menu. When you remove a branch, all the tasks located in that branch are also deleted. When you delete a task, only that task is deleted. Note You cannot use the Delete option to remove an input or output task, but you can rightclick on them and click Cut instead.
l All initial Input tasks have the Other tab which lists job infos and lets you back up the job file. 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. To cut and paste tasks or branches: 1. In PlanetPress Workflow Process area, select the task or branch you want to cut and paste. 2.
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 (in other words, before) the task or branch where you paste it.
To copy and paste the On Error properties of a task or branch: 1. Copy or cut a task or branch from which you want the On Error properties. 2. Select the task or branch where you want to paste the On Error properties. 3. From the Home tab in the Ribbon, choose Paste On Error (or right-click and select Paste On Error from the drop-down menu). 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.
3. Release the mouse button to drop the dragged item and release the CTRL key. The dropped task or branch is copied above the item over which it was dropped. When you move a branch, all its tasks are also moved. When you move a conditional branch, all the tasks appearing on the True side of the condition are also moved. Note You cannot drag a task or branch over an initial input task. Any input task that is dragged and dropped over an unknown initial input task will replace it.
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. Selecting Documents in Tasks Links The Properties dialog box of some action and output tasks let you select documents.
properties. 3. Click OK on the dialog. At run-time, if PlanetPress Workflow cannot find the document name generated by those variables, the task will fail. Highlight a Task or Branch The Highlight command lets you toggle the background color of selected tasks and branches. Note that the highlight color may be changed via the PlanetPress Workflow Configuration preferences. To highlight a Process Area square: l Use the mouse pointer to select a given square.
To redo a command: l From the Quick Access Toolbar, choose Redo. The Quick Access Toolbar PlanetPress Workflow Quick Access Toolbar is displayed, by default, on the right side of the PlanetPress Workflow button and provides one-click shortcuts to commonly used functions and features. You can add as many buttons as you want to the Quick Access Toolbar and remove them at will. 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.
The PlanetPress Workflow Ribbon The PlanetPress Workflow Ribbon centralizes commands, organizing them into a set of Tabs, each tab containing groups of controls. Each tab on the Ribbon displays the commands that are most relevant to a given feature set. The built-in Ribbon and Quick Access Toolbar contain commands that are frequently used and convenient to keep close at hand. You can minimize the Ribbon, and choose the position of the Quick Access Toolbar, as well as the commands it displays.
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. The Debug tab includes the Data, Debug and Debug Messages groups.
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 contains: l l l The Service Console button opens the The PlanetPress Workflow Service Console, allowing to monitor real-time information on the configuration execution.
Additional Information You can find additional information that complements the user manual about PlanetPress Workflow in the Connect knowledge base or the PlanetPress Suite knowledgebase.
Copyright Information Copyright © 1994-2018 Objectif Lune Inc. All Rights Reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any other language or computer language in whole or in part, in any form or by any means, whether it be electronic, mechanical, magnetic, optical, manual or otherwise, without prior written consent of Objectif Lune Inc. Objectif Lune Inc.
Legal Notices and Acknowledgements PlanetPress Workflow, Copyright © 2017, Objectif Lune Inc.. All rights reserved. The license agreements for the associated open source third party components can be found in the following installation folder: C:\Program Files\Objectif Lune\OL Connect\Legal Notices This application uses the following third party components: l l l l l l Adobe PDF Library which is either a registered trademark or trademark of Adobe Systems Incorporated in the United States and\or other
l l l l l l l l l l l l J2V8 which is distributed under the terms of the Eclipse Public License Version 1.0. The source code for J2V8 can be obtained from the following location: https://github.com/eclipsesource/j2v8 Jacob Java Com Bridge which is licensed under the terms of the GNU Lesser General Public License Version 2. The source code for this can be obtained from the following location: http://sourceforge.
l l l l l l l l l l l Logback which is distributed under the terms of the Eclipse Public License Version 1.0. The source code for Logback can be obtained from the following location: https://logback.qos.ch/download.html Mimepull which is distributed under the terms of the Common Development and Distribution License (CDDL) Version 1.1. The source code for this can be obtained from the following location: https://maven.java.
l l l XULRunner which is distributed under the terms of the Mozilla Public License Version 2.0. The source code for this can be obtained from the following location: http://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/latest/source/ zziplib which is licensed under the terms of the Mozilla License Version 1.1. The source code for this can be obtained from the following location: http://sourceforge.
l Apache Commons Pool l Apache Commons Text l Apache Commons Validator l Apache Commons VFS l Apache Derby l Apache Felix and dependencies l Apache Geronimo l Apache Jakarta HttpClient l Apache Log4j l Apache Neethi l Apache OpenCMIS l Apache POI l Apache ServiceMix l Apache Tomcat l Apache WSS4J l Apache Xalan l Apache Xerces2 Java Parser l Apache XMLGraphics l Apache XML-RPC l Barcode4j l Google Collections l Google GSON l Hibernate Validator l Jetty l LMA
l StAX l UCanAccess l XMLBeans Eclipse Technology: This Software includes unmodified Eclipse redistributables, which are available at www.eclipse.org. The Eclipse redistributables are distributed under the terms of the Eclipse Public License - v 1.0 that can be found at https://www.eclipse.org/legal/epl-v10.html. VSS Java FreeMarker: This product includes software developed by the Visigoth Software Society (http://www.visigoths.org/).
license from Oracle. “Commercial Features” means those features identified Table 1-1 (Commercial Features In Java SE Product Editions) of the Java SE documentation accessible at http://www.oracle.com/technetwork/java/javase/documentation/index.html. Further Components: l l l This product includes software developed by the JDOM Project (http://www.jdom.org/). Portions of this software are copyright © 2010 The FreeType Project (www.freetype.org). All rights reserved.
