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 Task Comments Pane 63 The Message Area Pane 63 Customizing the Program Window 64 Dock and Undock Areas of the Program Window 64 Show or Hide Areas of the Program Window 65 Combine and Attach Areas 65 Resize the Program Window Areas 69 Preferences 69 General User Options 70 Object Inspector User Options 70 Configuration Compo
Table of Content Job Info Variables 101 Standard Variables 102 Available Standard Variables The %i Loop Count Variable Data in PlanetPress Suite Workflow Tools 102 103 105 Choosing a Sample Data File 105 The Data Selector 105 Metadata tab 107 Metadata 108 Using the Metadata Data Selector 113 Using the File Viewer 114 Choosing a Database Type Sample Data File 114 Data Selections in PlanetPress Workflow Tools 114 Text-Based Data Selections 114 Database Data Selections 115 PDF Data
Table of Content Create PDF 154 Decompress File(s) 156 Digital Action 157 Download to Printer 161 External Program 163 Load External File 164 Mathematical Operations 165 Open XSLT 166 PlanetPress Database 167 Rename 170 Run Script 171 Send Images to Printer 173 Search and Replace 174 Send to Folder 175 Set Job Infos and Variables 176 SOAP Client Plug-in 177 Standard Filter 179 Translator 180 Windows Print Converter 181 Data Splitters 183 About Using Emulations with S
Table of Content About PlanetPress Fax 221 PlanetPress Fax 221 Captaris RightFax Configuration 222 About PlanetPress Image 225 PlanetPress Image 225 Overview of the PDF/A and PDF/X Standards 231 PrintShop Mail 232 PlanetPress Capture 234 Capture Condition 234 Capture Fields Generator 237 Capture Fields Processor 239 Capture PGC Splitter 241 Find Capture Documents 242 Get Capture Document 245 PGC to PDF Converter 246 Extract ICR Data 247 Metadata Tasks 249 Create Metadata
Table of Content PDF Workflow 279 PlanetPress Capture Workflow 279 HTTP Server workflow 279 PlanetPress Capture Workflow 279 The PlanetPress Capture workflow 280 The Examples 281 PlanetPress Capture Glossary 281 General Considerations 283 Security Considerations 284 20,000 Patterns 285 THE NUMBERS 285 EXAMPLE 286 EXTENDING 286 CONTAMINATION 287 SAFEGUARDS 288 CONCLUSION 288 Anoto penDirector 288 PlanetPress Mobile Application 289 PlanetPress Capture Implementation Restri
Table of Content HTTP Brochure Request 305 Resources 305 Installation 305 Task Breakdown 305 PDF Workflow 306 Examples 307 Daily Sales Report from PDF Files 307 Resources 307 Task Breakdown 307 Printer Queues and Documents 309 PlanetPress Suite Workflow Tools Printer Queues 309 Shared Printer Queue Properties 309 Windows Output Printer Queue 310 LPR Output Printer Queue 310 FTP Output Printer Queue 311 Send to Folder Printer Queue 312 PlanetPress Suite Workflow Tools and Pla
Table of Content SOAP API - GetProcessTaskList 333 SOAP API - GetSOAPProcessList 334 SOAP API - PostJobInfoStruc 334 SOAP API - SubmitJobInfStruc 335 The Watch Object 335 Watch.ShowMessage 336 Watch.ExecuteExternalProgram 337 Watch.GetJobFileName 337 Watch.GetOriginalFileName 338 Watch.GetMetadataFilename 338 Watch.InputBox 339 Watch.GetJobInfo 340 Watch.SetJobInfo 340 Watch.GetVariable 341 Watch.SetVariable 341 Watch.ExpandString 342 Watch.Log 342 Watch.
Overview Overview This PDF documentation covers version 7.5. 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 l l Click Tools in the PlanetPress Suite Ribbon. Click Start Service in the Services Status group. A progress bar is displayed while your PlanetPress Suite Workflow Tools is being started. 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 Cut, Copy, Paste: Controls the clipboard. l Delete: Deletes the subprocess from the configuration. l Rename: Renames the subprocess. l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties for error handling. Global Variables: Displays a list of variables that are shared between all your processes.
The PlanetPress Suite Workflow Tools Configuration Program PlanetPress Suite Workflow Tools Process Options properties are as follows: General tab l l l l l l l l l l l Active: Select to make the process active. 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.
The PlanetPress Suite Workflow Tools Configuration Program In the Time Grid, a blue block will indicate that the process is active within that time block. While blocks mean the process will not be active. l 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.
The PlanetPress Suite Workflow Tools Configuration Program you select a certain number of blocks in the Time Grid and then use the shift+click or drag method, blocks that are on will turn off. Changes made to the system time can have adverse effects on the processes managed by PlanetPress Suite Workflow Tools.
The PlanetPress Suite Workflow Tools Configuration Program Manipulate Local Variables For information about Global Variables see Global Variables. Local Variables are set at the level of the Process and are not shared with any other process or instance of that process. 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}).
The PlanetPress Suite Workflow Tools Configuration Program l Send your configuration. If you try to send a configuration that contains only inactive processes, the PlanetPress Suite Workflow Tools Configuration program will ask you to confirm the operation (this can be changed in the Notification User Options).
The PlanetPress Suite Workflow Tools Configuration Program 2. Enter the new value for your global variable 3. Click OK to save the new value. Shared tasks These procedures can be used on both local and global variables. To delete a variable l Right-click on the variable name in the Configuration Components Area and click Delete. To rename a variable: l l l Right-click on the variable name in the Configuration Components Area.
The PlanetPress Suite Workflow Tools Configuration Program l l l l Workflow Tools Configuration. It may have a PTK extension (if it has been sent to PlanetPress Workflow from PlanetPress Design), or a PS extension (if it is printer-resident). Version: The version of the PlanetPress Suite Workflow Tools in which the document was originally created. Printerresident documents are identified as such. Document name: The name of the document as entered in PlanetPress Design.
The PlanetPress Suite Workflow Tools Configuration Program Design Document in the Documents section of the Configuration Components. To set an attached data file as a sample data file in a process: 1. Make sure the Documents section is visible by clicking the button if it appears. 2. Expand the document (name.ptk) by clicking the button. 3. Right-click on the data file, then click Set as sample data file. To view an attached data file: 1.
The PlanetPress Suite Workflow Tools Configuration Program Those documents that are not available on your local PlanetPress Suite Workflow Tools server, but that are either available on printers or on other PlanetPress Suite Workflow Tools servers must added to the list, otherwise you will not be able to use them in your PlanetPress Suite Workflow Tools configuration. To add a resident document in the Configuration Components Pane: 1.
The PlanetPress Suite Workflow Tools Configuration Program If you simply wish to change the order in which objects appear in a category or group of the Configuration Components, refer to Reorder Objects in the Configuration Components Pane. As you drag a configuration component, your mouse cursor will change to indicate the action you are performing, as well as whether the location where the cursor is can accept the configuration component you are dragging.
The PlanetPress Suite Workflow Tools Configuration Program Moving and Copying Details: l l l l l l When moving configuration components, a horizontal line appears where the component will be dropped if the location is valid. At the end of this line will be small "dents". If these dents are on top of the line, the component will be placed at the same level (group) as the component before it.
The PlanetPress Suite Workflow Tools Configuration Program appearing within a group. You can also use the clipboard controls and drag & drop methods described in Using the Clipboard and Drag & Drop to copy and move objects and tasks. To reorder selected objects in the Configuration Components Pane: 1. Click an object or group. 2.
The PlanetPress Suite Workflow Tools Configuration Program 1. Select multiple objects that are not part of a group 2. Press CTRL+G. A new group is added and the selected items are moved to that new group. To ungroup selected objects: 1. Select objects in a group. 2. Press CTRL+U.
The PlanetPress Suite Workflow Tools Configuration Program Zoom In or Out within Process Area You can do a zoom out in the PlanetPress Suite Process area to see more tasks at the same time. In zoom out mode, you can perform the exact same functions as in normal view mode. To zoom in or out on the PlanetPress Suite Process Area: l l Click on the View tab of the Ribbon. Click on Zoom Out in the Navigate group to zoom out, and Zoom In to zoom in.
The PlanetPress Suite Workflow Tools Configuration Program To edit a task: 1. In the PlanetPress Suite Workflow Tools Process area, double-click the task icon. A dialog box containing the available task properties is displayed. 2. Edit the task properties as required. Click specific tabs to see all the properties associated with the task. 3. Click OK to close the dialog box and save the new properties.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l Send to Process: Check this option to send the job file to an error management process. Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task. Action Group: This group is disabled in the initial input tasks and defaults to Stop Process.
The PlanetPress Suite Workflow Tools Configuration Program Instead of pasting the actual task or branch, you can simply paste the properties of the task or branch. To copy and paste Properties of a task or branch: 1. Copy or Cut a task or branch of which you want to have the properties. 2. Select the task or branch where you want to paste the properties 3. From the Home tab in the Ribbon, choose Paste Properties (or Right-Click and select Paste Properties from the drop-down menu).
The PlanetPress Suite Workflow Tools Configuration Program You cannot drag a task or branch over an initial input task. Any input task that is dragged and dropped over an unknown initial input task will replace it. The same is true of an output task that is dragged and dropped over an unknown output task. Ignoring Tasks and Branches PlanetPress Suite Workflow Tools lets you ignore individual tasks, branches or conditions.
The PlanetPress Suite Workflow Tools Configuration Program l l l Click on the %o entry in the document list Type the variable properties or use the right-click menu to insert the correct variable properties. Click OK on the dialog. At runtime, if PlanetPress Workflow Tools cannot find the document name generated by those variables, the task will fail. Highlight a Task or Branch The Highlight command lets you toggle the background color of selected tasks and branches.
The PlanetPress Suite Workflow Tools Configuration Program The default categories lists plug-ins according to what type of task each achieve.
The PlanetPress Suite Workflow Tools Configuration Program To edit properties of processes, documents, and printers in the Object Inspector: l l l In the Configuration Components Pane, select a process, a document (either a document in the Documents category or a document assigned to a printer queue) or a printer queue. The selected object’s properties appear in the Object Inspector. In the Object Inspector, click an editable property.
The PlanetPress Suite Workflow Tools Configuration Program Click in the box on the left to edit the expression and add any variable properties or static text you want, and click outside of the box to save it. Once saved, the Value column displays the expression's result.
The PlanetPress Suite Workflow Tools Configuration Program The Message Area will only display information while running in Debug mode. It does not display information from other running services, and will not display the log of any process running in a live configuration (submitted to the PlanetPress Suite Workflow Tools Service). To learn more about debugging a process, refer to Debugging and Error Handling.
The PlanetPress Suite Workflow Tools Configuration Program l Double-click either a title bar (separate or attached areas) or a tab (combined areas) displaying the name of the Configuration Components Pane, the Object Inspector or the Messages area. The area will jump from an undocked to a docked position and vice-versa. Show or Hide Areas of the Program Window You can choose to hide or display any of the customizable areas in the PlanetPress Workflow Tools program.
The PlanetPress Suite Workflow Tools Configuration Program when the shape of a tab appears at the bottom of the rectangle. To switch between combined area: l At the bottom of the combined area, click the tab of the area you want to bring to the top. If all the tabs are not displayed, use the left and right arrows to navigate between them. The left and right arrows lets you show hidden tabs.
The PlanetPress Suite Workflow Tools Configuration Program As you drag, a rectangle is displayed to show the landing position. Drag around to the edges of another area and release the mouse button when the rectangle appears to the left or right, or 2. above or below the other area. The rectangle should not display a tab at its bottom, otherwise the areas will not be attached but rather combined.
The PlanetPress Suite Workflow Tools Configuration Program A) Click to maximize this area. B) Click to restore this currently maximized area. C) Click to maximize this area. D) Click to restore this currently maximized area.
The PlanetPress Suite Workflow Tools Configuration Program l Do one of the following: l Click the title bar displaying the name of the attached area you want to take out and move the mouse pointer so as to drag the area away from the group. As you drag, a rectangle is displayed to show the landing position. Release the mouse button when the rectangle is away from the group. l Double-click the title bar of the area you want to take out. The area will jump outside of the group.
The PlanetPress Suite Workflow Tools Configuration Program l l The PlanetPress Suite Services dialog lets you select the account that the PlanetPress Suite Workflow Tools Service uses to communicate on the server and the network. See PlanetPress Suite Workflow Tools Service Logon. You can change the appearance of the Run Script and XSLT Editor through the Editor Options dialog.
The PlanetPress Suite Workflow Tools Configuration Program Configuration Components Pane User Options The available Configuration Components Pane user options are as follows: Colors group l This window lets you set the color of individual Configuration Components Pane elements. To change the color of a given element, select it in the list box above and then choose a color from the drop-down list below.
The PlanetPress Suite Workflow Tools Configuration Program l l l l l l l l l l l l l l l l l l Group of documents deletion: Select to have PlanetPress Workflow prompt for confirmation when deleting a group of documents from the Configuration Components Pane. Empty group deletion: Select to have PlanetPress Workflow prompt for confirmation to delete a group when you remove the last of its member objects.
The PlanetPress Suite Workflow Tools Configuration Program l l l l Prompt on Form Refresh: Select to have PlanetPress Workflow prompt for confirmation when recompiling the PostScript (PSx) version of a PlanetPress Document. Refreshing PlanetPress Documents that are currently in use can lead to unexpected results.
The PlanetPress Suite Workflow Tools Configuration Program 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:\, to absolute paths referenced from a server in the format “\\servername\shared-resource-pathname”. When you select this option, the next time you configure a task after editing properties and clicking OK in its properties dialog box, entered paths are expanded to UNC format.
The PlanetPress Suite Workflow Tools Configuration Program 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. l Document ID: Search using the Document ID, a unique and automatic identifier attributed to each document by the Capture Field Generator task. l Document Title: Search in document title as specified in the Capture Field Generator task.
The PlanetPress Suite Workflow Tools Configuration Program 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 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. l The recommended ideal setup is a dedicated SQL Server PC, accessed by PlanetPress Workflow through an ODBC connection on the local network. Microsoft Access l Database file (mdb) must be local to the PlanetPress Workflow computer.
The PlanetPress Suite Workflow Tools Configuration Program 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. l Button: Place a checkmark on the line of any pen you wish to remove from the database, then click this button.
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.
l l Backup filename: Enter the filename that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l This task does not generate any job information.
If you use Email input tasks to capture data encoded using a Double-Byte character set (such as those used for Japanese or Chinese, for instance), it is preferable to use attachments rather than the email body to carry the data from its source to the input task, as data corruption is less likely to occur using this method. Email input task properties are as follows: General tab l l Data Location group l Message body: Select to use the data found in the body of the email.
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.
Output The output to this task is a series of individual files, one after the other. These files are not modified in any way from when they are captured from the source folder. As with any task that can refer to network resources, it is important to understand the considerations involved with paths and permissions of these resources. Please refer to the Network Considerations page in the Advanced Configuration and Options chapter (Reference Guide, in English only).
l %2 - Folder: Contains the folder from which the data was captured. 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.
C:\Samples\manuals\ usermanual.pdf C:\Samples\manuals\ 644037 Note that the
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. FTP Input FTP input tasks retrieve files from FTP sites using the FTP protocol. Masks are typically used to select multiple files to be retrieved from the server.
Job Information definitions l l l l %1 - User name: Contains the user name that was used to connect to the FTP server. This is useful if this task is used as a secondary input and the information is defined dynamically. %2 - FTP Server: Contains the FTP address of the server from which the files were retrieved. %3 - Source file name: Contains the name of the current file that was retrieved from the server. %4 - Folder: Contains the FTP folder from which the current file was retrieved.
l l Username: A user name known to the Web server. Password: The password associated with the username entered above. "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.
received, the HTTP Server Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received. The request can contain one or more files, one being an XML file containing the request information as well as any GET or POST variables that were received within this request. Other files are POST attachments. Processing Depending on the options chosen in the HTTP Server Input task properties, the task may choose to ignore some of the files.
"Other" Tab l l l l Job Information group l Information elements: indicates what job infos are automatically created by the input task. l Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file. Backup input files: Check this to save a copy of each data file that is captured by your input. These files are saved in the PlanetPress Suite Workflow Tools working folders under the "Backup" folder.
l l l l l l %{error.process}: the process name where the error occurred. %{error.tasktype}: the type of the failed task, can be Action, Input, Output, Printer, Comment and Branch. %{error.taskname}: the name of the plugin (the Display Name as seen in the plugin bar). %{error.taskindex}: the index of the task in the process (its position in the process). %{error.errormsg}: the "Message" specified on the OnError tab of the failed task. %{error.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Input SOAP The SOAP Input task (or Input Soap) is used to answer calls from a remote SOAP client and to return a response to that request. It is similar in functionality to the HTTP Server Input task.
The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
l Delete Existing Metadata: Check to remove any metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks. Job Information definitions l l l l l %1 - User name: Contains the user name of the user who sent the job to the printer, or the user un which a software sending the job was logged in under. %2 - Host computer: Contains the name of the computer from which the job was sent.
"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 The task outputs the job file as is, with no evaluation or modification. The format of the job is PostScript generated by PrintShop Mail Web. PrintShop Web Connect Preferences A PrintShop Web Connect preferences page, accessible via the PlanetPress Suite Button | Preferences | PrintShop Web Connect, allows to provide operator credentials to your PlanetPress Suite configuration.
Telnet Input The Telnet Input Task (also known as the Raw Socket Printing Input) receives files sent to a specific port. If you want PlanetPress Suite Workflow Tools to receive data using multiple ports, you must use multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see Telnet Input User Options). Input This task does not poll an input, it sits there and waits for a job file to be sent through the Telnet port.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
Spool Print Jobs in RAW Format: Select to output in RAW format, which is the exactly the data that the computer receives (and is not converted in any way). l Create PDF (With Metadata): Select to output a PDF which can be used by the Document Input (PDF Input) feature in PlanetPress Suite. l Optimize Resulting PDF: The resulting PDF is optimized for size and caching options are enabled. This reduces the size of the PDFs (depending on some factors), but may take more time to output the PDF.
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.
Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Add/Remove Text action task properties are as follows: 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.
Using regular expressions, it is possible to search for patterns rather than specific strings. For instance, a pattern can be specified to find all valid email addresses or phone numbers within the data stream. Input Any text-based file can be used in this task, even formats that are not directly compatible with PlanetPress. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task.
l search counter is reset for every line. If the Search whole file option is selected in the Search mode group, the search counter is not reset before the end of the file. Select one of the occurrence options (described below) in the list box below and enter a value in the variable property box besides it. l At occurrence: The replacement will take place only when the specified number of occurrences has been reached.
Processing The task reads the image and detects the presence of the selected supported barcode types. When a barcode is detected, the data it contains is read and added to the Data Page level of the metadata. This task does not recognize more than one level of the metadata Document. This means that if you are intending to define separate documents, you should use the Metadata Level Creation task after the Barcode Scan. Output This task outputs the original data file but with modified (or created) metadata.
Settings l l l l l Force checksum validation: Select to define whether the checksum validation is required for symbologies in which a checksum character is optional. The goal of checksum is to detect accidental modification such as corruption to stored data or errors in a barcode values. By default it is set to false.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane.
Limitations l l Some barcodes created with PlanetPress Suite 5 could not be read by the Barcode Scan task, so please use PlanetPress Suite version 6 or 7 to create barcoded documents. When using a secondary input, a known issue of the Workflow Tool can cause some unexpected behavior, like having the same metadata file reused instead of a new one being created for each data file captured. To work around this issue, simply add a Rename Action task to set a unique file name (Ex.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
l resulting PDF may be much larger than it should be and may even be too large for PlanetPress Suite Workflow Tools to handle. Reset Metadata according to new PDF: The metadata is updated to included only the selected nodes from the current metadata, and sequential indexes are re-created. On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog.
l Font : l Embed all fonts Subset embedded fonts Open options : l Zoom factor: Fit in window l Default view: Page only l l Decompress File(s) Decompress action tasks decompress zipped job files (files compressed as zip files). Input This task only accepts ZIP Files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself. Processing Every file in the ZIP is extracted to the specified location.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Digital Action Digital Action action tasks generates the same types of documents generated by PlanetPress Image output tasks.
JPEG: The output will be a JPEG file. JPEG is a lossy compression image format that creates small files, compressing continuous tone images (such as scanned photographs) well. l TIFF: The output will be a TIFF file. TIFF is a higher quality format that is one of the standards for document exchange, useful for eventual printing or archiving. You have a choice of the following compressed TIFF formats: TIFF Group 3, TIFF Group 4, and TIFF Packed bits.
l l l None: Select if you do not want this task to add an index file to the generated document. PDI: Select if you want this task to add a PDI index file to the generated document. XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document. Job Options tab If you chose PDF as the output type in the General tab, use this tab to choose the appropriate PDF options. Note that all the options available in this tab are only used with PDF files.
l l l 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. Since JPEG eliminates data, it can achieve much smaller file sizes than Flate compression. Select Auto to let the application choose the best compression method automatically.
l your PDF, opening it on another computer or printing it may cause it to be substituted by another default font. l Subset: Select to embed only a subset of the Type 1 and TrueType fonts used in the document. A font subset is in fact composed of only those characters that are actually used in the document. This option can only be used if the Embed all fonts option is selected. Note that if more than 35% of the characters included in a font are used in the document, the entire font is embedded.
You can use Download to Printer action tasks to send various types of files, such as attachments, documents and fonts that are used in PlanetPress Design documents that are executed directly on the printers. For images you should rather use Send Images to Printer action tasks (see Send Images to Printer), as they provide image quality and conversion options. Input Any file that you wish to upload to the printer.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane.
l l 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.
Load External File action task properties are as follows: General tab l External file: The path to the file you want the job file to be replaced with. You may browse to the file using the browse button on the right of the field. 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.
Output The input data file is returned with no modifications. Metadata is not modified. A single job info or variable is modified by this task. Mathematical Operations action task properties are as follows: General Tab l l l Mathematical Expression: Variable data field containing the expression to be evaluated. This expression may combine any combination of standard PlanetPress Workflow variables and VBScript mathematical expressions.
Delete: Delete the current selection (only available if there is selected text in the editor). l Select All: Select all of the contents of the editor. 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. XSLT Version l XSLT 1.0: Select if you will be entering or pasting XSLT version 1.0 code.
Processing A connection to the selected database is made, the data is retrieved, and an output in the selected emulation format is generated. Output The result of the query is output in the selected data format. The current emulation is changed to the selected format. Metadata and jobinfos are not modified in any way.
Add a header record with field names: Select this option if you want the generated file to have a header record (a record that includes the field names only). l Fixed Length Columns Emulation: If you selected Fixed length columns in the Output file emulation box, the following options are available: l Sort on field: If you want the table to be sorted before the data page creation process is started, select the sort field from this box.
l Use dynamic values at runtime: Select to use a dynamic database connection string and/or SQL statement at runtime. Check this box to enable the options included in this group (this disables the corresponding options in the General tab). l 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.
General tab l New file name: Enter the job file’s new name. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. On Error Tab The On Error Tab is common to all tasks. 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 File l l l l Import: Lets you open an existing script from an external file. This file can be in .vbs, .js, .pl or .py for language-specific scripts, or .txt for any of them. Export: Lets you save the current script as a file. Print: Prints the current script. Edit Undo: Undo the last edit. Cut: Cut the current selection (only available if there is selected text in the editor). l Copy: Copy the current selection (only available if there is selected text in the editor).
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
l l l l l l Image quality: Select the same image quality chosen in the PlanetPress Design documents that reference the image files you are sending. In PlanetPress Design, this setting is included in the document’s resource options. Image compression level: Select the level at which you want images to be compressed. Values can range from 1 (compress up to 1% of the image’s original size) to 100 (do not compress).
l l l l l l l Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies. List of words to find and replace: Lists each string to find, and its replacement. These are executed in order, from top to bottom.
Output The original data file, metadata and job infos are not modified, they are passed on to the next task. Send to Folder action task properties are as follows: General tab l l l l Folder: Enter the path of the folder to which the files are to be saved. File name: Enter the name of the output files generated by this task. To prevent each new file from overwriting the previous one, you should use variable names.
General tab l l l l l l Var/Info#: Lists all job infos, local variables in the current process and global variables in the configuration. Click on the variable you want to change. Value: Enter the value that you want to associate with the selected job information element or custom variable. button: Adds a new line and lets you define the variable and value to set. button: Removes the line that is currently selected (highlighted). button: Moves the line up so it is processed before.
Task Properties General tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the dropdown list. The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l l l l l l l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
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.
checked. Only if all three values lie within the tolerance are the two blocks recognized as belonging together. Additionally, you can control text passages whose horizontal distance has been recognized as out of the tolerance, but whose type size difference and vertical distance lie within the tolerance, outputting it in one line. At the output, these text passages are separated by a tabulator (ASCII code 9).
Winport Translator 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.
Last data line of page 1 Data line1 of page 2 ...and so forth... Once split, the first file generated by the action task would look like this: Data line1 of page 1 Data line2 of page 1 Data line2 of page 1 Last data line of page 1 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.
l l l l l l l l l l l The following options are only displayed when the Field value condition option has been selected at the top of the dialog box. Operator: Select the condition to fulfill for the condition to be true and thus for the splitting process to take place. Value: Enter the condition value.
Using an emulation to format the data before splitting provides the most splitting options, but slows down the process. Splitting a data file containing a few hundred thousand pages may take several hours. So you may choose to use non-emulated data to speed up the splitting process (see In-Stream Splitter). Input Any emulated data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties.
After: If you entered a value other than 0 in the Where to split box, select this option if you want to split the file a given number of lines after the line on which the condition is met. l When condition is found: By default, the task splits the file every time the condition is met (the default value is 1). If you want the task to split the file only when the condition has been met twice, for example, enter the number 2 in this box.
l Split data file on a word group: Select to split the data file based on a word found within the data stream (rather than on based on pages) and to activate the options from this group, which are used to tailor exactly how you want the word based splitting process to take place. l Word: Enter the word to use as the splitting criteria. In this variable property box, you may enter static characters, variables, job information elements or any combination of these.
The Generic splitter, while seemingly more feature-rich, is slower than the other splitters by an order of magnitude. Whenever encountering the Generic splitter, it is always recommended to replace it with a more appropriate splitter instead. Input Any data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties. Output Multiple data files, sent one after the other to the rest of the tasks in the process.
l l Split when word found: You may not want to split the file every time the string of characters entered above is found, but only every other time, or every third time. If so, enter the number of times in this box. A Word change: If you choose “A word change” in the Split data file on list box (the Use emulation option must be selected), the following boxes are displayed. l Get: Click to select a search region.
l l l Consider case: Select to force the Generic Splitter to match the character casing of the string of characters entered in the Value box with the characters found in the file. If this option is selected, “DAY” and “Day” will not be considered as matching the search string “day”. Where to split group l Pages or records: Enter exactly where to split the file.
PDF Splitter PDF Splitter action tasks are used to split emulated PDF data files into multiple data files that are passed to subsequent tasks in the process. This feature is part of the PDF Tools, which is only available in PlanetPress Office and PlanetPress Production. It is not available with a PlanetPress Watch license. Input A PDF Emulation data file. Processing The file is separated into multiple chunks according to the rules set in the task's properties.
Where to split: By default, the task splits the file at the beginning of the line on which the condition is met (the default value is 0). If you want the task to split the file a certain number of lines before or after that line, enter a value other than 0 in this box. Enter 1, for example, to split the file at the beginning of the line that precedes the line on which the condition is met.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. XML Splitter XML Splitter action tasks use the XSLT language to split XML data files into multiple XML data files that are passed to subsequent tasks in the process.
l l l should be used, the default system encoding will be used. This may result in errors being generated or split files that contain bad data. Using the UTF8 encoding can prevent such errors. l Use UTF8 encoding: Select if you want to use the UTF8 encoding to process the file. l Use file’s encoding: Select if you want to use the XML file’s own encoding to process the file.
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.
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.
Go Sub The GoSub action task transfers the execution of the calling process to the specified subprocess. When a process encounters a GoSub action, it halts its own execution, start the subprocess and waits for it to complete before resuming its workflow with the next task. Every subprocess starts with a BeginSub input task and ends with a EndSub output task, both of which have nothing to configure and cannot be replaced or deleted. The simply represents entry and exit points for the subprocess.
l l l l Number of iterations: The number of times the loop should be repeated. Every task after the Loop Action Task will be repeated this number of times. The number may be static, or use a variables (see Variable Properties). Store current iteration in Job Info #: The Job Info in which the loop's iteration should be stored. Useful for sequential filenames or conditions based on the iteration. The value of this Variable Properties box should be a digit between 1 and 9.
Output Whatever file the Run Script action generates, metadata it modifies or creates, etc. Note about conditions: When using Run Script as a condition, the output of the task can be within the branch or on the main trunk. To control the output, use the Script.ReturnValue variable in your script. Run Script action task properties are as follows: The Script Editor menu options are as followed: l File l l l l Import: Lets you open an existing script from an external file. This file can be in .vbs, .js, .
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.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. SNMP Condition SNMP is a communication protocol for helping network administrators manage devices and peripherals on their network.
l Select Critical alert to choose a specific critical alert in the Detected error box. Select Do not test if you only want to test the printer status (above). l Detected error: Select a specific non-critical or critical alert. Note that this box is only displayed if you selected either Non-critical alert or Critical alert in the Alert Status box.
be used to test whether or not the first string is equal to the second one, whether it is equal or lower than the second one, etc. The logic of text conditions can sometimes be tricky, especially if it includes variable strings, so you should test it thoroughly. Text Condition properties are as follows: General tab l l l l l l l l l l String: If you want to test the presence of a given string at a given location, enter the string in this box.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
l l l Grid: Select separate or contiguous time blocks. Click a block to toggle it on or off. Click and drag to toggle multiple blocks on or off. Click date or day at the top of the grid to toggle the whole date or day on or off. Click a time interval on the left margin of the grid to toggle the whole time interval on or off. Select All: Click to toggle all the time blocks on. Clear: Click to toggle all the time blocks off. On Error Tab The On Error Tab is common to all tasks.
l Use MRDX as new data file: Ignore the PDF file and use the MRDX as a job file after this task. The PDF is discarded. If this is unchecked, the PDF and metadata are used. 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.
For this tab to work, you must have entered your SharePoint Connection information in the Connection Tab. l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously.
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.
Electronic files: All files will be stored in their original format in Laserfiche.When double-clicking on the document in Laserfiche the native Windows application associated with the file extension of the archive will be opened. l Force folder creation: Select to force the folder creation if it does not already exist on the Laserfiche server. l Volume: A list allowing to choose among available Laserfiche volumes. l Configure Tags: Click to open the Configure Tags dialog.
l l l l If you want to assign an Informational Tag, do not check the Security tag option in the Laserfiche administration console. If the output repository folder does not have access rights to read and create documents, the task will not be able to export documents to the selected Laserfiche folder. If you intend to use PDI for number type, your decimal separator in both your Regional and Language Options and in PlanetPress Index (PDI) numbers should be a dot (".").
l l l l Selecting a tag will assign it to the exported documents. There are two types of tags: informational tags (icon with an exclamation mark ("!")), and security tags (icon with a lock). All tag properties are the same as in the Laserfiche client console. The Comments columns allow the addition of comments to the tag. This column supports the use of any PlanetPress Suite Workflow Tools variables. Restrictions l l The column Comments in the Configure Tags interface allows a maximum of 200 characters.
Lookup Column: The name of the column in the Microsoft® Excel® worksheet that corresponds to the contents of the Lookup Field. l Action: What to do with the resulting data from the Microsoft® Excel® worksheet. This can be: l Add Field: Creates a new field with the data. This may cause multiple fields to be created. l Replace field value: Replaces any existing field with the new content. Only the last result will be displayed. If the field does not exist, it will create it.
A PlanetPress Design document takes as input a transactional PDF file, and reproduces it exactly as it enters. Metadata fields called ItemDesc are created, one for each line item description, at the datapage level. Each ItemDesc metadata field is given the value of a line item description as found on a region of the current data page.
SQL Statement: An SQL statement that is understood by the database you are using and that will return a series of records that the Microsoft® Word® template is expecting. Note that no validation is made on SQL statements except if they are for Microsoft Access and Excel data files. You can use the Test Connection button to test the SQL and connection string.
Output to SharePoint The Output to SharePoint Action Task can be used to send files to an existing Microsoft SharePoint server. Input Any data file, with optional metadata. Processing The task connects to the selected Document store and uploads the current data file. If the file already exists, it will be overwritten and, if this option is selected, marked as "checked in". The information accompanying the file (the SharePoint metadata) is either updated or created.
l l Yes/No: Yes/No (menu to choose from). If passing a variable, has to be either "Yes" or "No". Hyperlink or Picture: This type contains an html hyperlink or picture. Document libraries using the Content Type system in SharePoint 2007 and higher (as well as Windows SharePoint Services 3.0 and higher) are supported in PlanetPress Suite 7.4 and higher only. Connection Tab l l l l Server Name: The name of the SharePoint server. This can either be a server name (e.g.
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.
Task Properties General Tab 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.
Start timestamp: Triggered when the first ink is applied in the field. l Before: If the first stroke found in the Capture Field was made earlier than the specified date and time, the condition becomes true. l After: If the first stroke found in the Capture Field was made later than the specified date and time, the condition becomes true.
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 any error occurs during processing, such as running out of patterns while generating the job, every action made by this task will be rolled back as if they hadn't happened. Output The Capture field Generator action Task will output either a PDF and Metadata, or an Optimized PostScript Stream file without Metadata.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
CapDocID: The database ID of the document. This field is useful especially if using the Capture API since the ID corresponds to the itembyID function. l CapDocName: The name of the document as specified in the Capture Field Generator. l CapOpenDate: The date at which the document was created by the Capture Field Generator. l CapPatternSequence: The value of the pattern sequence assigned to the document.
l Add pattern information to the metadata: Adds advanced information in the Metadata for post-processing: l At the Document node, timestamp information such as ink start/end time l At the Page node, information about each Capture Field such as its name, dimensions, style, index, mask, timestamp and content status. When the "ignore out of bounds ink data" option is checked, this option modifies the way that the On Error tab reacts.
Processing The PGC file is split by document, if a document can be matched for each pattern ID found in the PGC. The match is made by comparing each Pattern ID with the information found in the Capture database. If more than one pattern is used in a document (pattern on multiple pages of the document), all of the information for this document (more than one Pattern ID) is sent down as a split. Patterns that do not match any document are sent individually, one Pattern ID per split.
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. Input Because this task in an Input task, it does not use the current job file in your process, even when used as a secondary input task.
Equal: Inclusive filter, where anything equal (either by string or numeric comparison) is included in the results. l Not Equal: Exclusive filter, where anything not equal to the condition is included in the results. l Less Than: Numerical comparison, where anything lower than the specified value is included. l Greater Than: Numerical comparison, where anything higher than the specified value is included.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
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. 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.
Processing The ink contained in the PGC file is converted into an EPS layer, which is then applied on an blank, empty PDF file of the size specified in the task's properties. If more than one Pattern ID is found in the PGC file, each separate Pattern ID will generate a new page on which its ink is applied. Output A PDF file with a blank background and only the ink data found in the PGC file. Task Properties General Tab l PDF page size: Choose the page size of the output PDF.
Processing A query is made to the Capture database and the ICR data is retrieved. The document that is queried must be available in the database (must not have been closed and retrieved previously). Output The original data file is output by this task, along with the original Metadata file that has been enhanced with the ICR data at the selected level.
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.
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: Apply the action on the specified field at the Job level. l Group: Apply the action on the specified field at the Group level. l Document: Apply the action on the specified field at the Document level. l Data page: Apply the action on the specified field at the Data page level. l Field Name: Enter the metadata field name on which the task will operate. l Field Value: Enter the metadata field value. Note that if the chosen action is Delete, this parameter is disabled.
l l Metadata Fields Management actions on the Page level are not possible since the entire task execution is based on the data page node. The task raises an error if the selected Metadata Fields Management action is Sum and if one of the field values is not numeric. The task supports approximately 15 digits of precision in a range from 2.23 x 10-308 to 1.79 x 10308. Metadata File Management The Metadata File Management Action Task is used to execute actions on Metadata files.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Metadata Filter The task allows specifying the Level (Group, Document and Datapage) on which to perform the action and under which condition. At least one level must have the condition set.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane. Special Considerations l l The task CANNOT re-select unselected nodes if the condition is false for those nodes.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
Processing The order of the metadata is changed in accordance with the rules set forth in the task's properties. Output The original data file is output, along with the modified metadata. General Tab l l l Group: Sorts the metadata by group. Document: Sorts the metadata by document. Data page: Sorts the metadata by data page. For each parameter, three columns are available: Sort By, Then by, Then by (again). This lets you sort your document level in three different orders sequentially.
Input This task can use any data file, as long as it is accompanied by metadata. This metadata may have been directly generated or could be extracted from a PDF using the Metadata Embed and Extract task. Processing The metadata is read and PDF indexes are located. These indexes are defined in the PlanetPress Design document as data selections, in which the Archive/Email/Fax properties define the data as an index with a name. When all the indexes are collected , a PDI file is generated with those indexes.
l l l l All PlanetPress Design document templates must use the n-up object on both the front and the back pages of the duplex document. Each instance of the n-up object must have the “change data page with each repeat” option checked. The total number of repeats on each page (vertical X horizontal) must correspond to the number specified in the Number of virtual pages per physical page option..
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.
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane.
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.
l Passive: Select to prompt PlanetPress Suite Workflow Tools to use the passive mode when sending files to the FTP server. On Error Tab The On Error Tab is common to all tasks. Details can be found on Task Properties Dialog. If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded.
l l the actual printing part, so there is no way for your PlanetPress Suite Worflow Tool to ensure that all the settings you make will be applied to the printed document. Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used. You may use a different variable, but you may not use a data selection. This information may be used for the printer’s banner page. Job owner name: Enter the job owner name. You may use a PlanetPress Suite Workflow Tools variable.
Processing If the data file is in a valid Emulation and a document is selected, the data file and document are merged to produce a PostScript output. The output may be an Optimized PostScript Stream or a Printer Centric stream (data file + trigger). If the data file is any file and the Passthrough option is selected, the file is sent as-is to the selected printer queue. Whether the queue will properly output depends on the capabilities of the queue and its target.
l Use job name as Title: Uses the Job Name set in the Printer Queue's General tab, as the job's title, set as %%Title in the postscript's job. 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 this would cause the task to fail. If you suspect that the data may contain parentheses, you should use a Run script action task (see Run Script) with a Strip() function to strip them out. Message: Enter the content of the email message. Since this is a variable property box, the text may be personalized using variables and data selections. Note that since this is a variable property box, its content is parsed at runtime.
l l l Server requires authentication: Select if the outgoing server mentioned above requires authentication. To use authentication you must enter information in the Account name and Password boxes below. Account name: Enter the name of the account that PlanetPress Suite Workflow Tools is to use to send emails via the mail server. Password: Enter the password associated with the account name entered above.
l Concatenate files: If this option is selected, when PlanetPress Suite Workflow Tools tries to save the job file under an existing name, it appends the content of the new job file to that of the existing file, instead of overwriting it. l In the case of a PDF, this will act like the Merge PDF Files input task, merging the PDF logically. l l This feature is part of the PDF Tools, which is only available in PlanetPress Office and PlanetPress Production.
Task Properties General tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the dropdown list. The WSDL Address of a PlanetPress Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l l l l l l l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc. Comments Tab The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks.
l l l l l Control Characters: Contains a list of control characters that can be used in printers. Get Data Value: Brings up the Data Selector, retrieves the value you select and places it in the variable properties box. This information becomes static and does not change between each datapage and job file. Get Data Location: Brings up the Data Selector and records your selection.
that are put in the source folder. If you enter *.mdb instead, the task will only take the those database files that have an mdb extension. You can use any standard wildcard character in PlanetPress Suite Workflow Tools. Date and Time Format To simplify things and to prevent errors, date and time formats have been standardized. l l Date are entered and displayed as yyyy/MM/dd (2007/06/13, for example).
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 l l l l l l l l A Capture field is setup for ICR in a PlanetPress Design document. The document is sent to PlanetPress Production The Capture Field Generator is used to produce one or more print-outs using this document. The physical sheets are written on using an Anoto Digital Pen The pen is docked and the data is sent to PlanetPress Production The pen data goes through the Capture Field Processor, where the Capture Field ink is sent through the ICR engine.
Special Workflow Types The following guidelines are applicable when configuring a PlanetPress Capture object that utilizes ICR: The collected data is expected to be a number, therefore the numeric mask type must be selected, or The collected data is expected to be a letter, therefore the alphabet mask type must be selected, If upper case letters are expected, select Upper case in the Case option menu. The captured characters would be immediately converted to capital letter i.e.
Special Workflow Types 2- Guidelines for Capture-ready fields l l Target: Form designer What: Only one character per Capture field can be recognized. When expecting multiple characters making up a word or phrase, you must make sure that the user only writes one character per field. In order to do so, you must make sure that the fields are big enough and have enough space between each one. The best practice is to make sure that there is a boundary surrounding the field where ink marks are to be written.
Special Workflow Types How: Make sure there’s enough space between each field. You must re-design the document if that’s the case. There’s no minimum value that is required as the distance between 2 fields, except for the 7mm border that is required in order for the Anoto digital pen to recognize the pattern being used. 3- Writing in a legible way l l Target: User What: It is important to write in a legible way i.e. applying yourself by writing well defined numbers and letter that are easily interpreted.
Special Workflow Types 5- Possibility of interpretation error in an automated process l l Target: Workflow designer What: We cannot be 100% sure that a character would be recognized by PlanetPress Capture as it should. Therefore, the analysis of a value interpreted with ICR should only occur if the level of confidence is superior to a determined level. Why: An automated process can treat the characters incorrectly due to an incorrect interpretation of a value.
Special Workflow Types Basic Functional Capture Workflow This workflow is the most basic and simple workflow that you can use with PlanetPress Capture. In small implementations with only one simple document, this may be the only thing required for a functional workflow since, even in this simple state, it can be enough to automate the archive of your digital documents. The workflow requires two separate processes that will be triggered at different times.
Special Workflow Types After retrieving information from the Capture database There are two basic ways in which the Find Capture Documents task can be used. First, in an automated process that runs at specified intervals. For example, the following process which sends a daily report of all incomplete and "in error" documents to an agent who would presumably take action on each document through the document manager.
Special Workflow Types Capture Web Manager Workflow This example is both a more involved workflow for Capture, and an interesting implementation of an HTTP Workflow. Before looking at this example, it would be best to become familiar with both PlanetPress Capture Workflow and HTTP Server Workflow. The example is too complex to display as images in this guide, so it is rather available for download.
Special Workflow Types This example is compatible with PlanetPress Suite 7.4 and higher and will not work in older versions. Installation 1. 2. 3. 4. 5. 6. Download both resource files Create a folder on your disk called c:\planetpress Open the invoice.pp7 document and send it towards your local PlanetPress Workflow server (localhost or 127.0.0.1) Open the configuration file CaptureExampleProcess.pw7 Go in the PlanetPress Button ("file" menu) and go in Preferences.
Special Workflow Types PlanetPress Workflow can serve both static and dynamic resources to a web browser, however it is not meant to be used as a fully featured web server, as it is not built for responsiveness nor guaranteed uptime. It is much better to have a common web server (for example, IIS or Apache) to serve your contents and to have PlanetPress available only to process things only it can do. You can control access to the PlanetPress Suite Workflow Tools HTTP Server via the Access Manager.
Special Workflow Types And finally, the HTTP Server Input task properties. While these are described in the HTTP Server Input task properties page, here are a few considerations to keep in mind when using this task: l l l l l The HTTP Action corresponds precisely to the name immediately following the first slash of your address. That is to say, placing the action myaction here means the process would be triggered by opening http://127.0.0.1:8080/myaction in your browser.
Special Workflow Types Example HTTP Workflows l l l HTTP PDF Invoice Request (GET) HTTP Brochure Request (Customer Information+ POST) Capture Web Manager Workflow (PlanetPress Capture + HTTP) HTTP PDF Invoice Request This straightforward workflow simply receives a GET request from a browser, loads an existing PDF invoice from a folder on the hard drive, and returns it to the browser.
Special Workflow Types Task Breakdown l l l l The HTTP Server Input task receives a request through the /getinvoice HTTP Action. Because this task either returns an HTML page with an error message or a PDF, the MIME type is Auto-Detect. It checks whether the invoice request exists by checking if the size of the file is less than 1kb using File Size Condition. The condition returns "true" if the file is not found: c:\planetpress\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum[1]',Value,Ke
Special Workflow Types l l l When the condition is false, it means that there is something in the Full Name field. In this case, we know that the form was filled and submitted back to the process, and we handle the request as such. First, we add the full name, email and company information to job informations, in order for them to be available for the rest of the process. Then, we have a small condition that verifies if the user checked the "Newsletter" box. If so, the conditional branch is triggered.
Special Workflow Types Examples l Daily Sales Report from PDF Files Daily Sales Report from PDF Files This workflow makes heavy use of both PDF Tools and Metadata, and assume that you are using PlanetPress Office or PlanetPress Production version 7.3 or higher. This single process workflow generates a daily sales report for any sales rep inside of a company which made at least one sale.
Printer Queues and Documents Printer Queues and Documents This section delves into the subjects of PlanetPress Suite Workflow Tools printer queues and PlanetPress Design documents. PlanetPress Suite Workflow Tools Printer Queues The printer queues displayed in the Configuration Components Pane of the PlanetPress Suite Workflow Tools Configuration program are not to be confused with Windows printer queues.
Printer Queues and Documents Frequently Used Printer Control Characters Character name: Character code: Typical use in printing context: End-Of-Job \004 Indicates the end of a print job Backspace \b Moves a character space backwards Horizontal Tab \t Adds a horizontal tab Line Feed \012 Moves to the next line Form Feed \f Moves to the next page Carriage Return \r Moves to the beginning of the current line DOS End-Of-File \032 Indicates the end of a print job in a DOS environment Escape \033 Adds an escape
Printer Queues and Documents LPR output printer queue properties are as follows: General tab l l l l l Printer address: Enter the IP address or host name of the printer receiving LPR jobs. Queue name: Enter the printer queue name. Based on printer and network requirements, this property may not be required. Data type: Select the proper data type. Select (l) Binary data if the job file is a standard binary file.
Printer Queues and Documents l l l l FTP Port: Enter the FTP port to use. This option is disabled if Use FTP Client default port number is checked. The port should always correspond with the server's port number. Directory: Enter the directory to which the print jobs are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server. File name: Enter the name under which the print jobs will be saved.
Printer Queues and Documents l l l l Add: Click to add a new command to the list displayed in the Commands box. You must then edit the new command’s description and value. Note that new commands are shared by all printer queues. Delete: Click to remove a command from the Commands box. Command description: Use this box to edit the description of the command currently selected in the Commands box. Command value: Use this box to edit the code of the command currently selected in the Commands box.
Printer Queues and Documents A PlanetPress Document Package, or PTZ, is a file format consisting of a ZIP file, which contains all the document's data and resources. With a PTZ, resources are extracted and uncompressed only once when your PlanetPress Suite Workflow Tools receives the file.
Printer Queues and Documents l l When the server running PlanetPress Suite Workflow Tools sends a PlanetPress Design document along with the data to the printer, it adds a trigger before the document (trigger+document+data). When the server running PlanetPress Suite Workflow Tools only sends the data to the printer, because the document is already present on the printer, it adds a trigger before the data (trigger+data).
Printer Queues and Documents is created, end-users can install it on their own computer by going through the same steps they would when installing a new remote printer in their Operating System. By default, connecting to a shared printer will automatically result in the Objectif Lune Printer Driver being downloaded to the connecting host.
Printer Queues and Documents Note that steps 6-8 can be performed at any time, even if PlanetPress Watch/Office/Production is not yet started. This is because every Windows printer queue using Objectif Lune Printer Driver (PS) is paused by default. Once the service has started, it captures every queued job. PDF Creation Parameters PDF files retrieved from a Windows print queue using Objectif Lune Printer Driver (PS) have the following properties: l l l PDF 1.
Printer Queues and Documents l Optimized PostScript Stream can be used in any version or flavor of PlanetPress Suite. However, if used in PlanetPress Watch or PlanetPress Office, a license must be available for the printer or the output will contain a watermark. In PlanetPress Production, you can output to any PostScript printer without a watermark. Windows Printer Queue: This run mode is only available through the Print Using a Windows Driver output task, and uses printers that are installed in Windows.
Debugging and Error Handling Debugging and Error Handling This chapter touches on two subjects that are intrinsically linked, though their use is different. Debugging is the act of running through your process, either step by step or as a whole, directly from the PlanetPress Suite Workflow Configuration Tool, in order to detect and resolve issues with your process.
Debugging and Error Handling While stepping through a process (using Step, not Run): l l l l l l l l l l l Double-click on any task to change its properties. If you change the properties of a task before you step through it, those new properties will be used when the task is executed. Note that you cannot modify the process itself while in debug mode (you cannot add, delete or move tasks, change branches and conditions, etc). Click on Skip to ignore the next task or branch and go to the next one.
Debugging and Error Handling l Instead of skipping through each task, use the Run from here or Step from here options, either from the Debug tab or by right-clicking on the task where you want to start the process. Once you have created and fully debugged all your processes, you will be ready to send it to the PlanetPress Workflow Tools service. See Saving and Sending a Configuration.
Debugging and Error Handling Creating and Using Error Processes An Error Process is a special type of process that never runs on its own, and cannot be called using the GoSub or Send to Process tasks. It can only be used in the On Error tab of a task in your process, and will be triggered if the Send to Process option is checked in that tab and an error process is selected in the drop-down list.
Debugging and Error Handling The information that is displayed here is the same as in the PlanetPress Suite Workflow Tools logs and depends on the logging level that you set in the Logging User Options. To view logs for jobs that have already processed By default, the logs are available in the following folder: C:\Documents and Settings\All Users\Application Data\Objectif Lune\PlanetPress Suite 7\PlanetPress Watch\Log You can access this folder more quickly by using this procedure: l l l From the PlanetP
Debugging and Error Handling Figure 1 : The numbers on the left indicate the task index, the folder capture being level 1 and the Text condition being on level 4. To resubmit backed up input data files: 1. In the PlanetPress Suite Ribbon, go to the Tools tab then click Resubmit Job in the Services group. The File Resubmission dialog box is displayed. 2. From the Process box, select the process for which you want to resubmit the backed up input files. 3.
Debugging and Error Handling But finding this information often poses a problem. A good way to find this information easily is to print it using small characters at the bottom of every page. To do this, you have to do the following. In PlanetPress Suite Workflow Tools: l l Use a Set Job Info action task and associate a variable with the job’s name. In the output task, make sure to select the option that adds the job information to the document.
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
