User Guide Version: 8.
User Guide Version 8.5 Last Revision: 4/12/2017 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-2017. 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 8.
About Documents 44 Debugging and Error Handling 46 The Plug-in Bar 56 About Printing 58 About Processes and Subprocesses 71 Using Scripts 81 Special Workflow Types 127 About Tasks 172 Task Properties 173 Variable Properties 174 Working With Variables 535 About Configurations 544 About Related Programs and Services 548 The Interface 553 Customizing the Workspace 554 PlanetPress Workflow Button 563 The Configuration Components Pane 564 Other Dialogs 591 The Debug Informatio
The Message Area Pane 617 The Object Inspector Pane 619 The Plug-in Bar 620 Preferences 621 The Process Area 662 The Quick Access Toolbar 673 The PlanetPress Workflow Ribbon 674 The Task Comments Pane 677 Copyright Information 678 Legal Notices and Acknowledgements 679 Page 6
Welcome to PlanetPress Workflow 8.5 This PDF documentation covers version 8.5. 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. Working in conjunction with PlanetPress Connect, PlanetPress Capture, CaptureOnTheGO, PlanetPress Imaging, PlanetPress Fax, and a variety of plug-ins, it helps improve your communications processes.
Technical Information that may require specific knowledge to understand. Warning Information that is potentially critical to using PlanetPress Workflow. Pay close attention.
System Requirements These are the system requirements for PlanetPress Workflow 8.5. Operating System (64-bit only) l Microsoft Windows 2008/2008 R2 Server l Microsoft Windows 2012/2012 R2 Server l Microsoft Windows Vista l Microsoft Windows 7 l Microsoft Windows 8.1 l Microsoft Windows 10 Note Windows XP, Windows 2003 and older versions of Windows are not supported by PlanetPress Workflow.
Basics PlanetPress Workflow is a tool for the automation of the processing, the distribution and the printing of your business documents. Once installed on the server, it can be set up to automate all tasks related to document processing. Setting Up the Working Environment Setting up the working environment has to be done the first time you start PlanetPress Workflow. 1. Defining the printer (see Activate Your Printers). 2. Configure PlanetPress Workflow Services (see Workflow Services).
To add a PlanetPress Workflow startup process: l l In the Ribbon, go to the Home tab and click the Startup Process button in the Processes group. In the Configuration Components pane, right-click on any process or the Processes folder and select Insert Startup Process. Note You can only have one Startup Process in any given configuration and cannot add more.
If PlanetPress Workflow service is running when you send a new configuration, it stops and restarts automatically with the new configuration. If the service is stopped, it will not start automatically. To send a Configuration to the local server: 1. Open the configuration you want to use as a new configuration. 2. Edit the configuration, if required. 3. When the configuration is ready to be used, from the PlanetPress Workflow button, choose Send Configuration, then Send Local.
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.
Branches A branch is effectively a doubling of your job file. As your job file goes down the process, when it encounters a branch it will go in that branch, process all tasks up to the output, and return to the main trunk to continue processes. You can have branches within branches, and all branches must have an output. For more information on branches, see Branch. A branch is represented as a crossing . Conditions A condition will either execute the branch it creates or the main trunk, but never both.
Available Resources l Data Mapping Configurations: Displays a list of data mapping configurations used with the Execute Data Mapping task. Each of the templates have been sent from PlanetPress Connect using the Send to Workflow tool. For each template in the list, the following two items appear within them: l l l l l Data Model: Displays the data model used in the data mapping configuration. Double-click on the data model to view it in your default XML viewer (generally, Internet Explorer).
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 own folder: l datamapper contains archives of the data mapping configurations (.
For more information about Data, please refer to "Sample Data" on page 29. Note Null characters present in the data may not be displayed properly when using PlanetPress Workflow Configuration program, and that they may also be printed differently by different printers. To ensure consistency, you should consider filtering out such characters.
In the PlanetPress Workflow Configuration program, you use sample data files to create and edit 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.
You can add data selections to variable properties of your tasks either automatically using the data selector (See "The Data Selector" on page 24) or manually by typing in the data selection. Note It is strongly recommended to use the automatic method, as it returns precisely the same selections but is generally more reliable Text-Based Data Selections These selections are used for text data files such as Line Printer, ASCII and Channel Skip emulations.
Alternate Syntax @(line number, from column, to column) The alternate "quick" syntax lets you grab data from a single line from the first data page in the file. Here is a breakdown of the syntax (all options are mandatory): l @(): Always surrounds a data selection. l Line Number: The line from which to get the data. l From Column: the leftmost character position of the data selection. l To Column: the rightmost character position of the data selection.
Data Repository Lookups The Data Repository selections are made through the lookup function. Selections are done from the data located in the "Data Repository Manager" on page 613. The lookup function returns the value of a single key, which is always a string. Syntax lookup(group, return key, lookup key, lookup value) Here is a breakdown of the syntax (all arguments are mandatory): l l l l group: The name of the group in which to retrieve the value. Does not need to be surrounded by quotes.
l l Case Option: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent. l LowerCase: Converts all letters to their lowercase equivalent. Trim Option: Can either be "Trim" if you want to trim empty spaces before and after the data selection or "NoTrim" if you want to retain the extra spaces.
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, make data selections, and to stabilize your data. The Data Selector is divided in two tabs: Data and Metadata.
Depending on the chosen emulation and data file, the options in the data selector, the Sample data file section and the Data pane itself may change to accommodate your choice. The Line Printer, Ascii, Channel Skip and User-Defined emulations will display the default options (see the Emulation section) and a grid-like display of each character on each line. The following emulations however, will be slightly different.
the database. Each column represents a field returned by the query, with its field name as a row header. XML Emulation l XML data is represented in a tree structure which corresponds to the data in the XML file. Each node of the XML can be expanded to see the nodes under it. See XML Data Emulations. PDF Emulation l l l If you use a PDF emulation, the Data pane displays the data as you would see it in any PDF reader.
Metadata tab The Metadata tab allows users to either generate the metadata file for their active sample data file, or to associate an existing metadata file to their document. The Sample Metadata file name is the path to the metadata file describing the current sample data file. Buttons on the right can be used to load metadata from a file or to save the current metadata to a file.
The Search options defines how to retrieve the value of a given metadata element (attribute or field) when it is not present at the current metadata level. The possible search options are: l l Search from a specific location only. Search from level X to Job, where X can be any metadata level (Job, Group, Document, Datapage, Page).
The emulation that is used in your process can change during the process, and can be different than the one used in any PlanetPress Design document used in your process. PlanetPress Design documents use their own emulations, as defined in the document itself from PlanetPress Design. Emulations in PlanetPress Workflow: l Line Printer l ASCII l CSV l Channel Skip l Database l XML l PDF Warning PDF Emulation, also called Document Input, is only available in PlanetPress Workflow.
Workflow and how it treats data, you must understand how it is integrated into PlanetPress Design. This section covers issues relating to the sample data used to create your PlanetPress Workflow configuration and to the actual data that PlanetPress Workflow will send to PlanetPress Design documents. It is an important section which you should fully understand before you start creating your configuration.
To choose a sample data file: 1. Click the Debug tab in the PlanetPress Workflow Ribbon. 2. Click on Select in the Data group. 3. Use the Data Selector to choose your sample data file and emulation options. 4. Click OK on the Data Selector. PlanetPress Workflow also keeps the last 9 used data files in memory, which you can reopen to use in the same process, or a different one. To reopen a sample data file used previously: 1. Click the Debug tab in the PlanetPress Workflow Ribbon. 2.
your documents beforehand. Metadata structure Metadata in PlanetPress Workflow introduces the following concepts for adding information to a job: l Page: 1 side of a physical paper sheet. l Datapage: 1 atomic unit of content that produces zero, one or more pages. l l l Document: group of 1 or more ordered datapages intended to the same recipient from the same source (ex: invoice).
A single JOB can be composed of GROUPS of DOCUMENTS, which themselves are composed of physical PAGES produced by executing a PlanetPress Design document on one or more DATAPAGES. Metadata Elements Each metadata node (i.e. Job, Group, Document, etc.) is described with a series of elements, that is, system-defined attributes or user-defined fields holding static or dynamic information about the node they are attached to. Each element has a name and a value.
In addition to attributes and fields, each node of type group, document or datapage have a Boolean property called selected that indicates whether or not to produce the pages under that node. By default, this property is set to true for all nodes. Metadata Attributes Reference Here is a description of the Metadata attributes. The attributes are categorized as either Production, Finishing or Index/Count. Production attributes describe the production of the job and/or metadata (e.g.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge the data file used by the PlanetPress Design Document. Date Date the metadata was created in ISO format. Producti on X X X Time Time the metadata was created in ISO format. Producti on X X X Title Title of the source document. Producti on X X X Producer Name of the software that created the metadata. Producti on X X X Creator Name of the software that created the source of the metadata.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge device for which the metadata and associated data is intended. on Dimension Two floats separated by a colon indicating the media size in typographical points (ex: 612:792). Finishin g X X X X X Orientation "Rotate0", "Rotate90", "Rotate180" or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent. Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicate a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source. Finishin g X X X X X OutputBin Devicedependent identifier of the media destination.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge weight of the media. MediaColor Devicedepedent color of the media. Finishin g X X X X X MediaType Devicedependent type of the media. Finishin g X X X X X X X X X X X X X Index Index/C ount IndexInDocument Returns the Absolute index of the node within all the node under the parent Document. Index/C ount IndexInGroup Returns the Absolute index of the node within all the node under the parent Group.
Attribute Description Categor y IndexInJob Returns the Absolute index of the node within all the node under the parent Job.
Attribute Description Categor y SelectedIndexInDo cument Returns the Absolute index of the node within all the selected node under the parent Document. Index/C ount SelectedIndexInGr oup Returns the Absolute index of the node within all the selected node under the parent Group. Index/C ount SelectedIndexInJo b Returns the Absolute index of the node within all the selected node under the parent Job.
Attribute Description Categor y J o b Producti on X Gro up Docum ent Datap age Pa ge printing using a Windows driver. 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 PlanetPress Workflow includes a complete set of metadata-related functionality, which can be referred to as Metadata Tools.
Metadata Generation using Data Capture with PlanetPress Printer The Objectif Lune Printer Driver (PS) allows end-users to print directly to PlanetPress Design from any Windows application, by using the familiar File|Print option. At the other end, PlanetPress Design can capture the incoming stream and convert it internally into a PDF file along with its metadata. By default, capturing a document input using a PlanetPress Printer will generate a PDF along with its metadata.
The Metadata Selector allows to view and select metadata elements.
Metadata tab in the properties of a PlanetPress Design document allows to easily define documents or groups. Metadata Fields Metadata Fields in the properties of a PlanetPress Design document allows to easily define documents or groups. About Documents A Document is a file sent to PlanetPress Workflow by PlanetPress Design and is used to produce an output when merged with data. A Document can be an invoice, a report, a receipt or anything else, but by itself it is empty and without any variable data.
Import Documents This procedure describes how to import variable content documents created in PlanetPress Design. Importing documents can be useful when transferring configurations between PlanetPress Workflow installations. To import documents into PlanetPress Workflow: 1. Choose File | Import Documents. The Import PlanetPress Design Document dialog box appears. 2. In the File type box, select the desired file type. 3. Navigate to the document you want to import, select it and click Open.
Debugging and Error Handling This chapter touches on two subjects that are intrinsically linked, though their use is different. Debugging is the act of running through your process, either step by step or as a whole, directly from the PlanetPress Workflow Configuration Tool, in order to detect and resolve issues with your process. Error Handling, on the other hand, occurs when your configuration has been sent to PlanetPress Workflow services, and are running in "production" mode.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l A series of variables containing information about the error, the task that triggered it and the process that contained it. See "Standard Variables" on page 537 Note Local variables in the process are not sent to error processes, even if the error process has a variable of the same name. Accessing the Logs If your process is running live in PlanetPress Workflow service, you have two ways of seeing what is happening, now or in the past.
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 Plug-In Preferences" on page 641. To view logs for jobs that have already processed By default, the logs are available in the following folder: C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress 7\PlanetPress Watch\Log You can access this folder more quickly by using this procedure: 1.
Backup input files option, then type in a unique file name for the backup file (this should be variable). But if, for a given input task, you did select this option and something goes wrong and an original input file is lost or corrupted, you will have the option to use the Resubmit Job command to pull the backed up input file into the process. Granted that you have back up copies of the files polled by an input task, you may resubmit them as required.
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. In the list of backed up input files, select the file you want to resubmit. 5. Using the From page and To page boxes, select the data pages that you want to resubmit. If you want to resubmit all the data pages from the selected input file, enter 0 in both boxes. 6. Click Send to resubmit the data. 7.
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. In PlanetPress Connect: l Somewhere at the bottom of each document page, add a Data Selection object defined as a custom data selection that contains a reference to the job info variable sent from PlanetPress Workflow and a current page marker. You can use, for example, =&watch.
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 l Click on View as Text in the Data group of the Debug tab to view the current job file using a text editor (Notepad by default). Click on View as PDF to view the current job file in Adobe Acrobat if it is present (this will work only for PDF job files). Click on View Metadata to open the data selector and see the current state of the process' Metadata. Click on View as Hex to view the current job file in the internal Hex editor.
This method does not allow you to add, remove or move tasks, however. The second method can be used when that is required. l l 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.
Categories The default categories lists plug-ins according to what type of task each achieve. Therefore, when first starting your PlanetPress Workflow Configuration program, the following categories are used: l Inputs l Actions l Outputs l Data splitters l Metadata Related l Process logic l Connectors Note An Uncategorized category is dynamically created if your PlanetPress Workflow finds any plug-in that would not be part of the existing Plug-in bar.
Using the contextual menu displayed by the pop-up indicator, you can: l Insert, delete and rename custom categories. l Move categories up or down. l Import third party or legacy plug-ins. l Move plug-ins from one custom category to another (that you cannot move default plugins from the default categories, you can only copy them) l Copy plug-ins from one custom category to another by holding the CTRL key. l Delete plug-ins from any custom category by using the Delete key.
l Remote printing: l l l 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 65. 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 63. Windows Driver Printing: l The Print using a Windows Driver output task lets you send a job to any printer installed on the computer, using its own drivers.
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.
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 l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PlanetPress Workflow. Startup process: Select to make this process a startup process.
l Week of month / by date: Select the desired option for the time grid. Note that any selection you make in this box will be interpreted based on the selection made in the Month box. If you chose All months in the Month box and Last in the Week of month / by date box, then the process will run on the last week of every month. If you chose January in the Month box and First in the Week of month / by date box, then the process will run only on the first week of January.
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.
Activate or Deactivate a Process All processes are Active by default, but you may make any PlanetPress Workflow process Inactive as required. Because making a process active or inactive is a change in the configuration, to make the change effective you will have to send the edited configuration to your PlanetPress Workflow service (See "Send your Configuration" on page 11). To activate or deactivate a process: 1. Right-click the process in question in the Configuration Components pane 2.
If any task converted into a subprocess was previously using local variables, these variables must be removed or transferred to global variables or job information to be usable in the newly created subprocess. Import Processes from Another Configuration File You can import individual processes or groups of processes from a PlanetPress Workflow configuration file without having to import the contents of the entire configuration file.
configurations both include a startup process, the one in the imported configuration will become a standard process. Important considerations l l When importing a PlanetPress Workflow configuration file, your PlanetPress Design and PrintShop Mail document are not physically imported as they are not part of the configuration file itself.
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. Warning While this chapter provides some very useful and detailed information about scripting within PlanetPress Workflow, its focus is to inform you about the features, variables and functions unique to this environment.
Multiple APIs (methods of communicating with PlanetPress Workflow scripting tools) are available through the scripting engine, in all languages. l l l l l The Watch object is used to communicate with your current process and configuration. See "The Watch Object" on page 95. You can manipulate PDF files using the PlanetPress Alambic API. See AlambicEdit Library Reference. Note that the PlanetPress Alambic API is part of the PDF Tools.
Import and Export Scripts Both the Script Editor and XSLT Editor let you import and export scripts. Note When you import a script, it replaces any script currently displayed in the editor. To import a script: 1. In the editor, choose File | Import. The Open dialog box appears. 2. To import a script that uses a different scripting language or that was saved under a different file format, make a selection in the Files of type drop-down list. 3. Navigate to the script you want to import and select it. 4.
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. The last used string is displayed in the Text to find drop-down list box. 2. Set the search settings and options. l l l l l l l l Text to find: Enter a new search string or select a previous search from the drop-down list.
selection. When the search reaches the beginning of the script or script selection, the search finishes. It does not loop back to the beginning. l l From cursor: Select to start the search from the position of the cursor. Entire scope: Select to search the entire script or a script selection. The scope croplands to a script selection if you make a selection before executing the Find. 3. Click OK. The first matching string is highlighted in the script. 4.
l l l l l Selected text: Select to find matching text only within a text block you select. The text must be selected before you run the search. Forward: Select to search the script forward, from the location of the cursor or from the beginning of the script, depending on what you choose as the origin (From cursor begins where the cursor is currently located in the script, Entire scope begins from the beginning of the script or beginning of script selection).
To go to a line in a script: 1. Click anywhere in the Script Editor, then choose Search | Go To Line, or press Alt+G. The Go To Line dialog box appears. The last used line numbers are displayed in the Enter new line number drop-down list box. 2. Enter a new line number in the Enter new line number box or select one from drop-down list. 3. Click OK. Toggle Bookmarks Bookmarks help you identify and jump to specific places within your script (see "Jump to Bookmarks" below).
To jump to a bookmark: l From the editor’s pop-up menu, choose Go To Bookmark and a given bookmark number. If the bookmark you selected was displayed on a line, the cursor jumps to that line. SOAP Server API Reference PlanetPress Workflow offers a SOAP server API Reference allowing jobs to be submitted from third party application using the SOAP protocol. Remember that SOAP stands for Simple Object Access Protocol.
Arguments l l l File – base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64). SubmitJobInfStruc – Structure containing any required information to prepare the file for a valid insertion into a PlanetPress Workflow process. ReturnJobFile – Boolean value. When true, PlanetPress Workflow SOAP server returns the job file. When false, there no file is returned to the SOAP client.
Note To return the file, the process must be completed before the timeout of the server occurs. The Timeout option can be set in your PlanetPress Workflow preferences. SOAP API - PostJob Syntax PostJob (File, PostJobInfStruc , user name, Password) : PostJobResult Description The PostJob method allows users to remotely submit files to PlanetPress Workflow by using the Resubmit from here feature.
Note The task index can be retrieved by using the GetProcessTaskList method. See point GetProcessTaskList for details. Note The PostJob method can never return a file to the calling application. SOAP API - GetProcessList Syntax GetProcessList (user name, Password) : GetProcessListResult Description The GetProcessList function allows SOAP clients to request the list of available PlanetPress Workflow processes, based on their authentication credentials.
Note To obtain access to the complete list of processes for all users, the end-user must have administrator privileges. SOAP API - GetProcessTaskList Syntax GetProcessTaskList (ProcessName, user name, Password) : GetProcessTaskListResult Description The GetProcessTaskList function will allow a user to remotely request the tasks list of a process. This will be useful with the PostJob API since it needs a TaskIndex. Parameters l ProcessName – The Name of the PlanetPress Workflow process.
Note The TaskNames array will be sorted by the execution order of the process with the primary input of the process having an index of 1. SOAP API - GetSOAPProcessList Syntax GetSOAPProcessList (user name, Password) : GetSOAPProcessListResult Description The GetSOAPProcessList function will allow users to request the list of PlanetPress Workflow processes that contain a SOAP Input plug-in with the SOAP action name. This is useful when working with the SubmitJob API since it requires a SOAPActionName.
Note If a user has administrator privilege, he will have access to all processes and therefore he will see all the processes. SOAP API - PostJobInfoStruc PostJobInfStruc Structure containing any required information to prepare the file for resubmission into a PlanetPress Workflow process. l VariableList – Array of complex type, containing pairs of variable names and variables value. The list also contains the JobInfo variables.
l l VariableName – String l VariableValue – String OAPActionName – String containing the name of the Input SOAP task’s action name. The Watch Object PlanetPress Workflow scripting offers a number of methods of communicating with your process by means of PlanetPress Workflow automation object's methods and functions. The automation object is available in all 4 languages through their own syntax - the examples provided here are for VBScript.
Variable Name Description Example Usage (VBScript) "Watch.GetMetadataFilename" on page 101 Retrieves a string containing the job's metadata path and filename. This is useful when using the Metadata API in your script. Example Usage: str = Watch.getmetadatafilename "Watch.GetJobInfo" on page 102 Retrieves the content of a numbered job info (%1 to %9). Example Usage: str = Watch.getjobinfo(9) "Watch.GetVariable" on page 104 Retrieves the content of a local or global variable by name.
Variable Name Description Example Usage (VBScript) Example Usage: str = Watch.inputbox("Caption","Message","default") "Watch.SetJobInfo" on page 103 Writes the value of a string to a numbered job info. Example Usage: Watch.setjobinfo 9, "String" "Watch.SetVariable" on page 105 Writes the value of a string to a local or global variable by name. Example Usage: Watch.setvariable "global.GlobalVar", "Hello World!" "Watch.Sleep" on page 108 Pauses all processing for X milliseconds.
on Desktop" option must be enabled and you must be logged on as the same user as the PlanetPress Watch Service. Examples In the following example, showmessage() displays a dialog box saying “test message”. VBScript Watch.ShowMessage("test message") JavaScript Watch.ShowMessage("test message"); Python Watch.ShowMessage("test message") Perl $Watch->ShowMessage("test message"); Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line.
Flag Effect 0 Hide the execution window. 1 Display the window normally. 2 Display the window minimized. 3 Display the window maximized. 4 Makes the window visible and brings it to the top, but does not make it the active window. WaitForTerminate : A Boolean value that, if true, pauses the script until the command line has been fully executed. Examples VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true JavaScript Watch.
the job file, for example to replace data within it. If your script writes to this file, the modified contents will be used by the next plugin in your process. Example In the following example, GetJobFileName() retrieves the name of the job file, which is then logged using "Watch.Log" on page 106. VBScript Dim s s = Watch.GetJobFileName Watch.Log "The job filename is: " + s, 3 JavaScript var s; s = Watch.GetJobFilename(); Watch.Log("The job filename is: " + s, 3); Python s = Watch.GetJobFileName() Watch.
Python Watch.GetOriginalFileName() Perl $Watch->GetOriginalFileName(); Watch.GetMetadataFilename Returns the complete path and file name of the metadata file associated with the current job file. Example VBScript Watch.GetMetadataFileName JavaScript Watch.GetMetadataFileName(); Python Watch.GetMetadataFileName() Perl $Watch->GetMetadataFileName(); Watch.InputBox Warning Starting version 7.0, the Watch.
Clicking OK returns the value entered by the user. If no value was entered the default value is returned. Clicking Cancel returns the default value. You must enable the “Run on desktop” option for the PlanetPress Workflow process whose script calls Watch.InputBox. Otherwise PlanetPress Workflow application may stop working and require a reboot. Example s = watch.inputbox("caption", "message", "default") watch.showmessage(s) Examples In the following example,Watch.
Syntax Watch.GetJobInfo(Index: integer): string Example VBScript Dim s s = Watch.GetJobInfo(3) Watch.Log "Jobinfo 3's value is: " + s, 2 JavaScript var s; s = Watch.GetJobInfo(3); Watch.Log("Jobinfo 3's value is: " + s, 2); Python s = Watch.GetJobInfo(3) Watch.Log("Jobinfo 3's value is: " + s, 2) Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("Jobinfo 3's value is: " . $s, 2); Watch.SetJobInfo Sets the job information index to a specified string value. Syntax Watch.
Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.GetVariable Returns the string value of the corresponding variable name. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.GetVariable(Name: String): String Example VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.Log "MyVariable's value is: " + s, 2 s = Watch.GetVariable("global.MyVariable") Watch.Log "global.
Watch.SetVariable Sets the variable to a specified string value. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.SetVariable Name: String; Value: String Example VBScript Watch.SetVariable "MyVariable", "Desired value" Watch.SetVariable "global.MyVariable", "Desired value"/ JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); Python Watch.SetVariable("MyVariable", "Desired value") Watch.
Arguments StringToExpand —A regular parseable string that may contain system variables (%u, %f), user variables (%1 to %9), octal codes, and data selections. Example This example results in expanding the string of the variables to the date value in the following format: “YYYY-MM-DD”. VBScript Dim s s= Watch.ExpandString("%y-%m-%d") Watch.Log "Current Date is: " + s, 2 JavaScript var s; s= Watch.ExpandString("%y-%m-%d"); Watch.Log("Current Date is: " + s, 2); Python s= Watch.ExpandString("%y-%m-%d") Watch.
Level Type Text Color in Service Console 1 Error Red 2 Warning Orange 3 Information Black 4 Debug Grey Arguments Message—A string representing the message that is logged in the log file. Note that the text of the message must use the locale encoding of the system where the PlanetPress Workflow software will be running, otherwise it will be unreadable. Level—An integer between 1 and 4, specifying the severity level of the error message.
JavaScript Watch.Log("this is a log", 3); Python Watch.Log("this is a log",3) Perl $Watch->Log("this is a log",3); Watch.Sleep Pauses the process for the specified number of milliseconds. This can be used while waiting for something else to happen when the delay is known. Syntax Watch.Sleep Milliseconds: integer Example In the following example, sleep() pauses the process for 1 second (1000 milliseconds) VBScript Watch.Sleep 1000 JavaScript Watch.Sleep(1000); Python Watch.
Example This example will always return true, as the condition is static. It is, after all, simply an example. You get the idea. VBScript Dim everythingOK everythingOK = true if (everythingOK = true) then Script.ReturnValue = 1 else Script.ReturnValue = 0 end if JavaScript var everythingOK; everythingOK = true; if(everythingOK = true){ Script.ReturnValue = 1; } else { Script.ReturnValue = 0 } Python everythingOK = True if everythingOK == True: Script.ReturnValue = 1 else: Script.
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.
The term ... ... is the same as an Excel ... ... is the same as a Database ... Key Column Field KeySet Row Record Note Group and key names are case-insensitive. API Reference Obtaining an instance of the Repository Object JavaScript var repoObject = new ActiveXObject("RepositoryLib.WorkflowRepository"); VB Script set repoObject = CreateObject("RepositoryLib.
RepoObject.AddGroup("MyGroup","['FirstKey', 'SecondKey']"); Many methods require using the JSONStringArray type but JSON is not natively supported in VB Script. Therefore, for those methods, only JavaScript sample code is provided. There are many resources on the Web that propose ways of implementing JSON parsing in VB Script so you can implement whichever you see fit. However, using JavaScript is highly recommended.
Name Description values for the key, in all keysets for the group, are removed. Note that when the Group contains a large number of KeySets, this operation may take a while. 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).
Name Description 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. The method returns an array of the keyset ID's that were updated ( [1,2] ), or an empty array ( [] ) if no keysets were updated.
Name Description Condition may be left empty, in which case all keysets in GroupName are deleted. The method returns the number of keysets that were deleted. RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise. Note that this method is functionally equivalent to using RemoveKeySets() with its Condition parameter set to "ID=ID".
AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. Syntax AddGroup(GroupName: string, keyNames: JSONStringArray) Examples JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.AddGroup("Users", ''); 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.
AddKeySets Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues must exist otherwise an error is raised. However, it is not required to specify all available keys in KeyValues. Only the keys specified are updated in GroupName while unspecified keys are set to an empty string. Syntax AddKeySets(GroupName: string, KeyValues: JSONObjectArray): JSONIntegerArray Examples JavaScript repoObject.
repoObject.AddValue("Users", "LastName", "Smith"); VB Script repoObject.RenameGroup "Users", "LastName", "Smith" CheckRepository Verifies the integrity of the repository and recovers unused space left by deleted keysets. Similar to packing a database, the operation is non-destructive but it does require exclusive access to the Repository. You should therefore only perform this operation when you know for sure no other process is accessing the Data Repository.
GetKeySets Retrieves Keys values in GroupName for keysets that match Condition. When Keys is left empty, all keys are retrieved. When Condition is left empty, all keysets are retrieved. Syntax GetKeySets(GroupName: string, Keys: JSONStringArray, Condition: string): JSONStringArray Examples JavaScript repoObject.GetKeySets("Users", '["FirstName","LastName"]', "Gender='M'"); VB Script repoObject.
email for first user named Smith repoObject.GetValue("Users", "email", ""); // retrieves email for first user VB Script repoObject.GetValue "Users", "email", " LastName=""Smith"" AND FirstName=""John"" " // retrieves email for John Smith repoObject.GetValue "Users", "email", " LastName=""Smith"" " // retrieves email for first user named SmithrepoObject.
Examples JavaScript var repoObject = new ActiveXObject("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListKeys("Internal")); for (var Property in myList) { // Log all key names for group Users to the console Watch.Log(Property,2); } Sample return value '{"ID": "meta", "FirstName": "string", "LastName": "string", "email": "string", "DateC": "meta", "DateM": "meta"}' As shown in the sample, the value associated with each key name is actually the data type for that key.
Syntax RemoveKey(GroupName: string, KeyName: string) Examples JavaScript repoObject.RemoveKey("Users", "email"); VB Script repoObject.RemoveKey "Users", "email" RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise. Note This method is functionally equivalent to using "RemoveKeySets" on the next page with its Condition parameter set to "ID=ID". Syntax RemoveKeySetByID(GroupName: string, ID: integer): integer Examples JavaScript repoObject.
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. Syntax RemoveKeySets(GroupName: string, Condition: string): integer Examples JavaScript repoObject.RemoveKeySets("Users", 'Gender="M"'); VB Script repoObject.RemoveKeySets "Users", "Gender='M'" RenameGroup Renames group oldName to newName.
newName. Syntax RenameKey(GroupName: string, oldName: string, newName: string) Examples JavaScript repoObject.RenameKey("Users", "LastName", "SurName"); VB Script repoObject.RenameGroup "Users", "LastName", "SurName" SetValue Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition. The condition is specified using basic SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated.
MaritalStatus=""Married"" " repoObject.SetValue "Users", "FormOfAddress", "Miss", " Gender=""F"" AND MaritalStatus="""" " SetValueByID Updates KeyName with Value in group GroupName, where the keyset's ID matches the ID parameter. KeyName must exist in GroupName, otherwise an error is raised. The method returns the ID of the keyset that was updated or -1 if the keyset was not updated.
Syntax Version(): string Special Workflow Types PlanetPress Workflow supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility. However, some types of processes like PDF, HTTP and SOAP are important enough to pay some attention to them. This chapter will describe each of these special workflow types and give at least one example of an implementation that uses them.
SOAP Workflow As SOAP can be either a client or a server, two workflows will be presented. The SOAP Client workflow presents PlanetPress Workflow as the client and will explore how to retrieve WSDL information and how to make a SOAP request as a client. The SOAP Server workflow will show how to create a process that responds to SOAP requests, and where our own WSDL is located. PlanetPress Capture Workflow PlanetPress Capture, introduced in PlanetPress 7.
workflow. For more information, see the PlanetPress Design User Guide. Generating the Capture Patterns Once your document is created, the Capture Fields Generator action task is used to apply the capture patterns to each of your documents and send them to the printer. This printing process will consist of: l Retrieving your data file. l Creating metadata (See "Create Metadata" on page 447).
have a short polling interval set in their properties. Managing and Post-Processing There are a couple of things that can be done even after documents have been inked. As long as a document remains open, it is still present in the Capture database and be used in a process: l l The "Find Capture Documents" on page 436 input task is used to retrieve a list of documents under specific criteria.
Anoto Digital Pen A digital pen compatible with the Anoto system. These pens contain a camera, processor and memory chip which record each stroke of the pen on a printed Anoto Pattern, and are able to send this information back to PlanetPress Workflow. This document specifically refers to the Anoto DP-201 Digital Pen, not other equipment has been tested.
Client/Server Architecture A multi-server setup where more then one PlanetPress Workflow server are connected as clients to a single PlanetPress Workflow server which has a Capture Database. In this architecture, the Server contains the licenses for the pens, however the Client contains the database of documents and patterns. The Clients communicate with the server to authenticate pens. This architecture is only provided to simplify pen licensing for users with a large number of pens.
Pattern Sequence Pattern Sequences enable the multiplication of the number of available pattern by adding an extra identification to the document. A Pattern Sequence is also attributed to each Anoto Digital Pen, such as an incoming PGC file will contain the Pattern, on which the Pattern Sequence is added from the pen database. The pattern and pattern sequence refer to a specific document in the database.
PlanetPress Capture and its functionality. 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 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.
l l Also in MySQL, if a timeout occurs on simultaneous record access, resubmitting the PGC for processing should resolve the issue. In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue. Security Considerations PlanetPress Capture introduces new and efficient methods for digitally capturing the contents of ink laded out on physical paper.
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.
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". In a typical PlanetPress Capture implementation, a process in PlanetPress Workflow generates output (generally, this output is directly printed) and, at the same time, will "lock" one pattern for each page that it generates, if that page contains a pattern.
The example above actually uses numbers that are much higher than our typical PlanetPress Capture user. That is to say, a vast majority of our users will never have to worry about reaching the pattern limitation, unless their implementation is missing important parts, such as the "cleanup" process. But this also means a smaller minority of our users may require more than 20,000 patterns, so let's deal with this now.
Note It's very important to note here that the Anoto Digital Pen has absolutely no concept of Pattern Sequences. When "attributing" a sequence to a pen, this is fully on the PlanetPress Workflow side, in the Capture Database. This means that if a pen is mislabeled or someone picks up the wrong pen, this pen has absolutely no way to know that it is writing on the wrong paper. more about this in the Contamination section below.
eventually be closed by a manual or automatic procedure. However, the physical document with the pattern still exists even if it is closed in regards to the PlanetPress Capture database. Contamination would happen if a new document is printed with the same pattern, but somehow the "old" document re-surfaces and someone writes ink on it and docks the pen.
reverted. In implementations where the pen signs high number of documents, this can especially be an easy way to do this, as chances are the data will not match in at least one case. Conclusion l PlanetPress Workflow can only generate 20,000 unique patterns l One pattern is used (locked) for each page containing a pattern.
The PGC POST URL should correspond to your server name or IP, Port and the HTTP Action task of your HTTP Input, if that is what you are using. Example: http://127.0.0.1:8080/ProcessPGC Bluetooth Connectivity The Anoto penDirector program can also connect directly to the pen via wireless Bluetooth and receive PGC files directly through the Bluetooth link, without needing to dock the pen. To pair penDirector with an Anoto Digital Pen: 1.
1. Open penDirector. 2. Go to the Bluetooth tab 3. Click on the paired pen that you want to configure 4. Specify a PGC Storage folder 5. Check the PGC POST URL option 6. Enter the URL of your PGC handling process in the box 7. Click OK to save. PlanetPress Mobile Application The PlanetPress Mobile application can be installed on some mobile phones and enable fast and direct connectivity between the Anoto Digital Pen and PlanetPress Workflow.
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.
the next field. This can cause PlanetPress Capture to detect the ink as being present, and thus trigger whatever that field does. PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition".
An ICR Workflow The ICR engine in PlanetPress Workflow is used in conjunction with PlanetPress Capture, translating the ink from the Anoto Digital Pen into separate characters, or text, that is readable by the suite. Multiple components are required in order for the ICR to work: l l l l In PlanetPress Design, a Capture Field Object must be added and the Perform ICR option must be activated (See the Capture Field page in the PlanetPress Design User Guide).
Terminology and Definitions In regards to our ICR technology specifically, the following terminology applies: l l l l ICR: "Intelligent Character Recognition", or the engine that will read the pen data and attempt to recognize the text written using the pen itself. The ICR engine uses the path of the pen, its movement speed as well as the overall shape of each character to determine which character was written. ICR Value: The alpha, numeric or alphanumeric value that was determined by the ICR engine.
Using the Most Restrictive Mask l l Target: Form designer. What: In the Capture Options tab of a Capture object, the mask type indicates the type of character to be recognized. There are 3 possible selections: numeric, alphabet and alphanumeric. The alphabetic mask type allows you to select the letter case.
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 447 l "Capture Fields Generator" on page 422 l Print output PGC Handling Process The second process is the PGC Handling process. It receives data from the Anoto Digital pen, updates the Capture database and releases patterns as appropriate.
l "Get Capture Document" on page 441 l Archive or Print output Capture Post Processing Workflow Though the "Basic Functional Capture Workflow" on page 156 is minimal functional one, it will most likely not be enough for most actual implementations. The goal with PlanetPress Capture (and PlanetPress Workflow in general) being to automate as much as possible, there are some tools within the PlanetPress Capture tasks that can greatly help with this goal.
Task Breakdown: l l l The HTTP Server Input receives a POST request sent either by the Anoto penDirector or the PlanetPress Mobile Application. This requests contains information sent by the pen as well as a PGC file as an attachment. Because we're only concerned about the PGC, the task is configured to ignore the XML envelope as well as loop through each attachments (of which there is only one). So, the output of the task is the PGC file alone.
After Retrieving Information from the Capture Database There are two basic ways in which the Find Capture Document task can be used. First, in an automated process that runs at specified intervals. For example, the following process which sends a daily report of all incomplete and "in error" documents to an agent who would presumably take action on each document through the document manager.
Task Breakdown l l The Find Capture Documents task queries the Capture database for documents that correspond to certain specific conditions. For example, here we would look for all documents that are either in an "Error" or a "Partial" state, which means they received ink but are not completed correctly. To do this, the "Content Status" filter and setting it "Equal to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met".
3. Open the invoice.pp7 document and send it towards your local PlanetPress Workflow server (localhost or 127.0.0.1) 4. Open the configuration file CaptureExampleProcess.pw7 5. Click the PlanetPress Workflow button (File menu) and go in Preferences. 6. In the HTTP Server Input 2 section, check the Serve HTTP resources option, change the Resource action name box to static , and the Resource folder to c:\PlanetPress\http . Then, click OK. 7. Send the configuration to your local PlanetPress Workflow server. 8.
referred to as an "action", called from the browser itself. HTTP Server Input tasks are typically used in one of the two following situations: 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.
users generally frown upon being stopped for more than a minute, unless they are well aware of this processing time (and even then...) 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.
l Polling Interval (sec): This option determines how much time the HTTP Server Input waits between the moment it finishes processing a request and the moment it picks up a 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.
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. The very last file that is active when the process finishes is then returned to the HTTP service. 8. The HTTP service returns the file to the client and then closes the connection. 9.
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. This could also be an IP (192.168.1.123) or a full domain name (www.myserver.com), depending on the connectivity between the client and PlanetPress Workflow Server. l :8080 : The default PlanetPress Workflow HTTP Port, set in the preferences. l /getinvoice : The HTTP Action Name, as set in the HTTP Server Input task.
l l l It checks whether the invoice request exists by checking if the size of the file is less than 1kb using "File Size Condition" on page 358. The condition returns "true" if the file is not found: c:\PlanetPress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value,KeepCase,NoTrim).pdf Here, the xmlget() function grabs the invoicenum variable from the GET request, which would be INV999999.pdf in the specified folder.
Task Breakdown l l l The HTTP Server Input receives the initial request from the browser. Because this is a demonstration, a backup is made of the XML request. It's not suggested to do this every time, especially on servers receiving a large number of requests, as these files do take some amount of space for each request. A condition checks whether the form has been submitted, by verifying that one of the required fields is empty.
l l l l Modifying Metadata does not immediately modify the data. This is one of the benefits of Metadata because you can sort it, filter it, sequence it, add data to it, without ever modifying the data file itself. This is important because if you, for instance, filter out certain data pages from the metadata and then save your data file with the Send to Folder task, the full data file is saved, not the filtered one. This is resolved through different methods, used in the different examples below.
Daily Sales Report from PDF Files This workflow makes heavy use of both PDF Tools and Metadata, and assume that you are using PlanetPress Workflow version 7.3 or higher. This single process workflow generates a daily sales report for any sales rep inside of a company which made at least one sale. It does this by capturing the invoices generated within a specific day, putting all the invoices for each sales rep in a single PDF and then sending it to the sales rep.
l l l The "Metadata Sequencer" on page 465 acts like a splitter, where the separation happens whenever the Rep ID changes. Since documents are sorted with that field, each sequence can contain one or more document, but they will all be for the same Rep ID. "Create PDF" on page 260 is then used to generate a single PDF for each sales rep.
There are different types of tasks: l l l Input Task: Will either capture data from a specific location, or wait for input from a service or other computer to start processing. Action Task: Will manipulate the data in any number of ways. An action task is any task that is not an input or output task or a branch or condition. Output Task: Will output data to a specific location or send to a different service or computer.
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. This means that the property can be dynamically determined whenever your process runs, that is to say it will not remain static. This can be extremely useful when, for example, you want to determine how many copies you will print out depending on your data, or what document will be used in the printout depending on the department it came from.
into 4 items that provide variable properties: l Variables l System: Contains system variables, also called "Standard Variables" on page 537. l Job Info: Contains Job Info variables from %1 to %9 l l l l l l l l l Local Variables: Contains a list of local variables in this process. If no local variables exist, this item is disabled. Global Variables: Contains a list of global variables in this configuration. If no global variables exist, this item is disabled.
l l Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example. The lookup() function indicates a lookup in the "Data Repository Manager" on page 613. Unknown Tasks An unknown task is a task location that is not linked to any existing known task. Unknown tasks can have multiple causes: l l l l l Cutting an input or output task will replace it with an unknown task.
(yes, you can have mixed case in a file name but that's visual fluff - the OS itself does not care). Mask Format Here are the different mask formats available: l l Literal characters: Any alphanumerical character is considered literal character and must appear. For example, a mask of "trigger.txt" will not capture any other files than that name. Wildcards: Two wildcards are available in masks. l l l Asterisk (*): Supports any number of characters. *.txt would pick up any text file, file*.
l l Date are entered and displayed as yyyy/MM/dd (2007/06/13, for example). Times are entered and displayed using the 24 hour format as HH:mm:ss (3:38:54 PM, for example, is entered and displayed as 15:38:54).
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.
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. Secondary Input Tasks Secondary input tasks are placed in the process like an action task would and will replace the job file in the process with the file they retrieve.
Create File Create File input tasks are different from other input tasks in that they do not pull in data from a source location. The data that this task passes along to other task is its own: text or values from variables entered when the task was created or last edited. Since Create File input tasks are not dependent on data from external sources, they are performed at every polling interval and the process is thus started every time.
"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.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Email Input Email Input retrieves email data through a Microsoft Outlook or POP3 connection. Note If Microsoft Outlook connection is used, Microsoft Outlook 2000 or higher must be installed on the computer where PlanetPress Workflow is located.
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. If both the Message body and Attached files options are selected, the message’s body and the message’s attachment are treated as separate data files and processed one after the other. Unzip attached file: Select to unzip the attached files.
Login Tab l Use Microsoft Outlook: Select to use the Microsoft Outlook email account of the current user to receive emails. The current user is the one defined in PlanetPress Workflow Service Logon. l l Move message after processing to folder: Enter the name of an Outlook Folder to keep copies of the emails taken by this email input task. You should enter only the name of the folder as it appears in Outlook’s Folder List area, regardless of whether it is a child of another folder.
Job Information definitions l l %1 - Date received. Contains the date of the reception of the email (and not the date of retrieval by PlanetPress Workflow). The format is YYYY/MM/DD HH:MM:SS. %2 - Sender's name: Contains the name of the sender as defined by the sender himself (or, if the sender is using Exchange, by the name defined in his Exchange server). l %3 - Sender's address: Contains the email address of the sender as defined by the sender himself.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
Folder Capture Folder Capture input tasks retrieve files corresponding to a specified file mask, from a specified folder. Input Folder Capture 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.
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 Treat as regular expressions: When ticked, the contents of the Mask field are deemed to be a regular expression. The checkbox is not ticked by default. Please refer to Regular Expressions for more information. Note No Variable Data can be used inside this field if the Treat as regular expressions option is ticked.
"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.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
Folder Listing Folder Listing input tasks list the files present in a selected folder and gives you the option to use filename masks, to sort files by name or date, and to list the files present in the selected folder’s subfolders. The lists it generates are in XML format. Input Folder Listing captures nothing, however it does read the input folders (and, if selected, subfolders) and gathers information about each file in that folder.
644037 Note The
Job Information definitions l %1 - Folder: Contains the full path of the base folder from which the files are listed. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Output The output to this task is a series of individual files, one after the other. These files are not modified in any way from when they are captured from the source FTP server. Properties General tab l FTP Server: Enter the IP address or host name of the FTP server to poll. l User name: Enter the name of a user account on the FTP server. l Password: If account named in the User name box is password protected, enter the password here. l l Port number: Set to use a specific port number.
l Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically. l %2 - FTP Server: Contains the FTP address of the server from which the files were retrieved.
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 Suite Workflow Tools' 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.
Input This initial input task retrieves a single file as specified in the URL option. This file may be of any format, even formats that are not readable by PlanetPress Workflow. Processing No processing is done by this task. The file retrieved is not changed in any way. Output HTTP Client Input will output a single file which was retrieved from the web. Metadata is not generated by this task.
l Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l %1 - URL address: Contains the full URL that was requested by the task. This includes any GET variables in the URL. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Warning It is highly recommended to make all processes using the HTTP Server Input task self-replicating and to reduce their polling interval in the Process Properties. Input The HTTP Server Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received. Actually, it is the HTTP service that receives the requests and places them in a specific location on the drive.
If the Send Immediate Response to client option is selected, the response file is sent back right away and the involvement of the input task ends then. However, if this option is not checked, it means there is a second output that comes out of the HTTP Server Input task: The last output generated by PlanetPress Workflow is sent back to the initial input, which is returned back to the client. Note Starting in version 7.
example, "404 Not Found" or "401 Unauthorized". l Variable containing the response code: The contents of the job information or local variable selected in this drop-down, presumed to be a valid response code, will be returned in the response header. This is the value that is present at the end of the process, not the beginning. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Processing No processing is done by this task. Output The output of this task is the same as the input - a data file and job infos that are sent from a task that generated an error. 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 46.
the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
SOAP protocol. Using the SOAP tasks pre-supposes this knowledge and this documentation does not attempt to provide it. The Input SOAP Task only responds to a single SOAP action by the client: SubmitJob. Within this request however, a secondary action (SubmitSOAPActionName) can be specified - this is what the SOAP Action corresponds to in this task's properties. General Tab l SOAP Action: The SOAP action is used with the SubmitJob action. It’s the equivalent of the process name.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Properties General tab l LPD queue name: Enter the queue name specified in the printer queue on the remote computer or computers. "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.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Output A single PDF containing as many pages as all the combined input PDFs is generated. If the option is selected, this PDF is optimized. An optional metadata file is also created, containing information about the PDFs. This metadata is divided such that each PDF file is its own document, which can contain multiple data pages. General tab l l l l l l l l l Folder: Enter the full path of the folder from which the input files are to be taken.
captured PDF file. Within each Document, one Data Page containing a single Page is created for each page of the PDF file. Note Metadata can be manipulated with the Metadata Tasks, See "Metadata Tasks" on page 447. "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.
initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
"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.
l l l l l l l Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message.
SFTP Input The SFTP Input task retrieves files from a secure FTP site through an encrypted connection. Masks are typically used to select multiple files to be retrieved from the server. Input The SFTP Input connects to the specified FTP server and path, and retrieves a list of all files corresponding to the specified mask. These files may be of any format, even formats that are not readable by PlanetPress Workflow. The files are not deleted from the server when they are downloaded.
l Port Number Group l l l Use default port: Check to use the default port used by the protocol selected above. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another PlanetPress Workflow task. File Options group l Directory: Enter the path of the folder to poll on the FTP server.
l l l Approved Server list: Displays a list of servers that were approved for connection: l Server: The name of the server the certificate belongs to. l Fingerprint: The RSA fingerprint of the server. l Remove: Click to remove the server from the approved list. List of known servers: Displays a list of servers that were connected to, whether they are approved or not. l Server: The name of the server the certificate belongs to. l Fingerprint: The RSA fingerprint of the server.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
emails sent to it. This is due to a technical limitation that will be resolved in a future version. Processing The task reads the incoming SMTP request and provides the data within its body. Output Depending on the Data Location option, the output is different: l l Envelope: The request file in XML format, including all email fields (from, to, cc, bcc, subject, body) as well as additional header fields (email client information, attachments, etc).
l l “From” contains: Select to limit those messages used by this task to those that are sent from a specific address. The address you enter in the box below can include variables and wildcards. “To” contains: Select to limit those messages used by this task to those that are sent to a specific address. The address you enter in the box below can include variables and wildcards.
the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
l Description: PlanetPress Workflow displays the name of the service or process assigned to the port number entered in the Port box. Note that these are standard Internet Assigned Numbers Authority (IANA) descriptions. "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.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
WinQueue Input WinQueue input tasks capture print jobs received by a Windows printer queue. Note Before you go through the following procedure, on the computer running PlanetPress Workflow you will need to create a local printer queue that will be used to receive data files in the form of print jobs. This queue can be shared, so as to be able to receive jobs sent from local as well as remote users.
Properties General tab l l Printer queue: Select the PlanetPress Workflow printer queue (the one to which data files are going to be sent). Printer properties group l l Spool Print Job ins EMF Format (Advanced printing features): Select to create EMF files for Windows Print Converter action tasks (see "Windows Print Converter" on page 323). Note that this option must not be selected when capturing generic text type data.
Job Information definitions l l l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user un which a software sending the job was logged in under. %2 - Host computer: Contains the name of the computer from which the job was sent. %3 - Printer name: Contains the name of the printer in which the job was received. Is the same for all jobs received on any given printer.
l l l l 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 Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
process runs, that is to say it will not remain static. This can be extremely useful when, for example, you want to determine how many copies you will print out depending on your data, or what document will be used in the printout depending on the department it came from. Variable properties may include: l Static data. l Standard Variables. See "Standard Variables" on page 537. l Local and Global Variables. See "Manipulate Local Variables" on page 573. l Job Infos.
l Variables l System: Contains system variables, also called "Standard Variables" on page 537. l Job Info: Contains Job Info variables from %1 to %9 l l l l l l l l l Local Variables: Contains a list of local variables in this process. If no local variables exist, this item is disabled. Global Variables: Contains a list of global variables in this configuration. If no global variables exist, this item is disabled.
Unknown Tasks An unknown task is a task location that is not linked to any existing known task. Unknown tasks can have multiple causes: l l l l l Cutting an input or output task will replace it with an unknown task. See Cutting, Copying and Pasting Tasks and Branches Creating a new branch will create an unknown output task in that branch. See Adding Branches. Using Branch From Here... will create an unknown output task below that branch. See Adding Branches.
l l Literal characters: Any alphanumerical character is considered literal character and must appear. For example, a mask of "trigger.txt" will not capture any other files than that name. Wildcards: Two wildcards are available in masks. l l l Asterisk (*): Supports any number of characters. *.txt would pick up any text file, file*.txt would pick up any file starting with file and any characters: file1.txt, filetest.txt. Question Mark (?): Supports a single character. file?.txt would pick up File1.
Add Document The Add Document action task prepares a printer-centric PostScript job by adding a PostScript version of a selected PlanetPress Connect document and the trigger to execute it before the active data file. Input This task can support files in any emulation, however, the actual file that should be used is one that is compatible with the selected PlanetPress Design document. Processing This task takes the PostScript version of the document (.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Add/Remove Text Add/Remove Text action tasks can be used to perform the following actions on the data file they receive: l To add or remove characters. l To add or remove lines of data. l To add the content of a text file.
l l l l l l l Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file. Select Characters to add the string of characters entered in the Characters box to the beginning or end of the job file, or to remove a given number of characters from the beginning or end of the job file.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Advanced Search and Replace Advanced Search and Replace action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data.
search expressions that specify multiple data lines when this option is selected. l l l l String to search: Enter your search string or regular expression in this variable property box. To enter multiple strings or expressions, press Enter after each one (note that only one string can be entered in the Replace with box). Treat as regular expression: Select to specify that the string or strings entered above are to be interpreted as regular expressions rather than ordinary text strings.
the file. Select one of the occurrence options (described below) in the list box below and enter a value in the Occurrence value box besides it. l l l l l At occurrence: The replacement will take place only when the specified number of occurrences has been reached. Specifying 2 occurrences, for instance, means that only the second occurrence will be replaced. At every specified occurrence: The replacement will take place every time the specified number of occurrences is reached.
l l l l l l l Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message.
Barcode Scan The Barcode Scan task is used to convert barcode data from multiple image formats into text-readable information. This information is placed in the metadata and can be used by the rest of the process.
Barcode types Description EAN13 EAN13 symbology. Used with consumer products internationally, 13 characters. EAN8 EAN8 symbology. Short version of EAN-13, 8 characters. UPCA UPCA symbology. Used with consumer products in U.S., 12 characters. UPCE UPCE symbology. Short version of UPC symbol, 6 characters. Code11 Code 11 symbology. Used to identify telecommunications equipment Code39 Code 39 symbology. U.S. Government and military use, required for DoD applications Code93 Code 93 symbology.
Barcode types Description QRCode The QR Code (Quick Response Code) is a 2-dimensional matrix code. It can encode up to 2509 numeric or 1520 alphanumeric characters. PostNet PostNet symbology. Used by the United States Postal Service to assist in directing mail. RM4SCC RM4SCC symbology. Used by the Royal Mail. Note The fewer barcode types are selected, the faster the plug-in performs. Selecting only the expected barcodes is therefore a good practice.
l Process by: Select to define whether to process the image by page or by file: l l l l l Process by Page: The task is able to handle single or multiple page files (Tiff and PDF) and act as a loop to process each page independently and sequentially. The metadata file will be created separately for each page if it does not exist or will be enhanced with the values on processed Datapage level if it already exists. All supported images will be converted to tiff format.
initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
l l l l BarcodeValue: Metadata field representing the value of the barcode. When multiple barcodes are present on the page, this field is present multiple times. BarcodeCount:: Metadata field representing the number of barcodes on the page. Barcode_1_Value: Metadata field representing the value of the first barcode on the page. Note that this field (Barcode_1_Value) contains the same value as the first occurrence of BarcodeValue.
l When using a secondary input, a known issue of the Workflow Tool can cause some unexpected behavior, like having the same metadata file reused instead of a new one being created for each data file captured. To work around this issue, simply add a Rename action task to set a unique file name (Ex. %u) to each new file before the Barcode Scan task, after each secondary input.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Processing In the case of regular data files, these files will need to be merged with a PlanetPress Design document. In the case of a PDF data file, two things can happen. The PDF can be used as a data file for a Design document, or it can be part of a straight PDF workflow. When this is the case, this task will rather apply the active metadata to the PDF data file (see "PDF Workflow" on page 169 for more information on this).
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 Allow content copying: Select to let users copy content from the generated PDF files. l l l l Allow form filling: Select to let users enter information in the form fields included in the generated PDF files.
pages empty. Select Bookmarks and page to display the contents of the Bookmarks tab (you use data selection objects to create bookmarks in PlanetPress) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages. Select Full screen to hide all screen contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen. On Error Tab The On Error tab is common to all tasks.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
l l l l l l Monochrome images : l Compression: CCITT l Pixels per inch: 1200 Grayscale images : l Compression: Auto l down sampling : Bicubic l Pixels per inch: 300 Color images : l Compression: Auto l down sampling : Bicubic l Pixels per inch: 150 Security : l Allow printing l Allow changing the document l Allow content 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 Dat
can use a Create File input task as a dummy task at the beginning of your process, and then use a PlanetPress Workflow Database action task to gather your actual data. Technical Database Query action tasks require version 2.5 or higher of the Microsoft Data Access Components (MDAC), including JET 4.0. When adding a Database Query action task, you have two options: l l You can use static properties (properties that will remain the same regardless of the data processed at run-time).
Properties Database Connection tab l Database group l l l Table/Query: Select the table or query containing the information you need as your input data. Range group l l l Location: Enter either the path and name of the database or a database connection string in this box. You may click to navigate to the database and paste the database path and name automatically to this box. You may also click create an ODBC connection string to the data source and paste the string automatically to this box.
l l l Sort on field: If you want the table to be sorted before the data page creation process is started, select the sort field from this box. 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 Add a header record with field names: Select this option if you want the generated file to have a header record (a record that includes the field names only).
l l l l l l l l Sort on conditional field: Select this option if you want the table to be sorted using the field selected in the Create data pages as follows box before the data page creation process is started. Data encoding: Select the encoding used in the generated XML file. By default, this option is set to the default encoding of the computer used to create or edit the configuration. You may choose any encoding listed in the drop-down list or enter your own.
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.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Decompress File(s) Decompress file action tasks decompress zipped job files (files compressed as zip files).
l l Force directories: Select if you want to allow the system to create new folders when required. If this option is not select and the Decompress file action task tries to save a file to a folder that does not exist, the task will fail. Overwrite existing files: Select if you want decompressed files that have the same name as existing files to overwrite the existing files. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Differences between Digital Action and Image tasks: l l l Digital Action is an action task and cannot be the last task in a branch or process. Image is an output task, and has to be placed at the end of a process or branch. In PlanetPress Workflow 7.2.4 and older, Digital Action does not update the PlanetPress Search Database, even if a PDI is generated and even if the option is checked in the preferences. This behavior was changed starting in PlanetPress Workflow 7.3.
l l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Output type: Select the output file type that you want. l l l l l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PlanetPress Image. Note that some features, such as the Time and Date require that this option be selected. PDF: The output will be a PDF file.
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.
Job Options tab If you chose PDF as the output type in the General tab, use this tab to choose the appropriate PDF options. Note that all the options available in this tab are only used with PDF files. l l Job options: Select the PDF output option that best describes your needs. This loads all the standard settings for the selected usage scenario. These settings can be changed as required. Note that if you make changes and then select a different output option, your changes will be lost.
l l Monochrome images group l l l Keywords: You may enter keywords for the document. Since this is a variable property box, you may use variables and data selections and let PlanetPress Workflow interpret this information at run-time. Monochrome compression: Select the compression to use for the monochrome images. Flate compression is lossless, so no data is lost during compression.
l Color images group l l l l Color compression: Select the compression to use for the color images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs.
not have this password from opening the generated PDF files. l 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.
l l Subset: Select to embed only a subset of the Type 1 and TrueType fonts used in the document. A font subset is in fact composed of only those characters that are actually used in the document. This option can only be used if the Embed all fonts option is selected. Note that if more than 35% of the characters included in a font are used in the document, the entire font is embedded. This option often produces smaller PDF files and ensures proper PDF display.
l l l Use default database: Select to use the default database associated with your user profile on that SQL Server or Oracle database. Clear to enter the name of the database in the box that appears. 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.
Output A postscript file containing the necessary code to save the data file on the hard drive. Properties General tab l l l l l Hard disk name and path (as required): Enter the name and path of the hard disk to which the file is to be saved (enter “%disk0%/PPFiles/Resources”, for example, to save the file to the folder [ROOT]/PPFiles/Resources located on a hard disk identified internally as “disk0”). Leave blank to save the printer’s default hard disk and path.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. External Program External Program action tasks are used to launch and execute other programs, which can be useful when you wish to process your job file in a way that is not possible with the standard PlanetPress Workflow tasks.
Output If the external program modifies the job file using the full path, the modified file is the output of this software. Otherwise, the output is the same as the input. Metadata is not modified in any way. Job Infos may be modified, depending on the options set in the task's properties. Properties General tab l Program group l l l l l Parameters: Enter parameters that will be passed to the external program when it is launched.
l l l l Verify return value: Check to enable the group and react whenever specific exit codes are returned by the software. If exit code is: Use the drop-down to select how to compare to the exit code. This numerical comparison is either equal, greater than or lower than. Value: The numerical exit code that will be verified. Return: Use the drop-down to select whether this exit code should define a success or a failure of the external program.
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 Suite Workflow Tools' 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.
Processing The external file specified in the task's properties is loaded and replaces the current data file. Output The loaded file is output. Metadata is not modified in any way, neither are job infos. Properties General tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
Mathematical Operations The Mathematical Operations action task resolves a mathematical expression and stores the result in an existing job information or variable. Note When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False.
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. For example, to multiply Job Info 9 by 2, the expression would be %9*2 . Store result in: Variable data field containing the job information, local or global variable in which to store the result.
Output The modified XML data file is output. Metadata and jobinfos are not modified. l l File l Import: Lets you open an existing XSLT script from an XSL, XSLT or TXT file. l Export: Lets you save the current XSLT script as a file. l Print: Prints the current XSLT script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l Copy: Copy the current selection (only available if there is selected text in 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.
l Key set: Displays a list of keys for the selected group. l l l l l l l Key: Displays the key name in the group. Value: Enter a value for the key, which will be inserted in the KeySet. This value can be dynamic, including data selections, metadata selections, variables and other data. Update: Check to update the key with new data. For the Update column to be active, the Update base on option must be checked.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Rename Rename action tasks are used to rename the job files they receive. Note that you can see how each file is renamed via the Object Inspector when stepping through a process in Debug mode. Input Any job file, in any format.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. 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.
Properties The Script Editor menu options are as followed: 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 Copy: Copy the current selection (only available if there is selected text in the editor). l l l Paste: Paste the last selection that was cut or copied in the location of the cursor in the text editor.
l Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l l l The script editor text box: This is where you enter your XSLT Script that will be used. If you use an external script file, this will display the content of the file (note however that modifying the script in this case does not modify the external file and changes are not saved). Script running from: Choose if the script should be run from the editor text box, or from an external script file.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Search and Replace Search and Replace action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data. Note that this action task cannot be used with binary files. For more advanced search and replace functionality, you can also see "Advanced Search and Replace" on page 247. Input Any text-based file can be used in this task, even formats that are not directly compatible with PlanetPress.
l button: Click to add a new line to the list of words to find and replace. l button: Click to remove the currently selected line from the list. l button: Move the currently selected line up one position. l button: Move the currently selected line down one position. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Input Any image file that you wish to upload to the printer. Processing The currently active image data file converted to postscript. The image's resolution, scan orientation, and quality can be modified, depending on the selected option. All files are converted into PostScript format for storage on the printer. If a virtual drive, the file is automatically sent to it. Output A postscript file containing the necessary code to save the data file on the hard drive.
l Image compression level: Select the level at which you want images to be compressed. Values can range from 1 (compress up to 1% of the image’s original size) to 100 (do not compress). For example if you set this box to 75, the Image Downloader compresses all images by 75% when it converts those image to PostScript. The default compression level is 70%. l Send to Virtual Drive of: Select the computers and / or printers to which the images are to be sent.
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 Suite Workflow Tools' 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.
Note As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the Network Considerations page in the Advanced Configuration and Options chapter (Reference Guide, in English only). Input Any data file in any format. Processing A copy of the data file is saved on the hard drive at the specified location.
the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
l Value: Enter the value that you want to associate with the selected job information element or custom variable. l button: Adds a new line and lets you define the variable and value to set. l button: Removes the line that is currently selected (highlighted). l button: Moves the line up so it is processed before. l button: Moves the line down so it is processed after. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
In order to access and successfully use Web services, client applications must know how to get them, what operations they support, what parameters they expect, as well as what they return. SOAP servers make this information available via WSDL (Web Service Description Language) files.
l l l l l l l Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below. As script: Click to apply the options you chose above and to display information on the chosen Web service in JavaScript format in a script viewer. You should use this option if the Web service is too complex to be interpreted correctly by the SOAP Client plugin. Name: Displays the name of the arguments associated with the selected method.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Standard Filter Standard Filter action tasks can be used to remove HP Escape characters from data files, as well as to eliminate spacing problems caused by LF-CR end-of-line sequences.
Properties General tab l l Process job using ASCII emulation: Select to use the ASCII emulation to process the job file. This reverses LF-CR end-of-line sequences that may result in unwanted double-spacing. Remove and convert HP escape characters: Select to filter HP escape character sequences from the job file. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l l l 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 Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
Technical You can create your own translation matrix files for the Translation Action Task by adding them to the following folder: %CommonProgramFiles%\Objectif Lune\PlanetPress Workflow 7\Plugins\Translator Two examples are already present, converting ASCII to and from IBMEBCDIC.
l Default character on translation: You may enter a character to be used to replace all those characters that cannot be found in the source encoding. If you leave this box empty, they will be simply stripped from the data, so you may consider using a space as a place holder for unidentified characters. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
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.
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. l l Word distance: Indicates the largest acceptable distance between two text passages, so that they are still recognized as belonging together. This the factor the font's mean character width is multiplied with.
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. This will prompt the task to perform the second phase of the process, and thus convert the XML file to a Line Printer file.
Warning Splitters do not modify the metadata that is currently active within your process. This means that, if you are intending to use metadata along with a process using splitters, you can either use the "Metadata Sequencer" on page 465 instead of a splitter, or (re)create the metadata after the splitter. About Using Emulations with Splitters When an emulation is used with a splitter action task, the job file is emulated, cut to pieces and de-emulated.
l l l l With most emulations, if a file is split on a form feed, the form feed will not be appended to the output file. With the ASCII emulation, tabs within the input data file are replaced by spaces (the number of spaces is determined within the configuration of the emulation). With the ASCII emulation, if the Remove HP PCL Escapes option is selected, the data coming out of the splitter will have no escape sequences. The Goto column option of Channel Skip emulation is not supported.
The following options are only displayed when the Field value change or the Field value condition option has been selected at the top of the dialog box. l Field: Enter the name of the field upon which to base the splitter condition. Note that you can use the popup menu's Get Data command to select the field and populate this box automatically. The following options are only displayed when the Field value condition option has been selected at the top of the dialog box.
l Maximum pages per file: Enter the maximum number of pages to include in each file. Enter 0 for no limit. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
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. Properties General tab l Split data file on emulated page group: Select to split the data file based on pages (rather than on a word found within the emulated data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place.
l l l Match case: Select to force the splitter to match the character casing. Note that this setting applies both to the Specific Word and Word change options. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Trim selection: Select to force the splitter to strip empty trailing characters.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Properties General Tab l l l l l l Split data file on: Use this box to choose the item on which top split the file. The options available depend on whether or not the Use emulation box is checked (see below). Use emulation: Check to emulate the data before splitting the file. This lets you split the file on a word, a word change, a page number, a database field value or a database field change.
after the string. 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.
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. l l Split when condition found: You may not want to split the file every time the string of characters entered in the Value box is found, but only every other time, or every third time. If so, enter the number of times in this box.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. In-Stream Splitter In-Stream Splitter action tasks are used to split non-emulated data files into multiple data files that are passed to subsequent tasks in the process.
this option, the coordinates of the data you will select will be added to the From column and To column boxes below. l l l l l l l From column: Enter a value corresponding to the first column in which the splitter must start searching for the word. To column: Enter a value corresponding to the last column in which the splitter must start searching for the word.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
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. Output Multiple data files, sent one after the other to the rest of the tasks in the process.
l 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 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. Split PDF file based on Metadata group: l l Metadata Level: Determines on which level of the metadata the split occurs. This can be Group, Document to Data page.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
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 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.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Warning Branches, loops and conditions do NOT modify metadata in any way. Furthermore, even if a branch does a backup of jobinfos 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. As your job file goes down the process, when it encounters a branch it will go in that branch, process all tasks up to the output, and return 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.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
Comment Comments can be used to clarify your process either for yourself or others, to explain branches and scripts, or add information for anyone editing the configuration in the future. Comments do not open, modify or otherwise process the job file in any way, and are simply ignored at runtime. 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.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. 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.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l Use original Data Stream every time: Select to reuse the original job file received by the Loop action task at every iteration. If this option is not selected and if the process ends with Printer Queue Output task, for example, the second time the Loop action task will be performed, it will use the PostScript file generated by the output task. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
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 108 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. For more information, see On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
drop-down to list existing processes. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Properties General tab l Parameters group l l l l l l l Community: Enter the community name for the printer or other SNMP compliant device you want to monitor. A community acts like a combination of a user and password granting you access to an SNMP device. Depending on the community name, the device knows what rights to grant, for example, read-only or read-write. Community names serve as a form of organization and security used with SNMP.
l l Detected error: Select a specific non-critical or critical alert. Note that this box is only displayed if you selected either Non-critical alert or Critical alert in the Alert Status box. User Defined (displayed when User Defined is selected in the Condition Type box) l MIB OID number: Enter the Management Information Base Object Identifier corresponding to the object you want to test. Vendors of SNMP compliant devices sometimes list MIB OIDs in their documentation.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. 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. You can, for example, search for the string “Gold member” on the first line of the job file.
l l l l l l l Numeric comparison: This option is not displayed when either “Is found” or “Is not found” is selected in the Operator box. Select to convert the strings from the String and Comparison string boxes to their corresponding numeric values before performing the comparison. If you chose an operator that compares numeric values, you should select this option. On numeric error: This option is only available when the Numeric comparison option is selected.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
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 l l l 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 Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
Properties General Tab l Register Job to the SureTrac Server group: Check this option to enable the group. l l l l l Process Verification Job Name: The SureTrac job that this PDF should fall under. Use the button next to the list to retrieve a list of available SureTrac jobs from the server. Mailrun ID: A unique identification for the current job. This ID must never be the same between two mail runs - we suggest using either %f or %u , which are both always unique as they are based on date and time.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Input from SharePoint The Input from SharePoint task can be used to retrieve files from a SharePoint server on your network, filtering on your template fields and creating metadata to use in your process. When the Input from SharePoint task runs, it first lists all of the files to download then runs the process once for each file in the list. If any new files are added during the process, they will not be touched until the next time the process is scheduled.
Properties General Tab Note For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab. 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.
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. Domain: The active directory domain for the logon credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Laserfiche Repository Output Laserfiche Repository Output task publishes files - and optionally sets index values - into a Laserfiche server.
Task Properties General Tab l Laserfiche configuration group l l Folder: Enter the Laserfiche client repository folder where the documents will be exported. The user can specify the remote folder by clicking the Browse… button. Note: If the Folder field is empty, the documents will be exported by default to the root folder Import Format group l l l l l l l Laserfiche Pages: Converts all images files (*.bmp, *.gif, *.jpeg, *.pcx, *.png, *.tif, *.tiff, *.
l l Password: The password for the above user name. Test Connection: Click to verify that the information entered in this tab is correct and the server accepts it. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Lookup in Microsoft® Excel® Documents The Lookup in Microsoft® Excel® Documents action task is used to complement your job file's metadata by retrieving data from a Microsoft® Excel® spreadsheet on your system. The data retrieved is based on existing data in your metadata, and it will either be added to your metadata or will append or replace your existing metadata if it exists.
l l l Excel worksheet: The name of the worksheet you want to use. Once a workbook is open, this drop-down will automatically list all the available worksheets. Refresh button: If you have modified the original Microsoft® Excel® workbook to add a sheet, click this button to refresh the list of worksheets. Metadata group l l l Lookup Field: The name of the metadata field that will be used to determine which row should be returned. The Metadata field can be on any level.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Note Microsoft® Word® needs to be installed for this task to be functional and to test the connection. Input A compatible Microsoft Word Document (see notes). Processing The Word document is converted into a PDF file. If a Mail Merge is made, the mail merge is done in the document before the document is converted into a PDF file. The conversion is done through the use of a printer queue - the document is printed to this queue and the print job is converted to PDF.
Properties General tab l l Microsoft Word Document: Enter a Microsoft® Word® document or template, or click the browse button to navigate to the location of the document. The supported extensions are: *.doc, *.docx, *.dot and *.dotx. Perform Mail Merge: Check when providing a Microsoft® Word® document or template configured for mail merge. l l l l l l Use settings specified in document: Selected to instruct the task to use the connection string and SQL statements stored in the DOC file.
the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Output to Capture OnTheGo The Output to Capture OnTheGo task sends document information to the Capture OnTheGo online repository. These documents can then be retrieved by the Capture OnTheGo mobile application. Input This task ignores the input data file and any metadata it unless data selections are used in the variable data fields. Processing This task does not process the data or metadata file.
the PlanetPress HTTP Server or a regular Web server. l l l Cover Image: Enter the path to a cover image that is shown in the repository and library list, as well as the document property. The recommended image size is 512x512 px and is required to be in JPG or PNG format. Use the Browse button to locate an image on the local drive. The Cover Image is optional and, if omitted, displays a default image based on the file type.
OnTheGo Server, the process will go through and the listed categories will be added to the Server. Advanced Tab The Advanced tab is where you specify the document's time to live either in the repository or the user's device. l Document Handling Options group: l l l l Customize: You must check this box if you want the options included in this group to be used. When this option is not checked, the other boxes included in this group are faded.
l Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server. This tracking is done through the COTGDefaul.mdb database located in %ProgramData%\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\COTG , and includes most of the information set in this task, as well as information returned from the server. Output to SharePoint The Output to SharePoint action task can be used to send files to an existing Microsoft SharePoint server.
l l Mark the document as checked in: Sets the "Checked in" property of the document on the SharePoint server. Configure Fields: Opens the Configure SharePoint Metadata Fields dialog. Configure SharePoint Metadata Fields dialog This dialog lets you setup the information you want to assign to the SharePoint Metadata information. It contains one line for each field present in the SharePoint document library. l Field Name: Name of the field as set in SharePoint Document Library.
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. Domain: The active directory domain for the log-on credentials. This is not necessary if the SharePoint server is not part of a domain. User Name: A valid user name that has access to the SharePoint site and is able to read and write to document libraries.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
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 Plug-In Preferences" on page 649).
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 242, or a printer queue using a "Send to Folder Printer Queue" on page 66.
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. In order to generate an image in passthrough mode with external PostScript, please use the Digital Action task.
l l l l l l l l DPI: Enter the dots per inch (dpi) resolution of the output image. This property is enabled for all output types except PDF. Color depth: Enter the color depth of the output image in bits per pixel (bpp). The color depth is measured in bits, because each pixel of the output image can be described with a varied number of bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images.
l l Automatically Add Extension: Check if you want the correct extension for the image type to be appended to the file name automatically, rather than having to add it in the Filename box. The Output Type determines the extension to be used. Index group: This group lets you specify which type of index must be created for each document generated by this task. PDI files are used by PlanetPress Search as indexing information.
l l l l 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.
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. Select Subsample to use a pixel in the center of the sample area and replace the entire area with that pixel value. This method is significantly faster, but results in images that are less smooth.
files. l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l Allow content copying: Select to let users copy content from the generated PDF files. l l l l PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files.
alongside the PDF pages. Select Full screen to hide all screen contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen. PlanetPress Search Database tab If PlanetPress Workflow is configured to automatically update a PlanetPress Search database (See "PlanetPress Image User Options" on page 653), 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.
Login, Recipient, Attachments For the Login, Recipient and Attachment tabs, please see the "Send Email" on page 528 task properties. l PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Workflow. It is not available in older versions nor is it available in PlanetPress Office and PlanetPress Watch. PlanetPress Capture is a set of tools available in PlanetPress Workflow that enable output and input for interaction with an Anoto Digital Pen.
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. Processing The condition is evaluated using the specified rules, combination (condition is true when...) and scope (condition scope). Output The original data file and metadata is output by this task. If the rules used in the condition return True, the data and metadata is sent down in the condition's branch.
l l Condition based on Pattern Availability : Select to base the condition on the availability or non availability of patterns in a specific pattern sequence. l l l l Document is on error: Condition will be true if a logical error was triggered while processing the PGC. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc.
l Pidget setting: Triggered by specific pidget settings. l l Start timestamp: Triggered when the first ink is applied in the field. l l l l l l l l Before: If the first stroke found in the Capture Field was made earlier than the specified date and time, the condition becomes true. After: If the first stroke found in the Capture Field was made later than the specified date and time, the condition becomes true.
l ICR Resemblance: Triggered then the resemblance percentage the ICR engine gave to the ICR value in relation to its recognition database compares with the value determined in the "Resemblance" box, using the chosen comparison operator. For more information on ICR, see PlanetPress Capture ICR. l button: Add a new field and action line. l button: Remove the currently selected line.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Capture Fields Generator The Capture Fields Generator action task is used to generate Capture patterns in your job, which will then be printed for use with an Anoto Digital Pen. It also interacts with the Capture database and does some operations.
Processing The Capture Fields Generator action task uses an existing PlanetPress Design document containing Capture fields and assigns a unique Capture pattern to each printed page. The task then locks each pattern that it used so it cannot be reassigned to any other document. The whole job is then converted into a PDF file which is stored, without the patterns, in the Capture Database. This PDF file is later used by the "Capture Fields Processor" on page 426 to be merged with ink from the pen.
l l Output Format group l l l l l Custom: Use the title in the input field as set by the user. The field is variable so the title can be set on a per-document basis using data or metadata selections. Continue process with optimized postscript (no metadata): The job file coming out of the task will be a PostScript file that can be sent to any postscript printer or saved locally.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
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. It is strongly suggested to backup your PGC file before using this task and to create an error handling process to capture these errors. Logical errors do not cause this task to exit.
l l 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.
recognize letters, numbers and characters. For example, accented letters are not correctly recognized in the English ICR database. l l l l Fail if new ink is found on non-rewritable fields: Check to trigger the On Error tab if and when a field set as Disable Rewriting receives ink in a new session. Ignore out of bounds ink data: Check to continue processing even if receiving a PGC that causes ink to be outside of any Capture Field to appear. This may happen if updating the wrong document.
the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
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. Output One or more PGC file, separated as described above. Task Properties General tab l Pattern sequence group: Determines what Pattern Sequence will be assigned to each PGC file. l Type: Specify from where the Pattern Sequence should be taken. l l l l None: Do not use a Pattern Sequence.
l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced.
"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.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Output The data file generated by this task is an XML structure containing the data about each document. It also generates metadata that is compatible with post-processing tasks such as the "Capture Condition" on page 416 and "Get Capture Document" on page 441 tasks. Properties General Tab l Document-ID Based Condition: Select this option for this task to filter its results using a specific Document ID. l l Document ID: Enter the ID on which you want to filter.
l l l Pattern ID: The exact ID of the Anoto Pattern used. This is also called "Pattern Trace Code". Content Status: The status of the document as a whole. A document can be Empty (no ink), Partial (some ink but still open), Complete (all mandatory ink is present) or in Error (logical or process error). Operator: The choice of the condition operator.
l l l l l Condition: The condition or value the document needs to meet. The condition is variable dependent on the chosen filter. It can be a drop-down of values, an alphanumerical or numerical value. Add button: Click to add a condition row to the grid. Remove button: Click to remove the currently selected condition from the grid. To select a row, simply click on any of its 3 components.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Get Capture Document The Get Capture Document action task is used after the Capture Fields Processor to retrieve all documents that have been updated. Input A data file in PGC or PDF format that is accompanied by valid Metadata.
task. In addition, any ICR information available (when using PlanetPress Capture ICR) will be placed at the Page Level, as follows: l l ICR_[FieldName]_Val : The value of the text that was recognized by the ICR engine, for the field named [FieldName]. If the field is not and ICR field or if that field contains no ink, the value will be empty. ICR_[FieldName]_Cfd : The confidence value (in percentage) of the engine for the value provided.
l Capture Web Manager Workflow On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
each separate Pattern ID will generate a new page on which its ink is applied. Output A PDF file with a blank background and only the ink data found in the PGC file. Properties General Tab l PDF page size: Choose the page size of the output PDF. The default size is A2, and changing the format does not scale the digital ink. Ink appearing outsize of the selected page size will not be visible. Note This task was built using a custom plugin system and does not display the On Error tab in the regular view.
l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l l l l l l l l l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process. Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Metadata Tasks Metadata tasks regroups plug-ins that can create or update metadata for a job file. Metadata is a hierarchical structure describing a print job.
Technical In PlanetPress Design, this step is equivalent to a &metamode variable value of 1. Output The original data file is output, along with the newly generated metadata file. Job infos are not changed. Properties General Tab l l Documents: Select a specific PlanetPress Design document you want all the jobs metadata information generated for.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. 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.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Output The original data file is output, along with the modified metadata. Properties General tab l Action: Select the type of Metadata Field Management action to perform. 5 action types are available: l l l l l l Add/Replace: Create a new metadata field. If the name already exists, the value is overwritten with the new one. Duplicate: Create a new metadata field. If the fields already exist, a new instance is created. Append: Append the new value at the end of the current one.
(with a comma separator), interprets it as a thousand while interpreting 1.000 (with a dot separator), as one. l l l .: Treat every value with the dot (".") decimal separator. Commas (",") are treated as thousand separator. ,: Treat every value with the comma (",") decimal separator. Dots (".") are treated as thousand separator. Condition: Define criteria for the Metadata Field Management action execution. The condition must be TRUE for the action to execute.
l l l l 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 Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
Limitations l l l The name of the metadata field to add must adhere to these syntax rules: start with a letter, followed by zero or more letters, numbers, underscore or dash. The name is not case-sensitive. Metadata Fields Management actions on the page level are not possible since the entire task execution is based on the data page node. The task raises an error if the selected Metadata Fields Management action is Sum and if one of the field values is not numeric.
l l l Delete the current metadata file: Removes the active metadata from the process. Useful when using a secondary input task that does not automatically regenerates metadata. No metadata will be available until another task generates it. 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.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing Any metadata that does not correspond to the rules set forth by the filter are removed from the active metadata. Note that the metadata is still "present", but is disabled and ignored on all tasks that uses metadata afterward. Output The original data file is output, along with the modified metadata. 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 Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Special Considerations l l The task CANNOT re-select unselected nodes if the condition is false for those nodes.
Properties General Tab l l Document: Create a new Document level. Note: Attributes and Fields are deleted for all new Document levels created as well as existing Groups. Group: Create a new Group level. Note Attributes and Fields are deleted for all new Group levels created. l l Delimiter defines if the Condition parameter is triggering the beginning or the end of a Group or Document. If the delimiter option is set to None, the action is not performed.
l l l l l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked.
New Wild Card Since all metadata data pages, and possibly all physical data pages, are treated by the task at run-time in order to evaluate the condition at each level, it is necessary to dynamically define metadata as well as data selections to check all occurrences instead of a fixed one. To accommodate this requirement, a syntax modification is introduced in all current data and metadata functions (region(), @(), field(), xmlget()).
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.
(except, possibly, the last one, depending on the number of groups left in the last sequence). The next loop starts with the next group after this sequence. l l The following number of sequences in the job: Divides the metadata into a set number of sequences and equally distributes the number of levels between the sequences. For example, it the Metadata level is set to Document, and this value is set to 5, a 100 document job file will be divided into 5 sequences of 20 documents each.
When you click on either of the sort boxes, a small popup displays the following options: l l l Sort by: The drop down displays a list of available fields and attributes in that level, letting you select on which to sort. The field or attributes must be present for every instance of the level you are searching on, or the task raises an error. Order: Choose Ascending (orders like a,b,c, or 1,2,3) or Descending (orders like 3,2,1 or c,b,a) order.
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 Suite Workflow Tools' 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.
Input This task can use any data file, as long as it is accompanied by metadata. This metadata may have been directly generated or could be extracted from a PDF using the Embed and Extract PlanetPress Workflow Metadata task. Processing The metadata is read and PDF indexes are located. These indexes are defined in the PlanetPress Design document as data selections, in which the Archive / Email / Fax properties define the data as an index with a name.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Metadata-Based N-Up The Metadata-based N-Up action task works in conjunction with the PlanetPress Design tool's N-Up functionality.
General Tab l l Number of virtual pages that appear on each physical page: This is equivalent to the N in N-Up. This number should be equal to the total number of virtual pages in your PlanetPress Design document. For example, a 2 horizontal x 3 vertical is 6-up, so this number should be 6.
l l l l 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 Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values.
All In One The All In One action task is a combination of 4 different OL Connect tasks within a single one. This makes creating Print content faster and more easily, as the task is optimized for this specific purpose with less data exchanged with the server as well as multi-threading support. The task is build with 3 tabs that represent the 3 main steps of the creation of a Print Output: Data Mapping, Content Creation and Output Creation.
l Filter: l l l l l l l Switch conditions: Click to swap two conditions on the same level, or two groups of conditions. Delete the selected condition: Click to delete the currently selected conditions in the list. Clear the rule: Click to delete all rules in the list. Note: This cannot be undone. Import a rule: Click to open the Browse dialog and load a Rules file. This will load its rules into the list. Export the rule: Click to open a Save dialog and save the Rules file to disk.
l l l Template Names: Select the appropriate template name from the list. Adding templates is done from the Send to Workflow option in the Designer Module. Preview: Displays a preview of the output generated by the Print context of the selected Template. Not available for the PDF/VT or dynamic template names. Section: Use the drop-down or type in a variable name to execute a specific section.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Create Email Content Set The Create Email Content task generates a set of email content items from a template's Email Context, which are then sent directly to the recipient set in each record. Input This task must receive the information regarding a valid Record Set. This can be the output of the Create Record Set task, or a Record Set retrieved using the Retrieve Entities task. Processing This task loops through each record in the Record Set.
l Email information group: l l l l l Sender Address: Enter the email address that appears in the "From" field of the email. Mail host: Enter the address of the SMTP server through which emails should be routed. This information should be available from your IT staff. Send emails to sender (test mode): Check to ignore the email address from each record and send all emails to the address entered in the Sender Address field instead.
the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Properties General Tab l Job Preset file: Select which Job Preset to use to generate the job. To be used in this dialog, a preset must have been sent to PlanetPress Workflow using the Package File function in PlanetPress Connect. l l l 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" on page 504 task. "%o": Select to use a dynamic preset name.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
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. Output Management group: l l As defined by Output Preset: Select to send the output of the job to the location set in the Print Preset (file, printer, etc).
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Create PDF/VT The Create PDF/VT, similar to the Create PDF task, creates PDF/VT files from a PlanetPress Document. This PDF/VT is compatible with the Create Print Content directly without the use of a Connect Template (PDF/VT mode).
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Database. Properties General Tab l Template File: l 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 template is done through the Send to Workflow option in the Designer Module. Record ID: Enter a valid ID for a record.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
browser. Properties General Tab l Template File: l l l l l "%o": Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. Template Names: Select the appropriate template. Adding template is done through the Send to Workflow option in the Designer Module. Record ID: Enter a valid ID for a record. This record must be valid for the template used.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Output The output to this task is twofold. On the OL Connect Server side, a Record Set containing multiple records is created and saved. On PlanetPress Workflow side, metadata is returned with information about each record set. Alternatively, it is possible to ignore creation of the Record Set on the OL Connect Server and simply return an XML file containing the full Record Set structure. Properties General Tab l l l Data mapping configuration: Enter the full path to a valid data mapping configuration (.
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. On Error Tab The On Error tab is common to all tasks.
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 Suite Workflow Tools' 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.
Input The task requires a valid metadata file containing items for deletion, including Job Sets, Content Sets and Data Sets. These can be created by the Execute Data Mapping, Create Print Content and Create Job tasks. Job Sets, Content Sets and Data Sets are also valid when obtained using the Retrieve Items task. Processing All sets currently active in the metadata are set for deletion. Output The same metadata that is input.
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 The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
ID. l Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Properties General Tab l Metadata file: Enter the full path to a valid Job Metadata file, or use the Browse button to browse to a valid location. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing The task requests the items on the OL Connect Server using the conditions set in the task properties. Only the condition information and the return metadata are exchanged. Output The task outputs metadata that is equivalent to the appropriate task that would normally create the items (see the task properties for the list). Properties General Tab l Entity to retrieve: Use the drop-down to select which items to retrieve.
l Output Type group: l l Output IDs in Metadata: Select to only output minimal metadata containing the entity IDs. Output records in Metadata: Select to output IDs as well as record details in the metadata, useful for further sorting and filtering of the metadata. Commingling/Batching Tab 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.
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. On Error Tab The On Error tab is common to all tasks.
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 Suite Workflow Tools' 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.
l Add: Click to add a new line to the list. l Remove: Click to remove the currently selected line in the list. l Move Up: Click to move the currently selected line up one position in the list. l Move Down: Click to move the currently selected line down one position in the list. l Validate Names: Click to check the each of line in the list against the currently active Metadata. Metadata must be loaded in the Data Selector or through the use of the Debugging feature.
l Properties: Add all the properties to be added l Name: The name of the property. l Value: The value to apply to the property. l Add entry: Click to add another line to the Properties list. l Remove entry: Click to delete the currently selected line in the Properties list. l Move entry up: Click to move the currently selected line up in the Properties list. l Move entry down: Click to move the currently selected line down in the Properties list.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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 Tasks Output tasks are exits from PlanetPress Workflow processes. They can be used to send data to specific devices, such as printers, applications, such as email software, or locations, such as folders.
Processing The data file is either deleted directly or sent to the Windows Recycle Bin. Properties General tab l Move to recycle bin: Select to send the deleted files to the Windows recycle bin. When this option is not selected, files are deleted permanently. Examples & Use Cases This task is put into effect in the following use cases and example processes: l HTTP PDF Invoice Request l HTTP Brochure Request l Capture Web Manager Workflow On Error Tab The On Error tab is common to all tasks.
l l l l l l l Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message.
FTP Output FTP Output tasks send job files to other computers using the FTP protocol. It is similar to the Sent To Folder output task but sends to an FTP connection instead of a local drive. The following describes the properties specific to FTP Output tasks. Note that some FTP settings used for all FTP Output tasks are available via the PlanetPress Workflow user options (See "FTP Output Service User Options" on page 652). Input Any data file.
l Connection mode group l l Active: Select to prompt PlanetPress Workflow to use the active mode when sending files to the FTP server. Passive: Select to prompt PlanetPress Workflow to use the passive mode when sending files to the FTP server. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666.
l l l ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file. Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
In order to access and successfully use Web services, client applications must know how to get them, what operations they support, what parameters they expect, as well as what they return. SOAP servers make this information available via WSDL (Web Service Description Language) files.
l l l l l l l Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below. As script: Click to apply the options you chose above and to display information on the chosen Web service in JavaScript format in a script viewer. You should use this option if the Web service is too complex to be interpreted correctly by the SOAP Client plugin. Name: Displays the name of the arguments associated with the selected method.
l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Comments Tab The Comments tab is common to all tasks. It contains a single 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. Print Using a Windows Driver Printing Using a Windows Driver output tasks are used to send jobs to a local or network printer without going through a PlanetPress Workflow printer queue.
Properties General Tab l l l l Printer queue: Select the queues to which you want to send the output. Note that this is a variable property box, so you can use various schemes to use printer queue names that change with each job at run-time. Properties: Click to change the current printer queue properties.
Note Known issue: If a data file with metadata is resubmitted to such a process, the from / to page values set by the user in the Resubmit interface are ignored. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 666. By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification.
l l Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. Reset to defaults: Resets all options in this tab to their default values. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing If the data file is in a valid Emulation and a document is selected, the data file and document are merged to produce a PostScript output. The output may be an Optimized PostScript Stream or a Printer Centric stream (data file + trigger). If the data file is any file and the Pass-through option is selected, the file is sent as-is to the selected printer queue. Whether the queue will properly output depends on the capabilities of the queue and its target.
l l l l l l l l No balancing: No load balancing means that all the selected printer queues get everything. Split job: Split job means that jobs will be split according to the criteria set in the Page delimiter group (see below) and that an equal share of the job file will be sent to each one of the selected printer queues. For a hundred page job, for example, if two queues were selected, each one will get 50 pages.
not generate output. The On Error tab can be used to overwrite the default behaviors. l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
Properties Recipients tab l l l l l To: Enter the email address(es) of the recipient(s). Remember this is a variable property box and you can therefore use various schemes to use email addresses that change with each job at run-time. Cc: Specify addresses to which copies of the generated emails are to be sent. Bcc: Specify discreet addresses (other recipients will not be able to see these addresses) to which copies of the generated emails are to be sent.
To add the file to list displayed in the Attach box, you must the click the downward pointing arrow button. l l l l l Attach: Lists the files that will be attached to the messages sent from PlanetPress Workflow for this task. Selecting the Attach output file(s) option adds these files at the top of the list. Any other file that may have been added using the File box (above) is also listed here. Zip mode: Select how you want the files checked in the Attach box to be zipped.
l l l Server requires authentication: Select if the outgoing server mentioned above requires authentication. To use authentication you must enter information in the Account name and Password boxes below. Account name: Enter the name of the account that PlanetPress Workflow is to use to send emails via the mail server. Password: Enter the password associated with the account name entered above.
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 Suite Workflow Tools' 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.
The following describes the properties specific to Send to Folder output tasks. For information on those properties shared by various types of tasks, such as Other and On error properties, refer toConfigurations, Processes and Tasks. Input Any data file. Processing The file is saved in the location specified, as the file name specified. Properties General tab l l l Folder: Enter the path of the folder to which the files are to be saved.
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task.
All the variables in PlanetPress Workflow are considered strings, even if the information itself can be a number. There are no other types of variables (such as arrays, floating point numerical values or Boolean) in PlanetPress Workflow. Job Info Variables Job Infos have two main uses. First, they contain information on any job file that comes out of the initial input task or any secondary input tasks. The number of job infos as well as their definition can be seen in the Other tab of any input task.
l l Job infos sent to the document are global to that document, meaning the values do not change between data files. This means that if your data file contains multiple data pages for different clients, your job infos cannot be used to send information to the document. Job infos are in limited quantity and are slowly being deprecated when transferring data to your document. You should probably consider using Metadata, or Local Variables.
Variable Name Example value when interpreted %M Current Month (text) June %L Current Month (short text) JUN %d Current Day (numeric) 16 %D Current Day (text) Monday %l Current Day (short text) MON %h Current Hour 18 %n Current Minute 03 %s Current Second 41 %v Current Millisecond 24 %u Unique 13-char string (will be different every time it is used) 0ZIS4CW8U47VI00 %t Current Temporary Folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Wor
Variable Name Example value when interpreted name. %i Current Loop Iteration Index (always the innermost loop) 2 The %i Loop Count Variable In version 7.4, the %i variable is introduced. Its value is equivalent to the current iteration of loops inside of a process. It always contains the value of the innermost loop, and only certain tasks trigger the counter to start. Here is an example process and the value of %i during this process: Initial input tasks do not modify the value of %i.
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.
Manipulate Local Variables Note For information about Global Variables see Global Variables. Local Variables are set at the level of the Process and are not shared with any other process or instance of that process. Local variables can be used anywhere that accepts variables by using it's namee, surrounded by curly brackets and preceded by a percent sign (for example: %{myLocalVariable}).
l Type in the new name of the variable, then press Enter on your keyboard. While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it will not change the references in any script within a Run Script task. Deleting a variable, on the other hand, does not delete any reference to it.
2. Click Insert, then Insert Global Variable. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To add a global variable from the Ribbon: 1. Click on the Home tab of the PlanetPress Workflow Ribbon. 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.
You can set the value of a variable within your process in two ways: l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 312. l You can use Scripts. See the chapter "Using Scripts" on page 81. Variables may be used as variable properties in variable property boxes (see Variable Properties).
process that includes a "Folder Capture" on page 189 initial input task and a "Send to Folder" on page 532 output task. You can then edit and save your new configuration. To create a new configuration, choose New from the PlanetPress button. If the active watch file is currently opened, and if it includes unsaved modifications, PlanetPress Workflow asks you whether to send the configuration to the PlanetPress Watch service before creating the new configuration.
Saving and Sending Saving and Sending a 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.
When you use the Send command, the PlanetPress Workflow Configuration program uses the currently opened configuration to overwrite PlanetPress Workflow service's current configuration. If PlanetPress Workflow service is running when you send a new configuration, it stops and restarts automatically with the new configuration. If the service is stopped, it will not start automatically. To send a PlanetPress Workflow Configuration to the local server: 1.
Exit PlanetPress Workflow Configuration Program Once you are done using PlanetPress Workflow, you can close the configuration program. It is important to note that closing PlanetPress Workflow Configuration Program does not stop any of PlanetPress Workflow services or stop processing. You may exit PlanetPress Workflow Configuration Program in any of the following ways: l From the PlanetPress Workflow button, choose Exit.
PlanetPress Workflow are run as service applications. PlanetPress Workflow can thus use them as required without the need for any user interaction. Although you can manually start and stop any service running on your computer, most of the basic services used by the system are started and stopped automatically. In the case of PlanetPress Workflow and their related services, you typically use a command included in your PlanetPress Workflow Configuration program to start and stop most services.
instances. Each instance of PlanetPress Image can generate PDFs or images and dispatch them from the host on which it runs. See About Image. l l l l PlanetPress Fax: Outputs jobs as faxes. You use PlanetPress Fax as an interface to WinFax PRO or Windows Fax, to send faxes you create from documents. You can install multiple instances of the PlanetPress Fax service on your network, and have PlanetPress Workflowsend jobs to one or more of these instances.
Note The current PlanetPress Workflow status is always displayed in the lower-right corner of the PlanetPress Workflow Configuration program window. To start PlanetPress Workflow services via PlanetPress Workflow Configuration program: 1. Click Tools in the PlanetPress Workflow Ribbon. 2. Click Start Service in the Services Status group. A progress bar is displayed while your PlanetPress Workflow is being started. To stop your PlanetPress Workflow services via PlanetPress Workflow Configuration program: 1.
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.
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 563. 2. The Quick Access Toolbar. See " The Quick Access Toolbar" on page 673.
3. The Ribbon Tabs. See "The PlanetPress Workflow Ribbon" on page 674. 4. A Group within the Ribbon 5. The Process area. See " The Process Area" on page 662. 6. A specific link (aka a "component", "button" or "link"). 7. The Dockable panels including "The Plug-in Bar" on page 620, " The Object Inspector Pane" on page 619 and "The Debug Information Pane" on page 616. 8. The status bar. This displays your current software version and status of the PlanetPress Service. 9. The Configuration Components 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).
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 reorder tabs in a combined area: l At the bottom of the combined area, click the tab of the area you want to move, drag it to the left or right and drop it at the desired position.
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.
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.
Resize the Program Window Areas You can adjust the layout of the Program window by resizing one of the Program window areas. This also applies to resizing a combined area (see "Combine and Attach Areas" on page 556). To resize a Program window area: l Move the pointer to the edge of an area you want to resize to display the resize pointer, then click and drag to resize the area.
mapping used to convert back and forth the letters and numbers used by humans to the numeric characters used by computers). By default, codepage 1252 is used for Latin languages (good for Afrikaans, Basque, Catalan, Danish, Dutch, English, Faroese, Finnish, French, Galician, German, Icelandic, Indonesian, Italian, Malay, Norwegian, Portuguese, Spanish, Swahili and Swedish) and codepage 932 is used for Japanese.
l l l l l l Send Configuration: Sends the current configuration to the PlanetPress Watch service. See "Saving and Sending" on page 546. Close: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. Closing the current configuration is the same as creating a new one. Recent Documents: Displays a list of the 9 most recently opened configuration files. Click on any of them to open it.
l l l l Startup: Triggers whether the process is a startup process (runs before any other process). This option is only available if there is no existing startup process in your configuration. l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties, for scheduling and error handling. Subprocesses: Displays a list of subprocesses in your configuration.
l l l l l l Sample Data File(s): Displays a list of sample files that are included in the data mapping configuration. Double-click on a file to use it as a sample data file for the active process. Document Templates: Displays a list of templates that can be used in content creation tasks: Create Email Content Set, Create Web Content and Create Print Content. Job Presets: Displays a list of Job Presets that can be used in the "Create Job" on page 482 task.
l Text Test Page: Prints a text-only test page on the printer. l Properties...: Displays the printer queue properties. Note Deleting a component that is currently used by a process will cause this process to stop working and trigger an error, until the task that causes the error is removed, or changed to point to another existing component.
l l l l l l l Self-Replicating Process: Check this if you want the process to replicate itself in the background when multiple input files are received simultaneously. When this is checked, the input task polls its source once, determines the number of files to process, then replicates itself up to the maximum allowed and treats the files simultaneously. The initial process runs again once it has completed itself and replicates again as necessary, until all files have been processed.
l l Time division: Select the duration of each daily segment in the time grid. If you select 00:15, each segment will represent only 15 minutes and each day will be made up of 96 blocks (4 blocks per hour times 24 hours). If you select 24:00, each segment will represent an entire day. 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).
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.
Create 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. The defaults are configurable in the "Default Configuration Behavior Preferences" on page 625 screen.
Manipulate Local Variables Note For information about Global Variables see Global Variables. Local Variables are set at the level of the Process and are not shared with any other process or instance of that process. Local variables can be used anywhere that accepts variables by using it's namee, surrounded by curly brackets and preceded by a percent sign (for example: %{myLocalVariable}).
l Type in the new name of the variable, then press Enter on your keyboard. While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it will not change the references in any script within a Run Script task. Deleting a variable, on the other hand, does not delete any reference to it.
Convert a Branch to a Subprocess To allow for maximum flexibility and backward compatibility with the subprocess feature, the Convert to subprocess option lets users transform existing processes easily. This option is available whenever a Branch task is selected; right-clicking on it will display the contextual menu, which holds the Convert to subprocess option.
Global Variables are set at the level of the configuration file and are shared between all processes and tasks. Global variables can be used anywhere that accepts variables by using it's name preceded by "global." and surrounded by curly brackets (for example: %{global.myGlobalVariable}). Global variables are generally used to keep information that applies to multiple locations but need to be changed easily.
l Right-click on the variable name in the Configuration Components Area and click Delete. To rename a variable: l Right-click on the variable name in the Configuration Components Area. l Click Rename l Type in the new name of the variable, then press Enter on your keyboard. While renaming a variable will correctly rename all references to it in task properties or wherever else it is used in a task, it will not change the references in any script within a Run Script task.
l l l Document Templates: Displays a list of templates that can be used in content creation tasks: "Create Email Content Set" on page 479, "Create Web Content" on page 493 and "Create Print Content" on page 490. Job Presets: Displays a list of Job Presets that can be used in the "Create Job" on page 482 task. Output Presets: Displays a list of Output Presets that can be used in the "Create Output" on page 485 task.
The archives are saved using the template named followed by a timestamp. A maximum of 30 of each instance of a resource is kept (meaning if you have 10 different templates, a maximum of 300 files will be present in the archive\template folder). Older archives are deleted automatically as new archives are created. PPS/PSM Documents PPS/PSM Documents displays a list of PlanetPress Design and PrintShop Mail Design document that have been imported into PlanetPress Workflow.
l l l Document: The file name of the document, as entered in PlanetPress Design. This is the name of the file saved in PlanetPress Design, or the name you give it when you add a printer-resident document in your PlanetPress Workflow Configuration. It may have a PTK extension (if it has been sent to PlanetPress Workflow from PlanetPress Design), or a PS extension (if it is printer-resident). Version: The version of PlanetPress Workflow in which the document was originally created.
l l Document Update group (enabled only when using printer-centric mode and the document is on the printer) l l l l RAM: Select if the PlanetPress Design document is on the printer's RAM (Random Access Memory). Automatically update: PlanetPress Workflow will send a new version of the document to the printer automatically if the document has been changed since it was last used.
To view an attached data file: 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. Double-click on the data file to open the data selector. 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.
To view the Document Preview: 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 Open in PDF Viewer. 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.
associated with the queue. To assign documents to PlanetPress Workflow printer queues: 1. In the Documents group of the Configuration Components pane, select either a single document or a group of documents. 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.
keyboard shortcuts). If you simply wish to change the order in which objects appear in a category or group of the Configuration Components, refer to " Reorder Objects in the Configuration Components Pane" on page 588. 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.
l Let go of the mouse button. Using the clipboard buttons: l Click on the component you want to move. l Go to the Home tab of the ribbon. l Click the Cut button in the Clipboard group. l Click on the new location where you want the component. l Click the Paste button in the Clipboard group. Using the mouse contextual menu: l Right-click on the component you want to move. l Click on Cut in the contextual menu. l Right-click on the new location where you want the component.
Moving and Copying Details: l l l l l l When moving 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.
To rename a process, printer queue or group in the Configuration Components pane: 1. In the Configuration Components pane, right-click the name of an object or group and choose Rename from the pop-up menu. The name of the object or group is highlighted and ready to be edited. 2. Type the new name over the existing name and press ENTER. PlanetPress Workflow Configuration renames the object or group. To rename a resident document: 1.
within a group, this command has no effect. l To Bottom Level to move the item to the bottom level in the hierarchy. To alphabetically reorder objects in the Configuration Components pane: l Click the either a category (Processes, Global Variables, Documents, or Printer Queues) or a group l In the PlanetPress Workflow ribbon, go to the View tab. l In the Arrange group, select Sort by Name. Grouping Configuration Components Groups help you organize processes, documents, and printer queues.
To remove objects from a group: l Drag-and-drop the objects out of the group. The objects are removed from the group. If the group becomes empty, you are prompted to confirm the deletion of the group. To add selected objects to a new group: 1. Select multiple objects that are not part of a group. Press CTRL+G. A new group is added and the selected items are moved to that new group. To ungroup selected objects: 1. Select objects in a group. 2. Press CTRL+U.
In the case of documents, you are first prompted to confirm the deletion. You can turn off this prompt in the Notification Messages User Options. To delete a group of processes, documents, or printer queues: l Click a process group, documents group, or printer queue group, then press the DELETE key. In the case of process groups and printer queue groups, the group and all its members are deleted. In the case of documents, you are first prompted to confirm the deletion of each member of the group.
The printer list displays the following information l l l License Number: Reference number of the activation, linked to your customer account. Magic Number: The magic number generated by the printer. If the magic number is incorrect, your jobs will output with a watermark on that printer. Activation Code: The activation code generated by your license number and magic number. If the activation code is incorrect, your jobs will output with a watermark on that printer.
1. Click on the Tools tab in PlanetPress Workflow Ribbon, then click Configure Services. 2. Set the PlanetPress Workflow applications permissions as required: l l l Local System account: Select to run all the PlanetPress Workflow Services (including PlanetPress Workflow, PlanetPress Fax, and PlanetPress Image) under the Local System account. The Local System account is distinct from the Administrator account.
The account you choose will be used by PlanetPress Workflow and all its services, as well as by PlanetPress Fax and PlanetPress Image (only PlanetPress Messenger is not affected, since it always uses the Local System account). If you install PlanetPress Fax or PlanetPress Image on the same computer after performing this procedure, you will have to perform it once again, so as to choose the same account for all the installed applications.
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. Note that backups will only be kept for those input tasks that have the Keep backup file option selected and that they are required to resubmit input files.
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. While 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.
l l Description: A one-line box to give a title or short description to your process. Comments: A multi-line box to give more detailed information, for example the file format expected, explanation of the system in general. Advanced SQL Statement Dialog The Advanced SQL Statement dialog is available by clicking the Edit SQL button from the Database Query action task. You can enter a custom SQL query in this dialog, using the language supported by the database you select in the Database Query action task.
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. Technical Messenger communications (between different part of the PlanetPress Workflow) is limited to within the same Class C subnet. This means that PlanetPress Workflow on 192.168.1.23 cannot send a job to a PlanetPress Image on 192.168.100.54.
To manually add a new entry in 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.
Technical The format of the IP address must be one of the following: 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. l 192.168.0.42 : A single IP address. This can be any valid address on the same subnet. l 10.0.255.255: Any IP in the 10.0.X.X range. To automatically detect machines on the network and add them 1.
the first entry should be 255.255.255.255 with the Allow checkmark in the HTTP Input box. PlanetPress does not continue processing after it has found an "Allow" checkmark. There is no concept of "Deny", meaning if any "Allow" permission is given, there is no way to later remove it for certain IPs 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.
Note In order for the changes made here to be effective, you will need to restart the PlanetPress Messenger service. This can be done via the PlanetPress Workflow Service Console. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each user name entered in this dialog can have access to one or more processes.
To add a new SOAP user 1. Click on the button. 2. Enter the following information under the Username column for the new entry that was created: l l l User name: An alphanumerical user name for the user. Password: A password to protect the user. Note that the password will always revert to ******** (8 stars) when clicking outside of this box - that is normal and is meant to protect the length of the password as much as its contents.
service. This can be done via the PlanetPress Workflow Service Console. 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.
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.
To open the PlanetPress Workflow Service Console via the PlanetPress Workflow Configuration program: l Choose Tools | Service Console. A) The PlanetPress Workflow services monitored by the PlanetPress Workflow Service Console. B) The run-time information provided by the console. Note The log window only displays the 1000 most recent lines. Older lines are hidden as new ones appear to replace them.
To view the log messages generated by a service: l Click the service in question in Services pane, on the left hand side. A line appears to separate each log, and information from the newly selected service is displayed. To clear the Messages area of the PlanetPress Workflow Service Console: l Click in the Messages area of the Service Console, and from the right-click menu choose Clear. To save the information from the Messages area of the PlanetPress Workflow Service Console: 1.
To open the PlanetPress Workflow Service Console via the PlanetPress Workflow Configuration program: l Choose Tools | Service Console. A) The PlanetPress Workflow services monitored by the PlanetPress Workflow Service Console. B) The run-time information provided by the console. Note The log window only displays the 1000 most recent lines. Older lines are hidden as new ones appear to replace them.
To view the log messages generated by a service: l Click the service in question in Services pane, on the left hand side. A line appears to separate each log, and information from the newly selected service is displayed. To clear the Messages area of the PlanetPress Workflow Service Console: l Click in the Messages area of the Service Console, and from the right-click menu choose Clear. To save the information from the Messages area of the PlanetPress Workflow Service Console: 1.
Data Repository Manager The Data Repository Manager is an interface that managers the PlanetPress Workflow data repository. This feature, introduced in version 8.5, is a persistent data store used to save any sort of textual data in a table format. Feature Name Database Terminology Equivalent Description Group Table A Group is defined by its Keys (columns), and may contain 0 or more KeySets (rows) within it. Key Column/Field A Key is defined only by its name.
Warning Any change made within the Date Repository Manager is Immediate, and Irreversible. Deleting data from this interface may impact running processes if such processes access the data saved in the repository. This includes clearing a group, or clearing the repository. Toolbar Buttons l Group section l l l l l Delete Key: Click to remove the currently selected key in the group. This will remove the key and all the data for this key in each existing KeySet. Warning: This action cannot be undone.
l l l l Clear Group Data: Click to delete all the KeySets in the currently selected group, leaving the key definitions intact. Warning: This action cannot be undone. Clear All Data: Click to delete every KeySet of every group in the Repository. Warning: This action deletes all your data and cannot be undone. Clear Repository: Click to delete every group in the repository, including all their data. Warning: This action deletes all your data and cannot be undone.
Tip You can look up those shortcuts by right-clicking the item you want to interact with, and looking at the contextual menu. Virtual Drive Manager When you use the Send images to printer action in a given process, you have the option of, at the same time, sending the images to the virtual drive (a local storage folder used by PlanetPress Workflow applications) of any computer included in your network.
l l l l Job Information: Displays the Job Info variables, as well as the job's file name, size, last edit date and presence of metadata (see "Job Info Variables" on page 536). Local Variables: Displays all the variables local to this process (see "Manipulate Local Variables" on page 573). Global Variables: Displays all the variables global to this configuration (see "Manipulate Local Variables" on page 573). Evaluate Expression: Lets you enter a custom expression and displays its value at run-time.
Debug mode, the Messages area displays useful processing and error information. Messages are displayed in different colors (debug levels) in the Message area. l Messages in Red are critical and are normally critical errors in the plugin. l Messages in Orange are warnings. l Messages in Gray are job info and variable changes. l Messages in Black are debug information and processing information. There are various actions you can execute in the Message area.
The Object Inspector Pane The Object Inspector displays the properties of the object selected in the Configuration Components pane (not the Process Area, however). You can edit some of these properties directly from the Object Inspector, simply by clicking on the property.
The Plug-in Bar PlanetPress Workflow offer a constantly increasing number of plugins, while always allowing third party plug-ins to be installed and set up to be used by PlanetPress Workflow. The PlanetPress Workflow Plug-in Bar lists the available plugin in any of PlanetPress Workflow, and is divided into categories, which users can customize at will.
Settings & Customization The Plug-in bar can be customized according to your needs and the plug-ins you most frequently used. You can use the horizontal dark blue bar separating the plug-in area and the list of categories to change how many plug-in categories are displayed as the full-width bar with the title, and how much are displayed as the icon only. Move the bar up to display more full-width categories, down to display them more as icons.
Most of PlanetPress Workflow preferences are located in the PlanetPress Workflow Preferences window, accessible through the Preferences button in the PlanetPress Workflow button.
Note Preferences are saved automatically and applied immediately. Other Preferences and Settings l l The PlanetPress Workflow Services dialog lets you select the account that PlanetPress Workflow Service uses to communicate on the server and the network. See "Workflow Services" on page 592. You can change the appearance of the Run Script and XSLT Editor through the Editor Options dialog. General Appearance Preferences Ribbon Color Scheme l Blue: Sets the general interface color scheme to a blue color.
l Underline: Select to use an underlined font to display inactive processes. l Italic: Select to use an italic font to display inactive processes. l Strikethrough: Select to use a strikethrough font to display inactive processes. Object Inspector Appearance Preferences Colors l This window lets you set the color of individual Object Inspector elements. To change the color of a given element, select it in the list box above and then choose a color from the drop-down list below.
Options l l l l l l l Line Style: Select the style (dotted or solid) of the line that connects the different objects in the Configuration Components pane. Selection rectangle: Select whether your selection rectangle (used to select multiple objects by dragging a rectangle around multiple objects) will be displayed as a dotted line rectangle, or a blended rectangle (normally a blue rectangle with darker blue border).
Notification Messages Behavior Preferences Notification Messages behavior preferences control the display of certain messages and prompts within PlanetPress Workflow. Preferences l l l l l l l l l l l User mismatch: Select to have PlanetPress Workflow display a prompt when a different user opens the application. Task deletion: Select to prompt for confirmation when deleting a task. Document deletion: Select to have PlanetPress Workflow prompt for confirmation when deleting a document.
l l l l l l l l l l l Nothing to configure: Select to have PlanetPress Workflow notify you when you try to set properties for a task that does not have any properties. For example, the Error Bin input has no properties because it only inputs jobs sent to it through On Error properties of tasks in other processes. When you attempt to edit its properties, it displays the "nothing to configure" message when this option is selected.
l l l l l Prompt on Emulation Change: Select to have PlanetPress Workflow prompt when the default process emulation is being changed. The last emulation selected when debugging a process is the one the process begins with. Prompt on Form Refresh: Select to have PlanetPress Workflow prompt for confirmation when recompiling the PostScript (PSx) version of a PlanetPress Connect Document. Refreshing PlanetPress Connect Documents that are currently in use can lead to unexpected results.
Network Behavior Preferences Network behavior preferences let you Configure NetWare® Login user options, so that PlanetPress Workflow can access your Novell® NetWare network. The following procedure also lets you choose the Universal Naming Convention (UNC), which removes inconsistencies when accessing paths on Novell and other networks. Preferences l NetWare Login: Check to enable the options PlanetPress Workflow requires to access NetWare resources.
perform a context-free log in, or if you enter a server name in the Server box. PlanetPress Workflow and PlanetPress Image use the same security context when connected to a NetWare server and they each use one connection. Also note that using erroneous Tree or Context information may cause PlanetPress Workflow and its services to crash. PlanetPress Capture User Options PlanetPress Capture User Options lets you change the PlanetPress Capture options relative to your Workflow server.
l License Manager...: Click to open the "PlanetPress Capture License Management" on page 637 dialog. PlanetPress Capture Server/Client PlanetPress Capture can be set to be either in Server or Client mode from the PlanetPress Capture User Options. In Server mode, all pen licenses are stored locally. Other clients can connect to this server to validate pens. This allows all pen licenses to be managed locally. In client mode, no pen license information is stored locally.
l Pen user (by description): Search using the description field in the Pen Database. l Pen user (by serial number): Search using the pen's serial number in the Pen Database. l Pattern Sequence: Search using the Pattern Sequence in the Document Database. l l l l Template Name: The name of the document, corresponding to the name entered in the PlanetPress Design document properties. Pattern ID: Search using the pattern's identification number.
l More info: A variable column that displays additional information about the search results, such as the Pen ID or Pattern ID. l Select all: Click to select all the documents in the list. l Select none: Click to deselect all of the documents in the list. l l View documents: Click to view all the documents along with any ink already present on them. Each PDF is opened, in sequence, in the "PDF Viewer. Close documents: Click to close the document and release the pattern it uses.
Settings l l Name: Click to displays and choose from a drop-down of each DSN (Data Source Name) available on the system, along with it's source (User DSN or System DSN) and the driver it uses (database type). Type: Click to display a drop-down of supported database types. This must correspond to the database type of the DSN chosen in the previous option. l user name: If the database is secured with a user name and password, enter the user name here.
l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PlanetPress Workflow through an ODBC connection on the local network. Database file (mdb) must be local to the PlanetPress Workflow computer. It cannot be located on a network drive or another server. l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations.
PlanetPress Capture Pen Management Tool The Pen Management Tool screen is used to manage the pens that are registered in the PlanetPress Capture Database. The number of Anoto Digital Pens you may register on this screen depends on the licenses available within your PlanetPress Capture License. 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.
To register a new pen manually 1. Click on the icon 2. Enter the Pen ID (located on the pen after the word "Serial: ") 3. If necessary, enter an optional pattern sequence and User ID (identifier of who will use the pen). To register a pen using the registration pattern 1. 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.
registered in the Capture Database. When the number of pens have been reached, new pens can no longer be registered. If no pen pack is available, PlanetPress Capture functions in Demo Mode. In Demo mode, only one (1) pen can be registered in the pen management window. Also, the "Capture Fields Generator" on page 422 will be unable to produce more than 8 documents with a pattern instead of the full 20,000 patterns.
fragments, separated by a certain amount of space. Sometimes the text will be shifted up or down, spacing will be different, etc. In some cases, every letter is considered to be a different fragment. Text formatting features such as kerning, bold, exponential, etc, may cause these fragments to be considered as separate even if, to the naked eye, they obviously belong together.
Accepted values range from 0 to 1. The default value is 0.15, recommended values are between 0.00 and 0.50. Font Delta Height Defines the tolerance for the difference in average height of fonts in the two target fragments. The higher the number, the more difference in average font heights will be accepted. The average font height is bigger in text written in uppercase than text written in lowercase. At 0, the font size must be exactly the same between two fragments.
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 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 All events with details: Select to log everything that happens in PlanetPress Workflow. This includes when it starts and stops, the success and failure of tasks, and details on the success and failure of tasks. l Add time stamp to all processes events: l Delete log files after: Select how many days log files are kept before being deleted.
HTTP Server. Technical 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 in this dialog.
l l l Verbose log: Select to enable to keep a verbose log. Note that a communication log is generated whether or not this option is selected. If you use a secure connection, the log will contain extra information. Use PHP Arrays: Select to process incoming POST request with input arrays correctly. In the source HTML, input elements with names such as name="chat[input][name]" or name="items[][partnum]" will be correctly split as a single XML node along with each part of the array as children.
253 dent 361 341 dent 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. For more information on SSL and how to purchase a certificate, please see Q10694 on SSL.com.
The available HTTP Server 2 user options 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 it the path of the folder where your resources are located, or click the Browse button and choose the folder in the browse dialog.
Workflow installation folder. They are named lpddate.log, where date is the current date in the yyyymmdd numerical format. Note that changing this option also affects the log displayed in the PlanetPress Workflow Service Console. l l l l No source port range restriction: Select to remove any restrictions on the port of the LPR client computer that PlanetPress Workflow accepts data files from.
l l l l l l Data bits: Select the number of data bits defining the incoming data file on this serial port. The data bits transferred through a serial port represent the data content. This excludes the start, parity, and stop bits: these are bits defining the beginning and end of each unit of transferred data, as well as error detection provided by the parity bit. The majority of serial ports use between five and eight data bits. Binary data is typically transmitted as eight bits.
Preferences l l Log all Winsock and network messages (very verbose): Select to have PlanetPress Workflow keep a log of all Winsock and other network messages that occur from the Telnet input. These messages are related to files sent from other systems using a telnet connection. Since these messages can accumulate, you have the option of not logging them. Use Job Delimiters: Check this option if your Telnet input is a single stream that can contain multiple jobs.
to the one you set in WinFax PRO; a discrepancy between the two may result in WinFax PRO dialing incorrect fax numbers. Select Default to have PlanetPress Fax set the dial prefix, long distance prefix, area code, and fax number according to the content of the data selection, and send the result to WinFax PRO. WinFax PRO sets the dial prefix, long distance, prefix, and area code, and fax number to the ones it receives from PlanetPress Fax.
l l l Expand folder paths in UNC (Universal Naming Conventions) format: Select to have PlanetPress Fax use complete network server path names (\\servername\sharename\path\filename). This naming convention works well with Windows operating systems, Novell NetWare, and other operating systems when using a local naming system (such as the DOS naming system in Windows) would result in “File not found” error messages. Dialing options button: Click to set the appropriate options as required.
Captaris RightFax options l l l l l RightFax Printer: Select a RightFax printer. A RightFax printer is a fax driver that makes it possible to send faxes automatically. This printer will output faxes without prompting the user for fax addressing information. For more information, refer to Captaris RightFax documentation. Activation: Click to enter activation codes for the PlanetPress Image service installed on the same computer as PlanetPress Workflow.
l l Back up job on error: Select to move the job file to a local folder ftpPut\error if an error occurs while sending a job via the FTP output. This folder is relative to your install folder. FTP Port: Select the port number that you want PlanetPress Workflow to use for all FTP output tasks. The recommended port is 21 (the default setting).
l l l l l l l Error file: When enabled, sends an e-mail with an attachment of the offending file when an error occurs in the PlanetPress Image output task. Additionally, a backup of the job is created in the Error folder, which is located in the PlanetPress Workflow installation folder. Name or address not resolved: Select to send an email to the administrator when a name or address in the document selected to be used in PlanetPress Image cannot be resolved.
l l l l l Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory. This option is available only when you select Access database in the Database type box. Data source name: Enter the name of the computer on which the database runs. This option is available only when you select SQL Server database or Oracle database in the Database type box.
l l l l l l Name: Enter the name of the user sending the error messages to the administrators. Organization: Enter the name of the organization of the user sending the error messages to the administrators. Email address: Enter the email address of the user sending the error messages to the administrators. Reply address: Enter the reply address that recipients use to reply to the error messages.
l l l Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service. Error handling group l l l l No source port range restriction: Select to remove any restrictions on the port PlanetPress Workflow uses to send the job file via the LPR/LPD protocol. Clear to restrict the port used to send the job to one in the range between 721 and 731. Max.
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 "Send your Configuration" on page 11), 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.
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 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. Group undo: Select to set the undo feature of the Editor to undo the last group of editing commands entered.
l l l l l Double click line: Select to highlight the complete line of code when you double-click 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. Select to automatically copy the word under the pointer into the Text to find box when you open the Find dialog box. Clear to prevent the copy.
printable area of the page. l l l l l l Right margin position: Enter the position of the right margin indicator, in number of characters, relative to the left margin. For example, if you enter 80, the distance from the left margin to the right margin indicator is 80 characters. Use the drop-down list to select a previously-entered margin position. Gutter: Select to have the Editor display a gutter between the Commands and Code areas. Use the Gutter width option to set the width of the gutter.
l Attributes Group l l l Bold: Select to bold the element highlighted in the Element list box when it is displayed in the Script Editor. Italic: Select to italicize the element highlighted in the Element list box when it is displayed in the Script Editor. Underline: Select to underline the element highlighted in the Element list box when it is displayed in the Script Editor.
l " Undo a Command" on page 672 l " Redo a Command" on page 673 Zoom In or Out within Process Area You can do a zoom out in the PlanetPress Workflow Process area to see more tasks at the same time. In zoom out mode, you can perform the exact same functions as in normal view mode. To zoom in or out on the PlanetPress Workflow Process Area: 1. Click on the View tab of the Ribbon. 2. Click on Zoom Out in the Navigate group to zoom out, and Zoom In to zoom in.
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. When you add an output task, a new branch leading to that new task is added above the selected task or branch, except when replacing an existing output task. l Dropping a task on top of another one replaces it. l Dropping a task between two tasks will insert it at that location.
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. To replace an existing task with a new task, see Adding Tasks. To replace an existing task with another existing task or its properties, see Cutting, Copying and Pasting Tasks and Branches. Note You cannot replace a task by a branch or a condition. Trying to paste or drop a branch or condition over a task will insert it before the task instead.
Note You cannot use the Delete option to remove an input or output task, but you can right-click on them and click Cut instead. This replaces the task with an unknown task (see Unknown Tasks) To delete the path below a branch crossing (instead of the path to the right of the branch): l Press Shift+CTRL+Delete. l From the right-click menu, choose Edit | Delete| Delete Below the Branch.
l l l l Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output. Stop Process: The process is stopped and no more processing is done. No further output is produced. Log Message: Check this option to enable logging a custom error message in PlanetPress Workflow' log file. Message: Enabled only when the Log Message option is checked.
To copy and paste tasks or branches: 1. In PlanetPress Workflow Process area, select the task or branch you want to copy and paste. 2. From the Home tab in the Ribbon, choose Copy (or right-click and select Copy from the drop-down menu). 3. To paste the task or branch to a different process, select that process. 4. Select the task or branch crossing above which you want the task or branch to be pasted. 5.
Note You can only paste the properties of an input task on the initial input task of your process. Similarly you can only paste the properties of an output task on another output task. Also, you cannot paste the properties of a task on a branch and vice-versa. Note You can paste only the properties of the On Error tab of any task or branch on another one. 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.
3. Release the mouse button to drop the dragged item. The dropped task or branch is moved above the item over which it was dropped. To duplicate a task or branch, the same method applies but with a slight difference: 1. In PlanetPress Workflow Process area, click the icon of the task or branch you want to duplicate. 2. While holding down the mouse button, press and hold down the CTRL key and drag the icon task or branch over another task or branch. 3.
To disable or enable a task or branch: 1. In the PlanetPress Workflow Process area, click the icon of a task or branch. 2. From the Debug tab in the Ribbon, click Ignore. If the task or branch was enabled, it is now disabled, and vice versa. Resize Rows and Columns of the Process Area Resize the rows and columns of PlanetPress Workflow Process area in which tasks are located to better visualize the organization of your process. To resize rows and columns of the PlanetPress Workflow Tools Process area: 1.
Variable Document Name The Variable Document feature is used to dynamically determine which document is merged with the data in your output. The document name can come from any of the variable properties (see Variable Properties). Note If the data contains an extension, it will be replaced by .ptk. To use a variable document: 1. Click on the %o entry in the document list 2. Type the variable properties or use the right-click menu to insert the correct variable properties. 3. Click OK on the dialog.
To undo a command: l From the Quick Access Toolbar, choose Undo. Redo a Command The Redo command can be used to redo commands that were just undone using the Undo command. For example, if you used the Undo command three times in a row and immediately thereafter decided to redo those commands, you could use the Redo command three times in a row to redo those commands. Note that all commands in PlanetPress Workflow Configuration can be redone.
To move the Quick Access Toolbar below or above the Ribbon: 1. Right-click on the Quick Access Toolbar, or click on the downwards arrow at the rightmost end of the Quick Access Toolbar. 2. Click on Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon, depending on where you want it. Note The Quick Access Toolbar buttons cannot be moved or re-ordered. If you wish to re-order them, you will need to remove all the buttons and re-add them in the desired order.
l l l l l l The Printer Queues group contains controls to set up printer queues of any type, as well as replace any existing queues. The Arrange group contains the Group/Ungroup, Sort by Name and Order controls, allowing to reorder objects in the Configuration Components pane. It also includes the Undo/Redo controls, as well as a Rename control, to modify a given component's name.
l l l l l l l The Launch Upgrade Wizard control, used when migrating from a previous PlanetPress Workflow version. The Services Status control allows to start, pause and stop PlanetPress Workflow service. The Configure Services control loads the PlanetPress Workflow Services dialog to configure the user account PlanetPress Workflow should use. The Service Console button opens the The PlanetPress Workflow Service Console, allowing to monitor real-time information on the configuration execution.
The Task Comments Pane The Task Comments pane displays comments relevant to the currently selected items, such as the contents of the Comments tab of any task in the currently selected process. The Task Comments pane cannot be used to edit the comments themselves - only to see them. to edit the comments, the properties of the task must be opened, and the comments changed in the Comments tab.
Copyright Information Copyright © 1994-2017 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 downloaded here. This application uses the following third party components: l l l l l l l Apache Javascript Support (Rhino) version 1.7.3 which is licensed under the terms of the Mozilla License Version 1.1. The source code can be obtained from the following location: https://developer.mozilla.
l l l l l l l l l l l l JavaX Mail which is distributed under the terms of the Common Development and Distribution License (CDDL) Version 1.1. The source code for this can be obtained from the following location: https://java.net/projects/javamail/downloads/directory/source Jersey which is distributed under the terms of the Common Development and Distribution License (CDDL) Version 1.1. Information on how to obtain the source code can be found at the following location: http://repo1.maven.
l l l l l l l l Servlet API developed by Sun as part of the Glassfish project and licensed under the terms of the Common Development and Distribution License (CDDL) Version 1.0. Information on how to download the Glassfish source (as part of Java EE platform) can be obtained from here: https://wikis.oracle.com/display/GlassFish/Java+EE+7+Maven+Coordinates Spring Framework which is distributed under the terms of the Apache Software License Version 2.0.
l Apache Commons CLI l Apache Commons Codec l Apache Commons Collections l Apache Commons Configuration l Apache Commons DBCP l Apache Commons Discovery l Apache Commons FileUpload l Apache Commons Imaging l Apache Commons IO l Apache Commons Lang l Apache Commons Logging l Apache Commons Net l Apache Commons Pool 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 O
l Google Collections l Google GSON l Jetty l LMAX Disruptor l OPS4J Pax Web l org.json.simple l Spring Dynamic Modules l StAX 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.
This application uses Java Advanced Imaging which is part of the Java SE framework and platform and which is distributed under the terms of the Oracle Binary Code License Agreement for the Java SE Platform Products and Java FX. Copyright 2013, Oracle America ,Inc. All rights reserved. Use is subject to license terms. ORACLE and JAVA trademarks and all ORACLE- and JAVA-related trademarks, service marks, logos and other brand designations are trademarks or registered trademarks of Oracle in the U.S.
