User Guide www.objectiflune.
Copyright Information Copyright Information Copyright © 1994-2011 Objectif Lune Inc. All Rights Reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any other language or computer language in whole or in part, in any form or by any means, whether it be electronic, mechanical, magnetic, optical, manual or otherwise, without prior written consent of Objectif Lune Inc. Objectif Lune Inc.
Table of Content Table of Content Copyright Information 3 Table of Content 5 Overview Icons used in this guide Other Documentation Getting Started Environment Considerations 15 15 15 17 17 Terminal Services 17 Virtual Environments 17 32-Bit or 64-Bit? 17 Antivirus Considerations 18 Backup Considerations 18 Microsoft Office Compatibility 18 Network Considerations 18 Local and Network Rights 19 Account Requirements 19 Mapped Drives 19 Network Ports used by each service 19 Activate
Table of Content Create a New Configuration 33 Open a PlanetPress Suite Configuration File 33 Saving and Sending a Configuration 33 Save your Configuration 34 Send your Configuration 34 Import Processes from Another Configuration File 35 Import Documents 36 Import PrintShop Mail Documents 36 Change the Interface Language 36 Exit the PlanetPress Suite Workflow Tools Configuration Program 37 The Quick Access Toolbar 37 The PlanetPress Suite Ribbon 38 Start and Stop the PlanetPress Sui
Table of Content Redo a Command 60 The Plug-in Bar 60 The Object Inspector Pane 61 Toggle the Run on Desktop Property 62 The Debug Information Pane 62 The Message Area Pane 63 Customizing the Program Window 63 Dock and Undock Areas of the Program Window 64 Show or Hide Areas of the Program Window 64 Combine and Attach Areas 65 Resize the Program Window Areas 68 Preferences 68 General User Options 69 Object Inspector User Options 69 Configuration Components Pane User Options 70
Table of Content Standard Variables Available Standard Variables The %i Loop Count Variable Data in PlanetPress Suite Workflow Tools 100 100 101 103 Choosing a Sample Data File 103 The Data Selector 103 Metadata tab 105 Metadata 106 Using the Metadata Data Selector 111 Using the File Viewer 112 Choosing a Database Type Sample Data File 112 Data Selections in PlanetPress Workflow Tools 112 Text-Based Data Selections 112 Database Data Selections 113 PDF Data Selections 113 Metadata
Table of Content Decompress File(s) 153 Digital Action 154 Download to Printer 159 External Program 160 Load External File 161 Mathematical Operations 162 Open XSLT 163 PlanetPress Database 164 Rename 167 Run Script 168 Send Images to Printer 169 Search and Replace 171 Send to Folder 172 Set Job Infos and Variables 173 SOAP Client Plug-in 173 Standard Filter 175 Translator 176 Windows Print Converter 177 Data Splitters 179 About Using Emulations with Splitters 179 Da
Table of Content PlanetPress Fax 213 Captaris RightFax Configuration 214 About PlanetPress Image 217 PlanetPress Image 217 Overview of the PDF/A and PDF/X Standards 223 PrintShop Mail 224 PlanetPress Capture 226 Capture Condition 226 Capture Fields Generator 229 Capture Fields Processor 230 Capture PGC Splitter 232 Find Capture Documents 234 Get Capture Document 236 PGC to PDF Converter 237 Metadata Tasks 239 Create Metadata 239 Embed/Extract PlanetPress Suite Metadata 240
Table of Content HTTP Server workflow PlanetPress Capture Workflow 265 265 The PlanetPress Capture workflow 266 The Examples 267 PlanetPress Capture Glossary 267 General Considerations 269 Security Considerations 270 20,000 Patterns 271 THE NUMBERS 271 EXAMPLE 272 EXTENDING 272 CONTAMINATION 273 SAFEGUARDS 274 CONCLUSION 274 Anoto penDirector 274 PlanetPress Mobile Application 275 PlanetPress Capture Implementation Restrictions 276 Printer limitations 276 Black ink close
Table of Content Printer Queues and Documents 289 PlanetPress Suite Workflow Tools Printer Queues 289 Shared Printer Queue Properties 289 Windows Output Printer Queue 290 LPR Output Printer Queue 290 FTP Output Printer Queue 291 Send to Folder Printer Queue 292 PlanetPress Suite Workflow Tools and PlanetPress Design Documents 293 Variable Content Document File Formats: PTZ, PTK and PS 293 PlanetPress Suite Workflow Tools and Printshop Mail Documents 294 Triggers 294 Load Balancing 29
Table of Content Watch.GetMetadataFilename 316 Watch.InputBox 317 Watch.GetJobInfo 318 Watch.SetJobInfo 318 Watch.GetVariable 319 Watch.SetVariable 319 Watch.ExpandString 320 Watch.Log 320 Watch.Sleep 321 Script.
Overview Overview This PDF documentation covers version 7.4. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Icons used in this guide Some icons are used throughout this guide in order to catch your attention to certain particular information. Notes: This icon shows you something that complements the information around it.
Getting Started Getting Started This chapter describes how to install the PlanetPress Suite Workflow Tools and how to set up your working environment. Environment Considerations This page is intended to provide technical information about the environment in which PlanetPress Workflow is intended to run. Terminal Services PlanetPress Suite does not support Terminal Services environment as possible under Windows 2000, 2003 and 2008.
Getting Started Antivirus Considerations PlanetPress Suite Workflow Tools generates a very large amount of temporary data on your hard disk, especially when manipulating or creating PDF files. This can sometimes cause issues when any other software is trying to access the temporary files at the same time as PlanetPress Workflow and its components are trying to read, write, create or delete those files.
Getting Started Local and Network Rights Programs, such as PlanetPress Suite Workflow Tools and all its services, must identify themselves in order to be granted permission to perform operations on the computer on which they run as well as on other computers accessible via a network connection. On a given workstation, you can configure your PlanetPress Suite Workflow Tools to use either the local system account or any specific user account.
Getting Started Component Protocol Local Port LPD Input FTP Input Telnet Input FTP Output Email Output (SMTP mode) TCP TCP TCP TCP TCP Email Output (Outlook mode) TCP 515 (listening port) Default1 Default1 Default1 Default1 See Email Input (Outlook mode) Remote Port l UDP 445; TCP 445 (SMB over TCP/IP) N/A 21 9100 (configurable) 21 25 See Email Input (Outlook mode) Standard Windows file and printer sharing ports2: Send to Folder Windows Queue Output Default1 TCP TCP or UDP UDP Default or 721 to
Getting Started l l OK: Save changes and exit. Cancel: Exit without saving changes. You can also double-click on any existing activation to edit it. PlanetPress Suite Workflow Tools Service Logon To be able to run and to have access to local files as well as to files available on other computers in your network, PlanetPress Suite applications and services must identify themselves using a local or network account.
Understanding PlanetPress Suite Workflow Tools Understanding PlanetPress Suite Workflow Tools PlanetPress Suite Workflow Tools are input driven applications designed to output data in a variety of ways through diverse means to various applications and devices. PlanetPress Suite Workflow Tools can be used as simple go betweens, passing along input data to output devices, but it can also perform various types of data processing.
Understanding PlanetPress Suite Workflow Tools l l l l l l l l l l l l PlanetPress Suite Workflow Configuration (or "Configuration"): The Configuration is a physical file opened by the PlanetPress Suite Workflow Tools and it contains all of the elements (tasks, processes, documents and printer queues) that drive your workflow. Process: A single workflow within the Configuration.
Understanding PlanetPress Suite Workflow Tools About Processes A process is a single workflow within the configuration. A process begins with a single input task, contains one or more tasks and/or branches, and terminates with one or more output tasks. In its simplest form, a process can simply retrieve data from a given folder and save it in a different folder. In most cases, though, processes are more elaborate and configurations, which may include many processes, can be extremely complex.
Understanding PlanetPress Suite Workflow Tools l l l Input Task: Will either capture data from a specific location, or wait for input from a service or other computer to start processing. Action Task: Will manipulate the data in any number of ways. An action task is any task that is not an input or output task or a branch or condition. Output Task: Will output data to a specific location or send to a different service or computer.
Understanding PlanetPress Suite Workflow Tools generally used to generate output. Data can be manipulated using the tasks in the process, used as comparison for conditions and loops, complemented with data from other sources, and used to generate your output. It originates from many different sources (as many as the Input Tasks support), parts of it can be stored in variables, and is always accessible by the task that currently handles it.
Understanding PlanetPress Suite Workflow Tools l l XML PDF PDF Emulation, also called Document Input, is only available in PlanetPress Production and PlanetPress Office. If used in PlanetPress Watch, it will cause a watermark to appear in any output. For more information about each emulation and how to use them, please consult the PlanetPress Design User Guide.
Understanding PlanetPress Suite Workflow Tools l l l PlanetPress Fax can generate faxes and dispatch them from the host on which it runs, using a local faxing program, such as WinFax PRO, Captaris RightFax or Windows Fax. See About PlanetPress Fax. PrintShop Mail: Used to generate documents using PrintShop Mail databases and documents. Communicate with it through the PrintShop Mail and PrintShop Mail 7 Connector Tasks. See PrintShop Mail. Laserfiche: Used as a repository for electronic documents.
Understanding PlanetPress Suite Workflow Tools LPR output queues let you send print jobs to remote printers via TCP/IP using the LPR/LPD protocol. See LPR Output Printer Queue. Windows Driver Printing: l The Print using a Windows Driver output task lets you send a job to any printer installed on the computer, using its own drivers. In this particular case, the printer does not need to be a PostScript printer. See Print Using a Windows Driver.
The PlanetPress Suite Workflow Tools Configuration Program The PlanetPress Suite Workflow Tools Configuration Program This chapter centers on the PlanetPress Suite Workflow Tools Configuration program, which you use to create and edit your configurations. The basic user interface elements are as follows: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. The PlanetPress Suite Button. See The PlanetPress Button. The Quick Access Toolbar. See The Quick Access Toolbar. The Ribbon Tabs. See The PlanetPress Suite Ribbon.
The PlanetPress Suite Workflow Tools Configuration Program You can customize the appearance of the PlanetPress Workflow Tools Configuration programs to your needs. See Customizing the Program Window. Start the PlanetPress Suite Workflow Tools Configuration Program This procedure explains how to start the PlanetPress Suite Workflow Tools Configuration program, which is different from starting PlanetPress Suite Workflow Tools service itself (see Start and Stop the PlanetPress Suite Workflow Tools Service).
The PlanetPress Suite Workflow Tools Configuration Program l l Preferences: Displays the Options dialog. See Preferences. Exit: Closes PlanetPress Workflow. See Exit the PlanetPress Suite Workflow Tools Configuration Program. When using the New, Open, Close, Recent Documents and Exit menu options, if your current configuration has not been saved after modifications, a dialog will open asking if you want to save, not save, or cancel the action and return to the current configuration.
The PlanetPress Suite Workflow Tools Configuration Program Saving a configuration file never replaces the current PlanetPress Watch service configuration. To do this, you must use the Send Configuration command (see Send your Configuration). Save your Configuration Files created and edited using PlanetPress Workflow can be saved as PlanetPress Suite configuration files ([file name].pw7) anywhere on your computer or even a network location.
The PlanetPress Suite Workflow Tools Configuration Program If a server is greyed out, this may mean you do not have access to send a configuration remotely to it. For more information, please see Access Manager. Note that if PlanetPress Suite Workflow Tools service is paused when you send a new configuration, it will not stop and restart.
The PlanetPress Suite Workflow Tools Configuration Program Import Documents This procedure describes how to import variable content documents created in PlanetPress Design. Importing documents can be useful when transferring configurations between PlanetPress Suite Workflow Tools installations. To import documents into PlanetPress Suite Workflow Tools: 1. Choose File | Import Documents. The Import PlanetPress Design Document dialog box appears. 2. In the File type box, select the desired file type. 3.
The PlanetPress Suite Workflow Tools Configuration Program codepage 932 is used for Japanese. Exit the PlanetPress Suite Workflow Tools Configuration Program Once you are done using PlanetPress Suite Workflow Tools, you can close the configuration program. It is important to note that closing the PlanetPress Suite Workflow Tools Configuration Program does not stop any of the PlanetPress Suite Workflow Tools services or stop processing.
The PlanetPress Suite Workflow Tools Configuration Program 2. Click on Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon, depending on where you want it. The Quick Access Toolbar buttons cannot be moved or re-ordered. If you wish to re-order them, you will need to remove all the buttons and re-add them in the desired order.
The PlanetPress Suite Workflow Tools Configuration Program l l l l The Debug group contains the debugger's controls, allowing to execute a process step by step, skipping over or ignoring certain tasks, as well as setting up breakpoints and resetting variables values. This group also includes the Send Configuration button, necessary to push the current configuration to the PlanetPress Suite Workflow Tools service.
The PlanetPress Suite Workflow Tools Configuration Program To stop your PlanetPress Suite Workflow Tools services via the PlanetPress Suite Workflow Tools Configuration program: l l Click Tools in the PlanetPress Suite Ribbon. Click Stop Service in the Services Status group.
The PlanetPress Suite Workflow Tools Configuration Program Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties for error handling. Global Variables: Displays a list of variables that are shared between all your processes. Right-click on a Global Variable to access a drop-down menu that offers these choices: l Insert Global Variable: Creates a new global variable l Cut, Copy, Paste: Controls the clipboard.
The PlanetPress Suite Workflow Tools Configuration Program General tab l l l l l l l l l l l Active: Select to make the process active. Clear to prevent this process from running when you send the configuration to PlanetPress Suite Workflow Tools. Startup process: Select to make this process a startup process. Self-Replicating Process: Check this if you want the process to replicate itself in the background when multiple input files are received simultaneously.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l Click on any block to select/deselect it. Click and drag from one block to another to toggle all blocks between the two. Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click. To select all of the time segments for a given day or date, click the day or date on the top grid ruler.
The PlanetPress Suite Workflow Tools Configuration Program Changes made to the system time can have adverse effects on the processes managed by PlanetPress Suite Workflow Tools. When changing from daylight saving time to standard time, for example, if PlanetPress Suite Workflow Tools starts a given process at 2:00AM, and if the system time is then taken back to 1:00AM, the application will start a new instance of the same process when the system time reaches 2:00AM for a second time.
The PlanetPress Suite Workflow Tools Configuration Program Local Variables are set at the level of the Process and are not shared with any other process or instance of that process. Local variables can be used anywhere that accepts variables by using it's namee, surrounded by curly brackets and preceded by a percent sign (for example: %{myLocalVariable}). When the process ends, the local variable forgets whatever value was given to it by the process and goes back to its default value.
The PlanetPress Suite Workflow Tools Configuration Program Convert a Branch to a Subprocess To allow for maximum flexibility and backward compatibility with the subprocess feature, the Convert to subprocess option lets users transform existing processes easily. This option is available whenever a Branch task is selected; right-clicking on it will display the contextual menu, which holds the Convert to subprocess option.
The PlanetPress Suite Workflow Tools Configuration Program l Right-click on the variable name in the Configuration Components Area and click Delete. To rename a variable: l l l Right-click on the variable name in the Configuration Components Area. Click Rename Type in the new name of the variable, then press Enter on your keyboard.
The PlanetPress Suite Workflow Tools Configuration Program l l is used in the trigger to identify the document when the PlanetPress Suite Workflow Tools sends a job to be merged on a printer, the document name must exactly match the name of the document installed on the printer. 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.
The PlanetPress Suite Workflow Tools Configuration Program To view an attached data file: 1. Make sure the Documents section is visible by clicking the button if it appears. 2. Expand the document (name.ptk) by clicking the button. 3. Double-click on the data file to open the data selector. Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file. Clicking Cancel instead of Ok after viewing will prevent this action from being taken.
The PlanetPress Suite Workflow Tools Configuration Program 1. In the PlanetPress Suite Workflow Tools Configuration Components Pane, click the Documents icon and choose Insert | Resident Document. The Add Resident Document dialog box is displayed. 2. Enter the document’s name. Note that the name you enter must exactly match the actual document name or PlanetPress Suite Workflow Tools will not be able to use it on the printer or remote PlanetPress Suite Workflow Tools server. 3. Click OK.
The PlanetPress Suite Workflow Tools Configuration Program configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box. If you are copying a configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box and a plus (+) sign.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l same level (group) as the component after it. If you move an object in the Configuration Components Pane on top of a group, the group name turns maroon (in the default color scheme) to indicate the object will be moved in the group after all the existing objects currently in that group. Moving a configuration component does not change the order in which the components are used.
The PlanetPress Suite Workflow Tools Configuration Program 1. Click an object or group. 2. In the PlanetPress Suite Ribbon, go to the View tab then click Order in the Arrange group, then select one of the following: l Up One Level to move the item one level up in the hierarchy. If the item is already the top object in the category, or within a group, this command has no effect. l Down One Level to move the item one level down in the hierarchy.
The PlanetPress Suite Workflow Tools Configuration Program 1. Select objects in a group. 2. Press CTRL+U. Expand and Collapse Categories and Groups in the Configuration Components Pane You can expand and collapse the Processes, Global Variables, Documents and Printers Queues categories, and groups, in the Configuration Components Pane. To expand or collapse categories or groups in the Configuration Components Pane: l Click the expand/collapse button to the left of the item.
The PlanetPress Suite Workflow Tools Configuration Program l l Click on the View tab of the Ribbon. Click on Zoom Out in the Navigate group to zoom out, and Zoom In to zoom in. Adding Tasks You can add as many tasks as you want to your process by using the Plug-in Bar in the PlanetPress Suite Workflow Tools program. To insert a task: 1. Open the Plug-in Bar by clicking on its tab.
The PlanetPress Suite Workflow Tools Configuration Program Replacing Tasks, Conditions or Branches You can replace existing tasks either by dropping a new task on it, or by pasting another task over it. To replace an existing task with a new task, see Adding Tasks To replace an existing task with another existing task or its properties, see Cutting, Copying and Pasting Tasks and Branches You cannot replace a task by a branch or a condition.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available: l Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process.
The PlanetPress Suite Workflow Tools Configuration Program To copy and paste Properties of a task or branch: 1. Copy or Cut a task or branch of which you want to have the properties. 2. Select the task or branch where you want to paste the properties 3. From the Home tab in the Ribbon, choose Paste Properties (or Right-Click and select Paste Properties from the drop-down menu). You can only paste the properties of an input task on the initial input task of your process.
The PlanetPress Suite Workflow Tools Configuration Program Ignoring Tasks and Branches PlanetPress Suite Workflow Tools lets you ignore individual tasks, branches or conditions. l l When a task is disabled, it is not executed when the process is run in debug mode (see About the Debug Mode) or by the PlanetPress Suite Workflow Tool Service. When a branch is disabled, the whole branch including the tasks inside that branch are ignored and not executed.
The PlanetPress Suite Workflow Tools Configuration Program Highlight a Task or Branch The Highlight command lets you toggle the background color of selected tasks and branches. Note that the highlight color may be changed via the PlanetPress Suite Workflow Tools Configuration preferences. To highlight a Process Area square: l l l Use the mouse pointer to select a given square. In the PlanetPress Suite Button, click the View tab. Select Highlight from the Navigate group.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l Inputs Actions Outputs Data splitters Metadata Related Process logic Connectors 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.
The PlanetPress Suite Workflow Tools Configuration Program l Depending on the values that can be entered for the selected property, edit the value by typing a one or by selecting a new one from the drop-down list. If you select multiple objects in the Configuration Components window, some properties that are shared between those objects can be changed in the Object Inspector. Changing a property changes it for all the selected objects.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l Copy Value (only when right-clicking an existing expression): Places the resulting value of the expression in your clipboard. Revalue all: Refreshes the value of all the expressions. Add Expression: Creates a new expression. Delete Expression (only when right-clicking an existing expression): Remove the selected expression. Clear Expression List: Removes all expressions.
The PlanetPress Suite Workflow Tools Configuration Program Note that since the Process area must remain in the main PlanetPress Suite Workflow Tools Configuaration Program window, it cannot be combined and attached in this fashion. Dock and Undock Areas of the Program Window The Configuration Components Pane, the Object Inspector, and the Messages area can be displayed in windows that are attached to the Program window (docked position) or that float above it (undocked position).
The PlanetPress Suite Workflow Tools Configuration Program The Process Area is always visible and cannot be hidden. Combine and Attach Areas The Configuration Components Pane, the Object Inspector, and the Messages area can be attached or combined to one another and share the same space. However they are displayed, you can always drag, dock, or undock any area as desired. You can also switch among areas when they are combined, as well as maximize or minimize areas when they are attached.
The PlanetPress Suite Workflow Tools Configuration Program l At the bottom of the combined area, click the tab of the area you want to move, drag it to the left or right and drop it at the desired position. Dragging a combined area to new position. To take an area out of a combined area: l Do one of the following: l Click the tab displaying the name of the area you want to take out and move the mouse pointer so as to drag the area away from the combined area.
The PlanetPress Suite Workflow Tools Configuration Program l Do one of the following: l To maximize a vertically attached area, click the upward pointing arrow on its title bar. l To restore a vertically attached area, click the downward pointing arrow on its title bar. l To maximize a horizontally attached area, click the left pointing arrow on its title bar. l To restore a horizontally attached area, click the right pointing arrow on its title bar.
The PlanetPress Suite Workflow Tools Configuration Program A) Click to maximize this area. B) Click to restore this currently maximized area. C) Click to maximize this area. D) Click to restore this currently maximized area. To take an attached area out of a group: l Do one of the following: l Click the title bar displaying the name of the attached area you want to take out and move the mouse pointer so as to drag the area away from the group.
The PlanetPress Suite Workflow Tools Configuration Program Other Preferences and Settings: l l The PlanetPress Suite Services dialog lets you select the account that the PlanetPress Suite Workflow Tools Service uses to communicate on the server and the network. See PlanetPress Suite Workflow Tools Service Logon. You can change the appearance of the Run Script and XSLT Editor through the Editor Options dialog.
The PlanetPress Suite Workflow Tools Configuration Program l l Line style: Select a style for the lines. Reset to default: Click to reset all the Object Inspector options to their default values. Configuration Components Pane User Options The available Configuration Components Pane user options are as follows: Colors group l This window lets you set the color of individual Configuration Components Pane elements.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l l l l l l l l l l l l l l User mismatch: Select to have PlanetPress Workflow display a prompt when a different user opens the application. Task deletion: Select to prompt for confirmation when deleting a task. Document deletion: Select to have PlanetPress Workflow prompt for confirmation when deleting a document.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l Prompt on Emulation Change: Select to have PlanetPress Workflow prompt when the default process emulation is being changed. The last emulation selected when debugging a process is the one the process begins with. Prompt on Form Refresh: Select to have PlanetPress Workflow prompt for confirmation when recompiling the PostScript (PSx) version of a PlanetPress Document.
The PlanetPress Suite Workflow Tools Configuration Program l Server: Enter the server where the NDS tree you entered in the Tree text box resides. You do not have to specify a server if there is only a single configured server on your network. Click Servers to navigate to the desired server on which the NDS tree containing the user resides. Expand folder paths in UNC (Universal Naming Convention) format: Select to expand all paths used in the configuration to UNC. This converts map drives such as “f:\, t
The PlanetPress Suite Workflow Tools Configuration Program PlanetPress Capture Document Manager The PlanetPress Capture Document Manager dialog is used to manage all the documents present in the PlanetPress Capture database that are currently open. This window has the following options and controls: l l Documents lookup group l Filter by: Select what information you want to look for in the documents database.
The PlanetPress Suite Workflow Tools Configuration Program This will prevent the document to be further updated, may cause errors when docking any pen that signed the printed version of the document. This cannot be undone. PlanetPress Capture ODBC Settings This dialog is used to set up the connection to a PlanetPress Capture Database through an ODBC connection. To access this dialog, see PlanetPress Capture User Options.
The PlanetPress Suite Workflow Tools Configuration Program Minimum 100MB of database size is required as a minimum, but the space requirement is dependant on the implementation. The more active documents in the database, the more space is used - note that this progression is rather linear. l Regular database maintenance is required, such as database compacting, is required by a system administrator. l It is recommended to create an IT process that backs up the database regularly.
The PlanetPress Suite Workflow Tools Configuration Program Pattern Sequence: The pattern sequence the pen is assigned to. You can double-click this area and edit the pattern sequence as required. l User ID: The name of the user assigned to this pen. You can double-click this area to edit the user ID. This can also be custom information. Bottom Toolbar: l Button: Click to add a new line in the Pen Data List, then edit the information on this new line.
The PlanetPress Suite Workflow Tools Configuration Program l l PlanetPress Capture Pen Licenses group l Import License...: Click to open the Import License dialog. Browse to a PPLIC (PlanetPress License) file on your computer and open it to import the license. The PPLIC overwrites your current license, however it may contain more than one Pen Pack (your previous one and one you just purchased) and will display them individually. l License List: Displays the licenses that have been added to this system.
The PlanetPress Suite Workflow Tools Configuration Program text written in lowercase. At 0, the font size must be exactly the same between two fragments. At 1, a greater variance in font size is accepted. Accepted values range from 0 to 1. The default value is 0.65, recommended values are between 0.60 and 1.00. Gap Defines how spaces between two fragments are processed.
The PlanetPress Suite Workflow Tools Configuration Program Close inactive instances after: If you want the PlanetPress Suite Messenger to close inactive instances of the Alambic after a given number of minutes, enter a value in this box. Enter a value of ”0” if you do not want the PlanetPress Suite Messenger to terminate idle instances of the Alambic. Logging options group l Delete log files after: Enter the number of days after which to delete the PlanetPress Suite Messenger service logs.
The PlanetPress Suite Workflow Tools Configuration Program is very quick. Static resources are especially useful for additional formatting of HTML files such as JS (Javascript) scripts, CSS files and images, since they are not dynamic and generally shared between multiple dynamic files. The available HTTP Server 2 user options are as follows: l Serve HTTP resource: Check to activate static resource serving. l Resource action name: Enter a name that will be simulated as a folder in your HTTP structure.
The PlanetPress Suite Workflow Tools Configuration Program Serial Input Service User Options Serial input user options control certain functions of the PlanetPress Suite Workflow Tools Serial Capture service, which in turn has a direct impact on all Serial input tasks performed by PlanetPress Suite Workflow Tools on a given computer.
The PlanetPress Suite Workflow Tools Configuration Program l Use Job Delimiters: Check this option if your Telnet input is a single stream that can contain multiple jobs. The box lets you enter one or more possible delimiters (separated by a line return), either a direct string (such as %%EOJOB) or an ascii character (\001). For a list of ascii characters, see http://www.asciitable.com/.
The PlanetPress Suite Workflow Tools Configuration Program l l then be used as an input for a PlanetPress Watch process for monitoring the status of PlanetPress Fax jobs. The postscript (PS) file for the job is also copied with the report file and can be printed, sent by e-mail, or archived as specified by the PlanetPress Watch process. Expand folder paths in UNC (Universal Naming Conventions) format: Select to have PlanetPress Fax use complete network server path names (\\servername\sharename\path\filen
The PlanetPress Suite Workflow Tools Configuration Program Search database options, as well as networking and email options. Bear in mind that PlanetPress Image output tasks included in a given PlanetPress Suite Workflow Tools configuration can be performed by a PlanetPress Image installation running on a different computer, typically one that runs only PlanetPress Image. When you change the user options on a given computer, only that computer is affected.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l l Database directory: Enter the path of the directory in which the Access database is located, or use the Browse button to navigate to, and select, the directory. This option is available only when you select Access database in the Database type box. Data source name: Enter the name of the computer on which the database runs.
The PlanetPress Suite Workflow Tools Configuration Program l l l Protocol options group l Log all Winsock and network messages: Select to have PlanetPress Suite Workflow Tools keep a log of all Winsock and other network messages that occur through the LPR output. These messages are related to jobs being sent from PlanetPress Suite Workflow Tools to an LPD or LPD-compatible printer. Logs are kept in a Log folder relative to your install folder. They are named lprdate.
The PlanetPress Suite Workflow Tools Configuration Program identified as such. The available Script Editor and XSLT Editor options are as follows: l Editor l l l l l l l l l l l l l l l Auto indent mode: Select to automatically position the insertion pointer under the first non-blank character of the preceding line when you press ENTER. Insert mode: Select to use Insert mode and clear to use Overwrite mode. In Insert mode, when you enter text, existing text shifts to accommodate it.
The PlanetPress Suite Workflow Tools Configuration Program Enable search highlight: Select to highlight the search term match found in the code when you perform a search. Clear to prevent the highlighting. In both cases, the pointer appears after the last character of the search term match. l Double click line: Select to highlight the complete line of code when you double-click that line. Clear to highlight only the word under the pointer.
The PlanetPress Suite Workflow Tools Configuration Program l Color l l l l l Mapping: Select a mapping for the content of the script in the script editor—the mapping is used as well when the script appears in the text box of the Run Script actions properties dialog. Each mapping (Default, Classic, Ocean, Twilight) includes pre-set color values and attributes for each script element as listed in the Elements list box.
The PlanetPress Suite Workflow Tools Configuration Program Access Manager The Access Manager controls what rights are granted to other machines (clients and servers) on the same network. It grants access to functions such as sending documents and jobs to the server. Messenger communications (between different part of the PlanetPress Suite) is limited to within the same Class C subnet. This means that PlanetPress Workflow on 192.168.1.23 cannot send a job to a PlanetPress Image on 192.168.100.54.
The PlanetPress Suite Workflow Tools Configuration Program The format of the IP address must be one of the following: l l l l 127.0.0.1: The local computer. Typically this IP should have all the accesses checked. 255.255.255.255: Everyone on the same subnet. This is equivalent to hard-coding the current subnet, such as 192.168.1.255 or 10.0.0.255. 192.168.0.42 : A single IP address. This can be any valid address on the same subnet. 10.0.255.255: Any IP in the 10.0.X.X range.
The PlanetPress Suite Workflow Tools Configuration Program l l Send Document: Grants access to the remote computer to send new or updated PlanetPress Design Documents to this server. Send Config:Grants access to the remote computer to overwrite the configuration on the local PlanetPress Workflow service 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.
The PlanetPress Suite Workflow Tools Configuration Program Administrator: Choose the permission type l User: Can access none, some, or all of the processes, selected individually in the Permissions section. l Admin: Has access to all processes and features. When this option is selected, the Permission section is greyed out an all options are selected in it. l Disabled: Has access to nothing.
The PlanetPress Suite Workflow Tools Configuration Program The PDF Viewer The PDF Viewer is accessible through one of the following methods: l l l In the Documents section of the Configuration Components pane, expand a document present in the list. Then, rightclick on the document's Preview, and click Open in PDF Viewer. Click View as PDF in the Debug toolbar. This will show the current data file in the viewer (assuming it is a PDF).
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l Open: Click to browse for a PDF to open in the PDF Viewer. Note that this will not change the data file used in the process. Save: Click to browse for a location and name to save the currently active PDF in the viewer. Right Arrow: Click to view the next page of the PDF. Left Arrow: Click to view the previous page of the PDF. Page Selection: Type a page number and hit Enter on your keyboard to jump to that page.
The PlanetPress Suite Workflow Tools Configuration Program Viewing log files The second major role of the Service Console is to view and browse log files. The Service Console can both view existing log files, or monitor the log file for the current day and update the view in real time. When a service is selected on the left pane, its log file (if any exists for the current day) is displayed. The log displays in a tree fashion.
The PlanetPress Suite Workflow Tools Configuration Program Virtual Drive Manager When you use the Send images to printer action in a given process, you have the option of, at the same time, sending the images to the virtual drive (a local storage folder used by PlanetPress Suite applications) of any computer included in your network. You need to do this, for instance, if you plan to run documents that contain dynamic images on those computers (using the Optimized PostScript Stream option).
Working With Variables Working With Variables A Variable is basically a keyword that points to specific location in your computer's memory. This location contains data that you decide to place in it, by assigning that data to the variable name. This chapter will help you learn about these variables and how you can use them.
Working With Variables l l sure it contains the value that you want, and not one that has been overwritten by another task. Job infos sent to the document are global to that document, meaning the values do not change between data files. This means that if your data file contains multiple data pages for different clients, your job infos cannot be used to send information to the document. Job infos are in limited quantity and are slowly being deprecated when transferring data to your document.
Working With Variables The %i Loop Count Variable In version 7.4, the %i variable is introduced. Its value is equivalent to the current iteration of loops inside of a process. It always contains the value of the innermost loop, and only certain tasks trigger the counter to start. Here is an example process and the value of %i during this process: Initial input tasks do not modify the value of %i.
Data in PlanetPress Suite Workflow Tools Data in PlanetPress Suite Workflow Tools PlanetPress Suite Workflow Tools is a versatile tool that can capture various types of data files and dispatch this data to various PlanetPress Design documents. To fully understand PlanetPress Suite Workflow Tools and how it treats data, you must understand how it is integrated into PlanetPress Design.
Data in PlanetPress Suite Workflow Tools The Data Selector is divided in two tabs: Data and Metadata. The Data tab contains the Data Options, which let you select your emulation, and the Selector Options, which lets you personalize the data selector's display options (see "Data Selector Display Preferences" (page 1)) Depending on the chosen emulation and data file, the options in the data selector, the Sample data file section and the Data Pane itself may change to accommodate your choice.
Data in PlanetPress Suite Workflow Tools l l l If you use a PDF emulation, the Data Pane displays the data as you would see it in any PDF reader. A new zoom dropdown list is displayed to let you set the zoom in percentage or fit the PDF to the window or the width of the window. A new status bar, displaying the (Left, Top) and (Right, Bottom) coordinate pairs, is shown under the Data Pane.
Data in PlanetPress Suite Workflow Tools The Raise an error if the field does not exist option allows to control what to do when a given metadata element is not found, regardless of the search option. The Data page box lets the user choose which data page metadata elements to be displayed. The Metadata level is a treeview allowing users to select the metadata level from which to display or select metadata elements.
Data in PlanetPress Suite Workflow Tools A single JOB can be composed of GROUPS of DOCUMENTS, which themselves are composed of physical PAGES produced by executing a PlanetPress Design document on one or more DATAPAGES. Metadata Elements Each metadata node (i.e. Job, Group, Document, etc.) is described with a series of elements, that is, system-defined attributes or user-defined fields holding static or dynamic information about the node they are attached to. Each element has a name and a value.
Data in PlanetPress Suite Workflow Tools Finishing attributes describe the finishing intent (e.g. page dimensions, page orientation, duplex mode, etc.). Note that the presence of some finishing attributes depends on the PlanetPress Design document and target device used when producing the job. Index/Count attributes are not part of the original metadata file. They are evaluated live based on the content of the metadata.
Data in PlanetPress Suite Workflow Tools Index/Count DatapageCount Index/Count PageCount Index/Count SelectedCount Index/Count SelectedDocumentCount Index/Count SelectedDatapageCount Index/Count SelectedPageCount SelectedIndexInDocument Returns the Absolute index of the node within all the selected node Index/Count under the parent Document. SelectedIndexInGroup Returns the Absolute index of the node within all the selected node Index/Count under the parent Group.
Data in PlanetPress Suite Workflow Tools Metadata Selector PlanetPress Design's Data Selector window is accessible by double clicking inside the Sample Data window or by clicking on the Open Active Data button available in the ribbon. The Data Selector is equipped with a new tab labeled Metadata. Firstly, two buttons at the top right corner of this tab allows to load or save a metadata file generated for the current sample datafile. Secondly, the metadata tab graphically displays all elements (i.e.
Data in PlanetPress Suite Workflow Tools Metadata tab in the properties of a PlanetPress Design document allows to easily define documents or groups. Metadata Fields Metadata Fields in the properties of a PlanetPress Design document allows to easily define documents or groups. Using the Metadata Data Selector The Metadata Data Selector in PlanetPress Workflow Tools is the same as in PlanetPress Design, please refer to the PlanetPress Design User Guide for information on how to use the Data Selector.
Data in PlanetPress Suite Workflow Tools Using the File Viewer The File Viewer is like a Data Selector without any data related options, such as emulation settings. It is displayed when doing a data selection from the Generic Splitter Task (see Generic Splitter) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks. For more information on the selecting data, see The Data Selector.
Data in PlanetPress Suite Workflow Tools l l l l l l From Line: The starting line of the data selection. To Line: the last line of the data selection. From Column: the leftmost character position of the data selection. To Column: the rightmost character position of the data selection. Case Options: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent.
Data in PlanetPress Suite Workflow Tools l l l l l l l l region(): Always surrounds PDF data selections. Page: The page of the PDF from which to retreive the data. Left: Exact horizontal position (in inches) that defines the left of the selection region. Top: Exact vertical position (in inches) that defines the top of the selection region. Right: Exact horizontal position (in inches) that defines the right of the selection region.
Data in PlanetPress Suite Workflow Tools A single job file can be the source of multiple job files. This is the case, for example, when a process includes multiple branches, as each branch is given a duplicate copy of the job file. This is also the case when a job file is split into multiple smaller files by a Splitter action task, for instance (see Data Splitters). It is important to note that job files may be used as a helpful debugging resource (see Debugging and Error Handling).
Task Properties Reference Task Properties Reference This chapter lists all of the possible tasks that are available in the PlanetPress Workflow Tools Configuration program.
Input Tasks Input tasks are the starting point to any process and determine what file this process will being with. Each process must begin with an input tasks, and although a given process may have multiple input tasks, no task can have more than one initial input task. Initial Input Tasks Initial input tasks are always at the beginning of a process and are always triggered when the process starts.
l If your secondary input task creates a job file using a different emulation, you will need to use a Change Emulation task after the secondary input task to correctly change to that emulation. Properties common to all input tasks The "Other" tab is common to all input tasks and are available in the Properties of all input tasks. "Other" Tab l l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task.
l l l l l l l Sort files by: Select a given sorting method to prompt PlanetPress Suite Workflow Tools to sort the files in the source folder before taking them (and thus to take them in a specific order). Select None to let PlanetPress Suite Workflow Tools take the files without sorting them first. Sort order: If you selected a sorting method in the Sort files by box, select the order in which you want the files to be sorted.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Job Information definitions l This task does not generate any job information. Examples & Use Cases This task is put into effect in the following use cases and example processes: l l l HTTP PDF Invoice Request HTTP Brochure Request Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog.
General tab l l Data Location group l Message body: Select to use the data found in the body of the email. l Attached file: Select to use the data found in the email’s attachment. If both the Message body and Attached files options are selected, the message’s body and the message’s attachment are treated as separate data files and processed one after the other. l Unzip attached file: Select to unzip the attached files. l Zip password: Enter the password required to unzip the attached files (if any).
Job Information definitions l l l l l %1 - Date received. Contains the date of the reception of the email (and not the date of retrieval by PlanetPress Workflow). The format is YYYY/MM/DD HH:MM:SS. %2 - Sender's name: Contains the name of the sender as defined by the sender himself (or, if the sender is using Exchange, by the name defined in his Exchange server). %3 - Sender's address: Contains the email address of the sender as defined by the sender himself.
PlanetPress Suite Workflow Tools will try to remove all the files located in that folder, including all the system and hidden files. So when using a Folder Capture, be aware of where you are capturing. General Tab l l l l l l l l l Folder: Enter the full path of the folder from which the input files are to be taken. Masks: Enter a single or multiple file names or use file name masks. See Masks.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
l l l l Input folder: Enter the path of the folder that contains the files you want listed. Sorted by: Select either Name or Modified date, depending on how you want the list top be sorted. File mask: Edit the default filename mask (*.*) if you want only some of the files present in the folder to appear in the list. List files in sub-directories also: Select this option if you want the task to list any files present in subfolders of the selected input folder.
Output The output to this task is a series of individual files, one after the other. These files are not modified in any way from when they are captured from the source FTP server. FTP input task properties are as follows: General tab l l l l l l l FTP Server: Enter the IP address or host name of the FTP server to poll. User name: Enter the name of a user account on the FTP server. Password: If account named in the User name box is password protected, enter the password here.
HTTP Client Input HTTP Client input tasks use the HTTP protocol to issue HTTP GET commands (queries) to HTTP servers. Replies received from the HTTP servers are used as jobfiles and are thus passed on to following tasks. Input This initial input task retrieves a single file as specified in the URL option. This file may be of any format, even formats that are not readable by PlanetPress Workflow. Processing No processing is done by this task. The file retrieved is not changed in any way.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
l l l Loop each attachment as a data file: When receiving attachments through a POST request (HTML Form), this option will make the HTTP Server Input task loop through each attachment. Each data file is an XML with the accompanied file. l Do not include XML envelope: Only active when the previous Loop option is checked. When checked, the XML file containing the request data will not be available. Only the attachment itself is sent as a data file.
Input This task receives a data file from a task that generated an error. Accompanying this data file is the current Job Infos of the process that triggered the error. This means that this input does not generate its own job infos! No Metadata is received by this task, and none is generated. Processing No processing is done by this task. Output The output of this task is the same as the input - a data file and job infos that are sent from a task that generated an error.
Input This task does not poll any location by itself. It sits there waiting for requests coming in through WSDL (SOAP communication) and, when it receives a request, runs the process and returns the last output generated by the process to the client. Processing No processing is done. The request that is received by this task is XML and it is maintained as such. Output As with the HTTP Server Input, this task has a dual-output purpose.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. LPD Input LPD (Line Printer Daemon) input tasks retrieve data in the form of print files sent from remote computers using the LPD/LPR protocol.
The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l l l Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
"Other" Tab l l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder.
Output Either one of 3 formats is output from this task: l l l An EMF job format A RAW job format A PDF with attached metadata. WinQueue input task property is as follows: General tab l l l Printer queue: Select the PlanetPress Suite Workflow Tools printer queue (the one to which data files are going to be sent). Printer properties group l Spool Print Job ins EMF Format (Advanced printing features): Select to create EMF files for Windows Print Converter action tasks (see Windows Print Converter).
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Action Tasks Use action tasks in PlanetPress Suite Workflow Tools to perform a wide variety of operations. PlanetPress Suite Workflow Tools includes more action tasks then input and output tasks combined. Action tasks can even be used to input data and to output data. The difference between an action task and an input task is that an action task can never be the first task of a process.
Processing This task takes the PostScript version of the document (.ps7), ads the trigger and then the active data file to it. If metadata is present, the output is based on this metadata (unselected data pages will not generate output, the sort order will be respected, etc). Otherwise the complete data file is merged. Output The output is an PostScript job that can be sent to any output task in "passthrough" mode, for example Create PDF, PlanetPress Image, etc. Metadata is not generated by this task.
General tab l l l l l l l l Action group l Add: Select if you want the task to add content to the job file. l Remove: Select if you want the task to remove content from the job file. Content: Select what the task will actually add or remove. Select Text file to add the whole content of a text file to the beginning or end of the job file.
Advanced Search and Replace action task properties are as follows: General tab l l l l l l l Search mode group: Select your chosen search mode within this group. l Search line by line: Select if you want each line in the data stream to be searched separately. When this option is selected, PlanetPress Suite Workflow Tools considers each line as an individual data stream (lines are separated by Line Feed characters).
All before occurrence: All occurrences of the search string will be replaced until the specified number of occurrences has been reached. Specifying 5 occurrences, for instance, means that the four first occurrences will be replaced. Replace with: Enter the string that must be used as the replacement sting when a match is found. l l On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog.
UPCE Code11 Code39 Code93 Code128 Codabar Inter2of5 Add2 Add5 PDF417 UPCE symbology. Short version of UPC symbol, 6 characters. Code 11 symbology. Used to identify telecommunications equipment Code 39 symbology. U.S. Government and military use, required for DoD applications Code 93 symbology. Compressed form of Code 39. Code128 symbology. Very dense code, used extensively worldwide. Codabar symbology. Used in libraries and blood banks. Interleaved 2 of 5 symbology.
l l metadata field. This option allows only one printable replacement character. By default, this character is an empty space. Note: Non-printable characters are the first 32 characters in ASCII character table (Ex.: form-feed, newline, carriage return characters) Scan Interval: Set a scan interval in pixels of image scanning. This property directly affects the performance and quality of the recognition.
Barcode_1_Value: Metadata field representing the value of the first barcode on the page. Note that this field (Barcode_1_Value) contains the same value as the first occurrence of BarcodeValue. BarcodeBase64_1_Value: Metadata fieldcontaining the value of the first barcode, encoded in Base64. Barcode_1_Type: Metadata fieldcontaining the type of the first barcode (ex. EAN13, UPCA …). Barcode_1_Orientation: Metadata fieldcontaining the orientation of the first barcode.
Output The original data file, metadata and job infos are not modified. Only the emulation is changed. General Tab l The options of this task are basically the same as the Data Selector in PlanetPress Design. Please refer to the PlanetPress Design User Guide for information on how to use the Data Selector. Examples & Use Cases This task is put into effect in the following use cases and example processes: l Capture Web Manager Workflow On Error Tab The On Error Tab is common to all tasks.
General tab l l l l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. The None option is available to create or update a PDF without using a PlanetPress Design document, in a Metadata-based workflow. Run mode group l Printer centric: Select to send the document along with the trigger and data to the PDF RIP.
Pixels per inch: 300 Color images : l Compression: Auto l Downsampling: Bicubic l Pixels per inch: 150 Security : l Allow printing l Allow changing the document l Allow content copying l Allow form filling Font : l Embed all fonts l Subset embedded fonts Open options : l Zoom factor: Fit in window l Default view: Page only l l l l l Decompress File(s) Decompress action tasks decompress zipped job files (files compressed as zip files).
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l l l l l l l l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Output type: Select the output file type that you want. l PDF: The output will be a PDF file. If you select PDF, the DPI and Color Depth options (see below) are disabled and the options available in the PDF tab are enabled. l JPEG: The output will be a JPEG file.
l l Add PDF to PlanetPress Search database: Check to update the PlanetPress Search database with each new PDF generated. Index group: This group lets you specify which type of index must be created for each document generated by this task. PDI files are used by PlanetPress Search as indexing information. l None: Select if you do not want this task to add an index file to the generated document. l PDI: Select if you want this task to add a PDI index file to the generated document.
l l l 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.
l l 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. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded. If a font is not embedded in your PDF, opening it on another computer or printing it may cause it to be substituted by another default font.
Download to Printer Download to Printer action tasks are used to warn printers that the files that will be sent to them are to be stored to a specific location rather than printed. Note that each Download to Printer action task must be followed by a Printer Queue output task set to "passthrough", in order for it to be sent to the printer and not merged with a document.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
l l Program output capture group l Log the program output: Check to store the program output (messages generated by the execution of the external program) inside of a job info or variable. l Store the program output in variable: Use the drop-down to select which variable or job info to will be used to store the program output. Exit Code group l Store the exit code in job info: Use the drop-down to select which variable or job info will be used to store the program's exit code.
l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field. Examples & Use Cases This task is put into effect in the following use cases and example processes: l HTTP PDF Invoice Request On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog.
l l example, to multiply Job Info 9 by 2, the expression would be %9*2 . Store result in: Variable data field containing the job information, local or global variable in which to store the result. For job information use %1 through %9, for local variables use %{variable} and for global variables use %{global.variable}. Use value of Variable/JobInfo # expression: Use the contents of the variable entered in Store result in:, which is assumed to be a digit between 1 and 9.
l l 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. 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.
Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and jobinfos are not modified in any way. PlanetPress Database action task properties are as follows: Database Connection tab l l l Database group l Location: Enter either the path and name of the database or a database connection string in this box. You may click to navigate to the database and paste the database path and name automatically to this box.
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 Default width: This box is used to set the default width for all fields. It is set to 60 by default, but can be set to any value between 1 and 65535. This value is applied to all the fields in the generated file. To set different widths for each field, use the Configure Width button. Doing this disables the Default width box.
l l l l Parse normally: Select to interpret any backslashes included in the database connection string as backslashes. If this option is not selected, any backslash that is not doubled will be disregarded. Expect record set: Check if you are expecting a result from the database after executing the SQL query. If the query is expecting a record set in return and does not return one, the task will trigger an error. Database connection string: Enter a variable connection string in this box.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l l l l Search l Find: Brings up the Find dialog. l Find Again: Repeats the previous search and finds the next occurrence. l Replace: Brings up the Replace dialog. l Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Language l VBScript: Select if your script is written in VBScript. l JavaScript: Select if your script is written in Javascript. l Perl: Select if your script is written in Perl. l Python: Select if your script is written in Pyton.
another computer are stored in a sub-folder of the PlanetPress Suite Workflow Tools folder. Input Any image file that you wish to upload to the printer. Processing The currently active image data file is sent to the specified location on the printer. The image's resolution, scan orientation, and quality can be modified, depending on the selected option. All files are converted into PostScript format for storage on the printer. Output The original data file, metadata and job infos are not modified.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Set Job Infos and Variables Add Set Job Infos and Variable action tasks to set job info elements as well as custom variables.
Web services, a SOAP class of applications, expose their services via the Internet in a manner that lets other applications access them, as well as use and combine them as required. In order to access and successfully use Web services, client applications must know how to get them, what operations they support, what parameters they expect, as well as what they return. SOAP servers make this information available via WSDL (Web Service Description Language) files.
Advanced tab l l Use proxy group: Select this option to use a proxy server and to activate this group. l Proxy address: Enter the IP address or name of the proxy server. l Proxy port: Enter the number of the port to use to contact the proxy server. Use SOAP action group: Select this option to use a SOAP action and to activate this group. l SOAP action: Select the SOAP action to use. On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog.
The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Font size difference: Indicates the smallest acceptable factor between maximum and minimum font size within one line. A value of 0.60 means that with a ratio from maximum to minimum font size (in points), that is less than 0.60, two text passages are not recognized as belonging together. For example, if two text passages are formatted with different font sizes. Passage 1 with 10, passage 2 with 18 point. The ratio 0.56 is smaller than the adjusted value 0.60.
Select this option if the task is to generate a Line Printer file. This will prompt the task to perform the second phase of the process, and thus convert the XML file to a Line Printer file. If this option is not selected, the output file will thus be an XML file. The settings included in this group determine the format settings of the generated Line Printer file. Character per inch (CPI): The number of individual characters per inch on a line of text.
But when opened with PlanetPress Design or a PlanetPress Suite Workflow Tool using the ASCII emulation, the data in the generated file would look exactly like the data in the original. The same would hold true for the Channel Skip emulation. Note the following details about emulations and their options: l l l l With most emulations, if a file is split on a form feed, the form feed will not be appended to the output file.
l l l l l l Pages or records: Enter the number of pages or records before or after which the file is to be split. Enter 0 if you want the file to be split right before or after the page or record that matches the set condition. Before or after: Options from this list box are used to define exactly how the file is to be split. Select Records before if you want the file to be split a given number of records before the field that matches the set condition.
General tab l l l Split data file on emulated page group: Select to split the data file based on pages (rather than on a word found within the emulated data) and to activate the option from this group, which is used to tailor exactly how you want the page based splitting process to take place. l 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.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l When word is found: By default, the task splits the file every time the search word is found (the default value is 1). If you want the task to split the file only when the search word has been found twice, for example, enter the number 2 in this box. On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
l l l l l l Get: Click to get a static string of characters from the sample data file. If you use this button, the coordinates of the data you will select will be added to the Word is between lines and Word is between columns groups below. Word is between lines group l From and To: Enter a vertical search region defined as starting from a given line and ending at a given line.
A Page Number: If you choose “A page number” in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l l Pages per output file: Enter a number of pages after which to split the file. If you enter 3, for example, the Generic Splitter will split the file every time it has counted three pages. A 10 page file would be split in 4 files, the first three being three pages long and the last one only 1 page long.
l Choose 5 in the Pages or records box and “Records after” in this box, for example, to split the file 5 records after the record that matches the condition. Split when condition found: You may not want to split the file every time the string of characters changes, but only every other time, or every third time. If so, enter the number of times in this box. On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog.
l l l l l l l l l l l Specific word: Enter the word to use as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these. You may also use the Get Data button to get a static string of characters from the sample data file. If you use this option, the coordinates of the data you will select will be added to the Left, Right, Top and Bottom boxes below.
Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task. XML Splitter action task properties are as follows: General Tab This tab lets you choose the splitter settings for default PlanetPress Suite Workflow Tools XSLT engine.
This tab lets you choose the splitter settings for your own XSLT engine. If you want to use the default PlanetPress Suite Workflow Tools XSLT engine, click the General tab. 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.
Process Logic Tasks A process is like a flowchart. The data files captured by the input tasks become job files (see Data File and Job File) that travel down the process. Many processes include multiple process logic tasks. In the Process area, conditional branches appear with their associated condition, allowing you to understand the logic of the whole process at a glance.
l secondary branch includes a secondary input task or a Change Emulation action task, then the last emulation selected in the secondary branch will be the one used for the main branch. Backup local variables: Select if you want PlanetPress Suite Workflow Tools to use identical copies of the local variables for the main and secondary branches. When this option is not selected, the local variables that reaches the output task located at the end of the secondary branch is used for the main branch.
Common Errors Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. File Size Condition File Size conditions test the size of the job file they receive.
l l l l l Subprocess: Drop down list containing all the available subprocesses in the current configuration. Backup job file: Select if you want to use identical copies of the job file for the main process and the subprocess. Backup job information: Select if you want to use identical copies of the job file information for the main proces and subprocess. Once the subprocess completes its execution, the main process will retrieve the original job information values.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task.
l l l Language l VBScript: Select if your script is written in VBScript. l JavaScript: Select if your script is written in Javascript. l Perl: Select if your script is written in Perl. l Python: Select if your script is written in Pyton. Tools l Editor Options...: Opens the Editor Options. 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 Process: The name of the target process to send current job to. Note that startup and subprocesses are not available. You can either enter the name of a process (or use variable properties) or use the drop-down to list existing processes. On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
Host name: When you click Get info, if PlanetPress Suite Workflow Tools is able to communicate with the device, it displays its name here. l Description: When you click Get info, if PlanetPress Suite Workflow Tools is able to communicate with the device, it displays its description here. l Condition type: Select Printer Queue to test a standard printer status condition or User Defined to test a status identified using a printer specific identification code.
l l To test the presence of a string within the job file. You can, for example, search for the string “Gold member” on the first line of the job file. As another example, you could search for a variable string retrieved via a job info variable or a data selection in a given location in the job file. To compare two strings. As with the test above, this test can also be used to search for a string in a given location. The difference with this test is that it gives you comparison options.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
l Download the document and delete it from SharePoint: Download the document and delete it from the SharePoint server. Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g. http://SharePoint2003 ) or an IP address (e.g. http://192.168.1.123 ). Both http:// and https:// (secure) connections are accepted. Domain: The active directory domain for the logon credentials. This is not necessary if the SharePoint server is not part of a domain.
Laserfiche is a provider of digital document and records management systems. Laserfiche has two components: the Laserfiche server, which hosts the repository, and the Laserfiche client, which serves as the user’s interface with the repository.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
name is of type Date, you can use a Month Calendar to select the date and use only available Laserfiche variables. Laserfiche available data types: l l l l l l l Character (Char): This type may contain a string of any type of characters. This is the most flexible type of field. Use this type when you are not sure if the constraints of the other types will be appropriate. Integer: This type may contain a whole number between zero and 64,999.
Processing The task parses each level of the metadata and, for each field of the specified name it finds, a lookup is made. If a field of the same name appears on multiple levels, the lookup will happen for all fields, on all levels, individually. Output The original data file is unchanged. Metadata is updated according to the specified criteria. Task Properties General Tab l l l Excel group l Excel workbook: The full path and filename of a Microsoft® Excel® workbook (.xls or .xslx file).
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
Task Properties General tab l l Microsoft Word Document: Enter a Microsoft® Word® document or template, or click the browse button to navigate to the location of the document. The supported extensions are: *.doc, *.docx, *.dot and *.dotx. Perform Mail Merge: Check when providing a Microsoft® Word® document or template configured for mail merge. Use settings specified in document: Selected to instruct the task to use the connection string and SQL statements stored in the DOC file.
l l l l While debugging this task, the printer shows the message that the document can not be printed. This message is normal and will not appear when running a live configuration. If using a Microsoft® database such as Access® or Excel®, each software must be installed in the same version. For example, using Microsoft® Word® 2007 with a Microsoft® Access® 2003 database will cause the task to fail.
l the SharePoint Document Library. If this option is checked, the Field Information will change to "Use PlanetPress Index (PDF/A)". Field Type: The type of field as set in the SharePoint Document Library. The following SharePoint field types are supported by the SharePoint output task: l Single line of text: This type may contain a string of any type of characters. This is the most flexible type of field.
About PlanetPress Fax What is PlanetPress Fax? PlanetPress Fax is a service that can be used to output data and documents via a faxing software, such as Windows Fax (available with Windows 2000, XP, and Microsoft Windows Server™ 2003) or Symantec WinFax PRO, as well as via a faxing server, such as Captaris RightFax. Note that it is these applications that do the actual faxing.
Task Properties General tab l l l l l Host: Select the IP address of the PlanetPress Fax host to which you want the request to be sent. The Fax configuration is set in the PlanetPress Fax User Options on the target host. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box. Documents: Select a specific PlanetPress Design document if you want all the jobs to be faxed with that document. You must select a document, passtroughs are not available.
You also need to make sure that a user exists in the RightFax user list that has the same username that will be used for the PlanetPress Fax service (see section 2. PlanetPress Fax configuration). Any faxes sent to RightFax by PlanetPress fax will appear in that user's queue in the FaxUtil provided with RightFax. PlanetPress Fax configuration First step is to make sure that the PC on which PlanetPress Fax runs has access to the RightFax printer.
About PlanetPress Image What is PlanetPress Image? PlanetPress Image is a mutli-threaded service that can generate image files in PDF, JPEG and TIFF format. As the PlanetPress Suite Workflow Tools and PlanetPress Image are compliant AutoStore, DocAccel and KYOcapture, these formats can also be used. These image files can be archived and, depending on whether you use a PlanetPress Image output task or a Digital Action action task, sent via email.
Processing & Output Multiple things can happen, depending on the options chosen and the type of data this task receives: l l l If the data file and a document are selected, and "Printer Centric" mode is used, the data file is sent to the PlanetPress Image host which merges the data and document to produce output.
l l l l l l l l Color depth: Enter the color depth of the output image in bits per pixel (bpp). The color depth is measured in bits, because each pixel of the output image can be described with a varied number of bits. A higher bit number allows for more colors. It also increases the image file size. A 1-bit color depth produces monochrome images.
l l support binary files. This option also generates smaller files. l Compress text and line art: Select to compress the text and line work in the file using the Flate compression filter. Flate is a compression method that works well on elements with large areas of single colors or repeating patterns, as well as on black-and-white elements that contain repeating patterns. l Auto-rotate pages: Select to automatically rotate pages based on the orientation of the text or DSC comments.
l l l l Color images group l Color compression: Select the compression to use for the color images. Flate is a lossless compression method, so no data is lost in the process. It works well on images with large areas of single shades or repeating patterns, such as screen shots and simple images created with paint or drawing programs. JPEG removes image data and may reduce image quality, but may be suitable for continuous-tone photographs containing more detail than can be reproduced onscreen or in print.
PlanetPress Search Database tab If PlanetPress Workflow is configured to automatically update a PlanetPress Search database (see PlanetPress Image User Options), this tab can be used to override the global settings so that the task updates a different database than the one set in that global configuration. In order for the settings to work, the Add PDF to PlanetPress Search database must be checked.
Name: Value: Each generated XML file has Pdi tags wrapped around its content. This indicates the source of the enclosed XML content is the PlanetPress Suite. These tags wrap around the header information of the XML file.
Basic Features In the Jobs Options tab in the PlanetPress Image Output plugin and the Digital Action Action plugin, the Job Options dropdown allows the creation of PDFs using either PDF/X or PDF/A standards. This option is be available for PDF file outputs. The following standards are supported: l l l l l l PDF/A-1b:2005 (CMYK) PDF/A-1b:2005 (RGB) PDF/X-1a:2001 PDF/X-1a:2003 PDF/X-3:2002 PDF/X-3:2003 Other notes: l l l Digital Signature is not supported with PDF/X.
Output The output produced by this task is dependent on the options selected, it can be PDF, a Windows EMF print job, a PostScript print job or a JPG file. Note that Preflight doesn't actually produce printable or viewable output. The Preflight option does a cursory verification of the job and will generate an XML file that contains a list of all warnings and errors, including on which record and layout the warning or error occurred, and a description.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l l l l Document Origin: l Document to process: Determines where the document information is read l From Metadata: Select to use the current document available in the metadata generated by the Capture Field Processor. l From Specific ID: Select to specify an exact Document ID from the database. This document does not need to be loaded as a data file or its metadata manually obtained, as this task simply looks up the information directly in the PlanetPress Capture database.
After: If the first stroke found in the Capture Field was made later than the specified date and time, the condition becomes true. l In the last: If the first stroke found in the Capture Field was made within the specified number of Hour(s), Day(s) or Week(s) counting backwards from the moment the PGC is received, the condition becomes true. l End timestamp: Triggered when the last stroke finishes in the field.
Capture Fields Generator The Capture Fields Generator Action Task is used to generate Capture patterns in your job, which will then be printed for use with an Anoto Digital Pen. It also interacts with the Capture database and does some operations. PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently.
l l l l l Document Title group: Determines a Title for the document. This title is accessible in the Capture Database and can be used to search for a document or retrieve a list of document using other tasks. l From metadata: Use the Document Title property as set in the PlanetPress Capture section of a PlanetPress Design document's properties. l Custom: Use the title in the input field as set by the user.
Processing The PlanetPress Capture Fields Processor action task receives and processes the information sent by the Anoto digital pen and updates all the documents in the PlanetPress Capture Database using the information from the pen. Any ink in the pen is added as an EPS (image) layer on the PDF inside the Capture Database. If a specific document needs to be closed to release its pattern, this task does so.
Properties Capture Fields Processor action task properties are as follows: l l l l l PGC Name: This value will be added to the output metadata, as well as the Capture Database, to link the PGC to the document it updates. Pattern sequence group l Type: Specify from where the Pattern Sequence should be taken. l None: Do not use a Pattern Sequence. l Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database.
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. This depends on your country or region's laws, so if your implementation of Capture requires signatures to be authenticated please consult a legal advisor for more details.
Find Capture Documents The Find Capture Document task retrieves a list of pertinent information about Capture documents present in the Capture Database according to a specified set of rules. This task is most often useful as the beginning of an automated process using a series of Capture documents, for example one that removes old documents to unlock patterns. However, it can also be used as a secondary input in order to retrieve one or more documents after some operations.
Content Status: The status of the document as a whole. A document can be Empty (no ink), Partial (some ink but still open), Complete (all mandatory ink is present) or in Error (logical or process error). l Operator: The choice of the condition operator. The available choices are variable depending on the filter but will be part of the following choices: l Equal: Inclusive filter, where anything equal (either by string or numeric comparison) is included in the results.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l l l Document Type group l Get all documents: Get all the documents that have been updated, according to the metadata. l Get closed documents only: Get only the documents that have been closed in this process, according to the metadata. Close document after retrieval: Once the task has retrieved the document from the Capture database, the document will be closed even if it is incomplete.
l PDF page size: Choose the page size of the output PDF. The default size is A2, and changing the format does not scale the digital ink. Ink appearing outsize of the selected page size will not be visible. This task was built using a custom plugin system and does not display the On Error tab in the regular view. To access the On Error tab, right-click on the task and select "Advanced Properties...".
Metadata Tasks Metadata tasks regroups plug-ins that can create or update metadata for a job file. Metatdata is a hierarchical structure describing a print job. It is composed of 5 basic levels, from outer to inner: Job, Set, Document, Datapage, and Page. Create Metadata Creates all the metadata that is either the result of the merging between a data file and a PlanetPress Design document, or the information about a PDF File. Input Either a data file in any supported Emulation, or a PDF File.
On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Metadata Fields Management The Metadata Fields Management task can be used to add new fields into your metadata, either for every element or through conditions.
l interprets it as a thousand while interpreting 1.000 (with a dot separator), as one. l .: Treat every value with the dot (".") decimal separator. Commas (",") are treated as thousand separator. l ,: Treat every value with the comma (",") decimal separator. Dots (".") are treated as thousand separator. Condition: Define criteria for the Metadata Field Management action execution. The condition must be TRUE for the action to execute.
Output: This task outputs the exact same data that was given to it. Its metadata will either be missing (Delete Metadata), Changed (Load Metadata) or the same (Save Metadata). The Metadata Management Action Task properties are as follows: l l l Chose an action group l Load metadata file: Loads an external metadata file that was previously saved. This can be useful in Error processes if you have previously saved the Metadata to file (ErrorBin outputs do not transfer Metadata).
l l l Filter levels: Rules for unselecting nodes at the Group, Document or Data page level. Note that currently unselected nodes are ignored. l Group: Select the metadata Group nodes (the nodes only) based on the specified rule(s). l Document: Select the metadata Document nodes (the nodes only) based on the specified rule(s). l Datapage: Select the metadata Datapage nodes (the nodes only) based on the specified rule(s). Rules: Define according to which criteria the action must to be performed.
l l Document: Create a new Document level. Note: Attributes and Fields are deleted for all new Document levels created as well as existing Groups. Group: Create a new Group level. Note: Attributes and Fields are deleted for all new Group levels created. l Delimiter defines if the Condition parameter is triggering the beginning or the end of a Group or Document. If the delimiter option is set to None, the action is not performed.
l Document, and this value is set to 5, a 100 document job file will be divided into 5 sequences of 20 documents each. The following rule: Determine if a new sequence starts or if the current one ends. For each metadata level, the current value of the specified metadata attribute/field is compared with the one in memory. If they are different, either a new sequence starts or the current sequence is ended. The next sequence starts with the next metadata level being processed.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Metadata to PDI The Metadata to PDI Task takes the active metadata and generates a PDI using the information in that metadata.
current data file. The task rearranges the metadata accordingly, which greatly facilitates the set up of the N-Up functionality in the design tool, especially when the solution includes duplex printing with variable data on both sides.
l l Metadata Sequencer Input from SharePoint Conditions are expressed using the following syntax: The and options represent the values for comparison. The interface displays clickable links as the following: l l l Click to set expression Choose operator Click to set expression The left expression () can either be a custom list or a parsable edit field.
3. Define condition B. 4. Select condition B and choose Add Sub Condition. This will indent condition B and allow to define the condition C. Specify the logical operator OR. 5. Define condition C. 6. Right click on the first AND operator (the one right after condition A) and choose Add Condition. Specify the logical operator AND. This will create a condition at the same level as A. 7. Define condition D.
All In One The All In One action task is a combination of 4 different OL Connect tasks within a single one. This makes creating Print content faster and more easily, as the task is optimized for this specific purpose with less data exchanged with the server as well as multi-threading support. The task is build with 3 tabs that represent the 3 main steps of the creation of a Print Output: Data Mapping, Content Creation and Output Creation.
l PDF/VT with Content Creation: Expects a PDF/VT file as an input and executes basic data mapping on the file. This is the same as using the passthrough option in the Create Record Set task. Content Items are created automatically. When this source is selected, the Content Creation tab is disabled. Content Creation Tab The Content Creation tab generates Content Items either by merging a Record Set with a Template, or by processing a PDF/VT file into individual content items.
Output Tasks Output tasks are exits from PlanetPress Suite Workflow Tools processes. They can be used to send data to specific devices, such as printers, applications, such as email software, or locations, such as folders. A single process can include multiple branches, each one terminated by an output task, and so a single process may generate output via a variety of output tasks.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
If no metadata file is found, the from/to page settings from the job and the printer's properties from the task configuration are used, with the job's settings overriding those of the printer where applicable.If a metadata file is found, it is used to indicate which pages are printed and in which order. Any other metadata is ignored. Known issue: If a data file with metadata is resubmitted to such a process, the from/to page values set by the user in the Resubmit interface are ignored.
given document version number, you can use an Add Document action task instead of a Printer Queue output, and then use an Add/Remove Text action task to add a version number in the document trigger (for more information, refer to the Control Versions of a Document section of the PlanetPress Design User Guide). Advanced tab l l l l l l Copies: Enter the number of copies to be printed outputs. Since this is a variable property box, you may enter a fixed value or use a data selection.
In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PlanetPress Workflow is running, so emails are not sent out automatically. To correct this, make sure to logon to Windows on the PlanetPress server using the same login that PlanetPress is using, and open Outlook before starting the PlanetPress services. You could also use a startup process to start Outlook before the rest of the services. Input Any data file.
l l l l Zip mode: Select how you want the files checked in the Attach box to be zipped. Select Zip individually to have PlanetPress Suite Workflow Tools create a zip file for each file. Select Archive and Zip if you prefer to have one zip file that contains all the attached files. Zip file name: Enter the name of the one zip file that will be created if the Archive and Zip option was selected in the Attach box (this box is otherwise not enabled).
Send to Folder Send to Folder output tasks send the files they receive to a local folder. They perform the same function as Send to Folder action tasks, with the only difference being that in this case, 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.
A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol. The payload of the SOAP packet is an XML document that specifies the call being made and the parameters being passed. Web services, a SOAP class of applications, expose their services via the Internet in a manner that lets other applications access them, as well as use and combine them as required.
Arguments box. You should use this option when the SOAP Client plugin is not able to fully support the syntax of the response. Advanced tab l l Use proxy group: Select this option to use a proxy server and to activate this group. l Proxy address: Enter the IP address or name of the proxy server. l Proxy port: Enter the number of the port to use to contact the proxy server. Use SOAP action group: Select this option to use a SOAP action and to activate this group.
Contextual Menu In any variable properties box, you may use the contextual (right-click) menu to add variables and control characters, as well as to get data and make data selections. The lower part of the contextual menu is divided into 4 items that provide variable properties: l l l l l l Variables l System: Contains system variables, also called Standard Variables. l Job Info: Contains Job Info variables from %1 to %9 l Local Variables: Contains a list of local variables in this process.
configuration in a PlanetPress Production or Office installation up upgrading PlanetPress Watch to PlanetPress Production or Office and re-opening the configuration will restore the plug-ins and their properties. Masks What is a mask? A file name that includes characters meant to be replaced at runtime is referred to as a mask. Masks can be used in many edit boxes and can be used, for instance, to select multiple files. File selection is typically limited by fixed characters or special wildcard characters.
Special Workflow Types Special Workflow Types The PlanetPress Suite Workflow Tool supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility. However, some types of processes like PDF, HTTP and SOAP are important enough to pay some attention to them. This chapter will describe each of these special workflow types and give at least one example of an implementation that uses them.
Special Workflow Types l l 20,000 Patterns PlanetPress Capture Implementation Restrictions There are also 2 external tools that are used to communicate the pen's data to PlanetPress Workflow: l l Anoto penDirector PlanetPress Mobile Application The PlanetPress Capture workflow 1. Creating a Capture-Ready document This is done when creating your PlanetPress Design document.
Special Workflow Types directly convert a PGC file to a blank PDF file containing the ink data as an EPS layer. This is useful when, for example, data is received for a document that's already been closed. l l l The Input Error Bin input task is triggered when the process sends data to the error process. A PGC to PDF Converter task converts the PGC to a PDF Any existing output is used here, for example an email notification.
Special Workflow Types Client/Server Architecture A multi-server setup where more then one PlanetPress Production server are connected as clients to a single PlanetPress Production server which has a Capture Database. In this architecture, the Server contains the licenses for the pens, however the Client contains the database of documents and patterns. The Clients communicate with the server to authenticate pens.
Special Workflow Types Pidget Type of PlanetPress Capture object. Page element used to give instructions to the Anoto pen, as opposed to recording ink. PlanetPress Capture Database A database containing the list of patterns, sequences, registered pens and documents. The Capture Database can be used by a single server, or by multiple servers in a Client/Server architecture. Session The time spent by the pen between events that trigger a new session.
Special Workflow Types l l 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. l In the event where 2 requests are made simultaneously on the same record, MySQL will queue one of the requests and execute it once the first one is done.
Special Workflow Types the security concerns regarding Capture are external to it. This means the security that is implemented both on your network and physical premises are critical to the security of your PlanetPress implementation.
Special Workflow Types In a typical PlanetPress Capture implementation, a process in PlanetPress Production generates output (generally, this output is directly printed) and, at the same time, will "lock" one pattern for each page that it generates, if that page contains a pattern. PlanetPress Production also stores a copy of each document in the Capture Database, in PDF format.
Special Workflow Types 2) Using Pattern Sequences In the event where a single location generates all the patterns and this output *can* be split into multiple logical zones, Pattern Sequences can be used. A Pattern Sequence is basically a "tag" that is added after the pattern's identification (Pattern ID). When a Pattern Sequence is used, each Pattern Sequence can re-use each of the 20,000 available patterns.
Special Workflow Types Because the "old" document relates (presumably) to a different client, this means the "current" document has invalid information. This can be prevented through simple methods such as printing a date on each sheet and ensuring that users never sign a document that is older than a certain time, for example 48 hours. These sheets should simply be destroyed. Second, contamination can happen in method 1) above if a pen or paper is moved from one location to another.
Special Workflow Types The communication between penDirector and PlanetPress Production is either through a folder transfer or HTTP Post communication. To configure this communication: 1. 2. 3. 4. Open penDirector setup by right-clicking on its icon in the Windows System Tray, and selecting penDispatcher. Double-click on the PlanetPress Capture entry. Change the PGC Storage folder or PGC POST URL settings to your liking. Click OK, then OK again.
Special Workflow Types BlueTooth, while the connectivity between the mobile phone and PlanetPress Production is through the currently active data plan (either wifi or the cell phone company's data plan, such as 3G). Access the PlanetPress Mobile User Guide PlanetPress Capture Implementation Restrictions This document describes the limitations of the Anoto Digital Pen & Paper Technology, especially in regards to using it within a PlanetPress Suite implementation.
Special Workflow Types Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
Special Workflow Types Knowing this, the best practice when creating fields is that they have, at the very least, a 7mm margin on each size of the actual area you want to capture from. For example, an effective 30mm wide pattern will actually be 44mm wide using these margins. The margin should be for both the vertical size and the horizontal size.
Special Workflow Types The second process is the PGC Handling process. It receives data from the Anoto Digital pen, updates the Capture database and releases patterns as appropriate. PGC Handling Process l l l l HTTP Server Input or Folder Capture input task Capture Fields Processor Get Capture Document Archive or Print output Capture Post Processing Workflow Though the Basic Functional Capture Workflow is minimal functional one, it will most likely not be enough for most actual implementations.
Special Workflow Types After retrieving information from the Capture database There are two basic ways in which the Find Capture Documents task can be used. First, in an automated process that runs at specified intervals. For example, the following process which sends a daily report of all incomplete and "in error" documents to an agent who would presumably take action on each document through the document manager.
Special Workflow Types Workflow. The example is too complex to display as images in this guide, so it is rather available for download. It infers two different files: l l Capture Web Manager Workflow Configuration (PW7) Capture Web Manager PlanetPress Design Document (PP7) This example is compatible with PlanetPress Suite 7.4 and higher and will not work in older versions. Installation 1. 2. 3. 4. 5. 6. Download both resource files Create a folder on your disk called c:\planetpress Open the invoice.
Special Workflow Types l l HTML Form Action: An HTML Form in the browser that may contain text and attached files can be filled and sent to a process with the HTTP Server Input Task. HTTP Data Submission: A custom application or a server sends the request to PlanetPress Suite Workflow Tools using either a POST or GET command. The application or server then waits for a response from PlanetPress Suite Workflow Tools.
Special Workflow Types l l As soon as possible: This option needs to be checked, otherwise requests will not be handled as they come in (this option is meant to be used on scheduled processes that run at intervals). Polling Interval (sec): This option determines how much time the HTTP Server Input waits between the moment it finishes processing a request and the moment it picks up a new request. This should be put at 0 in order to process requests as soon as possible, meaning immediately.
Special Workflow Types This is actually the most used way of returning a response: Generate an HTML file using either Create File or Load External File, then delete the file as a last output. The HTML is thus returned to the client.
Special Workflow Types Task Breakdown l l l l The HTTP Server Input task receives a request through the /getinvoice HTTP Action. Because this task either returns an HTML page with an error message or a PDF, the MIME type is Auto-Detect. It checks whether the invoice request exists by checking if the size of the file is less than 1kb using File Size Condition. The condition returns "true" if the file is not found: c:\planetpress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum[1]',Value,Ke
Special Workflow Types l l l When the condition is false, it means that there is something in the Full Name field. In this case, we know that the form was filled and submitted back to the process, and we handle the request as such. First, we add the full name, email and company information to job informations, in order for them to be available for the rest of the process. Then, we have a small condition that verifies if the user checked the "Newsletter" box. If so, the conditional branch is triggered.
Special Workflow Types Examples l Daily Sales Report from PDF Files Daily Sales Report from PDF Files This workflow makes heavy use of both PDF Tools and Metadata, and assume that you are using PlanetPress Office or PlanetPress Production version 7.3 or higher. This single process workflow generates a daily sales report for any sales rep inside of a company which made at least one sale.
Printer Queues and Documents Printer Queues and Documents This section delves into the subjects of PlanetPress Suite Workflow Tools printer queues and PlanetPress Design documents. PlanetPress Suite Workflow Tools Printer Queues The printer queues displayed in the Configuration Components Pane of the PlanetPress Suite Workflow Tools Configuration program are not to be confused with Windows printer queues.
Printer Queues and Documents Frequently Used Printer Control Characters Character name: Character code: Typical use in printing context: End-Of-Job \004 Indicates the end of a print job Backspace \b Moves a character space backwards Horizontal Tab \t Adds a horizontal tab Line Feed \012 Moves to the next line Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape
Printer Queues and Documents LPR output printer queue properties are as follows: General tab l l l l l Printer address: Enter the IP address or host name of the printer receiving LPR jobs. Queue name: Enter the printer queue name. Based on printer and network requirements, this property may not be required. Data type: Select the proper data type. Select (l) Binary data if the job file is a standard binary file.
Printer Queues and Documents l l l l FTP Port: Enter the FTP port to use. This option is disabled if Use FTP Client default port number is checked. The port should always correspond with the server's port number. Directory: Enter the directory to which the print jobs are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server. File name: Enter the name under which the print jobs will be saved.
Printer Queues and Documents l l l l Add: Click to add a new command to the list displayed in the Commands box. You must then edit the new command’s description and value. Note that new commands are shared by all printer queues. Delete: Click to remove a command from the Commands box. Command description: Use this box to edit the description of the command currently selected in the Commands box. Command value: Use this box to edit the code of the command currently selected in the Commands box.
Printer Queues and Documents A PlanetPress Document Package, or PTZ, is a file format consisting of a ZIP file, which contains all the document's data and resources. With a PTZ, resources are extracted and uncompressed only once when your PlanetPress Suite Workflow Tools receives the file.
Printer Queues and Documents l l When the server running PlanetPress Suite Workflow Tools sends a PlanetPress Design document along with the data to the printer, it adds a trigger before the document (trigger+document+data). When the server running PlanetPress Suite Workflow Tools only sends the data to the printer, because the document is already present on the printer, it adds a trigger before the data (trigger+data).
Printer Queues and Documents is created, end-users can install it on their own computer by going through the same steps they would when installing a new remote printer in their Operating System. By default, connecting to a shared printer will automatically result in the Objectif Lune Printer Driver being downloaded to the connecting host.
Printer Queues and Documents Note that steps 6-8 can be performed at any time, even if PlanetPress Watch/Office/Production is not yet started. This is because every Windows printer queue using Objectif Lune Printer Driver (PS) is paused by default. Once the service has started, it captures every queued job. PDF Creation Parameters PDF files retrieved from a Windows print queue using Objectif Lune Printer Driver (PS) have the following properties: l l l PDF 1.
Printer Queues and Documents l Optimized PostScript Stream can be used in any version or flavor of PlanetPress Suite. However, if used in PlanetPress Watch or PlanetPress Office, a license must be available for the printer or the output will contain a watermark. In PlanetPress Production, you can output to any PostScript printer without a watermark. Windows Printer Queue: This run mode is only available through the Print Using a Windows Driver output task, and uses printers that are installed in Windows.
Debugging and Error Handling Debugging and Error Handling This chapter touches on two subjects that are intrinsically linked, though their use is different. Debugging is the act of running through your process, either step by step or as a whole, directly from the PlanetPress Suite Workflow Configuration Tool, in order to detect and resolve issues with your process.
Debugging and Error Handling While stepping through a process (using Step, not Run): l l l l l l l l l l l Double-click on any task to change its properties. If you change the properties of a task before you step through it, those new properties will be used when the task is executed. Note that you cannot modify the process itself while in debug mode (you cannot add, delete or move tasks, change branches and conditions, etc). Click on Skip to ignore the next task or branch and go to the next one.
Debugging and Error Handling l Instead of skipping through each task, use the Run from here or Step from here options, either from the Debug tab or by right-clicking on the task where you want to start the process. Once you have created and fully debugged all your processes, you will be ready to send it to the PlanetPress Workflow Tools service. See Saving and Sending a Configuration.
Debugging and Error Handling 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. Or you could update a database with an error status so that it appears on a customer's online order. You could also zip the order up and send it to an administrator, while simultaneously advising the person that sent the job that it failed.
Debugging and Error Handling l l l From the PlanetPress Suite Workflow Tools Configuration software, press CTRL+SHIFT+ALT+F4 simultaneously. The PlanetPress Suite Workflow working folders are opened. Double-click on the folder called Log. There are multiple logs displayed here, including: l ppwYYYYMMDD.log - PlanetPress Suite Workflow Tools logs, including the year, month and day of the log (from midnight to midnight). The PlanetPress Image and PlanetPress Fax logs are available in different folders.
Debugging and Error Handling 3. From the Task index box, select the index level to which you want the data to be sent. The index is the position in the process where you want to submit the job file. 4. In the list of backed up input files, select the file you want to resubmit. 5. Using the From page and To page boxes, select the data pages that you want to resubmit. If you want to resubmit all the data pages from the selected input file, enter 0 in both boxes. 6. Click Send to resubmit the data. 7.
Using Scripts Using Scripts Scripts can be used to perform various operations, such as to manipulate data, for example. PlanetPress Suite Workflow Tools can perform scripts written in four different scripting languages and also provides an interface for editing scripts. While this chapter provides some very useful and detailed information about scripting within PlanetPress Workflow Tools, its focus is to inform you about the features, variables and functions unique to this environment.
Using Scripts Use the Editor The Script Editor and XSLT Editor share most of the same commands and functions. You can open the Script Editor using the Open Editor button both from the Run Script Properties dialog box and from the Open XSLT Properties dialog box. When you do so, the script currently displayed in the dialog box is pasted to the editor’s scripting box. For information on the available editor options, refer to Editor Options.
Using Scripts Whole words only: Select to limit the search to complete words matching the text in the Text to find box. Whole words are defined as strings that have a space or punctuation before and after the word. Regular expressions: Select to treat the regular expressions of the scripting language as text to search. If you clear this option, the regular expressions of the language are not included in the search. Global: Select to search the entire content of the script.
Using Scripts text, you move forward only within the selection. When the search reaches the end of the script or script selection, the search finishes. It does not loop back to the beginning. Backward: Select to search the script backward, from the location of the cursor or from the end of the script, depending on what you choose for the origin (From cursor begins where the cursor is currently located in the script, Entire scope begins from the beginning of the script or beginning of script selection).
Using Scripts Jump to Bookmarks Before you can jump to bookmarks, you must add bookmarks to specific lines in your script (see Toggle Bookmarks). To jump to a bookmark: l From the editor’s pop-up menu, choose Go To Bookmark and a given bookmark number. If the bookmark you selected was displayed on a line, the cursor jumps to that line. SOAP Server API Reference PlanetPress Suite offers a SOAP server API Reference allowing jobs to be submitted from third party application using the SOAP protocol.
Using Scripts l ResultFile – base64Binary. If Success is different than 0 or the ReturnJobFile was set to False in the initial call, no file is returned. Otherwise, ResultFile contains the job file, as it existed at the completion of the PlanetPress Suite process (for instance, if the process creates a PDF and sets it as the current job file, the PDF is the file that gets returned to the calling SOAP client).
Using Scripts GetProcessList (Username, Password) : GetProcessListResult Description The GetProcessList function allows SOAP clients to request the list of available PlanetPress Suite processes, based on their authentication credentials. Parameters l l Username – String containing the username. Password – String containing the password. This value is case sensitive.
Using Scripts l l l TaskName – String containing the name of the task TaskIndex – Integer : 1 based index of the task. TaskDepth – Integer : 1 based depth of the task. Notes l The TaskNames array will be sorted by the execution order of the process with the primary input of the process having an index of 1.
Using Scripts l l l l l VariableList – Array of complex type, containing pairs of variable names and variables value. The list also contains the JobInfo variables. l VariableName – String l VariableValue – String ProcessName – String - Name of the PlanetPress Suite process. TaskIndex – Integer - 1 based index of the task where the resubmission should start. FirstPage – Integer - First page of data to process. LastPage – Integer - Last page of data to process.
Using Scripts Variable Name Description Example Usage (VBScript) Example Usage: str = Watch.getjobinfo(9) Watch.GetVariable Retrieves the content of a local or global variable by name. Example Usage: str = Watch.getvariable("Varname") Watch.ExpandString Retrieves the content of any Workflow string, containing any variable available to Watch, including data selections. Example Usage: watchDate = Watch.
Using Scripts Perl $Watch->ShowMessage("test message"); Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line. The program's execution will be directed by the appropriate flags specified as this method's parameters. Syntax Watch.ExecuteExternalProgram const CommandLine: WideString; const WorkingDir: WideString; ShowFlags: Integer; WaitForTerminate: WordBool: integer; const CommandLine:The command line to execute as a widestring.
Using Scripts within it. If your script writes to this file, the modified contents will be used by the next plugin in your process. Example In the following example, GetJobFileName() retrieves the name of the job file, which is then logged using Watch.Log. VBScript Dim s s = Watch.GetJobFileName Watch.Log "The job filename is: " + s, 3 Javascript var s; s = Watch.GetJobFilename(); Watch.Log("The job filename is: " + s, 3); Python s = Watch.GetJobFileName() Watch.
Using Scripts 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", "Desired value") Watch.SetVariable("global.MyVariable", "Desired value") Perl $Watch->SetVariable("MyVariable", "Desired value"); $Watch->SetVariable("global.MyVariable", "Desired value"); Watch.ExpandString Provides access to the emulated job file and to all variables. This function returns a string that is the expanded version of the input string. 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
