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 Server/Service 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 Acti
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 33 Import PrintShop Mail Documents 34 Change the Interface Language 34 Exit the PlanetPress Suite Workflow Tools Configuration Program 34 The Quick Access Toolbar 35 The PlanetPress Suite Ribbon 36 Start and Stop the PlanetPress Sui
Table of Content The Object Inspector Pane 58 Toggle the Run on Desktop Property 59 The Debug Information Pane 59 The Message Area Pane 60 Customizing the Program Window 60 Dock and Undock Areas of the Program Window 60 Show or Hide Areas of the Program Window 61 Combine and Attach Areas 61 Resize the Program Window Areas 65 Preferences 65 General User Options 66 Object Inspector User Options 66 Configuration Components Pane User Options 67 Default Configuration User Options 67
Table of Content Available Standard Variables 90 Data in PlanetPress Suite Workflow Tools 91 Choosing a Sample Data File 91 Use the Data Selector 91 Use the File Viewer 92 Choose a Database Type Sample Data File 92 Using the Metadata Data Selector 92 Data Selections in PlanetPress Workflow Tools 92 Text-Based Data Selections 93 Database Data Selections 93 PDF Data Selections 94 Metadata Selections 94 Data File and Job File 95 Actual Data and Sample Data 95 Job File Names and Out
Table of Content Windows Print Converter Action Task Properties 121 Standard Filter Action Task Properties 122 Translator Action Task Properties 123 PlanetPress Database Action Task Properties 123 XSLT Editor Action Task Properties 126 Send Images to Printer Action Task Properties 127 Send to Folder Action Task Properties 128 Run Script Action Task Properties 128 Microsoft® Word® To PDF Action Task Properties 129 Create MRDX Action Task Properties 131 PrintShop Mail Action Task Properti
Table of Content Printer Queue Output Task Properties 166 Print Using a Windows Driver Output Task Properties 167 SOAP Client Task Properties 169 Send Email Output Task Properties 170 Send to Folder Output Task Properties 172 Output to SharePoint Action Task Properties 172 About PlanetPress Fax 175 PlanetPress Fax Output Task Properties 175 Captaris RightFax Configuration 176 About PlanetPress Image 179 PlanetPress Image Output Task Properties 179 Digital Action Task Properties 185
Table of Content Security Considerations 196 Anoto penDirector 197 Capture Fields Generator Action Task 197 Capture PGC Splitter Task 198 Capture Fields Processor Action Task 199 Get Capture Document Action Task 201 Capture Condition Properties 201 Printer Queues and Documents 203 PlanetPress Suite Workflow Tools Printer Queues 203 Printer Queue Advanced Properties 203 Windows Output Printer Queue Properties 204 LPR Output Printer Queue Properties 204 FTP Output Printer Queue Proper
Table of Content SOAP API - GetSOAPProcessList 228 SOAP API - PostJobInfoStruc 228 SOAP API - SubmitJobInfStruc 229 The Watch Object 229 Watch.ShowMessage 230 Watch.ExecuteExternalProgram 231 Watch.GetJobFileName 232 Watch.GetOriginalFileName 232 Watch.GetMetadataFilename 232 Watch.InputBox 233 Watch.GetJobInfo 234 Watch.SetJobInfo 234 Watch.GetVariable 235 Watch.SetVariable 235 Watch.ExpandString 236 Watch.Log 236 Watch.Sleep 237 Script.
Overview Overview This PDF documentation covers version 7.2. 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 Server/Service PlanetPress Suite does not support Terminal Server (or Terminal Service) environment as possible under Windows 2000, 2003 and 2008.
Getting Started 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:\Users\planetpress\AppData\Local\Temp\ (where planetpress is the user under which Watch is configured) On all systems: l C:\Windows\Temp\ Note: C:\Windows\Temp\ is
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 About Data Data is what drives your business, and our software. We define data as anything that is obtained through an Input Task and used within the process itself. Once the data is obtained, it becomes the job file that is passed from one task to another and generally used to generate output.
Understanding PlanetPress Suite Workflow Tools Emulations in the PlanetPress Workflow Tools: l l l l l l l Line Printer ASCII CSV Channel Skip Database 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 l creates. You can install multiple instances of the PlanetPress Image service on your network, and have PlanetPress Suite Workflow Tools send jobs to one or more of these instances. Each instance of PlanetPress Image can generate PDFs or images and dispatch them from the host on which it runs. See "About PlanetPress Image" (page 179). PlanetPress Fax: Outputs jobs as faxes.
Understanding PlanetPress Suite Workflow Tools l l l Local printing: l Windows output queues let you send jobs to a local printer. See "Windows Output Printer Queue Properties" (page 204). l Send to Folder output queues let you save jobs to a local or network folder from which they can be picked up and printed. See "Send to Folder Printer Queue Properties" (page 206). Remote printing: l FTP output queues let you upload jobs to an FTP site from which they can be picked up and printed.
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 60).
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 Note that if PlanetPress Suite Workflow Tools service is paused when you send a new configuration, it will not stop and restart. Since PlanetPress Suite Workflow Tools service reads its configuration file when it starts up, when you resume processing, PlanetPress Suite Workflow Tools service will continue using the old configuration.
The PlanetPress Suite Workflow Tools Configuration Program 2. In the File type box, select the desired file type. 3. Navigate to the document you want to import, select it and click Open. The document is imported and displayed in the Configuration Components Pane. This physically installs the documents to the Documents folder relative to the install folder of PlanetPress Suite Workflow Tools.
The PlanetPress Suite Workflow Tools Configuration Program l l l l From the PlanetPress Suite Button, choose Exit. Click the X at the top-right corner of the PlanetPress Suite Workflow Tools Configuration Program Press ALT+F4 on your keyboard. Right-click on the PlanetPress Suite Workflow Tools Configuration Program button in your task bar, and select Close. If the default configuration file (ppwatch.
The PlanetPress Suite Workflow Tools Configuration Program The PlanetPress Suite Ribbon The PlanetPress Watch/Office/Production Ribbon replaces the main menu and toolbars of previous versions, and centralizes commands, organizing them into a set of Tabs, each Tab containing Groups of Controls. Each tab on the Ribbon displays the commands that are most relevant to a given feature set. For instance, the Objects tab in PlanetPress Design is used to draw any of the supported objects.
The PlanetPress Suite Workflow Tools Configuration Program l l The Tools tab includes the Managers, Services and Test Page groups. l The Managers group contains: l The Install PostScript Font control allows to install a PostScript font into your PlanetPress Suite installation. l The Virtual Drive Manager control loads the PlanetPress Suite Virtual Drive. l The Access Manager control loads the Access Manager, allowing to grant/remove permissions to hosts.
The PlanetPress Suite Workflow Tools Configuration Program l l Click Tools in the PlanetPress Suite Ribbon. Click Pause in the Services Status group. The PlanetPress Suite Workflow Tools service temporarily stops performing jobs. Note that if you send a new configuration when PlanetPress Suite Workflow Tools is paused, it will continue using the old configuration when you resume processing until you stop and restart it.
The PlanetPress Suite Workflow Tools Configuration Program Group, Ungroup: Triggers grouping functionality. Properties...: Displays the properties, which lets you set a default value for the global variable. Documents: Displays a list of PlanetPress Design and PrintShop Mail Design document that have been imported into PlanetPress Suite Workflow Tools.
The PlanetPress Suite Workflow Tools Configuration Program l l l l A given process may include output tasks that generate files used by input tasks from other processes. When you send a configuration to your PlanetPress Suite Workflow Tool service, all its active processes are applied. Each process’ schedule determines when its initial input task can be performed. Other tasks included in the process are performed regardless of schedule, granted that the previous task was performed.
The PlanetPress Suite Workflow Tools Configuration Program configuration to your PlanetPress Suite Workflow Tools service (see "Send your Configuration" (page 32)). To activate or deactivate a process: l l l Right-click the process in question in the Configuration Components Pane Click Active to disable or enable the process. Send your configuration.
The PlanetPress Suite Workflow Tools Configuration Program 1. Double-click on the global variable in the Configuration Components Pane. (Right-clicking then clicking Properties also works) 2. Enter the new value for your global variable 3. Click OK to save the new value. Shared tasks These procedures can be used on both local and global variables. To delete a variable l Right-click on the variable name in the Configuration Components Area and click Delete.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l example if the maximum number of thread is 10 and you specify 50% here, a maximum of 5 replications will occur (the original process + 4 copies). As soon as possible: Select to have the process run continuously. Clear to enable the Time Grid to fine-tune the schedule of the process. Day(s) to keep backup: Indicate the number of days to keep backups of jobs processed by input tasks.
The 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 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 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. Also stored in the printer queue are the properties of each document associated with the queue. To assign documents to PlanetPress Suite Workflow Tools printer queues: 1.
The PlanetPress Suite Workflow Tools Configuration Program 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. Go to the Home tab of the Ribbon. Click on Cut in the Clipboard group. Click on the new location where you want the component.
The PlanetPress Suite Workflow Tools Configuration Program l l along with a Process and move them together. Also, you cannot select multiple components if they are not in the same group or if one is in a group and the other is not. You can also copy and move groups that have been created in the Configuration Components Pane. Dropping documents onto printer queues does not move the documents, but rather assigns them to these queues (see "PlanetPress Suite Workflow Tools Printer Queues" (page 203)).
The PlanetPress Suite Workflow Tools Configuration Program l l 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. To Bottom Level to move the item to the bottom level in the hierarchy.
The PlanetPress Suite Workflow Tools Configuration Program 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. In the case of processes and printer queues, the object is deleted.
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 81) 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 l l MySQL l Database can be in any location, but performance will depend on the speed of the connection between PlanetPress and the MySQL server. l MySQL's performance has been slower than SQL Server and SQL Server Express during our tests. l By default, MySQL is configured not to allow any SQL request larger than 16 megs.
The PlanetPress Suite Workflow Tools Configuration Program Mask: Enter the text or number to compare with the database information. Search: Click to start the search. Manage documents group l Document list: Displays the results from the search. l Select all: Click to select all the documents in the list. l Select none: Click to deselect all of the documents in the list. l View documents: Click to view all the documents along with any ink already present on them.
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 l Logging options group l Delete log files after: Enter the number of days after which to delete the PlanetPress Suite Messenger service logs. Each log covers a 24-hour period and is kept in the Log folder, which is located in the PlanetPress Suite installation folder. l Verbose log: Select this option if you want the log to contain a maximum amount of information.
The PlanetPress Suite Workflow Tools Configuration Program LPD Input Preferences LPD input preferences control certain functions of the PlanetPress Suite Workflow Tools LPD Server service, which in turn has an impact on LDP input tasks performed by PlanetPress Suite Workflow Tools on a given computer. The LPD Server service receives jobs using TCP/IP from LPD servers. For information on the properties set in individual LDP input tasks, refer to “LPD Input Task Properties”.
The PlanetPress Suite Workflow Tools Configuration Program Parity: Select the type of parity used for error detection. The parity transfers through the serial connection as a single bit. It is used to verify that each set of data bits transfers correctly. It is then stripped away before the data file passes through the rest of the PlanetPress Suite Workflow Tools process. Select None to ignore all parity bits; no error detection occurs.
The PlanetPress Suite Workflow Tools Configuration Program l computer that actually performs the PlanetPress Fax output tasks). Fax service: Select the faxing program to which PlanetPress Fax sends its documents for faxing. Each faxing program has its own options and changing this option also changes the options below to reflect the following: WinFax Pro option l Dialing format: Select how you want PlanetPress Fax to read the fax number in the data selection and send it to WinFax PRO.
The PlanetPress Suite Workflow Tools Configuration Program l l About: Click to display an About dialog box for PlanetPress Fax. This dialog box contains information such as the version number, whether the software is activated or the number of days remaining in the trial. Select Language: Click to select a different interface language for the PlanetPress Fax Configuration applet.
The PlanetPress Suite Workflow Tools Configuration Program Error Log: Select to send an email that includes the current error log to the administrator when an error occurs. The error log is sent to all addresses you enter in the Administrator’s address(es) text box. l Error file: When enabled, sends an e-mail with an attachment of the offending file when an error occurs in the PlanetPress Image output task.
The PlanetPress Suite Workflow Tools Configuration Program PlanetPress Image 4 or login tab l l Use Microsoft Outlook: Select to use Microsoft Outlook on the host computer running PlanetPress Image to send the error messages to the administrators. The host computer must be running Outlook, and PlanetPress Suite Workflow Tools must have access to Outlook. Outgoing emails appear in the outbox of Outlook, and is sent whenever Outlook is set to send email.
The PlanetPress Suite Workflow Tools Configuration Program Retry interval: Select the interval, in seconds, at which time PlanetPress Suite Workflow Tools attempts to dispatch the job using the LPR output. This takes place only within the Max. retry period, after which the attempt ends. l Keep a backup when error occurs: Select to move the job file to a local folder relative to your install folder called pplpr\error in the case of an error.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l l l l l l l l advance one indentation level to enter the body of the for loop, then press BACKSPACE to enter the end for statement. You must select Auto indent mode to use this option. Cursor through tabs: Select to move one by one through the spaces of tabs using the left or right arrow keys. Clear to have the arrow keys treat the tab as a single character. You must select Use tab character to use this option.
The PlanetPress Suite Workflow Tools Configuration Program l l Display l Display options group l Editor font: Use to select the font the Editor uses to display the program code. Select the Use monospace fonts only option to restrict the fonts available to fixed width fonts. A preview of the selected font, at the selected Size, appears in the Sample box. l Size: Use to select the font size the Editor uses to display the program code.
The PlanetPress Suite Workflow Tools Configuration Program l Underline: Select to underline the element highlighted in the Element list box when it is displayed in the Script Editor. Advanced SQL Statement dialog The Advanced SQL Statement dialog is available by clicking the Edit SQL button from the Database Action Task. You can enter a custom SQL query in this dialog, using the language supported by the database you select in the Database Action Task.
The PlanetPress Suite Workflow Tools Configuration Program To open the Access Manager l l Open PlanetPress Design or PlanetPress Workflow Configuration Tool. In the Ribbon, go in Tools | Managers | Access Manager. The Access Manager dialog box is displayed. It lists all IP and IP ranges that have PlanetPress Design, PlanetPress Suite Workflow Tools, PlanetPress Fax or PlanetPress Image installed in the same network.
The PlanetPress Suite Workflow Tools Configuration Program In order for the changes made here to be effective, you will need to restart the PlanetPress Messenger service. This can be done via the PlanetPress Suite Service Console. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each username entered in this dialog can have access to one or more processes. To add a new SOAP user l l Click on the button.
The PlanetPress Suite Workflow Tools Configuration Program l l Define the permissions for the user (see below). Click OK to save the changes. To define or change the permissions for a SOAP User The Permissions section of the SOAP tab displays all of the processes that are available in the live configuration (the one that the PlanetPress service uses). To change or define the permissions: l l l l l In the top Username section, click on the username of which to modify permissions.
The PlanetPress Suite Workflow Tools Configuration Program 2. Select the images you want to delete. 3. Press the Delete key.
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 187).
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 - 98 -
Input Tasks Input tasks are entrances to PlanetPress Suite Workflow Tools. They are used to take data from specific locations and to pass it on to other tasks included in the same process. 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 (see "Initial and Secondary Input Tasks" (page 100)).
"Other" Tab l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder.
l l 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. On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 53).
"Other" Tab l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder.
l l l l l l l l l Folder: Enter the full path of the folder from which the input files are to be taken. Masks: Enter a single or multiple file names or use file name masks. See "Masks" (page 188). Since this task only supports PDF files, make sure your extension remains .PDF for all your masks. Sort files by: Select a given sorting method to prompt PlanetPress Suite Workflow Tools to sort the files in the source folder before taking them (and thus to take them in a specific order).
If you use Email input tasks to capture data encoded using a Double-Byte character set (such as those used for Japanese or Chinese, for instance), it is preferable to use attachments rather than the email body to carry the data from its source to the input task, as data corruption is less likely to occur using this method. Email input task properties are as follows: General tab l l l l l Message body: Select to use the data found in the body of the email.
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. On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 53).
"Other" Tab l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder.
l After you have created this queue, on every remote computer that will be sending data files to PlanetPress Suite Workflow Tools you will need to create a printer queue connecting to the PlanetPress Suite Workflow Tools queue. To ensure that the spooled files created by the PlanetPress Suite Workflow Tools queue remain in the spool folder, PlanetPress Suite Workflow Tools requires that the queue be paused.
l l The time that it takes to generate the response is important - most browsers will time out after a while if they do not receive an answer. For this reason, make sure your process is as optimized as possible, even if this means doing further work through another process (like book keeping, archiving or printing). You can set the HTTP Server timeout value through the "HTTP Server Input User Options" (page 74).
General tab l LPD queue name: Enter the queue name specified in the printer queue on the remote computer or computers. "Other" Tab 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.
A PrintShop Web Connect preferences page, accessible via the PlanetPress Suite Button | Preferences | PrintShop Web Connect, allows to provide operator credentials to your PlanetPress Suite configuration. It is mandatory to fill both username and password fields (with the values of an existing user on the PrintShop Web server) in order to use the PrintShop Web Connect Input task.
On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 53). SOAP Input Task Properties 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.
©2010 Objectif Lune Inc - 112 -
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 53). Add/Remove Text Action Properties 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 Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies. List of words to find and replace: Lists each string to find, and its replacement. These are executed in order, from top to bottom. l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these.
l l l Whole word only: Select force the plugin to search only for strings that match the search string from beginning to end (cannot be used with regular expressions). If this option is selected, “DAY” and “DAYS” will not be considered as matching strings. Position options group: Specify the location where the string must be found using this group. Note that this whole group is disabled when the Treat as regular expression option is selected.
l l Run mode group l Printer centric: Select to send the document along with the trigger and data to PlanetPress Image. l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PlanetPress Image. Note that some features, such as the Time and Date PlanetPress Talk functions, require that this option be selected.
l l l l l l l Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Output folder: Enter the name of the folder in which you want the decompressed files to be stored. File mask: Enter a file name mask to specify which files must be decompressed. Leave the default value of *.* to decompress all the files found within the zip.
General tab l l l l Executable file: Enter the name and path of an executable file (exe or com extension), batch file (bat extension), or command script (cmd extension) that can run in command mode. Note that the program will be run without user interaction. Although it may display progress information, it is better if the application has no user interface. Parameters: Enter parameters that will be passed to the external program when it is launched.
Load External File Action Properties 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.
Windows Print Converter Action Task Properties Windows Print Converter action tasks are designed to convert Windows print files into Line Printer files, that can then be used in a variety of other PlanetPress Suite Workflow Tools tasks. Typically, Windows Print Converter action tasks are located below WinQueue input tasks (note that the latter include options specific to Windows Print Converter action tasks).
about 2). For example, if the mean character width of the font example shown here corresponds to the width of the blank character (for other fonts it may be another sign). There is another text passage found whose horizontal distance is even bigger than the first one's mean character width, multiplied by factor 1.0. The two text passages are found to not belong together.
Standard Filter action task properties are as follows: General tab l l Process job using ASCII emulation: Select to use the ASCII emulation to process the job file. This reverses LFCR end-of-line sequences that may result in unwanted double-spacing. Remove and convert HP escape characters: Select to filter HP escape character sequences from the job file. On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 53).
including JET 4.0. When adding a PlanetPress Database action task, you have two options: l l You can use static properties (properties that will remain the same regardless of the data processed at runtime). This option lets you use an Open DataBase Connectivity (ODCB) compliant data source. You can also edit the SQL statement that assembles the database table.
CSV Emulation: If you selected CSV in the Output file emulation box, the following options are available: l Sort on field: If you want the table to be sorted before the data page creation process is started, select the sort field from this box. l Text delimiter: Select the text delimiter to be used in the generated file. l Field separator: Select the field separator to be used in the generated file.
l Export Config: Click to export the currently displayed properties of the PlanetPress Suite Workflow Tools action task. The exported configuration can then be reused on other PlanetPress Suite Workflow Tools workstations. Dynamic SQL tab l Use dynamic values at runtime: Select to use a dynamic database connection string and/or SQL statement at runtime. Check this box to enable the options included in this group (this disables the corresponding options in the General tab).
l l l XSLT Version l XSLT 1.0: Select if you will be entering or pasting XSLT version 1.0 code. l XSLT 2.0: Select if you will be entering or pasting XSLT version 2.0 code. Tools l Editor Options...: Opens the "Editor Options" (page 81). Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l l l The script editor text box: This is where you enter your XSLT Script that will be used.
l l l Refresh: Click to prompt PlanetPress Suite Workflow Tools to look again for available printers and computers. Hard disk name and path: You may enter the name and path of the hard disk to which you want to send the images. Needless to say that this option is used if the device to which you are sending the images has multiple hard drives. Print confirmation page: Select to print a confirmation page on each one of the selected printers after an image has been successfully received.
l File l l l l Import: Lets you open an existing script from an external file. This file can be in .vbs, .js, .pl or .py for language-specific scripts, or .txt for any of them. Export: Lets you save the current script as a file. Print: Prints the current script. Edit Undo: Undo the last edit. Cut: Cut the current selection (only available if there is selected text in the editor). l Copy: Copy the current selection (only available if there is selected text in the editor).
Microsoft® Word® needs to be installed for this task to be functional and to test the connection. General tab l l Microsoft Word Document: Enter a Microsoft® Word® document or template, or click the browse button to navigate to the location of the document. The supported extensions are: *.doc, *.docx, *.dot and *.dotx. Perform Mail Merge: Check when providing a Microsoft® Word® document or template configured for mail merge.
l If the database is the same for 2 processes, one of two processes aborts. Each process has to use different databases, or no more than one process with a Microsoft® Word® to PDF task. Create MRDX Action Task Properties The Create MRDX action task is used to register a job on a Suretrac server using an MRDX file. The MRDX contains information about the job and its finishing, as well as integrity features use by SureTrac.
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.
Process Logic Tasks Process Logic tasks include conditions, branches and loops. They can be used to control the flow of the data within your process either consistently or depending on certain information obtained from multiple sources. Conditions are used to create a path in your process that will either execute one branch or continue down the main trunk. The result can depend on data within your job file, external data, variables or even the result of an external script.
l secondary branch includes a secondary input task or a Change Emulation action task, then the last emulation selected in the secondary branch will be the one used for the main branch. Backup local variables: Select if you want PlanetPress Suite Workflow Tools to use identical copies of the local variables for the main and secondary branches. When this option is not selected, the local variables that reaches the output task located at the end of the secondary branch is used for the main branch.
l l File name mask: Enter one filename mask. See Masks. The condition will be tested True only in the case of an exact match, so consider using wildcard characters. Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). On Error Tab The On Error Tab is common to all tasks. Details can be found on "Task Properties Dialog" (page 53). File Size Condition Properties File Size conditions test the size of the job file they receive.
IP address: Enter the IP address of the network printer (or other device) whose status is to be checked via SNMP. l Get info: Click to retrieve information corresponding to the IP address you entered. If the information is successfully retrieved and it corresponds to a printer, the Host name and Description of the printer (or other device) appears in the corresponding boxes.
l 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. Using the “Contains” operator, you can test the presence of the string “Gold member” at a given location in the job file (using a data selection), but the other operators can be used to test whether or not the first string is equal to the second one, whether it is equal or lower than the second one, etc.
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 l l In-Stream Splitter action tasks are used to split non-emulated data. Emulated Data Splitter action tasks are used to split all types of emulated data, with the exception of XML and database data. XML Splitter action tasks are used to split XML data files. Database Splitter action tasks are used to split database files. PDF Splitter action tasks are used to split PDF files. In previous versions of PlanetPress Suite Workflow Tools, only a single splitter, the Generic Splitter, was available.
Database Splitter action task properties are as follows: General tab l l l l l l l l l l l l l l l l Split group: Use this group to indicate how you want the file to be split. Field value change: Select if you want the file to be split based on changes in the values of a selected database field (the value in the ClientID field changes, for example).
Using an emulation to format the data before splitting provides the most splitting options, but slows down the process. Splitting a data file containing a few hundred thousand pages may take several hours. So you may choose to use non-emulated data to speed up the splitting process (see "In-Stream Splitter Action Task Properties" (page 142)).
In-Stream Splitter Action Task Properties In-Stream Splitter action tasks are used to split non-emulated data files into multiple data files that are passed to subsequent tasks in the process. Note that performing the splitting process on raw, non-emulated data speeds up the splitting process.
PDF Splitter action task properties are as follows: General Tab l l l Split on page group: Select to split the data file based on pages (rather than on a word found within the PDF data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place. l Page(s) per output: Enter the number of pages to include in the file generated by the splitter in this edit box below or use the spin buttons.
XML Splitter Action Task Properties XML Splitter action tasks use the XSLT language to split XML data files into multiple XML data files that are passed to subsequent tasks in the process. The XML splitter includes options to add a new root node within the generated files, as well as to change the original file’s encoding to UTF8. Note that the XML Splitter cannot process files larger than 30 megabytes.
l l l l l l Use alternate XSLT engine group: Select this option to enable the box and the buttons included in this group. Path and parameters for the alternate engine: Enter your XSLT engine’s absolute path (use quotes for non DOS 8.3 compliant paths) followed by its required operators and parameters (you must know exactly which operators and parameters your XSLT engine requires and in which order they must appear in the command prompt used to launch the engine).
l l l l Word is between columns group l From and To: Enter a horizontal search region defined as starting from a given column and ending at a given column. If you enter 1 in the From box and 5 in the To box, the Generic Splitter will search for the string of characters only in the first five column (five first characters of every line selected above).
l l l l l l Field: Enter the name of the field that the Generic Splitter must check (only alphanumeric fields can be used—selecting a binary field, for instance, will cause the job to fail). If you enter “ID”, for example, the Generic Splitter will only look in the field named “ID” for the value entered below. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. Operator: Select the appropriate comparison operator.
Loop Action Task Properties Loop action tasks are used to repeat those tasks that are located after it on a given process branch. The number of repeats can be fixed or variable, as required. Loop action task properties are as follows: General tab l l l l Number of iterations: The number of times the loop should be repeated. Every task after the Loop Action Task will be repeated this number of times. The number may be static, or use a variables (see "Variable Properties" (page 187)).
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. While it is possible to place a GoSub action within a subprocess, doing so will hide the subprocess from any GoSub action, in order to avoid circular referencing (aka an infinite loop).
©2010 Objectif Lune Inc - 150 -
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.
Barcode orientations represent a barcode orientation on an image. For example, when the left-to-right option is checked, the task will try to read the barcode value assuming that the barcode data should be read in a left-to-right fashion. The fewer orientations are selected, the faster the task performs. Settings 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.
Note: If metadata was created previously in the process, the task only adds new fields to the existing metadata at the datapage level. Metadata Fields The barcode values are stored at the datapage level of the metadata. In the following defintions, the first 2 metadata fields are for standard use, while the next 8 fields contain '_1_' in their name. This number represents the barcode index on the page.
Create Metadata Action Task Properties 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. To create Metadata without using a PlanetPress Design document, choose none. When this option is selected, the plugin creates a metadata file based on the current process's default emulation. It creates a single Group with a Single Document.
l l l Excel group l Excel workbook: The full path and filename of a Microsoft® Excel® workbook (.xls or .xslx file). You can use the Browse button on the right to browse to the file on your computer. l Excel worksheet: The name of the worksheet you want to use. Once a workbook is open, this drop-down will automatically list all the available worksheets. l Refresh button: If you have modified the original Microsoft® Excel® workbook to add a sheet, click this button to refresh the list of worksheets.
corresponding ItemDesc metadata fields. The Lookup in Microsoft® Excel® Documents Action task updates the value of all 'ItemDesc' metadata fields with their corresponding foreign language descriptions. Metadata Fields Management Task Properties The Metadata Fields Management task can be used to add new fields into your metadata, either for every element or through conditions. This task will automatically "loop" through the metadata and repeat its action for each of your metadata's datapage.
For a given Metadata Field Management action, all nodes of a given level might be updated with a new Field Value. To accommodate this, metadata/data selection functions have been modified to accept a wild card parameter "?", indicating the function operates on all nodes (not just one) of a given level. For example, in a PDF emulation, the format of a selected region is: region(?,0.59375,2.21875,1.85416,2.51041,KeepCase,NoTrim) where “?” represents the current physical data page processed by the task.
The task enables users to merge data pages into Documents and/or merge Documents into Groups, based on conditions. Unselected Data pages are ignored, but are moved with others Data pages if the action is applied to the current parent node. Metadata Level Creation task properties are as follows: General Tab l l Document: Create a new Document level. Note: Attributes and Fields are deleted for all new Document levels created as well as existing Groups. Group: Create a new Group level.
General Tab l l l Group: Sorts the metadata by group. Document: Sorts the metadata by document. Data page: Sorts the metadata by data page. For each parameter, three columns are available: Sort By, Then by, Then by (again). This lets you sort your document level in three different orders sequentially. Sorts are always done from left to right, top to bottom, giving you a total of 9 sorting possibilities.
Rule Interface The Rule Interface can be opened from the Condition column of the following tasks: l l l l l "Metadata Fields Management Task Properties" (page 156) "Metadata Filter Action Task Properties" (page 157) "Metadata Level Creation Action Task Properties" (page 157) "Metadata Sequencer Action Task Properties" (page 158) Input from SharePoint Task Properties Conditions are expressed using the following syntax: The and options r
As an example, consider the following conditional expression, where A, B, C and D are conditions of the form : A and (B or C) and D Such a conditional expression can be expressed by means of sub conditions in the following way: 1. 2. 3. 4. Define condition A. Select condition A and choose Add Condition. Specify the logical operator AND. Define condition B. Select condition B and choose Add Sub Condition. This will indent condition B and allow to define the condition C.
©2010 Objectif Lune Inc - 162 -
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.
l l l l l 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. Directory: Enter the directory to which the job files are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server.
l l If the PlanetPress Image archive folder field is empty and the option “Use PlanetPress PDF/A” is selected, a warning message will be displayed: "You should insert PlanetPress Image archive folder source". The indexes in the PlanetPress Design document must match the ones in the Laserfiche server. Connection Tab l l l l l Server Name: The server name or IP address of the server you wish to connect to. Repository: The name of the repository you wish to send the files to.
If “Use PlanetPress Index file (PDI)” is disabled, the corresponding field is not configured to be multiple on the Laserfiche server. Users should check the multiple option on the Laserfiche server in order to use the PlanetPress index fields. Alternatively, right-clicking inside the field allows to select a PlanetPress Suite Workflow Tools variable. Note: The most important property of a template field is the type of data that it will contain.
l l Queues: Select the queues to which you want to send the output. Documents: Select None if you want the data to print as is. Select a specific PlanetPress Design document if you want all the jobs to be printed with that document. To use a document chosen at runtime for each job, enter a dynamic document name using a combination of text, variables and data selections. To enable the dynamic document name box, click inside it. To disable it, press Enter.
This type of output task does not support PDF transparency and duotone features, so you should not use it with PlanetPress Design documents that use those features. Print using a Windows driver output task properties are as follows: General Tab l l l l Printer queue: Select the queues to which you want to send the output. Note that this is a variable property box, so you can use various schemes to use printer queue names that change with each job at runtime.
get the file and then switch back to a secure connection). This lets you know which services the SOAP server provides, as well as each service’s methods and namespaces. If firewalls control communication between the SOAP client and the Web servers, they must be configured so as not to block client-server communication. For more on SOAP, including the new SOAP API and SOAP Server, refer to the PlanetPress Workflow Tool Reference Guide.
l l l l l l As script: Click to apply the options you chose above and to display information on the chosen Web service in JavaScript format in a script viewer. You should use this option if the Web service is too complex to be interpreted correctly by the SOAP Client plugin. Name: Displays the name of the arguments associated with the selected method. Note that you may also manually enter new arguments, change or delete existing ones, as well as change their order if needed.
HTML code is entered or pasted in this box, percent (%) and backslash (/) HTML characters must be doubled otherwise they will be disregarded. Attachments tab Use this tab to add the files received by this task (plus any other file that you may choose to attach) to the emails sent by PlanetPress Suite Workflow Tools. l l l l l l l Attach input job files: Select to attach the file received by this task to the emails it will generate.
Send to Folder Output Task Properties Send to Folder output tasks send the files they receive to a local folder. They perform the same function as Send to Folder action tasks, with the only difference being that in this case, the PlanetPress Suite Workflow Tools will not wait for the task to be completed before going on to the next task in the configuration. The following describes the properties specific to Send to Folder output tasks.
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.
©2010 Objectif Lune Inc - 174 -
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 - 178 -
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 l l l l l l l l l l l l Run mode group l Printer centric: Select to send the document along with the trigger and data to PlanetPress Image.
l 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.pdf instead of Statement.2005.255842.pdf, or Job.tif instead of Job.544872.tif).
compression method. Monochrome resolution: Select the resolution to use for monochrome images. Grayscale images group l Grayscale compression: Select the compression to use for the grayscale images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs.
Allow content copying: Select to let users copy content from the generated PDF files. Allowform filling: Select to let users enter information in the form fields included in the generated PDF files. Font group l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used.
l l l l l l l l To: Enter the email address(es) of the recipient(s). Remember this is a variable property box and you can therefore use various schemes to use email addresses that change with each job at runtime. Use document’s Email address: Select to send emails generated by PlanetPress Image to email addresses identified by the PlanetPress Design document selected in the General tab. In PlanetPress Design, you can tag a data selection as being an email address.
Digital Action Task Properties Digital Action action tasks use PlanetPress Image to generate the same types of documents generated by PlanetPress Image output tasks. Since Digital Action tasks are not output tasks, the documents they create are typically passed on to the following task. The image files they generate are always saved, along with their index files (if any), to an archive folder.
Name: Value: The name, minus the file name extension, of this XML file (and its corresponding Digital Action output file). You set this name in PlanetPress Suite Workflow Tools when you configure the Digital Action action task. The time the Digital Action action task created this XML file, expressed as hours:minutes:seconds. The day the Digital Action action task created this XML file, expressed as year/month/day.
l l l l 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. Encryption is not supported with PDF/A and PDF/X. Because of mandatory font embedding with these standards, all fonts must be available locally; otherwise creation of either PDF/X or PDF/A will fail. Variable Properties When you edit tasks, you may notice that some of the properties that you can modify have a red (or more precisely, a maroon) title.
Global Variables: Contains a list of global variables in this configuration. If no global variables exist, this item is disabled. Control Characters: Contains a list of control characters that can be used in printers. Get Data Value: Brings up the Data Selector, retrieves the value you select and places it in the variable properties box. This information becomes static and does not change between each datapage and job file. Get Data Location: Brings up the Data Selector and records your selection.
l l Date are entered and displayed as yyyy/MM/dd (2007/06/13, for example). Times are entered and displayed using the 24 hour format as HH:mm:ss (3:38:54 PM, for example, is entered and displayed as 15:38:54).
©2010 Objectif Lune Inc - 190 -
PlanetPress Capture PlanetPress Capture PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Production. It is not available in older versions nor is it available in PlanetPress Office and PlanetPress Watch. PlanetPress Capture is a set of tools available in PlanetPress Suite Production that enable output and input for interaction with an Anoto Digital Pen.
PlanetPress Capture "Anoto" and the Anoto logotype are trademarks owned by Anoto AB. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011. PlanetPress Capture Glossary This topic describes the specific terms used in the PlanetPress Capture set of tools within PlanetPress Suite.
PlanetPress Capture Capture Fields Processor PlanetPress Production task that reads an incoming PGC file and updates each document in the Capture Database. If ink is present in all the proper Mandatory and/or Final fields, the document is then closed by this task. This tasks outputs the PGC file along with metadata that contains all of the document's information and Capture Fields.
PlanetPress Capture in the database. Signing a document with a pen of which the Pattern Sequence does not match that of the document causes Contamination, which can cause errors or ink to be placed on the wrong document. Pen ID The serial number of the Anoto Digital Pen. It is registered in the PlanetPress Capture database and is present in each PGC file. PGC File Pen Generated Coordinates; PGC File containing all ink processed while the pen was undocked along with the Pen ID.
PlanetPress Capture patterns to be unreadable. Since the ink itself must be pure black it is also important not to use any ink saving technology when printing. Printing Speeds When generating print jobs that include patterns, a gradually slower printing speed is to be expected. Though your results may vary, tests have shown around 100 pagers per minute for the first thousand pages, around 60 ppm for the following 1000, etc.
PlanetPress Capture l In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue. Security Considerations PlanetPress Capture introduces new and efficient methods for digitally capturing the contents of ink layed out on physical paper. However, because of its nature, some end users may voice concerns about security and privacy.
PlanetPress Capture security for Capture files and documents as you would the rest of your sensitive information. In most cases, the procedures in place are enough for this purpose. Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc. The penDirector creates a bridge between the Anoto Digital Pen and a PlanetPress Capture workflow in PlanetPress Production.
PlanetPress Capture occur. This is to ensure that if such an error occurs most of your document sequences will get generated and you will not have to start the job over from the beginning. Processing The Capture Fields Generator Action Task uses an existing PlanetPress Design document containing Capture Fields and assigns a unique Capture Pattern to each printed page. The task then locks each pattern that it used so it cannot be reassigned to any other document.
PlanetPress Capture Note that using the Capture PGC Splitter will cause your process to take more time, since each PGC must pass through the Capture Fields Processor and then the Get Capture Document task. Due to the fact that the Capture PGC Splitter Task modifies the original PGC, in some cases the legality of the PGC signature may be compromised.
PlanetPress Capture If the Capture Fields Processor receives any error during the processing of any document in the PGC file, all of its actions will be reverted. If your PGC file contains multiple documents, even those documents that were processed before will revert. It is strongly suggested to backup your PGC file before using this task and to create an error handling process to capture these errors.
PlanetPress Capture "Anoto" and the Anoto logotype are trademarks owned by Anoto AB. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011. Get Capture Document Action Task The Get Capture Document action task is used after the Capture Field Processor to retrieve all documents that have been updated.
PlanetPress Capture l l l l l l Document based condition: Select this to base the condition on the state of the document l Document is open: Condition will be true if the document is open (not all Capture fields are filled). l Document is closed: Condition will be true if the document is closed (all relevant Capture Fields are filled). Capture Field based condition: Select to base the condition on the state of one or more fields of your document.
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 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). PlanetPress Suite Workflow Tools adds the trigger code automatically, but you may want to use custom triggers. You would do this, for example, to use special printer functions.
Printer Queues and Documents Lune Printer Driver being downloaded to the connecting host. Printer Properties setup The PlanetPress Suite Workflow Tools WinQueue Input task can be configured to set a Windows printer queue using Objectif Lune Printer Driver (PS) to produce one of 3 different types of datafiles: EMF, PostScript, or PDF. Note that PlanetPress Watch can only produce EMF or PostScript files.
Printer Queues and Documents 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.4 Optimized PDF (subject to change) No down-sampling of images These settings are pre-configured and cannot be changed by the user.
Printer Queues and Documents l 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 PlanetPress Suite Processes Debugging PlanetPress Suite Processes Debug PlanetPress Suite Workflow Tools processes to correct errors and increase efficiency. You can also configure tasks and make data selections on the fly when you Debug PlanetPress Suite Workflow Tools processes. The debugging features in PlanetPress Suite Workflow Tools Configuration let you debug your processes and fine tune its tasks.
Debugging PlanetPress Suite Processes l l l l l l Click on View Metadata to open the data selector and see the current state of the process' Metadata. Click on View as Hex to view the current job file in the internal Hex editor. Click on the Stop button to stop the debugging process. If you use Run, Step or Skip after stopping the process, debugging starts over from the top. Use the Set Breakpoint button to tag the currently selected task, branch or condition as a breakpoint.
Debugging PlanetPress Suite Processes A) The PlanetPress Suite Workflow Tools services monitored by the PlanetPress Suite Service Console. B) The runtime information provided by the console. The log window only displays the 1000 most recent lines. Older lines are hidden as new ones appear to replace them. To view the log messages generated by a service: l Click the service in question in Services pane, on the left hand side.
©2010 Objectif Lune Inc - 216 -
Error Handling Error Handling This section explains how you can build specific error behaviors into your configuration to determine exactly what is to happen when a something fails. This section presents the error handling features built into PlanetPress Suite Workflow Tools and explains how to set error handling properties for branches, conditions and tasks.
Error Handling checked in that tab and an error process is selected in the drop-down list. To create an error process, simply replace the initial input task by the InputErrorBin Input Task, and that process automatically becomes able to handle error jobs sent to it. It is up to you, however, to decide how that error job will be handled. For example, you could place the job file in a specific folder, then send an email to a supervisor indicating that a job has failed.
Error Handling The PlanetPress Image and PlanetPress Fax logs are available in different folders. From the Watch folder, go up one level then go in either folders, under which you will find the Log folder for that specific software within the suite. Resubmit Backed Up Input Files to a Process Each input task includes an option that lets you back up input files. This options is not selected by default, since it has the potential to generate a very large number of back up files.
Error Handling function for other types of inputs. In these cases, the complete backup job is submitted. Knowing What to Resubmit When something goes wrong with an output job, a print job for instance, and printouts are lost, you usually need to know the following information in order to resubmit the input: 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.
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 81).
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 224)). 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 234) Retrieves the content of a numbered job info (%1 to %9). Example Usage: str = Watch.getjobinfo(9) "Watch.GetVariable" (page 235) Retrieves the content of a local or global variable by name. Example Usage: str = Watch.getvariable("Varname") "Watch.ExpandString" (page 236) 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 - 241 -
