User Guide www.objectiflune.
©2010 Objectif Lune Inc -2-
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.
©2010 Objectif Lune Inc -4-
Table of Content Table of Content Copyright Information 3 Table of Content 5 Overview 13 Icons used in this guide 13 Other Documentation 13 Getting Started 15 Environment Considerations 15 Terminal Services 15 VMWare/ESX 15 32-Bit or 64-Bit? 15 Antivirus Considerations 15 Backup Considerations 16 Microsoft Office Compatibility 16 Network Considerations 16 Local and Network Rights 16 Account Requirements 17 Mapped Drives 17 Network Ports used by each service 17 Activate Y
Table of Content Create a New Configuration 31 Open a PlanetPress Suite Configuration File 31 Saving and Sending a Configuration 32 Save your Configuration 32 Send your Configuration 32 Import Processes from Another Configuration File 33 Import Documents 34 Import PrintShop Mail Documents 34 Change the Interface Language 34 Exit the PlanetPress Suite Workflow Tools Configuration Program 35 The Quick Access Toolbar 35 The PlanetPress Suite Ribbon 36 Start and Stop the PlanetPress Sui
Table of Content Redo a Command 58 The Plug-in Bar 58 The Object Inspector Pane 59 Toggle the Run on Desktop Property 60 The Debug Information Pane 60 The Message Area Pane 61 Customizing the Program Window 61 Dock and Undock Areas of the Program Window 61 Show or Hide Areas of the Program Window 62 Combine and Attach Areas 62 Resize the Program Window Areas 66 Preferences 66 General User Options 67 Object Inspector User Options 67 Configuration Components Pane User Options 68
Table of Content Standard Variables 96 Available Standard Variables 96 Data in PlanetPress Suite Workflow Tools 97 Choosing a Sample Data File 97 Using the Data Selector 97 Using the File Viewer 98 Choosing a Database Type Sample Data File 98 Using the Metadata Data Selector 98 Data Selections in PlanetPress Workflow Tools 98 Text-Based Data Selections 99 Database Data Selections 99 PDF Data Selections 100 Metadata Selections 100 Data File and Job File 101 Actual Data and Sample
Table of Content External Program 129 Load External File 131 Open XSLT 131 PlanetPress Database 132 Rename 134 Run Script 135 Search and Replace 136 Send Images to Printer 136 Send to Folder 137 Set Job Infos and Variables 138 SOAP Client Plug-in 138 Standard Filter 140 Translator 140 Windows Print Converter 141 Data Splitters 143 About Using Emulations with Splitters 143 Database Splitter 144 Emulated Data Splitter 145 Generic Splitter 146 In-Stream Splitter 148 PDF
Table of Content Overview of the PDF/A and PDF/X Standards 180 PrintShop Mail 181 PlanetPress Capture 182 The 3 steps to a PlanetPress Capture workflow 183 PlanetPress Capture Glossary 183 General Considerations 185 Security Considerations 186 Anoto penDirector 187 Capture Condition 188 Capture Fields Generator 189 Capture Fields Processor 190 Capture PGC Splitter 191 Get Capture Document 192 Metadata Tasks 195 Create Metadata 195 Embed/Extract PlanetPress Suite Metadata 195
Table of Content PlanetPress Suite Workflow Tools and Printshop Mail Documents 218 Triggers 218 Load Balancing 219 Location of Documents and Resources 221 Debugging and Error Handling 223 Debugging your PlanetPress Suite Process 223 Debugging and Emulation changes 224 About Error Handling 225 Using the On Error tab 225 Creating and Using Error Processes 225 Accessing the Logs 226 Resubmit Backed Up Input Files to a Process 226 Knowing What to Resubmit 227 Using Scripts 229 The S
Table of Content Stopping Execution 247 Index ©2010 Objectif Lune Inc 249 - 12 -
Overview Overview This PDF documentation covers version 7.3. 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.
©2010 Objectif Lune Inc - 14 -
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 SNMP Condition Protocol UDP UDP Local Port Remote Port 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. Refer to the Windows documentation for further information. 3.
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.
©2010 Objectif Lune Inc - 20 -
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 etPress 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" (page 169). 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" (page 181).
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 Properties" (page 214). 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" (page 204).
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. The PlanetPress Suite Button. See "The PlanetPress Suite Button" (page 30). The Quick Access Toolbar. See "The Quick Access Toolbar" (page 35). The Ribbon Tabs.
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" (page 61).
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 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 1. Open the configuration you want to use as PlanetPress Suite’s new configuration. 2. Edit the configuration, if required. 3. When the configuration is ready to be used, from the PlanetPress Suite Button, choose Send Configuration, then Send Remote. A list of available PlanetPress Workflow servers on the local network appears. 4. Put a checkmark next to each server where the configuration should be sent. 5. Click OK.
The PlanetPress Suite Workflow Tools Configuration Program Import Documents This procedure describes how to import variable content documents created in PlanetPress Design. Importing documents can be useful when transferring configurations between PlanetPress Suite Workflow Tools installations. To import documents into PlanetPress Suite Workflow Tools: 1. Choose File | Import Documents. The Import PlanetPress Design Document dialog box appears. 2. In the File type box, select the desired file type. 3.
The PlanetPress Suite Workflow Tools Configuration Program codepage 932 is used for Japanese. Exit the PlanetPress Suite Workflow Tools Configuration Program Once you are done using PlanetPress Suite Workflow Tools, you can close the configuration program. It is important to note that closing the PlanetPress Suite Workflow Tools Configuration Program does not stop any of the PlanetPress Suite Workflow Tools services or stop processing.
The PlanetPress Suite Workflow Tools Configuration Program 2. Click on Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon, depending on where you want it. The Quick Access Toolbar buttons cannot be moved or re-ordered. If you wish to re-order them, you will need to remove all the buttons and re-add them in the desired order.
The PlanetPress Suite Workflow Tools Configuration Program l l l l The Debug group contains the debugger's controls, allowing to execute a process step by step, skipping over or ignoring certain tasks, as well as setting up breakpoints and resetting variables values. This group also includes the Send Configuration button, necessary to push the current configuration to the PlanetPress Suite Workflow Tools service.
The PlanetPress Suite Workflow Tools Configuration Program l l Click Tools in the PlanetPress Suite Ribbon. Click Stop Service in the Services Status group. When you stop or pause PlanetPress Suite Workflow Tools, it immediately stops bringing new files into its processes, but it keeps on performing tasks until all the files which are currently under process have been completely processed.
The PlanetPress Suite Workflow Tools Configuration Program l l l Global Variables: Displays a list of variables that are shared between all your processes. Right-click on a Global Variable to access a drop-down menu that offers these choices: l Insert Global Variable: Creates a new global variable l Cut, Copy, Paste: Controls the clipboard. l Delete: Deletes the global variable from the configuration. l Rename: Renames the global variable. l Reset: Resets the global variable to its default value.
The PlanetPress Suite Workflow Tools Configuration Program General tab l l l l l l l l l l l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PlanetPress Suite Workflow Tools. Startup process: Select to make this process a startup process. Self-Replicating Process: Check this if you want the process to replicate itself in the background when multiple input files are received simultaneously.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l Click on any block to select/deselect it. Click and drag from one block to another to toggle all blocks between the two. Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click. To select all of the time segments for a given day or date, click the day or date on the top grid ruler.
The PlanetPress Suite Workflow Tools Configuration Program Changes made to the system time can have adverse effects on the processes managed by PlanetPress Suite Workflow Tools. When changing from daylight saving time to standard time, for example, if PlanetPress Suite Workflow Tools starts a given process at 2:00AM, and if the system time is then taken back to 1:00AM, the application will start a new instance of the same process when the system time reaches 2:00AM for a second time.
The PlanetPress Suite Workflow Tools Configuration Program Local Variables are set at the level of the Process and are not shared with any other process or instance of that process. Local variables can be used anywhere that accepts variables by using it's namee, surrounded by curly brackets and preceded by a percent sign (for example: %{myLocalVariable}). When the process ends, the local variable forgets whatever value was given to it by the process and goes back to its default value.
The PlanetPress Suite Workflow Tools Configuration Program Convert a Branch to a Subprocess To allow for maximum flexibility and backward compatibility with the subprocess feature, the Convert to subprocess option lets users transform existing processes easily. This option is available whenever a Branch task is selected; right-clicking on it will display the contextual menu, which holds the Convert to subprocess option.
The PlanetPress Suite Workflow Tools Configuration Program 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. Click Rename Type in the new name of the variable, then press Enter on your keyboard.
The PlanetPress Suite Workflow Tools Configuration Program l l Description: The description of the document as entered in PlanetPress Design. Last modified: The date and time the document was last uploaded to PlanetPress Workflow Tools. Printer Settings Tab l l l l l l Trigger Type: Select whether you want a normal trigger configuration to be used, or a custom trigger that you manually enter.
The PlanetPress Suite Workflow Tools Configuration Program 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. Double-click on the data file to open the data selector. Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file. Clicking Cancel instead of Ok after viewing will prevent this action from being taken. To save an attached data file to disk: 1.
The PlanetPress Suite Workflow Tools Configuration Program 2. Enter the document’s name. Note that the name you enter must exactly match the actual document name or PlanetPress Suite Workflow Tools will not be able to use it on the printer or remote PlanetPress Suite Workflow Tools server. 3. Click OK. Associate Documents and PlanetPress Watch Printer Queues One of the basic information stored in a PlanetPress Suite Workflow Tools printer queue is the list documents associated with the printer queue.
The PlanetPress Suite Workflow Tools Configuration Program The PlanetPress Suite Workflow Tools Mouse Cursors Normal Mouse Pointer Move Mouse Pointer Copy Mouse Pointer Prohibited Mouse Pointer Moving Configuration Components Moving components using Drag & Drop: l l l Click on the component and hold the mouse button. Move the component to the location where you want to drop it. Let go of the mouse button. Moving components using the clipboard buttons: l l l l l Click on the component you want to move.
The PlanetPress Suite Workflow Tools Configuration Program l l l l Moving a configuration component does not change the order in which the components are used. However they can affect your process if, for example, you move a local variable from one process to another and the local variable is still used in the first process. You can also copy multiple components by selecting more than one then using the methods described above.
The PlanetPress Suite Workflow Tools Configuration Program l l l Down One Level to move the item one level down in the hierarchy. If the item is already the bottom object in the category, or within a group, this command has no effect. To Top Level to move the item to the top level in the hierarchy. This moves the item to the top of the category or to the top of the group. If the item is already the top object in the category, or within a group, this command has no effect.
The PlanetPress Suite Workflow Tools Configuration Program To expand or collapse categories or groups in the Configuration Components Pane: l Click the expand/collapse button to the left of the item. Delete Objects and Groups from the Configuration Components Pane Delete objects and groups from the Configuration Components Pane. To delete a process, document, or printer queue: l Click a process, document, or printer queue, then press DELETE.
The PlanetPress Suite Workflow Tools Configuration Program 1. Open the Plug-in Bar by clicking on its tab. If you can't see the Plug-in Bar tab, click on the View tab in the Ribbon and make sure the Plug-in Bar is highlighted in the Show/Hide section. 2. Locate the task you want to add to your process. You can navigate between the different task categories by clicking the icons at the bottom of the Plug-in Bar. 3. Using your mouse, click and drag the task in your process at the place you want to insert it.
The PlanetPress Suite Workflow Tools Configuration Program insert it before the task instead. The contrary is also true, you cannot replace a branch or condition with a task. When you replace a task, you lose all the properties you set in this task.
The PlanetPress Suite Workflow Tools Configuration Program l l l Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message. ID: Select the error ID you want to attribute to the error log. Reset to defaults: Resets all options in this tab to their default values.
The PlanetPress Suite Workflow Tools Configuration Program and vice-versa. Lastly, you can paste only the properties of the On Error tab of any task or branch on another one. To copy and paste the On Error properties of a task or branch: 1. Copy or cut a task or branch from which you want the On Error properties. 2. Select the task or branch where you want to paste the On Error properties. 3.
The PlanetPress Suite Workflow Tools Configuration Program To disable or enable a task or branch: 1. In the PlanetPress Suite Workflow Tools Process area, click the icon of a task or branch. 2. From the Debug tab in the Ribbon, click Ignore. If the task or branch was enabled, it is now disabled, and vice versa.
The PlanetPress Suite Workflow Tools Configuration Program To remove the highlight, repeat the procedure. Undo a Command The undo command lets you undo most commands performed with the PlanetPress Suite Workflow Tools Configuration program. To undo a command: l From the Quick Access Toolbar, choose Undo. Redo a Command The Redo command can be used to redo commands that were just undone using the Undo command.
The PlanetPress Suite Workflow Tools Configuration Program Note that an Uncategorized category is dynamically created if your PlanetPress Suite Workflow Tools finds any plug-in that would not be part of the existing Plug-in bar. User-defined plug-ins and third party application plug-ins falls into such a category. Settings & Customization The Plug-in bar can be customized according to your needs and the plug-ins you most frequently used.
The PlanetPress Suite Workflow Tools Configuration Program Toggle the Run on Desktop Property Since PlanetPress Suite Workflow Tools configurations are typically meant to run without user interaction, all of their processes are set to run in the background by default. In some cases, such as when a dialog box must appear or user input is required, you may make any process run on your desktop instead of as a service.
The PlanetPress Suite Workflow Tools Configuration Program The Message Area Pane The Messages area is used in Debug mode to indicate the status of your PlanetPress Suite process as the sample data file is processed and used to generate output. When your PlanetPress Suite Workflow Tools runs in Debug mode, the Messages area displays useful processing and error information. Messages are displayed in different colors (debug levels) in the Message area.
The PlanetPress Suite Workflow Tools Configuration Program The Configuration Components Pane, the Object Inspector and the Messages area can each be displayed inside its own window, whether docked or undocked, but they can also be displayed attached or combined inside the same window. l l l When separate areas are displayed simultaneously, they appear in different sections of the Program window.
The PlanetPress Suite Workflow Tools Configuration Program The following procedures will show a number of things you can do to change the way information is displayed by the PlanetPress Suite Workflow Tools Configuration program. To combine areas: l Click either a title bar (separate or attached areas) or a tab (combined areas) displaying the name of the Configuration Components Pane, the Object Inspector or the Messages area and move the mouse pointer.
The PlanetPress Suite Workflow Tools Configuration Program l Double-click the tab of the area you want to take out of the combined area. The area will jump outside of the combined area. To attach areas: 1. Click either a title bar (separate areas) or a tab (combined areas) displaying the name of the Configuration Components Pane, the Object Inspector or the Messages area and move the mouse pointer. As you drag, a rectangle is displayed to show the landing position.
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.
The PlanetPress Suite Workflow Tools Configuration Program 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. As you drag, a rectangle is displayed to show the landing position. Release the mouse button when the rectangle is away from the group. l Double-click the title bar of the area you want to take out. The area will jump outside of the group.
The PlanetPress Suite Workflow Tools Configuration Program 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" (page 18). You can change the appearance of the Run Script and XSLT Editor through the "Editor Options" (page 84) dialog.
The PlanetPress Suite Workflow Tools Configuration Program 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. To change the color of a given element, select it in the list box above and then choose a color from the drop-down list below.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l l l l l l l l l l Document deletion: Select to have PlanetPress Suite Workflow Tools Configuration prompt for confirmation when deleting a document. Group of documents deletion: Select to have PlanetPress Suite Workflow Tools Configuration prompt for confirmation when deleting a group of documents from the Configuration Components Pane.
The PlanetPress Suite Workflow Tools Configuration Program l l 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. This may occur if a non-PlanetPress document will inadvertently have a PP4 or PSI file extension.
The PlanetPress Suite Workflow Tools Configuration Program use the same security context when connected to a NetWare server and they each use one connection. Also note that using erroneous Tree or Context information may cause PlanetPress Suite Workflow Tools and its services to crash. PlanetPress Capture User Options PlanetPress Capture User Options lets you change the PlanetPress Capture options relative to your Workflow server.
The PlanetPress Suite Workflow Tools Configuration Program Less than or equal to: If the mask and database information are both numbers, the mask will either be smaller or equal to the database information. l Greater than or equal to: If the mask and database information are both numbers, the mask will either be larger or equal to the database information. l Contains: The mask is contained within the database information, at any location within the information.
The PlanetPress Suite Workflow Tools Configuration Program Database Considerations (ODBC) On 64-bit operating systems, the ODBC Data Sources created by the Data Source (ODBC) icon in the Administrative Tools will not appear here, as PlanetPress Suite is 32-bit and cannot access the 64-bit data sources. In order to create an ODBC connection visible by PlanetPress, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\odbcad32.exe .
The PlanetPress Suite Workflow Tools Configuration Program Pattern Sequence: The pattern sequence the pen is assigned to. You can double-click this area and edit the pattern sequence as required. l User ID: The name of the user assigned to this pen. You can double-click this area to edit the user ID. This can also be custom information. Bottom Toolbar: l Button: Click to add a new line in the Pen Data List, then edit the information on this new line.
The PlanetPress Suite Workflow Tools Configuration Program l l PlanetPress Capture Pen Licenses group l Import License...: Click to open the Import License dialog. Browse to a PPLIC (PlanetPress License) file on your computer and open it to import the license. The PPLIC overwrites your current license, however it may contain more than one Pen Pack (your previous one and one you just purchased) and will display them individually. l License List: Displays the licenses that have been added to this system.
The PlanetPress Suite Workflow Tools Configuration Program Font Delta Height Defines the tolerance for the difference in average height of fonts in the two target fragments. The higher the number, the more difference in average font heights will be accepted. The average font height is bigger in text written in uppercase than text written in lowercase. At 0, the font size must be exactly the same between two fragments. At 1, a greater variance in font size is accepted. Accepted values range from 0 to 1.
The PlanetPress Suite Workflow Tools Configuration Program l Note that this also affects self-replicating processes, which will not be able to replicate beyond the number of available threads. l Close inactive instances after: If you want the PlanetPress Suite Messenger to close inactive instances of the Alambic after a given number of minutes, enter a value in this box. Enter a value of ”0” if you do not want the PlanetPress Suite Messenger to terminate idle instances of the Alambic.
The PlanetPress Suite Workflow Tools Configuration Program l Resource folder: Type it the path of the folder where your resources are located, or click the Browse button and choose the folder in the browse dialog. Subfolders are accepted in the structre, so if your resource folder contains a folder called faces, you could refer to a file in this folder as href="images/faces/johnsmith.jpg".
The PlanetPress Suite Workflow Tools Configuration Program Data bits: Select the number of data bits defining the incoming data file on this serial port. The data bits transferred through a serial port represent the data content. This excludes the start, parity, and stop bits: these are bits defining the beginning and end of each unit of transferred data, as well as error detection provided by the parity bit. The majority of serial ports use between five and eight data bits.
The PlanetPress Suite Workflow Tools Configuration Program The changes you make to the PlanetPress Fax user options are stored in the PlanetPress Fax configuration file. They will be applied when PlanetPress Fax is started. The available PlanetPress Fax user options are as follows: l l Delete log after: Enter the number of days after which to delete the PlanetPress Fax service log.
The PlanetPress Suite Workflow Tools Configuration Program l l l l information, refer to Captaris RightFax documentation. Activation: Click to enter activation codes for the PlanetPress Image service installed on the same computer as PlanetPress Watch. If you have already activated the PlanetPress Image service from its Control Panel applet, this is reflected when you open the activation dialog box by clicking this button.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l with semi-colons (;). Send to the administrator group l Daily log: Select to send an email to the administrator every day at midnight (according to the local system clock) reporting the daily activity of PlanetPress Image. The log is sent to all addresses you enter in the Administrator’s address(es) text box. l Error Log: Select to send an email that includes the current error log to the administrator when an error occurs.
The PlanetPress Suite Workflow Tools Configuration Program l Enforce global table creation: Select this option, as it ensures that all database users are granted access to the database. This option is available only when you select SQL database in the Database type box. PlanetPress Image 3 or network tab The options in this section are identical to the ones in the "Network User Options" (page 70) section.
The PlanetPress Suite Workflow Tools Configuration Program Print up to: Select the maximum number of files that can be simultaneously sent to print by the LPR output service. Error handling group l Max. retry period: Select the maximum time period, in hours, within which PlanetPress Suite Workflow Tools attempts to dispatch the job using the LPR output before giving up. Note that entering a maximum retry period of 0 hours disables retries altogether.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l l l l l l l l l l Smart tab: Select to use smart tabs. A smart tab advances with reference to the preceding line. It advances to align with the first non-blank character it encounters on the preceding line, from its current position forward. You must clear the Use tab character option to use Smart tabs.
The PlanetPress Suite Workflow Tools Configuration Program Tab stops: Use to set the number of spaces to advance when you enter a tab character or to set a series of tab stops. Enter a single integer to set the number of spaces to advance with each tab. Enter a sequence of two or more integers, each separated by a space, to specify tab stops. The sequence must be in ascending order. Tab stops are measured in number of space characters.
The PlanetPress Suite Workflow Tools Configuration Program l Attributes group l Bold: Select to bold the element highlighted in the Element list box when it is displayed in the Script Editor. l Italic: Select to italicize the element highlighted in the Element list box when it is displayed in the Script Editor. l Underline: Select to underline the element highlighted in the Element list box when it is displayed in the Script Editor.
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 l l the HTTP Input box. PlanetPress does not continue processing after it has found an "Allow" checkmark. There is no concept of "Deny", meaning if any "Allow" permission is given, there is no way to later remove it for certain IPs or IP ranges. Messenger communications (between different part of the PlanetPress Suite) was limited to within the same Class C subnet. This means that PlanetPress Workflow on 192.168.1.
The PlanetPress Suite Workflow Tools Configuration Program To add a new SOAP user l l l l Click on the button. Enter the following information in the Username section for the new entry that was created: l Username: An alphanumerical username for the user. l Password: A password to protect the user. Note that the password will always revert to ******** (8 stars) when clicking outside of this box - that is normal and is meant to protect the length of the password as much as its contents.
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. PDF Viewer The PDF Viewer, introduced in PlanetPress Workflow Tools 7.3 in some areas and expanded for use throughout the configuration tool, displays any PDF used in the configuration or process.
The PlanetPress Suite Workflow Tools Configuration Program The PDF Viewer To open the PDF Viewer: In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer. The top area of the PDF Viewer displays the PDF, while the bottom area contains a few controls: 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.
The PlanetPress Suite Workflow Tools Configuration Program l l Page Selection: Type a page number and hit Enter on your keyboard to jump to that page. Zoom: Click to view a drop-down list of pre-set zoom percentage, or automatic zoom fit options. Or, type in a zoom percentage and hig Enter on your keyboard to set the zoom level. Note that you can also use CTRL+ScrollWheel (on your mouse) to zoom in and out, SHIFT+ScrollWheel to scroll left and right, and ScrollWheel to scroll up and down.
The PlanetPress Suite Workflow Tools Configuration Program 2. Navigate to a location, enter a file name, then click OK. The complete content of the Messages area is saved. Add or Delete Document Instances Update Document Instance to Printers dialog The Update Document dialog lets you update your PlanetPress Design documents on your printers where those documents are used in Printer-Centric mode.
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.
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 only difference between both Data Selectors is that PlanetPress Workflow Tools does not directly support userdefined emulation, as it does not support the PlanetPress Talk language. In the PlanetPress Suite Workflow Tools, you can add data as well as variables to your variables properties using the contextual (right-click) menu. See "Variable Properties" (page 209).
Data in PlanetPress Suite Workflow Tools Text-Based Data Selections These selections are used for text data files such as Line Printer, ASCII and Channel Skip emulations. The selection refers to a rectangular selection that may contain multiple lines, rows, columns on a given page. Syntax @(page number, from line, to line, from column, to column, case option, trim option) Here is a breakdown of the syntax (all options are mandatory): l l l l l l l l @(): Always surrounds a data selection.
Data in PlanetPress Suite Workflow Tools l l Case Option: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent. l LowerCase: Converts all letters to their lowercase equivalent. Trim Option: Can either be "Trim" if you want to trim empty spaces before and after the data selection or "NoTrim" if you want to retain the extra spaces.
Data in PlanetPress Suite Workflow Tools Data File and Job File Whichever source it may come from, a serial port, an e-mail message, or an LPR request, for instance, and whatever its format, data entering a PlanetPress Suite process via an input task is always referred to as a data file. Job file is a more general term, that can refer to data files as well as other types of files traveling through a process. Image files, for example, can be passed from task to task in order to be downloaded to a printer.
Data in PlanetPress Suite Workflow Tools l l For the benefit of users who must identify files, be it in a folder or on a printer queue, consider using names that are as meaningful and precise as possible. Some devices or applications may use file name extensions to know what to do with incoming files. Since variable properties can be entered in the boxes where you specify the folder and file names, you can use variables, data selections and static text.
Task Properties Reference Task Properties Reference This chapter lists all of the possible tasks that are available in the PlanetPress Workflow Tools Configuration program.
©2010 Objectif Lune Inc - 104 -
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.
"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.
Metadata can be manipulated with the Metadata Tasks, see "Metadata Tasks" (page 195). "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.
The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54). Email Input Email input tasks retrieve data through a Microsoft Outlook or POP3 mail client. With Outlook, the email account of the current user on the local computer is used. Note that PlanetPress Suite Workflow Tools must run using the same account as the current user, otherwise the task will fail to retrieve the messages. Emails retrieved using POP3 are deleted from the mail server.
l l Account name: Enter the email account name on the POP3 mail server. This box is only enabled when the Use POP3 mail option is selected. Password: Enter the password required to unlock the selected account on the POP3 mail server. This box is only enabled when the Use POP3 mail option is selected. "Other" Tab l l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task.
Advanced Configuration and Options chapter (Reference Guide, in English only). If you create a Folder Capture input task that takes any file it finds in the root folder of one of your hard disks, then PlanetPress Suite Workflow Tools will try to remove all the files located in that folder, including all the system and hidden files. So when using a Folder Capture, be aware of where you are capturing.
Directory Listing input task property is as follows: General Tab l l l l Input folder: Enter the path of the folder that contains the files you want listed. Sorted by: Select either Name or Modified date, depending on how you want the list top be sorted. File mask: Edit the default filename mask (*.*) if you want only some of the files present in the folder to appear in the list.
"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.
Job Information definitions l %1 - URL address: Contains the full URL that was requested by the task. This includes any GET variables in the URL. On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54). HTTP Server Input HTTP Server input tasks are used to receive HTTP requests made via GET or POST commands and to send replies to the servers from which the requests were made. The HTTP server supports both http and https.
l l l l the process by accessing http://127.0.0.1:8080/MakePDF . This is also what your HTML Form's action should be. MIME Type: Select the MIME type that best suits the files PlanetPress Suite Workflow Tools will be receiving as input. Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the HTTP Server Input task loop through each attachment. Each data file is an XML with the accompanied file.
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" (page 54). Input SOAP The SOAP Input task (or Input Soap) is used to answer calls from a remote SOAP client and to return a response to that request. It is similar in functionality to the HTTP Server Input. SOAP communication is non-trivial and requires a certain understanding of XML and the SOAP protocol.
LPD tasks are configured primarily through user options (see "LPD Input Preferences" (page 78)). The only LDP information you enter in each LPD task is the queue name. When you set up the printer queue on the remote computer, you must specify the IP address of the host computer running PlanetPress Suite Workflow Tools and the name of the remote printer queue. The queue name entered on the remote computer side must match the queue name set in the LPD input task.
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
Note: It is also mandatory to send your configuration to your PlanetPress Suite Workflow Tools service since the PrintShop Web credentials are included in the *.cfg file (See "Send your Configuration" (page 32)), which is updated every time the configuration is sent to the service via the Send configuration button. Telnet Input The Telnet Input Task (also known as the Raw Socket Printing Input) receives files sent to a specific port.
Note that when you add or edit a WinQueue input task, if you select a printer queue that is not currently paused, a message will be displayed prompting to pause the printer. Also note that if the selected queue uses enhanced metafile spooling, a message box will be displayed prompting you to disable this option (PlanetPress Suite Workflow Tools does not support this feature which provides minimal benefits for PostScript printing).
©2010 Objectif Lune Inc - 120 -
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.
The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54). Add/Remove Text Add/Remove Text action tasks can be used to perform the following actions on the data file they receive: l l l To add or remove characters. To add or remove lines of data. To add the content of a text file. Note that the content must be located at the beginning or the end of the data file.
l l l l l l l separated by Line Feed characters). It minimizes memory requirements but may also limit hits, since lines are considered separately. Note that it is not possible to use search expressions that specify multiple data lines 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.
Barcode Scan Supported Image Formats Image formats supported by the Barcode Scan task are: l l l l l Tag Image File Format (TIFF) Portable Document Format (PDF) Joint Photographic Experts Group (JPEG and JPG) Portable Network Graphics (PNG) Bitmap (BMP) Supported Barcode Types The following types of barcodes are supported: Barcode types EAN13 EAN8 UPCA UPCE Code11 Code39 Code93 Code128 Codabar Inter2of5 Add2 Add5 PDF417 Description EAN13 symbology.
l l l l l Force checksum validation: Select to define whether the checksum validation is required for symbologies in which a checksum character is optional. The goal of checksum is to detect accidental modification such as corruption to stored data or errors in a barcode values. By default it is set to false.
The barcode values are stored at the datapage level of the metadata. In the following defintions, the first 2 metadata fields are for standard use, while the next 8 fields contain '_1_' in their name. This number represents the barcode index on the page. If there is more than one barcode on the same page, these metadata fields will be defined as many times as there are barcodes on the page, except that the middle number (..._X_...) will increment according to the barcode index (e.g.
to structure the data before it processes it. Any task that must use a different emulation must be preceded by a Change Emulation action task. All the tasks that follow on the same branch will use the emulation chosen in the Change Emulation task. General Tab l The options of this task are basically the same as the Data Selector in PlanetPress Design. Please refer to the PlanetPress Design User Guide for information on how to use the Data Selector. On Error Tab The On Error Tab is common to all tasks.
l l l l l Grayscale images : l Compression: Auto l Downsampling: Bicubic l Pixels per inch: 300 Color images : l Compression: Auto l Downsampling: Bicubic l Pixels per inch: 150 Security : l Allow printing l Allow changing the document l Allow content copying l Allow form filling Font : l Embed all fonts l Subset embedded fonts Open options : l Zoom factor: Fit in window l Default view: Page only Decompress File(s) Decompress action tasks decompress zipped job files (files compressed as zip files).
Workflow, either on the same server or a different one with PlanetPress Image installed and activated. The properties of the Digital Action Action Task are precisely the same as the PlanetPress Image Connector Task. See "PlanetPress Image" (page 173) to see a list of these properties. Differences between Digital Action and Image tasks: l l l Digital Action is an Action Task and cannot be the last task in a branch or process. Image is an output task, and has to be placed at the end of a process or branch.
As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the "Network Considerations" (page 16) page in the Advanced Configuration and Options chapter (Reference Guide, in English only).
Load External File Load External File Action tasks are used to replace the current job file by the designated text file. Loading an external file does not delete the original file or modify it in any way. Load External File action task properties are as follows: General tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field. On Error Tab The On Error Tab is common to all tasks.
l l l The script editor text box: This is where you enter your XSLT Script that will be used. If you use an external script file, this will display the content of the file (note however that modifying the script in this case does not modify the external file and changes are not saved). Script running from: Choose if the script should be run from the editor text box, or from an external script file.
l l l l l l l Output file emulation: Select the emulation corresponding to the type of output file you want the PlanetPress Database action task to generate. CR-LF replacement: If you want CR-LF (Carriage Return-Line Feed) characters within the data file to be replaced by another character, use this box to indicate which character to use. You may select the replacement character from the list or type your own.
XML for PrintShop Mail: This emulation is specifically for use with merging your data with a PrintShop Mail document, using the PrintShop Mail Action Task (see "PrintShop Mail" (page 181)). No options are offered, as this format is static and should not be modified. Alternate syntax: Select this option if your query uses an alternate syntax. Edit SQL: Click to create and test an advanced SQL query.
The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54). Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" (page 129)). However, they can be slower to execute. The Run Script action task can be used either as an action or a condition.
With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties. The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from wtihin your script. For more information, see On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54).
General tab l l l l l l l l l Scan orientation: Select Side to side for images that will be printed in their original orientation on a portrait oriented page, or in a rotated orientation on a landscape page. Select Top to bottom for images that will be printed in a rotated orientation on a portrait oriented page, or in a rotated orientation on a portrait oriented page.
l l Concatenate files: If this option is selected, when PlanetPress Suite Workflow Tools tries to save a file under a given name, if a file under that same name already exists, instead of overwriting it, PlanetPress Suite Workflow Tools will append the content of the new file to that of the existing file. This appending process will go on until the file is removed from the folder.
In the case of "string" type data, SOAP Client tasks normalize all line endings to a single line feed character. SOAP Client task properties are as follows: 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.
l Default character on translation: You may enter a character to be used to replace all those characters that cannot be found in the source encoding. If you leave this box empty, they will be simply stripped from the data, so you may consider using a space as a place holder for unidentified characters. On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54).
Word distance: Indicates the largest acceptable distance between two text passages, so that they are still recognized as belonging together. This the factor the font's mean character width is multiplied with. The value for the mean character width is taken from the corresponding font's attributes (for texts which are printed justified, it is suggested to raise this value up to about 2).
Line per inch (LPI): The number of lines of text per inch. Data Splitters Splitter action tasks are used to single data files into multiple data files. You can use such tasks, for example, to split files that contain statements for multiple clients into smaller files that each contain a single client statement. Each statement can then be printed and sent by snail mail, or even emailed directly from PlanetPress Suite Workflow Tools, to each individual client.
l l With the ASCII emulation, if the Remove HP PCL Escapes option is selected, the data coming out of the splitter will have no escape sequences. The Goto column option of Channel Skip emulation is not supported. Database Splitter Database Splitter are used to split database files into multiple data files that are passed to subsequent tasks in the process.
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" (page 150) or "Database Splitter" (page 144)) 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.
When condition is found: By default, the task splits the file every time the condition is met (the default value is 1). If you want the task to split the file only when the condition has been met twice, for example, enter the number 2 in this box. CSV Emulation Group l Add header to each output file: This option should only be checked if you are using CSV emulation, and will copy the first line of your data file as the first line of each split file aftewards.
l l l Where to split group l Pages: Enter exactly where to split the file. Enter 1 to split the file 1 page before or after the string, 2 to split the file 2 pages before or after the string, or 0 to split the file immediately before or after the string. l Before or after: In the previous box, you entered exactly where you wanted to split the file, here is where you specify whether you want the split before or after.
l l l l Splitter will consider that the condition is met whenever it finds the string of characters entered in the Value box, even if the database field contains additional characters (“day“ and “days“, for example, would be considered a match). Value: Enter the string of characters to search for as the splitting criteria. Like the Field box, this is also a variable property box.
l splitting process to take place. l Page breaks on form feed: Select if you want to start a new data page whenever a form feed character is found. l Page breaks on a number of lines: Select if you want start a new data page whenever a given number of lines has been counted. Enter the number of lines in the edit box below or use the spin buttons. l Page(s) per output: Select if you want the file generated by the splitter to include multiple data pages.
l l Split PDF file on a word group: Select to split the data file whenever a given region is found within the PDF data file (rather than on based on pages), or whenever the regoin found at a given location changes, and to activate the options from this group, which are used to tailor exactly how you want the region based splitting process to take place. l On region content change: Select if you want the data file to be split when the word found at a given location changes.
This tab lets you choose the splitter settings for default PlanetPress Suite Workflow Tools XSLT engine. If you want to use your own XSLT engine, click the Alternate XSLT Engine tab. l l l l l Split method: Use this box only if you want to edit the standard XSLT script that will be used to split the XML file. First use the Standard XML splitter option to define the standard settings. Then, to change the standard XSLT script, select Advanced XML splitter and edit the script as required.
l l Output file(s): Click to add the {OUTPUTFILE} variable to the command prompt displayed in the box above. Browse button: Click this button and browse to select the XSLT engine you want the XML splitter to use. On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54).
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" (page 101)) 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.
In case of the failure of a Branch task (the branch itself, not the other tasks contained within), by default the process will ignore the branch and simply go down the main trunk. You can overwrite this in the On Error tab. On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54).
Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess. When a process encounters a GoSub action, it halts its own execution, start the subprocess and waits for it to complete before resuming its workflow with the next task. Every subprocess starts with a BeginSub input task and ends with a EndSub output task, both of which have nothing to configure and cannot be replaced or deleted. The simply represents entry and exit points for the subprocess.
Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see "External Program" (page 129)). However, they can be slower to execute. The Run Script action task can be used either as an action or a condition.
Advanced Properties. The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from wtihin your script. For more information, see On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54). 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).
l l To test the presence of a string within the job file. You can, for example, search for the string “Gold member” on the first line of the job file. As another example, you could search for a variable string retrieved via a job info variable or a data selection in a given location in the job file. To compare two strings. As with the test above, this test can also be used to search for a string in a given location. The difference with this test is that it gives you comparison options.
The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54). Time of Day Condition Time of Day conditions test the current time and day. Using a time and day grid, you can select blocks that correspond to time and day coordinates. Various settings can be used to change time intervals, for instance, that range from 15 minutes to 24 hours. You may choose to use days or dates, and you may also select specific weeks or months.
l l l Register Job to the SureTrac Server group: Check this option to enable the group. l Server Name: The complete URL of the SureTrac server. l Process Verification Job Name: The SureTrac job that this PDF should fall under. Use the button next to the list to retrieve a list of available SureTrac jobs from the server. l Mailrun ID: A unique identification for the current job.
l Action Group l Download the document: Simply download the document and do not modify it in SharePoint. l Download the document and mark it as checked out in SharePoint: Download the document and mark it as Checked Out in SharePoint. This is useful for preventing files to be downloaded more than once. l Download the document and delete it from SharePoint: Download the document and delete it from the SharePoint server. Connection Tab l l l l Server Name: The name of the SharePoint server.
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.
LaserFiche Repository Output Task - Configure Templates A Laserfiche template consists of a collection of template fields. Template information can include words, numbers, dates and times, Laserfiche variables as well as any available PlanetPress Suite Workflow Tools variables. Template information makes documents easier to find. Configure Template l l Template: Select from a list of templates imported from Laserfiche. Fields: Set to configure the fields on a by-template basis.
Restrictions l l The column Comments in the Configure Tags interface allows a maximum of 200 characters. If you want to assign an Informational tag, do not select the Security tag option in Laserfiche admin console. Lookup in Microsoft® Excel® Documents The Lookup in Microsoft® Excel® Documents action task is used to complement your job file's metadata by retrieving data from a Microsoft® Excel® spreadsheet on your system.
The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54). Use Cases Use Case 1: Send Personalized Emails with Promotional Document Attached A PlanetPress Design document takes as input a PDF file as the input data file, and reproduces it exactly as it enters. The document also contains a custom data selection set to hold an email address. The data selection's value is given by a Metadata Field called 'Email'.
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. On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54). Notes l l l l l l l l Microsoft Word must be installed on the PlanetPress Suite Workflow Tool system.
l l l l Field Name: Name of the field as set in SharePoint Document Library. Field Information: The information to enter in the SharePoint Document's Metadata for this field. Use PDF/A: Check to use the information contained within an PDF. This PDF must have been created with PlanetPress Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library.
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.
l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to the component that generates fax documents. Some PlanetPress Design features, such as the Time and Date PlanetPress Talk functions, require that this option be selected. Fax Report File Each fax transmission appears as a separate entry in the report file. Each entry has 4 fields: l l l l ID: Unique identifier of the fax transmission as recognized by the Windows Fax service.
the RightFax printer, it cannot run as LocalSystem. Choose an account that has access to the printer and enter the login information and password. Remember that there should be a user with a matching name on the RightFax server. Once this is done, any job that goes through PlanetPress Fax will be sent to the RightFax server and appear in FaxUtil. Links in the Faxing Process For the faxing process to be initiated and completed as required, a number of applications are involved.
©2010 Objectif Lune Inc - 172 -
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.
While the Do not use a document (passthrough) is visible in this list, it is not compatible with the PlanetPress Image output if the PostScript was not generated by merging a design document with data in PlanetPRess Workflow. In order to generate an image in passthrough mode with external PostScript, please use the Digital Action task.
l l name includes a sequence number, such as in Invoice0, Invoice1, Invoice2. If you use file name masks that include dots, such as Statement.%y.@(1,1,1,1,25,KeepCase,Trim) or Job.%f, for example, you must add quotation marks at the beginning and end of the file name (“Statement.%y.%m.@(1,1,1,1,25,KeepCase,Trim)” or ”Job.%f”). Otherwise, when the file is saved, anything appearing after the last dot is replaced by the file’s extension characters (and the file name thus becomes Statement.2005.
l l l shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs. CCITT typically yields the best compression of monochrome images. It is the compression method developed for fax transmissions. Note that configurations that were created with an earlier version of PlanetPress Suite Workflow Tools and that included tasks set not to use any compression will by default be set to use the Flate compression method.
PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files. l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l Allow content copying: Select to let users copy content from the generated PDF files. l Allowform filling: Select to let users enter information in the form fields included in the generated PDF files.
l l Test Connection: Click to verify that PlanetPress Image can connect to the specified database. Enforce global table creation: Select this option, as it ensures that all database users are granted access to the database. This option is available only when you select SQL database in the Database type box. Login tab If you chose Send Email in the General tab, use this tab to choose the appropriate email settings.
l Use document’s Email message text: Select to use the email message identified by the PlanetPress Design document selected in the General tab. This option works the same way as the Use document’s email address(es) option above. If this option is selected and a message was entered in the Message box, both messages will appear in the body of the email.
Name: Value: Each generated XML file has Pdi tags wrapped around its content. This indicates the source of the enclosed XML content is the PlanetPress Suite. These tags wrap around the header information of the XML file.
Basic Features A new option in the PlanetPress Image Output plugin and the Digital Action Action plugin, under the PDF tab, will allow users create their PlanetPress Image PDF using either PDF/X or PDF/A standards. This option will only be available for PDF file outputs. The following standards will be supported: l l l l l l PDF/A-1b:2005 (CMYK) PDF/A-1b:2005 (RGB) PDF/X-1a:2001 PDF/X-1a:2003 PDF/X-3:2002 PDF/X-3:2003 Other notes: l l l Digital Signature is not supported with PDF/X.
Select Produce PostScript to generate a standard PostScript file that can then be sent to any PostScript printer. l Select JPG to generate a JPG image file. l Data file type: Select the data file type that is sent to this task, and used as a database for the PrintShop Mail document. l Distilling options file: Enter the name and path of a distilling options file (or "joboptions" file) or use the Browse button to navigate to that file. This option is only available when PDF is selected in the Output type box.
The 3 steps to a PlanetPress Capture workflow 1. Creating a Capture-Ready document PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently. In order to design a document with Capture Fields, you must review and understand the Critical PlanetPress Capture Implementation Restrictions. This is done when creating your PlanetPress Design document.
Anoto Functionality Statement Statement ('Paper featuring Anoto functionnality') that is automatically placed on the page when a PlanetPress Capture field is present. The statement can also include the Trace Code Anoto Pattern A series of dots placed in a pattern that is unique to each page where the pattern is printed. The Anoto Digital Pen identifies this pattern and its location on the page.
Ink Data The pen stroke information contained within the PGC file. This is the actual data applied to the document (lines, signatures, text, etc). Open Document A document in the Capture Database that does not yet have any ink data on it, or of which not all mandatory fields (or final field) have ink present on them. Such a document is waiting for a new PGC file to complete it so it can be closed. Pattern ID The ID of the Anoto pattern. Represents the pattern on the page.
Database Considerations (ODBC) On 64-bit operating systems, the ODBC Data Sources created by the Data Source (ODBC) icon in the Administrative Tools will not appear here, as PlanetPress Suite is 32-bit and cannot access the 64-bit data sources. In order to create an ODBC connection visible by PlanetPress, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\odbcad32.exe .
Before addressing these concerns, it must be pointed out that these security issues are not introduced by this new technology. In fact, they are essentially the same concerns that arise with plain pen and paper: if the signed document can be scanned, then any markings on the page can be extracted and reused by anyone with even limited technical skills. In addition, the signed document has, by definition, a longer life span than the temporary storage location of the digital pen.
The communication between penDirector and PlanetPress Production is either through a folder transfer or HTTP Post communication. To configure this communication: 1. 2. 3. 4. Open penDirector setup by right-clicking on its icon in the Windows System Tray, and selecting penDispatcher. Double-click on the PlanetPress Capture entry. Change the PGC Storage folder or PGC POST URL settings to your liking. Click OK, then OK again.
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 Document Title: Enter a name for the document that will be saved inside the PlanetPress Capture Database. This name should be unique and recognizable and will be used later to retrieve the document form using the Get Capture Document Action Task. Output Format group l Continue process with optimized postscript (no metadata): The job file coming out of the task will be a PostScript file that can be sent to any postscript printer or saved locally.
tools. The structure of the output metadata added by Capture is the following: l l Document Level l CapCloseDate: Date at which the document was closed by Capture Field Generator. Blank if the document is still open. l CapDocID: The database ID of the document. This field is useful especially if using the Capture API since the ID corresponds to the itembyID function. l CapDocName: The name of the document as specified in the Capture Field Generator.
PGC signature may be compromised. This depends on your country or region's laws, so if your implementation of Capture requires signatures to be authenticated please consult a legal advisor for more details. The Capture PGC Splitter properties are as follows: General tab l Pattern sequence group: Determines what Pattern Sequence will be assigned to each PGC file. l Type: Specify from where the Pattern Sequence should be taken. l None: Do not use a Pattern Sequence.
The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 54).
©2010 Objectif Lune Inc - 194 -
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 information from a PlanetPress Design document. Documents: Select a specific PlanetPress Design document you want all the jobs metadata information generated for.
This task will automatically "loop" through the metadata and repeat its action for each of your metadata's datapage. This task should not within a Metadata Sequencer. Metadata Fields Management task properties are as follows: General tab l l l Action: Select the type of Metadata Field Management action to perform. 5 action types are available: l Add/Replace: Create a new metadata field. If the name already exists, the value is overwritten with the new one. l Duplicate: Create a new metadata field.
l l l The name of the metadata field to add must adhere to thess syntax rules: start with a letter, followed by zero or more letters, numbers, underscore or dash. The name is not case-sensitive. Metadata Fields Management actions on the Page level are not possible since the entire task execution is based on the data page node. The task raises an error if the selected Metadata Fields Management action is Sum and if one of the field values is not numeric.
l l l Filter levels: Rules for unselecting nodes at the Group, Document or Data page level. Note that currently unselected nodes are ignored. l Group: Select the metadata Group nodes (the nodes only) based on the specified rule(s). l Document: Select the metadata Document nodes (the nodes only) based on the specified rule(s). l Datapage: Select the metadata Datapage nodes (the nodes only) based on the specified rule(s). Rules: Define according to which criteria the action must to be performed.
Each chunk created by the Metadata Sequencer Action task is called a "sequence". The properties of each sequence determine how many sequences will occur and what each sequence contains. Metadata Sequencer task properties are as follows: General Tab l l Metadata level: Select the metadata level to process. Sequencing is based on...: l The following number of occurrences of the level: Determine a sequence based on the number of instances found for the metadata level currently processed.
Metadata to PDI The Metadata to PDI Task takes the active metadata and generates a PDI using the information in that metadata. It is generally used in conjunction with a PDF data file and is used to generate the PDI file which is used by PlanetPress Search when building, refreshing or rebuilding its database. Input This task can use any data file, as long as it is accompanied by metadata.
l l Number of virtual pages that appear on each physical page: This is equivalent to the N in N-Up. This number should be equal to the total number of virtual pages in your PlanetPress Design document. For example, a 2 horizontal x 3 vertical is 6-up, so this number should be 6.
l l l Add Condition: Create a new condition at the selected level, using a standard logical operator (AND, OR). Add Sub condition: Indent the selected condition by one level and create a new condition at this level, linked with the selected condtion by a standard logical operator (AND, OR). The purpose of using sub conditions is to explicitely arrange the order on which conditions are evaluated and the way they are nested together. Delete Condition: Delete the selected condition.
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.
FTP Port: Enter the specific port number to use when Use FTP Client default port number is unchecked. Enter a value between 1 and 9999. Note: There is no validation to ensure the port is available. It is the user's responsibility to ensure the selected port is available and not being monitored by another application or PlanetPress Suite Workflow Tools task. User name: Enter an FTP server user name. Password: Enter a password associated with the FTP server user name entered above.
l Add job information to the document: Select to prompt your PlanetPress Suite Workflow Tools to add the available job information elements in the header of the file that will be sent to the selected printer queues. Metadata If no metadata file is found, the from/to page settings from the job and the printer's properties from the task configuration are used, with the job's settings overriding those of the printer where applicable.
l sending jobs to a printer that prints 500 pages a minute, and the second one sending jobs to a smaller printer printing 50 pages a minute, the first queue will receive roughly ten times more pages than the second one. l Round robin: Round robin means that complete jobs will be sent in turn to each one of the selected printer queues. For example, Queue_1 will get the first job, Queue_2 will get the second job, and so forth.
l l l l l Attach: Lists the files that will be attached to the messages sent from PlanetPress Suite Workflow Tools for this task. Selecting the Attach output file(s) option adds these files at the top of the list. Any other file that may have been added using the File box (above) is also listed here. Zip mode: Select how you want the files checked in the Attach box to be zipped. Select Zip individually to have PlanetPress Suite Workflow Tools create a zip file for each file.
General tab l l l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names. As with any variable property box, you can use any combination of text, variables and data selections.
http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l l l l l l l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below. Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found. Method: Choose an available method from this drop-down list.
l l l l Local and Global Variables. See "Manipulate Local Variables" (page 42). Job Infos. See "Job Info Variables" (page 95). Data and Metadata Selections. See "Data Selections in PlanetPress Workflow Tools" (page 98). Printer Control Characters. See "Printer Queue Advanced Properties" (page 213). These are normally only used in printer outputs. Variable properties can also be used in these special locations: l l l l In the Set Job Infos and Variables Action Task.
Unknown Tasks An unknown task is a task location that is not linked to any existing known task. Unknown tasks can have multiple causes: l l l l l Cutting an input or output task will replace it with an unknown task. See Cutting, Copying and Pasting Tasks and Branches Creating a new branch will create an unknown output task in that branch. See Adding Branches Using Branch From Here... will create an unknown output task below that branch.
©2010 Objectif Lune Inc - 212 -
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 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. Select (f) Formatted text to interpret the first character of each line of text as a standard FORTRAN carriage control character.
Printer Queues and Documents l l l 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. Consider using a dynamic name, since if you use a static name every new file will overwrite the previous one. Connection mode group l Active: Select to prompt the ftp client to use the active mode when sending files to the FTP server.
Printer Queues and Documents l l 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. Use the right-click menu for a list of standard printer control characters. PlanetPress Suite Workflow Tools and PlanetPress Design Documents PlanetPress Design lets you send documents to printers as well as to PlanetPress Suite Workflow Tools servers.
Printer Queues and Documents Tools receives the file. All the resource files are stored in a sub-folder from where they are used as needed by the PressTalk Interpreter, and a smaller PTK file, containing only the actual document definition, links to the resources and PPD, is placed in the Documents folder.
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 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. The job file is not modified in any way.
Debugging and Error Handling About Error Handling When your process is running, or during debugging, it may happen that the task that is currently running causes an error, and the task fails. For example, when trying to save to a folder that does not exist, or printing to a printer that cannot be found. When such an error occurs, in most cases you would want to be aware of it and to take certain actions in order to correct or report the error. This is where our error handling features come in handy.
Debugging and Error Handling Accessing the Logs If your process is running live in the PlanetPress Suite Workflow Tools service, you have two ways of seeing what is happening, now or in the past. To view what processes are running and processing data as it happens: l l l In the PlanetPress Suite Ribbon, click on the Tools tab, then select Service Console in the Services group. The PlanetPress Suite Service Console opens.
Debugging and Error Handling go to the Other tab and check the Backup input files option, then type in a unique filename for the backup file (this should be variable). But if, for a given input task, you did select this option and something goes wrong and an original input file is lost or corrupted, you will have the option to use the Resubmit Job command to pull the backed up input file into the process.
Debugging and Error Handling l l The name of the job. This refers to the name used internally by PlanetPress Suite Workflow Tools. This name is generated by the input task using parameters defined within the task. To simplify file identification, you should consider using names that include both the name of the original input file (if any) plus some details such as the current date and time. The number of each failed page.
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" (page 84).
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" (page 232)). 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.
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 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. Return Value l l l l l l GetProcessListResult - Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation.
Using Scripts l l 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" (page 242) Retrieves the content of a numbered job info (%1 to %9). Example Usage: str = Watch.getjobinfo(9) "Watch.GetVariable" (page 243) Retrieves the content of a local or global variable by name. Example Usage: str = Watch.getvariable("Varname") "Watch.ExpandString" (page 244) Retrieves the content of any Workflow string, containing any variable available to Watch, including data selections.
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 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.GetJobInfo(3) Watch.Log("Jobinfo 3's value is: " + s, 2) Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("Jobinfo 3's value is: " .
Using Scripts 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.GetVariable("MyVariable"); Watch.
Using Scripts 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. This function returns a string that is the expanded version of the input string. Syntax Watch.
Using Scripts Level Type Text Color in Service Console 1 Error Red 2 Warning Orange 3 Information Black 4 Debug Grey Arguments Message—A string representing the message that is logged in the log file. Note that the text of the message must use the locale encoding of the system where the PlanetPress Suite software will be running, otherwise it will be unreadable. Level—An integer between 1 and 4, specifying the severity level of the error message.
Using Scripts 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 ©2010 Objectif Lune Inc - 249 -
