User Guide www.objectiflune.
Copyright Information Copyright Information Copyright © 1994-2011 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.
Table of Content Table of Content Copyright Information 3 Table of Content 5 Overview Icons used in this guide Other Documentation Getting Started Environment Considerations 15 15 15 17 17 Terminal Services 17 VMWare/ESX 17 32-Bit or 64-Bit? 17 Antivirus Considerations 17 Backup Considerations 18 Microsoft Office Compatibility 18 Network Considerations 18 Local and Network Rights 18 Account Requirements 19 Mapped Drives 19 Network Ports used by each service 19 Activate Your Prin
Table of Content Create a New Configuration 33 Open a PlanetPress Suite Configuration File 33 Saving and Sending a Configuration 34 Save your Configuration 34 Send your Configuration 34 Import Processes from Another Configuration File 35 Import Documents 36 Import PrintShop Mail Documents 36 Change the Interface Language 36 Exit the PlanetPress Suite Workflow Tools Configuration Program 37 The Quick Access Toolbar 37 The PlanetPress Suite Ribbon 38 Start and Stop the PlanetPress Sui
Table of Content Redo a Command 60 The Plug-in Bar 60 The Object Inspector Pane 61 Toggle the Run on Desktop Property 62 The Debug Information Pane 62 The Message Area Pane 63 Customizing the Program Window 63 Dock and Undock Areas of the Program Window 64 Show or Hide Areas of the Program Window 64 Combine and Attach Areas 65 Resize the Program Window Areas 68 Preferences 68 General User Options 69 Object Inspector User Options 69 Configuration Components Pane User Options 70
Table of Content Standard Variables Available Standard Variables The %i Loop Count Variable Data in PlanetPress Suite Workflow Tools 100 100 101 103 Choosing a Sample Data File 103 The Data Selector 103 Metadata tab 105 Metadata 106 Using the Metadata Data Selector 111 Using the File Viewer 112 Choosing a Database Type Sample Data File 112 Data Selections in PlanetPress Workflow Tools 112 Text-Based Data Selections 112 Database Data Selections 113 PDF Data Selections 113 Metadata
Table of Content Decompress File(s) 148 Digital Action 149 Download to Printer 149 External Program 150 Load External File 152 Mathematical Operations 152 Open XSLT 153 PlanetPress Database 154 Rename 157 Run Script 158 Send Images to Printer 160 Search and Replace 161 Send to Folder 162 Set Job Infos and Variables 162 SOAP Client Plug-in 163 Standard Filter 165 Translator 165 Windows Print Converter 166 Data Splitters 168 About Using Emulations with Splitters 169 Da
Table of Content PlanetPress Fax 201 Captaris RightFax Configuration 202 About PlanetPress Image 205 PlanetPress Image 205 Overview of the PDF/A and PDF/X Standards 213 PrintShop Mail 213 PlanetPress Capture 215 Capture Condition 215 Capture Fields Generator 218 Capture Fields Processor 219 Capture PGC Splitter 221 Find Capture Documents 222 Get Capture Document 224 PGC to PDF Converter 225 Metadata Tasks 227 Create Metadata 227 Embed/Extract PlanetPress Suite Metadata 228
Table of Content The Examples 253 PlanetPress Capture Glossary 253 General Considerations 255 Security Considerations 256 10,000 Patterns 257 THE NUMBERS 257 EXAMPLE 258 EXTENDING 258 CONTAMINATION 259 SAFEGUARDS 260 CONCLUSION 260 Anoto penDirector 260 PlanetPress Mobile Application 261 PlanetPress Capture Implementation Restrictions 266 Printer limitations 266 Black ink close to patterns 266 Paper quality 267 Pattern sizes 267 Distance between patterns 268 Basic Func
Table of Content Windows Output Printer Queue 280 LPR Output Printer Queue 280 FTP Output Printer Queue 281 Send to Folder Printer Queue 282 PlanetPress Suite Workflow Tools and PlanetPress Design Documents 283 Variable Content Document File Formats: PTZ, PTK and PS 283 PlanetPress Suite Workflow Tools and Printshop Mail Documents 284 Triggers 284 Load Balancing 285 Location of Documents and Resources 287 Debugging and Error Handling Debugging your PlanetPress Suite Process Debugging an
Table of Content Watch.SetJobInfo 308 Watch.GetVariable 309 Watch.SetVariable 309 Watch.ExpandString 310 Watch.Log 310 Watch.Sleep 311 Script.
Overview Overview This PDF documentation covers version 7.4. 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. Icons used in this guide Some icons are used throughout this guide in order to catch your attention to certain particular information. Notes: This icon shows you something that complements the information around it.
Getting Started Getting Started This chapter describes how to install the PlanetPress Suite Workflow Tools and how to set up your working environment. Environment Considerations This page is intended to provide technical information about the environment in which PlanetPress Workflow is intended to run. Terminal Services PlanetPress Suite does not support Terminal Services environment as possible under Windows 2000, 2003 and 2008.
Getting Started In this respect, any antivirus software installed on the machine should ignore the following folders in it's live scans as well as daily "deep" or "complete" scans: l l l On Windows 2000/2003/XP: l C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Suite 7\ l C:\Documents and Settings\planetpress\Local Settings\Temp\ (where planetpress is the user under which Watch is configured) On Windows Vista/7/2008: l C:\ProgramData\Objectif Lune\PlanetPress Suite 7\ l C:
Getting Started Account Requirements PlanetPress Suite Workflow Tools and its services require administrator rights to run on any given computer and must therefore be associated with an account that has such rights.
Getting Started Component PlanetPress Database SNMP Condition Protocol TCP or UDP UDP Local Port Remote Port Unknown4 Unknown4 Default1 161 1. Value is greater than 1024 and is assigned by Windows XP. This is the default. 2. Windows NT 4.0 uses NetBIOS over TCP/IP for file and printer sharing, while Windows 2000, Windows XP, and Windows Server 2003 may be configured to use NetBIOS over TCP/IP or SMB over TCP/IP. The operating system may use additional ports.
Getting Started 1. Click on the Tools tab in the PlanetPress Suite Workflow Tools Ribbon, then click Configure Services. 2. Set the PlanetPress Suite applications permissions as required: l Local System account: Select to run all the PlanetPress Suite Services (including PlanetPress Suite Workflow Tools, PlanetPress Fax, and PlanetPress Image) under the Local System account. The Local System account is distinct from the Administrator account.
Understanding PlanetPress Suite Workflow Tools Understanding PlanetPress Suite Workflow Tools PlanetPress Suite Workflow Tools are input driven applications designed to output data in a variety of ways through diverse means to various applications and devices. PlanetPress Suite Workflow Tools can be used as simple go betweens, passing along input data to output devices, but it can also perform various types of data processing.
Understanding PlanetPress Suite Workflow Tools l l l l l l l l l l l l PlanetPress Suite Workflow Configuration (or "Configuration"): The Configuration is a physical file opened by the PlanetPress Suite Workflow Tools and it contains all of the elements (tasks, processes, documents and printer queues) that drive your workflow. Process: A single workflow within the Configuration.
Understanding PlanetPress Suite Workflow Tools About Processes A process is a single workflow within the configuration. A process begins with a single input task, contains one or more tasks and/or branches, and terminates with one or more output tasks. In its simplest form, a process can simply retrieve data from a given folder and save it in a different folder. In most cases, though, processes are more elaborate and configurations, which may include many processes, can be extremely complex.
Understanding PlanetPress Suite Workflow Tools l l l Input Task: Will either capture data from a specific location, or wait for input from a service or other computer to start processing. Action Task: Will manipulate the data in any number of ways. An action task is any task that is not an input or output task or a branch or condition. Output Task: Will output data to a specific location or send to a different service or computer.
Understanding PlanetPress Suite Workflow Tools generally used to generate output. Data can be manipulated using the tasks in the process, used as comparison for conditions and loops, complemented with data from other sources, and used to generate your output. It originates from many different sources (as many as the Input Tasks support), parts of it can be stored in variables, and is always accessible by the task that currently handles it.
Understanding PlanetPress Suite Workflow Tools l l XML PDF PDF Emulation, also called Document Input, is only available in PlanetPress Production and PlanetPress Office. If used in PlanetPress Watch, it will cause a watermark to appear in any output. For more information about each emulation and how to use them, please consult the PlanetPress Design User Guide.
Understanding PlanetPress Suite Workflow Tools l l l PlanetPress Fax can generate faxes and dispatch them from the host on which it runs, using a local faxing program, such as WinFax PRO, Captaris RightFax or Windows Fax. See About PlanetPress Fax. PrintShop Mail: Used to generate documents using PrintShop Mail databases and documents. Communicate with it through the PrintShop Mail and PrintShop Mail 7 Connector Tasks. See PrintShop Mail. Laserfiche: Used as a repository for electronic documents.
Understanding PlanetPress Suite Workflow Tools LPR output queues let you send print jobs to remote printers via TCP/IP using the LPR/LPD protocol. See LPR Output Printer Queue. Windows Driver Printing: l The Print using a Windows Driver output task lets you send a job to any printer installed on the computer, using its own drivers. In this particular case, the printer does not need to be a PostScript printer. See Print Using a Windows Driver.
The PlanetPress Suite Workflow Tools Configuration Program The PlanetPress Suite Workflow Tools Configuration Program This chapter centers on the PlanetPress Suite Workflow Tools Configuration program, which you use to create and edit your configurations. The basic user interface elements are as follows: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. The PlanetPress Suite Button. See The PlanetPress Suite Button. The Quick Access Toolbar. See The Quick Access Toolbar. The Ribbon Tabs. See The PlanetPress Suite Ribbon.
The PlanetPress Suite Workflow Tools Configuration Program You can customize the appearance of the PlanetPress Workflow Tools Configuration programs to your needs. See Customizing the Program Window. Start the PlanetPress Suite Workflow Tools Configuration Program This procedure explains how to start the PlanetPress Suite Workflow Tools Configuration program, which is different from starting PlanetPress Suite Workflow Tools service itself (see Start and Stop the PlanetPress Suite Workflow Tools Service).
The PlanetPress Suite Workflow Tools Configuration Program l l l l l Close: Closes the PlanetPress Suite Workflow Tools Configuration that is currently opened and creates a new PlanetPress Suite Workflow Tools Configuration, with a single example process and no printer queues. Closing the current configuration file is the same as creating a new one. Recent Documents: Displays a list of the 9 most recently opened PlanetPress Suite Workflow Tools Configurations. Click on any of them to open it.
The PlanetPress Suite Workflow Tools Configuration Program You can also open a configuration file from a previous version of PlanetPress Workflow Tool by changing the File Type selector to the desired version (for example, .pw6 for PlanetPress Watch/Server configurations from Version 6) Saving and Sending a Configuration The PlanetPress Suite Workflow Tools are service applications which, once started, constantly run in the background to perform the tasks included in their current configuration file.
The PlanetPress Suite Workflow Tools Configuration Program 3. When the configuration is ready to be used, from the PlanetPress Suite Button, choose Send Configuration, then Send Local. To send a PlanetPress Suite Workflow Tools Configuration to a remote server: 1. Open the configuration you want to use as PlanetPress Suite’s new configuration. 2. Edit the configuration, if required. 3.
The PlanetPress Suite Workflow Tools Configuration Program l l When importing a PlanetPress Suite Workflow Tools configuration file, your PlanetPress Design and PrintShop Mail document are not physically imported as they are not part of the configuration file itself. In order for the documents to be available, you will need to send each document from PlanetPress Design and PrintShop Mail (see their respective documentation for details).
The PlanetPress Suite Workflow Tools Configuration Program Use System Default Locale: Select to mirror your language settings, as defined in the Regional and Language Options of the Windows Control Panel. This option is typically used to enter and process information in non-European languages. It is only enabled when English is selected as the program language.
The PlanetPress Suite Workflow Tools Configuration Program 1. Locate the button you want to remove in the Quick Access Toolbar. 2. Right-click on the button 3. Select Remove From Quick Access toolbar. To move the Quick Access Toolbar below or above the Ribbon: 1. Right-click on the Quick Access Toolbar, or click on the downwards arrow at the rightmost end of the Quick Access Toolbar. 2.
The PlanetPress Suite Workflow Tools Configuration Program l l l l rently selected process, and Go to Child/Go to Parent to move around a given process logical nodes (branches or conditions). 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 Window pane, the Debug Info pane and the Plug-in bar. The Debug tab includes the Data, Debug and Debug Messages groups.
The PlanetPress Suite Workflow Tools Configuration Program The current PlanetPress Suite Workflow Tools status is always displayed in the lower-right corner of the PlanetPress Suite Workflow Tools Configuration program window. To start PlanetPress Suite Workflow Tools services via the PlanetPress Suite Workflow Tools Configuration program: l l Click Tools in the PlanetPress Suite Ribbon. Click Start Service in the Services Status group.
The PlanetPress Suite Workflow Tools Configuration Program Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties, for scheduling and error handling. Subprocesses: Displays a list of subprocesses in your configuration. Right-click on a subprocess to access a dropdown menu that offers these choices: l Insert Subprocess: Inserts a new process with a default input and output task. l Insert Local Variable: Inserts a new local variable.
The PlanetPress Suite Workflow Tools Configuration Program l l Right-Click on the Process in the Configuration Components Area. Select Properties. You can also double-click on the process to show its options. Subprocesses do not have the "General Tab" which is only used for scheduling, but they do have the Information Tab. PlanetPress Suite Workflow Tools Process Options properties are as follows: General tab l l l l l l l l l l l Active: Select to make the process active.
The PlanetPress Suite Workflow Tools Configuration Program The Time Grid The PlanetPress Suite Workflow Tools 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.
The PlanetPress Suite Workflow Tools Configuration Program l l 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. To select the entire grid, use the Select All button located below the grid. To deselect the entire grid, use the Clear All button located below the grid.
The PlanetPress Suite Workflow Tools Configuration Program l l Each process’ schedule determines when its initial input task can be performed. Other tasks included in the process are performed regardless of schedule, granted that the previous task was performed. Manipulate Local Variables 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.
The PlanetPress Suite Workflow Tools Configuration Program l l l Right-click the process in question in the Configuration Components Pane Click Active to disable or enable the process. Send your configuration. If you try to send a configuration that contains only inactive processes, the PlanetPress Suite Workflow Tools Configuration program will ask you to confirm the operation (this can be changed in the Notification User Options).
The PlanetPress Suite Workflow Tools Configuration Program 2. Enter the new value for your global variable 3. Click OK to save the new value. Shared tasks These procedures can be used on both local and global variables. To delete a variable l Right-click on the variable name in the Configuration Components Area and click Delete. To rename a variable: l l l Right-click on the variable name in the Configuration Components Area.
The PlanetPress Suite Workflow Tools Configuration Program l l l l Workflow Tools Configuration. It may have a PTK extension (if it has been sent to PlanetPress Workflow from PlanetPress Design), or a PS extension (if it is printer-resident). Version: The version of the PlanetPress Suite Workflow Tools in which the document was originally created. Printerresident documents are identified as such. Document name: The name of the document as entered in PlanetPress Design.
The PlanetPress Suite Workflow Tools Configuration Program Design Document in 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 button if it appears. 2. Expand the document (name.ptk) by clicking the button. 3. Right-click on the data file, then click Set as sample data file. To view an attached data file: 1.
The PlanetPress Suite Workflow Tools Configuration Program Those documents that are not available on your local PlanetPress Suite Workflow Tools server, but that are either available on printers or on other PlanetPress Suite Workflow Tools servers must added to the list, otherwise you will not be able to use them in your PlanetPress Suite Workflow Tools configuration. To add a resident document in the Configuration Components Pane: 1.
The PlanetPress Suite Workflow Tools Configuration Program If you simply wish to change the order in which objects appear in a category or group of the Configuration Components, refer to Reorder Objects in the Configuration Components Pane. As you drag a configuration component, your mouse cursor will change to indicate the action you are performing, as well as whether the location where the cursor is can accept the configuration component you are dragging.
The PlanetPress Suite Workflow Tools Configuration Program Moving and Copying Details: l l l l l l When moving configuration components, a horizontal line appears where the component will be dropped if the location is valid. At the end of this line will be small "dents". If these dents are on top of the line, the component will be placed at the same level (group) as the component before it.
The PlanetPress Suite Workflow Tools Configuration Program appearing within a group. You can also use the clipboard controls and drag & drop methods described in Using the Clipboard and Drag & Drop to copy and move objects and tasks. To reorder selected objects in the Configuration Components Pane: 1. Click an object or group. 2.
The PlanetPress Suite Workflow Tools Configuration Program 1. Select multiple objects that are not part of a group 2. Press CTRL+G. A new group is added and the selected items are moved to that new group. To ungroup selected objects: 1. Select objects in a group. 2. Press CTRL+U.
The PlanetPress Suite Workflow Tools Configuration Program Zoom In or Out within Process Area You can do a zoom out in the PlanetPress Suite Process area to see more tasks at the same time. In zoom out mode, you can perform the exact same functions as in normal view mode. To zoom in or out on the PlanetPress Suite Process Area: l l Click on the View tab of the Ribbon. Click on Zoom Out in the Navigate group to zoom out, and Zoom In to zoom in.
The PlanetPress Suite Workflow Tools Configuration Program To edit a task: 1. In the PlanetPress Suite Workflow Tools 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.
The PlanetPress Suite Workflow Tools Configuration Program l l l l 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.
The PlanetPress Suite Workflow Tools Configuration Program 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. Select the task or branch where you want to paste the properties 3. From the Home tab in the Ribbon, choose Paste Properties (or Right-Click and select Paste Properties from the drop-down menu).
The PlanetPress Suite Workflow Tools Configuration Program You cannot drag a task or branch over an initial input task. Any input task that is dragged and dropped over an unknown initial input task will replace it. The same is true of an output task that is dragged and dropped over an unknown output task. Ignoring Tasks and Branches PlanetPress Suite Workflow Tools lets you ignore individual tasks, branches or conditions.
The PlanetPress Suite Workflow Tools Configuration Program l l l Click on the %o entry in the document list Type the variable properties or use the right-click menu to insert the correct variable properties. Click OK on the dialog. At runtime, if PlanetPress Workflow Tools cannot find the document name generated by those variables, the task will fail. Highlight a Task or Branch The Highlight command lets you toggle the background color of selected tasks and branches.
The PlanetPress Suite Workflow Tools Configuration Program The default categories lists plug-ins according to what type of task each achieve.
The PlanetPress Suite Workflow Tools Configuration Program l Depending on the values that can be entered for the selected property, edit the value by typing a one or by selecting a new one from the drop-down list. If you select multiple objects in the Configuration Components window, some properties that are shared between those objects can be changed in the Object Inspector. Changing a property changes it for all the selected objects.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l Copy Value (only when right-clicking an existing expression): Places the resulting value of the expression in your clipboard. Revalue all: Refreshes the value of all the expressions. Add Expression: Creates a new expression. Delete Expression (only when right-clicking an existing expression): Remove the selected expression. Clear Expression List: Removes all expressions.
The PlanetPress Suite Workflow Tools Configuration Program Note that since the Process area must remain in the main PlanetPress Suite Workflow Tools Configuaration Program window, it cannot be combined and attached in this fashion. Dock and Undock Areas of the Program Window The Configuration Components Pane, the Object Inspector, and the Messages area can be displayed in windows that are attached to the Program window (docked position) or that float above it (undocked position).
The PlanetPress Suite Workflow Tools Configuration Program The Process Area is always visible and cannot be hidden. Combine and Attach Areas The Configuration Components Pane, the Object Inspector, and the Messages area can be attached or combined to one another and share the same space. However they are displayed, you can always drag, dock, or undock any area as desired. You can also switch among areas when they are combined, as well as maximize or minimize areas when they are attached.
The PlanetPress Suite Workflow Tools Configuration Program l At the bottom of the combined area, click the tab of the area you want to move, drag it to the left or right and drop it at the desired position. Dragging a combined area to new position. To take an area out of a combined area: l Do one of the following: 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.
The PlanetPress Suite Workflow Tools Configuration Program l 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. l To maximize a horizontally attached area, click the left pointing arrow on its title bar. l To restore a horizontally attached area, click the right pointing arrow on its title bar.
The PlanetPress Suite Workflow Tools Configuration Program 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: l Do one of the following: 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.
The PlanetPress Suite Workflow Tools Configuration Program Other Preferences and Settings: l l The PlanetPress Suite Services dialog lets you select the account that the PlanetPress Suite Workflow Tools Service uses to communicate on the server and the network. See PlanetPress Suite Workflow Tools Service Logon. You can change the appearance of the Run Script and XSLT Editor through the Editor Options dialog.
The PlanetPress Suite Workflow Tools Configuration Program l l Line style: Select a style for the lines. Reset to default: Click to reset all the Object Inspector options to their default values. Configuration Components Pane User Options The available Configuration Components Pane user options are as follows: Colors group l This window lets you set the color of individual Configuration Components Pane elements.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l l l l l l l l l l l l User mismatch: Select to have PlanetPress Suite Workflow Tools Configuration display a prompt when a different user opens PlanetPress Suite Workflow Tools Configuration. Task deletion: Select to prompt for confirmation when deleting a task. Document deletion: Select to have PlanetPress Suite Workflow Tools Configuration prompt for confirmation when deleting a document.
The PlanetPress Suite Workflow Tools Configuration Program l l the previous option is that this option will warn the user that the document about to be overwritten may currently be used by PlanetPress Suite Workflow Tools. Prompt on Importing a non-PlanetPress Document: Select to have your PlanetPress Suite Workflow Tools prompt for confirmation when a document that is not a valid PlanetPress document is about to be imported.
The PlanetPress Suite Workflow Tools Configuration Program You can leave the Context box empty if there is a single root context on your NDS tree, if you can perform a contextfree login, or if you enter a server name in the Server box. PlanetPress Suite Workflow Tools and PlanetPress Image use the same security context when connected to a NetWare server and they each use one connection.
The PlanetPress Suite Workflow Tools Configuration Program 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 Less than: If the mask and database information are both numbers, the mask will be a smaller number. l Greater than: If the mask and database information are both numbers, the mask will be a larger number.
The PlanetPress Suite Workflow Tools Configuration Program The ODBC Settings dialog The following settings are available: l l l l Name: Click to displays and choose from a drop-down of each DSN (Data Source Name) available on the system, along with it's source (User DSN or System DSN) and the driver it uses (database type). Type: Click to display a drop-down of supported database types. This must correspond to the database type of the DSN chosen in the previous option.
The PlanetPress Suite Workflow Tools Configuration Program In the event where 2 requests are made simultaneously on the same record, MySQL will queue one of the requests and execute it once the first one is done. In extremely rare cases this may cause a timeout on very large requests. MSSQL (Microsoft SQL Server) l Database can be in any location, but performance will depend on the speed of the connection between PlanetPress Production and the SQL server.
The PlanetPress Suite Workflow Tools Configuration Program 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. Multiple pens can be registered at once simply by writing on the registration pattern and then docking each pen before clicking the Read PGC file button.
The PlanetPress Suite Workflow Tools Configuration Program Text formatting features such as kerning, bold, exponential, etc, may cause these fragments to be considered as separate even if, to the naked eye, they obviously belong together. The PDF Text Extraction Tolerance Factors is used to modify the behavior of data selections made from PDF data files from within PlanetPress Workflow.
The PlanetPress Suite Workflow Tools Configuration Program excessively large files. Changing the logging options also affects the logs displayed in the PlanetPress Suite Service Console . The available Logging user options are as follows: l l Log level group l Startup and shutdown: Select to only track when the PlanetPress Suite Workflow Tools service is started and stopped.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l Port: Select the TCP port to use. The default port is 8080, the official HTTP alternate port, so as not to interfere with the standard HTTP port (80). To block any regular HTTP traffic (for example if only using HTTPS connections) the port can be set to 0. Time out: Set the timeout period in seconds. The default value is 120 seconds. Verbose log: Select to enable to keep a verbose log.
The PlanetPress Suite Workflow Tools Configuration Program l l Protocol options group l Log all Winsock and network messages: Select to have PlanetPress Suite Workflow Tools keep a log of all Winsock and other network messages that occur through the LPD service. These are messages related to jobs being sent from other systems through LPR, and being received by PlanetPress Suite Workflow Tools via LPD. Since these messages can accumulate, you have the option of not logging them.
The PlanetPress Suite Workflow Tools Configuration Program Time-out: Set the time in seconds the PlanetPress Suite Workflow Tools 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.
The PlanetPress Suite Workflow Tools Configuration Program between the two may result in WinFax PRO dialing incorrect fax numbers. Select Default to have PlanetPress Fax set the dial prefix, long distance prefix, area code, and fax number according to the content of the data selection, and send the result to WinFax PRO. WinFaxPRO sets the dial prefix, long distance, prefix, and area code, and fax number to the ones it receives from PlanetPress Fax.
The PlanetPress Suite Workflow Tools Configuration Program FTP Output Service User Options FTP output user options control certain functions of the FTP Client service, which in turn has a direct impact on all FTP output tasks performed by PlanetPress Suite Workflow Tools on a given computer.
The PlanetPress Suite Workflow Tools Configuration Program 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. Each log file covers a single 24-hour period and is kept in the Log folder, which is located in the PlanetPress Suite installation folder.
The PlanetPress Suite Workflow Tools Configuration Program l Tools must have access to Outlook. Outgoing emails appear in the outbox of Outlook, and is sent whenever Outlook is set to send email. 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.
The PlanetPress Suite Workflow Tools Configuration Program Keep a backup when error occurs: Select to move the job file to a local folder relative to your install folder called pplpr\error in the case of an error. LPR settings group l Time-out: Set the time in seconds the PlanetPress Suite Workflow Tools process waits when it sends jobs using the LPR protocol. The default value for the Time-out property is 7200 seconds (2 hours).
The PlanetPress Suite Workflow Tools Configuration Program Cursor through tabs: Select to move one by one through the spaces of tabs using the left or right arrow keys. Clear to have the arrow keys treat the tab as a single character. You must select Use tab character to use this option. l Group undo: Select to set the undo feature of the Editor to undo the last group of editing commands entered. An editing command is defined as a mouse click, a press on ENTER, or a press on any other key.
The PlanetPress Suite Workflow Tools Configuration Program l l at the selected Size, appears in the Sample box. 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. 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.
The PlanetPress Suite Workflow Tools Configuration Program Other Dialogs These dialogs are either accessible from the preferences or from different parts of PlanetPress Suite. Advanced SQL Statement dialog The Advanced SQL Statement dialog is available by clicking the Edit SQL button from the Database Action Task. You can enter a custom SQL query in this dialog, using the language supported by the database you select in the Database Action Task.
The PlanetPress Suite Workflow Tools Configuration Program To open the Access Manager l l Open PlanetPress Design or PlanetPress Workflow Configuration Tool. In the Ribbon, go in Tools | Managers | Access Manager. The Access Manager dialog box is displayed. It lists all IP and IP ranges that have PlanetPress Design, PlanetPress Suite Workflow Tools, PlanetPress Fax or PlanetPress Image installed in the same network.
The PlanetPress Suite Workflow Tools Configuration Program In order for the changes made here to be effective, you will need to restart the PlanetPress Messenger service. This can be done via the PlanetPress Suite Service Console. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each username entered in this dialog can have access to one or more processes. To add a new SOAP user l l l l Click on the button.
The PlanetPress Suite Workflow Tools Configuration Program To define or change the permissions for a SOAP User The Permissions section of the SOAP tab displays all of the processes that are available in the live configuration (the one that the PlanetPress service uses). To change or define the permissions: l l l l l In the top Username section, click on the username of which to modify permissions. Place a checkmark in each process that the user should have access to.
The PlanetPress Suite Workflow Tools Configuration Program The 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, rightclick 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).
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l Open: Click to browse for a PDF to open in the PDF Viewer. Note that this will not change the data file used in the process. Save: Click to browse for a location and name to save the currently active PDF in the viewer. Right Arrow: Click to view the next page of the PDF. Left Arrow: Click to view the previous page of the PDF. Page Selection: Type a page number and hit Enter on your keyboard to jump to that page.
The PlanetPress Suite Workflow Tools Configuration Program Viewing log files The second major role of the Service Console is to view and browse log files. The Service Console can both view existing log files, or monitor the log file for the current day and update the view in real time. When a service is selected on the left pane, its log file (if any exists for the current day) is displayed. The log displays in a tree fashion.
The PlanetPress Suite Workflow Tools Configuration Program Virtual Drive Manager When you use the Send images to printer action in a given process, you have the option of, at the same time, sending the images to the virtual drive (a local storage folder used by PlanetPress Suite applications) of any computer included in your network. You need to do this, for instance, if you plan to run documents that contain dynamic images on those computers (using the Optimized PostScript Stream option).
Working With Variables Working With Variables A Variable is basically a keyword that points to specific location in your computer's memory. This location contains data that you decide to place in it, by assigning that data to the variable name. This chapter will help you learn about these variables and how you can use them.
Working With Variables l l sure it contains the value that you want, and not one that has been overwritten by another task. Job infos sent to the document are global to that document, meaning the values do not change between data files. This means that if your data file contains multiple data pages for different clients, your job infos cannot be used to send information to the document. Job infos are in limited quantity and are slowly being deprecated when transferring data to your document.
Working With Variables 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.
Data in PlanetPress Suite Workflow Tools Data in PlanetPress Suite Workflow Tools PlanetPress Suite Workflow Tools is a versatile tool that can capture various types of data files and dispatch this data to various PlanetPress Design documents. To fully understand PlanetPress Suite Workflow Tools and how it treats data, you must understand how it is integrated into PlanetPress Design.
Data in PlanetPress Suite Workflow Tools The Data Selector is divided in two tabs: Data and Metadata. The Data tab contains the Data Options, which let you select your emulation, and the Selector Options, which lets you personalize the data selector's display options (see "Data Selector Display Preferences" (page 1)) 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.
Data in PlanetPress Suite Workflow Tools l l l If you use a PDF emulation, the Data Pane displays the data as you would see it in any PDF reader. A new zoom dropdown list is displayed to let you set the zoom in percentage or fit the PDF to the window or the width of the window. A new status bar, displaying the (Left, Top) and (Right, Bottom) coordinate pairs, is shown under the Data Pane.
Data in PlanetPress Suite Workflow Tools The Raise an error if the field does not exist option allows to control what to do when a given metadata element is not found, regardless of the search option. The Data page box lets the user choose which data page metadata elements to be displayed. The Metadata level is a treeview allowing users to select the metadata level from which to display or select metadata elements.
Data in PlanetPress Suite Workflow Tools A single JOB can be composed of GROUPS of DOCUMENTS, which themselves are composed of physical PAGES produced by executing a PlanetPress Design document on one or more DATAPAGES. Metadata Elements Each metadata node (i.e. Job, Group, Document, etc.) is described with a series of elements, that is, system-defined attributes or user-defined fields holding static or dynamic information about the node they are attached to. Each element has a name and a value.
Data in PlanetPress Suite Workflow Tools Finishing attributes describe the finishing intent (e.g. page dimensions, page orientation, duplex mode, etc.). Note that the presence of some finishing attributes depends on the PlanetPress Design document and target device used when producing the job. Index/Count attributes are not part of the original metadata file. They are evaluated live based on the content of the metadata.
Data in PlanetPress Suite Workflow Tools Index/Count PageCount Index/Count SelectedCount Index/Count SelectedDocumentCount Index/Count SelectedDatapageCount Index/Count SelectedPageCount SelectedIndexInDocument Returns the Absolute index of the node within all the selected node Index/Count under the parent Document. SelectedIndexInGroup Returns the Absolute index of the node within all the selected node Index/Count under the parent Group.
Data in PlanetPress Suite Workflow Tools Metadata Selector PlanetPress Design's Data Selector window is accessible by double clicking inside the Sample Data window or by clicking on the Open Active Data button available in the ribbon. The Data Selector is equipped with a new tab labeled Metadata. 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.
Data in PlanetPress Suite Workflow Tools Metadata tab in the properties of a PlanetPress Design document allows to easily define documents or groups. Metadata Fields Metadata Fields in the properties of a PlanetPress Design document allows to easily define documents or groups. Using the Metadata Data Selector The Metadata Data Selector in PlanetPress Workflow Tools is the same as in PlanetPress Design, please refer to the PlanetPress Design User Guide for information on how to use the Data Selector.
Data in PlanetPress Suite Workflow Tools Using the File Viewer The File Viewer is like a Data Selector without any data related options, such as emulation settings. It is displayed when doing a data selection from the Generic Splitter Task (see Generic Splitter) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks. For more information on the selecting data, see The Data Selector.
Data in PlanetPress Suite Workflow Tools l l l l l l From Line: The starting line of the data selection. To Line: the last line of the data selection. From Column: the leftmost character position of the data selection. To Column: the rightmost character position of the data selection. Case Options: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent.
Data in PlanetPress Suite Workflow Tools l l l l l l l l region(): Always surrounds PDF data selections. Page: The page of the PDF from which to retreive the data. Left: Exact horizontal position (in inches) that defines the left of the selection region. Top: Exact vertical position (in inches) that defines the top of the selection region. Right: Exact horizontal position (in inches) that defines the right of the selection region.
Data in PlanetPress Suite Workflow Tools A single job file can be the source of multiple job files. This is the case, for example, when a process includes multiple branches, as each branch is given a duplicate copy of the job file. This is also the case when a job file is split into multiple smaller files by a Splitter action task, for instance (see Data Splitters). It is important to note that job files may be used as a helpful debugging resource (see Debugging and Error Handling).
Task Properties Reference Task Properties Reference This chapter lists all of the possible tasks that are available in the PlanetPress Workflow Tools Configuration program.
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.
l If your secondary input task creates a job file using a different emulation, you will need to use a Change Emulation task after the secondary input task to correctly change to that emulation. Properties common to all input tasks The "Other" tab is common to all input tasks and are available in the Properties of all input tasks. "Other" Tab l l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task.
l l l l l l l Sort files by: Select a given sorting method to prompt PlanetPress Suite Workflow Tools 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 Suite Workflow Tools 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.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Create File Create File input tasks are different from other input tasks in that they do not pull in data from a source location.
l l l HTTP PDF Invoice Request HTTP Brochure Request Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
l l “From” contains: Select to limit those messages used by this task to those that are sent from a specific address. The address you enter in the box below can include variables and wildcards. “To” contains: Select to limit those messages used by this task to those that are sent to a specific address. The address you enter in the box below can include variables and wildcards. Login Tab l l Use Microsoft Outlook: Select to use the Microsoft Outlook email account of the current user to receive emails.
The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l l each separate folder, not across folders. The subfolders themselves are always processed in alphabetical order, regardless of the sort order. Include hidden files: Select if you want any hidden folders or files present in the source folder to be taken as well. Include empty files: Select if you want any empty folders or files present in the source folder to be taken as well.
l l File mask: Edit the default filename mask (*.*) if you want only some of the files present in the folder to appear in the list. List files in sub-directories also: Select this option if you want the task to list any files present in subfolders of the selected input folder. "Other" Tab l l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task.
l l l l l Password: If account named in the User name box is password protected, enter the password here. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or another PlanetPress Suite Workflow Tools task. Directory: Enter the path of the folder to poll on the FTP server.
HTTP Client input task properties are as follows: General tab l l URL: Enter the URL of the HTTP server from which the file must be downloaded. Since this is a variable property box, variables may be used, as well as the Get Data and Select Data commands. Note that when PlanetPress Suite Workflow Tools connects to a secure page, an SSL (Secure Socket Layer) connection is automatically used. Server requires authentication: Check this option if the HTTP server requires user authentication.
The request can contain one or more files, one being an XML file containing the request information as well as any GET or POST variables that were received within this request. Other files are POST attachments. Processing Depending on the options chosen in the HTTP Server Input task properties, the task may choose to ignore some of the files. For example, using the "Do not include XML envelope" means that only the POST attachments will be used in the process, the XML file will be discarded.
Examples & Use Cases This task is put into effect in the following use cases and example processes: l l l HTTP PDF Invoice Request HTTP Brochure Request Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
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 on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
l l 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 on Task Properties Dialog.
Job Information definitions l l l l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user un which a software sending the job was logged in under. %2 - Host computer: Contains the name of the computer from which the job was sent. %3 - 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.
The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Create PDF (With Metadata): Select to output a PDF which can be used by the Document Input (PDF Input) feature in PlanetPress Suite. 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. Include empty files: Check to process empty incoming jobs.
Action Tasks Use action tasks in PlanetPress Suite Workflow Tools to perform a wide variety of operations. PlanetPress Suite Workflow Tools includes more action tasks then input and output tasks combined. Action tasks can even be used to input data and to output data. The difference between an action task and an input task is that an action task can never be the first task of a process.
Processing This task merges the current data file with the selected PlanetPress Design document. 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. Output The output is an Optimized PostScript Stream job that is the combination of the data file and selected document. Metadata is not generated by this task.
l l l l l l l Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file. Select Characters to add the string of characters entered in the Characters box to the beginning or end of the job file, or to remove a given number of characters from the beginning or end of the job file.
l l l l l l l when this option is selected. 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 Suite Workflow Tools 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.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Barcode Scan The Barcode Scanner task is used to convert barcode data from multiple image formats into text-readable information.
DataMatrix DataMatrix is a two-dimensional barcode which can store from 1 to about 2,000 characters. DataMatrix is being used to encode product and serial number information on electrical rating plates; to mark of surgical instruments in Japan; to identify lenses, circuit boards, and other items during manufacturing. QRCode The QR Code (Quick Response Code) is a 2-dimensional matrix code. It can encode up to 2509 numeric or 1520 alphanumeric characters. PostNet PostNet symbology.
that the color threshold level will be calculated automatically depending on the image. By default Threshold level [0..255] is 0. This parameter is ignored with binary images (black and white images). On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
One method is to use a VBScript with the Open Script task, using the Watch.ExpandString command with a metadata command as its input parameter, in between double quotes. For example, the following script line gives the value of the first BarcodeValue metadata field of the first datapage: watch.expandstring("GetMeta(BarcodeValue[0],0,Job.Group[0].Document[0].Datapage[0])") Another method is to use a Set Job Info and Variables task to copy a metadata field into a Workflow variable.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Other Notes Here's a list of the hard-coded PDF values for files generated with this new plugin. Basically, these settings correspond to Digital Action and PlanetPress Image settings for Standard Quality: l l l l l l l l l l l PDF version : 1.
General Tab l l l l l l l Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Output folder: Enter the name of the folder in which you want the decompressed files to be stored. File mask: Enter a file name mask to specify which files must be decompressed. Leave the default value of *.* to decompress all the files found within the zip.
For images you should rather use Send Images to Printer action tasks (see Send Images to Printer), as they provide image quality and conversion options. Input Any file that you wish to upload to the printer. Note that this task does not attempt to verify that the type of file being sent is compatible with the printer, or is in a supported file format. Processing The currently active data file is sent to the specified location on the printer.
l l The executable file must accept so-called "command-line options" and be able to run without any sort of user interaction. Only certain programs are able to do this and may refer to it as "command-line" or "automation" features. The process will always wait for the executable file to finish before it continues to the next task, and does not have any timeout setting. This mean that if your program fails to exit for any reason, your process will hang. Input Any active data file, in any format.
l Return: Use the drop-down to select whether this exit code should define a success or a failure of the external program. If "Failure" is chosen, exit codes that match the condition set will cause the On Error tab to be triggered and any other exit code will be considered a success. Inversily, if Success is chosen, exit codes that match the condition set will cause be considered a success and any other exit code will cause the On Error tab to be triggered.
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. The expression itself must be written in a format understood by the VBSCript scripting language.
Processing The XSLT is applied to the XML data file. Output The modified XML data file is output. Metadata and jobinfos are not modified. The Open XSLT menu options are as follows: l File l l l l Import: Lets you open an existing XSLT script from an XSL, XSLT or TXT file. Export: Lets you save the current XSLT script as a file. Print: Prints the current XSLT script. Edit Undo: Undo the last edit. Cut: Cut the current selection (only available if there is selected text in the editor).
PlanetPress Database action tasks require version 2.5 or higher of the Microsoft Data Access Components (MDAC), including JET 4.0. When adding a PlanetPress Database action task, you have two options: l l You can use static properties (properties that will remain the same regardless of the data processed at runtime). This option lets you use an Open DataBase Connectivity (ODCB) compliant data source. You can also edit the SQL statement that assembles the database table.
Emulation options group: Options from this group change based on the selected output file emulation. l PlanetPress Database Emulation: If you selected PlanetPress Database in the Output file emulation box, the following options are available: l Create data pages as follows: Select the option that will be used to generate the data pages. Each data page created using the table or query selected above (Table/Query box) can contain a single record, a fixed number of records, or a variable number of records.
l l l Edit SQL: Click to create and test an advanced SQL query. Import Config: If you previously created and exported a PlanetPress 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.
Processing The task renames the job file to the desired name, and changes the value of %f and %F to reflect the new name. Output The input data file is output, with the new name. Rename action task property is as follows: General tab l New file name: Enter the job file’s new name. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. On Error Tab The On Error Tab is common to all tasks.
l File l l l l Import: Lets you open an existing script from an external file. This file can be in .vbs, .js, .pl or .py for language-specific scripts, or .txt for any of them. Export: Lets you save the current script as a file. Print: Prints the current script. Edit Undo: Undo the last edit. Cut: Cut the current selection (only available if there is selected text in the editor). l Copy: Copy the current selection (only available if there is selected text in the editor).
Send Images to Printer The Send Images to Printer Action Task is used to (obviously) send images to the printer so they can be used as resources by documents run on the printer. They are comparable to Download to Printer action tasks (see Download to Printer), but they include image specific options. Furthermore, they can be used to send images not only to printers, but also to the virtual drive of other computers running PlanetPress Suite applications.
l Print confirmation page: Select to print a confirmation page on each one of the selected printers after an image has been successfully received. On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Send to Folder Send to Folder action tasks send the files they receive to a local folder.
Input Any data file in any format. Processing This task assigns the defined values to each local or global variables or job informations. It does not modify the data file nor the metadata. Output The original data file, metadata and job infos are not modified, they are passed on to the next task. Set Job Infos and Variables action task properties are as follows: General tab l l l l l l Var/Info#: Lists all job infos, local variables in the current process and global variables in the configuration.
In the case of "string" type data, SOAP Client tasks normalize all line endings to a single line feed character. Task Properties General tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the dropdown list. 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).
Standard Filter Standard Filter action tasks can be used to remove HP Escape characters from data files, as well as to eliminate spacing problems caused by LF-CR end-of-line sequences. HP escape characters are used in the Hewlett Packard Printer Control Language (HP PCL) to communicate basic page formatting and font selection information from print jobs to HP or HP-compatible printers.
Codepage 1252 (ANSI - Latin 1) is used for many Latin language documents, since it can be used for Afrikaans, Basque, Catalan, Danish, Dutch, English, Faroese, Finnish, French, Galician, German, Icelandic, Indonesian, Italian, Malay, Norwegian, Portuguese, Spanish, Swahili and Swedish. Codepage 932 is often used for Japanese. Input Any text-based data file. Processing The characters in the data file are converted from the old encoding to the new one. Output The data file in its new encoding format.
Processing The EMF job is converted into a text-only, Line Printer Emulation data file. Output A Line Printer file. Metadata, job infos and variables are not changed. Windows Print Converter action task properties are as follows: General tab 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.
Vertical distance: Indicates the biggest acceptable vertical distance between two text passages so that they're still recognized as belonging together. This is the factor the font's height and size is multiplied with. The value for the font's height therefore is taken from the corresponding font's attributes. For example, if the height of that font example in 10 point size is 0.32 cm. There is a passage found that is positioned 0.15 cm above - which means 0.15/0.31 = 0.48 < 0.50 - the previous text passage.
Splitters do not modify the metadata that is currently active within your process. This means that, if you are intending to use metadata along with a process using splitters, you can either use the Metadata Sequencer instead of a splitter, or (re)create the metadata after the spiltter. About Using Emulations with Splitters When an emulation is used with a splitter action task, the job file is emulated, cut to pieces and de-emulated. Most times, the emulation/de-emulation process is completely transparent.
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. Database Splitter action task properties are as follows: General tab l l l l l l l l l l l l l l l l Split group: Use this group to indicate how you want the file to be split.
Emulated Data Splitter Emulated Data Splitter action tasks are used to split emulated data files (with the exception of XML and database data files refer to XML Splitter or Database Splitter) into multiple data files that are passed to subsequent tasks in the process. The data received by the process is typically prepared for a given output device using a pre-set emulation. In some cases, the data’s original emulation may also have been changed by a Change emulation action task (see Change Emulation).
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. l 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).
word based splitting process to take place. l Word: Enter the word to use as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. You may also use the Get Data button to get a static string of characters from the sample data file. If you use this option, the coordinates of the data you will select will be added to the From column and To column boxes below.
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. Generic Splitter action task properties are as follows: General Tab l l l l 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.
l l l Word is between columns group l From and To: Enter a horizontal search region defined as starting from a given column and ending at a given column. If you enter 1 in the From box and 1 in the To box, the Generic Splitter will search for the string of characters entered above only in the first column of the line selected above. If you enter 1 in the From box and 10 in the To box, the Generic Splitter will search in the ten first columns of the line selected above.
l Split when condition found: You may not want to split the file every time the string of characters entered in the Value box is found, but only every other time, or every third time. If so, enter the number of times in this box. A Database Field Change: If you choose “A database field change” in the Split data file on list box (the Use emulation option must be selected), the following box is displayed. l l l l Field name: Enter the name of the field that the Generic Splitter must check.
l l to take place. 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.
XML Splitter XML Splitter action tasks use the XSLT language to split XML data files into multiple XML data files that are passed to subsequent tasks in the process. The XML splitter includes options to add a new root node within the generated files, as well as to change the original file’s encoding to UTF8. Note that the XML Splitter cannot process files larger than 30 megabytes. Input A XML Emulation data file.
l l l Advanced XML splitter options 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. Refresh XSLT: Once you have made all the required settings using the Standard XML splitter option, click this button to display the XML code generated by the XML splitter.
Process Logic Tasks A process is like a flowchart. The data files captured by the input tasks become job files (see Data File and Job File) that travel down the process. Many processes include multiple process logic tasks. In the Process area, conditional branches appear with their associated condition, allowing you to understand the logic of the whole process at a glance.
l secondary branch includes a secondary input task or a Change Emulation action task, then the last emulation selected in the secondary branch will be the one used for the main branch. Backup local variables: Select if you want PlanetPress Suite Workflow Tools to use identical copies of the local variables for the main and secondary branches. When this option is not selected, the local variables that reaches the output task located at the end of the secondary branch is used for the main branch.
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).
Loop Loop action tasks are used to repeat those tasks that are located after it on a given process branch. The number of repeats can be fixed or variable, as required. Loop action task properties are as follows: General tab l l l l Number of iterations: The number of times the loop should be repeated. Every task after the Loop Action Task will be repeated this number of times. The number may be static, or use a variables (see Variable Properties).
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 variable in your script. Run Script action task properties are as follows: The Script Editor menu options are as followed: l File l l l l Import: Lets you open an existing script from an external file. This file can be in .vbs, .js, .pl or .py for language-specific scripts, or .txt for any of them.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Send to Process The Send to Process task transfers job file(s), job information and all related files (metadata, sorted metadata, etc.) to a selected process.
l l sufficient access to the SNMP device to monitor it with the condition. Most SNMP devices come with a public community name that usually gives you read-only and/or read-write access. It is recommended to increase security on your network by entering community names allowing varying levels of access depending on the particular device, its users, etc. The community name tells the device which rights to grant PlanetPress Suite Workflow Tools (required to perform the test).
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Text Condition Text conditions can be used to perform two different types of tests: l l To test the presence of a string within the job file.
l l l 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. The page range setting is only considered when either ”Is found” or ”Is not found” is selected in the Operator box. Range: Entries must be separated by commas. Page ranges are entered using a starting page and an ending page, separated by a dash. For pages 1, 3 and 5 to 7, you would enter the following: 1,3,5-7.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Connector Tasks A Connector, as the name implies, is a task that connects to something outside of PlanetPress Workflow itself.
l l l l Microsoft SharePoint 2007 Microsoft SharePoint 2010 Windows SharePoint Services 3.0 SP2 SharePoint Foundation 2010 Input Any data file present on a SharePoint document store, even those not compatible with PlanetPress' emulations. 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.
"Other" Tab l l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task. 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.
l l Laserfiche configuration tab l Folder: Enter the Laserfiche client repository folder where the documents will be exported. The user can specify the remote folder by clicking the Browse… button. Note: If the Folder field is empty, the documents will be exported by default to the root folder l Import Format group l Laserfiche Pages: Converts all images files (*.bmp, *.gif, *.jpeg, *.pcx, *.png, *.tif, *.tiff, *.txt) into the Laserfiche internal TIFF format on the server.
l l If you intend to use PDI for number type, your decimal separator in both your Regional and Language Options and in PlanetPress Index (PDI) numbers should be a dot ("."). The Laserfiche output task will only work if an activated PlanetPress Imaging is found, either locally or on the network. LaserFiche Repository Output Task - Configure Templates A Laserfiche template consists of a collection of template fields.
l l l l Selecting a tag will assign it to the exported documents. There are two types of tags: informational tags (icon with an exclamation mark ("!")), and security tags (icon with a lock). All tag properties are the same as in the Laserfiche client console. The Comments columns allow the addition of comments to the tag. This column supports the use of any PlanetPress Suite Workflow Tools variables. Restrictions l l The column Comments in the Configure Tags interface allows a maximum of 200 characters.
l l Metadata group l Lookup Field: The name of the metadata field that will be used to determine which row should be returned. The Metadata field can be on any level. l Lookup Column: The name of the column in the Microsoft® Excel® worksheet that corresponds to the contents of the Lookup Field. l Action: What to do with the resulting data from the Microsoft® Excel® worksheet. This can be: l Add Field: Creates a new field with the data. This may cause multiple fields to be created.
Microsoft® Word® Documents To PDF Conversion The Microsoft® Word® to PDF Action Task can be used to convert a Word® document into a PDF file that can be used in your PlanetPress Suite Workflow Tools process. It can also do a Mail Merge as it runs the task. This plugin is only available with PlanetPress Production (and not with PlanetPress Office or PlanetPress Watch). Microsoft® Word® needs to be installed for this task to be functional and to test the connection.
l Output Type: l .PDF File (with metadata): The result will be a PDF file with the number of pages generated by the combination of the template and recordset. Metadata is also included that complement the PDF. l .DOC file: The result is a Microsoft® Word® document in .doc format. Note that this format is not supported by PlanetPress Suite as a data file or job file, so this option is only useful if you are simply planning to save the Word document in a specific location.
Task Properites General Tab l l l l 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 Capture Post Processing Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
About PlanetPress Fax What is PlanetPress Fax? PlanetPress Fax is a service that can be used to output data and documents via a faxing software, such as Windows Fax (available with Windows 2000, XP, and Microsoft Windows Server™ 2003) or Symantec WinFax PRO, as well as via a faxing server, such as Captaris RightFax. Note that it is these applications that do the actual faxing.
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. Documents: Select a specific PlanetPress Design document if you want all the jobs to be faxed with that document. You must select a document, passtroughs are not available.
You also need to make sure that a user exists in the RightFax user list that has the same username that will be used for the PlanetPress Fax service (see section 2. PlanetPress Fax configuration). Any faxes sent to RightFax by PlanetPress fax will appear in that user's queue in the FaxUtil provided with RightFax. PlanetPress Fax configuration First step is to make sure that the PC on which PlanetPress Fax runs has access to the RightFax printer.
About PlanetPress Image What is PlanetPress Image? PlanetPress Image is a mutli-threaded service that can generate image files in PDF, JPEG and TIFF format. As the PlanetPress Suite Workflow Tools and PlanetPress Image are compliant AutoStore, DocAccel and KYOcapture, these formats can also be used. These image files can be archived and, depending on whether you use a PlanetPress Image output task or a Digital Action action task, sent via email.
Processing & Output Multiple things can happen, depending on the options chosen and the type of data this task receives: l l l If the data file and a document are selected, and "Printer Centric" mode is used, the data file is sent to the PlanetPress Image host which merges the data and document to produce output.
l l l l l l l l Color depth: Enter the color depth of the output image in bits per pixel (bpp). The color depth is measured in bits, because each pixel of the output image can be described with a varied number of bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images.
l l support binary files. This option also generates smaller files. l Compress text and line art: Select to compress the text and line work in the file using the Flate compression filter. Flate is a compression method that works well on elements with large areas of single colors or repeating patterns, as well as on black-and-white elements that contain repeating patterns. l Auto-rotate pages: Select to automatically rotate pages based on the orientation of the text or DSC comments.
l l l l Color images group l Color compression: Select the compression to use for the color images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs. JPEG removes image data and may reduce image quality, but may be suitable for continuous-tone photographs containing more detail than can be reproduced onscreen or in print.
PlanetPress Search Database tab If PlanetPress Workflow is configured to automatically update a PlanetPress Search database (see PlanetPress Image User Options), 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.
Once more, if you chose Send Email in the General tab, use this tab to choose the appropriate email settings. l l l 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 runtime. Use document’s Email address: Select to send emails generated by PlanetPress Image to email addresses identified by the PlanetPress Design document selected in the General tab.
l l Password protect Zip file(s): Select to force recipients to use a password to open the attached zip files. Note that users will be required to use this password open each one of the generated zip files. Password: Enter the zip file password. Links in the Image Generation Process Since PlanetPress Image lets you create image files via output tasks as well action tasks, and since it can also be used to generate files using proprietary formats, various software may be involved in the process.
Name: Value: arated into pages. These tags wrap around all the information for a single page resulting from a job. Contained in the page tags will be fields, page number, and other tagged information such as text. These tags wrap around all the pages part of the job. They appear after the information in the header of the XML file.
essentially the same except for the version supported: PrintShop Mail only supports 6.1 documents, while PrintShop Mail 7 supports 7.0 and 7.1 documents. Limitations In order for the PrintShop Mail tasks to be functional, some pre-requisites must be met: l l l PrintShop Mail version 6.1 or higher must be installed on the same system, and an activated PrintShop Mail production dongle must be plugged in to the system.
PostScript Driver: Select which driver to use to generate the job. This should be the same as the printer selected in your PrintShop Mail document when designing it. This option only appears in the PDF and Produce PostScript output types. l Windows printer: Select the print driver of the printer to which you want the print job to be sent. This option is only available when Windows PostScript driver is selected in the Output type box.
Input A data file in PGC or PDF format that is accompanied by valid Metadata. This metadata must contain Capture information and is generally available after a Capture Fields Processor or Find Capture Documents task. However, it is also possible to directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and metadata are completely ignored by this task's condition rules, and the database information is used instead.
Index: The specified index of the capture field of this name should contain ink. The Index property is generated when a Capture Field object is repeated or is part of a runpage. This index is 1based. l Pidget setting: Triggered by specific pidget settings. l Every pidget setting (such as stroke color and stroke thickness) is listed here. If the specific pidget was triggered before ink was applied to the Capture Field, the conditions becomes true.
Capture Fields Generator The Capture Fields Generator Action Task is used to generate Capture patterns in your job, which will then be printed for use with an Anoto Digital Pen. It also interacts with the Capture database and does some operations. PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently.
l l l l l 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. l From metadata: Use the Document Title property as set in the PlanetPress Capture section of a PlanetPress Design document's properties. l Custom: Use the title in the input field as set by the user.
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. During processing, ink is always applied to the document first and then the logic is applied for releasing patterns. This means that even if a document is closed by a field set as Final that was checked first, ink present in other fields will still be applied to the document.
l l l l l PGC Name: This value will be added to the output metadata, as well as the Capture Database, to link the PGC to the document it updates. Pattern sequence group l Type: Specify from where the Pattern Sequence should be taken. l None: Do not use a Pattern Sequence. l Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database. l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection.
Processing The PGC file is split by document, if a document can be matched for each pattern ID found in the PGC. The match is made by comparing each Pattern ID with the information found in the Capture database. If more than one pattern is used in a document (pattern on multiple pages of the document), all of the information for this document (more than one Pattern ID) is sent down as a split. Patterns that do not match any document are sent individually, one Pattern ID per split.
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 and Get Capture Document tasks. Task Properties General Tab l l Document-ID Based Condition: Select this option for this task to filter its results using a specific Document ID. l Document ID: Enter the ID on which you want to filter.
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. l Add button: Click to add a condition row to the grid. l Remove button: Click to remove the currently selected condition from the grid. To select a row, simply click on any of its 3 components.
Output The Get Capture Document action task is a loop that outputs a PDF version of the Capture Document. The PDF contains the original document, any ink added by the Capture Fields Processor action task. Task Properties General Tab l l l l Document Origin group: l Document to process: Determines where the document information is read l From Metadata: Select to use the current document available in the metadata generated by the Capture Field Processor.
Processing The ink contained in the PGC file is converted into an EPS layer, which is then applied on an blank, empty PDF file of the size specified in the task's properties. If more than one Pattern ID is found in the PGC file, each separate Pattern ID will generate a new page on which its ink is applied. Output A PDF file with a blank background and only the ink data found in the PGC file. Task Properties General Tab l PDF page size: Choose the page size of the output PDF.
Metadata Tasks Metadata tasks regroups plug-ins that can create or update metadata for a job file. Metatdata is a hierarchical structure describing a print job. It is composed of 5 basic levels, from outer to inner: Job, Set, Document, Datapage, and Page. Create Metadata Creates all the metadata that is either the result of the merging between a data file and a PlanetPress Design document, or the information about a PDF File. Input Either a data file in any supported Emulation, or a PDF File.
On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
This task should not be placed after a Metadata Sequencer. Input Any data file with accompanying metadata. Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties. 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 occurence of that level. Output The original data file is output, along with the modified metadata.
The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l Metadata Filename: Enter a static or variable name for the metadata file to load. Not active when the delete action is chosen. On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
l l The task CANNOT re-select unselected nodes if the condition is false for those nodes. Filter rules cannot be based on the following metadata attributes: SelectedIndexInJob, SelectedIndexInGroup, SelectedIndexInDocument and SelectedIndex. Metadata Level Creation Conditionally create new metadata groups or documents. This task is only functional if metadata already exists for the current job.
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. Note that *all* the metadata is in each of the sequence, but anything not part of the sequence is disabled and is ignored by all tasks using metadata afterwards. Task Properties General Tab l l Metadata level: Select the metadata level to process. Sequencing is based on...
l l l Sort by: The drop down displays a list of available fields and attributes in that level, letting you select on which to sort. The field or attributes must be present for every instance of the level you are searching on, or the task raises an error. Order: Choose Ascending (orders like a,b,c, or 1,2,3) or Descending (orders like 3,2,1 or c,b,a) order. If the Numeric sorting option is not checked, numbers are sorted like this: "1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9".
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. Metadata-Based N-Up The Metadata-based N-Up Action task works in conjunction with the PlanetPress Design tool's N-Up functionality.
l l l l l Metadata Fields Management Metadata Filter Metadata Level Creation Metadata Sequencer Input from SharePoint Conditions are expressed using the following syntax: The and options represent the values for comparison.
1. 2. 3. 4. Define condition A. Select condition A and choose Add Condition. Specify the logical operator AND. Define condition B. Select condition B and choose Add Sub Condition. This will indent condition B and allow to define the condition C. Specify the logical operator OR. 5. Define condition C. 6. Right click on the first AND operator (the one right after condition A) and choose Add Condition. Specify the logical operator AND. This will create a condition at the same level as A. 7.
Output Tasks Output tasks are exits from PlanetPress Suite Workflow Tools processes. They can be used to send data to specific devices, such as printers, applications, such as email software, or locations, such as folders. A single process can include multiple branches, each one terminated by an output task, and so a single process may generate output via a variety of output tasks.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. FTP Output FTP output tasks send job files to other computers using the FTP protocol.
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 Suite 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. However, this output can work with nonpostscript printers such as HP PCL printers.
The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
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 Suite Workflow Tools Printer Queue Options dialog box—see Print Using a Windows Driver) will be sent to each one of the selected printer queues.
l l Subject: Enter the subject of the emails generated by PlanetPress Image for this task. Note that if you use a data selection in this box, you must be sure that the data that will be selected at runtime 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) with a Strip() function to strip them out. Message: Enter the content of the email message.
l l Account name: Enter the name of the account that PlanetPress Suite Workflow Tools is to use to send emails via the mail server. Password: Enter the password associated with the account name entered above. Examples & Use Cases This task is put into effect in the following use cases and example processes: l Capture Post Processing Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten. SOAP Client Plug-in SOAP Client tasks can be used as input, output and action tasks, although their basic function is to generate output.
l l l l l Name: Displays the name of the arguments associated with the selected method. Note that you may also manually enter new arguments, change or delete existing ones, as well as change their order if needed. Type: Displays the argument type. Value: Lets you enter fixed or variable values. To exchange variable information between the Web service and PlanetPress Suite Workflow Tools, you must use job information variables %1 to %9 or variable %c (which contains the entire job file).
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 filename, followed by part of the first line of a text data file, then the current date.
l l Opening a configuration that contains additional plug-ins that are not installed on that system will cause these plug-ins to be replaced by unknown tasks. Installing the additional plug-ins and re-opening the configuration will restore the plug-ins and their properties. Opening a configuration that contains plug-ins only available in PlanetPress Production or Office (such as Create PDF) from a PlanetPress Watch installation will cause these plug-ins to be replaced by unknown tasks.
Special Workflow Types Special Workflow Types The PlanetPress Suite Workflow Tool supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility. However, some types of processes like PDF, HTTP and SOAP are important enough to pay some attention to them. This chapter will describe each of these special workflow types and give at least one example of an implementation that uses them.
Special Workflow Types l l 10,000 Patterns PlanetPress Capture Implementation Restrictions There are also 2 external tools that are used to communicate the pen's data to PlanetPress Workflow: l l Anoto penDirector PlanetPress Mobile Application The PlanetPress Capture workflow 1. Creating a Capture-Ready document This is done when creating your PlanetPress Design document.
Special Workflow Types directly convert a PGC file to a blank PDF file containing the ink data as an EPS layer. This is useful when, for example, data is received for a document that's already been closed. l l l The Input Error Bin input task is triggered when the process sends data to the error process. A PGC to PDF Converter task converts the PGC to a PDF Any existing output is used here, for example an email notification.
Special Workflow Types Client/Server Architecture A multi-server setup where more then one PlanetPress Production server are connected as clients to a single PlanetPress Production 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.
Special Workflow Types Pidget Type of PlanetPress Capture object. Page element used to give instructions to the Anoto pen, as opposed to recording ink. PlanetPress Capture Database A database containing the list of patterns, sequences, registered pens and documents. The Capture Database can be used by a single server, or by multiple servers in a Client/Server architecture. Session The time spent by the pen between events that trigger a new session.
Special Workflow Types l l In the event where 2 requests are made simultaneously on the same record, SQL Server will drop the most complex request. Resubmitting the PGC for processing should resolve this issue. This, however, should happen only rarely. When configuring the ODBC connection, your must use the Microsoft version of the driver, and not the Native SQL version of the driver. This is due to a technical limitation of the native driver that interferes with the PlanetPress Suite database requests.
Special Workflow Types l l l PlanetPress Production could use software such as a packet sniffer to retrieve its parts and recreate the PGC files. This may be resolvable by create a secure VPN tunnel for each location where penDirector is installed instead of going through regular remote HTTP server. The PlanetPress Capture database, since it can be external to PlanetPress such as on a MySQL server, will be dependent on your own database security.
Special Workflow Types The third important number is based on your actual output needs. In other words, how many documents do you intend to print on a regular basis that will contain a pattern? These three numbers, together, represent an easy way to determine if the 10,000 patterns are actually enough for you.
Special Workflow Types tagged (with a label) as being for use with a specific pattern sequence also. Each morning, as drivers are attributed a route, they pick up the correct pen and stack of paper that belong to their route before leaving. It's very important to note here that the Anoto Digital Pen has absolutely no concept of Pattern Sequences. When "attributing" a sequence to a pen, this is fully on the PlanetPress Production side, in the Capture Database.
Special Workflow Types coffee and exchange their pens inadvertently (we hope, anyways), the pens would be signing the "wrong" documents all day and, when docked, would update the wrong documents in the database. In all of these cases, the errors often do not appear when the wrong document is updated - it actually occurs when the "right" data is processed.
Special Workflow Types Bluetooth Connectivity The Anoto penDirector program can also connect directly to the pen via wireless Bluetooth and receive PGC files directly through the Bluetooth link, without needing to dock the pen. To pair penDirector with an Anoto Digital Pen: 1. Make sure that a Bluetooth dongle is present and enabled on the computer where penDirector is installed. 2.
Special Workflow Types Not all phones that can support the software can actually support the transfer modes between the pen and the mobile phone. Some phones are thus not compatible with the PlanetPress Mobile app, even if the app itself installs properly. As a general rule, devices with BlueTooth that support OBEX FTP should be compatible, as long as they support one of the app versions above. List of known incompatible phones: l l Google Nexus S (made by Samsung) with Android OS 2.3.
Special Workflow Types The main screen contains 3 navigation buttons, a status screen and 3 action buttons. l l l l l l l l l General Configuration General Configuration: Click to open the General Configuration dialog Host Configuration: Click to open the Host Configuration dialog PGC handling: Click to open the PGC Handling dialog Status: indicates the status of the background service Sent... : Indicates the number of PGC files sent to the remote host.
Special Workflow Types The General configuration dialog has the following configurable options: l l l Host Configuration Automatic Start: Starts the PGC handling service immediately when opening the app. If this option is unchecked, the service needs to be started manually when opening the app. Delete PGC after X days: Automatically delete any local copy of the PGC files after the specified number of days. Note that not all phones support writing to the memory. This option does not apply in this case.
Special Workflow Types The Host Configuration (or "Server Configuration") determines where the PGC files will be sent after being received from the pen. l l PGC Data handling Server: This is the equivalent to the "PGC POST URL" option found in the Anoto penDirector application. It corresponds to the server (including the port and the action name) where PlanetPress Production is installed and activated with PlanetPress Capture. Note that HTTPS is not supported at this time, except on BlackBerry devices.
Special Workflow Types The PGC Data Handling dialog determines where the PGC files are stored on the phone's internal memory. Note that if the phone does not support local storage, this option will have no effect. l l Source folder: The path to the folder where PGCs should be stored. Browse: Click to open a dialog that displays all the accessible folders on the local storage. If you need to create a new folder, you will need to use your phone's file explorer or a third-party tool.
Special Workflow Types 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.
Special Workflow Types 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.
Special Workflow Types Basic Functional Capture Workflow This workflow is the most basic and simple workflow that you can use with PlanetPress Capture. In small implementations with only one simple document, this may be the only thing required for a functional workflow since, even in this simple state, it can be enough to automate the archive of your digital documents. The workflow requires two separate processes that will be triggered at different times.
Special Workflow Types After retrieving information from the Capture database There are two basic ways in which the Find Capture Documents task can be used. First, in an automated process that runs at specified intervals. For example, the following process which sends a daily report of all incomplete and "in error" documents to an agent who would presumably take action on each document through the document manager.
Special Workflow Types Capture Web Manager Workflow This example is both a more involved workflow for Capture, and an interesting implementation of an HTTP Workflow. Before looking at this example, it would be best to become familiar with both PlanetPress Capture Workflow and HTTP Server Workflow. The example is too complex to display as images in this guide, so it is rather available for download.
Special Workflow Types This example is compatible with PlanetPress Suite 7.4 and higher and will not work in older versions. Installation 1. 2. 3. 4. 5. 6. Download both resource files Create a folder on your disk called c:\planetpress Open the invoice.pp7 document and send it towards your local PlanetPress Workflow server (localhost or 127.0.0.1) Open the configuration file CaptureExampleProcess.pw7 Go in the PlanetPress Button ("file" menu) and go in Preferences.
Special Workflow Types PlanetPress Workflow can serve both static and dynamic resources to a web browser, however it is not meant to be used as a fully featured web server, as it is not built for responsiveness nor guaranteed uptime. It is much better to have a common web server (for example, IIS or Apache) to serve your contents and to have PlanetPress available only to process things only it can do. You can control access to the PlanetPress Suite Workflow Tools HTTP Server via the Access Manager.
Special Workflow Types And finally, the HTTP Server Input task properties. While these are described in the HTTP Server Input 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. That is to say, placing the action myaction here means the process would be triggered by opening http://127.0.0.1:8080/myaction in your browser.
Special Workflow Types Example HTTP Workflows l l l HTTP PDF Invoice Request (GET) HTTP Brochure Request (Customer Information+ POST) Capture Web Manager Workflow (PlanetPress Capture + HTTP) 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.
Special Workflow Types 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. The condition returns "true" if the file is not found: c:\planetpress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum[1]',Value,Ke
Special Workflow Types l l l When the condition is false, it means that there is something in the Full Name field. In this case, we know that the form was filled and submitted back to the process, and we handle the request as such. First, we add the full name, email and company information to job informations, in order for them to be available for the rest of the process. Then, we have a small condition that verifies if the user checked the "Newsletter" box. If so, the conditional branch is triggered.
Special Workflow Types Examples l Daily Sales Report from PDF Files Daily Sales Report from PDF Files This workflow makes heavy use of both PDF Tools and Metadata, and assume that you are using PlanetPress Office or PlanetPress Production version 7.3 or higher. This single process workflow generates a daily sales report for any sales rep inside of a company which made at least one sale.
Printer Queues and Documents Printer Queues and Documents This section delves into the subjects of PlanetPress Suite Workflow Tools printer queues and PlanetPress Design documents. PlanetPress Suite Workflow Tools Printer Queues The printer queues displayed in the Configuration Components Pane of the PlanetPress Suite Workflow Tools Configuration program are not to be confused with Windows printer queues.
Printer Queues and Documents Frequently Used Printer Control Characters Character name: Character code: Typical use in printing context: End-Of-Job \004 Indicates the end of a print job Backspace \b Moves a character space backwards Horizontal Tab \t Adds a horizontal tab Line Feed \012 Moves to the next line Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape
Printer Queues and Documents LPR output printer queue properties are as follows: General tab l l l l l Printer address: Enter the IP address or host name of the printer receiving LPR jobs. Queue name: Enter the printer queue name. Based on printer and network requirements, this property may not be required. Data type: Select the proper data type. Select (l) Binary data if the job file is a standard binary file.
Printer Queues and Documents l l l l FTP Port: Enter the FTP port to use. This option is disabled if Use FTP Client default port number is checked. The port should always correspond with the server's port number. Directory: Enter the directory to which the print jobs are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server. File name: Enter the name under which the print jobs will be saved.
Printer Queues and Documents l l l l Add: Click to add a new command to the list displayed in the Commands box. You must then edit the new command’s description and value. Note that new commands are shared by all printer queues. Delete: Click to remove a command from the Commands box. Command description: Use this box to edit the description of the command currently selected in the Commands box. Command value: Use this box to edit the code of the command currently selected in the Commands box.
Printer Queues and Documents A PlanetPress Document Package, or PTZ, is a file format consisting of a ZIP file, which contains all the document's data and resources. With a PTZ, resources are extracted and uncompressed only once when your PlanetPress Suite Workflow Tools receives the file.
Printer Queues and Documents l l When the server running PlanetPress Suite Workflow Tools sends a PlanetPress Design document along with the data to the printer, it adds a trigger before the document (trigger+document+data). When the server running PlanetPress Suite Workflow Tools 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).
Printer Queues and Documents is created, end-users can install it on their own computer by going through the same steps they would when installing a new remote printer in their Operating System. By default, connecting to a shared printer will automatically result in the Objectif Lune Printer Driver being downloaded to the connecting host.
Printer Queues and Documents Note that steps 6-8 can be performed at any time, even if PlanetPress Watch/Office/Production is not yet started. This is because every Windows printer queue using Objectif Lune Printer Driver (PS) is paused by default. 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 l l PDF 1.
Printer Queues and Documents l Optimized PostScript Stream can be used in any version or flavor of PlanetPress Suite. However, if used in PlanetPress Watch or PlanetPress Office, a license must be available for the printer or the output will contain a watermark. In PlanetPress Production, you can output to any PostScript printer without a watermark. Windows Printer Queue: This run mode is only available through the Print Using a Windows Driver output task, and uses printers that are installed in Windows.
Debugging and Error Handling 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 Suite Workflow Configuration Tool, in order to detect and resolve issues with your process.
Debugging and Error Handling While stepping through a process (using Step, not Run): l l l l l l l l l l l Double-click on any task to change its properties. If you change the properties of a task before you step through it, those new properties will be used when the task is executed. Note that you cannot modify the process itself while in debug mode (you cannot add, delete or move tasks, change branches and conditions, etc). Click on Skip to ignore the next task or branch and go to the next one.
Debugging and Error Handling l Instead of skipping through each task, use the Run from here or Step from here options, either from the Debug tab or by right-clicking on the task where you want to start the process. Once you have created and fully debugged all your processes, you will be ready to send it to the PlanetPress Workflow Tools service. See Saving and Sending a Configuration.
Debugging and Error Handling You can have as many error processes as you can normal processes - that is, you are limited to 512 processes, subprocesses, startup processes and error processes combined.
Debugging and Error Handling l There are multiple logs displayed here, including: l ppwYYYYMMDD.log - PlanetPress Suite Workflow Tools logs, including the year, month and day of the log (from midnight to midnight). The PlanetPress Image and PlanetPress Fax logs are available in different folders. From the Watch folder, go up one level then go in either folders, under which you will find the Log folder for that specific software within the suite.
Debugging and Error Handling 5. Using the From page and To page boxes, select the data pages that you want to resubmit. If you want to resubmit all the data pages from the selected input file, enter 0 in both boxes. 6. Click Send to resubmit the data. 7. To resubmit backed up input files for the same process or for a different one, repeat step 2 to step 6. 8. To close the File Resubmission dialog box, click Close.
Using Scripts Using Scripts Scripts can be used to perform various operations, such as to manipulate data, for example. PlanetPress Suite Workflow Tools can perform scripts written in four different scripting languages and also provides an interface for editing scripts. While this chapter provides some very useful and detailed information about scripting within PlanetPress Workflow Tools, its focus is to inform you about the features, variables and functions unique to this environment.
Using Scripts Use the Editor The Script Editor and XSLT Editor share most of the same commands and functions. You can open the Script Editor using the Open Editor button both from the Run Script Properties dialog box and from the Open XSLT Properties dialog box. When you do so, the script currently displayed in the dialog box is pasted to the editor’s scripting box. For information on the available editor options, refer to Editor Options.
Using Scripts Whole words only: Select to limit the search to complete words matching the text in the Text to find box. Whole words are defined as strings that have a space or punctuation before and after the word. Regular expressions: Select to treat the regular expressions of the scripting language as text to search. If you clear this option, the regular expressions of the language are not included in the search. Global: Select to search the entire content of the script.
Using Scripts text, you move forward only within the selection. When the search reaches the end of the script or script selection, the search finishes. It does not loop back to the beginning. Backward: Select to search the script backward, from the location of the cursor or from the end of the script, depending on what you choose for the origin (From cursor begins where the cursor is currently located in the script, Entire scope begins from the beginning of the script or beginning of script selection).
Using Scripts Jump to Bookmarks Before you can jump to bookmarks, you must add bookmarks to specific lines in your script (see Toggle Bookmarks). To jump to a bookmark: l From the editor’s pop-up menu, choose Go To Bookmark and a given bookmark number. If the bookmark you selected was displayed on a line, the cursor jumps to that line. SOAP Server API Reference PlanetPress Suite offers a SOAP server API Reference allowing jobs to be submitted from third party application using the SOAP protocol.
Using Scripts l ResultFile – base64Binary. If Success is different than 0 or the ReturnJobFile was set to False in the initial call, no file is returned. Otherwise, ResultFile contains the job file, as it existed at the completion of the PlanetPress Suite process (for instance, if the process creates a PDF and sets it as the current job file, the PDF is the file that gets returned to the calling SOAP client).
Using Scripts GetProcessList (Username, Password) : GetProcessListResult Description The GetProcessList function allows SOAP clients to request the list of available PlanetPress Suite processes, based on their authentication credentials. Parameters l l Username – String containing the username. Password – String containing the password. This value is case sensitive.
Using Scripts l l l TaskName – String containing the name of the task TaskIndex – Integer : 1 based index of the task. TaskDepth – Integer : 1 based depth of the task. Notes l The TaskNames array will be sorted by the execution order of the process with the primary input of the process having an index of 1.
Using Scripts l l l l l VariableList – Array of complex type, containing pairs of variable names and variables value. The list also contains the JobInfo variables. l VariableName – String l VariableValue – String ProcessName – String - Name of the PlanetPress Suite process. TaskIndex – Integer - 1 based index of the task where the resubmission should start. FirstPage – Integer - First page of data to process. LastPage – Integer - Last page of data to process.
Using Scripts Variable Name Description Example Usage (VBScript) Watch.GetJobInfo Retrieves the content of a numbered job info (%1 to %9). Example Usage: str = Watch.getjobinfo(9) Watch.GetVariable Retrieves the content of a local or global variable by name. Example Usage: str = Watch.getvariable("Varname") Watch.ExpandString Retrieves the content of any Workflow string, containing any variable available to Watch, including data selections. Example Usage: watchDate = Watch.
Using Scripts Python Watch.ShowMessage("test message") Perl $Watch->ShowMessage("test message"); Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line. The program's execution will be directed by the appropriate flags specified as this method's parameters. Syntax Watch.
Using Scripts Watch.GetJobFileName Returns the complete path and file name of the job. This method is the same as PW_GetJobFileName. getjobfilename() obtains the file name of a PlanetPress Suite process. This is useful for manipulating the job file, for example to replace data within it. If your script writes to this file, the modified contents will be used by the next plugin in your process.
Using Scripts VBScript Watch.GetMetadataFileName Javascript Watch.GetMetadataFileName(); Python Watch.GetMetadataFileName() Perl $Watch->GetMetadataFileName(); Watch.InputBox 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 Suite 7.3 and higher. Prompts the user to enter a string. The string is displayed as the window caption.
Using Scripts Perl s = Watch->InputBox("Your Name", "Please enter your name", "John Doe"); Watch->ShowMessage("Will the real " + $s + " please stand up?"); Watch.GetJobInfo Returns job information corresponding to the specified index. Index is an integer from 1 to 9. Syntax Watch.GetJobInfo(Index: integer): string Example VBScript Dim s s = Watch.GetJobInfo(3) Watch.Log("Jobinfo 3's value is: " + s, 2) Javascript var s; Watch.GetJobInfo(3); Watch.Log("Jobinfo 3's value is: " + s, 2); Python s = Watch.
Using Scripts Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.GetVariable Returns the string value of the corresponding variable name. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.GetVariable(Name: String): String Example VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.Log "MyVariable's value is: " + s, 2 s = Watch.GetVariable("global.MyVariable") Watch.Log "global.MyVariable's value is: " + s, 2 Javascript var s; s = Watch.
Using Scripts Javascript Watch.SetVariable("MyVariable", "MyVariable Value"); Watch.SetVariable("global.MyVariable", "global.MyVariable Value"); Python Watch.SetVariable("MyVariable", "MyVariable Value") Watch.SetVariable("global.MyVariable", "global.MyVariable Value") Perl $Watch->SetVariable("MyVariable", "MyVariable Value"); $Watch->SetVariable("global.MyVariable", "global.MyVariable Value"); Watch.ExpandString Provides access to the emulated job file and to all variables.
Using Scripts View error messages in the Services Console while PlanetPress Suite Workflow Tools is in Run mode by choosing Tools | Services | Service Console. In the Service Console, error messages appear with colors that correspond to the message level. Level Type Text Color in Service Console 1 Error Red 2 Warning Orange 3 Information Black 4 Debug Grey Arguments Message—A string representing the message that is logged in the log file.
Using Scripts 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.
Using Scripts Stopping Execution When using a script, you may come to a point where you'd like the task to fail (raise an error) and trigger your On Error tab under certain conditions. This can be done by using the scripting language's built-in error features, described here. Note that the value or description of the error will not be available to your error process if one is used. However, when available, a description of the error message will be logged in the Watch log. VBScript In VBSCript, the Err.
Using Scripts $s = $Watch->GetJobInfo(9); if (s = "") { die "Value cannot be empty"; } else { # Do something with Job Info 9! $Watch->Log("Job Info 9's value is: " .
Index
