User Guide Version: 8.6.
User Guide Version 8.6.1 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.6.
Accessing the Data Repository Where to find the Data Repository About Documents Import Documents Import PrintShop Mail Documents Debugging and Error Handling About Error Handling Using the On Error tab Creating and Using Error Processes Accessing the Logs Resubmit Backed Up Input Files to a Process Knowing What to Resubmit Debugging your PlanetPress Workflow Process The Plug-in Bar Categories Settings & customization About Printing PlanetPress Workflow Printer Queues Shared Printer Queue Properties Windows
The Watch Object Data repository API Stopping Execution Special Workflow processes PDF workflow PlanetPress Capture workflow HTTP Server workflow OL Connect Send workflow SOAP Workflow PlanetPress Capture Workflow Database Considerations (ODBC) HTTP Server Workflow PDF Workflow Capture OnTheGo Workflow About Tasks Task Properties Variable Properties Contextual Menu Unknown Tasks Masks Date and Time Format Input Tasks Task Properties Variable Properties Data Splitters Process Logic Tasks Connector Tasks Plan
About Configurations Create a New Configuration Open a PlanetPress Workflow Configuration File Saving and Sending Exit PlanetPress Workflow Configuration Program About Related Programs and Services Available Input Services Available Output Services Start and Stop PlanetPress Workflow Service The Interface Customizing the Workspace Dock and Undock Areas of the Program Window Show or Hide Areas of the Program Window Combine and Attach Areas Resize the Program Window Areas Change the Interface Language PlanetP
PDF Viewer The PlanetPress Workflow Service Console Update document Data Repository Manager Virtual Drive Manager The Debug Information Pane The Message Area Pane The Object Inspector Pane The Plug-in Bar Categories Settings & customization Preferences Other Preferences and Settings General appearance preferences Object Inspector appearance preferences Configuration Components Pane appearance preferences Default Configuration behavior preferences Notification Messages behavior preferences Sample Data behavi
Zoom In or Out within Process Area Adding Tasks Adding Branches Edit a Task Replacing Tasks, Conditions or Branches Remove Tasks or Branches Task Properties Dialog Cutting, Copying and Pasting Tasks and Branches Moving a Task or Branch Using Drag-and-Drop Ignoring Tasks and Branches Resize Rows and Columns of the Process Area Selecting Documents in Tasks Links Highlight a Task or Branch Undo a Command Redo a Command The Quick Access Toolbar The PlanetPress Workflow Ribbon The Task Comments Pane Copyright In
Welcome to PlanetPress Workflow 8.6.1 This PDF documentation covers version 8.6.1. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Workflow is the heart of all of our solutions. Working in conjunction with PlanetPress Connect, PlanetPress Capture, CaptureOnTheGO, PlanetPress Imaging, PlanetPress Fax, and a variety of plugins, 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.6.1. 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 (Pro and Enterprise versions only) 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 33. 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.
Adding a data selection A data selection can be used in any task property that may contain a variable. These properties are recognizable by their colored field label (maroon, by default). Right-click the property field and choose Get Data Location or Get Metadata Location to open the Data Selector (see "The Data Selector" on page 28) or Get Repository Location to open the Data Repository Manager (see "Data Repository Manager" on page 668). Note The Get (...
Text-based data selections Text-based selections are used for text data files such as Line Printer, ASCII and Channel Skip emulations. The selection refers to a rectangular selection that may contain multiple lines, rows, columns on a given page. Syntax @(page number, from line, to line, from column, to column, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l l @(): Always surrounds a data selection.
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. Database data selections These selections are used for database-driven data files such as Database and CSV emulations. The selection refers to a specific field on any given data page.
Syntax 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. return key: The name of the key where the information you want to retrieve is located. Does not need to be surrounded by quotes. lookup key: The name of the key in the group with which to look up the value.
l 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. Metadata selections Metadata selections are used with any type of emulation, as long as a metadata file was created by a previous task in the process. Note To get a sample of the metadata file, debug your process and step through it until the option View Metadata gets enabled. This happens when metadata have been created by a task in the process.
A value of 0 means 'no flag'. Name Value Behavior GetAttribute 1 Search for the name argument in the attribute collection instead of the default field collection. See: "Metadata" on page 35. NoCascade 2 Search only the level specified by the path argument (defaults to Page level when path argument is empty), instead of default behavior, going from the Page level to the Job level.
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 The hierarchical structure of the metadata is composed of a number of basic levels for adding information to the job. These levels are, from top to bottom: l l l Job: a file that contains 1 or more groups. Group: a logical and ordered group of documents (ex: all invoices for a specific customer number; all documents going to the same address, etc.).
l l l The job contains only invoices for clients located in Montreal. Since more than one invoice can go to the same recipient, invoices are grouped by customer. Each invoice is a document resulting from the execution of a PlanetPress Design document over one or more datapages, which results in zero or more physical pages being output.
Attributes are non-repetitive (i.e. name is unique) and do not persist through metadata recreation. l Field: A read-write, user-defined element which holds custom information about a certain node in the metadata structure. Fields are repetitive (i.e. the same field may appear multiple times) and persist through metadata recreation.
In the following table, the last 5 columns indicate at which level the corresponding attribute is available. This also depends on the type of job, however. In the metadata file created for a PlanetPress Workflow job, only three levels are filled with actual data about the job: Job, Group and Document. Attribute Description Categor y J o b Gro up Docum ent DataEncoding (optional) Name of the character encoding.
Attribute Description Categor y J o b Gro up Docum ent software that created the metadata. on Creator Name of the software that created the source of the metadata. TargetDevice Datap age Pa ge Producti on X X X Name of the device for which the metadata and associated data is intended. Producti on X X X Dimension Two floats separated by a colon indicating the media size in typographical points (ex: 612:792).
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge respectively portrait, landscape, rotated portrait and rotated landscape. Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is devicedependent. Finishin g X Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicates a change of the duplex status.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge identifier of the media source. OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media. Finishin g X X X X X MediaColor Devicedepedent color of the media. Finishin g X X X X X MediaType Devicedependent type of the media.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge X X X X X X X X X X under the parent Document. IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group. Index/C ount IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
Attribute Description Categor y J o b Gro up Docum ent Datap age SelectedCount Index/C ount X X X X SelectedDocument Count Index/C ount X SelectedDatapage Count Index/C ount X X SelectedPageCoun t Index/C ount X X SelectedIndexInDo cument Returns the Absolute index of the node within all the selected nodes under the parent Document. Index/C ount SelectedIndexInGr oup Returns the Absolute index of the node within all the selected nodes under the parent Group.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge index of the node within all the selected nodes under the parent Job. NumCopies Indicates how many times the job is set to execute, as set when printing using a Windows driver. Index/C ount X Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input.
Metadata Tools in PlanetPress [[[Undefined variable Old_ProductVar.ProductShort]]] (not to be confused with PlanetPress Workflow) includes a complete set of metadata-related functionality, which can be referred to as Metadata Tools. These tools can be used to generate metadata, retrieve or define metadata elements, and build the metadata structure. Using PlanetPress Design, one can: l Generate metadata for any given sample datafile.
Firstly, two buttons at the top right corner of this tab allows to load or save a metadata file generated for the current sample datafile. Secondly, the metadata tab graphically displays all elements (i.e. attributes and fields) available at the current level (i.e. Page, Datapage, Document, etc.). More importantly, these elements are graphically selectable, like any other part of the sample datafile when using the 'Select Data' option inside a Text object, for example.
Metadata in document properties The Metadata tab in the properties of a PlanetPress Design document allows to easily define documents or groups.
The Metadata Fields in the structure of a PlanetPress Design document allow to easily define documents or groups, by dragging and dropping data from the Sample Data directly onto the document's Metadata Fields. Data Repository The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes. This feature was introduced in version 8.5.
Feature Name Description Equivalent Database Terminology STRING values and any data inserted into it is converted to string automatically. The maximum size of a single key is 1 billion bytes. KeySet A group may contain as many KeySets (rows), which contain variable data, as necessary. A KeySet is inserted using the "Push to Repository" on page 314 task. Row/Record Lookup A method of retrieving one or more KeySets from a group in the data repository.
This function may also be used anywhere else where the contextual menu gives access to it. You could, for example, use it on the General tab of the Create File task, to fill in the value of a key/value pair in a JSON string. Tip The Data Repository Manager displays, at the bottom left, the syntax used for accessing a specific value. Scripts In a script you can access the Data Repository using the "Data repository API " on page 116.
Documents contain static data such as logos, addresses and graphic formatting, as well as placeholders for data. Documents can also contain conditions and programming logic. For more information about PlanetPress Design documents, please see the PlanetPress Design User Guide. 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.
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 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
The following information is available from within your information process when it is triggered: l Job Information variables (%1 to %9) l The data file as it was before starting the task l Global variables (which are, of course, available anywhere) l A series of variables containing information about the error, the task that triggered it and the process that contained it.
l PlanetPress Fax l PlanetPress Messenger 3. When any job or file is processed by the selected service, the processing logs will be displayed in the window on the right. Note The information that is displayed here is the same as in PlanetPress Workflow logs and depends on the logging level that you set in the "General and logging preferences" on page 697. To view logs for jobs that have already processed By default, the logs are available in the following folder: %ProgramData%\Objectif Lune\PlanetPres
Resubmit Backed Up Input Files to a Process Each input task includes an option that lets you back up input files. This options is not selected by default, since it has the potential to generate a very large number of back up files. To turn on the backup option of an input task, simply open its properties, go to the Other tab and check the Backup input files option, then type in a unique file name for the backup file (this should be variable).
To resubmit backed up input data files: 1. In the PlanetPress Workflow Ribbon, go to the Tools tab then click Resubmit Job in the Services group. The File Resubmission dialog box is displayed. 2. From the Process box, select the process for which you want to resubmit the backed up input files. 3. From the Task index box, select the index level to which you want the data to be sent. The index is the position in the process where you want to submit the job file. 4.
But finding this information often poses a problem. A good way to find this information easily is to print it using small characters at the bottom of every page. To do this, you have to do the following. In PlanetPress Design: 1. Use a Set Job Info action task and associate a variable with the job’s name. 2. In the output task, make sure to select the option that adds the job information to the document.
executed by copying the initial input task and pasting it as a secondary input task (the first action task to actually run in the process). Do not forget, however, to remove this duplicate task before saving the configuration! 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.
l l l l l l l l l l Click on Skip to ignore the next task or branch and go to the next one. The job file is not modified in any way. Click on View as Text in the Data group of the Debug tab to view the current job file using a text editor (Notepad by default). Click on View as PDF to view the current job file in Adobe Acrobat if it is present (this will work only for PDF job files). Click on View Metadata to open the data selector and see the current state of the process' Metadata.
l Any data selection used in task properties after this point will use the new emulation. l Continue stepping through each task until the end of the process to debug it. This method does not allow you to add, remove or move tasks, however. The second method can be used when that is required. 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.
referred to, in this documentation, as tasks, except in the specific case of importing a new plugin or customizing the Plug-in Bar. Categories The default categories list plugins according to what type of task they achieve.
much are displayed as icon only. Move the bar up to display more full-width categories, or down to display them more as icons. Furthermore, the Plug-in Bar can be customized using the popup indicator control ( ). Customizing the Plug-in Bar is mostly used for third party or legacy plugins. Using the contextual menu displayed by the popup indicator, you can: l Insert, delete and rename custom categories. l Move categories up or down. l Import third party or legacy plugins.
l Local printing: l l l Send to Folder output queues let you save jobs to a local or network folder from which they can be picked up and printed. See "Send to Folder Printer Queue" on page 73. Remote printing: l l l Windows output queues let you send jobs to a local printer. See "Windows Output Printer Queue" on page 69. 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 72.
Technical In PlanetPress Workflow Configuration, you may associate a single Printer Queue output task with multiple Printer Queues. If you do so, you have the option of using load balancing or not (See "Load Balancing" on page 75). 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.
before the data in the data file, while post-job commands are placed at the end of the data file. 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.
Character name: Character code: Typical use in printing context: Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape character New Line (CRLF) \n Goes to a new line Windows Output Printer Queue Windows output printer queues send print jobs to local or network 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 14). 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 l The Watch object is used to communicate with your current process and configuration. See "The Watch Object" on page 101. 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.
For information on the available editor options, refer to "Editor Options" on page 715. 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 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 dropdown list.
selected text, you move backward only within the script 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.
l l l l l l Global: Select to search the entire content of the script. Selected text: Select to find matching text only within a text block you select. The text must be selected before you run the search.
the line number display settings, See "Editor Options" on page 715). 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.
Jump to Bookmarks Before you can jump to bookmarks, you must add bookmarks to specific lines in your script (See "Toggle Bookmarks" on the previous page). 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.
Description The SubmitJob method allows users to remotely submit files to their PlanetPress Workflow from a SOAP client. The SOAP client has the option to wait for a response file from PlanetPress Workflow SOAP server. Arguments l l l File – base64Binary. 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.
Note If ReturnJobFile is set to true, the schedule options of the process should be set to a pooling lower than four seconds, so the client application gets a timely response. 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.
Return Value l l PostjobResult - Structure containing the following information: Success – Integer indicating the Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status. l PostjobInfStruc – See point PostJobInfoStruct for details. Note The task index can be retrieved by using the GetProcessTaskList method. See point GetProcessTaskList for details.
Return Value l l GetProcessListResult - Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status. l ProcessList – Structure containing the following information details. l ProcessName – String containing the process name l Active – Boolean value specifying whether the process is currently active.
Return Value l l GetProcessTaskListResult – Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status. l TaskNames – Structure containing the following information details. l TaskName – String containing the name of the task l TaskIndex – Integer : 1 based index of the task.
Return Value l l GetSOAPProcessListResult – Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status. l ProcessList – Structure containing the following information details. l l SOAPActionName – String containing the name of the process as seen in your PlanetPress Workflow.
Note If both FirstPage and LastPage are set to 0, the entire data file is used. SOAP API - SubmitJobInfStruc SubmitJobInfStruc Structure containing any required information to prepare the file for a valid insertion into a PlanetPress Workflow process. l l VariableList – Array of complex type, containing pairs of variable name and variable value.
Variable Name Description Example Usage (VBScript) "Watch.GetJobFileName" on page 106 Retrieves a string containing the job path and file name located in the job spool folder. Example Usage: str = Watch.getjobfilename "Watch.GetOriginalFileName" on page 107 Retrieves a string containing the job's original path and filename. Note: this filename is generally no longer available if it has been captured by Watch. Example Usage: str = Watch.getoriginalfilename "Watch.
Variable Name Description Example Usage (VBScript) "Watch.Log" on page 113 Writes to the Workflow log file, or the message window when in debug - can accept multiple log levels from 1 (red) to 4 (gray). Example Usage: Watch.log "Hello, World!",1 "Watch.ShowMessage" on the next page Displays a popup dialog box to the user (user has to be logged on). Example Usage: Watch.showmessage("Hello, World!") "Watch.
Variable Name Description Example Usage (VBScript) Example Usage: Watch.executeexternalprogram "del *.ps" "c:\" 0 true "Script.ReturnValue" on page 115 Returns a boolean True or False value to a Workflow scripted condition Example Usage: Script.returnvalue = 1 Watch.GetPDFEditObject Is used to manipulate PDF files using the AlambicEdit API. See the AlambicEdit API for more information. Watch.ShowMessage Displays a message to the user. This method is the same as PW_ShowMessage.
Perl $Watch->ShowMessage("test message"); Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line. The program's execution will be directed by the appropriate flags specified as this method's parameters. Syntax Watch.ExecuteExternalProgram const CommandLine: WideString; const WorkingDir: WideString; ShowFlags: Integer; WaitForTerminate: WordBool: integer; const CommandLine: The command line to execute as a widestring.
Examples VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true JavaScript Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); Python Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, True) Perl $Watch->ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true); Watch.GetJobFileName Returns the complete path and file name of the job.
Python s = Watch.GetJobFileName() Watch.Log("The job filename is: " + s, 3) Perl $s = $Watch->GetJobFileName; $Watch->Log("The job filename is: " + $s, 3); Watch.GetOriginalFileName Returns the original name of the file, when it was captured. This method is the same as PW_ GetOriginalFileName. Example VBScript Watch.GetOriginalFileName JavaScript Watch.GetOriginalFileName(); Python Watch.GetOriginalFileName() Perl $Watch->GetOriginalFileName(); Watch.
Python Watch.GetMetadataFileName() Perl $Watch->GetMetadataFileName(); Watch.InputBox Warning Starting version 7.0, the Watch.InputBox function is deprecated and may no longer work due to changes in the way in which the Watch Service functions. This function is completely disabled in PlanetPress Workflow 7.3 and higher. Prompts the user to enter a string. The string is displayed as the window caption. You can specify a message that is displayed above the text box. This method is the same as PW_ InputBox.
VBScript s = Watch.InputBox("Your Name", "Please enter your name", "John Doe") Watch.ShowMessage("Will the real " + s + " please stand up?") JavaScript s = Watch.InputBox("Your Name", "Please enter your name", "John Doe"); Watch.ShowMessage("Will the real " + s + " please stand up?"); Python s = Watch.InputBox("Your Name", "Please enter your name", "John Doe") Watch.
Python s = Watch.GetJobInfo(3) Watch.Log("Jobinfo 3's value is: " + s, 2) Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("Jobinfo 3's value is: " . $s, 2); Watch.SetJobInfo Sets the job information index to a specified string value. Syntax Watch.SetJobInfo(Index: Integer; Value: String) Example VBScript Watch.SetJobInfo 3, "Job info 3 Value" JavaScript Watch.SetJobInfo(3, "Job info 3 Value"); Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.
Example VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.Log "MyVariable's value is: " + s, 2 s = Watch.GetVariable("global.MyVariable") Watch.Log "global.MyVariable's value is: " + s, 2 JavaScript var s; s = Watch.GetVariable("MyVariable"); Watch.Log("MyVariable's value is: " + s, 2); s = Watch.GetVariable("global.MyVariable"); Watch.Log("Jobinfo 3's value is: " + s, 2); Python s = Watch.GetVariable("MyVariable") Watch.Log("global.
JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); Python Watch.SetVariable("MyVariable", "Desired value") Watch.SetVariable("global.MyVariable", "Desired value") Perl $Watch->SetVariable("MyVariable", "Desired value"); $Watch->SetVariable("global.MyVariable", "Desired value"); Watch.ExpandString Provides access to the emulated job file and to all variables. This function returns a string that is the expanded version of the input string.
Python s= Watch.ExpandString("%y-%m-%d") Watch.Log("Current Date is: " + s, 2) Perl $s = $Watch->ExpandString("%y-%m-%d"); $Watch->Log("Current Date is: " . $s,2); Watch.Log Creates messages that are added to PlanetPress Workflowwatch.log file. PlanetPress Workflow watch.log file is located in ...\Program Files\PlanetPress Workflow 7\PlanetPress Watch\Log\ppw[log date].log. View error messages in the Services Console while PlanetPress Workflow is in Run mode by choosing Tools | Services | Service Console.
Level Description 1 The message is logged as an Error in the log file. 2 The message is logged as a Warning in the log file. 3 The message is logged as Information in the log file. 4 The message only appears when the application runs in Debug mode. Examples In the following example, log() will write an information entry in the watch log that says "this is a log" VBScript Watch.Log "this is a log", 3 JavaScript Watch.Log("this is a log", 3); Python Watch.
VBScript Watch.Sleep 1000 JavaScript Watch.Sleep(1000); Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.ReturnValue Set this variable to 1 (true) or 0 (false) in order to return a true or false status to PlanetPress Workflow, when using your script as a conditional branch. This variable will have no effect if the script is run as an action. Example This example will always return true, as the condition is static. It is, after all, simply an example. You get the idea.
Script.ReturnValue = 0 } Python everythingOK = True if everythingOK == True: Script.ReturnValue = 1 else: Script.ReturnValue = 0 Perl $everythingOK = true; if (everythingOK = true) { $Script->{ReturnValue} = 1; } else { $Script->{ReturnValue} = 0; } Data repository API The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes.
The term ... ... is the same as an Excel ... ... is the same as a Database ... Group Sheet Table Key Column Field KeySet Row Record Note Group and key names are case-insensitive. API Reference Obtaining an instance of the Repository Object The Data Repository is accessed via a COM object that exposes methods to store and retrieve data within the Repository. JavaScript var repoObject = new ActiveXObject ("RepositoryLib.
RepoObject.AddGroup("MyGroup",'["FirstKey", "SecondKey"]'); RepoObject.AddGroup("MyGroup","[\"FirstKey\", \"SecondKey\"]"); But the following is incorrect: RepoObject.AddGroup("MyGroup","['FirstKey', 'SecondKey']"); Many methods require using the JSONStringArray type but JSON is not natively supported in VB Script. Therefore, for those methods, only JavaScript sample code is provided.
Name Description AddValue() for information on how to set a value for a key. RemoveKey Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised. All 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.
Name Description newly created KeySet. SetValue Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition. The condition is specified using basic SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note that KeyName must exist in GroupName, otherwise an error is raised. 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 available keys in KeyValues. Only the keys specified are updated in GroupName while unspecified keys are set to an empty string. 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. RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName.
Name Description sure no other process is accessing the Data Repository. Version Returns the version of the DLL library used by the Repository. AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. Syntax AddGroup(GroupName: string, keyNames: JSONStringArray) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.
Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 117). JavaScript repoObject.AddKey("Users", "email"); VB Script repoObject.AddKey "Users", "email" AddKeySets Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues must exist otherwise an error is raised.
Sample return value The method returns a JSONIntegerArray containing the ID's of all keysets inserted into GroupName: '[131,132]' AddValue Creates a new KeySet by assigning Value to the key KeyName in Group GroupName. Note that KeyName must exist in GroupName, otherwise an error is raised. See AddKey() for information on adding a key to a group. Upon successful completion, the method returns the ID of the newly created KeySet.
ClearAllData Delete all keysets in all groups, while retaining the existing key structure. Syntax ClearAllData() ClearGroupData Deletes all keysets inside GroupName while retaining the existing key structure. Syntax ClearGroupData(GroupName: string) ClearRepository Deletes all groups, keys and keysets from the repository, returning it to a blank state. Use with caution! Syntax ClearRepository() GetKeySets Retrieves Keys values in GroupName for keysets that match Condition.
VB Script repoObject.GetKeySets "Users", "[""FirstName"",""LastName""]", "Gender='M'" Sample return value The method returns a JSONStringArray of key-value pairs. '[{"FirstName": "John","LastName": "Smith"},{"FirstName": "Richard", "LastName": "Doe"}]' GetValue Performs a lookup in group GroupName and retrieves the first value for key KeyName that matches Condition. The condition is specified using basic SQL WHERE syntax.
retrieves email for first user named SmithrepoObject.GetValue "Users", "email", "" // retrieves email for first user ListGroups Retrieves the list of all group names in the Repository, stored in a JSONStringArray. Syntax ListGroups(): JSONStringArray Example In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 117).
Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 117). 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.
VB Script repoObject.RemoveGroup "Users" RemoveKey Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised. All 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.
Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 117). JavaScript repoObject.RemoveKeySetByID("Users", 10); perform repoObject.RemoveKeySets( "Users", "ID=10" ); // both methods // the same task VB Script repoObject.RemoveKeySetByID "Users", 10 perform repoObject.
RenameGroup Renames group oldName to newName. While this operation has no impact on the data stored in the specified group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Syntax RenameGroup(oldName, newName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 117). JavaScript repoObject.
VB Script repoObject.RenameGroup "Users", "LastName", "SurName" SetValue Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition. The condition is specified using basic SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note that KeyName must exist in GroupName, otherwise an error is raised.
SetValueByID Updates KeyName with Value in group GroupName, where the keyset's ID matches the ID parameter. KeyName must exist in GroupName, otherwise an error is raised. The method returns the ID of the keyset that was updated or -1 if the keyset was not updated. Syntax SetValueByID(GroupName: string, KeyName: string, Value: string, ID: integer): integer64 Note This method is functionally equivalent to using "SetValue" on the previous page with its Condition parameter set to "ID=ID".
Syntax Version(): string 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.
Watch.Log("Job Info 9's value is: " + s,4); } 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.
with PlanetPress Suite. The Metadata Tools are used extensively in the given example, which is a weekly sales report sent to all the sales associates of a particular company branch. See the "PDF Workflow" on page 179 for more details. PlanetPress Capture workflow A Capture workflow is divided in two steps: creating an output of documents containing the PlanetPress Capture Fields, and retrieving the information from the Anoto Digital Pen to merge it with the original documents.
PlanetPress Capture Workflow PlanetPress Capture, introduced in PlanetPress 7.2 and enhanced ever since, is a set of tools that is used to simplify digital archiving processes by capturing information from a special pen which records everything it writes on paper, as long as this paper contains special Anoto Patterns. Warning There are important considerations to keep in mind when dealing with PlanetPress Capture. Please review them in "PlanetPress Capture Implementation Restrictions" on page 154.
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 475). l l l Separating each individual document in the metadata (this can be done in your Design document or through the "Metadata Level Creation" on page 490 action task).
always be self-replicating and have a short polling interval set in their properties. Managing and Post-Processing There are a couple of things that can be done even after documents have been inked. As long as a document remains open, it is still present in the Capture database and be used in a process: l l The "Find Capture Documents" on page 463 input task is used to retrieve a list of documents under specific criteria.
Anoto Digital Pen A digital pen compatible with the Anoto system. These pens contain a camera, processor and memory chip which record each stroke of the pen on a printed Anoto Pattern, and are able to send this information back to PlanetPress Workflow. This document specifically refers to the Anoto DP-201 Digital Pen, not other equipment has been tested.
Client/Server Architecture A multi-server setup where more then one PlanetPress Workflow server are connected as clients to a single PlanetPress Workflow server which has a Capture Database. In this architecture, the Server contains the licenses for the pens, however the Client contains the database of documents and patterns. The Clients communicate with the server to authenticate pens. This architecture is only provided to simplify pen licensing for users with a large number of pens.
Pattern ID The ID of the Anoto pattern. Represents the pattern on the page. Can be used to retrace the document to which the pattern belong. Pattern Sequence Pattern Sequences enable the multiplication of the number of available pattern by adding an extra identification to the document. A Pattern Sequence is also attributed to each Anoto Digital Pen, such as an incoming PGC file will contain the Pattern, on which the Pattern Sequence is added from the pen database.
multiple fields in any order. A new session starts whenever a PGC is sent for processing (which erases the data from the pen). General Considerations Here are some general considerations in regards to PlanetPress Capture, its environment, the hardware and the software that interacts with it. Please review these considerations carefully as they may impact PlanetPress Capture and its functionality.
l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PlanetPress Workflow through an ODBC connection on the local network. Database file (mdb) must be local to the PlanetPress Workflow computer. It cannot be located on a network drive or another server. l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations.
l l l l In Microsoft Access, the total size of stored document cannot be larger than 2GB and this database will be very unstable in implementation with more than a few thousand pattern sequences being used simultaneously. It is only suggested for small implementation with less than 10 pens, or for demos. In MySQL, the 16 megs packet size limit can be an issue if the PDFs created by Capture are larger than this size; An error saying "MySQL Server has gone away" would appear in this case.
Here are a few notable points with the security of PlanetPress Capture on a network: l l l l l PGC Files, while not written in plain text, are not encrypted and are readable through either PlanetPress Workflow (even a server that did not generate the document associated with it), or through third-party applications using the Anoto SDK.
PlanetPress Capture implementation and then explain how the 20,000 patterns limitation can be circumvented in some cases. We will also touch upon the potential pitfalls of these workarounds as they are used. The Numbers First and foremost, the 20,000 patterns is a fixed number - PlanetPress can only generate 20,000 unique patterns as this is the number of patterns that we license through Anoto. The 20,000 patterns are, however, not all available when generating documents.
N of these documents are closed through regular process (writing on them with a pen and docking it) during that period, does the difference between both ever reach 20,000? Example Say you print 19,000 pages containing a pattern, every day. You may think you'll "run out of patterns" after a single day. But if 18,900 of these documents are being written to and processed within the day, at the end of the day you only have a 100 page difference, possibly due to mistakes, lost pages, or errors during processing.
Using Pattern Sequences In the event where a single location generates all the patterns and this output *can* be split into multiple logical zones, Pattern Sequences can be used. A Pattern Sequence is basically a "tag" that is added after the pattern's identification (Pattern ID). When a Pattern Sequence is used, each Pattern Sequence can re-use each of the 20,000 available patterns.
As you may have figured out by now, we are still not actually printing more than 20,000 patterns. The only distinction here is that we are re-using patterns in separate "zones" (or, well, sequences) and as long as pens and pages using capture patterns are not exchanged between these zones, they act independently with their own 20,000 pattern limitation.
Second, contamination can happen in method 1) above if a pen or paper is moved from one location to another. Similarly to the previous contamination example, if there exists a document in the Capture Database where the "wrong" data is processed, it will update a document where it does not belong. Again, neither the pen nor PlanetPress Workflow have any idea that this causes an error until it's too late.
l l l When necessary, patterns can be extended using multiple servers or Pattern Sequences (as long as these are used in separate physical locations). It is extremely critical that contamination be avoided at all costs. Whenever possible, always avoid using pattern sequences unless it is absolutely necessary to do so. Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc.
To pair penDirector with an Anoto Digital Pen: 1. Make sure that a Bluetooth dongle is present and enabled on the computer where penDirector is installed. 2. Note down the PIN of the Anoto Digital Pen, by docking the pen and going in the Pen settings tab of penDirector and looking at the Pen access group at the bottom of the dialog. The default PIN is 0000. 3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4.
PlanetPress Mobile Application The PlanetPress Mobile application can be installed on some mobile phones and enable fast and direct connectivity between the Anoto Digital Pen and PlanetPress Workflow. The connectivity between the pen and the mobile phone is done through Bluetooth, while the connectivity between the mobile phone and PlanetPress Workflow is through the currently active data plan (either wifi or the cell phone company's data plan, such as 3G).
Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
This is because the pen's camera (which captures the position of the pen) is located under the pen tip and must fully see the pattern.
Knowing this, the best practice when creating fields is that they have, at the very least, a 7mm margin on each size of the actual area you want to capture from. For example, an effective 30mm wide pattern will actually be 44mm wide using these margins. The margin should be for both the vertical size and the horizontal size.
PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition". The difference between the two is easily explained: While OCR can only recognize characters using the finished shape (for example, in scanned documents and pictures), ICR relies on much more data which is provided by the Anoto Digital Pen: the path that the pen takes, the exact timing of this path, start and stop points, etc.
User Guide). This must be either a Multi-Area Field or a Text Field. l l l The Capture Fields Processor must have the Perform ICR Recognition option checked, and language needs to be selected. Once the ICR data is available, do something with it. This is done by reading the ICR data that is available in the metadata generated by the Get Capture Document task. The metadata is also readable by the Capture Condition task, including the captured text and the reliability of this text.
l l l ICR Value: The alpha, numeric or alphanumeric value that was determined by the ICR engine. ICR Confidence: A percentage value that the ICR engine gives to any specific value, when comparing the pen data with it's character database. ICR Resemblance: A percentage value that defines how closely the value resembles the "average" character shape. Both the Confidence and Resemblance can be used together to make an informed decision on the contents received by ICR.
The following guidelines are applicable when configuring a PlanetPress Capture object that utilizes ICR: l l l l l l l The collected data is expected to be a number, therefore the numeric mask type must be selected, or The collected data is expected to be a letter, therefore the alphabet mask type must be selected, If upper case letters are expected, select Upper case in the Case option menu. The captured characters would be immediately converted to capital letter i.e.
The following diagram illustrates the available mask types. It is recommended to select the mask type that is the closest to the desired result. An alphanumeric field should be used as a last resort. Guidelines for Capture-Ready Fields l l Target: Form designer What: Only one character per Capture field can be recognized. When expecting multiple characters making up a word or phrase, you must make sure that the user only writes one character per field.
Why: To avoid any ink marks that would spill over from one field to another. If both fields A and B are to close in proximity and the ink marks from field A spill over to field B, then the marks captured on field B would be considered as being part of a character written on field B. For example, if a number spills over and is written over two fields like numbers 9, 1 or 7; then the bottom tip of these numbers could be considered as number 1 in the second field.
How: Make sure there’s enough space between each field. You must re-design the document if that’s the case. There’s no minimum value that is required as the distance between 2 fields, except for the 7mm border that is required in order for the Anoto digital pen to recognize the pattern being used. Writing in a Legible Way l l Target: User. What: It is important to write in a legible way i.e. applying yourself by writing well defined numbers and letter that are easily interpreted.
Why: The available filters to interpret the ink marks done with the Anoto digital pen, allow you to select the engine language to be used. Doing so will give you results that are the closest match to the captured data. Multiple cultural characters can be interpreted with ICR once the correct language is selected such as û, à, é, etc. How: This option is available from the Capture Fields Processor task.
Possibility of Interpretation Error in an Automated Process l l Target: Workflow designer What: We cannot be 100% sure that a character would be recognized by PlanetPress Capture as it should. Therefore, the analysis of a value interpreted with ICR should only occur if the level of confidence is superior to a determined level. Why: An automated process can treat the characters incorrectly due to an incorrect interpretation of a value. This occurrence should be minimized as much as possible.
l Any input task l "Create Metadata" on page 475 l "Capture Fields Generator" on page 448 l Print output PGC Handling Process The second process is the PGC Handling process. It receives data from the Anoto Digital pen, updates the Capture database and releases patterns as appropriate.
Post-Processing is generally done using the "Capture Condition" on page 442 task, which verifies the presence or state of the ink on the document or on specific fields. After PGC Handling Here is an example of a process that receives ink data, updates the database, and then verifies whether or not a field that indicates manager attention is required (for example, a box noting the wrong number of items in a delivery slip). If attention is required, the document is sent via email to the manager.
l l The Capture Fields Processor then uses the PGC file to update any documents in the database that the pen wrote on, and closes those documents in the database when they are complete. Capture Condition is where we can check whether a specific field (a "RequireManager" field) has ink contained in it, and if it does, the branch on the right is triggered.
Task Breakdown l The Find Capture Documents task queries the Capture database for documents that correspond to certain specific conditions. For example, here we would look for all documents that are either in an "Error" or a "Partial" state, which means they received ink but are not completed correctly.
to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met". l With this list of documents in the metadata, we Branch off. This is done because we need to build a report that will be sent to an administrator, and only one email should be sent. l l To build the report, inside of the branch we use the Metadata Sequencer to create one sequence for each document, by splitting at the Document level, by 1 occurrence of the level for each sequence.
the Resource action name box to static , and the Resource folder to c:\PlanetPress\http . Then, click OK. 7. Send the configuration to your local PlanetPress Workflow server. 8. Start PlanetPress Workflow services (see "Start and Stop PlanetPress Workflow Service" on page 608). 9. Open your browser and point it to http://127.0.0.1:8080/documentlist , assuming you have not changed the default HTTP port in the HTTP Server Input 2 section.
l l HTML Form Action: An HTML Form in the browser that may contain text and attached files can be filled and sent to a process with the HTTP Server Input task. HTTP Data Submission: A custom application or a server sends the request to PlanetPress Workflow using either a POST or GET command. The application or server then waits for a response from PlanetPress Workflow Tools.
l l Enable server for SSL requests: This enables secure communication between the browser and the server via HTTPS. By enabling this option, you will need to provide for the proper certificates, key and password. While this configuration is beyond the scope of this document, there are plenty of resources on the Internet to explain these systems. Serve HTTP resources: This is where you enable static resources in PlanetPress Workflow.
new request. This should be put at 0 in order to process requests as soon as possible, meaning immediately. And finally, the HTTP Server Input task properties. While these are described in the "HTTP Server Input" on page 214 task properties page, here are a few considerations to keep in mind when using this task: l l l l l The HTTP Action corresponds precisely to the name immediately following the first slash of your address.
3. The XML request file and attachments are saved in a local folder, if the HTTP Action is a valid one (otherwise, the files are deleted). 4. The HTTP service keeps the request from the client open (it does not yet respond ot it), and waits. 5. The HTTP process corresponding to the HTTP Action captures the XML file and attachments and the process begins. 6. The process runs its course just like any other process would (including subprocesses, send to process, etc). 7.
HTTP PDF Invoice Request This straightforward workflow simply receives a GET request from a browser, loads an existing PDF invoice from a folder on the hard drive, and returns it to the browser. To do this, a client (or a web service) would request the following page: http://ppworkflowserver:8080/getinvoice?in=INV999999 Breakdown of this URL: l l http:// : transfer protocol. This could be HTTPS if the SSL certificates are activated in the preferences. ppworkflowserver : name of the machine.
Task Breakdown l l l l The HTTP Server Input task receives a request through the /getinvoice HTTP Action. Because this task either returns an HTML page with an error message or a PDF, the MIME type is Auto-Detect. It checks whether the invoice request exists by checking if the size of the file is less than 1kb using "File Size Condition" on page 380. The condition returns "true" if the file is not found: c:\PlanetPress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value,KeepCase,No
l l Open HTTPBrochureRequest.pw7 and send the configuration to your local PlanetPress Workflow service. Open your browser to http://localhost:8080/generatebrochure Task Breakdown l l l The HTTP Server Input receives the initial request from the browser. Because this is a demonstration, a backup is made of the XML request. It's not suggested to do this every time, especially on servers receiving a large number of requests, as these files do take some amount of space for each request.
The idea is that a PDF file, because it is a formatted document in and of itself, doesn't absolutely need to go through PlanetPress Design to be processed and printed. Additionally, because of the PDF tools in PlanetPress Workflow, you can easily merge, split, print and take parts of the PDF file as required.
l l l l "Run Script" on page 387 tasks can also modify metadata using the Metadata API (See "Using Scripts" on page 87). The "Barcode Scan" on page 267 task can add information to the existing metadata, and creates it if there is none. The "Capture Fields Generator" on page 448, "Capture Fields Processor" on page 452, "Get Capture Document" on page 468 and "Find Capture Documents" on page 463 tasks generate their own metadata.
l l l l l l l l The "Metadata Level Creation" on page 490 creates the Document level of the metadata by placing each PDF data file in its own Document level. It does this by detecting when the Address in the document changes. Then, the "Metadata Fields Management" on page 480 adds a few fields at the Document level in order to properly tag each document with the appropriate information, in this case the Customer ID, Country and Rep ID.
This section describes the implementation details for a Capture OnTheGo process, including how to create, send and submit COTG documents to the Mobile application. About Tasks A task is a plugin or a block that is used to build PlanetPress Workflow processes. Tasks can do multiple things depending on the type of task and where they are placed. You can add as many tasks as you like to your processes and order them in any way you can.
Task Properties Any task you add to your PlanetPress Workflowprocess must be configured using its properties dialog box. Each task's Properties dialog will give you the options to configure that specific, individual task.
Variable properties can also be mixed, meaning you can combine, within a single variable property box, any number and order of variable types. You can, for example, do the following for an output file name: %O_@(1,1,1,30, KeepCase,Trim)_%y-%m-%d.txt. This would translate in the original file name, followed by part of the first line of a text data file, then the current date.
You can quickly identify variable information that is already present in your variable properties as such: l l l l l A percentage sign identifies standard variables, as well as standard and custom job info variables — %f, for example. A backslash indicates a control character — \004, for example. An at sign (@) indicates a data selection for emulations other than database — @ (1,1,1,1,17,KeepCase,Trim), for example.
a Folder Capture input task and enter *.* in the Masks box, the input task will grab all the files that are put in the source folder. If you enter *.mdb instead, the task will only take the those database files that have an mdb extension. You can use any standard wildcard character in PlanetPress Workflow.
Technical Filename containing brackets can be a hassle when attempting to capture them with a mask and using sets or ranges. You can capture a set that contains an opening bracket ( [[] ) , but not a closing bracket as the closing bracket always ends the set or range. There is no escape character available in masks. Date and Time Format To simplify things and to prevent errors, date and time formats have been standardized. l l Date are entered and displayed as yyyy/MM/dd (2007/06/13, for example).
Input Tasks Input tasks are the starting point to any process and determine what file this process will being with. Each process must begin with an input tasks, and although a given process may have multiple input tasks, no task can have more than one initial input task. Initial Input Tasks Initial input tasks are always at the beginning of a process and are always triggered when the process starts.
This is an important consideration when scheduling a task, as the Folder Capture will keep capturing files as long as new files are added, even if it means continuing to capture and process outside its scheduled time. It is also important that while the Folder Capture input task is processing files it keeps a copy of each file in a temporary folder, and will not delete any of these files until it has finished processing all of them. This may cause issues with running out of disk space.
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
l l Add CRLF after last line: Check if you want the plugin to automatically add a new line at the end of the file. Remove the checkmark to leave the file as-is, useful in the creation of CSV files for example. Delete Metadata: Check to delete any metadata attached to your data file. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task.
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. 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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
Output Depending on the options, each email is sent as a data file, followed by each of its attachments sequentially. Technical If you use Email input tasks to capture data encoded using a Double-Byte character set (such as those used for Japanese or Chinese, for instance), it is preferable to use attachments rather than the email body to carry the data from its source to the input task, as data corruption is less likely to occur using this method.
l l l Nothing: Select to limit those messages used by this task to those that do not specify any subject. “From” contains: Select to limit those messages used by this task to those that are sent from a specific address. The address you enter in the box below can include variables. “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.
"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.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored 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 folder. 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).
validation of the RegEx being specified. l l l l l l l Sort files by: Select a given sorting method to prompt PlanetPress Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order). Select None to let PlanetPress Workflow take the files without sorting them first. Sort order: If you selected a sorting method in the Sort files by box, select the order in which you want the files to be sorted.
l l Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l %1 - Source File Name. Contains the file name (excluding path but including extension) of the file name that is captured. Equivalent to using the %o system variable.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
Input Folder Listing captures nothing, however it does read the input folders (and, if selected, subfolders) and gathers information about each file in that folder. Processing Folder Listing loops through the files and, for each file, generates an XML node with information about the file. Output The output is an XML file containing information about each file. If the Sub-directories option was checked, the structure of the XML also contains the folder structure as it is present on the drive.
Note The
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored 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 l l Password: If account named in the User name box is password protected, enter the password here. Port number: Set to use a specific port number.
l l Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically.
iteration. 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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
HTTP Client Input HTTP Client Input tasks use the HTTP protocol to issue HTTP GET commands (queries) to HTTP servers. Replies received from the HTTP servers are used as jobfiles and are thus passed on to following tasks. Input This initial input task retrieves a single file as specified in the URL option. 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.
l l l l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory.
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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
HTTP Server Input HTTP Server Input tasks are used to receive HTTP requests made via GET or POST commands and to send replies to the servers from which the requests were made. The HTTP server supports both http and e. For HTTPS Support information, see HTTP Server Input User Options.
incoming XML file cannot be more than 400MB, which because of CDATA is reduced to around 200MB. To help in this situation, you may elect to omit CDATA from the attachment, which can be changed in HTTP Server Input User Options. Please note that this limitation also affects incoming binary files (sent through file upload in a form), regardless of CDATA settings. Processing Depending on the options chosen in the HTTP Server Input task properties, the task may choose to ignore some of the files.
you enter "MakePDF" here, you could trigger the process by accessing http://127.0.0.1:8080/MakePDF . This is also what your HTML Form's action should be. l l MIME Type: Select the MIME type that best suits the files PlanetPress Workflow will be receiving as input. Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the HTTP Server Input task loop through each attachment. Each data file is an XML with the accompanied file.
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
l l 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: In the initial input tasks, this group is disabled 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.
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 53.
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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
Technical SOAP communication is non-trivial and requires a certain understanding of XML and the SOAP protocol. Using the SOAP tasks pre-supposes this knowledge and this documentation does not attempt to provide it. The Input SOAP Task only responds to a single SOAP action by the client: SubmitJob. Within this request however, a secondary action (SubmitSOAPActionName) can be specified - this is what the SOAP Action corresponds to in this task's properties.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing When the job is received through LPR, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. 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.
l l l %3 - Job name: Contains the name of the job as specified by the software that sent the job. %4 - Source file name: Contains the name of the job file as specified by the software that sent the job. %5 - Sender's IP address: Contains the IP address from which the job was sent. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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 Workflow 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.
The Merge PDF Files input task performs just like any other input: once the process has completed, control is transferred back to the input one last time to check if new files meeting the mask have come in. This means that the merging of PDF files that are not all present at the start of the process may take several passes, which may have an adverse effect on the overall performance and the size of the resulting PDF.
each separate folder, not across folders. The subfolders themselves are always processed in alphabetical order, regardless of the sort order. l l l Sort directories first: If you selected a sorting method in the Sort files by box, and if you want the folders present in the source folder to be sorted first, select this option. Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized.
Job Information definitions l %1 - PDF Directory: Contains the folder from which the data was captured. Examples & Use Cases This task is put into effect in the following use cases and example processes: l Daily Sales Report from PDF Files On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
Input This task does not poll an input, it sits there and waits for a job file to be sent through the Serial connection. Processing When the job is received through the Serial connection, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification. General Tab l Since Serial Input tasks have no specific task configurable properties, this section contains no property information.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
files in the queue. Once all the files are gone, the task polls the FTP folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. 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 Server Settings group l FTP Server: Enter the IP address or host name of the FTP server to poll.
directory is usually under the server main user directory and generally includes the user’s name. For example, if "/tmp/temp/copy_pending" is entered, it does not point to the "/tmp/temp/copy_pending" directory but to the "/users/support/tmp/temp/copy_ pending" directory. l l l Delete remote file: Check this option to delete the file after it has been retrieved by Workflow. Connection mode group: This group is only relevant to the FTPS protocol and appears when it is selected.
"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: In the initial input tasks, this group is disabled 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.
from most 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 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 Unzip attached file: Select to unzip the attached files. l l Zip password: Enter the password required to unzip the attached files (if any). Note that you can use variables and data selections. Conditions: Defines a filter on capturing files from the SMTP Service's hotfolder. When a condition is added, only files that match this filter are captured, the rest remain untouched. “Subject” contains: Select to limit those messages used by this task to those with a specific subject.
Job Information definitions l %1 - Date Received: Contains the date and time at which the email was received. l %2 - Originator Name: Contains the Name of the sender (in the from field). l %3 - Originator Address: Contains the Email address of the sender (in the from field). l %4 - Recipients: Contains the recipient(s) of the email (in the to field). l %5 - CC: Contains the Carbon Copy recipient if there is one (in the cc 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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Example In this example, the SMTP Input plugin is used to capture incoming emails data that must meet certain conditions as the subject that contains "Work to do" and the sender that contains "client@company.com ". The process then redirects the content of those emails to an extraction and finally to a PDF printing.
Telnet Input The Telnet Input Task (also known as the Raw Socket Printing Input) receives files sent to a specific port.
use multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see "Telnet Input plugin preferences" on page 705). Input This task does not poll an input, it sits there and waits for a job file to be sent through the Telnet port. Processing When the job is received through Telnet, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification.
l l Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l This task does not generate any job information. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
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. To ensure that the spooled files created by PlanetPress Workflow queue remain in the spool folder, the printer queue must be paused. Input The WinQueue input regularly polls the selected printer queue for new jobs. When a new job is available, it is captured automatically by this task. Processing The print job, by default, is in EMF format.
l Spool Print Jobs in RAW Format: Select to output in RAW format, which is the exactly the data that the computer receives (and is not converted in any way). l Create PDF (With Metadata): Select to output a PDF which can be used by the Document Input (PDF Input) feature in PlanetPress Workflow. l l Optimize Resulting PDF: The resulting PDF is optimized for size and caching options are enabled. This reduces the size of the PDFs (depending on some factors), but may take more time to output the PDF.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Variable properties may include: l Static data. l Standard Variables. See "Standard Variables" on page 593. l Local and Global Variables. See "Manipulate Local Variables" on page 630. l Job Infos. See "Job Info Variables" on page 592. l Data and Metadata Selections. See "Data selections" on page 22. l Printer Control Characters. See "Shared Printer Queue Properties" on page 67. These are normally only used in printer outputs.
l l l l l l l l Global Variables: Contains a list of global variables in this configuration. If no global variables exist, this item is disabled. Control Characters: Contains a list of control characters that can be used in printers. Get Data Value: Brings up the Data Selector, retrieves the value you select and places it in the variable properties box. This information becomes static and does not change between each datapage and job file.
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. Opening a configuration that contains additional plugins that are not installed on that system will cause these plugins to be replaced by unknown tasks.
l 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.txt or filea.txt , but not file13.txt or filetest.txt. Brackets: Specifies a set of supported characters, or range of characters.
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 (.ps7), ads the trigger and then the active data file to it. If metadata is present, the output is based on this metadata (unselected data pages will not generate output, the sort order will be respected, etc). Otherwise the complete data file is merged.
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: In the initial input tasks, this group is disabled 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.
Task Properties General tab l l l l l l l l Action group l Add: Select if you want the task to add content to the job file. l Remove: Select if you want the task to remove content from the job file. Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file.
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. 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.
Task Properties General tab l Search mode group: Select your chosen search mode within this group. l l l l l Search whole file: Select if you want the entire data stream to be searched as if it were a single string of text. When this option is selected, PlanetPress Workflow loads the entire file in memory. It offers more flexibility, since search expressions may span across multiple lines and may result in more successful hits. Note that since this option uses more memory, it may affect performance.
l l l l l At the beginning of a line: Select to indicate that the search string must be the first string on the line. At the end of a line: Select to indicate that the search string must be the last string on the line. At column: Select to indicate that the search string must be in a specific column. Specify the column number (the value must be greater then 0) in the Column value box below. Between specific words: Select to indicate that the search string must be between specific words.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing The task reads the image and detects the presence of the selected supported barcode types. When a barcode is detected, the data it contains is read and added to the Data Page level of the metadata. Technical This task does not recognize more than one level of the metadata Document. This means that if you are intending to define separate documents, you should use the Metadata Level Creation task after the Barcode Scan.
Barcode types Description Code93 Code 93 symbology. Compressed form of Code 39. Code128 Code128 symbology. Very dense code, used extensively worldwide. Codabar Codabar symbology. Used in libraries and blood banks. Inter2of5 Interleaved 2 of 5 symbology. Used in warehouse, industrial applications. Add2 2 additional digits code for UPC-based symbologies. Used to indicate magazines and newspaper issue numbers. Add5 5 additional digits code for UPC-based symbologies.
Note The fewer barcode types are selected, the faster the plugin performs. Selecting only the expected barcodes is therefore a good practice. Barcode Orientations Barcode orientations represent a barcode orientation on an image. For example, when the leftto-right option is checked, the task will try to read the barcode value assuming that the barcode data should be read in a left-to-right fashion. Note The fewer orientations are selected, the faster the task performs.
The Barcode Scan task character replacement option will allow successful barcode reading of all non-printable characters in a given barcode. The value specified in the Replace non-printable character with option will be found in place of any non-printable character in the BarcodeValue and Barcode_x_Value metadata fields, while the original barcode value (i.e. with non-printable characters) will be available in the BarcodeBase64_x_value metadata field.
l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the 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.
l l l l l l l BarcodeBase64_1_Value: Metadata field containing the value of the first barcode, encoded in Base64. Barcode_1_Type: Metadata field containing the type of the first barcode (ex. EAN13, UPCA …). Barcode_1_Orientation: Metadata field containing the orientation of the first barcode. Barcode_1_Top: Metadata field providing the distance (in pixels) from the top of the page to the top of the first barcode.
Change Emulation Change Emulation action tasks are used to tell the tasks that follow them to use a different emulation to format the data they receive. So these tasks do not perform any operation as such on the data, but rather they modify the way subsequent tasks process the data they receive. Change Emulation action tasks are typically used when a secondary input task brings new data that is not structured like the initial data into the process.
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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
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 179 for more information on this). Output The output of this task is always, exclusively, a PDF file, optionally optimized and optionally with fresh metadata.
l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files.
l Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty. Select Bookmarks and page to display the contents of the Bookmarks tab (you use data selection objects to create bookmarks in PlanetPress) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
l General: l Compress text and line art l Auto-rotate pages l Optimize for fast web view l Author: PlanetPress l Keywords: PlanetPress; Create PDF plugin l Monochrome images : l l l l l l Compression: CCITT l Pixels per inch: 1200 Grayscale images : l Compression: Auto l down sampling : Bicubic l Pixels per inch: 300 Color images : l Compression: Auto l down sampling : Bicubic l Pixels per inch: 150 Security : l Allow printing l Allow changing the document l Allow cont
Database Query Database Query action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format. Database Query action tasks are not considered input tasks as such, because they cannot be used to start a process. Although they cannot be used to get the process’ initial input, they can be used to gather secondary input (see "Input Tasks" on page 189).
Processing A connection to the selected database is made, the data is retrieved, and an output in the selected emulation format is generated. Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and jobinfos are not modified in any way. 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.
which character to use. You may select the replacement character from the list or type your own. l l Emulation options group: Options from this group change based on the selected output file emulation.
field, use the Configure Width button. Doing this disables the Default width box. l l XML Emulation: If you selected XML in the Output file emulation box, the following options are available: l l l l l l l Configure Width: Click to set the width of each field in the generated file. The displayed Configure Width dialog box lists all the fields in the file that will be generated and indicates their widths.
l l Import Config: If you previously created and exported a PlanetPress Workflow Database Connection configuration, click this button to import it. This saves you the trouble of configuring the connection every time. Client-side Cursor: When this option is enabled, the complete result set is downloaded before processing starts, and changing records is done by PlanetPress Workflow.
simply copy and paste it to this box. Bear in mind that if the Parse normally option is not selected, any backslashes included in the connection string that is not doubled will be disregarded. Once your connection string is displayed in this box, you can edit it by adding variables or data selections. l SQL statement: Enter your SQL statement. Remember that you may use variables and data selections in your statement. 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 Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
Processing Every file in the ZIP is extracted to the specified location. If a folder structure exists in the ZIP, it is respected in the output folder. Output This task outputs the data file it received with no modification. Metadata and job files are not touched either. Properties General Tab l l l l l l l Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these.
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. Action: In the initial input tasks, this group is disabled 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.
Task Properties General tab l l l Host: Select the IP address of the PlanetPress Image host to which you want the request to be sent. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box. Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections.
l Output type: Select the output file type that you want. l l l l l l l PDF: The output will be a PDF file. If you select PDF, the DPI and Color Depth options (see below) are disabled and the options available in the PDF tab are enabled. JPEG: The output will be a JPEG file. JPEG is a lossy compression image format that creates small files, compressing continuous tone images (such as scanned photographs) well. TIFF: The output will be a TIFF file.
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. Use original data stream (with document): Uses the PostScript data generated before image is created.
l XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document. 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.
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. If you suspect that the data may contain parentheses, you should use a Run script action task (see Run Script Action Task Property) with a Strip() function to strip them out. l l Monochrome images group l l l Keywords: You may enter keywords for the document.
Subsample to use a pixel in the center of the sample area and replace the entire area with that pixel value. This method is significantly faster, but results in images that are less smooth. Select Bicubic to use a weighted average to determine pixel shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l l Color images group l l l l Grayscale resolution: Select the resolution to use for grayscale images.
options of the generated PDF files. l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l l l l l Allow form filling: Select to let users enter information in the form fields included in the generated PDF files. PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files.
contents of the Bookmarks tab (you use data selection objects to create bookmarks in PlanetPress) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages. Select Full screen to hide all screen contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen.
configuration. In order for the settings to work, the Add PDF to PlanetPress Search database must be checked. However, you can override which database will be updating using the option in this window, Override global PlanetPress Search Database settings. The database options then activate. l l l l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server).
Printer action task must be followed by a Printer Queue output task set to "pass-through", in order for it to be sent to the printer and not merged with a document. You can use Download to Printer action tasks to send various types of files, such as attachments, documents and fonts that are used in PlanetPress Design documents that are executed directly on the printers.
l l Keep file extension: Select to use extensions when saving files. When this option is selected, if the task receives a file with the “txt” extension, for example, it will keep this extension even if it renames the file (as specified in the File name box). Print confirmation page: Select to print the Variable content document download confirmation page when the download is successful. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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 Workflow 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.
(Reference Guide, in English only). There are some important things to consider when using the External Program task: l l The executable file must accept so-called "command-line options" and be able to run without any sort of user interaction. Only certain programs are able to do this and may refer to it as "command-line" or "automation" features. The process will always wait for the executable file to finish before it continues to the next task, and does not have any timeout setting.
l l l l Start in: Enter the folder in which the external program is to run. This is important, for example, if the program is to generate files that are to be picked up in a specific location for further processing, or if it requires resources that are located in a specific folder. Leave blank to run the program in the folder of the executable file. Run minimized: Select to prevent a window (a DOS box, for instance) from being displayed on the desktop.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
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. Examples & Use Cases This task is put into effect in the following use cases and example processes: l HTTP PDF Invoice Request On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
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. The task does not modify the job file in any way, its only output is the change in the specified variable where the result is stored. Technical The expression itself must be written in a format understood by the VBSCript scripting language.
2, the expression would be %9*2 . l l Store result in: Variable data field containing the job information, local or global variable in which to store the result. For job information use %1 through %9, for local variables use %{variable} and for global variables use %{global.variable}. Use value of Variable/JobInfo # expression: Use the contents of the variable entered in Store result in:, which is assumed to be a digit between 1 and 9.
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 l l l l l Delete: Delete the current selection (only available if there is selected text in the editor). Select All: Select all of the contents of the editor.
saved). l l Script running from: Choose if the script should be run from the editor text box, or from an external script file. Script filename and path: Either enter the full path of the XSLT Script, or click the Browse button to navigate to the file. This option is only available if you choose external script file in the Script running from option. Push to Repository The Push to Repository Action Task adds data to the PlanetPress Workflow data repository. The task may only add one KeySet per action.
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.
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: In the initial input tasks, this group is disabled 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.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored 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 115 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 723.
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 Workflow 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.
readable and supported by this task. Processing The appropriate changes are made to the data file (replacing text). Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Properties General Tab l l l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these.
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. 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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
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.
images by 75% when it converts those image to PostScript. The default compression level is 70%. l l l l Send to Virtual Drive of: Select the computers and / or printers to which the images are to be sent. Refresh: Click to prompt PlanetPress Workflow to look again for available printers and computers. Hard disk name and path: You may enter the name and path of the hard disk to which you want to send the images.
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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
PlanetPress Workflow will wait for the task to be completed before going on to the next task in the configuration. Note As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the Network Considerations page in the Advanced Configuration and Options chapter (Reference Guide, in English only). Input Any data file in any format.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Output The original data file, metadata and job infos are not modified, they are passed on to the next task. Set Job Infos and Variables action task properties are as follows: General tab l l Var/Info#: Lists all job infos, local variables in the current process and global variables in the configuration. Click on the variable you want to change. Value: Enter the value that you want to associate with the selected job information element or custom variable.
iteration. 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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
SOAP Client plugin SOAP Client plugin tasks can be used as input, output and action tasks, although their basic function is to generate output. SOAP (Simple Object Access Protocol) is a light protocol that defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems. A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol.
Note The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l l l l l l l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below. Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found.
Advanced tab l Domain: Enter the domain for the authentication on the SOAP server. The Domain is optional even when authentication is used. l user name: Enter the user name for the authentication, if required. l Password: Enter the password for the above user name. l Allow invalid security certificate: Check to ignore SSL certificates that are invalid. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
These characters, like other printer control characters that control how printers interpret and print jobs, are not meant to be printed. If your print job is bound for an HP compatible printer, it may include these characters even when printing to a PostScript printer that does not recognize them. PlanetPress Workflow provides an easy way to automatically filter these characters through its Standard Filter action.
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. Action: In the initial input tasks, this group is disabled 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 The data file in its new encoding format. Metadata, job info and variables are unchanged. Properties General tab l l l l Source encoding: Select the current data encoding. Note that the source encoding is not selected automatically and you must therefore select the proper encoding from this list in order for the conversion process to be performed successfully. Target encoding: Select the encoding to which you want the data to be converted.
l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
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. Windows Print Converter Windows Print Converter action tasks are designed to convert Windows print files into Line Printer files, that can then be used in a variety of other PlanetPress Workflow tasks.
Properties General tab l EMF to XY group: Select this option if the file received by this task is a Windows print file. This will prompt the task to perform the first phase of the process, and thus convert the file to an XML file. If this option is not selected, the input file will not be converted to an XML file (note that the task will fail if the file it receives is not an XML file). The settings included in this group fine tune the process.
font's mean character width is multiplied with. The value for the mean character width is taken from the corresponding font's attributes (for texts which are printed justified, it is suggested to raise this value up to about 2). For example, if the mean character width of the font example shown here corresponds to the width of the blank character (for other fonts it may be another sign).
l l Character per inch (CPI): The number of individual characters per inch on a line of text. Line per inch (LPI): The number of lines of text per inch. Data Splitters Splitter action tasks are used to single data files into multiple data files. You can use such tasks, for example, to split files that contain statements for multiple clients into smaller files that each contain a single client statement.
channel in Channel Skip), the output data will be different from the input data, but the change will not be significant. Let us imagine that a splitter action task processes the following data file using the ASCII emulation: Data line1 of page 1 Data line2 of page 1 Last data line of page 1 Data line1 of page 2 ...and so forth...
Input A Database Emulation data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task. Properties General tab l l l l l Split group: Use this group to indicate how you want the file to be split.
l l l l l l l l Match case: Select to force the splitter to match the character casing when resolving the Field value change or Field value condition. If this option is selected, a change from “DAY” to “Day” will be considered as a valid field value change, and “DAY” and “Day” will not be considered as equal values. Where to split group: Options from this group are used to define a number of pages or records before or after which the file is to be split.
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: In the initial input tasks, this group is disabled 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 Split data file on emulated page group: Select to split the data file based on pages (rather than on a word found within the emulated data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place. l l Page(s) per output: Enter the number of pages to include in the file generated by the splitter in this edit box below or use the spin buttons.
l l Trim selection: Select to force the splitter to strip empty trailing characters. When this option is not selected, blank trailing characters, if any, are considered in the matching process, so the word “DAY” will not be considered as matching the word “DAY”. Note that this setting applies only to the Word change option. Where to split: By default, the task splits the file at the beginning of the line on which the condition is met (the default value is 0).
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. Action: In the initial input tasks, this group is disabled 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.
l Where to split group l l l l Pages: Enter exactly where to split the file. Enter 1 to split the file 1 page before or after the string, 2 to split the file 2 pages before or after the string, or 0 to split the file immediately before or after the string. Before or after: In the previous box, you entered exactly where you wanted to split the file, here is where you specify whether you want the split before or after.
to split the file immediately before or after the string. 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. 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 Where to split group l l l l Pages or records: Enter exactly where to split the file. Enter 1 to split the file 1 page or record before or after the string, 2 to split the file 2 pages or records before or after the string, or 0 to split the file immediately before or after the string. Before or after: In the previous box, you entered where you wanted to split the file.
l Split when condition found: You may not want to split the file every time the string of characters changes, but only every other time, or every third time. If so, enter the number of times in this box. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Properties General tab l Split data file on page group: Select to split the data file based on pages (rather than on a word found within the data stream) and to activate the options from this group, which are used to tailor exactly how you want the page based splitting process to take place. l l l l Page breaks on form feed: Select if you want to start a new data page whenever a form feed character is found.
this box. Enter 1, for example, to split the file at the beginning of the line that precedes the line on which the search word is found. l l l Before: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines before the search word. After: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines after the search word.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
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. Metadata, job infos and user variables are not modified by this task.
combination of these. You may also use the Get Data button to get a static string of characters from the sample data file. If you use this option, the coordinates of the data you will select will be added to the Left, Right, Top and Bottom boxes below. l l l l l l l l l l Left: Enter a value corresponding to the left coordinate on which the splitter must start searching for the region.
l 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. Sequencing based on: l l l l l The following number of occurrences of the level: Determine a sequence based on the number of instances found for the metadata level currently processed.
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. Action: In the initial input tasks, this group is disabled 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 l Use UTF8 encoding: Select if you want to use the UTF8 encoding to process the file. Use file’s encoding: Select if you want to use the XML file’s own encoding to process the file. Advanced XML splitter: The following options and buttons are only displayed when the Advanced XML splitter option is selected in the Split method box. Note that you should not use this option before you have completed all the required settings using the Standard XML splitter option.
l Browse button: Click this button and browse to select the XSLT engine you want the XML splitter to use. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Technical Branches, Loops and other process logic tasks do not generally modify the job file, though some may change system variables. The only exception is the Run Script action, which can be a condition that also modifies the data. Warning Branches, loops and conditions do NOT modify metadata in any way. Furthermore, even if a branch does a backup of jobinfos and the data file, it does not back up the metadata. Keep this in mind when designing a process.
Properties Backup Tab l l l l Backup job file: Select if you want PlanetPress Workflow to use identical copies of the job file for the main and secondary branches. When this option is not selected, the file generated by the output task located at the end of the secondary branch is used as the job file for the main branch. Note that if the secondary branch ends with a Delete output task, the main branch will not receive any job file.
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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
Properties General tab l l File name mask: Enter one file name mask or multiple masks separated by a semicolon (;). See Masks. The condition will be tested True only in the case of an exact match, so consider using wildcard characters. Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
Properties General tab l l l File size is: Select whether the condition is to check if the job file is smaller (less than) or larger (more than) then the specified value. Kbytes: Enter the minimum (more than) or maximum (less than) size setting in kilobytes. Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa).
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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess. When a process encounters a GoSub action, it halts its own execution, start the subprocess and waits for it to complete before resuming its workflow with the next task. Every subprocess starts with a BeginSub input task and ends with a EndSub output task, both of which have nothing to configure and cannot be replaced or deleted. The simply represents entry and exit points for the subprocess.
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. 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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
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 723. 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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Input Any data file, in any format. 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.
l l l l l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog. Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Language 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.
Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties. The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from within your script. 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 723.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
This task is dual-purpose: It can be used either as an Action task, or as an Output task. In either case, it does not directly produce an output, though the process it calls may produce one or more outputs. In either case, the called process will ignore the input task along with its job infos and schedule, and use the job file, job infos, metadata and variables from the current process. General tab l Process: The name of the target process to send current job to.
l 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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
retrieve error and other status messages that printers send out, such as being out of paper or having low toner. PlanetPress Workflow uses the SNMP protocol in the form of an SNMP Condition, in to ways: l l To check the status of printers on your network against values you set in a condition, and to return a true or false value. This is called setting a Printer condition in the SNMP condition's Properties dialog box.
l l l l Description: When you click Get info, if PlanetPress Workflow is able to communicate with the device, it displays its description here. Condition type: Select Printer Queue to test a standard printer status condition or User Defined to test a status identified using a printer specific identification code. Bear in mind that the failure to comply with any of the test conditions selected below will make the whole condition False.
hard disk, or to modem mode. Using an SNMP condition, PlanetPress Workflow can communicate with a device located at a given IP address and request the status of the object identified by a given MIB OID number. Object Identifiers are typically assigned and registered by device manufacturers. They are based on a standard known as Abstract Syntax Notation One (often referred to as the ASN.1 standard). On Error Tab The On Error tab is common to all tasks.
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 Workflow 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.
can be used to test whether or not the first string is equal to the second one, whether it is equal or lower than the second one, etc. The logic of text conditions can sometimes be tricky, especially if it includes variable strings, so you should test it thoroughly. Properties General tab l l l l l l String: If you want to test the presence of a given string at a given location, enter the string in this box.
l l l l Compare to string: You cannot enter a comparison string when either “Is found” or “Is not found” is selected in the Operator box. Enter the second string of the comparison in this box. As with the String box, you can enter a static string, a variable or a data selection in this box. Page range: Select Any page if you do not want to specify a precise data page. Select Pages to specify individual pages or page ranges.
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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
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: In the initial input tasks, this group is disabled 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 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 l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
Create MRDX The Create MRDX action task is used to register a job on a Suretrac server using an MRDX file. The MRDX contains information about the job and its finishing, as well as integrity features use by SureTrac. This task requires a PDF file as an input, along with metadata generated through a document that contains PitneyBowes Scan Codes. Properties General Tab l Register Job to the SureTrac Server group: Check this option to enable the group.
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: In the initial input tasks, this group is disabled 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.
Input Any data file present on a SharePoint document store, even those not compatible with PlanetPress Workflow emulations, and the properties of these files. Processing The task connects to the selected Document store and retrieves a copy of files according to the specified rules. The files may be deleted or marked as checked out depending on the options selected, otherwise they are untouched. Output The output to this task is a series of individual files, one after the other.
l l Do not download checked out documents: If the document is set as "Checked Out" in SharePoint, it will be ignored. Action Group l l l Download the document: Simply download the document and do not modify it in SharePoint. Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint. This is useful for preventing files to be downloaded more than once.
Job Information definitions l l %1 - Source file name: Contains the name of the current captured file. %2 - Directory: Contains the name of the SharePoint director from which the current file was captured. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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 Workflow 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.
Input Any file that is compatible with Laserfiche (see the Laserfiche user manual for more information on supported files types) Processing A connection is established with the Laserfiche server, the file is uploaded and the metadata in the Laserfiche server is generated correctly. Output The output from this task is the specified file along with the metadata within the Laserfiche server. The file is not directly modified by this task.
l l Configure Templates: Click to open the Configure Templates dialog. See LaserFiche Repository Output - Configure Templates. PlanetPress archive folder: Folder path of the folder capture of the current process. This field is optional and should only be set when publishing PlanetPress Workflow archives that have PDI files.
l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process.
Restrictions l l Each Laserfiche Repository Output task uses a connection to Laserfiche. You can use as many Laserfiche Repository Output tasks at the same time as your Laserfiche license allows. If you see the error message ‘The session number was exceeded’ in the PlanetPress Workflow Service Console, it means you have exceeded your allowed number of connections.
task, otherwise it will run as many times as there are metadata sequences, which will result in decreased performance. Input Any compatible data file, requires metadata to be present. Processing The task parses each level of the metadata and, for each field of the specified name it finds, a lookup is made. If a field of the same name appears on multiple levels, the lookup will happen for all fields, on all levels, individually. Output The original data file is unchanged.
l l l l l l l Add Field: Creates a new field with the data. This may cause multiple fields to be created. Replace field value: Replaces any existing field with the new content. Only the last result will be displayed. If the field does not exist, it will create it. Append field value: Ads the data to the existing field within the same one. No "separator" is added. If the field does not exist, it will create it. Result Field: The metadata field name in which the result should be stored.
l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the 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. Use Cases Use Case 1: Send Personalized Emails with Promotional Document Attached A PlanetPress Design document takes as input a PDF file as the input data file, and reproduces it exactly as it enters.
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. This is the same technique used in the "WinQueue Input" on page 249 when generating PDF files.
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. There is no guarantee that the database, connection string or statement are still valid, especially if the DOC file was moved or sent to someone else. Use custom settings: Override the mail merge settings in the Microsoft® Word® document and lets you specify your own.
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: In the initial input tasks, this group is disabled 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 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.
l Document to Publish group: This is where you specify the document location and type. It is mandatory to enter valid information in all the boxes included in this group. l l l l File Type: Select the appropriate document type. HTML for forms that users can fill out, and PDF for documents users can read. 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 names are case insensitive. Click the button marked with a plus sign to add a category to this list box. To remove a category, make a selection in the list and then click the button marked with an X. l Fail process if any of the categories does not exist: Check this box if you want the process to fail if any of the categories listed above does not exist on the Capture OnTheGo Server.
l l l l Until: If you want the document to remain in the repository until a given date, select this option and enter a date in the corresponding box (the date format must be “YYYY-MM-DD” - note that you can use the date picker). The date entered corresponds to the last day of validity (the document is valid until 11:59:59 PM on the date you entered). If you leave the box empty, the document will not be removed from the repository based on this setting.
Properties General Tab l l l SharePoint Site: The name of the SharePoint site where you want to send the files. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to send the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously. Folder: The folder location in the document library where your files will be sent.
l l Choice: This type contains the menu to choose from. Number: This type may contain a number (1, 1.0, 100). The decimal separator is “.” in the plugin. l Currency: This type contains the currency ($ …). l Date/Time: Date/Time fields contain a date and time l l Yes/No: Yes/No (menu to choose from). If passing a variable, has to be either "Yes" or "No". Hyperlink or Picture: This type contains an html hyperlink or picture.
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. 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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
Output A TIFF in the CCITT Group 4 compression, and information for the FAX server to know where to send the file. Task Properties General tab l l l l l Host: Select the IP address of the PlanetPress Fax host to which you want the request to be sent. The Fax configuration is set in the PlanetPress Fax User Options on the target host. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box.
The following describes the properties specific to PlanetPress Image output tasks. For information on those properties shared by various types of tasks, such as Other and On error properties, refer to Configurations, Processes and Tasks. Technical In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PlanetPress Workflow is running, so emails are not sent out automatically.
l If the data file is a postscript file and either mode is used, the postscript file is sent to the PlanetPress Image host which generates output (since this is already Optimized PostScript, it is not regenerated). Properties General tab l l l Host: Select the IP address of the PlanetPress Image host to which you want the request to be sent. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box.
l 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 l PDF: The output will be a PDF file. If you select PDF, the DPI and Color Depth options (see below) are disabled and the options available in the PDF tab are enabled. JPEG: The output will be a JPEG file.
l l l l l l Archive output: Select to archive generated files. If you select this option, you must enter a folder path in the Archive folder box and a name in the File name box. Send Email: Select to send the generated file via email. You enter the emailing properties in the Login, Recipients, and Attachment(s) tabs. Note that the generated file will only be sent if you select the Attach output file(s) option in the Attachment(s) tab.
l l Job options: Select the PDF output option that best describes your needs. This loads all the standard settings for the selected usage scenario. These settings can be changed as required. Note that if you make changes and then select a different output option, your changes will be lost. PlanetPress Image supports numerous PDF standards: Standard, High Quality, Custom, and a variety of PDF/VT, PDF/A and PDF/X formats.
l l Monochrome images group l l l Keywords: You may enter keywords for the document. Since this is a variable property box, you may use variables and data selections and let PlanetPress Workflow interpret this information at run-time. Compression: Select the compression to use for the monochrome images. Flate compression is lossless, so no data is lost during compression.
l l Color images group l l l l Resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. 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.
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. Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128). It gives the task the ability to take an existing PDF in input and apply the selected password to the PDF without any change to the quality level of the original PDF.
PlanetPress Search Database tab If PlanetPress Workflow is configured to automatically update a PlanetPress Search database (See "PlanetPress Image preferences" on page 710), this tab can be used to override the global settings so that the task updates a different database than the one set in that global configuration. In order for the settings to work, the Add PDF to PlanetPress Search database must be checked.
Login, Recipient, Attachments For the Login, Recipient and Attachment tabs, please see the "Send Email" on page 584 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.
directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and metadata are completely ignored by this task's condition rules, and the database information is used instead. 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.
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. 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 Pidget setting: Triggered by specific pidget settings. 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 l ICR Confidence: Triggered when the confidence percentage the ICR engine gave to the ICR value compares with the value determined in the "Confidence" box, using the chosen comparison operator. 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.
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. 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.
database. While it is not recommended to separate each document on its own as it removes all optimization and makes the database much larger, you may split into document batches such as 250, 1000 or 2500 documents. If using the Metadata Sequencer it is generally recommended to place the Sequencer and the Capture Fields Generator tasks within a branch and, within the Capture Field Generator's On Error properties tab, to set it to stop the branch if any errors occur.
l l Document Title: Enter a name for the document that will be saved inside the PlanetPress Capture Database. This name should be unique and recognizable and will be used later to retrieve the document form using the Get Capture Document action task. Document Title group: Determines a Title for the document. This title is accessible in the Capture Database and can be used to search for a document or retrieve a list of document using other tasks.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID. l Reset to defaults: Resets all options in this tab to their default values. l When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Processing The PlanetPress Capture Fields Processor action task receives and processes the information sent by the Anoto digital pen and updates all the documents in the PlanetPress Capture Database using the information from the pen. Any ink in the pen is added as an EPS (image) layer on the PDF inside the Capture Database. If a specific document needs to be closed to release its pattern, this task does so.
l l l l l l l l CapDocID: The database ID of the document. This field is useful especially if using the Capture API since the ID corresponds to the itembyID function. CapDocName: The name of the document as specified in the Capture Field Generator. CapOpenDate: The date at which the document was created by the Capture Field Generator. CapPatternSequence: The value of the pattern sequence assigned to the document.
l Pattern sequence group l Type: Specify from where the Pattern Sequence should be taken. l l l l l l l l l Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database. Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the Pattern Sequence to be used.
Technical When the "ignore out of bounds ink data" option is checked, this option modifies the way that the On Error tab reacts. When a single split is processed and generates an error, only that split triggers the On Error tab. The other splits continue processing as usual. If another split generates an error, it also triggers the On Error tab.
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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Capture PGC Splitter The Capture PGC Splitter task can be used to separate each document into its own PGC file so they can be processed separately. The splitter then sends each document PGC to the next action, which should be the Capture Fields Processor task. Note that using the Capture PGC Splitter will cause your process to take more time, since each PGC must pass through the Capture Fields Processor and then the Get Capture Document task.
l Type: Specify from where the Pattern Sequence should be taken. l l l l None: Do not use a Pattern Sequence. Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database. Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the pattern sequence to be used.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
Extract ICR Data The Extract ICR Data task retrieves the ICR data from the specified document ID from the Capture Database and adds this information to the current Metadata in the process, at the specified level. Input Any data file, but generally one associated with the document in question (either a PGC or a PDF), along with an associated metadata file. Processing A query is made to the Capture database and the ICR data is retrieved.
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. Action: In the initial input tasks, this group is disabled 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.
about each document and places the information in the data file it generates. Output The data file generated by this task is an XML structure containing the data about each document. It also generates metadata that is compatible with post-processing tasks such as the "Capture Condition" on page 442 and "Get Capture Document" on page 468 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 l l l Pattern Sequence: The Pattern Sequence in which a document is entered. Template name: The name of the PlanetPress Design document used to generate the Capture document. This is set in the document's properties, in PlanetPress Design. 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.
l l l l l l l Last: Date comparison, documents of which the date is within the specified interval are included (Date Generated and Date Closed filters only). Older than: Date comparison, documents of which the date is older than the specified interval are included (Date Generated and Date Closed filters only). 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.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
When retrieving documents from the database, the PDF from which the document is obtained will remain in the database until each document contained in it is retrieved from it. For example, if a 10-page PDF contains 5 documents, the 10 pages remain in that PDF until all 5 documents have received ink, been closed and retrieved from the database. This may mean space issues if too many PDF files remain in your database.
manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database. l Document Type group l l l l Get all documents: Get all the documents that have been updated, according to the metadata. Get closed documents only: Get only the documents that have been closed in this process, according to the metadata. Close document after retrieval: Once the task has retrieved the document from the Capture database, the document will be closed even if it is incomplete.
l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
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. PGC to PDF Converter The PGC to PDF Converter tasks extracts the digital ink located in a PGC file and adds it to a blank PDF, creating one page per document in the PGC.
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. To access the On Error tab, right-click on the task and select "Advanced Properties...". Examples & Use Cases This task is put into effect in the following use cases and example processes: l PlanetPress Capture Workflow On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Metadata Tasks Metadata tasks are plugins that can create or edit metadata for a job file. For more information about the metadata structure and elements, see "Metadata" on page 35.
If the "Do not use document (passthrough)" option is used, no PlanetPress Design document is used. The metadata will contain a single Job, Group and Document level, as many data page levels as there are records (pages in a PDF, XML levels, etc) in the file, and one page level per data page. 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.
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. 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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
and it becomes the current metadata from this point on, overwriting any current metadata file that may already be set. l Embed metadata from PDF job file: the current metadata file is inserted in the current data file, which is assumed to be a PDF file. If the original PDF is PDF/X or PDF/A compliant, the resulting PDF file will also be compliant. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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 Workflow 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.
Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties. If the field is present in a level that repeats (for example, the data page level), this task loops so that the action may take place on each of the occurrence of that level. 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.
l l Field Value: Enter the metadata field value. Note that if the chosen action is Delete, this parameter is disabled. For other action types, in order to set the field value, click the [...] button. This button opens the Data Selector, which allows to specify a data selection as the field's value. Decimal Separator: Set the decimal separator for the Sum option. 3 possible modes are offered: l l l l Auto-detect: Interpret automatically the value.
the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration. l 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. If the task is not on a branch, the entire process will be stopped.
with the OK button, and are displayed in the Task Comments Pane. New Wild Card For a given Metadata Field Management action, all nodes of a given level might be updated with a new Field Value. To accommodate this, metadata/data selection functions have been modified to accept a wild card parameter "?", indicating the function operates on all nodes (not just one) of a given level. For example, in a PDF emulation, the format of a selected region is: region(?,0.59375,2.21875,1.85416,2.
Output This task outputs the exact same data that was given to it. Its metadata will either be missing (Delete Metadata), Changed (Load Metadata) or the same (Save Metadata). Properties l Chose an action group l l l l l Load metadata file: Loads an external metadata file that was previously saved. This can be useful in Error processes if you have previously saved the Metadata to file (ErrorBin outputs do not transfer Metadata).
l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
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 Filter The task allows specifying the Level (Group, Document and Datapage) on which to perform the action and under which condition. At least one level must have the condition set.
l l Rules: Define according to which criteria the action must to be performed. The condition must be TRUE to execute the action. All nodes on a specific level with false condition become Unselected. The task effectively both selects and deselects nodes based on the condition. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action. See the Rule Interface page for more details.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
Metadata Level Creation Conditionally create new metadata groups or documents. This task is only functional if metadata already exists for the current job. The task enables users to merge data pages into Documents and/or merge Documents into Groups, based on conditions. Unselected Data pages are ignored, but are moved with others Data pages if the action is applied to the current parent node. Input Any data file with accompanying metadata. Processing The metadata file is split on the selected level.
rule is not applied. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action. See the Rule Interface page for more details. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
where "?" represents the current page. Using this expression, if the metadata structure has 3 data pages, then the task will proceed 3 times sequentially, with ?=1 for the first data page, ?=2 for the second and ?=3 for the third and last data page index from the metadata structure. In the Metadata tab of the Data Selector, the syntax of the selection is: GetMeta(ItemDesc[?], 2, Job.Group[?].Document[?].Datapage[?]) where "?" is replaced with the current level index.
sequence, the entire data file still gets carried from one task to another. Metadata records are simply selected / deselected, which has the same effect. Input Any data file with accompanying metadata. Processing A loop is established and the metadata is separated into chunks, as defined in the rules set forth in the task properties. Output The original data file is output once per chunk, along with this chunk's metadata.
starts or the current sequence is ended. The next sequence starts with the next metadata level being processed. For details see the Rule Interface. Metadata Sorter The Metadata Sorter action task allows metadata to be sorted sequentially on three different levels, alphabetically or numerically. It also allows sorting in ascending and descending order. Input Any data file with accompanying metadata.
l Numeric Sorting: Check to sort numerically instead of alphabetically (only supports whole numbers. Currency with thousands separator and decimal points will not work). If any non-numeric value is found in the field or attribute, in any instance of the level, the task raises an error. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
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 Workflow 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.
Processing The metadata is read and PDF indexes are located. These indexes are defined in the PlanetPress Design document as data selections, in which the Archive / Email / Fax properties define the data as an index with a name. When all the indexes are collected, a PDI file is generated with those indexes. Output The output is the same as the input, no modification is done to either the data file or the metadata. However, a PDI file is generated and saved in the location specified in the task.
l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the 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 l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
specifically to communicate with the Server component of PlanetPress Connect or PReS Connect. OL Connect includes a set of automation tasks to communicate with the Server component and automate certain tasks such as creating record sets, generating contents and generating output. All In One The All In One action task is a combination of 4 different OL Connect tasks within a single one.
model attached to the configuration in the Data Mapper module, to verify that the right one is used. Only works for configurations listed (will not work for "None" or "Dynamic" options). l Filter: Retrieves records from the Connect Database. This is identical to using the Retrieve Entities task. l Filter type: Determines at which level to retrieve the records: l l l l l l l l l Add a condition: Click to add a new condition line.
l l PDF/VT with Content Creation: Expects a PDF/VT file as an input and executes basic data mapping on the file. This is the same as using the passthrough option in the Create Record Set task. Content Items are created automatically. When this source is selected, the Content Creation tab is disabled. Do not store records in database (faster): Persisting records in between Data Mapping and Content creation is costly in terms of performance.
By default the entire Print context is printed. Printing selected Print sections can only be achieved with a Control Script in the template (see Control Scripts in the Designer Help). Output Creation Tab The Output Creation tab generates the output for the current job, using the selected Output Creation Preset. Note that the Job Creation task normally necessary when using the individual tasks is implicitly executed before output creation.
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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
Create Email Content The Create Email Content task generates a set of email content items from a template's Email Context, which are then sent directly to the recipient set in each record. Input This task must receive 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. For each record, an HTML Email is generated using the record's data.
Email Info l Email information group: l l l l Sender Address: Enter the email address that appears in the "From" field of the email. This email address overrides the "From" email address that was set in the template, unless the option Precedence to template address is checked (see below). Mail host: Enter the address of the SMTP server through which emails should be routed. This information should be available from your IT staff. A port number can be added, separated by a colon (for example: smtp.
l l Web Content as HTML page: Check to generate one Web section in the template as HTML file and send it with the email as an attachment. Test SMTP settings: Click to send a test email from the Sender Address to the Sender Address, using the given host and settings. Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences.
l Action: In the initial input tasks, this group is disabled 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 Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the 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 Job The Create Job action task prepares a series of print content items for output generation. A Job is not actual contents but simply a collection of content items ready to be printed.
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 559 task. "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below. Preset Names: Select the appropriate preset to generate output.
l 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: In the initial input tasks, this group is disabled 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.
File function in PlanetPress Connect. l l l "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below. Preset Names: Select the appropriate preset to generate output. 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).
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Properties The Create PDF/VT action task properties are as follows (note that the Connect Proxy tab is not present as this task does not communicate with the OL Connect Server module): General Tab l l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. Recipient Node: Use the drop-down to select which level of the metadata is used as the "Recipient" node.
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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Create Preview PDF The Create Preview PDF plugin generates a PDF preview for a single record as fast as possible. This preview is typically used for previews embedded in web pages. The plugin retrieves the resulting PDF from the file store and makes it available to the process as the job data file. The job file name extension is .pdf.
Note When the data mapping configuration provides multiple records, the preview is created based on the first record. l JSON string sets the data source to a JSON string (see "Using JSON" on the next page). A text area is shown allowing the user to enter the JSON string. The JSON string may contain local and global variables, Job Infos and calls to the lookup function (see "JSON string samples" on the next page). A single variable can be used, assuming that the respective variable contains a JSON string.
values through the record's data fields. (See the Designer help: Adding Variable Data). Using JSON In web environments, it is common to send and retrieve data from a server using an AJAX request (typically invoked from within a JavaScript). Then the data is often exchanged in JSON format. JSON is short for JavaScript Object Notation. It is a way to store information in a structured and easy to read format. It is often referred to as XML without nodes and meant for exchanging data.
"datafile_name":"lookup(OLCS_jobs, datafile_name, jobid, '% {jobid}')", "pages":"lookup(OLCS_jobs, pages, jobid, '%{jobid}')", "documents":"lookup(OLCS_jobs, documents, jobid, '%{jobid}')", "recordsetid":"lookup(OLCS_jobs, recordsetid, jobid, '%{jobid}')" } An example where the entire JSON string is provided in Job Info 1: %1 A JSON string constructed with information retrieved from an XML job data file: { "first":"xmlget('/request[1]/values[1]/first [1]',Value,KeepCase,NoTrim)", "last":"xmlget('/request[1]
OL Connect Proxy Tab l Server Connect Settings l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340. User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab The On Error tab is common to all tasks.
l l l l l l Log Message: Check this option to enable logging a custom error message in the PlanetPress Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
Input This task can receive either the information regarding a valid Record Set (which can be the output of the Create Record Set task, or a Record Set retrieved using the Retrieve Entities task) or a PDF/VT File. Processing In the case of a record set and template, this task loops through each record in the Record Set. For each record, an one or more pages are generated using the record's data and these pages are saved as a content item in the database.
Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server.
iteration. 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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Create Web Content The Create Web Content action task generates the output of the HTML Context of a specified template and returns the HTML code to PlanetPress Workflow for further processing and return to the requester. Generally, this task is placed within an HTTP Server Workflow. 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.
l Update Records from Metadata: If the process metadata has been modified by any Metadata related task, check to use the updated metadata. Otherwise, only the ID of the current job is sent, and the metadata on the Server is used. Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences.
l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
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. Execute Data Mapping The Execute Data Mapping action task generates a record set by executing a data mapping configuration on a data source. It can also automatically create a record set from a PDF/VT file without using a data mapping configuration.
Properties General Tab l l l Data mapping configuration: Enter the full path to a valid data mapping configuration (.oldatamapper) file, or use the Browse button to find the path. Data Source or PDF/VT file: Enter the full path to a valid data source compatible with the above data mapping configuration or a PDF/VT file, or use the Browse button to find the path. Output Type group: l l l Output IDs in Metadata: Select to only output the Record and Job IDs in the metadata.
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 723. 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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Output The same metadata that is input. Properties l Set types to mark for deletion based on metadata content: l l l Job Set: Tag any Job set created by the Create Job task or the Retrieve Items task set to retrieve Job Sets. Content Set: Tag any Content set created by the Create Print Content task or the Retrieve Items task set to retrieve Content Sets. Record Set: Tag any Record set created by the Execute Data Mapping task or the Retrieve Items task set to retrieve Record Sets.
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. 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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Workflow processes in Connect Send For help on the configuration of Workflow processes in a Connect Send solution, see Workflow processes in a Connect Send solution. Job Processor The Job Processor plugin is an output plugin that appears in the Plug-in Bar of Workflow under OL Connect Send. Input The Job Processor plugin must be added to a Workflow job transfer process that starts with an HTTP Server Input. The Job Processor plugin is the only other task in that process.
If OL Connect Send is unlicensed, the plugin stores the incoming job in the target folder using the specified file name, but it does not save any information in the database. The end user will receive a message in the Notification Area (also called "system tray") confirming the unlicensed status, and the printer driver will not request another web page. In licensed mode, the plugin will store all relevant information about each job in the OL Connect Send database.
Database connection The Job Processor plugin works with a database to store all relevant job information. This database is a HyperSQL Database (HSQLDB, see https://en.wikipedia.org/wiki/HSQL_ Database_Engine). It is installed as a service with the name OL Connect Send DBServer (the internal service name is OLCSServer). Communication between the plugin and the database occurs using port 9001 (the default port for HSQLDB).
Note If no extension is defined by the user for the file name, the default “.ps” extension is added automatically, as the incoming print jobs are PostScript files. Workflow variables Variables can and should be used to create dynamic file and folder names for each print job. This enables separating licensed and unlicensed jobs and/or storing the files by domain, machine and even user name.
l Plug-in Information l l License: Shows whether a license for OL Connect Send could be found. If not, OL Connect Send will be running in unlicensed (default) mode. Protocol version: Here the plugin shows which protocol version is used. The OL Connect Send components communicate with each other by using a well-defined and versioned protocol. As long as these components use the same protocol version, the job transfer will work even if the plugins themselves are changed.
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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
The plugin appears in the Plug-in Bar of Workflow under OL Connect Send. Typically, it is used in the OL Connect Send interaction process, just after the initial HTTP Server Input plugin. The Get Job Data plugin gets all relevant information for the dedicated print job using the Unique Job ID. Whenever an OL Connect Send Printer Driver is sending a print job to the OL Connect Send Job Processor plugin, it creates a unique ID string composed from 10 upper- and lowercase letters and digits e.g. “ri0zZdluLp”.
processing. l Read from Variable: When selecting this option, any existing Workflow variable can be chosen via the drop-down field. In this case, the plugin reads the Job ID from that variable. Select Returning Type Depending on this setting the plugin gets status information about the job before it has arrived or it gets information after the job has been completely received.
l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Date/Time stamp: This is the time when the matching job was initially created in the database. It is stored in UTC format plus time zone indicator inside the database. It will differ from the time stamp logged by the OL Connect Send Printer Driver as well as by the OL Connect Send Job Processor. Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value.
l l l Domain / Workgroup Indicator: This domain name is the real domain name or only a workgroup name. For explanations about domains, domain names, users, user names, user domains, logged on users vs. application running users, machine names etc. please refer to the respective Windows help pages or ask your system administrator. Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
Note The Get Data plugin gets data from the OL Connect Send database which means it only works when Connect is in LICENSED mode. Properties General Tab Filter options Filters are required for: l Start and end date (down to minutes) l Domain(s) l User(s) l Machine name(s) Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: l Workflow variables l Job variables l Names.
Example 1 A valid user name search string, entered in the Filter Users field, would be: %\{global.User};helen;%1;george napier This would look for all entries, where the user name is either: l as currently stored in the global Workflow variable User l "helen" l as stored in the job variable number 1 l equals "george napier" (case insensitive). These search criteria are combined with OR. Example 2 The domain name entered in the Filter Domains field is objmtl.objectiflune.
and minute is a colon) It is possible to define the same date for From Date/Time as for To Date/Time. However, entering the same info (without time information) would lead to getting no entries.
Returned information For each job received by the OL Connect Send Job Processor plugin the following values will be available. l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Date/Time stamp: This is the time when the matching job was initially created in the database. It is stored in UTC format plus time zone indicator inside the database. It will differ from the time stamp logged by the OL Connect Send Printer Driver as well as by the OL Connect Send Job Processor.
l l l l l Original file size: The size of the print job - NOT the size of the document file. Domain (workgroup) name: The name of the domain or workgroup the printing user belongs to. This is not necessarily the name of the domain the machine itself belongs to. Domain / Workgroup Indicator: This domain name is the real domain name or only a workgroup name. For explanations about domains, domain names, users, user names, user domains, logged on users vs. application running users, machine names etc.
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 Workflow log file and in the Windows Application Events. Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message.
together. Since this task can retrieve items at any level, it can be used to generate metadata used in multiple tasks. Input The task requires no input file, but any input information such as metadata, job information or data file can be used to specify which items to retrieve. 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.
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.
often used to separate mail routes, provinces, or cities. l Sort items based on: Use the [...] to open the Sort Parameters dialog and define how documents are sorted within the group, for example by Zip Code. Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences.
l l l l l l l l l Default: By default, the task is ignored as if it did not exist and the error is logged before continuing the branch or process; the job file is passed on to the next task in the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration.
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. Pick Parameters The Search Parameters define how the to pick entities retrieved from the Connect Database using the Retrieve Items task and place them together in Documents or Groups. Items are picked using either Properties or Values.
(such as record-level properties), the Metadata should be split using the Metadata Sequencer task first. Output The task outputs metadata that is identical to the input Metadata. Only the entries on the OL Connect Server side. Properties General Tab l l Entity: Use the drop-down to select the entity type of which to set the properties.
l l User name: Enter the user name expected by the OL Connect Server. Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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 Workflow 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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Other tasks available in PlanetPress Workflow can be used to generate output, such as Digital Action, Create VDX and PrintForm action tasks. Unlike output tasks, action tasks are only considered completed once the output file has been generated. In the case of a Digital Action action task, for example, PlanetPress Workflow will consider the task completed only once the image file has actually been created. This means that no other task from the same process can be performed in the meantime.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
Properties General tab l FTP Server: Enter the IP address or host name of the FTP server. l Port number: Set the plugin to use a specific port number. l l Use FTP Client default port number: Use the value as specified in the Preferences (port 21 is the default value). FTP Port: Enter the specific port number to use when Use FTP Client default port number is unchecked. Enter a value between 1 and 9999. Note: There is no validation to ensure the port is available.
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: In the initial input tasks, this group is disabled 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.
In the case of "string" type data, SOAP Client plugin tasks normalize all line endings to a single line feed character. Properties General tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the drop-down list. Note The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port).
l l l Value: Lets you enter fixed or variable values. To exchange variable information between the Web service and PlanetPress Workflow, you must use job information variables %1 to %9 or variable %c (which contains the entire job file). Note that return values (arguments which are used to return information to the SOAP Client) are displayed in bold font. Namespace: Displays the namespace of the arguments associated with the selected method.
the process. When an error occurs in a loop (or in a plugin that acts like a loop), the loop may log the error, terminate the current iteration and proceed with the next iteration. l 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. If the task is not on a branch, the entire process will be stopped.
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. Since the printer driver itself is not necessarily postscript, we cannot optimize the print file, so using a Windows Driver Output will always generate a larger and slower print job.
Windows print driver, which takes the relay for the actual printing part, so there is no way for your PlanetPress Workflow Tool to ensure that all the settings you make will be applied to the printed document. l l Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used. You may use a different variable, but you may not use a data selection. This information may be used for the printer’s banner page. Job owner name: Enter the job owner name.
On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723. 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.
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. When storing the message or ID, if they are stored in a jobinfo they will be available in any error handling process where errors are being forwarded.
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. For example, sending a JPG file in pass-through to an FTP or Send to Folder output will simply place the file in the destination.
l l l l l l Queue balancing: Queue balancing means that jobs will be split according to the criteria set in the Page delimiter group (see below) and that a share of the job file corresponding to each printer’s capacity (as set in the PlanetPress Workflow Printer Queue Options dialog box—See "Print Using a Windows Driver" on page 577) will be sent to each one of the selected printer queues.
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. 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.
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
Once the contents of the file and attachments is determined, the email (and attachments) is either sent directly to the selected SMTP server, or is deposited in the "Outbox" folder of the local Microsoft Outlook account. 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.
l l l l l l l Attach input job files: Select to attach the file received by this task to the emails it will generate. If this option is not selected, the recipients will not receive any of the data file. File: Select additional files to include as attachments. You may enter the file name directly and use text, variables and data selections. You may also use the Browse button to navigate and select the file.
l l l l l l Reply address: Enter the reply address that will be used in emails sent by PlanetPress Workflow for this task (this is optional). Outgoing mail (SMTP): Enter the IP address of the mail server PlanetPress Workflow is to use to send emails via SMTP. Port: Specify the outgoing SMTP Port if it is different from the default port (25). Server requires authentication: Select if the outgoing server mentioned above requires authentication.
loop may log the error, terminate the current iteration and proceed with the next iteration. 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. If the task is not on a branch, the entire process will be stopped. Stop Process: The process is stopped and no more processing is done. No further output is produced.
Send to Folder Send to Folder output tasks send the files they receive to a local folder. They perform the same function as Send to Folder action tasks, with the only difference being that in this case, PlanetPress Workflow will not wait for the task to be completed before going on to the next task in the configuration. The following describes the properties specific to Send to Folder output tasks.
This feature is part of the PDF Tools, which is only available in PlanetPress Workflow. l Separator string: This option is used to add a separator string between the content of each file when the Concatenate files option is selected. On Error Tab The On Error tab is common to all tasks. Details can be found in the" Task Properties Dialog" on page 723.
l l l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Workflow log file. You can use any variables available in PlanetPress Workflow to customize the message. Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content. ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Workflow log file.
l l l Global Variables are available by all processes and tasks within the configuration, and any modification made to them affects all tasks and configurations. For more information see "Manipulate Global Variables" on page 632. Local Variables are specific to an instance of a process. That is to say, when a process changes the information in a local variable, it changes it only for that process and only for that specific instance of the process.
You can set the value of a job info within your process in two ways: l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 332. You can use Scripts. See the chapter "Using Scripts" on page 87. Considerations on Job Infos: l l l While the initial job infos are created by the input task, they can be overwritten by the Set Job Info and Variables Action Task, by a Script, or by any secondary input task in the process.
Variable Name Example value when interpreted Name including the file extension. %z Job File Size in bytes. 34134 %o Original File Name invoice_june2nd.
Variable Name Example value when interpreted %h Current Hour 18 %n Current Minute 03 %s Current Second 41 %v Current Millisecond 24 %u Unique 13char string (will be different every time it is used) 0ZIS4CW8U47VI00 %t Current Temporary Folder C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Workflow 7\PlanetPress Watch\Spool\6.tmp\ %e Current Metadata Filename job00ZAIZ2C4FXON16CE6C566.dat.meta %E Current Metadata Path and Filename C:\Documents and Sett
Variable Name Example value when interpreted Iteration Index (always the innermost loop) 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 Get Capture Document l Loop l Capture PGC Splitter l PrintShop Mail Error Handling Variables The following variables are available in error-handling tasks (that start with the Error Bin Input task). Note that these are new in PlanetPress Workflow 7.4 and are not available in previous versions. Variable Name % {error.process} Name of the process where the error was triggered % {error.tasktype} The type of task that triggered the error % {error.
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 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. Deleting a variable, on the other hand, does not delete any reference to it.
To add a global variable from the Configuration Components pane: 1. Right-Click on Global Variables. 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).
Script task. Deleting a variable, on the other hand, does not delete any reference to it. In both the case where a script refers to a variable and it is renamed, or in the case of deleting a variable, any task or script that refers to it will cease to function and will generate an error. You can set the value of a variable within your process in two ways: l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 332. You can use Scripts.
l l For information about Processes and Subprocesses, see "About Processes and Subprocesses" on page 78. For information about Global Variables, see "Working With Variables" on page 591. Create a New Configuration When you start PlanetPress Workflow, it always opens the configuration file that is active on the PlanetPress Watch service.
configuration before opening any other configuration (See "Saving and Sending" on the facing page). Note You can also open a configuration file from a previous version of PlanetPress Workflow by changing the File Type selector to the desired version (for example, .
To save the current configuration under a new name: l l From the PlanetPress button, choose Save As. Browse to the location where you wanted to save the file, enter the new name of the configuration in the File name box and click Save. Sending a Configuration PlanetPress Workflow Configuration saves entire configurations in the form of a single file. Like any other file, configuration files may be saved and reopened, as well as rename as desired.
4. Put a checkmark next to each server where the configuration should be sent. 5. Click OK. If a server is grayed out, this may mean you do not have access to send a configuration remotely to it. For more information, please see "Access Manager" on page 656. Note If PlanetPress Workflow service is paused when you send a new configuration, it will not stop and restart.
When the PlanetPress Workflow Configuration program sends a configuration, the PlanetPress Workflow service is stopped and restarted, if it is currently running, and the new configuration starts being applied immediately. If a file different from the default configuration file is currently opened, and if it includes unsaved modifications, the PlanetPress Workflow Configuration program asks you whether to save the configuration before exiting.
l HTTP/SOAP Server service: Monitors web pages and web sites as well as SOAP servers. Available Output Services Output services are used to output jobs. The output services used by PlanetPress Workflow are: l l l l l l l FTP Output service: Places output jobs on a server via the FTP protocol. LPR (Line Printer Requester) Output service: Sends jobs to an LPD server or LPD compatible printers.
information on services and system permissions, refer to Windows documentation. For more information on how to configure the account used by the services, See "Workflow Services" on page 649. The PlanetPress Workflow Service Console, included in the PlanetPress Workflow Workflow Tools Configuration program, can be used to monitor, start and stop PlanetPress Workflow services (See Users and Configurations and "The PlanetPress Workflow Service Console" on page 666).
To pause your PlanetPress Workflow Workflow Tools service via the PlanetPress Workflow Configuration program: 1. Click Tools in the PlanetPress Workflow Ribbon. 2. Click Pause in the Services Status group. The PlanetPress Workflow service temporarily stops performing jobs. Note If you send a new configuration when PlanetPress Workflow is paused, it will continue using the old configuration when you resume processing until you stop and restart it.
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 619. 2. The Quick Access Toolbar. See " The Quick Access Toolbar" on page 731. 3. The Ribbon Tabs. See "The PlanetPress Workflow Ribbon" on page 732.
4. A Group within the Ribbon 5. The Process area. See " The Process Area" on page 719. 6. A specific link (aka a "component", "button" or "link"). 7. The Dockable panels including "The Plug-in Bar" on page 675, " The Object Inspector Pane" on page 674 and "The Debug Information Pane" on page 672. 8. The status bar. This displays your current software version and status of the PlanetPress Service. 9. The Configuration Components pane. See "The Configuration Components Pane" on page 621. 10.
The Configuration Components pane, the Object Inspector and the Messages area can each be displayed inside its own window, whether docked or undocked, but they can also be displayed attached or combined inside the same window. l l l When separate areas are displayed simultaneously, they appear in different sections of the Program window. When attached areas are displayed simultaneously, they appear side-by-side or above one another inside sub-windows.
Show or Hide Areas of the Program Window You can choose to hide or display any of the customizable areas in PlanetPress Workflow program. Hidden areas will still contain the same information but will not be visible. To show or hide a Program window area: l In the PlanetPress Workflow Ribbon, click the View tab. l From the Show/Hide group, click on any area name to hide or display it. A "highlighted" (orange) button means the area is displayed somewhere on your screen(s).
button when the shape of a tab appears at the bottom of the rectangle. To switch between combined area: l At the bottom of the combined area, click the tab of the area you want to bring to the top. If all the tabs are not displayed, use the left and right arrows to navigate between them. The left and right arrows lets you show hidden tabs.
To take an area out of a combined area, do one of the following: l l Click the tab displaying the name of the area you want to take out and move the mouse pointer so as to drag the area away from the combined area. As you drag, a rectangle is displayed to show the landing position. Release the mouse button when the rectangle is away from the combined area. Double-click the tab of the area you want to take out of the combined area. The area will jump outside of the combined area. To attach areas: 1.
3. Resize each part of the new group as desired. Attaching an area to a group of combined areas. The rectangle showing the landing position is not tabbed and the area will therefore be moved next to the combined area. To maximize or restore attached areas, do one of the following: l To maximize a vertically attached area, click the upward pointing arrow on its title bar. l To restore a vertically attached area, click the downward pointing arrow on its title bar.
Page 617
A) Click to maximize this area. B) Click to restore this currently maximized area. C) Click to maximize this area. D) Click to restore this currently maximized area. To take an attached area out of a group, do one of the following: l l Click the title bar displaying the name of the attached area you want to take out and move the mouse pointer so as to drag the area away from the group. As you drag, a rectangle is displayed to show the landing position.
To change the language used by the PlanetPress Workflow Configuration program: 1. Click the PlanetPress Workflow button, then click Select Language. The Select Language dialog box appears. This box lists all the languages that can be used by PlanetPress Workflow as well as the Use System Default Locale check box. 2. Select the desired language. 3. Use System Default Locale: Select to mirror your language settings, as defined in the Regional and Language Options of the Windows Control Panel.
l l l Save: Saves the current configuration. If the file is new and has not yet been saved, or if the configuration is the loaded directly from the service, the Save As dialog is displayed instead. See "Saving and Sending" on page 603. Save As: Saves the current configuration under a new name. It does not overwrite any existing configuration file, unless an existing file is selected and overwritten manually by the user.
The Configuration Components Pane The Configuration Components pane displays processes, subprocesses, variables, documents and printer queues. It also lets you add any of these components using the rightclick menu. Components Area Sections l Processes: Displays a list of processes in your configuration. Right-click on a process to access a drop-down menu that offers these choices: l l Insert Startup Process: Inserts a new process as a Startup Process.
l l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties for error handling. Global Variables: Displays a list of variables that are shared between all your processes. Right-click on a Global Variable to access a drop-down menu that offers these choices: l Insert Global Variable: Creates a new global variable l Cut, Copy, Paste: Controls the clipboard. l Delete: Deletes the global variable from the configuration.
l PPS/PSM Documents: Displays a list of PlanetPress Connect and PrintShop Mail Design document that have been imported into PlanetPress Workflow. Right-click on a document to access a drop-down menu that offers these choices: l l l Cut, Copy, Paste: Controls the clipboard. Delete: Deletes the document from the configuration, as well as the Workflow Tools Working Folders. l Refresh: Regenerates a PostScript Cache from the original document's PTK file. l Group, Ungroup: Triggers grouping functionality.
Processes and Subprocesses The Processes component displays a list of processes in your configuration while the Subprocesses component displays a list of subprocesses. Process Properties To have access to the properties of a process or subprocess: l Right-Click on the Process in the Configuration Components Area. l Select Properties. You can also double-click on the process to show its options.
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.
The Time Grid The PlanetPress Workflow Process Options dialog box includes a time grid that lets you set exactly when you want a process to run. The grid is composed of blocks that represent time periods on a given day. To activate the Time Grid, the "As soon as possible" option must be unchecked. In the Time Grid, a blue block will indicate that the process is active within that time block. 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. 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 681 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.
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. For example, a lot of uses use them to set a server's IP, a printer name, or folder location that is used by multiple processes.
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.
Internet Explorer). 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" on page 509, "Create Web Content" on page 531 and "Create Print Content" on page 527.
l datamapper contains archives of the data mapping configurations (.OL-datamapper) l jobcreation contains archives of the Job Presets (.OL-jobpreset) l outputcreation contains archives of the Output Presets (.OL-outputpreset) l template contains archives of the templates (.OL-template) l workflow contains archives of Workflow configurations received by the server. The archives are saved using the template named followed by a timestamp.
Document Properties Options Identification Tab The information here is read-only and gives you information on the document. l l l l l Document: The file name of the document, as entered in PlanetPress Design. This is the name of the file saved in PlanetPress Design, or the name you give it when you add a printer-resident document in your PlanetPress Workflow Configuration.
l Document location group (enabled only when using Printer-Centric mode) l l l l l On printer hard disk: Select if the PlanetPress Design document is on the printer's hard drive. In printer flash memory: Select if the PlanetPress Design document is on the printer's flash memory. RAM: Select if the PlanetPress Design document is on the printer's RAM (Random Access Memory).
Data Files When sending a PlanetPress Design Document from PlanetPress Design to PlanetPress Workflow, all data files used in the document are automatically sent to PlanetPress Workflow along with the Design Document. These data files appear under the Documents section of the Configuration Components. To set an attached data file as a sample data file in a process: 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.
not appear in the Configuration Components but it follows the data file and can be viewed from the Metadata tab whenever the data file is viewed through the Data Selector. Use Attached Document Preview When sending a PlanetPress Design Document from PlanetPress Design to PlanetPress Workflow, a PDF Preview of the job's output is automatically sent to PlanetPress Workflow along with the Design Document. This preview appears under the Documents section of the Configuration Components.
To add a resident document in the Configuration Components pane: 1. In the PlanetPress Workflow Configuration Components pane, click the Documents button and choose Insert | Resident Document. The Add Resident Document dialog box is displayed. 2. Enter the document’s name. Note that the name you enter must exactly match the actual document name or PlanetPress Workflow will not be able to use it on the printer or remote PlanetPress Workflow server. 3. Click OK.
To modify the settings of a document assigned to a printer queue: The settings available in this window are the same as the Printer Settings dialog of a document properties in the Documents list of the Configuration Components Area, but they are specifically for this document on this printer queue. See " View Document Properties" on page 636 for more details. l Double-click on the document located within a printer queue. The Document Properties dialog appears.
Copy Mouse Pointer Prohibited Mouse Pointer Moving Configuration Components Using Drag & Drop: l Click on the component and hold the mouse button. l Move the component to the location where you want to drop it. 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 on the new location where you want the component. l Do CTRL+V (paste) on your keyboard. Copying components You can make a copy of any component in the Configuration Components pane, with the only exception being Documents (of which you can only have one copy). Copying components is done using the same methods as moving them, with the following differences: l l To move components using the clipboard buttons and contextual menu, replace "Cut" by "Copy". Otherwise the methods are the same.
Rename Objects in the Configuration Components Pane You can rename processes, groups, and printer queues in the Configuration Components pane. PlanetPress Design Documents (ptk/ptz files) are different and cannot be renamed or modified using PlanetPress Workflow. You can, on the other hand, change the name of printerresident documents. Note Names cannot begin with a number.
To reorder selected objects in the Configuration Components pane: 1. Click an object or group. 2. In the PlanetPress Workflow ribbon, go to the View tab then click Order in the Arrange group, then select one of the following: l l l l Up One Level to move the item one level up in the hierarchy. If the item is already the top object in the category, or within a group, this command has no effect. Down One Level to move the item one level down in the hierarchy.
To add a group in the Configuration Components pane: l In the Configuration Components pane, click a category and choose View | Arrange | Group. A new group is added at the end of the category. To add objects to an existing group: l Drag-and-drop the objects onto the group. The objects are added as the last objects in the group. To remove objects from a group: l Drag-and-drop the objects out of the group. The objects are removed from the group.
Delete Objects and Groups from the Configuration Components Pane To delete a process, document, or printer queue: l Click a process, document, or printer queue, then press DELETE. In the case of processes and printer queues, the object is deleted. If there is only one process in the configuration, you cannot delete it; there must be at least one process in the configuration. If you delete the last configured process, a process with two unknown tasks remains.
Note Printer activations are normally given to you by the activations department electronically, including a file that will automatically add all your printers in this dialog. To display the Activate a Printer dialog, click the button from the Help menu. 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.
themselves using a local or network account. The first time you start the PlanetPress Workflow Configuration program, the application automatically asks you to choose an account (see procedure below). You can also manually start this procedure from the PlanetPress Workflow Tools by following this procedure: 1. Click on the Tools tab in PlanetPress Workflow Ribbon, then click Configure Services. 2.
l Services start automatically: Select to start the required PlanetPress Workflow automatically. 3. Click OK. PlanetPress Workflow applies the user account information to all the services (PlanetPress Workflow, PlanetPress Fax, PlanetPress Image, LPD input, Serial input, Telnet input, FTP output, LPR output), that run on this computer (with the exception of PlanetPress Messenger, which always runs under the Local System account).
Options General tab l 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. Self-Replicating Process: Check this if you want the process to replicate itself in the background when multiple input files are received simultaneously.
l Select Date to display dates on the grid’s top ruler. l Select any of the other options to display days on the top ruler. l Select All weeks to have the process run every week. l l l l Select First, Second, Third or Fourth to have the process run on the first, second, third or fourth week. Select Last to have the process run only on the last week. Time division: Select the duration of each daily segment in the time grid.
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.
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. The dialog is separated in two parts: l The left part displays the available tables in your database. Click the Show Tables button to display them.
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. This limitation has been removed in PlanetPress Workflow 7.3 and higher. To open the Access Manager 1. Open PlanetPress Design. 2. In the Ribbon, go in Tools | Managers | Access Manager. The Access Manager dialog box is displayed.
Page 658
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.
l l l l 127.0.0.1: The local computer. Typically this IP should have all the accesses checked. 255.255.255.255: Everyone on the same subnet. This is equivalent to hard-coding the current subnet, such as 192.168.1.255 or 10.0.0.255. 192.168.0.42 : A single IP address. This can be any valid address on the same subnet. 10.0.255.255: Any IP in the 10.0.X.X range. To automatically detect machines on the network and add them 1.
does not continue processing after it has found an "Allow" checkmark. There is no concept of "Deny", meaning if any "Allow" permission is given, there is no way to later remove it for certain 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. HTTP, FTP and SOAP communication is not limited to the local subnet on any version where these plugins appear.
Console. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each user name entered in this dialog can have access to one or more processes. To add a new SOAP user 1. Click on the button. 2.
l l l User name: An alphanumerical user name for the user. Password: A password to protect the user. Note that the password will always revert to ******** (8 stars) when clicking outside of this box - that is normal and is meant to protect the length of the password as much as its contents. Administrator: Choose the permission type l l l User: Can access none, some, or all of the processes, selected individually in the Permissions section. Admin: Has access to all processes and features.
PDF Viewer The PDF Viewer, introduced in PlanetPress Tools 7.3 in some areas and expanded for use throughout the configuration tool, displays any PDF used in the configuration or process. Because this PDF viewer is integrated with the suite, it is not necessary to have any third-party tools such as Adobe Acrobat installed on the operating system. Technical The PDF Viewer is not currently standalone and cannot be used to display PDFs outside of PlanetPress Workflow.
The PDF Viewer To open the PDF Viewer: In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer.
The PDF Viewer is accessible through one of the following methods: l l l In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer. Click View as PDF in the Debug toolbar. This will show the current data file in the viewer (assuming it is a PDF). If the viewer is opened during debugging, the current state of the PDF will be displayed (instead of the original data file).
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 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. Click in the Messages area of the Service Console, and from the right-click menu choose Save to file. The Save As dialog box appears. 2. Navigate to a location, enter a file name, then click OK. The complete content of the Messages area is saved.
Accessing the Data Repository Manager To access the Data Repository Manager: l Open PlanetPress Workflow l Go to the Tools tab. l Click the Data Repository Manager button in the Managers group. 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.
l Update section l l l Refresh: Click to load any changes made to the repository since it was last opened or refreshed. Management section l l l l l Edit KeySet: Click to edit the currently selected KeySet. Opens a dialog which each key and their value, which can be edited. Double-clicking a row has the same effect as clicking the Edit KeySet button.
l l Press Tab to switch between the Repository Structure, Group Key Sets, Lookup Function Syntax and the Close and Help buttons. Press CTRL+N to add a new item: l If a group is selected, will create a new group. l If a key is selected, will create a new key within the selected group. l If in the Group Key Sets, will create a new keyset. l Press F2 to rename a group or a key l Press Delete to remove Group or Key from the Repository, or a KeySet.
in your computer’s virtual drive. 2. Select the images you want to delete. 3. Press the Delete key. The Debug Information Pane The Debug Information pane displays the current values of variables and other information useful in debugging processes (see "Debugging and Error Handling" on page 53). It is divided in 4 sections: l l l l Job Information: Displays the Job Info variables, as well as the job's file name, size, last edit date and presence of metadata (see "Job Info Variables" on page 592).
selected expression. l Clear Expression List: Removes all expressions. Warning Deleting an expression or clearing the expression list cannot be undone! The Message Area Pane The Messages area is used in Debug mode to indicate the status of your PlanetPress Workflow process as the sample data file is processed and used to generate output. When your PlanetPress Workflow runs in Debug mode, the Messages area displays useful processing and error information.
l Right-click anywhere in the Message Area and select Save to File to display a dialog box that lets you save a copy of the Message Area content to a text file. The Message Area will only display information while running in Debug mode. It does not display information from other running services, and will not display the log of any process running in a live configuration (submitted to PlanetPress Workflow Service).
Note When you select a group (folder), no information is displayed in the Object Inspector, because what is really selected is the group heading and not the items included in the group. The Plug-in Bar PlanetPress Workflow offers a constantly increasing number of plugins, while always allowing third party plugins to be installed and set up to be used by PlanetPress Workflow.
l OL Connect l Outputs Note An Uncategorized category is dynamically created if your PlanetPress Workflow finds any plugin that would not be part of the existing Plug-in Bar. User-defined plugins and third party application plugins falls into such a category. Settings & customization The Plug-in Bar can be customized according to your needs and the plugins you most frequently used.
To import a plugin: 1. Click on the popup control ( ). 2. Click on Import Plugin. 3. Browse to the location of the plugin DLL file. 4. Click on Open. 5. New plugins appear in the Uncategorized category. Preferences PlanetPress Workflow lets you configure a variety of options, from how the application itself looks or behaves, to plugin specific options.
l "HTTP Server Input 2 plugin preferences" on page 702 l "LPD Input plugin preferences" on page 703 l "Serial Input plugin preferences" on page 704 l SMTP Input l "Telnet Input plugin preferences" on page 705 l "PlanetPressFax plugin preferences" on page 705 l "FTP Output Service preferences" on page 709 l "PlanetPress Image preferences" on page 710 l "LPR Output preferences" on page 713 l "PrintShop Web Connect Service preferences" on page 714 Note Preferences are saved automatically an
Colors l l l l Variable properties: Select a color for the labels identifying variable property boxes. Debug: Select the color applied to the PlanetPress Workflow Process area background when in debug mode. Highlighted tasks and branches: Select the background color for highlighted tasks and branches in the Process Area’s invisible grid. Disabled tasks and branches: Select the background color for disabled tasks and branches in the Process Area’s invisible grid.
l l Sunken active property: Select to use a recessed effect to display the currently selected property. Border active property: Select to display a border around the currently selected property. l Show lines: Select to display lines between elements. l Line style: Select a style for the lines. l Reset to default button: Click to reset all the Object Inspector options to their default values.
Default Configuration behavior preferences l l l l l Use default configuration: Check to use default input and output tasks when you create a new process. If this group is not selected, each new process you will add will begin and end with unknown tasks. Default input task: Select an input task to use as the default input task when you add a new process. Click the Configure button located to the right of this box to set the properties of the selected input task.
l l l l l l l l l l l Empty group deletion: Select to have PlanetPress Workflow prompt for confirmation to delete a group when you remove the last of its member objects. If you clear this option, groups are automatically deleted when their last members are removed. Invalid name: Select to have PlanetPress Workflow warn you when you try to rename an object in the Configuration Components incorrectly.
l l l l l l l l l l Prompt on no active process to send: Select to have PlanetPress Workflow prompt for confirmation when attempting to send a configuration although no processes are active. Prompt on overwrite of a document: Select to have PlanetPress Workflow prompt for confirmation when a document that is being imported using File | Import Document is about to overwrite an existing document.
be used since it can almost always be replaced by more specialized and efficient splitters. l Warn on Component Rename: Select to have PlanetPress Workflow prompt for action when configuration components, such as processes, are imported from an external configuration file. Imported components can overwrite existing components, or be renamed automatically with unique names. Sample Data behavior preferences Sample Data behavior preferences control the way theData Selectordisplays the sample data file.
l l l l Password: Enter the NetWare password corresponding to the user name you entered in the previous text box. Tree: Enter the NetWare Directory Services (NDS) tree where the user resides. This is the user you entered in the user name text box. Click Trees to navigate to the desired tree. You must enter a value for the Tree text box. Context: Enter the context on the NDS tree where the user you enter in the user name text box resides.
The available PlanetPress Capture user options are: l Mode: Choose between Server and Client mode. Client and Server mode are used for multi-server architectures. See PlanetPress Capture Server/Client. l Port: Select the port used to connect two servers together. The default value is 5864. l Document and Pattern Database group l l l Use ODBC Database: Check to ignore the default location for the Microsoft Access database (MDB) and use an ODBC connection to your own database location instead.
processes, which may cause a slight delay for the operation depending on the connection speed and latency between the two systems. Note The Server/Client mode is only used for managing pen licenses and has no impact on the Capture Database itself. The database can be stored locally or remotely, regardless of the Server/Client mode specified.
l Operator: Select how to do the comparison l Equal: The mask and database information are exactly the same. l Not equal: The mask and database information are different. l l l l l l Less than: If the mask and database information are both numbers, the mask will be a smaller number. Greater than: If the mask and database information are both numbers, the mask will be a larger number.
Warning This will prevent the document to be further updated, may cause errors when docking any pen that signed the printed version of the document. This cannot be undone. PlanetPress Capture ODBC Settings This dialog is used to set up the connection to a PlanetPress Capture Database through an ODBC connection. To access this dialog, See "PlanetPress Capture preferences" on page 685.
l Password: If the database is secured with a user name and password, enter the password here. Note In order for the database connection to be functional, you must ensure that the database Type correspond exactly to the one used by the DSN, and is part of the supported database types.
l Microsoft Access l l l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database file (mdb) must be local to the PlanetPress Workflow computer. It cannot be located on a network drive or another server. Database can be in any location, but performance will depend on the speed of the connection between PlanetPress and the MySQL server.
Options and Controls Top Toolbar l l l Read PGC File: Click to display a File Open dialog. Browse to an existing PGC file, and open it. PlanetPress Capture will read the serial number from the PGC file and register the pen. Print Pen Activation File: Click to print a page containing a special pattern. Any pen that writes on this pattern and is then docked will be registered in the database.
To register a pen using the registration pattern 1. Click on the Print pen activation file button in the top toolbar of this dialog. 2. Use the Windows Print dialog to print to the desired printer. 3. Write or make a line on the printed pattern. 4. Dock the pen in its cradle. 5. Click on the Read PGC File button in the top toolbar of this dialog. 6. If necessary, enter an optional pattern sequence and User ID for each pen.
Technical To add a pen pack, PlanetPress must be activated using a PlanetPress Production license. if PlanetPress Production is in trial mode, no pen pack can be added because the Pen Pack uses the serial number. Options and Controls PlanetPress Capture Pen Licenses Group l l Import License...: Click to open the Import License dialog. Browse to a PPLIC (PlanetPress License) file on your computer and open it to import the license.
The available OL Connect user options define the default behavior of OL Connect tasks' OL Connect Proxy tab. These values are used unless they are overwritten in a task's properties: l Server Connect Settings l l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server.
Warning The default values are generally correct for the greatest majority of PDF data files. Only change these values if you understand what they are for. Delta Width Defines the tolerance for the distance between two text fragments, either positive (space between fragments) or negative (kerning text where letters overlap). When this value is at 0, the two fragments will need to be exactly one beside the other with no space or overlap between them.
At 0, the font size must be exactly the same between two fragments. At 1, a greater variance in font size is accepted. Accepted values range from 0 to 1. The default value is 0.65, recommended values are between 0.60 and 1.00. Gap Defines how spaces between two fragments are processed. If the space between two fragments is too small, the text extraction will sometimes eliminate that space and count the two fragments as a single word. To resolve this, the Gap setting can be changed.
l l l Add time stamp to all processes events: Adds a time stamp to each log entry for a process event. Delete log files after: Select how many days log files are kept before being deleted. Maximum numbers of replicated processes: Set the maximum number of times a process may be replicated. Messenger plugin preferences Apart from enabling communication between the various parts of PlanetPress Workflow, the PlanetPress Workflow Messenger also manages local instances of the PlanetPress Workflow Alambic.
HTTP Server Input 1 plugin preferences HTTP server input 1 plugin preferences control the server protocol aspects of the PlanetPress WorkflowHTTP Server Input tasks. This is where you enable and configure secure communication for the 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.
l l Password: Enter the password (or passkey) for the Private Key File. Please note that this password is encrypted within PlanetPress Workflow server and is not saved in plain text. Encryption protocol: Choose your cryptographic protocol (SSL or TSL). This is determined by the software that generated the keys. Note When SSL is enabled and a user sends a query prefixed with https://, then this specific communication will be sent through port 443, which cannot be changed in Workflow.
Technical PHP Arrays This is an example of the new "Use PHP Arrays" option introduced in Workflow 8.5. HTML Example: PAGE 702
HTTP Server Input 2 plugin preferences The HTTP Server Input 2 plugin preferences are used to enable serving static HTTP resources, as part of an HTTP Server workflow. These resources are referred to within the HTML response file and do not pass through a process to get served so the process is very quick.
LPD Input plugin preferences LPD input plugin preferences control certain functions of the PlanetPress Workflow LPD Server service, which in turn has an impact on LDP input tasks performed by PlanetPress Workflow on a given computer. The LPD Server service receives jobs using TCP/IP from LPD servers. For information on the preferences set in individual LDP input tasks, refer to LPD Input Task Properties.
property is 7200 seconds (2 hours). On a time-out, partially received data files are not passed to the rest of the process; the LPD input resets and is ready to receive further data files. Log messages include the time-out duration. Serial Input plugin preferences Serial input plugin preferences control certain functions of the PlanetPress Serial Capture service, which in turn has a direct impact on all Serial input tasks performed by PlanetPress Workflow on a given computer.
l l l Time-out: Set the time in seconds the PlanetPress Workflow process waits for the transfer of bytes in the data file before ending the transfer of this file. On a time-out, partially received data files are not passed to the rest of the process; the Serial input resets, ready to receive further data files. Job delimiters: Enter the strings that tell PlanetPress Workflow the data file being retrieved through the Serial input is complete.
given computer, only that computer is affected. So you should consider changing the PlanetPress Fax user options on the computer that actually performs the PlanetPress Workflow Fax output tasks. The changes you make to the PlanetPress Workflow Fax plugin preferences are stored in the PlanetPress Fax configuration file. They will be applied when PlanetPress Fax is started. Preferences l l Delete log after: Enter the number of days after which to delete the PlanetPress Fax service log.
- Raster resolution: 196 dpi l Windows Fax Service l l l l l l Report Failures: Select to have PlanetPress Fax generate a report whenever the maximum number of retries for a single fax is exceeded. The error generated by the Windows Fax Service is also logged in the report. Note that when PlanetPress Fax is unable to send a fax because an empty fax number is used as the only recipient for a document, a failure will not be reported but an error will be logged.
when PlanetPress Fax is unable to send a fax because an empty fax number is used as the only recipient for a document, a failure will not be reported but an error will be logged. l l l l Report Successes: Select to have PlanetPress Fax generate a report whenever one of the faxes in the PlanetPress Fax Job reaches its destination successfully or at least as far as the Windows Fax service is concerned. Folder: Enter or select the location of the report file.
l l l Check for updates: Click to access the Objectif Lune website to search for updates to PlanetPress Image. You are guided through the updating process with the PlanetPress Workflow Update Service wizard. About: Click to display an About dialog box for PlanetPress Fax. This dialog box contains information such as the version number, whether the software is activated or the number of days remaining in the trial.
PlanetPress Image preferences PlanetPress Image user options control certain functions of the PlanetPress Image service, which in turn has a direct impact on all PlanetPress Image output tasks performed on a given computer. These include error and logging options, PlanetPress Search database options, as well as networking and email options.
of the job is created in the Error folder, which is located in the PlanetPress Workflow installation folder. l l l l l l Name or address not resolved: Select to send an email to the administrator when a name or address in the document selected to be used in PlanetPress Image cannot be resolved. Delete log after: Enter the number of days to wait before deleting the log of the generated PlanetPress Image output.
l l l l l l l l Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory. This option is available only when you select Access database in the Database type box. Data source name: Enter the name of the computer on which the database runs. This option is available only when you select SQL Server database or Oracle database in the Database type box.
l Use SMTP mail group: Check to activate this group’s options and to use Simple Mail Transfer Protocol (SMTP) to send the error messages to the administrators. Note that if you select this option, you will be required to enter information in the Name, Email address and Outgoing mail (SMTP) boxes. l l l l l l Name: Enter the name of the user sending the error messages to the administrators. Organization: Enter the name of the organization of the user sending the error messages to the administrators.
yyyymmdd numerical format. Note that changing this option also affects the log displayed in the PlanetPress Workflow Service Console. l l l l No source port range restriction: Select to remove any restrictions on the port PlanetPress Workflow uses to send the job file via the LPR/LPD protocol. Clear to restrict the port used to send the job to one in the range between 721 and 731. Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service.
The available preferences are as follows: l l User name: Enter the user name of a valid PrintShop Web user, mostly operators. Password: Enter the password associated with the user name on the PrintShop Web server. Note It is also mandatory to send your configuration to your PlanetPress Workflow service since the PrintShop Web credentials are included in the *.
l l l l l l l l l l Optimal fill: Select to optimize the indent of every auto-indented line by minimizing the number of space and/or tab characters it uses. You must select both Auto indent mode and use tab character to use this option. Backspace unindents: Select to move the insertion pointer to the previous indentation level when you press BACKSPACE.
portion of code, or by double-clicking to highlight the word or line under the pointer (the Double click line option determines whether a word or line highlights). You can cut, copy, paste, and print selections. If you also select Enable dragging, you can drag selections to reposition them in the code. l l l l l l l Enable dragging: Select to permit dragging and dropping a selection to reposition it in the program. This option works only if you also select Enable selection.
l l l l Use monospace fonts only: Select to display only fixed width fonts in the Editor font drop-down list. Every character in a fixed width font occupies the same amount of space. Sample: Displays a preview of the font selected in the Editor font option, at the size selected in the Size option. Margin and Gutter Group l l l l l l l Size: Use to select the font size the Editor uses to display the program code. A preview of the selected font, at the selected size, appears in the Sample box.
includes pre-set color values and attributes for each script element as listed in the Elements list box. After selecting a mapping, you can edit individual elements to change their pre-sets by selecting them in the Element list box and editing their values. l l l l Element list box: Select a script element in the Element list box, then edit the background and foreground color with which it is displayed, and/or its formatting attributes.
l " Adding Branches" on the facing page l " Edit a Task" on the facing page l " Replacing Tasks, Conditions or Branches" on page 722 l " Remove Tasks or Branches" on page 722 l " Task Properties Dialog" on page 723 l " Cutting, Copying and Pasting Tasks and Branches" on page 724 l " Moving a Task or Branch Using Drag-and-Drop" on page 727 l " Ignoring Tasks and Branches" on page 728 l " Resize Rows and Columns of the Process Area" on page 728 l " Selecting Documents in Tasks Links" on pag
2. Locate the task you want to add to your process. You can navigate between the different task categories by clicking the icons at the bottom of the Plug-in Bar. 3. Using your mouse, click and drag the task in your process at the place you want to insert it. 4. Depending on where you place your mouse, you may see that you can replace or insert existing tasks, or not place it at that location at all. 5.
To edit a task: 1. In the PlanetPress Workflow Process area, double-click the Task icon. A dialog box containing the available task properties is displayed. 2. Edit the task properties as required. Click specific tabs to see all the properties associated with the task. 3. Click OK to close the dialog box and save the new properties. Replacing Tasks, Conditions or Branches You can replace existing tasks either by dropping a new task on it, or by pasting another task over it.
l l Click on the task or branch you want to delete, and press the Delete (or "Del") key on your keyboard. Right-click on the task or branch you want to delete, and select Delete from the menu. When you remove a branch, all the tasks located in that branch are also deleted. When you delete a task, only that task is deleted. Note You cannot use the Delete option to remove an input or output task, but you can rightclick on them and click Cut instead.
The "On Error" tab that is common to almost all tasks contain the following options: 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.
To cut and paste tasks or branches: 1. In PlanetPress Workflow Process area, select the task or branch you want to cut and paste. 2. From the Home tab in the Ribbon, choose Cut (or right-click and select Cut 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. From the Home tab in the Ribbon, choose Paste (or right-click and select Paste from the drop-down menu).
l Tasks and branches will always appear on top (in other words, before) the task or branch where you paste it. The only exceptions are input and output tasks which can only be pasted on top of Unknown Task. Note Instead of pasting the actual task or branch, you can simply paste the properties of the task or branch. To copy and paste Properties of a task or branch: 1. Copy or Cut a task or branch of which you want to have the properties. 2.
Moving a Task or Branch Using Drag-and-Drop When you want to move a given task or branch, the simplest way is to use drag-and-drop. Using the mouse, you can drag and drop tasks and branches only within a given process. To move tasks and branches between different processes, see Cutting, Copying and Pasting Tasks and Branches. When you move a task or branch using drag and drop, it typically moves from its original location to a position immediately preceding the target onto which you dropped it.
dropped over an unknown initial input task will replace it. The same is true of an output task that is dragged and dropped over an unknown output task. Ignoring Tasks and Branches PlanetPress Workflow lets you ignore individual tasks, branches or conditions. l l When a task is disabled, it is not executed when the process is run in debug mode (see About the Debug Mode) or by PlanetPress Workflow Service.
Selecting Documents in Tasks Links The Properties dialog box of some action and output tasks let you select documents. Depending on where the document selection list appears you will have access to all the documents or only the documents installed on a printer queue. In most cases, you have three options: l l l You can choose not to use any document (only in certain cases). This means no document is merged with the data and the job file is sent as is.
Highlight a Task or Branch The Highlight command lets you toggle the background color of selected tasks and branches. Note that the highlight color may be changed via the PlanetPress Workflow Configuration preferences. To highlight a Process Area square: l Use the mouse pointer to select a given square. l In the PlanetPress Workflow button, click the View tab. l Select Highlight from the Navigate group. To remove the highlight, repeat the procedure.
The Quick Access Toolbar PlanetPress Workflow Quick Access Toolbar is displayed, by default, on the right side of the PlanetPress Workflow button and provides one-click shortcuts to commonly used functions and features. You can add as many buttons as you want to the Quick Access Toolbar and remove them at will. To add a new button to the Quick Access Toolbar: 1. Locate the button you want to add in one of the tabs of the Ribbon. 2. Right-Click on the button. 3. Select Add to Quick Access toolbar.
The PlanetPress Workflow Ribbon The PlanetPress Workflow Ribbon centralizes commands, organizing them into a set of Tabs, each tab containing groups of controls. Each tab on the Ribbon displays the commands that are most relevant to a given feature set. The built-in Ribbon and Quick Access Toolbar contain commands that are frequently used and convenient to keep close at hand. You can minimize the Ribbon, and choose the position of the Quick Access Toolbar, as well as the commands it displays.
l l l The Show/Hide group contains four controls to display or hide any of the four panes; the Configuration Components pane, the Object Inspector pane, the Message pane, the Debug Info pane and the Plug-in Bar. The Debug tab includes the Data, Debug and Debug Messages groups.
l l l l The Document Manager button opens the PlanetPress Capture Document Manager. The Pen Manager button opens the PlanetPress Capture Pen Management Tool. The Test Page group contains: l l l The Service Console button opens the The PlanetPress Workflow Service Console, allowing to monitor real-time information on the configuration execution.
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 Jacob Java Com Bridge which is licensed under the terms of the GNU Lesser General Public License Version 2. The source code for this can be obtained from the following location: http://sourceforge.net/projects/jacob-project/files/jacob-project/ JavaCraft JSch Copyright © 2002 - 2012 Atsuhiko Yamanaka, JCraft Inc. All rights reserved. JavaSysMon Copyright © 2009 ThoughtWorks, Inc. All rights reserved.
l l l l l l l l l l l Relique CSV Driver which is licensed under the terms of the Lesser General Public License Version 2.0. This can be obtained from the following location: http://sourceforge.net/p/csvjdbc/code/ci/master/tree/ Rhino 1.6R7 and 1.7R2 which are licensed under the terms of the Mozilla License Version 1.1. The source code for this can be obtained from the following location: https://developer.mozilla.
Portions of certain libraries included in this application which are distributed under the terms of the Mozilla Public License have been modified. To obtain copies of the modified libraries please contact your local Objective Lune Support team. This application also uses the following components which are distributed under the terms of the Apache Software License Version 2.
l Apache ServiceMix l Apache Tomcat l Apache WSS4J l Apache Xalan l Apache Xerces2 Java Parser l Apache XMLGraphics l Apache XML-RPC l Barcode4j l Google Collections l Google GSON l 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.
l freemarker/ext/jsp/web-app_2_4.xsd l freemarker/ext/jsp/web-app_2_5.xsd l freemarker/ext/jsp/web-jsptaglibrary_1_1.dtd l freemarker/ext/jsp/web-jsptaglibrary_1_2.dtd l freemarker/ext/jsp/web-jsptaglibrary_2_0.xsd l freemarker/ext/jsp/web-jsptaglibrary_2_1.
