User Guide Version: 2018.
User Guide Version 2018.1 Last Revision: 2019-09-17 Objectif Lune, Inc. 2030 Pie-IX, Suite 500 Montréal, QC, Canada, H1V 2C8 +1 (514) 875-5863 www.objectiflune.com All trademarks displayed are the property of their respective owners. © Objectif Lune, Inc. 1994-2019. All rights reserved. No part of this documentation may be reproduced, transmitted or distributed outside of Objectif Lune Inc. by any means whatsoever without the express written permission of Objectif Lune Inc. Inc. Objectif Lune Inc. Inc.
Table of Contents Table of Contents 4 Welcome to PReS Workflow 2018.
Saving and sending a Workflow Configuration Exit PReS Workflow Configuration program Workflow Configuration resource files Connect resources PlanetPress Design documents PrintShop Mail documents About data About documents and variable data Job file Job file names and output file names Data selections About data emulation Sample Data Metadata Data Repository Structure Accessing the Data Repository Where to find the Data Repository Debugging and error handling About error handling Using the On Error tab Creat
Associating PlanetPress Design documents and PReS printer queues About processes and subprocesses Processes Subprocesses Creating a new process Importing processes Activating or deactivating a process Process properties About branches and conditions Converting a branch to a subprocess Running a process on desktop Saving and sending a Workflow Configuration Using Scripts The Script Editor and XSLT Editor SOAP Server API Reference The Watch Object Data Repository API Stopping Execution Special workflow types
Unknown tasks About variables Job Info variables Standard variables Local variables Global variables Variable task properties Workflow add-ons PlanetPress Capture About PReS Fax About PReS Image Workflow processes in a Connect Send solution ZUGFeRD About related programs and services Available Input services Available Output services Start and stop PReS Workflow Service Users and configurations Workflow Services The Interface Customizing the Workspace Dock and Undock Areas of the Program Window Show or Hide
Expanding and collapsing categories and groups in the Configuration Components pane Delete objects and groups from the Configuration Components pane Other Dialogs Access Manager Activate a printer Advanced SQL Statement Dialog Data Repository Manager The Data Selector Data Selector display preferences Dialog_File_Viewer PDF Viewer Process properties The PReS Workflow Service Console Update document Virtual Drive Manager Workflow Services The Debug Information pane The Message Area Pane The Object Inspector
HTTP Server Input 1 plugin preferences HTTP Server Input 2 plugin preferences LPD Input plugin preferences Serial Input plugin preferences Telnet Input plugin preferences PReS Fax plugin preferences FTP Output Service preferences PReS Image preferences LPR Output preferences PrintShop Web Connect Service preferences Editor Options The Process area Zoom in or out within Process Area Adding Branches Replacing tasks, conditions or branches Removing tasks or branches Task Properties dialog Cutting, copying and
Welcome to PReS Workflow 2018.1 This PDF documentation covers version 2018.1. 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. Workflow is the heart of all of our solutions. Working in conjunction with PReS Connect, PReS Capture, CaptureOnTheGO, PReS Imaging, PReS Fax, and a variety of plugins, it helps improve your communications processes.
Warning Information that is potentially critical to using PReS Workflow. Technical Background information.
Installation and setup This chapter describes the different considerations that are important in regards to the installation and use of PReS Workflow. l "System Requirements" below l "Environment considerations" on the next page l "Setting up the working environment" on page 16 l "Known Issues" on page 19 System Requirements These are the system requirements for PReS Workflow 2018.1.
l 8GB RAM (16GB Recommended) l Disk Space: At least 10GB (20GB recommended) Environment considerations This page is intended to provide technical information about the environment in which PReS Workflow is intended to run. Terminal Services PReS Workflow does not support Terminal Services environment as possible under Windows 2000, 2003 and 2008.
and they are properly detected by PlanetPress Suite 7.5.1 and higher, we have not tested them and cannot offer support for them. Warning The PReS Workflow End-User License Agreement (EULA) specifies that a PReS Workflow software license may only be used on a single virtual or physical PC at a time. While copying a virtual machine for backup purposes is acceptable, running two instances of the same machine, using the same serial number, is strictly prohibited.
Warning Disabling any antivirus scanning permanently on any folder or program is not recommended, and Objectif Lune cannot be held reliable for any consequence of disabling your antivirus or whitelisting the folders or executables listed here, or any other change in your antivirus protection setup! l On Windows 7/2008: l l l l C:\Users\planetpress\AppData\Local\Temp\ (where planetpress is the user under which Workflow is configured) C:\Users\planetpress\Connect (where planetpress is the user under whic
Microsoft Office compatibility The Microsoft Office 2010 line of products, other than Pro and Enterprise, has not been certified for use with PReS Workflow. Some of its products may not be compatible with the connectors included in the Suite. Setting up the working environment After installation, the working environment needs to be set up before you start using Workflow. This involves: l l l Configuring PReS Workflow Services (see "Workflow Services" on page 628).
associated with the selected account (except for PReS Messenger Service which always runs on the Local System account). When you are running PReS Workflow Configuration program on a workstation, if it is associated with an account that is different from your account, the following icon is displayed in the lower right corner of PReS Workflow Configuration program: .
Component Protocol Local Port Remote Port Email Input (POP3 mode) TCP Default1 110 Email Input (Outlook mode) TCP see Remote Port See Network Ports Used by Key Microsoft Server Products Folder Capture TCP/UDP Default1 Standard Windows file and printer sharing ports2: l l UDP 137, 138; TCP 139 (NetBIOS over TCP/IP (NetBT)) UDP 445; TCP 445 (SMB over TCP/IP) LPD Input TCP 515 (listening port) N/A FTP Input TCP Default1 21 Telnet Input TCP Default1 9100 (configurable) FTP Output
Component Protocol Local Port Remote Port l 445 (SMB Over TCP/IP) LPR Output TCP Default or 721 to 7313 515 PReS Database TCP or UDP Unknown4 Unknown4 SNMP Condition UDP Default1 161 1 Value is greater than 1024 and is assigned by Windows XP. This is the default. 2 Windows NT 4.0 uses NetBIOS over TCP/IP for file and printer sharing, while Windows 2000, Windows XP, and Windows Server 2003 may be configured to use NetBIOS over TCP/IP or SMB over TCP/IP.
Microsoft patch causing handling of XLS to fail Some recent Windows updates from Microsoft have impacted the handling of XLS sources in PReS\PlanetPress Workflow 8. The Microsoft updates concerned are as follows: l KB4041693 for Windows 8.1 and Windows Server 2012 R2 l KB4041681 for Windows 7 and Windows Server 2008 R2 l KB4041690 for Windows Server 2012 (no service pack) Installing these updates may cause the application to fail when attempting to open or load XLS files via a plugin or in a script.
Other known issues l l l l l l l l l l l Anoto Pen Director 2.8 is not supported on Windows Server 2012 and Windows 10. 22356: Using the PT-PT setting to perform ICR on AlphaNumeric fields may not work properly. If you encounter the issue, use the PT-BR setting instead, or use another PlanetPess Field in your document design. 21962: Barcode scanner task may have issues reading 2-D barcodes printed/scanned with low resolution.
PlanetPress Messenger service from the Workflow console for this one time only. To avoid getting the error altogether, make sure you launch the PReS Workflow tool once before sending any document to it. l l l l 13554: In the LaserFiche connector, when selecting a different template after filling up the fields and then going back to the first template, the values entered in the fields are lost. They have to be entered again.
l l l l l The WordToPDF task requires the default system printer to be set to a queue that uses the PlanetPress printer driver. If you change the default system printer or if you import a PReS Workflow configuration file from another PC that includes an instance of the WordToPDF task, you must review the properties of each instance of the task and click OK to validate its contents. A new printer queue will be created if required and the default printer will be reset properly.
PReS Fax can be installed on any computer on your network and process all requests coming from tasks performed by PReS Workflow on other workstations. You may choose to run it on every computer where PReS Workflow is running, but you may also choose to run it on computers more or less dedicated to PReS Fax. Since the faxing program must always be running and ready to receive requests from PReS Workflow, it should be included in the Windows Startup group.
PReS Image can be installed on any computer on your network and can process requests coming from tasks performed by PReS Workflow on other workstations. You may choose to run it on every computer where PReS Workflow is running, but you may also choose to run it on computers more or less dedicated to PReS Image. Note that in the case of Digital Action tasks, PReS Workflow and the PReS Image service must be running on the same computer.
Basics PReS Workflow is a tool to automate the processing, distribution and printing of your business documents. Once installed on the server, it can be set up to automate all tasks related to document processing (see "Setting up the working environment" on page 16). When you're all set up, you can start using the Workflow Configuration tool, assuming that you have already done research on the processes that need to be automated. Working with Workflow implies the following basic steps: 1.
The product-specific files need to be sent to, or imported into, Workflow before they can be used in conjunction with a task (see "Workflow Configuration resource files" on page 34). They become visible in the "Configuration Components pane" on page 582.
Features PReS Workflow are input driven applications designed to output data in a variety of ways through diverse means to various applications and devices. PReS Workflowcan be used as simple go between, passing along input data to output devices, but it can also perform various types of data processing. You can combine the various PReS Workflow services to set up versatile automated processes to print jobs as well as generate other types of output. PReS Workflow processes act as sorts of dispatchers.
Note A PReS Workflow configuration must be composed of at least one process, but it may include as many as 512. PReS Workflow cannot work without a valid configuration, and a PReS Workflow session running on a given computer can only use one configuration at a time. For a configuration created in the PReS Workflow Configuration tool to actually be executed by PReS Workflow, it must be sent to the PReS Workflow Service.
If a file that is different from the default configuration file is currently opened, and if it includes unsaved modifications, PReS Workflow asks you whether to save the configuration before creating the new configuration. Select the Always save without prompting for confirmation option to automatically save any unsaved work.
When the PReS Workflow Configuration program sends a configuration, the PReS Workflow service is stopped and restarted, if it is currently running, and the new configuration starts being applied immediately. Saving a configuration Files created and edited using PReS Workflow can be saved as PReS Workflow configuration files anywhere on your computer or even a network location. To save the current configuration: l l From the PReS button, choose Save.
If the PReS Workflow Service is running when you send a new configuration, it stops and restarts automatically with the new configuration. If the service is stopped before sending the configuration, it will not restart automatically. Note When you send a configuration to your PReS Workflow service, all its active processes are applied; see also:"Activating or deactivating a process" on page 112. Sending a Configuration to the local server 1.
configuration. Exit PReS Workflow Configuration program Once you are done using the PReS Workflow Configuration program, you can close it. Note Closing PReS Workflow Configuration program does not stop any of PReS Workflow services or processes. You may exit the PReS Workflow Configuration program in any of the following ways: l From the PReS Workflow Button, choose Exit. l Click the X at the top-right corner of PReS Workflow Configuration program. l Press ALT+F4 on your keyboard.
Workflow Configuration resource files Workflow serves as automation tool in a number of distinct products. Some of the tasks that can be used in a Workflow configuration will work with product-specific resource files: l l l PReS Connect Resources are files created with one of the other Connect modules - the Designer and DataMapper (see "Connect resources" below). PlanetPress Suite users may use PlanetPress Design documents (see "PlanetPress Design documents" on page 38) in PReS Workflow processes.
Tip Double-click on a sample data file to use it as a sample data file for the active process. l l l Document Templates: Templates can be used in content creation tasks: "Create Email Content" on page 455, "Create Web Content" on page 473 and "Create Print Content" on page 469. Job Presets: Job Presets can be used in the "Create Job" on page 459 task to filter and rearrange print content items. Output Presets: Output Presets contain settings for Print output.
Tip You can import multiple files at once. Resource Save location Any resource sent to PReS Workflow from PReS Connect is saved locally at the following location: %PROGRAMDATA%\Objectif Lune\PReS Workflow 8\PReS Watch\OLConnect Resources are saved in their appropriate folder: l DataMapper contains the data mapping configurations (.OL-datamapper) l JobCreation contains the Job Presets (.OL-jobpreset) l OutputCreation contains the Output Presets (.OL-outputpreset) l Template contains the templates (.
of 300 files will be present in the archive\template folder). Older archives are deleted automatically as new archives are created. Using Connect Resources in tasks A number of OL Connect tasks (see "OL Connect tasks" on page 450) let you select a Connect resource file to be used with the task. The selection list will appear on one or more of the tabs in the Task Properties dialog that appears when you add a task to a process (see "Adding tasks" on page 198).
Note Double-clicking on the data file does the same thing as right-clicking on it an then selecting Set as sample data file. Clicking Cancel instead of OK after viewing will prevent this action from being taken. Saving an attached data file to disk 1. Make sure the Connect Resources section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Right-click on the data file, then click Save sample data file.
Printer-centric printing PlanetPress Design lets you send documents to printers as well as to PReS Workflow servers. l l l If you send a document to printers only and not to any PReS Workflow server, you will not be able to see this document in the PReS Workflow Configuration program.
PReS Workflow server. 3. Click OK. Importing PlanetPress Design documents This procedure describes how to import PlanetPress Design documents into PReS Workflow. Importing documents can be useful when transferring configurations between PReS Workflow installations. To import documents into PReS Workflow: 1. Click the PReS Workflow button. 2. Choose Import, then Import PlanetPress Document. The Import PlanetPress Design Document dialog box appears. 3. In the File type box, select the desired file type. 4.
2. Expand the document (name.ptk) by clicking the button. 3. Right-click on the data file, then click Set as sample data file. Viewing an attached data file 1. Make sure the PPS/PSM Documents section is visible by clicking the appears. 2. Expand the document (name.ptk) by clicking the button if it button. 3. Double-click on the data file to open the data selector (see "The Data Selector" on page 610).
document. This preview appears under the PPS/PSM Documents section of the Configuration Components pane. The PDF contains the result of a preview with the active data file (for all data pages) run as an Optimized PostScript Stream. Viewing the Document Preview 1. Make sure the PPS/PSM Documents section is visible by clicking the appears. button if it 2. Expand the document (name.ptk) by clicking the button. The Document Preview has the same name as the document but with a PDF extension. 3.
The Document name of printer-resident documents can be changed using PReS Workflow Configuration program simply because it is initially set using that program. The properties available via the Printer Settings tab define how documents are printed. They are also set using the PReS Workflow Configuration program and are retained when documents are assigned to printer queues.
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 it is always accessible by the task that currently handles it. Data is referred to in tasks using data selections; see "Data selections" on page 47.
Job file Whichever source it may come from, a serial port, an e-mail message, or an LPR request, for instance, and whatever its format, data entering a PReS Workflow process via an Input task is always referred to as a data file. When a data file enters a process, it becomes the job file. 'Job file' however is a more general term, that can refer to data files as well as other types of files traveling through a process.
l If the job file is processed by a Splitter action task, the task typically creates a number of new files which are all given new job file names. Since these files are generated and managed by PReS Workflow, you should not actually pay too much attention to their names. Many Output tasks, on the other hand, let you determine exactly how you want the files they generate to be named.
Note You can change the name of a previously named file using a Rename action task (see "Rename" on page 301). Data selections A data selection could be compared to an address. It indicates a location within a data file or database: the job file (see "Job file" on page 45), Metadata file (see "Metadata" on page 67), or "Data Repository" on page 78.
Data selections can also be used in a PlanetPress Design document that is being merged with the data (for example in a printed output); for more information, see PlanetPress Design User Guide. Wild card parameter "?" Data/Metadata selection functions accept a wildcard parameter "?", indicating the function operates on all nodes (not just one) of a given level. Examples l l l In a PDF emulation, the format of a selected region could be: region(?,0.59375,2.21875,1.85416,2.
l To Line: the last line of the data selection. l From Column: the leftmost character position of the data selection. l To Column: the rightmost character position of the data selection. l Case Options: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent. l LowerCase: Converts all letters to their lowercase equivalent.
Data Repository lookups The Data Repository selections are made through the lookup function. Selections are done from the data located in the "Data Repository Manager" on page 606. The lookup function returns the value of a single key, which is always a string. Syntax lookup(group, return key, lookup key, lookup value) Here is a breakdown of the syntax (all arguments are mandatory): l l l l group: The name of the group in which to retrieve the value. Does not need to be surrounded by quotes.
l Bottom: Exact vertical position (in inches) that defines the bottom of the selection region. l Case Option: This can be one of three options: l l KeepCase: Keeps the current uppercase and lowercase letters as they are. l UpperCase: Converts all letters to their uppercase equivalent. l LowerCase: Converts all letters to their lowercase equivalent.
has an index of 0 and the last element's index corresponds to the collection's length minus 1. Option flags The flag value to enter should be the sum of all desired flags. So, a value of 11, which is 8+2+1, means that behavior 8, 2 and 1 are applied. A value of 0 means 'no flag'. Name Value Behavior GetAttribute 1 Search for the name argument in the attribute collection instead of the default field collection. See: "Metadata" on page 67.
Every Workflow process has its own data emulation setting, which depends on the sample data file you choose. A process's data emulation is only visible in the Workflow configuration tool when using the Data Selector e.g. to select a sample data file, but it is always set to one. A process's emulation can be changed either by choosing another sample data file (see "Choosing a sample data file" on page 63) or by inserting a "Change Emulation" on page 264 task in the process.
Lines per page: Enter the number of lines each data page contains, or use the spin buttons to increment or decrement the value. Pages in buffer: Enter the number of data pages you want the data page buffer to contain, or use the spin buttons to increment or decrement the value. Read in binary mode (ASCII emulation only): Select to read the data file in binary mode. You select this if you intend to run a PlanetPress Design document on a printer that is set to binary mode.
tools as in PlanetPress Design are available throughout your process, using the Data Selector. One notable exception however is that User-Defined Emulation is not available because it uses PlanetPress Talk code, which is not available within the PReS Workflow Configuration program. The emulation that is used in your process can change during the process, and can be different than the one used in any PlanetPress Design document used in your process.
A form feed signals the end of a data page in ASCII emulation. If no form feed occurs in the data stream, the emulation adds data to the data page buffer until the buffer is full. ASCII emulation options l Tab on carriage return: Select this option to fix formatting problems caused by isolated CR characters found within the data. When this option is selected, isolated CR characters are spaces, as defined in the Number of spaces in the tab box below.
Note Channel skip emulation is only used when merging line printer data with a PlanetPress Design document. CSV emulation options l l l l Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the data is split into two fields. If you want to use a backslash character (\) as a delimiter, you must precede it with another backslash character (thus you would e
database. By making a connection to the database, its structure can be accessed and it becomes possible to determine how data is to be pulled into the document. In a Workflow process, the database query has to be performed automatically. This can be performed by the "Database Query" on page 274 Action task. The task generates a data file that it passes to the following task, be it another Action task, or any Output task.
Note for PlanetPress Suite users: For information about setting up a database emulation in a Design document, please see the relevant page in the PlanetPress Design User Guide. Line printer emulation Line printer emulation tells the process to treat the input data as data destined for a line printer. In this emulation, a form feed signals the end of a data page. If no form feed occurs in the data stream, the emulation adds lines to the data page buffer until the buffer is full.
PDF emulation options The PDF emulation does not have any options - that is, there is nothing to set up when opening a PDF data file. In the Preferences there is a number of options that affect how words, lines and paragraphs are detected in the PDF when creating data selections. You will find these options when you select Workflow > Preferences > PDF Text Extractor. For more information see "PDF text extraction tolerance factors" on page 653.
l l l l l Lines per page: Enter the number of lines each data page contains, or use the spin buttons to increment or decrement the value. A higher value means more lines will be displayed on each data page. Note that increasing the value for this setting increases the amount of RAM used by the application and may exceed the system’s capacity. Since the Show used cells option also uses up some RAM, consider removing this option (see "Data Selector display preferences" on page 614) to reduce system load.
Note Characters referenced using the ϧ syntax are limited to values ranging from 000 (�) to 256 (Ā). Note When XML data is merged with PlanetPress Design documents on a printer DOCTYPE and ENTITY tags are ignored. XML emulation options l Cache XML data: When this option is selected, PReS Workflow Server only reloads the data if the size or modified date of the XML file changes.
About sample data files and emulation Choosing a sample file sets the process's emulation to the chosen format (see "About data emulation" on page 52). The only other way to change a process's emulation is by inserting a "Change Emulation" on page 264 task in it. Changing the emulation is particularly important if you want to make a data selection in a file after it has been changed to another format (see "Data selections" on page 47).
1. Expand the relevant resource files folder (Connect Resources or PPS/PSM Documents) by clicking the button. 2. Expand the file by clicking the button. 3. Right-click on the data file, then click Set as sample data file. For example to use a sample data file included in a Connect data mapper configuration: select Connect Resources > Data Mapping Configurations > [your data mapping configuration], right-click a data file and choose Set as sample data file.
database, and the Table/query name box updates to reflect the tables and queries available in the selected database. 5. Click Edit SQL to create the SQL query by hand to define the SQL query that retrieves the data your document requires. 6. Set the properties that define a record set: l l l Condition: Select the condition that signals the end of a record set.
Alternate syntax(not recommended): Select to prevent PlanetPress Design from automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the advanced SQL Statement dialog box. 6. Client side cursor: Select to download result sets to client computer running the SQL query. 7. Click OK to return to the Database Connection dialog box.
Note You can also use the PReS Workflow Database Action task to get data from a database, and output in multiple different formats such as CSV. See "Database Query" on page 274. Bear the following in mind: l l l l The person or plugin performing the query must have full access to the database. The data is extracted at the time of the query. A new query must be performed whenever the data needs to be updated.
Design document, 'User defined information' (sometimes created by regular tasks) and in some cases page properties and page counts. Some of the Action and Output tasks produce, alter, or use the Metadata. In addition to that, PReS Workflow provides a whole series of plugins to create and edit Metadata during a Workflow process (see "Metadata Tasks" on page 418). The things that you have to know in order to use the Metadata tasks effectively are set out in another topic: Working with Metadata.
Note Any operation that modifies the data with regards to the structure (ex: remove pages, alter the data, etc.) makes the Metadata obsolete and so it must be recreated or refreshed; see Working with Metadata. Metadata in OL Connect jobs In PlanetPress Suite, all levels in the Metadata hold information about an actual job. In Connect, that isn't the case. The Metadata file created and maintained by OL Connect tasks looks the same, but contains less information.
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. More specifically, here is a definition of these 2 types of elements: l l Attribute: A read-only, system-defined element which holds certain information about a certain node in the Metadata structure.
Note Metadata Index/Count values are one-based when viewed in the user interface: the first element in any collection has an index of 1 and the last element's index corresponds to the collection's length. However, in the API and in Metadata selections, they are zero-based: the first element in any collection has an index of 0 and the last element's index corresponds to the collection's length minus 1.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge Document. Date Date the Metadata was created in ISO format. Producti on X X X Time Time the Metadata was created in ISO format. Producti on X X X Title Title of the source document. Producti on X X X Producer Name of the software that created the Metadata. Producti on X X X Creator Name of the software that created the source of the Metadata.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge data is intended. Dimension Two floats separated by a colon indicating the media size in typographical points (ex: 612:792). Finishin g X X X X X Orientation "Rotate0", "Rotate90", "Rotate180" or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape. Finishin g X X X X X Side "Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge This attribute is a "best effort" and is devicedependent. Duplex "None", "DuplexTumbl e" or "DuplexNoTu mble"; indicates a change of the duplex status. Finishin g X X X X X InputSlot Devicedependent identifier of the media source. Finishin g X X X X X OutputBin Devicedependent identifier of the media destination. Finishin g X X X X X Weight Devicedependent weight of the media.
Attribute MediaType Description Categor y depedent color of the media. g Devicedependent type of the media. Finishin g Index Index/C ount IndexInDocument Returns the Absolute index of the node within all the nodes under the parent Document. Index/C ount IndexInGroup Returns the Absolute index of the node within all the nodes under the parent Group.
Attribute Description Categor y J o b Gro up Docum ent Datap age Count Index/C ount X X X X DocumentCount Index/C ount X DatapageCount Index/C ount X X PageCount Index/C ount X X X SelectedCount Index/C ount X X X SelectedDocument Count Index/C ount X SelectedDatapage Count Index/C ount X X SelectedPageCoun t Index/C ount X X Pa ge node within all the nodes under the parent Job.
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge X X X X X X node within all the selected nodes under the parent Document. SelectedIndexInGr oup Returns the Absolute index of the node within all the selected nodes under the parent Group. Index/C ount SelectedIndexInJo b Returns the Absolute index of the node within all the selected nodes under the parent Job.
Attribute Description Categor y J o b Author Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input. Producti on X Gro up Docum ent Datap age Pa ge Metadata in PlanetPress Design PlanetPress Design includes a complete set of Metadata-related functionality, which can be referred to as Metadata Tools.
Data comes in and is merged into a Capture OnTheGo template and stored in the Data Repository. The end-user augments the data (using the COTG as a data-entry system). The process that receives the augmented data could look into the Data Repository to retrieve the original data (or the ID of the original data records) in order to augment, modify or delete it. l Structure As can be seen in the "Data Repository Manager" on page 606, the Data Repository consists of Groups, Keys and KeySets.
Accessing the Data Repository Via plugins Storing data in the Data Repository Data can be stored in the Data Repository using the Push to Repository task (see "Push to Repository" on page 299). Retrieving data from the Data Repository In any Workflow task where variable data is allowed (recognisable by the maroon field labels), information can be retrieved from the Data Repository using a Lookup function. Right-click a field with a maroon label and select Get Repository Location.
Note Lookup()returns NODATA when the group and/or key does not exist. In previous versions of the software, trying to do a look-up in a non-existent group and/or key would cause an error. This change in behavior may affect any Workflow configuration that uses an on error process related to invalid groups/keys. Scripts In a script you can access the Data Repository using the "Data Repository API" on page 152. For a quick start, turn to this How-to: Interacting with the Data Repository API.
Error handling, on the other hand, occurs when your configuration has been sent to PReS Workflow services, and are running in "production" mode. The automated handling of errors within your processes will have a large impact on recovering from errors as they happen during production. About error handling When your process is running, or during debugging, it may happen that the task that is currently running causes an error, and the task fails.
overwrite the default behaviors. 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: In the initial input tasks, this group is disabled and defaults to Stop Process.
All error codes are listed in the knowledge base of PReS Workflow. 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 PReS Workflow 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.
Note Local variables in the process are not sent to error processes, even if the error process has a variable of the same name. Accessing the Logs If your process is running live in thePReS WorkflowService, you have two ways of seeing what is happening now or what has happened in the past. Viewing running processes To view what processes are running and processing data as it happens: 1. In the PReS Workflow Ribbon, click on the Tools tab, then select Service Console in the Services group.
depends on the logging level that you set in the "General and logging preferences" on page 655. Viewing logs for jobs that have already processed The logs for jobs that have already processed are available in the following folder: C:\ProgramData\Objectif Lune\PlanetPress Workflow 8\PlanetPress Watch\Log You can access this folder more quickly by using this procedure: 1. From PReS Workflow Configuration software, press CTRL+SHIFT+ALT+F4 simultaneously. The PReS Workflow working folders are opened. 2.
Granted that you have backup copies of the files polled by an Input task, you may resubmit them as required. The PReS Workflow Configuration tool gives you the option to resubmit them as they were submitted originally (polled by the initial input task) or to submit them to those tasks located on the index you select. The numbers on the left in the Process area indicate the task index. In the above image, the Folder Capture task is on level 1 and the Text condition is on level 4.
Warning The From page and To page boxes are only useful for Printer Queue (or printer capture) Input tasks. They will not function for other types of inputs. In these cases, the complete backup job is submitted. 6. Click Send to resubmit the data. 7. To resubmit backed up input files for the same process or for a different one, repeat step 2 to step 6. 8. To close the File Resubmission dialog box, click Close.
Prerequisites Before you can start debugging, these are the prerequisites. l There must not be any "Unknown tasks" on page 510 in the process. l A sample data file must be selected; see "Choosing a sample data file" on page 63. Note The sample job file should generally be the exact same format as the data that the process will receive when PReS Workflow is processing the job at run-time.
breakpoints may be used and given steps may be passed, using the buttons on the Debug ribbon (see below). l Right-click on any task in the process and click Run from Here or Step from Here. These actions are the same as using the debug Step and Run buttons, but will execute the process only starting from that task forward. 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.
l Use the Ignore button to disable the task, branch or condition that is currently selected. If you disable a branch or condition, all tasks inside that branch or condition are ignored including the output. Note that if you set a task, branch or condition to be ignored, it will also be ignored at run-time, providing you sent the configuration to the service.
l l l Step through the process until the emulation or data change, as in the first method. Save the data file locally and then select it as your sample data file, as with the second method. 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.
Presets are created in the Connect Designer and can be used with any Connect template (see Output Creation Preset and Print Options in Connect's Online Help). For some options, such as grouping documents and splitting jobs, a Job Creation Preset is required as well (see Job Creation Preset in the Connect Online Help). Presets have to be sent to or imported into Workflow before they can be used in a Workflow process.
l Associate the document with that Printer Queue (see "Associating PlanetPress Design documents and PReS printer queues" on page 106). Printer-centric printing Alternatively the merging of the document and data can take place inside a printer (if the printer is suitable for it). In that case, PReS Workflow sends one of two things to a printer: l l A file that contains only the data to the selected Printer Queue.
server. In the case of a Windows Output printer queue, on the other hand, you will find the name of a local or shared Windows printer queue. Using Printer Queues To send print jobs to any of those PReS Workflow printer queues, you must use a "Printer Queue Output" on page 502 task. Note that with a single task, you can send print jobs to multiple Workflow printer queues, regardless of queue types.
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.
Windows Output printer queue Windows output printer queues send print jobs to local or network printer queues set up in the Windows session in which PReS Workflow is running. Properties General tab l l l Printer queue: Select the Windows printer queue to which you want to send print jobs. Job name: Enter the job’s file name. By default, the variable %f (Job File Name; see "Standard variables" on page 513) is used. You may use a different variable, but you may not use a data selection.
l Command value: Use this box to edit the code of the command currently selected in the Commands box. Use the right-click menu for a list of standard printer control characters. (See also: "Frequently used printer control characters" on page 96.) LPR Output Printer Queue LPR output printer queues send print jobs to LPD-compatible printers using the LPD/LPR protocol.
l l l l l l Commands: The list of available commands appears in this box. Select either Pre-job commands or Post-job commands in the Selected box, and double-click a command from this list to add it to the appropriate list. Selected: Select either Pre-job commands or Post-job commands to add new commands to the appropriate list and to see those commands that have already selected. Double-click a command to remove it from the selected list.
General tab l FTP Server: Enter the IP address or host name of the FTP server. l User name: Enter an FTP server user name. l Password: Enter a password associated with the FTP server user name entered above. l l l l l Use FTP Client default port number: Forces the FTP connection on port 21, the default FTP port. 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.
l l l 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. Use the right-click menu for a list of standard printer control characters. (See also: "Frequently used printer control characters" on page 96.
l l l l l Selected: Select either Pre-job commands or Post-job commands to add new commands to the appropriate list and to see those commands that have already selected. Double-click a command to remove it from the selected list. 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.
Load balancing can only be used for jobs sent to Printer Queue output tasks and it only applies when multiple Workflow Printer Queues are selected. In the General tab of the Printer Queue Output Properties dialog box, you may select multiple printers, and in the Advanced tab, you can set the load balancing options for the selected printers.
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 Properties setup PReS Workflow WinQueue Input task can be configured to set a Windows printer queue using Objectif Lune Printer Driver (PS) to produce one of 3 different types of data files: EMF, PostScript, or PDF.
Data Capture from PReS Workflow Once a shared Windows printer queue using Objectif Lune Printer Driver (PS) is installed on both the server and the client sides, data capture can be achieved the same way as with any other Windows printer queues. 1. Open your PReS Workflow Configuration program. 2. Insert a new process. 3. Select WinQueue Input from the Plugin Bar and insert it in the new process. 4.
About Metadata Metadata files are files containing information on the job itself rather than containing the job per se. A job sent to the Objectif Lune Printer Driver (PS) creates its own Metadata, allowing users to retrieve relevant information, such as, for instance, the time and date the print request was sent. For more on this, see the Metadata documentation pages ("Metadata" on page 67).
1. Select the document as displayed under one of the printer queues in question and from the right-click menu choose Delete Instances. The Delete Document Instances dialog box appears. 2. In the Printer Queue list, select all those Workflow printer queues for which you want the printer queue—document association to be broken. 3. Click OK.
included in the process are performed regardless of schedule, granted that the previous task was performed. The available processes in your PReS Workflow Configuration are listed in the "Configuration Components pane" on page 582. Processes in a configuration will always run concurrently. You can schedule processes to run only at certain times or intervals (see "Process properties" on page 619).
Subprocesses Subprocesses are special processes that can be called by any other process. These act exactly as subroutines in programming languages, allowing users to reuse existing processes by sharing them to the whole configuration file. They can thus be used to perform redundant operations that may need to be executed numerous times; for instance, archiving a copy of a zipped file received as the input job file, then decompressing it before sending the unzipped version of it back to the calling process.
have as many tasks as necessary (see: "About Tasks" on page 197). To add a PReS Workflow startup process: l l In the Ribbon, go to the Home tab and click the Startup Process button in the Processes group. In the Configuration Components pane, right-click on any process or the Processes folder and select Insert Startup Process. Note You can only have one Startup process in any given configuration and cannot add more.
"Importing PlanetPress Design documents" on page 40 and "Importing PrintShop Mail documents" on page 43. To import processes and other components from a configuration file: 1. From the PReS Workflow Button, choose Import | Configuration Components. The Import dialog appears. 2. Navigate to the PReS Workflow configuration file containing the processes or groups of processes you want to import. 3. Select the file, then click Open.
Important considerations l l When importing a PReS Workflow configuration file, resource files like Connect templates, PlanetPress Design documents and PrintShop Mail documents are not physically imported as they are not part of the configuration file itself. In order for the documents to be available, you will need to send each document from Connect Designer, PlanetPress Design or PrintShop Mail (see their respective documentation for details).
Process properties To have access to the properties of a process or subprocess: l Right-click on the process in the Configuration Components pane. l Select Properties. You can also double-click on the process to show its options. Note Subprocesses do not have the "General" tab which is only used for scheduling, but they do have the Information tab. Options General tab l l l l l Active: Select to make the process active.
l l l l Day(s) to keep backup: Indicate the number of days to keep backups of jobs processed by input tasks. Note that backups will only be kept for those input tasks that have the Keep backup file option selected and that they are required to resubmit input files. Polling interval: Enter the frequency (in seconds) at which the process should verify if there are new jobs to process. The polling interval also applies to scheduled tasks that only run on certain times.
a given day. To activate the Time Grid, the "As soon as possible" option must be unchecked. In the Time Grid, a blue block will indicate that the process is active within that time block. White blocks mean the process will not be active.
l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two. l l l l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click. To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler.
l l Description: A one-line box to give a title or short description to your process. Comments: A multi-line box to give more detailed information, for example the file format expected, explanation of the system in general. On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings.
Adding branches The PReS Workflow Configuration program offers two different commands when it comes to adding new branches to a process: You can add a new branch, by dragging and dropping a branch, from the Process Logic category of the Plug-in Bar, into your process. Branches can thus be added like a task; see "Adding tasks" on page 198. You can add a new branch that contains all of the tasks below the point where you insert the branch.
automatically passed to the subprocess, which means that, if the subprocess needs to use a different emulation than the calling process, a Change Emulation task is required. If any task converted into a subprocess was previously using local variables, these variables must be removed or transferred to global variables or Job Information variables to be usable in the newly created subprocess (see "About variables" on page 511).
As you are working on your configuration, you can save that configuration file as a file on your local hard drive. Saving a configuration file never replaces the current PReS Watch service configuration. To do this, you must use the Send Configuration command. When the PReS Workflow Configuration program sends a configuration, the PReS Workflow service is stopped and restarted, if it is currently running, and the new configuration starts being applied immediately.
Note .OL-workflow files are equivalent to .pp7 files made with older versions of PReS Workflow. They contain the processes and such used by Workflow. If the PReS Workflow Service is running when you send a new configuration, it stops and restarts automatically with the new configuration. If the service is stopped before sending the configuration, it will not restart automatically.
Note If PReS Workflow service is paused when you send a new configuration, it will not stop and restart. Since PReS Workflow service reads its configuration file when it starts up, when you resume processing, PReS Workflow service will continue using the old configuration.
Using Scripts Scripts can be used to perform various operations, such as to manipulate data, for example. PReS Workflow can perform scripts written in four different scripting languages and also provides an interface for editing scripts. Warning While this chapter provides some very useful and detailed information about scripting within PReS Workflow, its focus is to inform you about the features, variables and functions unique to this environment.
Multiple APIs (methods of communicating with PReS Workflow scripting tools) are available through the scripting engine, in all languages. l l l l l l l The Watch object is used to communicate with your current process and configuration. See "The Watch Object" on page 137. The PReS Connect REST API consists of many services that expose access to a number of areas including Workflow, data entity management and file store operations. See the Connect REST API Cookbook.
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" on page 673.
make a selection in the Save as type drop-down list. 6. Click OK. Find Strings in a Script The Find Text dialog box allows you to search for text strings in the editor. The available options help you limit the search, making searches quicker and easier. To find strings in a script: Note If you only want to search a particular section of the script, you should select it before performing the following procedure. 1. Choose Search | Find, or press CTRL+F. The Find Text dialog box appears.
scope to selected 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.
l l l l l l l l Regular expressions: Select to treat the regular expressions of the scripting language as text. If you clear this option, the regular expressions of the language are blocked from the search. Prompt on replace: Select to have PReS Workflow display a prompt before it replaces text. When you use the Replace All function, you are prompted each time matching text is found. The prompt includes an All button for replacing all matching text. This suppresses any further prompting.
Once again, if you selected Prompt on replace, a dialog box opens to ask you whether to proceed with the replacement. You can OK to replace that string only, or you can click All to replace that string as well as every other string that matches the replacement settings. Go to a Line in a Script The Go To Line dialog box lets you jump to a specific line within your script.
To toggle bookmarks: l Place the cursor on a line in your script and, from the editor’s pop-up menu, choose Toggle Bookmark and a given bookmark number. If the bookmark you selected was not displayed on any line, it is added to the line where you placed the cursor. If the bookmark you selected was displayed on the line where you placed the cursor, it is removed. If the bookmark you selected was displayed on a different line, it is moved to the line where you placed the cursor.
Since the SOAP Server API Reference is primarily targeted at programmers or systems engineers, it is rather technical. SOAP API - SubmitJob Syntax SubmitJob (File, SubmitJobInfStruc , ReturnJobFile, user name, Password) : SubmitJobResult Description The SubmitJob method allows users to remotely submit files to their PReS Workflow from a SOAP client. The SOAP client has the option to wait for a response file from PReS Workflow SOAP server. Arguments l l l File – base64Binary.
existed at the completion of the PReS Workflow 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). Note The SubmitJob method only returns a file if the PReS Workflow process contains a SOAP Input task. Note If ReturnJobFile is set to true, the schedule options of the process should be set to a pooling lower than four seconds, so the client application gets a timely response.
l PostJobInfStruc – Structure containing any required information to prepare the file for resubmission into a PReS Workflow process. l user name – String containing the user name. l Password – String containing the password. This value is case sensitive. Return Value l l PostjobResult - Structure containing the following information: Success – Integer indicating the Success/Error level of the operation. A result of 0 means that the operation was successful.
Parameters l user name – String containing the user name. l Password – String containing the password. This value is case sensitive. Return Value l l GetProcessListResult - Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status.
l Password – String containing the password. This is case sensitive. Return Value l l GetProcessTaskListResult – Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status. l TaskNames – Structure containing the following information details.
Return Value l l GetSOAPProcessListResult – Structure containing the following information: Success – Integer indicating the system-defined Success/Error level of the operation. A result of 0 means that the operation was successful. l Message – String containing text information about the Success status. l ProcessList – Structure containing the following information details. l l SOAPActionName – String containing the name of the process as seen in your PReS Workflow.
Note If both FirstPage and LastPage are set to 0, the entire data file is used. SOAP API - SubmitJobInfStruc SubmitJobInfStruc Structure containing any required information to prepare the file for a valid insertion into a PReS Workflow process. l l VariableList – Array of complex type, containing pairs of variable name and variable value.
Variable Name Description Example Usage (VBScript) "Watch.GetJobFileName" on page 142 Retrieves a string containing the job path and file name located in the job spool folder. Example Usage: str = Watch.getjobfilename "Watch.GetOriginalFileName" on page 143 Retrieves a string containing the job's original path and filename. Note: this filename is generally no longer available if it has been captured by Watch. Example Usage: str = Watch.getoriginalfilename "Watch.
Variable Name Description Example Usage (VBScript) "Watch.Log" on page 149 Writes to the Workflow log file, or the message window when in debug - can accept multiple log levels from 1 (red) to 4 (gray). Example Usage: Watch.log "Hello, World!",1 "Watch.ShowMessage" on the next page Displays a popup dialog box to the user (user has to be logged on). Example Usage: Watch.showmessage("Hello, World!") "Watch.
Variable Name Description Example Usage (VBScript) Example Usage: Watch.executeexternalprogram "del *.ps" "c:\" 0 true "Script.ReturnValue" on page 151 Returns a boolean True or False value to a Workflow scripted condition Example Usage: Script.returnvalue = 1 Watch.GetPDFEditObject Is used to manipulate PDF files using the AlambicEdit API. See the AlambicEdit API for more information. Watch.ShowMessage Displays a message to the user. This method is the same as PW_ShowMessage.
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.
Examples VBScript Watch.ExecuteExternalProgram "lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true JavaScript Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, true); Python Watch.ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\\myfile.ps", "c:\\", 0, True) Perl $Watch->ExecuteExternalProgram("lpr -S 192.168.100.001 -P auto c:\myfile.ps", "c:\", 0, true); Watch.GetJobFileName Returns the complete path and file name of the job.
Python s = Watch.GetJobFileName() Watch.Log("The job filename is: " + s, 3) Perl $s = $Watch->GetJobFileName; $Watch->Log("The job filename is: " + $s, 3); Watch.GetOriginalFileName Returns the original name of the file, when it was captured. This method is the same as PW_ GetOriginalFileName. Example VBScript Watch.GetOriginalFileName JavaScript Watch.GetOriginalFileName(); Python Watch.GetOriginalFileName() Perl $Watch->GetOriginalFileName(); Watch.
Python Watch.GetMetadataFileName() Perl $Watch->GetMetadataFileName(); Watch.InputBox Warning 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 PReS Workflow 7.3 and higher. Prompts the user to enter a string. The string is displayed as the window caption. You can specify a message that is displayed above the text box. This method is the same as PW_ InputBox.
VBScript s = Watch.InputBox("Your Name", "Please enter your name", "John Doe") Watch.ShowMessage("Will the real " + s + " please stand up?") JavaScript s = Watch.InputBox("Your Name", "Please enter your name", "John Doe"); Watch.ShowMessage("Will the real " + s + " please stand up?"); Python s = Watch.InputBox("Your Name", "Please enter your name", "John Doe") Watch.
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: " . $s, 2); Watch.SetJobInfo Sets the job information index to a specified string value. Syntax Watch.SetJobInfo(Index: Integer; Value: String) Example VBScript Watch.SetJobInfo 3, "Job info 3 Value" JavaScript Watch.SetJobInfo(3, "Job info 3 Value"); Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.
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.Log("MyVariable's value is: " + s, 2); s = Watch.GetVariable("global.MyVariable"); Watch.Log("Jobinfo 3's value is: " + s, 2); Python s = Watch.GetVariable("MyVariable") Watch.Log("global.
JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); 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.
Python s= Watch.ExpandString("%y-%m-%d") Watch.Log("Current Date is: " + s, 2) Perl $s = $Watch->ExpandString("%y-%m-%d"); $Watch->Log("Current Date is: " . $s,2); Watch.Log Creates messages that are added to PReS Workflowwatch.log file. PReS Workflow watch.log file is located in ...\Program Files\PReS Workflow 7\PlanetPress Watch\Log\ppw[log date].log. View error messages in the Services Console while PReS Workflow is in Run mode by choosing Tools | Services | Service Console.
Level Description 1 The message is logged as an Error in the log file. 2 The message is logged as a Warning in the log file. 3 The message is logged as Information in the log file. 4 The message only appears when the application runs in Debug mode. Examples In the following example, log() will write an information entry in the watch log that says "this is a log" VBScript Watch.Log "this is a log", 3 JavaScript Watch.Log("this is a log", 3); Python Watch.
VBScript Watch.Sleep 1000 JavaScript Watch.Sleep(1000); Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.ReturnValue Set this variable to 1 (true) or 0 (false) in order to return a true or false status to PReS 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.
Script.ReturnValue = 0 } Python everythingOK = True if everythingOK: Script.ReturnValue = 1 else: Script.ReturnValue = 0 Perl $everythingOK = 1; if ($everythingOK) { $Script->{ReturnValue} } else { $Script->{ReturnValue} } = 1; = 0; Data Repository API The Data Repository is a permanent structure to store data that can then be reused, modified or augmented at a later time, by different processes.
The term ... ... is the same as an Excel ... ... is the same as a Database ... Group Sheet Table Key Column Field KeySet Row Record Note Group and key names are case-insensitive. API Reference Obtaining an instance of the Repository Object The Data Repository is accessed via a COM object that exposes methods to store and retrieve data within the Repository. JavaScript var repoObject = new ActiveXObject ("RepositoryLib.
Using a JSON parameter or return value Whenever a parameter or return value is defined as a JSONStringArray type, that JSON array is itself a string. Since a JSON array internally defines double quotes as the delimiter for each element, you must enclose the entire string in single quotes. Alternatively, you can escape the double quotes inside the JSON Array. For instance, the following calls to AddGroup() are correct: repoObject.AddGroup("MyGroup",'["FirstKey", "SecondKey"]'); repoObject.
Name Description existing key structure. ConnectionString Creates/opens a Repository to read from and write to at a custom location. Set ConnectionString to a string containing a full path and file name. Version Returns the version of the DLL library used by the Repository. Group methods Name Description AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty.
Name Description only adds a key name to the group, not a key value. See AddValue() for information on how to set a value for a key. ListKeys Retrieves the list of all Key names and data types in Group GroupName, stored in a JSONStringObject. You should use JSON.Parse() to convert the string into an actual JavaScript object. You can then use the for…in construct to list the different properties for that object (i.e. the keys in the group). RemoveKey Removes existing key KeyName from group GroupName.
Name Description Condition may be left empty in which case the very first value found for the specified KeyName is returned. SetValue Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition. The condition is specified using basic SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note that KeyName must exist in GroupName, otherwise an error is raised.
Name Description GetKeySets Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all keys are retrieved. When Condition is left empty, all keysets are retrieved. RemoveKeySets Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. Condition may be left empty, in which case all keysets in GroupName are deleted. The method returns the number of keysets that were deleted.
VB Script repoObject.AddGroup "Users", "[""FirstName"", ""LastName""]" repoObject.AddGroup "Users", "" AddKey Adds key KeyName to group GroupName. KeyName must not already exist in the specified group. Note that this method only adds a key name to the group, not a key value. See AddValue() for information on how to set a value for a key.
Examples Basic examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 153). JavaScript repoObject.AddKeySets("Users", '[{"FirstName": "John","LastName": "Smith"},{"FirstName": "Richard", "LastName": "Doe"}]'); VB Script repoObject.
AddValue Creates a new KeySet by assigning Value to the key KeyName in Group GroupName. Note that KeyName must exist in GroupName, otherwise an error is raised. See AddKey() for information on adding a key to a group. Upon successful completion, the method returns the ID of the newly created KeySet.
ClearGroupData Deletes all keysets inside GroupName while retaining the existing key structure. Syntax ClearGroupData(GroupName: string) ClearRepository Deletes all groups, keys and keysets from the repository, returning it to a blank state. Use with caution! Syntax ClearRepository() GetKeySets Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all keys are retrieved. Note In versions prior to 2018.
Examples Basic examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 153). JavaScript repoObject.GetKeySets("Users", '["FirstName","LastName"]', "Gender='M'"); VB Script myKeySet = repoObject.
The return value (saved for example in the %9 JobInfo variable, as the above example does) can be used in a number of ways: l l l It can be returned to a web page that's making an HTTP request to Workflow. JSON is the simplest way to transfer information between any system that supports JavaScript. It can be passed to Designer and loaded up directly as an object in a script there. The JSON can be converted to XML, which makes it useable in the DataMapper module.
John Smith */ myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" ") /* retrieves email for first user named Smith */ myValue = repoObject.GetValue("Users", "email", "") /* retrieves email for first user */ Retrieving a KeySet ID This JavaScript example retrieves the KeySet ID, which is then used to update values in the row. /* Get KeySet ID */ var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var keySetID = repoObject.
Watch.Log(myList[i],2); } Sample return value '["Users","Cart","Orders"]' ListKeys Retrieves the list of all Key names and data types in Group GroupName, stored in a JSONStringObject. You should use JSON.Parse() to convert the string into an actual JavaScript object. You can then use the for…in construct to list the different properties for that object (i.e. the keys in the group).
RemoveGroup Deletes the group named GroupName, along with all its keysets and keys. Syntax RemoveGroup(GroupName: string) Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 153). JavaScript repoObject.RemoveGroup("Users"); VB Script repoObject.RemoveGroup "Users" RemoveKey Removes existing key KeyName from group GroupName.
repoObject.RemoveKey "Users", "email" RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise. Note This method is functionally equivalent to using "RemoveKeySets" below with its Condition parameter set to "ID=ID". Syntax RemoveKeySetByID(GroupName: string, ID: integer): integer Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.
Examples Basic examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 153). JavaScript repoObject.RemoveKeySets("Users", 'Gender="M"'); VB Script repoObject.RemoveKeySets "Users", "Gender='M'" Deleting a row This script attempts to delete a client from the rows, then returns "true" or "false" in JobInfo variable %9 as a response.
Repository Object" on page 153). JavaScript repoObject.RenameGroup("Users", "Customers"); VB Script repoObject.RenameGroup "Users", "Customers" RenameKey Renames key oldName to newName in group GroupName. While this operation has no impact on the data stored in that Group, it does require any plugin and/or script that uses oldName to be modified to refer to newName.
Syntax SetValue(GroupName: string, KeyName: string, Value: string, Condition: string): string Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 153). JavaScript repoObject.SetValue("Users", ); repoObject.SetValue("Users", AND MaritalStatus='Married'" repoObject.SetValue("Users", AND MaritalStatus=''" ); "FormOfAddress", "Mr.
Note This method is functionally equivalent to using "SetValue" on page 170 with its Condition parameter set to "ID=ID". Examples In each of these examples, the object repoObject is deemed having been obtained through a call to the COM object "RepositoryLib.WorkflowRepository" (see "Obtaining an instance of the Repository Object" on page 153). JavaScript /* both methods perform the same task */ repoObject.SetValueByID("Users", "FormOfAddress", "Mr.", 10); repoObject.SetValue("Users", "FormOfAddress", "Mr.
Syntax Version(): string 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.
Watch.Log("Job Info 9's value is: " + s,4); } Python In Python, the raise statement is similar to JavaScript and will stop processing unless an except statement is used. See the python documentation. s = Watch.GetJobInfo(9) if not s: raise NameError('Value cannot be empty') else: # Do something with Job Info 9! Watch.Log("Job Info 9's value is: " + s,5) Perl In PERL, die() raises an exception and triggers the On Error tab, unless the unless command is used. See the perl documentation.
workflow since that is the type of file created by the HTTP Server Input action task. See the "HTTP Server Workflow" on the next page page for more details. PDF Workflow A PDF workflow uses a PDF as its job file and manipulations are generally made in the Metadata instead of the PDF itself, since PDF files are much larger than most other data files compatible with PReS Workflow.
HTTP Server Workflow An HTTP Server workflow is one that has one or more processes that always start with the HTTP Server Input task and returns something to a client using a web browser. Each process would have a specific task referred to as an "action", called from the browser itself.
used by default is to prevent any interference with existing web servers installed or activated on the same server as PReS Workflow. l l l Time-out (seconds): This determines how long the HTTP Server service will wait for the process to finish, before returning a time out error back to the client browser. This means that if a process takes more than 120 seconds (by default) to complete, the browser will time out.
l l l Self-Replicating Process: This option is critically important when dealing with HTTP processes. Basically, this means that when HTTP requests are received, the process will duplicate itself up to the specified maximum number, in order to simultaneously (and asynchronously) handle multiple requests. See "Process properties" on page 619 for more details.
Request/Process/Response cycle Once a process using the HTTP Server Input task is created, it is important to understand the cycle that is triggered when such a process runs. Note that this is the process when the default HTTP Server Input task options are used (more on how that behavior changes later): 1. A request is received by the HTTP service. 2. This request is converted into an XML request file along with one or more attachments when present. 3.
Example HTTP Workflows l "HTTP PDF Invoice Request" below (GET) l "HTTP Brochure Request" on page 182 (Customer Information+ POST) l "Capture Web Manager Workflow" on page 194 (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.
Process Illustration Task Breakdown 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" on page 346. The condition returns "true" if the file is not found: c:\PReS\archives\pdf\invoices\xmlget('/request[1]/values[1]/invoicenum [1]',Value
l If, however, the file is found, then it is loaded with the "Load External File" on page 294 task, and then deleted (for the same reasons). HTTP Brochure Request This workflow builds on the knowledge acquired in "HTTP PDF Invoice Request" on page 180 and uses a single process, but in this case it also uses a PlanetPress Design document which merges the data received from a browser form with the document to generate a PDF brochure, which is sent via email. Resources l HTTPBrochureRequest.
form submits back to the same URL, meaning it is handled by the same process. l l l l The file is renamed with the .html extension, so that both the HTTP service and the browser will recognize it as an HTML page. And then, as usual, it is deleted (but still returned to the browser). 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.
Note In Connect it is also possible to group, sort and split PDF data using "OL Connect tasks" on page 450. Example: Daily sales report from PDF files This workflow makes heavy use of PDF tasks and Metadata, and assumes that you are using PReS Workflow version 7.3 or higher. This single process workflow generates a daily sales report for any sales representative inside of a company which made at least one sale.
l l l l l The "Metadata Sorter" on page 431 then re-orders the Metadata documents by Rep ID, so that all of the invoices for any particular sales representative are all together. "Lookup in Microsoft® Excel® Documents" on page 367 then uses the Rep ID field to retrieve each sales representative's email from a specific Excel spreadsheet. The "Metadata Sequencer" on page 430 acts like a splitter, where the separation happens whenever the Rep ID changes.
l l l l l l l l The "Metadata Level Creation" on page 428 creates the Document level of the metadata by placing each PDF data file in its own Document level. It does this by detecting when the Address in the document changes. Then, the "Metadata Fields Management" on page 422 adds a few fields at the Document level in order to properly tag each document with the appropriate information, in this case the Customer ID, Country and Rep ID.
Capture. Please review them in "PlanetPress Capture Implementation Restrictions" on page 539. In order to properly build a PlanetPress Capture workflow, it is very important to understand the terminology, implications and limitations of the technology.
patterns l Printing your documents. Capturing and Archiving After the printed documents have been inked with the Anoto Digital Pen, the PGC files from the pen must be processed and merged with the appropriate documents in the PlanetPress Capture Database. A workflow process that receives PGC files and reads them in turn consists of the following actions: l l l l l An "HTTP Server Input" on page 223 task or "Folder Capture" on page 213 task that receives the PGC.
Error Handling Whenever an error occurs during the Capture Field Processor phase, it is of course important to be able to handles these errors. For this purpose, the "PGC to PDF Converter" on page 417 task was added with PlanetPress 7.4, adding the ability to quickly and 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 Any input task l "Create Metadata" on page 419 l "Capture Fields Generator" on page 400 l Print output PGC Handling Process The second process is the PGC Handling process. It receives data from the Anoto Digital pen, updates the Capture database and releases patterns as appropriate.
l "Get Capture Document" on page 414 l Archive or Print output Capture Post Processing Workflow Though the "Basic Functional Capture Workflow" on page 189 is minimal functional one, it will most likely not be enough for most actual implementations. The goal with PlanetPress Capture (and PReS Workflow in general) being to automate as much as possible, there are some tools within the PlanetPress Capture tasks that can greatly help with this goal.
Task Breakdown: l l l The HTTP Server Input receives a POST request sent either by the Anoto penDirector or the PlanetPress Mobile Application. This requests contains information sent by the pen as well as a PGC file as an attachment. Because we're only concerned about the PGC, the task is configured to ignore the XML envelope as well as loop through each attachments (of which there is only one). So, the output of the task is the PGC file alone.
After Retrieving Information from the Capture Database There are two basic ways in which the Find Capture Document 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.
Task Breakdown l l The Find Capture Documents task queries the Capture database for documents that correspond to certain specific conditions. For example, here we would look for all documents that are either in an "Error" or a "Partial" state, which means they received ink but are not completed correctly. To do this, the "Content Status" filter and setting it "Equal to" those states. Two conditions are necessary, and the "Condition is true when" is set to "all items are met".
3. Import the invoice.pp7 Design document into Workflow, or open it in PlanetPress Design and send it towards your local PReS Workflow server (localhost or 127.0.0.1). 4. Open the configuration file CaptureExampleProcess.pw7 5. Click the PReS Workflow button (File menu) and go in Preferences. 6. In the HTTP Server Input 2 section, check the Serve HTTP resources option, change the Resource action name box to static , and the Resource folder to c:\PReS\http . Then, click OK. 7.
Workflow processes in a Connect Send solution OL Connect Send (see "OL Connect Send" on page 436) needs one Workflow process to handle the job transfer, and in licensed mode it needs at least one other process to interact with the user. Reports about the use of OL Connect Send might be produced in yet another Workflow process. Each OL Connect Send solution will require the Workflow processes to be configured differently, but certain plugins will always be part of the solution.
Production report process The key plugin in a process that produces reports about jobs received with OL Connect Send is the Get Data plugin. It allows to query the OL Connect Send database. (See "Get Data" on page 436.) Sample project The Ad Hoc Mail Consolidation sample project may help you understand the Workflow processes for OL Connect Send and configure your own. l l Watch the sample in action on demo.objectiflune.com. Under Ad Hoc Mail Consolidation, click Demo and follow the instructions.
For more information on the tasks that are by default available to you in PReS Workflow, see the following pages: l "Input tasks" on page 205 l "Action Tasks" on page 251 l "Data Splitters" on page 321 l "Process Logic tasks" on page 342 l "Connector Tasks" on page 359 l "PlanetPress Capture" on page 524 l "Metadata Tasks" on page 418 l "OL Connect tasks" on page 450 l "OL Connect Send" on page 436 l "Output Tasks" on page 494 l "Unknown tasks" on page 510 Note Completely empty files (
2. Locate the task you want to add to your process. You can navigate between the different task categories by clicking the icons at the bottom of the Plug-in Bar. 3. Using your mouse, click and drag the task in your process at the place you want to insert it. 4. Depending on where you place your mouse, you may see that you can replace or insert existing tasks, or not place it at that location at all. 5.
Note For the list of operations you can perform on tasks in a process via the Process area, please refer to "The Process area" on page 678. Task properties Any task you add to your PReS Workflow process must be configured using its Properties dialog. It appears as soon as you add a task to a process, or when you double-click on a task. Each task's Properties dialog will give you the options to configure that specific, individual task.
Variable task properties When you edit tasks, you may notice that some of the properties that you can modify have a red (or more precisely, a maroon) title. This means that the property can be dynamically determined whenever your process runs, that is to say it will not remain static. This can be extremely useful when, for example, you want to determine how many copies you will print out depending on your data, or what document will be used in the printout depending on the department it came from.
l Variables l System: Contains system variables, also called "Standard variables" on page 513. l Job Info: Contains Job Info variables from %1 to %9 l l l l l l l l l Local Variables: Contains a list of local variables in this process. If no local variables exist, this item is disabled. Global Variables: Contains a list of global variables in this configuration. If no global variables exist, this item is disabled.
l l Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example. The lookup() function indicates a lookup in the "Data Repository Manager" on page 606. Masks Certain tasks, such as the Folder Capture Input task and the File Name Condition task, allow for entering a mask instead of a file name. See Masks. Date and Time Format To simplify things and to prevent errors, date and time formats have been standardized.
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 task, 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.
This is an important consideration when scheduling a task, as the Folder Capture task will keep capturing files as long as new files are added, even if it means continuing to capture and process outside its scheduled time. It is also important that while the Folder Capture input task is processing files it keeps a copy of each file in a temporary folder, and will not delete any of these files until it has finished processing all of them. This may cause issues with running out of disk space.
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 PReS 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.
l HTTP PDF Invoice Request l HTTP Brochure Request Input Create File does not capture any file and, if it is a secondary input task, discards the current data file. Processing Create File generates a job file with the contents of it's text. If variables and control characters are present, they are evaluated at run-time when the task is executed. Output The output is the job file.
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 PReS 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.
inbox are retrieved. Emails retrieved using POP3 are deleted from the server, emails retrieved from an Outlook inbox are moved to the Deleted Items folder by default. Processing Depending on the options selected below, each email is converted into a text-only data file, and each attachment is separated from the email. Output Depending on the options, each email is sent as a data file, followed by each of its attachments sequentially.
Note Since characters '?' and '*' are considered valid to define the subject of an email, their use as wildcards is not supported . l l l Nothing: Select to limit those messages used by this task to those that do not specify any subject. “From” contains: Select to limit those messages used by this task to those that are sent from a specific address. The address you enter in the box below can include variables.
l Password: Enter the password required to unlock the selected account on the POP3 mail server. This box is only enabled when the Use POP3 mail option is selected. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
Note Because of the way Microsoft Exchange works, when receiving an email from a user on the same local Exchange server, the email address may not be available. See FAQ-1509 in the Knowledge Base of PReS Workflow. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
Warning If you create a Folder Capture input task that takes any file it finds in the root folder of one of your hard disks, then PReS Workflow will try to remove all the files located in that folder, including all the system and hidden files. So when using a Folder Capture, be aware of where you are capturing. Processing Each file capture by the input is sent down through the process, one at a time.
elements of the RegEx syntax, therefore they cannot be mixed and matched with Workflow variable data syntax (e.g. %1, ${global.myvar}, etc.). Also, there is no validation of the RegEx being specified. l l l l l l l Sort files by: Select a given sorting method to prompt PReS Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order). Select None to let PReS Workflow take the files without sorting them first.
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 PReS 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.
Processing Folder Listing loops through the files and, for each file, generates an XML node with information about the file. Output The output is an XML file containing information about each file. If the Sub-directories option was checked, the structure of the XML also contains the folder structure as it is present on the drive. Here is a sample of the XML that is generated: C:\Samples\ invoice.
Note The
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Task properties General Tab l FTP Server: Enter the IP address or host name of the FTP server to poll. l User name: Enter the name of a user account on the FTP server. l l l Password: If account named in the User name box is password protected, enter the password here. Port number: Set to use a specific port number. Note: There is no validation to ensure the port is available.
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 %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.
Processing No processing is done by this task. The file retrieved is not changed in any way. Output HTTP Client Input will output a single file which was retrieved from the web. Metadata is not generated by this task. Task properties General Tab l l URL: Enter the URL of the HTTP server from which the file must be downloaded. Since this is a variable property box, variables may be used, as well as the Get Data and Select Data commands (see "Variable task properties" on page 201).
Job Information definitions l %1 - URL address: Contains the full URL that was requested by the task. This includes any GET variables in the URL. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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.
and to let Workflow process things only it can do. For more information on how to serve HTML and PDF generated by Connect through IIS, watch the Connect with Evie - IIS series. Warning It is highly recommended to make all processes using the HTTP Server Input task selfreplicating and to reduce their polling interval in the Process Properties.
effectively doubling the size of the incoming file. Due to technical restrictions, the incoming XML file cannot be more than 400MB, which because of CDATA is reduced to around 200MB. To help in this situation, you may elect to omit from the attachment, which can be changed in HTTP Server Input User Options. Please note that incoming binary files (sent through file upload in a form) can never be larger than 400 MB.
Task properties General Tab l l l HTTP action: Enter the name of the action requested of PReS Workflow by the client. This name corresponds to the URL that the client will be accessing. For example, if you enter "MakePDF" here, you could trigger the process by accessing http://127.0.0.1:8080/MakePDF . This is also what your HTML Form's action should be. MIME Type: Select the MIME type of the file that will be returned by the plugin.
"Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. 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 PReS Suite Workflow Tools working folders under the "Backup" folder.
Input Error Bin The Input Error Bin task is used specifically and only to create error management processes. These processes do not run on their own but are rather triggered by the On Error tab of tasks in other processes, when that task fails. Input This task receives a data file from a task that generated an error. Accompanying this data file is the current Job Infos of the process that triggered the error.
Task properties General Tab l The Input Error Bin task does not have any specific properties unique to it, since it only receives input directly from tasks in other processes when an error is generated. For more information, see the chapter on "Debugging and error handling" on page 81. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Input SOAP The Input SOAP task 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" on page 223 task. Note SOAP communication is non-trivial and requires a certain understanding of XML and the SOAP protocol.
Task properties General Tab l SOAP Action: The SOAP action is used with the SubmitJob action. It’s the equivalent of the process name. The difference is that more than one processes can share the same SOAP action. That way more than 1 CPU can be used to process all the incoming requests however this means that all process sharing the same SOAP action must be identical because there is no way to decide the execution order of all the process.
the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. LPD Input LPD (Line Printer Daemon) Input tasks retrieve data in the form of print files sent from remote computers using the LPD/LPR protocol. The PReS Workflow LPD server starts automatically when a configuration that includes at least one active LPD Input task is started.
"Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. 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 PReS Suite Workflow Tools working folders under the "Backup" folder.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Merge PDF Files The Merge PDF Files Input task (formerly named "Concatenate PDF Files") captures all PDF files in a given folder and merges them into a single PDF file. This task is put into effect in the following example process: "Example: Daily sales report from PDF files" on page 184. Input This task captures all of the PDF files present in a specific folder, in one operation.
Task properties General Tab l l l l l l l l l Folder: Enter the full path of the folder from which the input files are to be taken. Masks: Enter a single or multiple file names or use file name masks. See Masks. Since this task only supports PDF files, make sure your extension remains .PDF for all your masks. Sort files by: Select a given sorting method to prompt PReS Workflow to sort the files in the source folder before taking them (and thus to take them in a specific order).
Note Metadata can be manipulated with Metadata tasks; see "Metadata Tasks" on page 418. "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. 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.
Serial Input Serial Input tasks receive files sent to a serial port on the computer running PReS Workflow. All the Serial Input tasks in a PReS Workflow configuration share the same general properties, which are configured through user options (see "Serial Input plugin preferences" on page 662). Only the properties set in the Other and Error tabs are specific to individual tasks. Input This task does not poll an input, it sits there and waits for a job file to be sent through the Serial connection.
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 %1 - Source file name: Contains the name of the job file as specified by the software that sent the job.
files in the queue. Once all the files are gone, the task polls the FTP folder again to see if new files are present and, if so, the process continues with these files. Otherwise, the process ends. Output The output to this task is a series of individual files, one after the other. These files are not modified in any way from when they are captured from the source FTP server. Task properties General Tab l Server Settings group l FTP Server: Enter the IP address or host name of the FTP server to poll.
home directory is usually under the server main user directory and generally includes the user’s name. For example, if "/tmp/temp/copy_pending" is entered, it does not point to the "/tmp/temp/copy_pending" directory but to the "/users/support/tmp/temp/copy_pending" directory. l l l Delete remote file: Check this option to delete the file after it has been retrieved by Workflow. Connection mode group: This group is only relevant to the FTPS protocol and appears when it is selected.
l l Approve: Click to add the server to the list of approved servers. Refresh: Click to refresh the list of known servers "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. 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.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Input The SMTP Input task does not, by itself, capture any files. Neither does it directly wait for requests to be received.
places them in a specific location on the drive. When a request is received, the SMTP Input polls that location and finds the requests and all attachments. It will always pick up the "oldest" request received. Warning Due to a technical limitation the SMTP Input task does NOT receive the BCC addresses from most emails sent to it. Processing The task reads the incoming SMTP request and provides the data within its body.
Task properties General Tab l l Data location: Determines what files are sent into the process: l Envelope: Only the request envelope is sent to the process (see above). l Attachments: Each attachment is sent down the process (see above). Unzip attached file: Select to unzip the attached files. l l Zip password: Enter the password required to unzip the attached files (if any). Note that you can use variables and data selections.
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 %1 - Date Received: Contains the date and time at which the email was received. l %2 - Originator Name: Contains the Name of the sender (in the from field).
multiple Telnet input tasks. To turn on or off the Telnet logging option, see the user options (see "Telnet Input plugin preferences" on page 664). Input This task does not poll an input, it sits there and waits for a job file to be sent through the Telnet port. Processing When the job is received through Telnet, it is saved as a job file. No further processing is done on the file. Output The task outputs the job file as is, with no evaluation or modification.
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 This task does not generate any job information. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks.
Input The WinQueue input regularly polls the selected printer queue for new jobs. When a new job is available, it is captured automatically by this task. Processing The print job, by default, is in EMF format. If this option is selected, no action is taken on the data file. However, if the RAW format is selected, the job is converted to RAW. Furthermore, if the Create PDF option is selected, the file is converted to a PDF, including metadata.
l Include empty files: Check to process empty incoming jobs. The output will be empty, the job is deleted from the print queue, but the job information is available in the process (sending computer and user name, etc). "Other" Tab l Job Information group l l l l l Information elements: indicates what job infos are automatically created by the input task. Add lines before first data page: Using the arrows keys you can add any job information directly at the beginning of your data file.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Action Tasks Use action tasks in PReS Workflow to perform a wide variety of operations.
l "Mathematical Operations" on page 295 l "Open XSLT" on page 297 l "Push to Repository" on page 299 l "Rename" on page 301 l "Run Script" on page 349 l "Search and Replace" on page 305 l "Send Images to Printer" on page 306 l "Send to Folder" on page 308 l "Set Job Infos and Variables" on page 310 l "SOAP Client plugin" on page 497 l "Standard Filter" on page 314 l "Translator" on page 315 l "Windows Print Converter" on page 317 Add Document The Add Document action task prepares a
Output The output is a PostScript job that can be sent to any output task in "passthrough" mode, for example Create PDF, PReS Image, etc. Metadata is not generated by this task. Task properties General tab l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be merged with that document (see "PlanetPress Design documents" on page 38).
Input Any text-based file can be used in this task, even formats that are not directly compatible with PReS. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task. Processing The selected operation (adding or removing lines, text or pages) is made on the data file. Output The modified data file is output from this task. Metadata is not modified in any way if it is present.
l l l Characters: Enter the string of characters to be added to the job file. This box is only displayed when the Characters option is selected in the Content box. Lines: Enter the lines of text to be added to the job file. This box is only displayed when the Lines option is selected in the Content box. Remove: Enter the number of characters or lines to be removed from the job file.
Output The modified data file is output from this task. Metadata is not modified in any way if it is present. Task properties General tab l Search mode group: Select your chosen search mode within this group. l l l l l Search line by line: Select if you want each line in the data stream to be searched separately. When this option is selected, PReS Workflow considers each line as an individual data stream (lines are separated by Line Feed characters).
l Position options group: Specify the location where the string must be found using this group. Note that this whole group is disabled when the Treat as regular expression option is selected. l l l l l l Anywhere on the line: Select to indicate that the search string can be anywhere on the line. At the beginning of a line: Select to indicate that the search string must be the first string on the line. At the end of a line: Select to indicate that the search string must be the last string on the line.
l l All before occurrence: All occurrences of the search string will be replaced until the specified number of occurrences has been reached. Specifying 5 occurrences, for instance, means that the four first occurrences will be replaced. Replace with: Enter the string that must be used as the replacement sting when a match is found. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks.
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. Note 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.
Barcode types Description Code93 Code 93 symbology. Compressed form of Code 39. Code128 Code128 symbology. Very dense code, used extensively worldwide. Codabar Codabar symbology. Used in libraries and blood banks. Inter2of5 Interleaved 2 of 5 symbology. Used in warehouse, industrial applications. Add2 2 additional digits code for UPC-based symbologies. Used to indicate magazines and newspaper issue numbers. Add5 5 additional digits code for UPC-based symbologies.
Note The fewer barcode types are selected, the faster the plugin performs. Selecting only the expected barcodes is therefore a good practice. Barcode orientations Barcode orientations represent a barcode orientation on an image. For example, when the leftto-right option is checked, the task will try to read the barcode value assuming that the barcode data should be read in a left-to-right fashion. Note The fewer orientations are selected, the faster the task performs.
Barcode Scan task character replacement option will allow successful barcode reading of all non-printable characters in a given barcode. The value specified in the Replace non-printable character with option will be found in place of any non-printable character in the BarcodeValue and Barcode_x_Value Metadata fields, while the original barcode value (i.e. with non-printable characters) will be available in the BarcodeBase64_x_value Metadata field. This option allows only one printable replacement character.
l l If the selected option is process by page, then the Metadata file is created and overwritten for each new scanned page. If the selected option is process by file, then only one Metadata file will be created (or updated). Note If Metadata was created previously in the process, the task only adds new fields to the existing Metadata at the datapage level. Metadata fields The barcode values are stored at the datapage level of the Metadata.
l l Barcode_1_Left: Metadata field providing the distance (in pixels) from the left of the page to the left side part of the first barcode. Barcode_1_Right: Metadata field providing the distance (in pixels) from the left of the page to the right side part of the first barcode. Accessing a barcode value from the Workflow tool One method to access a barcode value from the Workflow configuration tool is to use a VBScript with the Open Script task, using the Watch.
Emulation action task. All the tasks that follow on the same branch will use the emulation chosen in the Change Emulation task. Input Any data file. Processing The emulation for the following tasks is changed to the selected emulation. Output The original data file, metadata and job infos are not modified. Only the emulation is changed.
start of the first data page. Note that you cannot add lines in either a CSV or user defined emulation. Lines per page: Enter the number of lines each data page contains, or use the spin buttons to increment or decrement the value. Pages in buffer: Enter the number of data pages you want the data page buffer to contain, or use the spin buttons to increment or decrement the value. Read in binary mode (ASCII emulation only): Select to read the data file in binary mode.
l l CSV (comma separated values). l l l l l Remove HP PCL escapes: Select to have the document remove any Hewlett Packard Printer Control Language (HP PCL) escape sequences it encounters. Text delimiter: Enter the character that starts and ends the data in each field of the record. If you do not set a text delimiter and the data in a field contains the character you set as the delimiter, the document splits that data into two fields. If you want to use a backslash character (\) as a delimiter, you m
the underscore characters of the underline on the following line. The first character of the line with the text is a code that tells the printer to ignore the LF at the end of that line. The result is underlined text. It is important to understand what happens when you tell the channel skip emulation in PlanetPress Design to ignore the LF at the end of a line.
plugin works on the data file. Caching the XML data will make subsequent tasks run faster (as loading an XML file can take a long time) but will also use up more memory since that memory isn't released in between tasks. For single runs the performance gain is less noticeable than in loops (either through a splitter, a Loop task or a metadata filter) where the XML file would be loaded repeatedly. l PDF. (Nothing to configure.
Input Any data file supported by PReS Workflow, or a PostScript file. Processing A PostScript file can be converted straight into PDF. A regular data file needs to be merged with a PlanetPress Design document first, except for a PDF file, which may or may not be merged with a PlanetPress Design document. When a PDF file is used as-is, the Create PDF task will apply the active Metadata to the PDF data file (for more information on this see "PDF Workflow" on page 183 and Working with Metadata).
l l l Optimize resulting PDF: Select to specify whether the resulting PDF should be optimized. Optimization can lead to a significant reduction in the size of the PDF, but it may also add a certain amount of time to the process. This option should only be unchecked if the timing of the process is critical and it needs to be done quickly, but keep in mind that the resulting PDF may be much larger than it should be and may even be too large for PReS Workflow to handle.
l 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. This option often produces smaller PDF files and ensures proper PDF display.
l PDF version: 1.
l Open options: l Zoom factor: Fit in window l Default view: Page only Database Query The Database Query action task retrieves data from various databases to use as input data. The data received by the task may be kept as is or converted to the CSV, Fixed Length Columns or XML format. Database Query action tasks are not considered input tasks as such, because they cannot be used to start a process.
Input Any data file. The data file will be discarded by the task. 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 Job Info variables are not modified in any way.
l l l l Output file emulation: Select the emulation corresponding to the type of output file you want the PReS Workflow Database action task to generate. CR-LF replacement: If you want CR-LF (Carriage Return-Line Feed) characters within the data file to be replaced by another character, use this box to indicate which character to use. You may select the replacement character from the list or type your own.
l l l l Default width: This box is used to set the default width for all fields. It is set to 60 by default, but can be set to any value between 1 and 65535. This value is applied to all the fields in the generated file. To set different widths for each field, use the Configure Width button. Doing this disables the Default width box. Configure Width: Click to set the width of each field in the generated file.
l l l l Alternate syntax: Select to prevent automatically enclosing the names of any database tables and fields that appear in the SQL query in square brackets when it exits the Advanced SQL Statement dialog box. The alternate syntax may be required for some database types. Edit SQL: Click to create and test an advanced SQL query. Import Config: If you previously created and exported a PReS Workflow Database Connection configuration, click this button to import it.
l l Database connection string: Enter a variable connection string in this box. To do this you may begin by clicking to create an ODBC connection string to the data source and paste the string automatically to this box. Note that if a login name and password are required to connect to the database, a dialog box is displayed and the information you enter is saved in the configuration of the PReS Workflow Database action task.
Output This task outputs the data file it received with no modification. Metadata and job files are not touched either. Task properties General Tab l l l l l l l Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these. Output folder: Enter the name of the folder in which you want the decompressed files to be stored.
Digital Action Digital Action Action tasks generate the same types of documents as generated by PReS Image output tasks (see "PReS Image" on page 378). Since Digital Action tasks are not Output tasks, the documents they create are typically passed on to the following task. The image files they generate are always saved, along with their index files (if any), to an archive folder.
Digital Action tasks, in a PDF/VT file created with Connect, see the Connect Online Help: Generating tags for Image output. Alternatively, select a PlanetPress Design document if you want all the jobs to be generated with that document. To use a document chosen at run-time for each job, enter a dynamic document name using a combination of text, variables and data selections. To enable the dynamic document name box, click inside it. To disable it, press Enter.
the digital masters. The TIFF Group 3 and Group 4 formats are efficient for document storage. l l l l l l VDX: The output will be a VDX file, which is a PDF file with some PPML code inside of it to enhance performance by doing caching/image reusing. The output can only be used on devices that support the VDX technology. DPI: Enter the dots per inch (dpi) resolution of the output image. This property is enabled for all output types except PDF.
l l l l Folder and filename: Enter the path of the folder to which output files generated by this task are to be archived. PDF index files (PDI and XML) are also put in this folder. This edit box is enabled when the Save a copy option is selected. To prevent each new file from overwriting the previous one, you should use variable names. As with any variable property box, you can use any combination of text, variables and data selections.
l l Job options: Select the PDF output option that best describes your needs. This loads all the standard settings for the selected usage scenario. These settings can be changed as required. Note that if you make changes and then select a different output option, your changes will be lost. PReS Image supports numerous PDF standards: Standard, High Quality, Custom, and a variety of PDF/VT, PDF/A and PDF/X formats.
l l Monochrome images group l l l Keywords: You may enter keywords for the document. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time. Monochrome compression: Select the compression to use for the monochrome images. Flate compression is lossless, so no data is lost during compression.
shades. This method is the slowest but most precise and results in the smoothest tonal gradations. l l Color images group l l l l Grayscale resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. 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.
l l l l l l Allow content copying: Select to let users copy content from the generated PDF files. Allow form filling: Select to let users enter information in the form fields included in the generated PDF files. PDF open password: Enter a password in this box only if you want to prevent users who does not have this password from opening the generated PDF files. Security Level: The password protection for PDF can be encrypted using one of the available encryption methods (RC4, AES-256 and AES-128).
pages. Select Full screen to hide all screen contents except the PDF page, and expand the PDF page to the maximum size it can occupy onscreen. l Font group l l l Embed all: Select to embed the entire font of all fonts used in the variable content document within the generated PDFs. Using this option may result in large PDFs, especially if many fonts are used. Note that those fonts installed by default with the Adobe Acrobat and Adobe Reader are never embedded.
l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server). Connection time-out: Enter the time, in seconds, that the connection to the database is maintained while no action is taking place before the connection is severed. 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.
For images you should rather use Send Images to Printer action tasks (See "Send Images to Printer" on page 306), as they provide image quality and conversion options. Input Any file that you wish to upload to the printer. Note that this task does not attempt to verify that the type of file being sent is compatible with the printer, or is in a supported file format. Processing The currently active data file is converted into PostScript.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Processing The external program is executed using the parameters provided. Note that the current data file is not "sent" to the executable file, however you can refer to the full path of the data file using %F. Output If the external program modifies the job file using the full path, the modified file is the output of this software. Otherwise, the output is the same as the input. Metadata is not modified in any way. Job Infos may be modified, depending on the options set in the task's properties.
l 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 l l l 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. The exit code is a numerical value generated by the program which will indicate whether its execution was a success or if errors were encountered.
l HTTP PDF Invoice Request Input The current data file in the process will be discarded. Processing The external file specified in the task's properties is loaded and replaces the current data file. Output The loaded file is output. Metadata is not modified in any way, neither are Job Info variables. Task properties 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.
Note When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False. The task does not modify the job file in any way, its only output is the change in the specified variable where the result is stored. Input Any active data file, in any format. This data file is ignored by the task and is not modified in any way.
scripting language. For more information, please see Mathematical Functions in VBSCript and VBSCript Math Operators. l l Store result in: Variable data field containing the job information, local or global variable in which to store the result. For job information use %1 through %9, for local variables use %{variable} and for global variables use %{global.variable}.
Output The modified XML data file is output. Metadata and Job Info variables are not modified. l l File l Import: Lets you open an existing XSLT script from an XSL, XSLT or TXT file. l Export: Lets you save the current XSLT script as a file. l Print: Prints the current XSLT script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor).
The other options of the window are: l l l The script editor text box: This is where you enter your XSLT Script that will be used. If you use an external script file, this will display the content of the file (note however that modifying the script in this case does not modify the external file and changes are not saved). Script running from: Choose if the script should be run from the editor text box, or from an external script file.
Task properties General tab l l Group: Use the drop-down to select into which group the KeySet is inserted, or in which group the KeySet should be updated. Key set: Displays a list of keys for the selected group. l l l l l l l Key: Displays the key name in the group. Value: Enter a value for the key, which will be inserted in the KeySet. This value can be dynamic, including data selections, metadata selections, variables and other data. Update: Check to update the key with new data.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Rename Rename action tasks are used to rename the job files they receive.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Run Script Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task.
on the main trunk. To control the output, use the "Script.ReturnValue" on page 151 variable in your script. Properties The Script Editor menu options are as follows. l File l l l Export: Lets you save the current script as a file. l Print: Prints the current script. Edit l Undo: Undo the last edit. l Cut: Cut the current selection (only available if there is selected text in the editor). l l l l l Copy: Copy the current selection (only available if there is selected text in the editor).
l Tools l l Editor Options...: Opens the "Editor Options" on page 673. Help l Contents and Indexes: Opens the Editor Help (this page) The other options of the window are: l l l The script editor text box: This is where you enter your script that will be used. If you use an external script file, this will display the content of the file (note however that modifying the script in this case does not modify the external file and changes are not saved).
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Search and Replace Search and Replace Action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data. Note that this Action task cannot be used with binary files. For more advanced search and replace functionality, see "Advanced Search and Replace" on page 255.
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. l button: Click to add a new line to the list of words to find and replace. l button: Click to remove the currently selected line from the list.
images sent to the virtual drive of another computer are stored in a sub-folder of the PReS Workflow folder. Input Any image file that you wish to upload to the printer. Processing The currently active image data file converted to PostScript. The image's resolution, scan orientation, and quality can be modified, depending on the selected option. All files are converted into PostScript format for storage on the printer. If a virtual drive, the file is automatically sent to it.
characters (characters, such as é, for example) are not recommended in image file names. 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).
PReS Workflow will wait for the task to be completed before going on to the next task in the configuration. Note 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" on page 16 page. Input Any data file in any format. Processing A copy of the data file is saved on the hard drive at the specified location.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l Value: Enter the value that you want to associate with the selected Job Info variable or custom variable. l button: Adds a new line and lets you define the variable and value to set. l button: Removes the line that is currently selected (highlighted). l button: Moves the line up so it is processed before. l button: Moves the line down so it is processed after. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82.
To configure a given SOAP Client plugin task in the PReS Workflow Configuration program, you must first get its WSDL file (note that you cannot download the WSDL file over an HTTPS connection, so you should use an HTTP connection to get the file and then switch back to a secure connection). This lets you know which services the SOAP server provides, as well as each service’s methods and name spaces.
l l l l l l l Resolve: Click to apply the options you chose above and to display the arguments of the chosen method in the Arguments box below. As script: Click to apply the options you chose above and to display information on the chosen Web service in JavaScript format in a script viewer. You should use this option if the Web service is too complex to be interpreted correctly by the SOAP Client plugin. Name: Displays the name of the arguments associated with the selected method.
the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Standard Filter Standard Filter Action tasks can be used to remove HP Escape characters from data files, as well as to eliminate spacing problems caused by LF-CR end-of-line sequences.
Task properties General Tab l l Process job using ASCII emulation: Select to use the ASCII emulation to process the job file. This reverses LF-CR end-of-line sequences that may result in unwanted doublespacing. Remove and convert HP escape characters: Select to filter HP escape character sequences from the job file. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks.
Codepage 1252 (ANSI - Latin 1) is used for many Latin language documents, since it can be used for Afrikaans, Basque, Catalan, Danish, Dutch, English, Faroese, Finnish, French, Galician, German, Icelandic, Indonesian, Italian, Malay, Norwegian, Portuguese, Spanish, Swahili and Swedish. Codepage 932 is often used for Japanese. Input Any text-based data file. Processing The characters in the data file are converted from the old encoding to the new one. Output The data file in its new encoding format.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Task properties General Tab l EMF to XY group: Select this option if the file received by this task is a Windows print file. This will prompt the task to perform the first phase of the process, and thus convert the file to an XML file. If this option is not selected, the input file will not be converted to an XML file (note that the task will fail if the file it receives is not an XML file). The settings included in this group fine tune the process.
font's mean character width is multiplied with. The value for the mean character width is taken from the corresponding font's attributes (for texts which are printed justified, it is suggested to raise this value up to about 2). For example, if the mean character width of the font example shown here corresponds to the width of the blank character (for other fonts it may be another sign).
l l Character per inch (CPI): The number of individual characters per inch on a line of text. Line per inch (LPI): The number of lines of text per inch. XML/JSON Conversion The XML/JSON Action task converts an XML job file to JSON or a JSON job file to XML. This task makes parsing XML/JSON files much simpler in a JavaScript environment and also allows processes to natively send JSON to a Connect template or data mapping configuration. Input The current job file.
practices, see: XML elements on W3Schools. Output The output is the modified job file, which replaces the input job file. The metadata are reset. Task properties General tab l Automatic detection: By default, the format of the job file is detected automatically. If the source file is a JSON file, it will be converted to XML. If it is an XML file, it will be converted to JSON. Uncheck this option to limit the task to one type of conversion. l JSON to XML: the task only converts JSON files to XML.
Splitters initiate a recurring cycle that stops only when the original file has been completely processed. When a given splitter creates a file, it hands it down to the task that follows, and all the tasks on the same branch are performed until the output task. Then the splitter task creates yet another file that is again handed down to the next task, and so forth until the cycle ends (when there is no more data in the original file).
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 PReS Workflow 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.
Task properties General Tab l l l l l Split group: Use this group to indicate how you want the file to be split. Field value change: Select if you want the file to be split based on changes in the values of a selected database field (the value in the ClientID field changes, for example). Field value condition: Select if you want the file to be split based on a condition set for the values of a selected database field (the value in the Order field equals 1, for example).
Pages before if you want the file to be split a given number of pages before the field that matches the set condition. Select Pages after if you want the file to be split a given number of pages after the field that matches the set condition. l l l l Split when condition is found group: Use this group if you want the condition to be met a multiple number of times before splitting the file.
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" on page 334). Example This task is put into effect in the following example process: l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite.
are used to tailor exactly how you want the word based splitting process to take place. l l l l l l l l l l Word change: Select if you want the data file to be split when the word found at a given location changes. Get: Click to go to the Data Selector and select the location associated with the Word change option. Specific word: Enter the word to use as the splitting criteria.
which the condition is met. l l l 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. 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.
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. Metadata, Job Infos and other variables are not modified by this task.
elements or any combination of these. l l Get: Click to get a static string of characters from the sample data file. If you use this button, the coordinates of the data you will select will be added to the Word is between lines and Word is between columns groups below. Word is between lines l l Word is between columns l l l l l From and To: Enter a horizontal search region defined as starting from a given column and ending at a given column.
l l l Get: Click to select a search region. The coordinates of the selected region will be added to the Word is in line box and the Word is between columns group below. The Generic Splitter will look for changes in the string of characters appearing in that region. Word is in line: Enter the line on which to search for the word change. If you enter 1, the Generic Splitter will consider only in the first line of every page.
three pages. A 10 page file would be split in 4 files, the first three being three pages long and the last one only 1 page long. l l View data file: Click to view the sample data file and to cycle through the pages. A database field value: If you choose A database value in the Split data file on list box (the Use emulation option must be selected), the following box is displayed.
l l Split when condition found: You may not want to split the file every time the string of characters entered in the Value box is found, but only every other time, or every third time. If so, enter the number of times in this box. A database field change: If you choose A database field change in the Split data file on list box (the Use emulation option must be selected), the following box is displayed. l l l Field name: Enter the name of the field that the Generic Splitter must check.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. In-Stream Splitter In-Stream Splitter action tasks are used to split non-emulated data files into multiple data files that are passed to subsequent tasks in the process. Note Performing the splitting process on raw, non-emulated data speeds up the splitting process.
l l l l l l l From column: Enter a value corresponding to the first column in which the splitter must start searching for the word. To column: Enter a value corresponding to the last column in which the splitter must start searching for the word. Match case: Select to force the splitter to match the character casing of the string of characters entered above 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”.
When using a PlanetPress Design document, the PDF Splitter will do the job quicker than the Metadata Sequencer task that can also be used to split PDFs. However, when using a PDF as input, the Metadata Sequencer might perform better. For more information and some test results, see this How-to: Performance testing grounds. In the case of Connect Print output, using Print Presets to separate the output is preferable to using the PDF Splitter.
l Split PDF file on a word: Select to split the data file whenever a given region is found within the PDF data file (rather than on based on pages), or whenever the region found at a given location changes, and to activate the options from this group, which are used to tailor exactly how you want the region based splitting process to take place. l l l l l l l l l l On region content change: Select if you want the data file to be split when the word found at a given location changes.
l l l l Before: 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 before the line on which the condition is met. 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. When condition is found: By default, the task splits the file every time the condition is met (the default value is 1).
mind that the resulting PDF may be much larger than it should be and may even be too large for PReS Workflow to handle. l Reset Metadata according to new PDF: Metadata will be recreated according to the new PDF that was created, including page numbering, etc. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
Task properties General Tab This tab lets you choose the splitter settings for the default PReS Workflow XSLT engine. If you want to use your own XSLT engine, click the Alternate XSLT Engine tab. l Split method: Use this box only if you want to edit the standard XSLT script that will be used to split the XML file. First use the Standard XML splitter option to define the standard settings. Then, to change the standard XSLT script, select Advanced XML splitter and edit the script as required.
l l l l l l Encoding group: This group lets you indicate whether you want the splitter to use the file’s own encoding or the universal encoding UTF8 to process the file. Note that if the file contains no indication as to which encoding 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. Use UTF8 encoding: Select if you want to use the UTF8 encoding to process the file.
l l l l XSLT file button: Click to add the {XSLTFILE} variable to the command prompt displayed in the box above. Data file button: Click to add the {DATAFILE} variable to the command prompt displayed in the box above. Output file(s) button: Click to add the {OUTPUTFILE} variable to the command prompt displayed in the box above. Browse button: Click this button and browse to select the XSLT engine you want the XML splitter to use.
may change system variables. The only exception is the Run Script action, which can be a condition that also modifies the data. Warning Branches, Loops and Conditions do NOT modify metadata in any way. Furthermore, even if a branch does a backup of Job Info variables and the data file, it does not back up the metadata. Keep this in mind when designing a process. A Branch is effectively a doubling of your job file (see "Job file" on page 45).
Task properties Backup Tab l l l l Backup job file: Select if you want PReS Workflow to use identical copies of the job file for the main and secondary branches. When this option is not selected, the file generated by the output task located at the end of the secondary branch is used as the job file for the main branch. Note that if the secondary branch ends with a Delete output task, the main branch will receive the job file in the state it was just before the delete.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l l Backup emulation: Select if you want to use the emulation selected when the job file reaches the subprocess for the main process as well. Note that the emulation is not passed from a main process to a subprocess or vice versa. Retrieve subprocess error: Select if you want to receive error(s) from the subprocess in order to handle them on its own. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82.
l l l Store current iteration in Job Info #: The Job Info in which the loop's iteration should be stored. Useful for sequential file names or conditions based on the iteration. The value of this Variable Properties box should be a digit between 1 and 9 (see "Job Info variables" on page 512).
For more information on scripts, what languages are supported and how to write scripts and conditions, please see the related chapter, "Using Scripts" on page 123. Input Any data file, in any format. Processing The script is executed. The script can modify anything such as the data file, Job Info variables, Metadata, or even other files on the operating system. Output Whatever file the Run Script action generates, Metadata it modifies or creates, etc.
l l l l l Select All: Select all of the contents of the editor. 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. Go To Line: Brings up the Go To Line dialog where you can enter a line number and jump directly to that line. Language: Select the language in which your script is written. Choices are VBScript, JavaScript, Perl or Python.
Warning With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties. The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from within your script. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks.
Task properties General Tab l Process: The name of the target process to send the current job to. Note that startup processes and subprocesses are not available. You can either enter the name of a process (or use variable properties) or use the drop-down to list existing processes. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks.
Management Information Base Object Identifiers A Management Information Base (MIB) is a database of Object Identifiers (OIDs) that can be used to monitor device objects using SNMP. An MIB OID can point be a printer tray, cartridge or hard disk, or to modem mode. Using an SNMP condition, PReS Workflow can communicate with a device located at a given IP address and request the status of the object identified by a given MIB OID number.
l l Printer Queue group (displayed when Printer Queue is selected in the Condition Type box) l l l l Condition type: Select Printer Queue to test a standard printer status condition or User Defined to test a status identified using a printer specific identification code. Bear in mind that the failure to comply with any of the test conditions selected below will make the whole condition False. Printer status: Select Idle or Printing to test whether the printer is currently idle or printing.
the OK button, and are displayed in the Task Comments Pane. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Text Condition Text Condition tasks can be used to perform two different types of tests: l l To test the presence of a string within the job file. You can, for example, search for the string “Gold member” on the first line of the job file.
l l l l l l l l Convert data to uppercase before comparison: This option is only displayed when either “Is found” or “Is not found” is selected in the Operator box. Select to prompt PReS Workflow to convert the string to uppercase before performing the comparison. Numeric comparison: This option is not displayed when either “Is found” or “Is not found” is selected in the Operator box.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Time of Day Condition Time of Day Condition tasks test the current time and day.
l l Invert condition result: Select to toggle the result of the condition (true becomes false and vice versa). 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. l Select All: Click to toggle all the time blocks on.
l Output to SharePoint l "PReS Fax" on page 377 l "PReS Image" on page 378 l "PReS Print Controls" on page 388 l "PrintShop Mail" on page 392 Delete Capture OnTheGo Document The Delete Capture OnTheGo Document deletes a document from a Capture OnTheGo Repository, which stores documents that can then be retrieved by the Capture OnTheGo mobile application.
l Repository ID: Enter a valid Capture OnTheGo Repository ID. l Password: Enter the password that corresponds to the Repository ID entered above. l Document ID: Enter the ID of the document to delete from the Repository. l Invert result: When the task is used as a Condition task, the success of the delete operation determines whether the condition returns True or False. Check this option to invert the result.
Note 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 7.5 and higher only. Input Any data file present on a SharePoint document store, even those not compatible with PReS Workflow emulations, and the properties of these files. Processing The task connects to the selected Document store and retrieves a copy of files according to the specified rules.
l l l l l Folder: The folder in the document library where your files are located. You can click the Browse button to display your folder structure. In the Browse Folders dialog, click on the folder you want to use and click OK. Input Rule: Lets you define rules to filter incoming files on certain variables, for example the file name, size, etc. Clicking the ... button brings up the Rule Interface. Download files from sub-directories also: Check to also look into subdirectories of the specified Folder.
l l l 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 PReS 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.
which serves as the user’s interface with the repository. For more information see the Laserfiche website: https://www.laserfiche.com/. Input Any file that is compatible with Laserfiche (see the Laserfiche user manual for more information on supported files types) Processing A connection is established with the Laserfiche server, the file is uploaded and the metadata in the Laserfiche server is generated correctly.
l l l l Volume: A list allowing to choose among available Laserfiche volumes. Configure Tags: Click to open the Configure Tags dialog. See LaserFiche Repository Output - Configure Tags. Configure Templates: Click to open the Configure Templates dialog. See LaserFiche Repository Output - Configure Templates. PReS archive folder: Folder path of the folder capture of the current process. This field is optional and should only be set when publishing PReS Workflow archives that have PDI files.
l To use the “Use PReS PDF/A archives” option, make sure to: l l l l l l l Check the field as Multiple, select CHAR type and enter the width fields in Laserfiche administration console as long as your PReS fields. Insert a folder path to your PDI source files in the PReS Image archive folder. If a field is checked as Required in Laserfiche administration console, fill the field value.
Use case 1: Send personalized emails with promotional document attached A PlanetPress Design document takes a PDF file as the input data file, and reproduces it exactly as it enters. The document also contains a custom data selection set to hold an email address. The data selection's value is given by a Metadata Field called 'Email'. The value of this Email Metadata field is a region from the sample data file representing the customer number.
Task properties General Tab l Excel group l l l l Excel workbook: The full path and file name of a Microsoft® Excel® workbook (.xls or .xslx file). You can use the Browse button on the right to browse to the file on your computer. Excel worksheet: The name of the worksheet you want to use. Once a workbook is open, this drop-down will automatically list all the available worksheets.
l l button: Moves the currently selected line up one place. l button: Moves the currently selected line down one place. Search option group l Match case: Will force the lookup column names to be in exactly the same case as the Lookup column name. This means if you type in "CustomerID" in the lookup column and the actual column is named "customerid", it would not return any result. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82.
avoid confusion from network users, however it is shared between all Microsoft® Word® Document to PDF action tasks on the same system. l l l If using a Microsoft® database such as Access® or Excel®, each software must be installed in the same version. For example, using Microsoft® Word® 2007 with a Microsoft® Access® 2003 database will cause the task to fail.
Note The Objectif Lune Printer Driver will naturally add a margin to the PDF generated by this task. If your PDF is full bleed you will not get the desired results using this option. l A DOC (Word Document) file which is the result of the mail merge. This output is only available when doing a mail merge. Task properties General Tab l l Microsoft Word Document: Enter a Microsoft® Word® document or template, or click the browse button to navigate to the location of the document.
l Output Type: l l .PDF File (with metadata): The result will be a PDF file with the number of pages generated by the combination of the template and record set. Metadata is also included that complement the PDF. .DOC file: The result is a Microsoft® Word® document in .doc format. Note that this format is not supported by PReS Workflow as a data file or job file, so this option is only useful if you are simply planning to save the Word document in a specific location.
Processing This task does not process the data or metadata file. The information entered in the Deposit tab of this task is sent to the repository configured in the Repository tab. Output The output that this task produces is the information sent to the Capture OnTheGo online repository (the document ID). Task properties Repository Tab The Repository tab is where you enter the connection information necessary to create the link between OL Connect or PReS and CaptureOnTheGo.
an image on the local drive. The Cover Image is optional and, if omitted, displays a default image based on the file type. l Document Information group: In this group, you enter information that will help users identify the document. It is mandatory to enter valid information in all the boxes included in this group. l l Title: Enter the document name that Capture OnTheGo users will see on their device. Choose a name that will let users clearly identify the document.
Advanced Tab The Advanced tab is where you specify the document's time to live either in the repository or the user's device. l Document Handling Options group: l l l l Customize: You must check this box if you want the options included in this group to be used. When this option is not checked, the other boxes included in this group are faded.
Until box above, the computer’s time zone appears in this box. You may select a different time zone if required. l Document Tracking: l l l Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server. This tracking is done through the COTGDefaul.mdb database located in %ProgramData%\Objectif Lune\PReS Workflow 8\PReS Watch\COTG , and includes most of the information set in this task, as well as information returned from the server.
the PReS Fax host specified in the properties. If the file is a TIFF file in the proper format and the "Pass-through" option is selected, no processing is done, the file is sent as-is. Output A TIFF in the CCITT Group 4 compression, and information for the FAX server to know where to send the file. Task properties General Tab l l l l l Host: Select the IP address of the PReS Fax host to which you want the request to be sent. The Fax configuration is set in the PReS Fax User Options on the target host.
Since this task is an Output, it is not possible to immediately act on the generated image before continuing. When necessary to immediately retrieve the generated file, the "Digital Action" on page 281 task should be used instead. In addition to the job-specific PReS Image properties you configure in the task’s Properties dialog box, there are configurable options common to all PReS Image outputs processed by a given computer (see "PReS Image preferences" on page 668).
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 PReS Image host which merges the data and document to produce output.
l l List only documents using VDX compilation: Check to ensure that only documents that are compatible with the VDX compilation method are shown in the list, if producing VDX output. Run mode group (only with PlanetPress Design document) l l l l Optimized PostScript Stream: Select to merge the selected document with the data received by this task before sending it to PReS Image. Note that some features, such as the Time and Date functions, require that this option be selected.
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 Automatically Add Extension: Check if you want the correct extension for the image type to be appended to the file name automatically, rather than having to add it in the Filename box. The Output Type determines the extension to be used. Index group: This group lets you specify which type of index must be created for each document generated by this task. PDI files are used by PReS Search as indexing information.
l l l l l l l Optimize for fast web view: Select to minimize file size and facilitate page downloading. Title: Enter a title for the document. If you leave this box empty, the document’s name will be used as the document’s title. Since this is a variable property box, you may use variables and data selections and let PReS Workflow interpret this information at run-time. Author: You may enter the name of the author of the document.
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. 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.
sampling. Select Average to average pixel color in each sample area and to replace the entire area with a pixel of the average color. Select Subsample to use a pixel in the center of the sample area and replace the entire area with that pixel value. This method is significantly faster, but results in images that are less smooth. Select Bicubic to use a weighted average to determine pixel shades. This method is the slowest but most precise and results in the smoothest tonal gradations.
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. This option often produces smaller PDF files and ensures proper PDF display. l Initial view group l l Zoom factor: Select the magnification at which you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to open the generated PDF.
l l l Use default database: Select to use the default database associated with your user profile on that SQL Server or Oracle database. Clear to enter the name of the database in the box that appears. Use Windows NT Integrated security: Select to use your Windows user name and password to log onto the SQL database. User ID: Enter the user id required to access the database to which you are adding new PDI files from the generated PDF files.
Note All PReS Classic licenses are issued and controlled by the PReS License Server and not Connect. Thus a separate PReS Classic license is required. Input A PReS Classic job and the resources it needs. These resources include the data file to run against the job, plus any graphic or font resources the jobs needs, along with any required PReS Classic specific resources, such as TRF or PDI files. Processing The selected data file is merged with the selected PReS Classic job to create a print output stream.
to compile the selected file and then run the resultant PDC file, regardless of whether there was an existing PDC file within the folder already. Any existing PDC file in that folder will be overwritten by the new compilation. Note The use of pre-compiled PReS Classic jobs is heavily recommended, as this greatly reduces the scope for run-time errors. l Data File: The data file to use in the run. This file can be explicitly selected, or it could be set via a Connect Workflow variable.
l PDL Type: Select the desired PReS Classic output type for the job. Note Not all PReS Classic jobs can be swapped between output types. Jobs designed for certain output types (such as AFPDS) will likely have settings specific to the original output type. Changing the output type at this point will likely lead to errors or require job modifications to suit the changed output type. l l Log level: Specifies the verboseness of messages returned by job processing.
l Time-out: The time in seconds that the Connect Workflow waits for a response from the PReS Print Control to make sure it is running. If Connect Workflow does not receive a response in the allotted time it will terminate the Print Control and continue to the next step in the workflow.
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. Task properties PSMail Tab l l File name: Select a specific PrintShop Mail document if you want all the jobs to be printed with that document. Output type group l Output type: Select the type of output you want the task to generate. l l l l l l l l l Select PDF to generate a PDF file.
l l l l l l Windows printer: Select the print driver of the printer to which you want the print job to be sent. This option is only available when Windows PostScript driver is selected in the Output type box. Print Technology: Select the PrintShop Mail print technology to use when generating the output. For a list of available job technologies, consult the PrintShop Mail User Guide. This option is only available when Windows PostScript driver is selected in the Output type box.
PlanetPress Capture Note PlanetPress Capture is only available in version 7.2 and higher of PlanetPress Suite Production. It is not available in older versions nor is it available in the Office and Watch versions of PlanetPress Suite. PlanetPress Capture is not compatible with Connect Designer templates. PlanetPress Capture is a set of tools available in PReS Workflow that enable output and input for interaction with an Anoto Digital Pen.
page 403 or "Find Capture Documents" on page 410 task. However, it is also possible to directly retrieve the required information from a specific Document ID. When a specific ID is used, the data file and Metadata are completely ignored by this task's condition rules, and the database information is used instead. Processing The condition is evaluated using the specified rules, combination (condition is true when...) and scope (condition scope).
l l l l Document is empty: Condition will be true if the document is open but no Capture Field is filled. Document is on error: Condition will be true if a logical error was triggered while processing the PGC. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc.
l Condition: Defines what should trigger the condition: l Ink is Present: Triggered by the presence or absence of ink in the field. l l l l l l l l l l All: Ink should be present in all fields of this name in your document. Index: The specified index of the Capture Field of this name should contain ink. The Index property is generated when a Capture Field object is repeated or is part of a runpage. This index is 1-based.
l l l l Error: A logical error was detected in the field. This can happen, for example, if a field was re-written when it should not, a List Field set to only accept one option contains ink in both options, etc. ICR Value: Triggered when the value given by the ICR engine compares with the specified value. Operators are available for the comparison (such as Equal, Not Equal, Lower or Higher Than, Contains and etc).
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
You may also use a Metadata Sequencer task in order to split the job into multiple parts. This both creates multiple smaller outputs, as well as multiple smaller PDFs in the Capture database. While it is not recommended to separate each document on its own as it removes all optimization and makes the database much larger, you may split into document batches such as 250, 1000 or 2500 documents.
l l l Capture Document: Choose the PlanetPress Design capture ready document that will be used to generate the output including the capture fields. Document Title: Enter a name for the document that will be saved inside the PlanetPress Capture Database. This name should be unique and recognizable and will be used later to retrieve the document form using the Get Capture Document action task. Document Title group: Determines a Title for the document.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
During processing, ink is always applied to the document first and then the logic is applied for releasing patterns. This means that even if a document is closed by a field set as Final that was checked first, ink present in other fields will still be applied to the document. From version 7.5 and onwards, ICR is done on the ink, if the "Perform ICR Recognition" option is checked.
l l l l l CapPatternSequence: The value of the pattern sequence assigned to the document. CapPGCName: The name of each PGC file that was used to update this document (will repeat for each PGC file) CapStatus: Current status of the document: l 0: Open l 1: Closed by an optional field l 2: Closed by a mandatory field l 3: Closed by a final field CapTemplateName: Name of the PReS Connect document used to generate the document.
l l l l l l l Custom Pattern Sequence: If you choose Custom in the Type drop-down, enter a manual Pattern Sequence or a data selection that contains the Pattern Sequence to be used. ICR Settings group l l Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection. Perform ICR Recognition: Triggers the PlanetPress Capture ICR engine. For more information, see PlanetPress Capture ICR.
another split generates an error, it also triggers the On Error tab. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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.
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.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB. PLANETPRESS CAPTURE is based on Anoto Digital Pen and Paper Technology, which is covered by over 200 patents worldwide, including but not limited to US6663008, US7172131, US7248250, US7281668, JP3872498, JP3842283, CN1595440, SE517445, RU2256225, and AU773011.
l Metadata Level: A drop-down list containing all of the levels of Metadata. Choose the one where the ICR data will be added. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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 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. Processing This task connects to the Capture database and looks up all available documents that meet the criteria specified in the plugin. Then it does further processing to retrieve relevant information about each document and places the information in the data file it generates.
l l l l l l l l Date Closed: The date, in YYYY-MM-DD format, when the document was closed by the Capture Field Processor or Get Capture Document tasks. This field is empty in documents that are still open. Pen user (by description): The description of the pen, as entered in the "PlanetPress Capture Pen Management Tool" on page 649. Generally, this is the name of the owner of the pen.
l l l l l l l l l l l Contains: Inclusive string comparison, documents where the specified value is present within the chosen filter are included. Does not contain: Exclusive string comparison, documents where the specified value is not present within the chosen filter are included. Before: Date comparison, documents of which the date is previous to the specified value are included (Date Generated and Date Closed filters only).
this option unless you are aware of the loss of performance and actually need to access each field's properties individually! On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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.
Processing One PDF, corresponding to the information present either in the Metadata or specified in the task, is extracted from the Capture database. When retrieving documents from the database, the PDF from which the document is obtained will remain in the database until each document contained in it is retrieved from it. For example, if a 10-page PDF contains 5 documents, the 10 pages remain in that PDF until all 5 documents have received ink, been closed and retrieved from the database.
Task properties General Tab l Document Origin group: l Document to process: Determines where the document information is read l l l l 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.
PGC to PDF Converter The PGC to PDF Converter task extracts the digital ink located in a PGC file and adds it to a blank PDF, creating one page per document in the PGC. It's main use is to process PGCs that generated errors when processing them, as part of an Error Handling process. Note When adding this task to your process, you will be asked if you want to add the task as an Action or a Condition. This task should only be used as an Action. If used as a condition, it will always return False.
Note This task was built using a custom plugin system and does not display the On Error tab in the regular view. To access the On Error tab, right-click on the task and select Advanced Properties... On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a text area (Task comments) that lets you write comments about the task.
Create Metadata Creates all the Metadata that is either the information about a data file, or the result of the merging between a data file and a PlanetPress Design document. For more information about Metadata see: "Metadata" on page 67. This task is put into effect in the following example processes. l "Example: Daily sales report from PDF files" on page 184 l Basic Functional Capture Workflow l Capture Web Manager Workflow Note that Capture can only be used with PlanetPress Suite.
l In XML emulation, the Metadata file is always created as if the user had specified the "Second Level" parameter in PlanetPress Design. Output The original data file is output, along with the newly generated Metadata file. Job Info variables are not changed. Task properties General Tab l l Documents: Select the Do not use a document (passthrough) option to create Metadata based on the data file alone.
Input A PDF File, either with no Metadata and along with Metadata that presumably corresponds to the PDF file, or a PDF file with embedded Metadata. Processing If the Embed option is used, the Metadata information is embedded directly into the PDF File as binary data. This does not change the way the PDF is viewed by any PDF viewer. If the Extract option is used, Metadata present inside of the PDF file is extracted from it. If no Metadata is embedded, the task generates an error: W3976.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata Fields Management The Metadata Fields Management task can be used to add new fields into your Metadata, either for every element or through conditions. For more information about Metadata see "Metadata" on page 67. Note This task will automatically loop through the Metadata and repeat its action for each of your Metadata's datapages.
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. Output The original data file is outputted, along with the modified Metadata.
l l Field Value: Enter the Metadata field value. Note that if the chosen action is Delete, this parameter is disabled. For other action types, in order to set the field value, click the [...] button. This button opens the Data Selector, which allows to specify a data selection as the field's value. Note that when adding a Metadata field, if you perform a multi-line data selection on a PDF region, only the first line of that region will be set to the Metadata field.
process. For more information about Metadata see "Metadata" on page 67. Input This task takes any file as input and does not modify it. Process This task does not execute any change to the process, its files or variables. It only executes the selected action on Metadata. Output This task outputs the exact same data that was given to it. Its Metadata will either be missing (Delete Metadata), Changed (Load Metadata) or the same (Save Metadata).
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
l l l l l Group: Select the Metadata Group nodes (the nodes only) based on the specified rule(s). Document: Select the Metadata Document nodes (the nodes only) based on the specified rule(s). Datapage: Select the Metadata Datapage nodes (the nodes only) based on the specified rule(s). Rules: Define according to which criteria the action must to be performed. The condition must be TRUE to execute the action. All nodes on a specific level with false condition become unselected.
Metadata Level Creation The Metadata Level Creation task conditionally creates new Metadata groups or documents. This task is only functional if Metadata already exists for the current job. For more information about Metadata see "Metadata" on page 67. The task enables users to merge data pages into Documents and/or merge Documents into Groups, based on conditions. Unselected Data pages are ignored, but are moved with other Data pages if the action is applied to the current parent node.
With this example, before the Metadata Level Creation task, the Metadata structure contains one group containing one document (containing multiple data pages). After the Metadata Level Creation task, the Metadata structure contains one group containing multiple documents. Input Any data file with accompanying Metadata. Processing The Metadata file is split on the selected level. Output The original data file is output, along with the modified Metadata.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Task properties General Tab l Metadata level: Select the Metadata level to process. l Sequencing is based on l l l The following number of occurrences of the level: Determine a sequence based on the number of instances found for the Metadata level currently processed. For example, if the Metadata level is set to Group, and this value is set to 3, each sequence contains 3 groups (except, possibly, the last one, depending on the number of groups left in the last sequence).
Output The original data file is output, along with the modified Metadata. General Tab l Group: Sorts the Metadata by group. l Document: Sorts the Metadata by document. l Data page: Sorts the Metadata by data page. For each parameter, three columns are available: Sort By, Then by, Then by (again). This lets you sort your document level in three different orders sequentially. Sorts are always done from left to right, top to bottom, giving you a total of 9 sorting possibilities.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Metadata to PDI The Metadata to PDI task takes the active metadata and generates a PDI using the information in that metadata. It is generally used in conjunction with a PDF data file and is used to generate the PDI file which is used by PReS Search when building, refreshing or rebuilding its database. For more information about Metadata see "Metadata" on page 67.
l Index Group: l l PDI: Only generate a PDI file. PDI and XML: Generate both the PDI and an XML equivalent (not used by PReS Search). On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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.
Tip To print a Connect template with an N-Up print layout you need an Output Creation Preset with the correct production options. See "OL Connect print jobs" on page 92. Also see Output Creation Preset and Print Options in Connect's Online Help. Input Any data file with accompanying Metadata. Processing The Metadata is re-arranged and/or duplicated in order to correspond to the options set forth in this task's properties. Output The original data file is output, along with the modified Metadata.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. OL Connect Send Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application.
All job info that could be retrieved will be written to a temporary results file that is then passed on as the new Workflow job file. It can be used right after the Get Job data plugin in the same Workflow configuration. It could for example be saved using a Send to Folder plugin. Note The Get Data plugin gets data from the OL Connect Send database which means it only works when Connect is in LICENSED mode.
Operators l Searches are case-insensitive. l Multiple entries in one filter field are combined with: OR. l Entries in different filter fields are combined with: AND. Example 1 A valid user name search string, entered in the Filter Users field, would be: %\{global.
2016-07-12 It is possible to only define a date without a time. 2016-%m-%d Standard Workflow variables for year, month and day are allowed. 2016-07-12 11:00 From and To dates may also have a time indicator (24 hour notation, separator from the date is a space character, separator between hour and minute is a colon) It is possible to define the same date for From Date/Time as for To Date/Time. However, entering the same info (without time information) would lead to getting no entries.
Note This file is not automatically saved to disk. The retrieved job info is written to a temporary results file that will be passed on as the new Workflow job file. To save the results file, use a Send to Folder plugin and configure that appropriately. Returned information For each job received by the OL Connect Send Job Processor plugin the following values will be available. l l Job UID: This is the 10 (ten) character long Unique Job Identifier string.
l l l l l l l User name: This is the Windows user name of the user who started the application to produce the print job. It is not - in all cases - the user name of the user who is currently logged into the system. Original file name: This is the "file name" as sent from the application to the Windows spooling system. It is taken from the name as it arrives in the spooler. Some applications add info to the name (like Notepad++) while others don’t (like Adobe Reader).
The plugin appears in the Plug-in Bar of Workflow under OL Connect Send. Typically, it is used in the OL Connect Send interaction process, just after the initial HTTP Server Input plugin. The Get Job Data plugin gets all relevant information for the dedicated print job using the Unique Job ID. Whenever an OL Connect Send Printer Driver is sending a print job to the OL Connect Send Job Processor plugin, it creates a unique ID string composed from 10 upper- and lowercase letters and digits e.g. “ri0zZdluLp”.
processing. l Read from Variable: When selecting this option, any existing Workflow variable can be chosen via the drop-down field. In this case, the plugin reads the Job ID from that variable. Select Returning Type Depending on this setting the plugin gets status information about the job before it has arrived or it gets information after the job has been completely received.
l l Job UID: This is the 10 (ten) character long Unique Job Identifier string. Date/Time stamp: This is the time when the matching job was initially created in the database. It is stored in UTC format plus time zone indicator inside the database. It will differ from the time stamp logged by the OL Connect Send Printer Driver as well as by the OL Connect Send Job Processor. Note The Printer Driver machine time stamp in the Printer Driver log may significantly differ from this value.
l l l Domain / Workgroup Indicator: This domain name is the real domain name or only a workgroup name. For explanations about domains, domain names, users, user names, user domains, logged on users vs. application running users, machine names etc. please refer to the respective Windows help pages or ask your system administrator. Machine name: The name of the machine the OL Connect Send Printer Driver is running on as retrieved by the respective Windows API.
Note It is strongly recommended that a single job transfer process for all OL Connect Send Printer Drivers is created, using the domain or machine’s or user information to divert to any follow-up processes. This single transfer process can be set to "Self Replicating", so that parallelization is possible.
Security In order to provide security when printing over the internet, OL Connect Send includes several protective features. HTTPS Communication The OL Connect Send Printer Driver can be set to use HTTPS for any job transfer. To do this, Workflow must also be set to use HTTPS. Job Origin Each print job will include unique information about the machine it has been sent from. This unique machine ID is calculated with a proven method and will be transferred, encrypted and enhanced.
If no extension is defined by the user for the file name, the default “.ps” extension is added automatically, as the incoming print jobs are PostScript files. Metadata In addition to the print job, the plugin creates a metadata file with basic information. The values originate from the client machine. In unlicensed mode, the user name, machine name and domain/workgroup name will not be available through the metadata.
Information Workflow Variable When licensed When unlicensed License status for this job %2 "Licensed" "Unlicensed" Username 1 %3 The user name "na" IP Address 1 %4 The IP address The IP address No. of Pages 1 %5 Number of pages of the job Number of pages of the job No.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. OL Connect tasks OL Connect tasks are available in PReS Workflow 8.0 and up.
branch to continue after this task. An Output task is always located at the end of a process or branch. Note When added as an Output task, the All In One plugin works asynchronously to the Workflow process. Task properties Data Mapper Tab The Data Mapper tab generates a Record Set from a specific source: data mapping on the appropriate source (Current Data File, Database or PDF/VT data file), Retrieving items from the Connect Database (filter setting) or uses the current job Metadata.
Turning this feature on can improve data mapping performance significantly, as well as the time required for the cleanup process. However, since the data is not written to the database, there is no way to do post-processing on the extracted data after the All In One operation has completed. Any postprocessors defined in the data mapping configuration will be disabled. This option is unchecked by default. l Filter: Retrieves records from the Connect Database.
l l Metadata: Uses existing metadata, generally the output of a "Execute Data Mapping" on page 476 or a "Retrieve Items" on page 486 task set to retrieve Records or Record Sets. This source has no options as it expects valid metadata. 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 "Execute Data Mapping" on page 476 task. Content Items are created automatically.
l Output Preset: Select the appropriate Output Creation Preset to use: l l l "None": Select to prevent the execution of Output Creation. In this case the All In One can be combined with the Create Job and Create Output tasks and thus also with a Job Preset and Output Preset. "%o": Select to use a dynamic Preset name. Click on %o to change the expression that determines the name of the Preset to use. Preset Name: Select the appropriate Preset to create output with.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Sort Parameters The Sort Parameters define how to sort the entities retrieved from the Connect Database using either the Retrieve Items task, or the Filter source in the "All In One" on page 450's Data Mapper task. l Sort items based on: Lists the different sorts to apply to the entities. l l l Name: Click and enter the name for the Value or the Property to sort on.
JSON The Create Email Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records. If a value in a record object is a string, it is considered to be a field value. If a value in a record object is a JSON object, it is considered to be a nested table with detail records. For examples, see "JSON string samples" on page 467. A JSON Record Data List (see the REST API Cookbook).
l l Section: Enter the section name that will generate output. Only one section can be output. If no section is defined or if the section name is invalid, the default section will be output. Data Source (see "Input" on page 455): l Metadata: l l Update Records from Metadata: If the process metadata has been modified by any of the "Metadata Tasks" on page 418, check this option to update the records in the Connect database with the metadata and use the updated records.
l Use Authentication group: Check to enable authentication to the SMTP server. l l l l Password: Enter the password for the above user name. Start TLS: Check to send connect to the SMTP server using TLS (Transport Layer Security, also called "SSL"). Attachments: l l l User name: Enter a user name that has permission to send email through the SMTP server. Print Context as PDF document: Check to generate the Print Context in the template as a PDF and send it with the email as an attachment.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Job The Create Job action task prepares a series of print content items for output generation.
Task properties General Tab l Job Preset file: Select which Job Preset to use to generate the job. To be used in this dialog, a preset must have been sent to PReS Workflow using the Package File function in PReS Connect. l l l Default: The IDs in the metadata are used instead of a job preset file. Select this option if the Print Content Set is the result of the Retrieve Items task. "%o": Select to use a dynamic preset name.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Properties The Create Output task properties are as follows: General Tab l Output Preset file: Select which Output Preset to use to generate the output. To be used in this dialog, a preset must have been sent to PReS Workflow using the Package File function in PReS Connect. l l l "%o": Select to use a dynamic preset name. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the list below.
l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82.
Properties Note that the Connect Proxy tab is not present in the Create PDF/VT Action task properties, as this task does not communicate with the OL Connect Server. General Tab l l l Documents: Select a specific PlanetPress Design document if you want all the jobs to be generated with that document. Recipient Node: Use the drop-down to select which level of the metadata is used as the "Recipient" node. The Recipient node defines each Record in the output when used with the Create Print Content task.
To make the rendering process as fast as possible, the generated PDF isn't optimized for print production purposes. Properties Datamapper tab The Create Preview PDF plugin gets one record from the source selected on the Datamapper tab. This record is then merged with the template (selected on the Content Creation tab) to create a preview PDF. The Datamapper tab can have one of the following source options: l Data mapping configuration sets the data source to a data mapping configuration.
Note The Create Preview PDF plugin cannot parse Workflow automation variables. Instead it uses the default values set up in the Preprocessor of the data mapping configuration. To work around this issue you could either convert the posted data file into JSON, add the variables and use the JSON string option in the Create Preview PDF plugin, or you could add the variables to the data file and let the data mapping configuration extract them.
Note The Metadata option requires that entries in the metadata have matching field names in the data model of the template. When they have, the values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data). Using JSON In web environments, it is common to send and retrieve data from a server using an AJAX request (typically invoked from within a JavaScript).
A JSON string containing a local variable and various lookups: { "jobid":"%{jobid}", "account":"lookup(OLCS_jobs, account, jobid, '%{jobid}')", "datafile_name":"lookup(OLCS_jobs, datafile_name, jobid, '% {jobid}')", "pages":"lookup(OLCS_jobs, pages, jobid, '%{jobid}')", "documents":"lookup(OLCS_jobs, documents, jobid, '%{jobid}')", "recordsetid":"lookup(OLCS_jobs, recordsetid, jobid, '%{jobid}')" } An example where the entire JSON string is provided in Job Info 1: %1 A JSON string constructed with informati
l l %o: Select to use a dynamic template name. Click on %o to change the expression that determines the name of the template to use. A template name: Select the appropriate template name from the list. Adding templates to this list is done from the Send to Workflow option in the Designer module. A preview will be displayed of the output generated by the Print context of the selected template. (Not available for a dynamic template name).
Input This task can receive either Metadata containing information regarding a valid Record Set, or JSON data, or a PDF/VT File (see "Create PDF/VT" on page 463). Metadata The "Execute Data Mapping" on page 476 task and the "Retrieve Items" on page 486 task output Metadata containing information regarding a Record Set. JSON The Create Print Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records.
In the case of a PDF/VT file, content items are created based on the structure of the PDF/VT metadata and content items are stored using the data for each of those metadata records. By default, the entire Print Context is used to create print content items. Individual Print sections can be selected dynamically via a Control Script. (For more information see the Designer Help.
access to the values through the record's data fields. (See the Designer help: Adding Variable Data.) Warning The JSON format is not validated by the plugin; it is passed as is to the server. OL Connect Proxy Tab This tab is common to all OL Connect tasks and defines where to process the jobs sent through these tasks. When these fields are empty, they use the defaults set in the OL Connect User Options page of the preferences.
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Create Web Content The Create Web Content task generates the output of the HTML Context of a specified template for a single record and returns the HTML code to PReS Workflow for further processing and return to the requester. Generally, this task is placed within an HTTP Server Workflow.
Note that only the first JSON object is processed, as the endpoint generates HTML output for a single record. Processing For a single record, this task generates the output for the HTML Context of the specified template. Any external resources such as images, css stylesheets or JavaScript files, are also produced and put aside on the OL Connect Server component. Output The task outputs HTML code as a job file.
This option requires that keys in the JSON data have matching field names in the data model of the template. When they have, the JSON values are passed to the template and the personalization scripts of the template will have access to the values through the record's data fields. (See the Designer help: Adding Variable Data.) Warning The JSON format is not validated by the plugin; it is passed as is to the server.
Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name.
Note To open a Microsoft Access database, you have to use the Load External File task just before the Execute Data Mapping task. Note AFP input is dependent on a third party library (CDP), which only allows PReS Connect to run up to 4 AFP input processes on a given machine at a given time. Processing The task executes the selected data mapping configuration on the appropriate data source, or converts the PDF/VT into a Record Set directly.
l Output Type group: l l l Output IDs in Metadata: Select to only output the Record and Job IDs in the metadata. This does not permit sorting and filtering, but it enhances performance since only minimal data is exchanged between the OL Connect Server and PReS Workflow. Output records in Metadata: Select to output the full Record table (no Details table) as metadata in the task.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area.
Options page of the preferences. Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name.
Processing The task tries to download the requested file from the OL Connect File Store by performing a call to the /rest/serverengine/filestore/file/{fileId} REST endpoint; see File Store Service: Download File in the REST API Cookbook. Output The downloaded file becomes the current job file and retains the file name that it had in the OL Connect File Store. Task properties General Tab l Filename or File Store ID: Enter the name of the file in the OL Connect File Store or its File Store ID.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. File Store - Upload File The File Store - Upload File task uploads the current Job File to the OL Connect File Store.
l l Save File Store ID in variable: Select the variable in which to store the File Store ID that is returned after a file has been successfully uploaded to the File Store. This ID can be used to download or delete the file from the OL Connect File Store. Mark as permanent: When this option is checked, the file will never be removed automatically by Connect's Clean-Up Service. Non-permanent files may be removed if there are no remaining references to them in the Connect Database.
Mark Connect Sets for Deletion The Mark Connect Sets for Deletion task indicates that an item in the Connect Database should be deleted the next time the Database Cleanup runs. This means that whatever item is set for deletion will no longer be available from the database. Input The task requires a valid Metadata file containing items for deletion, including Job Sets, Content Sets and Data Sets. These can be created by the Execute Data Mapping, Create Print Content and Create Job tasks.
Note Defaults are not used unless the configuration is sent to the Workflow service. l OL Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. l Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 l User name: Enter the user name expected by the OL Connect Server. l Password: Enter the password expected by the OL Connect Server for the above user name.
Output The task outputs a merged Metadata Job File which can be used in the Create Output task. Task properties General Tab l Metadata file: Enter the full path to a valid Metadata file containing an OL Connect Job, or use the Browse button to browse to a valid location. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks.
Output The task outputs Metadata that is equivalent to the output of the appropriate task that would normally create the items, or a JSON Record Data List. Note The result of a Retrieve Items task can be used with the "Create Job" on page 459 task if it is a Content Item or Content Set, but it cannot be used in combination with a Job Preset. Note Content Creation tasks accept Metadata as well as JSON data as input.
"ItemOrdered": "INTEGER" } } } }, "id": 3678077, "datasetid": 2392921, "fields": { "ID": "CU19762514", "Date": 1331096400000 }, "tables": { "detail": [{ "id": 3678078, "fields": { "ItemTotal": "2300.00", "ItemShipped": 2.0, "ItemOrdered": false } }, { "id": 3678079, "fields": { "ItemTotal": "29.99", "ItemShipped": 1.0, "ItemOrdered": "false" } }], "detail2": [{ "id": 3678080, "fields": { "ItemUnitPrice": "1150.00", "ItemOrdered": 2 } }, { "id": 3678081, "fields": { "ItemUnitPrice": "29.
] The values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.detail[0].fields.ItemTotal; Task properties General Tab l Entity to retrieve: Use the drop-down to select which items to retrieve. l l l l l l l Record Set: Retrieves one or more Record Sets, including all their records. Output similar to the "Execute Data Mapping" on page 476 task. Content Item: Retrieves one or more Content Items, whether or not they are part of a Content Set.
l l l l l l Delete the selected condition: Click to delete the currently selected conditions in the list. Clear the rule: Click to delete all rules in the list. Note: This cannot be undone. Import a rule: Click to open the Browse dialog and load a Rules file. This will load its rules into the list. Export the rule: Click to open a Save dialog and save the Rules file to disk. Rule Viewer: Displays a text-based view of the condition using operators and parentheses.
l l Pick items based on: Use the [...] to open the "Pick Parameters" on the next page dialog and define how to pick which documents will be placed in each Document group. groups are often used to separate mail routes, provinces, or cities. Sort items based on: Use the [...] to open the "Sort Parameters" on page 455 dialog and define how documents are sorted within the group, for example by Zip Code.
Pick Parameters The Pick Parameters define how to pick entities retrieved from the Connect Database using the Retrieve Items task and place them together in Documents or Groups. Items are picked using either Properties or Values. l Name: Enter the name of the Property or Value that will be used to pick items. l Type: Use the drop-down to select whether the name refers to a Property or a Value. l Add: Click to add a new line to the list.
Task properties General Tab l l Entity: Use the drop-down to select the entity type of which to set the properties. This task does not auto-detect entities, and so the appropriate selection must be made: Record, Record Set, Content Item, Content Set, Job Properties: Add all the properties to be added l Name: The name of the property. l Value: The value to apply to the property. l Add entry: Click to add another line to the Properties list.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. Output Tasks Output tasks are exits from PReS Workflow processes.
l "PReS Fax" on page 377 l "FTP Output" on the next page l "PReS Image" on page 378 l "Print using a Windows driver" on page 500 l "Printer Queue Output" on page 502 l "Send Email" on page 505 l "Send to Folder" on page 509 l "SOAP Client plugin" on page 497 Delete Delete output tasks simply delete the job files they receive. They are often used after conditions to get rid of those files that did not meet the requirements of the condition.
Comments Tab The Comments tab is common to all tasks. It contains a 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. Check the option Use as step description to display the text next to the icon of the plugin in the Process area. FTP Output FTP Output tasks send job files to other computers using the FTP protocol.
selected port is available and not being monitored by another application or PReS Workflow task. l User name: Enter an FTP server user name. l Password: Enter a password associated with the FTP server user name entered above. l l l Directory: Enter the directory to which the job files are to be uploaded. If you leave this box empty, the job files are sent to the root directory of the FTP server. File name: Enter the name under which the output job file will be saved.
A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol. The payload of the SOAP packet is an XML document that specifies the call being made and the parameters being passed. Web services, a SOAP class of applications, expose their services via the Internet in a manner that lets other applications access them, as well as use and combine them as required.
l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below. Service: Choose an available Web service from this drop-down list to populate the Method box below. You may also enter the service name directly if the WSDL file cannot be found. Method: Choose an available method from this drop-down list. This populates the Namespace box below. You may also enter the method name directly.
Advanced Tab l Domain: Enter the domain for the authentication on the SOAP server. The Domain is optional even when authentication is used. l Username: Enter the user name for the authentication, if required. l Password: Enter the password for the above user name. l Allow invalid security certificate: Check to ignore SSL certificates that are invalid. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82.
Input This task can accept either a data file with a correct emulation (see "About data emulation" on page 52), which is then merged to a PlanetPress Design document, or a PDF file which is to be printed natively. Processing Either the data file is merged with the document if one is selected, or the PDF File is printed natively through the PReS Printer driver (which prints the same as if one were to open the PDF in a PDF reader and print it).
l l Natively print PDF file: This special option can be used if your job file is a PDF. The job will . Add job information to the document: Select to prompt your PReS Workflow to add the available job information elements in the header of the file that will be sent to the selected printer queues.
The task can create print output as well, by merging the data file with a PlanetPress Design document (see "PlanetPress Design documents" on page 38). This requires at least one PlanetPress Design document to be associated with a Workflow printer queue (see "Associating PlanetPress Design documents and PReS printer queues" on page 106). For more information about printing see "About printing" on page 92. Input Any data file.
number, you can use an Add Document action task instead of a Printer Queue Output task, and then use an Add / Remove Text Action task to add a version number in the document trigger (for more information, refer to the Control Versions of a Document section of the PlanetPress Design User Guide). Note It is not possible to select a Connect template with this task.
selected, the first one sending jobs to a printer that prints 500 pages a minute, and the second one sending jobs to a smaller printer printing 50 pages a minute, the first queue will receive roughly ten times more pages than the second one. l l Page delimiter group: These options are enabled when you choose Split job or Queue balancing load balancing options. They are used to determine how each job is to be split before being sent to the Workflow printer queues.
Note In some combinations of Microsoft Outlook and Windows versions, it is not possible for Outlook to be opened while PReS Workflow is running, so emails are not sent out automatically. To correct this, make sure to log on to Windows on the PReS Workflow server using the same login that PReS Workflow is using, and open Outlook before starting the PReS Workflow services. You could also use a startup process to start Outlook before the rest of the services.
l l l Bcc: Specify discreet addresses (other recipients will not be able to see these addresses) to which a copy of the generated emails are to be sent. Subject: Enter the subject of the emails generated by PReS Image for this task. Note that if you use a data selection in this box, you must be sure that the data that will be selected at run-time will not contain any parentheses, as this would cause the task to fail.
l l l l Zip mode: Select how you want the files checked in the Attach box to be zipped. Select Zip individually to have PReS Workflow create a zip file for each file. Select Archive and Zip if you prefer to have one zip file that contains all the attached files. Zip file name: Enter the name of the one zip file that will be created if the Archive and Zip option was selected in the Attach box (this box is otherwise not enabled).
emails via the mail server. l Password: Enter the password associated with the account name entered above. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 82. Comments Tab The Comments tab is common to all tasks. It contains a 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.
variable property box, you can use any combination of text, variables and data selections; see "Variable task properties" on page 201. l l Concatenate files: If this option is selected, when PReS Workflow 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. In the case of a PDF, this will act like the "Merge PDF Files" on page 234 input task, merging the PDF logically.
l Opening a configuration that contains plugins only available in PReS Workflow (such as Create PDF) from a PReS Watch installation will cause these plugins to be replaced by Unknown tasks. Opening the configuration in a PReS Production or Office installation or upgrading PReS Watch to PReS Workflow and re-opening the configuration will restore the plugins and their properties. About variables A variable is basically a keyword that points to specific location in your computer's memory.
Job Info variables Job Infos contain information on any job file that comes out of the initial input task or any secondary input tasks. There are only 9 Job Infos available numbered from 1 to 9. They can be accessed directly anywhere where variable properties are accepted, by using the number of the variable preceded by a percent sign, for example, %2 or %9. Not all available Job Infos will actually be used by input tasks.
Note that Job Infos don't change whilst the task executes. Consequently, the value of the field that contains the Job Info will be the same in each of the records in the resulting record set.
Variable Name Example value when interpreted file extension %z Job file size in bytes 34134 %o Original file name invoice_june2nd.
Variable Name Example value when interpreted minute %s Current second 41 %v Current millisecond 24 %u Unique 13char string (will be different every time it is used) 0ZIS4CW8U47VI00 %U Unique 36character string consisting of 32 alphanumeric, lower case characters and four hyphens. Format: xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx (8-4-4-4-12 characters). 123e4567-e89b-12d3-a456-426655440000 %t Current C:\Documents and Settings\All Users\Application Page 515
Variable Name Example value when interpreted temporary folder Data\Objectif Lune\PReS Workflow 7\PlanetPress Watch\Spool\6.tmp\ %e Current Metadata file name job00ZAIZ2C4FXON16CE6C566.dat.meta %E Current Metadata path and file name C:\Documents and Settings\All Users\Application Data\Objectif Lune\PReS Workflow 7\PlanetPress Watch\Spool\5.tmp\job00ZAIZ2C4FXON16CE6C566.dat.
Initial input tasks do not modify the value of %i. However, the following tasks do trigger the variable: l Barcode scan l Capture Field Processor l All Splitters (Including the Metadata Sequencer) l Get Capture Document l Loop l Capture PGC Splitter l PrintShop Mail Error handling variables The following variables are available in error-handling tasks (that start with the Error Bin Input task). Note that these are new in PReS Workflow 7.4 and are not available in previous versions.
Variable Name % {error.tasktype} The type of task that triggered the error % {error.taskname} The name of the task that triggered the error % {error.taskindex} The position of the task in the process % {error.errormsg} The error message, as entered in the OnError tab of the task. This is the same message as appears in PReS Workflow Log file. %{error.errorid} The error ID, as entered in the OnError tab of the task. This is the same ID that appears in the Windows Event Viewer.
1. Select the process where you want to add the variable. 2. Now you can use one of two methods: l l Click on the Home tab of the PReS Workflow Ribbon, then click Local Variable in the Variables group. Right-click on the process in the Configuration Components area, then click on Insert Local Variable. Deleting a variable l Right-click on the variable name in the Configuration Components pane and click Delete. Note Deleting a variable does not delete any reference to it.
Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" on page 522). Global variables Global variables are set at the level of the configuration file and are shared between all processes and tasks. To refer to a global variable, for example in a variable task property (see: "About Tasks" on page 197), use its name preceded by "global." and surrounded by curly brackets, for example: % {global.myGlobalVariable}.
1. Double-click on the global variable in the Configuration Components pane. (Rightclicking then clicking Properties also works.) 2. Enter the new value for your global variable. 3. Click OK to save the new value. Deleting a variable l Right-click on the variable name in the Configuration Components pane and click Delete. Note Deleting a variable does not delete any reference to it.
Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" below). Variable task properties When you edit tasks, you may notice that some of the properties that you can modify have a red (or more precisely, a maroon) title. This means that the property can be dynamically determined whenever your process runs, that is to say it will not remain static.
an output file name: %O_@(1,1,1,30, KeepCase,Trim)_%y-%m-%d.txt. This would translate in the original file name, followed by part of the first line of a text data file, then the current date. Inserting variables in task properties In any variable properties box, you may use the contextual (right-click) menu to add variables and control characters, as well as to get data and make data selections.
You can quickly identify variable information that is already present in your variable properties as such: l l l l l A percentage sign identifies standard variables, as well as standard and custom job info variables — %f, for example. A backslash indicates a control character — \004, for example. An at sign (@) indicates a data selection for emulations other than database — @ (1,1,1,1,17,KeepCase,Trim), for example.
PlanetPress Capture is a set of tools available in PReS Workflow that enable output and input for interaction with an Anoto Digital Pen. Anoto Digital Pens are electronic devices containing a camera, processor, memory and communication capabilities and they can recognize their location on any paper where a special Anoto pattern is printed. For more information on building and using PlanetPress Capture processes, please see "PlanetPress Capture Workflow" on page 186.
Capture Condition PReS Workflow task that is used for post-processing of documents after they have been processed by the Capture Fields Processor. Conditions can be made on the document status or the presence (or absence) of ink on any of the Capture Fields on the document. Capture-Ready Document A PReS Connect document (*.pp7) that contains at least one Capture Field on at least one page. Capture Document Manager A tool that lets a user search through the available documents in the Capture Database.
sequence being used such as when a pen is docked in the wrong location or if two pens are swapped. ICR (Intelligent Character Recognition) Recognizing text that has been hand-written with the Anoto Digital Pen. This feature is currently not implemented in PlanetPress Capture, but will be in the (near) future. Ink Data The pen stroke information contained within the PGC file. This is the actual data applied to the document (lines, signatures, text, etc).
PGC File Pen Generated Coordinates; PGC File containing all ink processed while the pen was undocked along with the Pen ID. It is possible that a single document requires multiple PGC, just as it is possible that a single PGC have multiple documents. 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.
Database considerations (ODBC) Technical On 64-bit operating systems, the ODBC Data Sources created by the Data Source (ODBC) icon in the Administrative Tools will not appear here, as PReS Suite is 32-bit and cannot access the 64-bit data sources. In order to create an ODBC connection visible by PReS, you will need to access the 32-bit version of the ODBC manager, available in C:\Windows\SysWOW64\odbcad32.exe .
l l l l MySQL's performance has been slower than SQL Server and SQL Server Express during our tests. By default, MySQL is configured not to allow any SQL request larger than 16 megs. In the event where 2 requests are made simultaneously on the same record, MySQL will queue one of the requests and execute it once the first one is done. In extremely rare cases this may cause a timeout on very large requests.
concerns about security and privacy. Are signatures secure? Could their transmission be intercepted? How can the contents of the Anoto digital pen be protected from malicious users? Before addressing these concerns, it must be pointed out that these security issues are not introduced by this new technology.
l l l The PlanetPress Capture database, since it can be external to PReS Workflow such as on a MySQL server, will be dependent on your own database security. The Anoto Digital Pens, since they may contain critical information, are just like physical sheets of signed paper and must be kept secured. This is best done through training employees handling the pens to be aware of its value and contents and act accordingly.
In a typical PlanetPress Capture implementation, a process in PReS Workflow 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. PReS Workflow also stores a copy of each document in the Capture Database, in PDF format.
The example above actually uses numbers that are much higher than our typical PlanetPress Capture user. That is to say, a vast majority of our users will never have to worry about reaching the pattern limitation, unless their implementation is missing important parts, such as the "cleanup" process. But this also means a smaller minority of our users may require more than 20,000 patterns, so let's deal with this now.
company may have decided to print each "route" using the route number as a pattern sequence, and each pen is tagged (with a label) as being for use with a specific pattern sequence also. Each morning, as drivers are attributed a route, they pick up the correct pen and stack of paper that belong to their route before leaving. Note It's very important to note here that the Anoto Digital Pen has absolutely no concept of Pattern Sequences.
and in different situations, and can have devastating effects in some of those cases so please pay special attention to this section. First, contamination is not limited to implementations that extend their patterns through methods 1) and 2) above. Any time that a pen writes on a "wrong" document, it is considered contamination. A simple example in a basic implementation would be to print a document with a pattern on it, put this paper aside (or lose it on a desk somewhere) and forget about it.
Safeguards There are certain safeguards against contamination: l l PlanetPress Capture checks for pattern size and placement. If the data contains ink for a specific pattern but the ink location does not correspond to the Capture Fields of the document it's updating, it will fail. Errors can be set to stop and revert the whole current batch. If a single error occurs during the pen data processing, it is possible for this processing to be stopped and all changes the Capture Database reverted.
To configure this communication: 1. Open penDirector setup by right-clicking on its icon in the Windows System Tray, and selecting penDispatcher. 2. Double-click on the PlanetPress Capture entry. 3. Change the PGC Storage folder or PGC POST URL settings to your liking. 4. Click OK, then OK again. The PGC POST URL should correspond to your server name or IP, Port and the HTTP Action task of your HTTP Input, if that is what you are using. Example: http://127.0.0.
Warning Because the Bluetooth configuration only handles a single route, it is not possible to use the Design preview patter, or the special registration pattern, using Bluetooth connectivity. To use the preview Pattern in PlanetPress Design or use the special registration pattern, the pen's docking station must be used. To specify where to send the PGC files received through Bluetooth: 1. Open penDirector. 2. Go to the Bluetooth tab 3. Click on the paired pen that you want to configure 4.
Black ink close to patterns Because the Anoto Pen & Paper technology relies on infrared to read pure-black dots on the paper, it is imperative that no other black ink interfere with this reading. Though it is possible to print Capture documents on a black & white laser printer as long as there is no other ink on top of, or close to, the patterns, this is not recommended. A color laser printer should be used, and any elements placed close to, or on top of, the Capture Patterns should be printed in color.
Pattern sizes The absolute minimum required for an Anoto Digital Pen to read the pattern and know it's position on the page is 7mm (1/4"). Any pattern smaller than this will not be readable. However, at 7mm width and height, the pen can only recognize a single dot within that pattern, at the top of the field. This is because the pen's camera (which captures the position of the pen) is located under the pen tip and must fully see the pattern.
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.
PlanetPress Capture ICR The term "ICR", which means "Intelligent Character Recognition" is an evolution on the popularly-known "OCR", which is "Optical Character Recognition". The difference between the two is easily explained: While OCR can only recognize characters using the finished shape (for example, in scanned documents and pictures), ICR relies on much more data which is provided by the Anoto Digital Pen: the path that the pen takes, the exact timing of this path, start and stop points, etc.
Guide). This must be either a Multi-Area Field or a Text Field. l l l The Capture Fields Processor must have the Perform ICR Recognition option checked, and language needs to be selected. Once the ICR data is available, do something with it. This is done by reading the ICR data that is available in the metadata generated by the Get Capture Document task. The metadata is also readable by the Capture Condition task, including the captured text and the reliability of this text.
l l l ICR Value: The alpha, numeric or alphanumeric value that was determined by the ICR engine. ICR Confidence: A percentage value that the ICR engine gives to any specific value, when comparing the pen data with it's character database. ICR Resemblance: A percentage value that defines how closely the value resembles the "average" character shape. Both the Confidence and Resemblance can be used together to make an informed decision on the contents received by ICR.
The following guidelines are applicable when configuring a PlanetPress Capture object that utilizes ICR: l l l l l l l 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.
The following diagram illustrates the available mask types. It is recommended to select the mask type that is the closest to the desired result. An alphanumeric field should be used as a last resort. 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.
Why: To avoid any ink marks that would spill over from one field to another. If both fields A and B are to close in proximity and the ink marks from field A spill over to field B, then the marks captured on field B would be considered as being part of a character written on field B. For example, if a number spills over and is written over two fields like numbers 9, 1 or 7; then the bottom tip of these numbers could be considered as number 1 in the second field.
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. 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.
Selecting the Correct Language When Using the Capture Field Processor Task l l Target: Workflow designer. What: It is crucial that the correct language is selected when using the ICR recognition option. This will affect how the captured data is interpreted. Why: The available filters to interpret the ink marks done with the Anoto digital pen, allow you to select the engine language to be used. Doing so will give you results that are the closest match to the captured data.
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. This occurrence should be minimized as much as possible. How: Allow for a special process (possibly manual handling) in the case the automated process didn’t reach a high confidence level in its analysis of the ink marks. Use the plugin Capture condition that includes the ICRContent option. This can be configured to be a true condition if the confidence level is greater than a certain value.
Note Because of technical limitations, the minimum time required to generate a PReS Fax document is approximately 10 times longer on Windows 2000 than on Windows XP/2003. About PReS Image PReS Image is a multi-threaded service that can generate image files in PDF, JPEG and TIFF format. As PReS Workflow and PReS Image are compliant with AutoStore, DocAccel and KYOcapture, these formats can also be used.
processed by a given computer; see "PReS Image preferences" on page 668. Note that those options are specific to each PReS Image installation and that they are immediately applied. Workflow processes in a Connect Send solution OL Connect Send (see "OL Connect Send" on page 436) needs one Workflow process to handle the job transfer, and in licensed mode it needs at least one other process to interact with the user. Reports about the use of OL Connect Send might be produced in yet another Workflow process.
l The Create Preview PDF plugin generates a PDF preview for a single record as fast as possible. It is typically used for previews embedded in web pages. (See Create Preview PDF.) Production report process The key plugin in a process that produces reports about jobs received with OL Connect Send is the Get Data plugin. It allows to query the OL Connect Send database. (See "Get Data" on page 436.
Licensing The ZUGFeRD plugin is bound to the Connect Workflow Imaging license. Workflow Imaging is an add-on license bundle for Connect Workflow that includes the Image and Fax plugins. Without a valid Imaging license, the plugin will create a valid ZUGFeRD PDF file at design time and in debug mode, but will not apply ZUGFeRD data to the PDF in runtime/production mode. An unlicensed plugin will simply will pass through any incoming PDF files untouched.
Input A PDF file that is PDF/A compliant. The PDF/A conformity level doesn't matter. It may be 1, 2 or 3. Processing The plugin first checks that the PDF is PDF/A compliant, and doesn't already contain ZUGFeRD data. If it is, then the PDF is processed. Output A PDF/A-3 file with the selected ZUGFeRD data included. If the incoming PDF is not PDF/A compliant, the plugin will not touch it but will instead forward the untouched PDF as the Job File.
l l Workflow Jobdatei: Use the incoming Workflow Job File. Datei: Specify a specific PDF. Use the browse button the file path and name into the edit box. to select a file, or paste The file path and name can be given and defined via variables, so the file selection can be dynamic. Note The PDF selected must already be PDF/A compliant. The conformity level doesn't matter (it may be 1, 2 or 3).
l Lieferant group contains all the required values and information related to the seller, delivery and/or the invoicing party. l l l Name: The individual or company name. This field supports alphanumeric strings, and can be set via Workflow data and/or variables. Adresse: The postal address (sans post code and city entries). Two address lines can be included in this entry. This field supports alphanumeric strings, and can be set via Workflow data and/or variables.
entered. This field can be set via Workflow data and/or variables. l l Art der Steuernummer: The two letter code for the tax identity number. Select from the drop down list box. The choices are either "VA" (Umsatzsteueridentifikationsnummer (UStID)) or "FC" (Steuernummer (national)). This field can be set via Workflow data and/or variables. Steuernummer: The tax identity number. This number must match with the tax type specified in the "Art der Steuernummer" selection.
l l Ort: The postal address city/town. This field supports alphanumeric strings, and can be set via Workflow data and/or variables. Ländercode: A 2-letter country code as defined by the industry standard ISO 31661 alpha-2. The plugin provides some common predefined country codes in the pull down list. Codes other than those provided can be entered either manually or through variables. However, the country code must always follow the standard of exactly two uppercase letters only.
variables. l Währung: This is a 3-letter currency code, as defined in the ISO 4217 3A standard. The plugin offers some predefined common currency codes in the pull down list box. Other codes can be entered manually or via variables. However, the currency code must follow the ISO standard of exactly three uppercase letters only. Note The plugin does not check if a given currency code is in the list of valid currency codes in the mentioned ISO.
Note The plugin does not validate bank IBAN/BIC codes. It is the responsibility of the user to ensure that valid codes are entered. This field can be set via Workflow data and/or variables. l Allgemeine steuerliche Informationen group contains taxation related general information. l Steuerart: The trade tax code following the international UNCL 5153 standard. Generally this is "VAT" (Umsatzsteuer, value added tax). Note The plugin will accept any string.
l l l l l Bruttosumme: The grand total amount. This should be a numeric currency, which can be set via Workflow data and/or variables. Gesamtbetrag der Zuschläge: The charge amount. This should be a numeric currency, which can be set via Workflow data and/or variables. Steuerbasisbetrag: The basic amount, upon which tax is drawn. This should be a numeric currency, which can be set via Workflow data and/or variables. Gesamtbetrag der Abschläge: The total amount of discounts and allowances.
Although you can manually start and stop any service running on your computer, most of the basic services used by the system are started and stopped automatically. In the case of PReS Workflow and their related services, you typically use a command included in your PReS Workflow Configuration program to start and stop most services. Opening and closing your PReS Workflow Configuration program has no effect on these services.
l l l l l l l FTP Output service: Places output jobs on a server via the FTP protocol. LPR (Line Printer Requester) Output service: Sends jobs to an LPD server or LPD compatible printers. The LPD/LPR printing protocol is a common way to send print jobs that, in turn, use the TCP/IP protocol to communicate through the network. PReS Image: Outputs jobs as PDF files or in a variety of image formats. You can also use PReS Image to archive and/or email the files it creates.
Click Tools in the PReS Workflow Ribbon. Then, in the Services Status group: l l l Click Start Service to start the service. A progress bar is displayed while your PReS Workflow is being started. Click Stop Service to stop the service. When you stop or pause PReS Workflow, it immediately stops bringing new files into its processes, but it keeps on performing tasks until all the files which are currently under process have been completely processed. Click Pause to pause the service.
Workflow and all its services the same rights associated with the selected account (this is true of all services with the exception of the PReS Workflow Messenger which always uses the local system account). It is important to note that PReS Workflow and its services require administrator rights to run on any given computer and that they must therefore be associated with an account that has such rights.
option is selected in the network options), then you should have no problems running configurations on different systems using different user accounts. Workflow Services To be able to run and to have access to local files as well as to files available on other computers in your network, PReS Workflow applications and services must identify themselves using a local or network account.
l This Account: Provide a domain, user name and password to use instead of the Local System Account. l l l l l Browse: Opens the default Windows dialog for selecting users/groups/etc. from a domain. User: Enter the name of the user account. Password: Enter the password for the user account you specified in the user name box. Confirm password: Enter the password you entered in the Password box. Services start automatically: Select to start the required PReS Workflow automatically.
The Interface This chapter centers on the PReS Workflow Configuration program, which you use to create and edit your configurations. The basic user interface elements are as follows: 1. The PReS Workflow button. See "PReS Workflow Button" on page 580. 2. The Quick Access Toolbar. See " The Quick Access Toolbar" on page 687. 3. The Ribbon Tabs. See "The PReS Workflow Ribbon" on page 688.
4. A Group within the Ribbon 5. The Process area. See "The Process area" on page 678. 6. A specific link (aka a "component", "button" or "link"). 7. The Dockable panels including "The Plug-in Bar" on page 633, " The Object Inspector Pane" on page 632 and "The Debug Information pane" on page 630. 8. The status bar. This displays your current software version and status of the PReS Service. 9. The Configuration Components pane. See "Configuration Components pane" on page 582. 10. The Messages Pane.
The Configuration Components pane, the Object Inspector and the Messages area can each be displayed inside its own window, whether docked or undocked, but they can also be displayed attached or combined inside the same window. l l l When separate areas are displayed simultaneously, they appear in different sections of the Program window. When attached areas are displayed simultaneously, they appear side-by-side or above one another inside sub-windows.
Show or Hide Areas of the Program Window You can choose to hide or display any of the customizable areas in PReS Workflow program. Hidden areas will still contain the same information but will not be visible. To show or hide a Program window area: l In the PReS Workflow Ribbon, click the View tab. l From the Show/Hide group, click on any area name to hide or display it. A "highlighted" (orange) button means the area is displayed somewhere on your screen(s). A dim (blue) button means the area is hidden.
button 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.
To take an area out of a combined area, do one of the following: l l Click the tab displaying the name of the area you want to take out and move the mouse pointer so as to drag the area away from the combined area. As you drag, a rectangle is displayed to show the landing position. Release the mouse button when the rectangle is away from the combined area. Double-click the tab of the area you want to take out of the combined area. The area will jump outside of the combined area. To attach areas: 1.
3. Resize each part of the new group as desired. Attaching an area to a group of combined areas. The rectangle showing the landing position is not tabbed and the area will therefore be moved next to the combined area. To maximize or restore attached areas, do one of the following: l To maximize a vertically attached area, click the upward pointing arrow on its title bar. l To restore a vertically attached area, click the downward pointing arrow on its title bar.
Page 578
A) Click to maximize this area. B) Click to restore this currently maximized area. C) Click to maximize this area. D) Click to restore this currently maximized area. To take an attached area out of a group, do one of the following: l 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.
To change the language used by the PReS Workflow Configuration program: 1. Click the PReS Workflow button, then click Select Language. The Select Language dialog box appears. This box lists all the languages that can be used by PReS Workflow as well as the Use System Default Locale check box. 2. Select the desired language. 3. Use System Default Locale: Select to mirror your language settings, as defined in the Regional and Language Options of the Windows Control Panel.
l l l Save: Saves the current configuration. If the file is new and has not yet been saved, or if the configuration is the loaded directly from the service, the Save As dialog is displayed instead. See "Saving and sending a Workflow Configuration" on page 119. Save As: Saves the current configuration under a new name. It does not overwrite any existing configuration file, unless an existing file is selected and overwritten manually by the user.
Configuration Components pane The Configuration Components pane displays processes, subprocesses, variables, resource files and printer queues. It also lets you add any of these components using the right-click menu. Components Area Sections l Processes: Displays a list of processes in your configuration (see: "About processes and subprocesses" on page 107).
l l 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 (see: "Global variables" on page 520).
l l l l Job Presets: Displays a list of Job Presets that can be used in the "Create Job" on page 459 task. Output Presets: Displays a list of Output Presets that can be used in the "Create Output" on page 461 task. PPS/PSM Documents: Displays a list of PlanetPress Suite Design and PrintShop Mail (Suite) documents that have been imported into PReS Workflow (see "PlanetPress Design documents" on page 38 and "PrintShop Mail documents" on page 43).
l PS Test Page: Prints a test page in PostScript format. Useful for validating whether the printer supports PostScript. l Text Test Page: Prints a text-only test page on the printer. l Properties...: Displays the printer queue properties. Note Deleting a component that is currently used by a process will cause this process to stop working and trigger an error, until the task that causes the error is removed, or changed to point to another existing component.
the input task polls its source once, determines the number of files to process, then replicates itself up to the maximum allowed and treats the files simultaneously. The initial process runs again once it has completed itself and replicates again as necessary, until all files have been processed. l l l l l l Max percentage of threading (%): Determines how many processes you may have running at the same time.
l l Time division: Select the duration of each daily segment in the time grid. If you select 00:15, each segment will represent only 15 minutes and each day will be made up of 96 blocks (4 blocks per hour times 24 hours). If you select 24:00, each segment will represent an entire day. Poll once per activity period: Select to perform this process’ initial input task no more than once for each set of contiguous blocks (blocks that are on the top of one another).
l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two. l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
l l l To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler. To deselect all the days or dates for a given time segment, CTRL+click the time segment on the left grid ruler.
On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings. The options in the On Error tab of the Process Properties dialog are the same as in the On Error tab in the Task Properties dialogs; see "Using the On Error tab" on page 82.
printer-resident document in your PReS Workflow Configuration. It may have a PTK extension (if it has been sent to PReS Workflow from PlanetPress Design), or a PS extension (if it is printer-resident). l l Version: The version of PReS Workflow in which the document was originally created. Printer-resident documents are identified as such. Document name: The name of the document as entered in PlanetPress Design.
l l Document Update group (enabled only when using printer-centric mode and the document is on the printer) l l l l RAM: Select if the PlanetPress Design document is on the printer's RAM (Random Access Memory). Automatically update: PReS Workflow will send a new version of the document to the printer automatically if the document has been changed since it was last used.
Normal mouse pointer Move mouse pointer Copy mouse pointer Prohibited mouse pointer Moving Configuration Components You can move components in the Configuration Components pane in a number of ways; see below. Note that moving a configuration component does not change the order in which the components are used. However they can affect your process if, for example, you move a local variable from one process to another and the local variable is still used in the first process.
Using the clipboard buttons l Click on the component you want to move. l Go to the Home tab of the ribbon. l Click the Cut button in the Clipboard group. l Click on the new location where you want the component. l Click the Paste button in the Clipboard group. Using the contextual menu l Right-click on the component you want to move. l Click on Cut in the contextual menu. l Right-click on the new location where you want the component. l Click on Paste in the contextual menu.
Note You can also copy multiple components by selecting more than one then using the methods described above. However, you can only select multiple components from within the same folder. You cannot, for example, select a subprocess along with a process and move them together. Also, you cannot select multiple components if they are not in the same group or if one is in a group and the other is not.
Reordering objects in the Configuration Components pane There are multiple ways you can reorder objects in the Configuration Components pane. Commands available from the right-click menu let you reorder selected objects, as well as alphabetically reorder objects listed directly under a category or appearing within a group. You can also use the clipboard controls and drag & drop methods described in " Using the Clipboard and Drag & Drop" on page 592 to copy and move objects and tasks.
Items can only be grouped within their own category. Thus you can only group processes with other processes, documents with other documents, and printer queues with other printer queues. In the documents category, you can only group documents with others of the same version and type. For example, you can only group documents from PlanetPress Design (files with a PTK extension) with other PTK files, not with printer-resident documents.
Expanding and collapsing categories and groups in the Configuration Components pane You can expand and collapse the Processes, Global Variables, PPD/PSM Documents and Printers Queues categories, and groups, in the Configuration Components pane. To do this, click the Expand / Collapse button to the left of the item. Delete objects and groups from the Configuration Components pane To delete a process, document, or printer queue: l Click a process, document, or printer queue, then press the Delete key.
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. To open the Access Manager 1. Open PReS Workflow. 2. In the Ribbon, go in Tools > Managers > Access Manager. The Access Manager dialog box is displayed. It lists all IP addresses and IP ranges that have PReS Connect modules installed in the same network.
Messenger access Manually adding new entries to the list To grant access to the Messenger service you can manually add new entries to the list: l Open the Access Manager. l Make sure you are in the Messenger tab. l In the IP address box, enter the IP address of the remote machine. l Click on the l Add the necessary permissions. l Click OK. l Restart the Messenger service. button. Note The format of the IP address must be one of the following: l l l l 127.0.0.1: The local computer.
4. Click OK. 5. Restart the Messenger service. Removing an entry from the list To remove an entry from the list: 1. Remove all checkmarks from the entry. 2. Click OK. 3. Restart the Messenger service. Warning The following considerations are to be understood when using the Access Manager to configure IP limitations: l l l l Each permission type (column) is evaluated from top to bottom (column per column) in the order in which they are visible in the Access Manager window.
l Host name: The name of those computers on which PReS Workflow software are currently installed or which have been manually added. l IP address: The IP address or IP address range to give permission to. l Permissions l HTTP Input: Grants access to send HTTP Requests to this server. l LPD Input: Grants access to send LPD Queue jobs to this server. l l l Send Job: Grants access to the selected computer or server to send jobs to PReS Fax and PReS Image installed on this server.
Adding a new SOAP user To add a new SOAP user: 1. Click on the button. 2. Enter the following information under the Username column for the new entry that was created: l l l User name: An alphanumerical user name for the user. Password: A password to protect the user. Note that the password will always revert to ******** (8 stars) when clicking outside of this box - that is normal and is meant to protect the length of the password as much as its contents.
l l Admin: Has access to all processes and features. When this option is selected, the Permissions section is grayed out an all options are selected in it. Disabled: Has access to nothing. The result is the same as not having this user defined at all, but has the advantage that a disabled user can be reactivated with a simple click. 3. Define the permissions for the user (see below). 4. Click OK to save the changes.
Note Activating a printer is required when you have a PlanetPress Suite Printer License. Printer activations are normally given to you by the activations department electronically, including a file that will automatically add all your printers in this dialog. To display the Activate a Printer dialog, click the Printer Activation button from the Help menu. The printer list displays the following information l l l License Number: Reference number of the activation, linked to your customer account.
Advanced SQL Statement Dialog The Advanced SQL Statement dialog is available by clicking the Edit SQL button from the Database Query action task. You can enter a custom SQL query in this dialog, using the language supported by the database you select in the Database Query action task. The dialog is separated in two parts: l The left part displays the available tables in your database. Click the Show Tables button to display them.
to save any sort of textual data in a table format. Accessing the Data Repository Manager To access the Data Repository Manager: l Open PReS Workflow l Go to the Tools tab. l Click the Data Repository Manager button in the Managers group. Warning Any change made within the Date Repository Manager is Immediate, and Irreversible. Deleting data from this interface may impact running processes if such processes access the data saved in the repository.
l KeySet section l l l l Edit KeySet: Click to edit the currently selected KeySet. Opens a dialog which each key and their value, which can be edited. Double-clicking a row has the same effect as clicking the Edit KeySet button. Refresh: Click to load any changes made to the repository since it was last opened or refreshed. Management section l l l l l Delete KeySet: Click to delete the currently selected KeySet in the Group. Warning: This action cannot be undone.
l s = one or more digits representing a decimal fraction of a second l Z = literal constant representing the UTC time zone designator. Repository Structure Pane This section of the Data Repository display a tree view of all groups in the data repository as well as all the Keys under each of those groups. l To add, delete or edit a Group, use the contextual menu (right-click). l To expand a Group and edit its Keys, click the + or double-click on the Group .
l l Press F2 to rename a group or a key on the Repository Structure pane. Press Delete to remove a Group or Key from the Repository, or a KeySet from the KeySets pane. Tip You can look up these shortcuts by right-clicking the item you want to interact with, and looking at the contextual menu. The Data Selector The Data Selector is the tool you use to choose your sample data and Metadata files, to select the appropriate emulation, to make data selections, and to stabilize your data.
The Data Selector is essentially the same as the one used in PlanetPress Design. 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" on page 328) with the Use Emulation option unchecked. The only data formatting codes to which the File Viewer responds are line breaks.
the current task) to format the data. It displays the formatted data to let you make selections easily using the mouse pointer. 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. The Line Printer, Ascii, Channel Skip and User-Defined emulations will display the default options (see "About data emulation" on page 52) and a grid-like display of each character on each line.
The Sample metadata filename is the path to the Metadata file describing the current sample data file. Buttons on the right can be used to load Metadata from a file or to save the current Metadata to a file. Tip To get a sample of the Metadata file, debug your process and step through it until the option Debug > View Metadata gets enabled. This happens when Metadata have been created by a task in the process. Open the Metadata viewer and save the Metadata file to use it as a sample file.
The User defined information lists all Metadata fields defined by the user on the current Metadata level. Note Not all of the options in the Metadata Selector in PlanetPress Design 7 are available in the user interface of PReS Workflow . However, when these settings are made in PReS Design 7, they will function as expected in PReS Workflow2018.1. Data Selector display preferences The Data Selector Preferences are accessible through the Selector Options tab in the Data tab of the Data Selector.
Content and appearance of the Data Pane To adjust the content and appearance of the Data pane for all emulations except XML and PDF: 1. In the Data Selector, click the Selector Options tab. 2. Change the options that modify the appearance and behavior of the Data pane: l l l l l l l View size: Use to adjust the size of each cell in the Data Pane, and the amount of visible data that is visible. Show used cells: Select this to display in green all cells that contain data.
Color of used cells To select the color the Show used cells option will use: l Click on the Select Color button . Font To set the font the Data Selector uses for all emulations except XML and PDF: 1. In the Data Selector, click the Selector Options tab. 2. Click Select Font. 3. In the Font dialog box, set the font you want PReS Workflow to use to display the sample data file in the Data Pane. l Font: Select the font you want to use to display the sample data file in the Data Pane.
Because this PDF viewer is integrated with the suite, it is not necessary to have any third-party tools such as Adobe Acrobat installed on the operating system. Technical The PDF Viewer is not currently standalone and cannot be used to display PDFs outside of PReS Workflow.
The PDF Viewer To open the PDF Viewer: In the Documents section of the Configuration Components pane, expand a document present in the list. Then, right-click on the document's Preview, and click Open in PDF Viewer.
The 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, right-click 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). If the viewer is opened during debugging, the current state of the PDF will be displayed (instead of the original data file).
Note Subprocesses do not have the "General" tab which is only used for scheduling, but they do have the Information tab. Options General tab 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 PReS Workflow. Startup process: Select to make this process a startup process.
l l Month: Select the month of the year when the process should be run or select All months to have the process run all year long. This option is disabled when "As soon as possible" is checked. Week of month / by date: Select the desired option for the time grid. Note that any selection you make in this box will be interpreted based on the selection made in the Month box.
l Click on any block to select / deselect it. l Click and drag from one block to another to toggle all blocks between the two. l Shift-click on any block to toggle all blocks from the top-left corner of the grid to the block you click.
l l l To select all of the time segments for a given day or date, click the day or date on the top grid ruler. To deselect all of the time segments for a given day or date, CTRL+click the day or date on the top grid ruler. To select all the days or dates for a given time segment, click the time segment on the left grid ruler. To deselect all the days or dates for a given time segment, CTRL+click the time segment on the left grid ruler.
On Error Tab A process’s On Error tab specifies the default values for error handling of all of the tasks in that process. When a task has its own error handling settings, those settings overwrite the process's default error handling settings. The options in the On Error tab of the Process Properties dialog are the same as in the On Error tab in the Task Properties dialogs; see "Using the On Error tab" on page 82.
complete before pausing. Once paused, the service is still "started" but will wait until it is activated again before processing jobs. This is very useful if you want to receive jobs from external services (such as with the LPD Server) but not process them right away. To kill (force quit) a service: 1. Right-click on the running service. 2. Click on Kill. 3. Click OK to confirm on the warning. If the service is currently processing a file, execution will stop and the action will not complete.
Copying messages To copy one or more log messages: l l Right-click on the message and select Copy from the contextual menu. Click on the message and press Ctrl + C, or select File > Copy from the menu. Keep the Ctrl key pressed down to select multiple messages. Searching through the active log file When a log file is active in the log viewer, it can be searched by going in the Search menu, then clicking Find.
on it opens the log file in the viewer. Right-clicking on the file brings a menu from which the log file can be refreshed, or removed from the list. The log viewer for existing log files does not refresh automatically since log files for older days do not generally change. The display of the sessions, processes and tasks is the same. Note The log viewer as described here was introduced in version 7.4 of PReS Workflow.
then use the Virtual Drive Manager to see the images that were downloaded to your computer as well as to delete them from your virtual drive. To add images to the virtual drive, use either of the following methods: l Send a single resource file to the printer: see "Download to Printer" on page 290. l Send one or more images to the printer: see "Send Images to Printer" on page 306. l Use PlanetPress Design: see the PlanetPress Design User Guide. To delete images from your virtual drive: 1.
unavailable. It is recommended that you create a configuration for a particular user. Clear the Local System account checkbox to run all the PReS Workflow Services under the account you specify. Use the options that become available when you clear Local System account to enter the account information—you must enter a valid user name and password to use Microsoft Outlook as your email client for Email input and Send email output tasks.
The Debug Information pane The Debug Information pane displays the current values of variables and other information useful in debugging processes (see "Debugging and error handling" on page 81). It is divided in 4 sections: l l l l Job Information: Displays the Job Info variables, as well as the job's file name, size, last edit date and presence of metadata (see "Job Info variables" on page 512). Local Variables: Displays all the variables local to this process (see "Local variables" on page 518).
Warning Deleting an expression or clearing the expression list cannot be undone! The Message Area Pane The Messages area is used in Debug mode to indicate the status of your PReS Workflow process as the sample data file is processed and used to generate output. When your PReS Workflow runs in Debug mode, the Messages area displays useful processing and error information. Messages are displayed in different colors (debug levels) in the Message area.
The 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 PReS Workflow Service). To learn more about debugging a process, refer to "Debugging and error handling" on page 81. The Object Inspector Pane The Object Inspector displays the properties of the object selected in the Configuration Components pane (not the Process Area, however).
Note When you select a group (folder), no information is displayed in the Object Inspector, because what is really selected is the group heading and not the items included in the group. The Plug-in Bar PReS Workflow offers a constantly increasing number of plugins, while always allowing third party plugins to be installed and set up to be used by PReS Workflow. The PReS Workflow Plug-in Bar lists all plugins available in PReS Workflow, and is divided into categories, which users can customize at will.
l OL Connect Send, see "OL Connect Send" on page 436 l Outputs, see "Output Tasks" on page 494 An Uncategorized category is dynamically created if your PReS Workflow finds any plugin that would not be part of the existing Plug-in Bar. User-defined plugins and third party application plugins fall into such a category. Settings & customization The Plug-in Bar can be customized according to your needs and the plugins you most frequently used.
3. Browse to the location of the plugin DLL file. 4. Click on Open. New plugins appear in the Uncategorized category. Preferences PReS Workflow Configuration program lets you configure a variety of options, from how the application itself looks or behaves, to plugin specific options. Most of PReS Workflow preferences are located in the PReS Workflow Preferences window, accessible through the Preferences button in the PReS Workflow button.
l SMTP Input l "Telnet Input plugin preferences" on page 664 l "PReS Fax plugin preferences" on page 664 l "FTP Output Service preferences" on page 667 l "PReS Image preferences" on page 668 l "LPR Output preferences" on page 671 l "PrintShop Web Connect Service preferences" on page 673 Note Preferences are saved automatically and applied immediately.
l l Highlighted tasks and branches: Select the background color for highlighted tasks and branches in the Process Area’s invisible grid. Disabled tasks and branches: Select the background color for disabled tasks and branches in the Process Area’s invisible grid. Inactive process l Color: Select the color to use to identify inactive processes in the Configuration Components pane. l Bold: Select to use a bold font to display inactive processes.
l l Line style: Select a style for the lines. Reset to default button: Click to reset all the Object Inspector options to their default values. Configuration Components Pane appearance preferences Colors 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.
l l l l l l Default input task: Select an input task to use as the default input task when you add a new process. Click the Configure button located to the right of this box to set the properties of the selected input task. Default output task: Select an output task to use as the default output task when you add a new process. Click the Configure button located to the right of this box to set the properties of the selected output task.
l l l l l l l l l l l Empty group deletion: Select to have PReS Workflow prompt for confirmation to delete a group when you remove the last of its member objects. If you clear this option, groups are automatically deleted when their last members are removed. Invalid name: Select to have PReS Workflow warn you when you try to rename an object in the Configuration Components incorrectly. Names can include letters, numbers, and underscores; the first character of a name cannot be a number.
l l l l l l l l l l Prompt on no active process to send: Select to have PReS Workflow prompt for confirmation when attempting to send a configuration although no processes are active. Prompt on overwrite of a document: Select to have PReS Workflow prompt for confirmation when a document that is being imported using File | Import Document is about to overwrite an existing document.
l Warn on Component Rename: Select to have PReS Workflow prompt for action when configuration components, such as processes, are imported from an external configuration file. Imported components can overwrite existing components, or be renamed automatically with unique names. Sample Data behavior preferences Sample Data behavior preferences control the way theData Selectordisplays the sample data file.
l l l Tree: Enter the NetWare Directory Services (NDS) tree where the user resides. This is the user you entered in the user name text box. Click Trees to navigate to the desired tree. You must enter a value for the Tree text box. Context: Enter the context on the NDS tree where the user you enter in the user name text box resides. Server: Enter the server where the NDS tree you entered in the Tree text box resides.
l Document and Pattern Database group l l l Use ODBC Database: Check to ignore the default location for the Microsoft Access database (MDB) and use an ODBC connection to your own database location instead. ODBC Settings: Click to open the "PlanetPress Capture ODBC Settings" on page 647 dialog. l Test Connection: Click to verify the connection to the ODBC Database. l Reset Database: Click to reset the database to its original status. l l Status: Displays the status of the database.
Note The Server/Client mode is only used for managing pen licenses and has no impact on the Capture Database itself. The database can be stored locally or remotely, regardless of the Server/Client mode specified. PlanetPress Document Manager The PlanetPress Capture Document Manager dialog is used to manage all the documents present in the PlanetPress Capture database that are currently open.
l Operator: Select how to do the comparison l Equal: The mask and database information are exactly the same. l Not equal: The mask and database information are different. l l l l l l Less than: If the mask and database information are both numbers, the mask will be a smaller number. Greater than: If the mask and database information are both numbers, the mask will be a larger number.
Warning This will prevent the document to be further updated, may cause errors when docking any pen that signed the printed version of the document. This cannot be undone. PlanetPress Capture ODBC Settings This dialog is used to set up the connection to a PlanetPress Capture Database through an ODBC connection. To access this dialog, See "PlanetPress Capture preferences" on page 643.
l l user name: If the database is secured with a user name and password, enter the user name here. Password: If the database is secured with a user name and password, enter the password here. Note In order for the database connection to be functional, you must ensure that the database Type correspond exactly to the one used by the DSN, and is part of the supported database types.
l l Microsoft Access l l Database file (mdb) must be local to the PReS Workflow computer. It cannot be located on a network drive or another server. l Total database size is limited to 4GB of data. l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l The recommended ideal setup is a dedicated SQL Server PC, accessed by PReS Workflow through an ODBC connection on the local network.
Options and Controls Top Toolbar l l l Read PGC File: Click to display a File Open dialog. Browse to an existing PGC file, and open it. PlanetPress Capture will read the serial number from the PGC file and register the pen. Print Pen Activation File: Click to print a page containing a special pattern. Any pen that writes on this pattern and is then docked will be registered in the database.
To register a pen using the registration pattern 1. Click on the Print pen activation file button in the top toolbar of this dialog. 2. Use the Windows Print dialog to print to the desired printer. 3. Write or make a line on the printed pattern. 4. Dock the pen in its cradle. 5. Click on the Read PGC File button in the top toolbar of this dialog. 6. If necessary, enter an optional pattern sequence and User ID for each pen.
Technical To add a pen pack, PlanetPress must be activated using a PlanetPress Production license. if PlanetPress Production is in trial mode, no pen pack can be added because the Pen Pack uses the serial number. Options and Controls PlanetPress Capture Pen Licenses Group l 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 available OL Connect user options define the default behavior of OL Connect tasks' OL Connect Proxy tab. These values are used unless they are overwritten in a task's properties: l Server Connect Settings l l l l l Connect Proxy Address: Enter the machine name or IP Address where the OL Connect Server resides. Port: Enter the port to use to communicate with the OL Connect Server. Default: 9340 User name: Enter the user name expected by the OL Connect Server.
Warning The default values are generally correct for the greatest majority of PDF data files. Only change these values if you understand what they are for. Delta Width Defines the tolerance for the distance between two text fragments, either positive (space between fragments) or negative (kerning text where letters overlap). When this value is at 0, the two fragments will need to be exactly one beside the other with no space or overlap between them.
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. If the space between two fragments is too small, the text extraction will sometimes eliminate that space and count the two fragments as a single word. To resolve this, the Gap setting can be changed.
l l l Add time stamp to all processes events: Adds a time stamp to each log entry for a process event. Delete log files after: Select how many days log files are kept before being deleted. Maximum numbers of replicated processes: Set the maximum number of times a process may be replicated. Messenger plugin preferences Apart from enabling communication between the various parts of PReS Workflow, the PReS Workflow Messenger also manages local instances of the PReS Workflow Alambic.
HTTP Server Input 1 plugin preferences HTTP Server Input 1 plugin preferences control the server protocol aspects of the PReS Workflow HTTP Server Input tasks. This is where you enable and configure secure communication for the HTTP Server. Click the PReS Workflow button and then the Preferences button, to open the Preferences dialog. The HTTP Server Input 1 plugin preferences can be found under Plug-in. Preferences l l l Port: Select the TCP port to use.
Note When SSL is enabled and a user sends a query prefixed with https://, then this specific communication will be sent through port 443, which cannot be changed in Workflow. However, http:// requests will still be received on the port specified in http server preferences. Note SSL is used to accept secured, encrypted requests from web clients and requires a certificate delivered by an approved authority. SSL can also be called HTTPS, though that is a misnomer.
l Omit attachments as CData node in the XML envelope: By default, the request XML has a CDATA node that contains the raw input data, effectively doubling the size of the incoming XML file, which due to technical restrictions cannot be larger than 400 MB. This option allows for much larger (non-binary) attachments by removing them from the XML data file. Generally attachments are both saved on disk and included as a CDATA node within the XML envelope.
253 dent 361 341 dent Resulting XML structure with Enhanced PHP-like arrays email@example.
The available HTTP Server Input 2 preferences are as follows: l Serve HTTP resource: Check to activate static resource serving. l l Resource action name: Enter a name that will be simulated as a folder in your HTTP structure. For example, if you enter images in this box, you would refer to any files in this folder as href="images/file.ext" . Resource folder: Type the path of the folder where your resources are located, or click the Browse button and choose the folder in the browse dialog.
Preferences l Protocol options group l l l l l Log all Winsock and network messages: Select to have PReS Workflow keep a log of all Winsock and other network messages that occur through the LPD service. These are messages related to jobs being sent from other systems through LPR, and being received by PReS Workflow via LPD. Since these messages can accumulate, you have the option of not logging them. Log files are kept in the Log folder, which is located in the PReS Workflow installation folder.
Preferences l Serial settings group l l l l l l l l Serial port: Select the port of the computer where the Serial input is connected to (COM1 through COM8). Baud rate: Select the baud rate of the Serial input. The baud rate is the number of bits transferred per second. The transferred bits include the start bit, the data bits, the parity bit (if defined), and the stop bits. Data bits: Select the number of data bits defining the incoming data file on this serial port.
Telnet Input plugin preferences The Telnet input plugin preferences control the log of the PReS Workflow Telnet Capture service. Since PReS Workflow lets you monitor multiple Telnet inputs simultaneously, the port setting for all Telnet input tasks cannot be set in the Preferences. Preferences l l Log all Winsock and network messages (very verbose): Select to have PReS Workflow keep a log of all Winsock and other network messages that occur from the Telnet input.
l Fax service: Select the faxing program to which PReS Fax sends its documents for faxing. Each faxing program has its own options and changing this option also changes the options below to reflect the following: l WinFax Pro l Dialing format: Select how you want PReS Fax to read the fax number in the data selection and send it to WinFax PRO.
l l l l Folder: Enter or select the location of the report file. PReS Fax generates report file names automatically with the file name extension PFX. The report file is copied to the specified Report folder only after all fax transmissions in a PReS Fax job are completed or have exceeded the maximum number of retries. This folder can then be used as an input for a PReS Workflow process for monitoring the status of PReS Fax jobs.
l l Expand folder paths in UNC (Universal Naming Conventions) format: Select to have PReS Fax use complete network server path names (\\servername\sharename\path\filename). This naming convention works well with Windows operating systems, Novell NetWare, and other operating systems when using a local naming system (such as the DOS naming system in Windows) would result in “File not found” error messages. Dialing options button: Click to set the appropriate options as required.
Options l Protocol Options Group l l l l Log all Winsock and network messages: Select to have PReS Workflow keep a log of all Winsock and other network messages that occur through the FTP output. These messages are related to jobs sent from PReS Workflow to a server via an FTP output, which in turn uses the FTP output service. Log files are kept in the Log folder, which is located in the PReS Workflow installation folder. They are named ftpdate.
PReS Image 1 or logging tab l l Administrator’s address(es): Enter one or more system administrator email addresses to which error and other messages related to the creation of PDFs/images by PReS Image are sent. Separate multiple email addresses with semi-colons (;). Send to the administrator group l l l l l l l l l Daily log: Select to send an email to the administrator every day at midnight (according to the local system clock) reporting the daily activity of PReS Image.
PReS Image 2 or database tab Add PDF to PReS Search database group: Select to populate a PReS Search database using the documents created by PReS Image and to activate the related options. Refer to the PReS Search User Guide for more information on this PReS Workflow software. l l l l l l l Database type: Select the type of the database in which you want to create a table (Access, or SQL Server).
PReS Image 4 or login tab l l Use Microsoft Outlook: Select to use Microsoft Outlook on the host computer running PReS Image to send the error messages to the administrators. The host computer must be running Outlook, and PReS Workflow must have access to Outlook. Outgoing emails appear in the outbox of Outlook, and is sent whenever Outlook is set to send email.
Options l Protocol options group l l l l l Print banner pages between jobs: Select to print banner pages between each job processed and output from the LPR output. The banner page includes details of the job being printed, including the job file name and the user name on the host computer running the LPR output client. No source port range restriction: Select to remove any restrictions on the port PReS Workflow uses to send the job file via the LPR/LPD protocol.
l Polling interval (seconds): Select the period of time—the default is 4 seconds—for which PReS Workflow is to wait when it finishes dispatching jobs to the LPR printer queues before polling the LPR output folder again. PrintShop Web Connect Service preferences PrintShop Web Connect service preferences control the credentials to log into the PrintShop Web server. The available preferences are as follows: l l User name: Enter the user name of a valid PrintShop Web user, mostly operators.
mode, text you enter overwrites existing text. You can also press INSERT to toggle between the two modes. l l l l l l l l l Use tab character: Select to use the tab character instead of spaces to represent tabs in the program file. Clear to use spaces to represent tabs. You must clear the Smart tab option to use this option. Smart tab: Select to use smart tabs. A smart tab advances with reference to the preceding line.
l l l l l l l l l Persistent blocks: Select to have any text you enter immediately after selecting a block of code appended to that block of code as part of the selection. When you select this option, you can also use the arrow keys to move within the code without affecting the selected code. You must select the Enable selection option to use the Persistent blocks option. Overwrite blocks: Select to have any text you enter immediately after selecting a block of code replace that block of code.
order. Tab stops are measured in number of space characters. For example, a value of 20 places the tab stop at the 20th space character. You can also use the dropdown list to select a previously entered value. l Display l Display Options Group l l l l l Editor font: Use to select the font the Editor uses to display the program code. Select the Use monospace fonts only option to restrict the fonts available to fixed width fonts.
l l l Line numbers on page: Select to display code line numbers at the left edge of the Code area. If you clear both this and the Line numbers on gutter option, no line numbers appear alongside the lines of code. Line numbers on gutter: Select to display code line numbers in the gutter between the Commands and Code areas. Selecting this option has effect only if you selected the Gutter option.
The Process area The Process area, which is always available and visible, holds all the tasks, branches, conditions and comments that make up the selected process (see "About processes and subprocesses" on page 107 and "About Tasks" on page 197). The Process area is built like an invisible grid divided by rows (horizontal) and columns (vertical). When adding a new Action task, a new row is added. When adding a Branch or Condition, a new column appears (unless there is already a column at that level).
Zoom in or out within Process Area You can do a zoom out in the PReS Workflow 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 PReS Workflow Process Area: 1. Click on the View tab of the Ribbon. 2. Click on Zoom Out in the Navigate group to zoom out, and Zoom In to zoom in.
condition over a task will insert it before the task instead. The contrary is also true, you cannot replace a branch or condition with a task. Warning When you replace a task, you lose all the properties you set in this task. Removing tasks or branches To remove any task or branch (except Input and Output tasks), use one of the following methods: l l l Click on the task or branch you want to delete, go to the Home tab of PReS Workflow Ribbon and click on the Delete button in the Clipboard group.
Task Properties dialog Any task you add to your PReS Workflow process must be configured using its Properties dialog. It appears as soon as you add a task to a process, or when you double-click on a task. Each task's Properties dialog will give you the options to configure that specific, individual task. Properties of one task do not directly affect the properties of another task, however there are some software preferences that may affect tasks in one way or another (see "Preferences" on page 635).
1. In PReS Workflow Process area, select the task or branch you want to cut and paste. 2. From the Home tab in the Ribbon, choose Cut (or right-click and select Cut from the drop-down menu). When you cut a Task or Branch, it disappears from the Process Area but is kept in your clipboard until it is pasted somewhere else. 3. To paste the task or branch to a different process, select that process. 4. Select the task or branch crossing above which you want the task or branch to be pasted. 5.
3. From the Home tab in the Ribbon, choose Paste Properties (or right-click and select Paste Properties from the drop-down menu). Note You can only paste the properties of an Input task on the initial Input task of your process. Similarly you can only paste the properties of an Output task on another Output task. Also, you cannot paste the properties of a task on a branch and vice versa.
Moving a task or branch using drag-and-drop To move a task or branch using drag and drop: 1. In the PReS Workflow Process area, click the icon of the task or branch you want to move. 2. While holding down the mouse button, drag the icon task or branch over another task or branch. 3. Release the mouse button to drop the dragged item. The dropped task or branch is moved above the item over which it was dropped. When you move a branch, all its tasks are also moved.
To disable or enable a task or branch: 1. In the PReS Workflow Process area, click the icon of a task or branch. 2. From the Debug tab in the Ribbon, click Ignore. If the task or branch was enabled, it is now disabled, and vice versa. Resize rows and columns of the Process Area The rows and columns of PReS Workflow Process area in which tasks are located can be resized to better visualize the organization of your process. To resize rows and columns of the PReS Workflow Tools Process area: 1.
Variable file name The variable file name feature is used to dynamically determine which file is used with the task. The file name can be constructed using any variable (see "Variable task properties" on page 522). To insert a variable file name: 1. Click on the %o entry in the document list 2. Right-click to insert variables using the contextual menu, or type the variables. 3. Click OK on the dialog.
l From the Quick Access Toolbar, choose Undo. Redo a command The Redo command can be used to redo commands that were just undone using the Undo command. For example, if you used the Undo command three times in a row and immediately thereafter decided to redo those commands, you could use the Redo command three times in a row to redo those commands. Note that all commands in PReS Workflow Configuration can be redone. To redo a command: l From the Quick Access Toolbar, choose Redo.
To move the Quick Access Toolbar below or above the Ribbon: 1. Right-click on the Quick Access Toolbar, or click on the downwards arrow at the rightmost end of the Quick Access Toolbar. 2. Click on Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon, depending on where you want it. Note The Quick Access Toolbar buttons cannot be moved or re-ordered. If you wish to reorder them, you will need to remove all the buttons and re-add them in the desired order.
l l l l The Documents group contains the controls used to insert, refresh, update or delete PlanetPress Design documents and document instances (see "PlanetPress Design documents" on page 38). The Printer Queues group contains controls to set up printer queues of any type, as well as replace any existing queues (see "PReS Workflow printer queues" on page 94). The View tab includes the Arrange, Navigate and Show/Hide groups.
l The Tools tab includes the Managers, Services and Test Page groups. l The Managers group: l l l l l l l l The Access Manager control loads the Access Manager, allowing to grant/remove permissions to hosts. The Check for updates control, used to update the current PReS Workflow version. The Launch Upgrade Wizard control, used when migrating from a previous PReS Workflow version. The Services Status control allows to start, pause and stop PReS Workflow service.
l The Help tab includes the Help, Activation and License groups. l l l The Help group contains the User Guide, the Reference Guide and the About controls, used to access online documentation and version information. The Activation group contains the Software Activation and Printer Activation controls, used to enter activation codes for either the software (all users) or a given device (PlanetPress Suite users) The License group contains a link to the "PlanetPress Capture License Management" on page 651.
Additional Information You can find additional information that complements the user manual about PReS Workflow in the Workflow knowledge base and the Connect knowledge base.
Copyright Information Copyright © 1994-2019 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.
Legal Notices and Acknowledgments PReS Workflow, Copyright © 2018, Objectif Lune Incorporated. All rights reserved. The license agreements for the associated open source third party components can be found in the following installation folder: C:\Program Files\Objectif Lune\OL Connect\Legal Notices This application uses the following third party components: l l l l l l Adobe PDF Library which is either a registered trademark or trademark of Adobe Systems Incorporated in the United States and\or other
l l l l l l l l l l l l Jacob Java Com Bridge which is licensed under the terms of the GNU Lesser General Public License Version 2. The source code for this can be obtained from the following location: http://sourceforge.net/projects/jacob-project/files/jacob-project/ JavaCraft JSch Copyright © 2002 - 2012 Atsuhiko Yamanaka, JCraft Inc. All rights reserved. JavaSysMon Copyright © 2009 ThoughtWorks, Inc. All rights reserved.
l l l l l l l l l l l Mimepull which is distributed under the terms of the Common Development and Distribution License (CDDL) Version 1.1. The source code for this can be obtained from the following location: https://maven.java.net/content/repositories/releases/org/jvnet/mimepull/mimepull/ Objectweb ASM, Copyright © 2000-2011 INRIA, France Telecom. All rights reserved. Relique CSV Driver which is licensed under the terms of the Lesser General Public License Version 2.1.
l l zziplib which is licensed under the terms of the Mozilla License Version 1.1. The source code for this can be obtained from the following location: http://sourceforge.net/projects/zziplib/files/zziplib13/ 7-Zip SFX which is licensed under the terms of the GNU Lesser General Public License Version 2.1. The source code for this can be obtained from the following location: https://github.
l Apache Commons VFS l Apache Derby l Apache Felix and dependencies l Apache Geronimo l Apache Jakarta HttpClient l Apache Log4j l Apache Neethi l Apache OpenCMIS l Apache POI l Apache ServiceMix l Apache Tomcat l Apache WSS4J l Apache Xalan l Apache Xerces2 Java Parser l Apache XMLGraphics l Apache XML-RPC l Barcode4j l Google Collections l Google GSON l Hibernate Validator l Jetty l LMAX Disruptor l Objenesis l OpenCSV l OPS4J Pax Web l org.json.
Eclipse Technology: This Software includes unmodified Eclipse redistributables, which are available at www.eclipse.org. The Eclipse redistributables are distributed under the terms of the Eclipse Public License - v 1.0 that can be found at https://www.eclipse.org/legal/epl-v10.html. VSS Java FreeMarker: This product includes software developed by the Visigoth Software Society (http://www.visigoths.org/).
Further Components: l l l This product includes software developed by the JDOM Project (http://www.jdom.org/). Portions of this software are copyright © 2010 The FreeType Project (www.freetype.org). All rights reserved. This product includes software developed by JSON.org (http://www.json.org/java/index.html).
