-
User Guide Version: 2018.
-
-
User Guide Version 2018.2 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.
-
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 Working with Metadata Working with JSON 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 Creating
-
Triggers Objectif Lune Printer Driver (PS) About processes and subprocesses Processes Startup processes Subprocesses Creating a 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 Run Script task APIs The Script Editor and XSLT Editor SOAP Server API Reference The Watch Object Data Repository API Stopping execution Special wo
-
PlanetPress Capture Metadata Tasks OL Connect Send OL Connect tasks Output Tasks Unknown tasks About variables Job Info variables Standard variables Local variables Global variables Variable task properties Special workflow types 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 user
-
Moving and copying configuration components Renaming objects in the Configuration Components Pane Reordering objects in the Configuration Components pane Grouping Configuration Components Expanding and collapsing categories and groups in the Configuration Components pane Deleting something from the Configuration Components pane Dialogs Access Manager Activate a printer Advanced SQL Statement Dialog Data Repository Manager The Data Selector The File Viewer Data Selector display preferences PDF Viewer Process
-
Sample Data behavior preferences Network behavior preferences PlanetPress Capture preferences OL Connect preferences PDF text extraction tolerance factors General and logging preferences Messenger plugin preferences HTTP Server Input plugin preferences 1 HTTP Server Input plugin preferences 2 LPD Input plugin preferences NodeJS Server Input plugin preferences 1 NodeJS Server Input plugin preferences 2 NodeJS Server Input plugin preferences 3 Serial Input plugin preferences Telnet Input plugin preferences PR
-
The Task Comments Pane Additional Information 755 756 Copyright Information 757 Legal Notices and Acknowledgments 758 Page 10
-
Welcome to PReS Workflow 2018.2 This PDF documentation covers version 2018.2. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. 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 facing page l "Setting up the working environment" on page 17 l "Known Issues" on page 20 System Requirements These are the system requirements for PReS Workflow 2018.2.
-
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 689).
-
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: . The icon reminds you that the logon information is different for the PReS Workflow services, and that some network resources may not be accessibly by PReS Workflow when running a live configuration.
-
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.
-
Installing these updates may cause the application to fail when attempting to open or load XLS files via a plugin or in a script. The following error message may appear: “Unexpected error from external database driver (1). (Microsoft JET Database Engine)". Suggested resolution Uninstall the Microsoft patches and wait for the issue to be fixed in a subsequent Microsoft patch.
-
documented issue in those two Operating Systems. Microsoft has provided no reason nor workaround for the problem, therefore PReS Workflow cannot circumvent the issue. l l l l l l l l l Under Windows 2000, the SharePoint output task does not work with SharePoint 2010. Under the same OS, the PlanetPress Capture ICR does not work due to the .NET 3.5 requirement. 21465: The SharePoint Output task does not validate the field contents. That's Sharepoint's responsibility.
-
Version 8. To circumvent the issue, open the output task's properties, make sure you reselect the proper printer, close the task and send the configuration again. l l The HTTP/SOAP service may fail when both it and the Workflow service are logged on using 2 non-local users or 2 local users with different privileges. To resolve the issue, make sure both services use the same logon credentials.
-
configuration to the service. Make sure you send the configuration before exiting from the Configuration tool. l l l 13009: With Outlook 2010, the Send Email functionality requires that the service be run with administrative credentials in the domain. In addition, both Outlook and the PReS Workflow Configuration tool must *not* be running while the service is. The Microsoft Office 2010/2013/2016 and 365 line of products has not been certified for use with PReS Workflow.
-
PReS Fax can associate a different fax number with each page it sends via the faxing software. For this to happen, two things are required: each record must have a fax number specified in the job file and that fax number must be tagged as such in PlanetPress Design (in the PlanetPress Design User Guide, refer to the section documenting Data Selections, which includes explanations on the available PReS Fax options).
-
Note The minimum time required to generate a PReS Image document is approximately 10 times longer on Windows 2000 than on Windows XP/2003. Preferences In addition to the job-specific PReS Image properties that 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 734. Note that those options are specific to each PReS Image installation and that they are immediately applied.
-
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 17). 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 35). They become visible in the "Configuration Components pane" on page 638.
-
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 123. 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 39) 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 508, "Create Web Content" on page 526 and "Create Print Content" on page 523. Job Presets: Job Presets can be used in the "Create Job" on page 512 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 502) 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 238).
-
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 666).
-
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 48.
-
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 349). 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 46), Metadata file (see "Metadata" on page 69), or "Data Repository" on page 88.
-
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 663. 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 Left: Exact horizontal position (in inches) that defines the left of the selection region. l Top: Exact vertical position (in inches) that defines the top of the selection region. l Right: Exact horizontal position (in inches) that defines the right of the selection region. 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 Metadata Path (optional): Defines the precise path where the Metadata Field is located. Note Metadata Index/Count values 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. 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'.
-
Here is a breakdown of the syntax: l xmlget(): Always surrounds a data selection. l Value Options: l l l Count: The number of elements on the same level in the same node that have the same name. l Name: The element's name. l Value: The element's value. Case Options: This can be one of three options: l KeepCase: Keeps the current uppercase and lowercase characters as they are. l LowerCase: Converts all characters to their lowercase equivalent.
-
Note Even during debugging, selecting a sample data file with a different format will cause the emulation of a process to change. In order to avoid errors, change the emulation back to the format of the original input file before using the process again. Stabilizing data All emulations, except the database, PDF and XML emulations, let you perform operations on the data to stabilize it. The following options are available in both the "Change Emulation" on page 312 task and "The Data Selector" on page 666.
-
as they appear in the data stream and does not perform any substitution. A printer that does not support binary mode or is not running in binary mode replaces any CR, LF, or CRLF that appears at the end of a line of data with a LF. Note, however, that it replaces a line feed followed by a carriage return (LFCR) with two LFs. Binary mode is the recommended printer mode when you use an ASCII emulation.
-
For more information about emulations in PlanetPress Design see PlanetPress Design User Guide. ASCII emulation ASCII emulation tells the process to treat the input data as a stream of ASCII characters. The data stream is read one character at a time, a line is constructed, and that line is added to the data page buffer. In this emulation, you can define how to handle carriage returns that are not followed by line feeds and how to handle tabs.
-
l l l Number of spaces in the tab: Enter the number of spaces you want the application to use when an isolated carriage return character is found within the data. This number typically corresponds to the maximum column number. If your data is formatted so as to occupy a maximum of 120 characters on each line, enter a value of 120 in this box, so when an isolated CR character is found, the data following the CR character will appear starting from column 121.
-
character (\) as a delimiter, you must precede it with another backslash character (thus you would enter \\). You can also specify an ASCII character using its octal value preceded by a backslash (for example, \041 is the exclamation mark character [!]). l l l Force one record per page: Select to force a single record per data page. If you clear the selection, a record may be split across data pages if necessary.
-
and output in multiple different formats such as CSV. See "Database Query" on page 322. 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. Any changes to the structure of the database may have an impact on automated data querying tasks. You must have the proper ODBC driver installed to use this emulation.
-
Note Line printer emulation is only used when merging line printer data with a PlanetPress Design document. When choosing a line printer sample data file to be merged with a Connect template, select Text emulation (see "Text-based emulation" on the facing page). Line printer emulation options The line printer emulation does not have any options other than the general text-based emulation options (see "Text-based emulation" on the facing page).
-
Text-based emulation Text-based emulations display your data in plain text in the Data Selector and the Data Pane, one line at a time, up to the limit you specify in the emulation properties (by default, 66 lines). This is especially useful for legacy systems (such as AS/400 computers) that send data as text meant for older line printers using pre-printed forms. The emulation options are used to make sure your data is stable.
-
Note for PlanetPress Suite users: You should also consider using the N-Up Object if you want to display multiple data pages; see thePlanetPress Design user guide. l l l Cut on FF character: Select to have a new data page when a form feed character is encountered in the data stream. If you select the Cut on FF character option, there are two conditions that signal the end of a data page: the form feed character and the number of lines set in the Lines per page option.
-
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. When this option is not selected, the XML data will be reloaded into memory every time that a 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.
-
the format of the original input file before using the process again. Choosing a sample data file In order to create your PReS Workflow process, the sample data you are going to use has to correspond precisely to the job files that will be treated by that process, at least in terms of structure. The sample data file should have a relatively small number of records (generally less than a hundred) in order to be processed quickly, while your actual data may be much larger and take more time to process.
-
Tip 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. Choosing a database sample file To choose a database sample file: 1. Open the Data Selector (see "The Data Selector" on page 666). 2. From the Emulation drop-down list, select Database. 3. Next to the Sample data file field, click the Configure Database button. 4. Associate a 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. Three possibilities exist: create a new record set for each record, create a new record set after every x records, or create a new record set when the value of a specific field changes.
-
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.
-
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 322. 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 470). The things that you have to know in order to use the Metadata tasks effectively are set out in another topic: "Working with Metadata" on page 80.
-
When Metadata is produced for a given job, a hierarchical (i.e. tree-like) structure is created, composed of the above elements in the following order: Job > Group(s) > Document(s) > Datapage(s) > Page(s). For example: 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" on page 80.
-
The Metadata related plugins (see "Metadata Tasks" on page 470) can be used in conjunction with OL Connect tasks nonetheless; see "How Metadata affects the output" on page 81. 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.
-
Index/Count attributes are not part of the original Metadata file. They are evaluated dynamically, based on the content of the Metadata. 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.
-
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge used by the PlanetPress Design 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 floatingpoint values 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.
-
Attribute Description Categor y J o b Gro up Docum ent Datap age Pa ge 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 Description Categor y dependent type of the media. g Index J o b 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. Index/C ount IndexInJob Returns the Absolute index of the node within all the nodes under the parent Job.
-
Attribute Description Categor y J o b Gro up 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 SelectedIndexInDo cument Returns the Absolute index of the node within all the selected nodes under the parent Document.
-
Attribute Description Categor y J o b SelectedIndexInJob Returns the Absolute index of the node within all the selected nodes under the parent Job. Index/C ount NumCopies Indicates how many times the job is set to execute, as set when printing using a Windows driver. Index/C ount X 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.
-
Working with Metadata A set of special Workflow plugins allows to edit the Metadata during a Workflow process (see "Metadata" on page 69 and "Metadata Tasks" on page 470). This topic describes what you have to know about Metadata in order to be able to use these plugins effectively. How data and Metadata influence each other When Metadata are created, they are based upon a data file.
-
l l l l "OL Connect tasks" on page 502 can add information, such as record IDs, a record set ID or a print job ID, to the Metadata. They put it under 'User defined information' on the Job, Group or Document level. The "Barcode Scan" on page 306 task can add information to the existing Metadata, and creates it if there is none.
-
Example Here is an example of an issue that occurs when Metadata is not re-created in a Loop. In the following process, the Job file is a PDF that contains several invoices. Some (but not all) of those invoices start with a separator page that you don't want to print. Invoices that don't have a separator page should be printed as-is. The process would look something like this (by default): l l l Step 2 splits the PDF whenever it encounters a new Invoice Number on the Top Right corner of a page.
-
l l l ...and step 5 filters out the first page (which means the Metadata unselects the first Data Page, in effect "hiding" it from the Print Output task). Step 6 prints the PDF to a printer. When printing a PDF file in passthrough mode, the Metadata is inspected to determine which pages should print or not. In this case, Page 1 is unselected in the Metadata, therefore the printer receives the job starting from Page 2, which is exactly what you want.
-
Working with JSON In online processes, it is common to send data to and retrieve data from a server. That data is often exchanged in JSON format. JSON is short for JavaScript Object Notation. It is a way to store information in a structured and easy-to-read format. It is often referred to as "XML without nodes" and it is designed for exchanging data. Refer to the following online resources for more information on JSON and its syntax: l www.json.org l www.w3schools.
-
l l l l The "XML/JSON Conversion" on page 368 task converts an XML job file to JSON or a JSON job file to XML. OL Connect Content Creation tasks ("Create Email Content" on page 508, "Create Print Content" on page 523 and "Create Web Content" on page 526) and the OL Connect "Create Preview PDF" on page 517 task accept JSON data as input. When the OL Connect "Retrieve Items" on page 541 task is set to output Records in JSON, it outputs a JSON Record Data List (see "Types of JSON in Workflow" below).
-
A JSON string with references to local variables and a Job Info variable (see "About variables" on page 566): { "first":"%{first}", "last":"%{last}", "email":"%2" } A JSON string containing a local variable and various Data Repository selections (see "Data Repository lookups" on page 51): { "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":"l
-
"detail": [{"id":"inv123","ExtraData":"hello"}, {"id":"456","ExtraData":"world"}] } JSON Record Data List example A JSON Record Data List describes a list of data fields (as name/value pairs), a data table schema and nested data records (if any) for one or more data records. Below follows an example of such a JSON Record Data List.
-
"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.99", "ItemOrdered": 1 } }] } } ] Values could be retrieved in JavaScript as follows: var foo = record.fields.ID; var bar = record.tables.detail[0].fields.
-
The Data Repository is especially useful in situations where data needs to be kept in between processes. A few examples: An HTTP-based authentication process, once it has validated user credentials, could store session information (unique ID, user name, session starting time) into the repository. All other related processes could then look into the repository to determine if a new request is received from an already authenticated user, if the session has expired, what the user name is, etc.
-
Feature Name Description Equivalent Database Terminology to Repository" on page 347 task. Lookup A method of retrieving one or more KeySets from a group in the data repository. Query 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 347).
-
Tip The Data Repository Manager displays, at the bottom left, the syntax used for accessing a specific value. 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.
-
Debugging is the act of running through your process, either step by step or as a whole, directly from the PReS Workflow Configuration tool, in order to detect and resolve issues with your process. 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.
-
ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and Output tasks will not generate output. The On Error tab can be used to 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.
-
error, the contents of the variables selected in this window will be available to the rest of your process, or as long as they are not overwritten. 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.
-
Note Local variables in the process are not sent to error processes, even if the error process has a variable of the same name. Error handling variables The error handling variables are read only and are filled by the On Error mechanism. They can be accessed anywhere, but they only appear in the contextual menu of a task property field when the current process is an error-handling process (that starts with the Error Bin Input task). See also: "Variable task properties" on page 577.
-
1. In the PReS Workflow Ribbon, click on the Tools tab, then select Service Console in the Services group. The PReS Workflow Service Console opens. 2. Click on the service you want to check, including: l PReS Workflow l LPD Server l Telnet Capture l Serial Capture l HTTP/SOAP Server l LPR Client l FTP Client l PReS Image l PReS Fax l PReS Messenger 3. When any job or file is processed by the selected service, the processing logs will be displayed in the window on the right.
-
3. There are multiple logs displayed here, including: l ppwYYYYMMDD.log - PReS Workflow logs, including the year, month and day of the log (from midnight to midnight). Note The PReS Image and PReS Fax logs are available in different folders. From the Watch folder, go up one level then go in either folders, under which you will find the Log folder for that specific software within the suite. Resubmit backed up input files to a process Each Input task includes an option that lets you back up input files.
-
In the above image, the Folder Capture task is on level 1 and the Text condition is on level 4. Here's how to resubmit backed up input data files. 1. In the PReS Workflow Ribbon, go to the Tools tab then click Resubmit Job in the Services group. The File Resubmission dialog box is displayed. 2. From the Process box, select the process for which you want to resubmit the backed up input files. 3. From the Task index box, select the index level to which you want the data to be sent.
-
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. Knowing what to resubmit When something goes wrong with an output job, a print job for instance, and printouts are lost, you need to know the name of the job in order to resubmit the input.
-
l There must not be any "Unknown tasks" on page 566 in the process. l A sample data file must be selected; see "Choosing a sample data file" on page 65. 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. About the Debug mode When debugging your process, it is important to keep in mind that: l l l The initial Input task is never executed.
-
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.
-
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. Debugging and Emulation changes One of the cases where debugging is most useful is whenever the job file is converted to another type of emulation, or if a new data file of a different emulation is used somewhere in the process.
-
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 l Create a matching Printer Queue in Workflow (see "PReS Workflow printer queues" below). Associate the document with that Printer Queue (see "Associating PlanetPress Design documents and PReS printer queues" on page 113). 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.
-
The properties associated with each queue will differ depending on the queue type. In the case of an FTP Output printer queue, for example, the properties include the IP address of the FTP 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 558 task.
-
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.
-
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. Note that jobs sent to those queues completely bypass the printer driver. 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 569) is used.
-
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 107.) 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 107.
-
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.
-
Assigning documents to a Workflow printer queue To assign PlanetPress Design documents to PReS Workflow printer queues: 1. In the PPS/PSM Documents group of the Configuration Components pane, select either a single document or a group of documents. 2. Drag the selected documents over a PReS Workflow printer queue. The selected document or the group of documents is associated with the printer queue. Each document keeps its default properties.
-
Triggers In PReS Workflow, a trigger is typically a two line piece of PostScript code placed just before the data. Triggers tell the printer to turn on PostScript mode and specify which document should be used in the merging process (PlanetPress Design document+data). Triggers are used in two situations: l l When the server running PReS Workflow sends a PlanetPress Design document along with the data to the printer, it adds a trigger before the document (trigger+document+data).
-
1. Start your PReS Workflow Configuration program. 2. Insert a WinQueue Input plugin. 3. In the WinQueue Input plugin properties, click New. 4. Enter a Name for the printer queue. 5. Click OK. Every new Windows printer queue using the Objectif Lune Printer Driver (PS) is shared by default. Once such a shared queue is created, end-users can install it on their own computer by going through the same steps they would when installing a new remote printer in their Operating System.
-
l Checked if the incoming stream has been produced with the Objectif Lune Printer Driver. l Unchecked if the incoming stream comes from some other PostScript Driver. l Grayed out and unchecked if the incoming stream is not PostScript. 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.
-
These settings are pre-configured and cannot be changed by the user. 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 69).
-
l l l Startup processes run only once before every other process in a given configuration (see "Startup processes" below). Subprocesses can be called by any other process (see "Subprocesses" on the facing page). Error processes can only be used in the On Error tab of a task in your process (see "Creating and using Error processes" on page 94). Self-replicating processes are in fact regular processes that replicate themselves in the background when multiple input files are received simultaneously.
-
Subprocesses Subprocesses are special processes that can be called by any other process. Subprocesses act exactly as subroutines in programming languages, allowing users to reuse existing processes by sharing them to the whole configuration file.
-
Adding a startup process You may create a startup process in two different ways. 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 > Insert Startup Process. In addition, you may convert a regular process into a startup process: l Right-click a regular process and select Startup to convert the process into a startup process.
-
Processes can be deleted, duplicated, renamed, disabled, grouped etc. via the Configuration Components pane. For a list of all operations that can be performed on processes in the Configuration Components pane, please refer to "Configuration Components pane" on page 638. Special workflow types PReS Workflow supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility.
-
4. In the list, select the components you want to import. The PReS Workflow Configuration program lets you open and import any of the following: l l Complete PlanetPress Watch 4 to 6 configurations, as well as PReS Workflow 7 and 8 configurations. Specific processes from Version 6, 7 and 8 configurations, including their local variables. l Specific subprocesses from any PReS Workflow 7 and 8 Tools configurations. l Specific global variables from PReS Workflow 7 and 8 Tools configurations.
-
To activate or deactivate a process: 1. Right-click the process in question in the Configuration Components pane 2. Click Active to disable or enable the process. 3. Send the configuration. Because making a process active or inactive is a change in the configuration, to make the change effective in the PReS Workflow Service, you will have to send the edited configuration to your PReS Workflow Service (see "Sending a configuration" on page 132).
-
l l l l l l l l Startup: Select to make this process a startup process (see: "Startup processes" on page 119). This option is not available for self-replicating processes and error processes. The order in which the Startup processes are arranged in the Configuration Components pane determines, from top to bottom, the order in which the Startup processes are executed when the Workflow Service launches.
-
only on the first week of January. l Select Date to display dates on the grid’s top ruler. l Select any of the other options to display days on the top ruler. l Select All weeks to have the process run every week. l l l l l Select First, Second, Third or Fourth to have the process run on the first, second, third or fourth week. Select Last to have the process run only on the last week. Time division: Select the duration of each daily segment in the time grid.
-
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 Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
-
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 238. You can add a new branch that contains all of the tasks below the point where you insert the branch. To do this, right-click on the first task that you want to include in the branch, and select Branch From Here.... An Unknown task will be created as an output below the branch.
-
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 566). Running a process on desktop Since PReS Workflow configurations are typically meant to run without user interaction, all of their processes are set to run in the background by default.
-
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 123. Sending a Configuration to the local server 1.
-
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. Note 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.
-
Note l l The JavaScript engine is Microsoft’s JScript 5.8, which is the equivalent of JavaScript 1.5 (ECMA-262 3rd edition + ECMA-327 (ES-CP) + JSON). While JavaScript and VBScript are natively available on Windows operating systems, Python and Perl require third-party tools to be functional. For Perl, ActivePerl can be installed. For Python ActivePython (version 2.7.13 ) can be installed.
-
button from the task's Properties dialog. When you do so, the script currently displayed in the dialog box is pasted to the editor’s scripting box. Both editors are visually identical and share almost exactly the same commands. They let you import and export scripts, perform common editing, such as search and replace, and feature syntax highlighting and formatting.
-
4. Click OK. The script is imported, displayed and formatted according to the syntax of the language selected in the editor. If the imported file had the extension of a recognized scripting language (.vbs or .js, for example), the editor language is automatically changed. Exporting a script To export a script: 1. In the editor, choose File > Export. The Save As dialog box appears. 2.
-
l l l l l l l l Whole words only: Select to limit the search to complete words matching the text in the Text to find box. Whole words are defined as strings that have a space or punctuation before and after the word. Regular expressions: Select to treat the regular expressions of the scripting language as text to search. If you clear this option, the regular expressions of the language are not included in the search. Global: Select to search the entire content of the script.
-
1. Choose Search | Replace, or press CTRL+R. The Replace With dialog box appears. The last used strings are displayed in the Text to find and Replace with boxes. 2. Set the replacement settings and options. l l l l l l l l l l Text to find: Enter a new search string or select a previous search from the dropdown list. Replace with: Enter the string that will replace the string displayed in the Text to find box.
-
reaches the beginning of the script or script selection, the search finishes. It does not loop back to the beginning. l l From cursor: Select to start the search from the position of the cursor. Entire scope: Select to search either the entire script, or a script selection. The scope corresponds to a script selection if you make a selection before executing the Find. 3. Do one of the following: l l Click OK to replace the first string encountered.
-
Bookmarks are displayed in the editor’s gutter, so you will not be able to see them unless the gutter is both visible and sufficiently wide. If line numbers are also displayed in the gutter, bookmarks may be harder to see. To control line number and gutter display, see "Editor Options" on page 740. Note Bookmarks are not preserved when you close the editor.
-
While there are multiple possibilities for solutions using a SOAP server implementation, the SOAP Server API Reference is specifically for submitting jobs from a SOAP client. It implements methods that will allow SOAP clients to submit jobs and get information from PReS Workflow executing them. Note PReS Workflow already come with a SOAP Client plugin, which can be used as an input, action or output; this task was renamed Legacy SOAP Client.
-
Return Value SubmitJobResult: Structure containing the following information: l l l l Success: Integer indicating the Success/Error level of the operation. A result of 0 means the operation was successful. Message: String containing text information about the Success/Failure status. SubmitJobInfStruc: Structure containing any required information to prepare the file for a valid insertion into a PReS Workflow process (see "SOAP API - SubmitJobInfStruc" on page 149). ResultFile: base64Binary.
-
SOAP API - PostJob Syntax PostJob (File, PostJobInfStruc , user name, Password) : PostJobResult Description The PostJob method allows users to remotely submit files to PReS Workflow by using the Resubmit from here feature. The main advantage of this feature is that it allows a user to specify a starting task index from which the File is to be processed. Parameters l l File: base64Binary. This is an array of byte base64 encoded (see http://en.wikipedia.org/wiki/Base64).
-
Note The PostJob method can never return a file to the calling application. SOAP API - GetProcessList Syntax GetProcessList (user name, Password) : GetProcessListResult Description The GetProcessList function allows SOAP clients to request the list of available PReS Workflow processes, based on their authentication credentials. Parameters l user name: String containing the user name. l Password: String containing the password. This is case sensitive.
-
SOAP API - GetProcessTaskList Syntax GetProcessTaskList (ProcessName, user name, Password) : GetProcessTaskListResult Description The GetProcessTaskList function will allow a user to remotely request the tasks list of a process. This will be useful with the PostJob API since it needs a TaskIndex. Parameters l ProcessName: The Name of the PReS Workflow process. l user name: String containing the user name. l Password: String containing the password. This is case sensitive.
-
SOAP API - GetSOAPProcessList Syntax GetSOAPProcessList (user name, Password) : GetSOAPProcessListResult Description The GetSOAPProcessList function will allow users to request the list of PReS Workflow processes that contain a SOAP Input plugin with the SOAP action name. This is useful when working with the SubmitJob API since it requires a SOAPActionName. Parameters l user name: String containing the user name. l Password: String containing the password. This is case sensitive.
-
SOAP API - PostJobInfoStruc Structure containing any required information to prepare the file for resubmission into a PReS Workflow process. l VariableList – Array of complex type, containing pairs of variable names and variables value. The list also contains the Job Info variables. l VariableName: String l VariableValue: String l ProcessName: String: name of the PReS Workflow process. l TaskIndex: Integer: 1 based index of the task where the resubmission should start.
-
Note While the functions here are in mixed case to simplify reading, it's important to note that some languages (especially JavaScript) are case-sensitive and will require the proper case. Examples in this chapter will always use the proper case when relevant. Here is a list of the methods and functions that are available to you through the automation object (or "Watch" object).
-
Variable Name Description Example Usage (VBScript) "Watch.GetVariable" on page 159 Retrieves the content of a local or global variable by name. Example Usage: str = Watch.getvariable("Varname") "Watch.ExpandString" on page 160 Retrieves the content of any Workflow string, containing any variable available to Watch, including data selections. Example Usage: watchDate = Watch.expandstring("%y-%m-%d") "Watch.
-
Variable Name Description Example Usage (VBScript) by name. Example Usage: Watch.setvariable "global.GlobalVar", "Hello World!" "Watch.Sleep" on page 163 Pauses all processing for X milliseconds. Example Usage: Watch.sleep(1000) "Watch.ExecuteExternalProgram" on the facing page Calls and executes an external program in the command line. Example Usage: Watch.executeexternalprogram "del *.ps" "c:\" 0 true "Script.
-
VBScript Watch.ShowMessage("test message") JavaScript Watch.ShowMessage("test message"); Python Watch.ShowMessage("test message") Perl $Watch->ShowMessage("test message"); Watch.ExecuteExternalProgram Calls and executes an external program through a specified command line. The program's execution will be directed by the appropriate flags specified as this method's parameters. Syntax Watch.
-
Flag Effect 2 Display the window minimized. 3 Display the window maximized. 4 Makes the window visible and brings it to the top, but does not make it the active window. WaitForTerminate : A Boolean value that, if true, pauses the script until the command line has been fully executed. 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); Pyth
-
Example In the following example, GetJobFileName() retrieves the name of the job file, which is then logged using "Watch.Log" on page 161. VBScript Dim s s = Watch.GetJobFileName Watch.Log "The job filename is: " + s, 3 JavaScript var s; s = Watch.GetJobFilename(); Watch.Log("The job filename is: " + s, 3); Python s = Watch.GetJobFileName() Watch.Log("The job filename is: " + s, 3) Perl $s = $Watch->GetJobFileName; $Watch->Log("The job filename is: " + $s, 3); Watch.
-
Perl $Watch->GetOriginalFileName(); Watch.GetMetadataFilename Returns the complete path and file name of the metadata file associated with the current job file. Example VBScript Watch.GetMetadataFileName JavaScript Watch.GetMetadataFileName(); 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.
-
You must enable the “Run on desktop” option for the PReS Workflow process whose script calls Watch.InputBox. Otherwise PReS Workflow application may stop working and require a reboot. Example s = watch.inputbox("caption", "message", "default") watch.showmessage(s) Examples In the following example,Watch.InputBox requires the user to enter a line of text. The script the displays a pop-up of the message contents using "Watch.ShowMessage" on page 152. VBScript s = Watch.
-
Syntax Watch.GetJobInfo(Index: integer): string Example VBScript Dim s s = Watch.GetJobInfo(3) Watch.Log "Jobinfo 3's value is: " + s, 2 JavaScript var s; s = Watch.GetJobInfo(3); Watch.Log("Jobinfo 3's value is: " + s, 2); Python s = Watch.GetJobInfo(3) Watch.Log("Jobinfo 3's value is: " + s, 2) Perl $s = $Watch->GetJobInfo(3); $Watch->ShowMessage("Jobinfo 3's value is: " . $s, 2); Watch.SetJobInfo Sets the job information index to a specified string value. Syntax Watch.
-
Python Watch.SetJobInfo(3, "Job info 3 Value") Perl $Watch->SetJobInfo(3, "Job info 3 Value"); Watch.GetVariable Returns the string value of the corresponding variable name. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.GetVariable(Name: String): String Example VBScript Dim s s = Watch.GetVariable("MyVariable") Watch.Log "MyVariable's value is: " + s, 2 s = Watch.GetVariable("global.MyVariable") Watch.Log "global.
-
Watch.SetVariable Sets the variable to a specified string value. Note that if an undeclared variable is called using this method, an error will be generated. Syntax Watch.SetVariable Name: String; Value: String Example VBScript Watch.SetVariable "MyVariable", "Desired value" Watch.SetVariable "global.MyVariable", "Desired value"/ JavaScript Watch.SetVariable("MyVariable", "Desired value"); Watch.SetVariable("global.MyVariable", "Desired value"); Python Watch.SetVariable("MyVariable", "Desired value") Watch.
-
Example This example results in expanding the string of the variables to the date value in the following format: “YYYY-MM-DD”. VBScript Dim s s= Watch.ExpandString("%y-%m-%d") Watch.Log "Current Date is: " + s, 2 JavaScript var s; s= Watch.ExpandString("%y-%m-%d"); Watch.Log("Current Date is: " + s, 2); 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.
-
Level Type Text Color in Service Console 3 Information Black 4 Debug Grey Arguments Message—A string representing the message that is logged in the log file. Note that the text of the message must use the locale encoding of the system where the PReS Workflow software will be running, otherwise it will be unreadable. Level—An integer between 1 and 4, specifying the severity level of the error message.
-
Python Watch.Log("this is a log",3) Perl $Watch->Log("this is a log",3); Watch.Sleep Pauses the process for the specified number of milliseconds. This can be used while waiting for something else to happen when the delay is known. Syntax Watch.Sleep Milliseconds: integer Example In the following example, sleep() pauses the process for 1 second (1000 milliseconds) VBScript Watch.Sleep 1000 JavaScript Watch.Sleep(1000); Python Watch.Sleep(1000) Perl $Watch->Sleep(1000); Script.
-
Example This example will always return true, as the condition is static. It is, after all, simply an example. You get the idea. VBScript Dim everythingOK everythingOK = true if (everythingOK = true) then Script.ReturnValue = 1 else Script.ReturnValue = 0 end if JavaScript var everythingOK; everythingOK = true; if(everythingOK){ Script.ReturnValue = 1; } else { Script.ReturnValue = 0 } Python everythingOK = True if everythingOK: Script.ReturnValue = 1 else: Script.
-
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 Data Repository can be accessed at runtime by the Push To Repository plugin and other tasks (see "Data Repository" on page 88) and at design time via the "Data Repository Manager" on page 663. This topic explains how to access the Data Repository in script. For a quick start, turn to this How-to: Interacting with the Data Repository API.
-
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.WorkflowRepository"); VB Script set repoObject = CreateObject("RepositoryLib.WorkflowRepository") In each example in this documentation, the object repoObject is deemed having been obtained through the above call to the COM object.
-
many resources on the Web that propose ways of implementing JSON parsing in VB Script so you can implement whichever you see fit. However, using JavaScript is highly recommended. Repository management methods Name Description CheckRepository Verifies the integrity of the repository and recovers unused space left by deleted keysets. Similar to packing a database, the operation is non-destructive but it does require exclusive access to the Repository.
-
Name Description ListGroups Retrieves the list of all group names in the Repository, stored in a JSONStringArray.. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys. RenameGroup Renames group oldName to newName. While this operation has no impact on the data stored in the specified group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Key Methods Name Description AddKey Adds key KeyName to group GroupName.
-
Name Description Group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Value Methods Name Description 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.
-
Name Description the keyset was not updated. Note that this method is functionally equivalent to using SetValue() with its Condition parameter set to "ID=ID". KeySet methods Name Description AddKeySets Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues must exist otherwise an error is raised. However, it is not required to specify all available keys in KeyValues.
-
AddGroup Creates a group named GroupName and optionally creates keys listed in keyNames. The keyNames parameter may be empty. Syntax AddGroup(GroupName: string, keyNames: JSONStringArray) 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 166). JavaScript repoObject.AddGroup("Users", '["FirstName", "LastName"]'); repoObject.
-
repoObject.AddKey("Users", "email"); VB Script repoObject.AddKey "Users", "email" AddKeySets Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues must exist otherwise an error is raised. However, it is not required to specify all available keys in KeyValues. Only the keys specified are updated in GroupName while unspecified keys are set to an empty string.
-
var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); repoObject.AddKeySets("customers", '[{"CustomerID": "CUJS123456", "FirstName": "John","LastName": "Smith"}, {"CustomerID": "CURD654321", "FirstName": "Richard", "LastName": "Doe"}]'); Tip: to update a row instead of adding it, use the GetValue() function to get the KeySet ID; then update each individual value using SetValueByID() (see "GetValue" on page 176 and "SetValueByID" on page 184).
-
CheckRepository Verifies the integrity of the repository and recovers unused space left by deleted keysets. Similar to packing a database, the operation is non-destructive but it does require exclusive access to the Repository. You should therefore only perform this operation when you know for sure no other process is accessing the Data Repository. Syntax CheckRepository() ClearAllData Delete all keysets in all groups, while retaining the existing key structure.
-
When Condition is left empty, all keysets are retrieved, which is useful for reports, cleanup, or custom filters based on more complex conditions. GetKeySets() converts the results coming from the Repository from UTF8 to Ansi, in order to make results with special characters like 'éèêë?æ' compatible with scripting. To obtain the UTF8 value, without conversion, use GetKeySetsW().
-
By replacing the last option from GetKeySets (the filter on CustomerID) with an asterisk, you can get all the rows from the data repository.
-
LastName='Smith' "); /* retrieves email for first user named Smith */ var myValue = repoObject.GetValue("Users", "email", ""); /* retrieves email for first user */ VB Script myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" AND FirstName=""John"" ") /* retrieves email for John Smith */ myValue = repoObject.GetValue("Users", "email", " LastName=""Smith"" ") /* retrieves email for first user named Smith */ myValue = repoObject.
-
Repository Object" on page 166). JavaScript var repoObject = new ActiveXObject ("RepositoryLib.WorkflowRepository"); var myList = JSON.parse(repoObject.ListGroups()); for (var i=0; i
-
Sample return value '{"ID": "meta", "FirstName": "string", "LastName": "string", "email": "string", "DateC": "meta", "DateM": "meta"}' As shown in the sample, the value associated with each key name is actually the data type for that key. Only two values are currently possible: string and meta, where meta denotes an internally generated key. RemoveGroup Deletes the group named GroupName, along with all its keysets and keys.
-
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 166). JavaScript repoObject.RemoveKey("Users", "email"); VB Script repoObject.RemoveKey "Users", "email" RemoveKeySetByID Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise.
-
/* both methods perform the same task */ repoObject.RemoveKeySetByID "Users", 10 repoObject.RemoveKeySets "Users", "ID=10" RemoveKeySets Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. The method returns the number of keysets that were deleted. When passing 'ID' as the Condition, all keysets in GroupName will be deleted.
-
RenameGroup Renames group oldName to newName. While this operation has no impact on the data stored in the specified group, it does require any plugin and/or script that uses oldName to be modified to refer to newName. Syntax RenameGroup(oldName, newName: 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 166). JavaScript repoObject.
-
VB Script repoObject.RenameGroup "Users", "LastName", "SurName" 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.
-
SetValueByID Updates KeyName with Value in group GroupName, where the KeySet's ID matches the ID parameter. KeyName must exist in GroupName, otherwise an error is raised. The method returns the ID of the keyset that was updated or -1 if the keyset was not updated. The KeySet ID can be retrieved with GetValue() ("GetValue" on page 176).
-
("RepositoryLib.WorkflowRepository"); var keySetID = repoObject.GetValue("customers", "ID", "CustomerID='CURD654321'"); /* Update Values */ repoObject.SetValueByID("customers", "FormOfAddress", "Mr.", keySetID); repoObject.SetValueByID("customers", "Country", "US", keySetID); repoObject.SetValueByID("customers", "Language", "EN", keySetID); Version Returns the version of the DLL library used by the Repository.
-
JavaScript JavaScript uses the throw statement within try to create an exception which, if not caught using catch() , will cause the script execution to stop and the On Error tab to be triggered. See the JavaScript errors page on W3Schools. var s; s = Watch.GetJobInfo(9); if (s == "") { throw "Value Cannot be empty"; } else { // Do something with Job Info 9! Watch.
-
Special workflow types PReS Workflow supports multiple input and output types, in so many different combinations that it would be hard to give example processes for each possibility. However, some types of processes like PDF and HTTP processes, and processes related to another product, are important enough to pay some attention to them. This chapter will describe each of these special workflow types and give at least one example of an implementation that uses them.
-
SOAP Workflow As SOAP can be either a client or a server, two workflows will be presented. The SOAP Client workflow presents PReS Workflow as the client and will explore how to retrieve WSDL information and how to make a SOAP request as a client. The SOAP Server workflow will show how to create a process that responds to SOAP requests, and where our own WSDL is located.
-
Manager. Important Configuration, Setup and Options Before starting to work with HTTP workflows, there are a few key points to keep in mind in terms of configuration. First of all, the following options are available in PReS Workflow Preference screen, under the HTTP Server Input 1 and HTTP Server Input 2 sections: l l l l Port (default value: 8080 recommended): The port number is the one in which a browser needs to make a request to PReS Workflow.
-
Note As of PReS Workflow 8.1, it is possible to serve a default HTML file when no action is specified, for example http://localhost:8080/ . This is done by creating an index.html file in the Resource Folder defined above. However, resources called by this index.html must still use the Resource action name, for example a stylesheet would still point to http://127.0.0.1:8080/static/css/style.css or more simply static/css/style.css.
-
fields named, respectively, id and q, and submitting them with the information "12345" and "test". In both cases, this information is located in the XML envelope that is the original input file. l l l When doing POST requests and uploading files, always make sure to include the "multipart" option in the
-
Point 7 is critical to understand, as it has an impact on what the client receives. If a process receives a file that is split into multiple parts and each of these parts generates and output, the last split's output will be sent to the client. If the last output task generates a PostScript file for printing, this PostScript is returned to the client. In most cases, what is returned is what remains after the last task, but only if this task's processing is done in PReS Workflow.
-
l ?in=INV999999 : A GET Variable, specifying that the variable named invoicenum (invoice number) would have a value of INV999999 , or any other "valid" invoice number. 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.
-
deleting the data file only means you are not doing anything with it locally - it is still returned to the client. l If, however, the file is found, then it is loaded with the "Load External File" on page 342 task, and then deleted (for the same reasons).
-
l l l l l If this is the initial request, an HTML page is created which contains a form asking the client for a required full name and email, and optional company name. A checkmark also offers to subscribe to a newsletter (it is unchecked by default!). The form submits back to the same URL, meaning it is handled by the same process. The file is renamed with the .html extension, so that both the HTTP service and the browser will recognize it as an HTML page.
-
Note In Connect it is also possible to group, sort and split PDF data using "OL Connect tasks" on page 502. 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 483 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 416 then uses the Rep ID field to retrieve each sales representative's email from a specific Excel spreadsheet. The "Metadata Sequencer" on page 481 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 479 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 473 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 595. 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 263 task or "Folder Capture" on page 253 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 468 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.
-
Anoto Pattern A series of dots placed in a pattern that is unique to each page where the pattern is printed. The Anoto Digital Pen identifies this pattern and its location on the page. PlanetPress Capture contains 20,000 patterns (8 in demo mode, See "PlanetPress Capture License Management" on page 713) which can be used to generate documents. Capture Condition PReS Workflow task that is used for post-processing of documents after they have been processed by the Capture Fields Processor.
-
the database until it is retrieved with the Get Capture Document task, after which it is deleted. Contamination The act of writing on a "wrong" document, aka one that has a Pattern Sequence different that the one for which it was produced.. This can happen in architectures with more than one 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.
-
Pen ID The serial number of the Anoto Digital Pen. It is registered in the PlanetPress Capture database and is present in each PGC file. PGC File Pen Generated Coordinates; PGC File containing all ink processed while the pen was undocked along with the Pen ID. 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.
-
with Capture Fields, you must review and understand the Critical PlanetPress Capture Implementation Restrictions. Database considerations (ODBC) Note 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\od
-
l l Total size of a single table is 2GB. l May be unstable in large implementations. MySQL l l l l l Database can be in any location, but performance will depend on the speed of the connection between PReS and the MySQL server. 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.
-
l In SQL Server, if one of your requests is dropped because of simultaneous accesses, resubmitting the PGC should resolve the issue. Security Considerations PlanetPress Capture introduces new and efficient methods for digitally capturing the contents of ink laded out on physical paper. However, because of its nature, some end users may voice concerns about security and privacy.
-
l l l l The transfer between the Anoto penDirector and PReS Workflow is not encrypted due to a limitation of penDirector which does not support SSL connections. This means someone located anywhere between penDirector and PReS Workflow could use software such as a packet sniffer to retrieve its parts and recreate the PGC files. This may be resolvable by create a secure VPN tunnel for each location where penDirector is installed instead of going through regular remote HTTP server.
-
mode (no license activated), and react the same way that the bulk of the 20,000 patterns. Another single pattern is used to register pens in the database, and one last single pattern is used when printing a "Preview" from PlanetPress Design. So in reality, the number of available patterns for document generation is 19990, but for simplicity's sake this FAQ uses the round number "20,000".
-
like this one would be perfectly functional and not be affected by the 20,000 page limit. Remember however that this means that 19,000 physical sheets of paper are printed every day, and those 19,000 documents are written on using one or more Anoto Digital Pens, which are then processed back into the system. The example above actually uses numbers that are much higher than our typical PlanetPress Capture user.
-
each cases, using a typical situation of a shipping company that uses PlanetPress Capture to simplify the archiving of the client's signature on a "Confirmation of Reception" slip. l Pen-Based Sequences: In this case, each pen is attributed a specific pattern sequence. When documents are printed, they are set to attribute a pattern sequence to each document in relation to which pen it will be signed on.
-
PlanetPress Capture in version 7.4. Contamination The single but critical danger with any implementation that deals with PlanetPress Capture is "Contamination". Basically, contamination happens when an Anoto Digital Pen writes on a "wrong" document or is docked in the wrong location. This can happen any number of ways and in different situations, and can have devastating effects in some of those cases so please pay special attention to this section.
-
pens inadvertently (we hope, anyways), the pens would be signing the "wrong" documents all day and, when docked, would update the wrong documents in the database. In all of these cases, the errors often do not appear when the wrong document is updated - it actually occurs when the "right" data is processed.
-
Anoto penDirector The Anoto penDirector is a software driver provided as a download by Objectif Lune Inc. The penDirector creates a bridge between the Anoto Digital Pen and a PlanetPress Capture workflow in PReS Workflow. In order to use penDirector, it needs to be downloaded from the Objectif Lune website, on this page. This software must be installed after PReS Workflow. The setup will install a preconfigured version of penDirector which can be immediately used with PlanetPress Capture.
-
3. Undock the pen, or remove its protective cap if it is not docked. Make sure the power light on the pen is turned on and green in color. 4. Go in the Bluetooth tab of penDirector and click on Add Pen. 5. Click on Search while the cap is off on the pen. 6. When the pen is found, click on it and then click Add. 7. When asked for the PIN, enter the one noted above. 8. Click OK to save the settings. The settings for Bluetooth PGC handling are separate from the ones used when docking.
-
PlanetPress Capture Implementation Restrictions This document describes the limitations of the Anoto Digital Pen & Paper Technology, especially in regards to using it within a PReS Workflow implementation. Note that these limitations apply to any Anoto technology implementation and not just our own. Printer limitations Any document printed with Capture Fields (aka Anoto Patterns) must be sent through a Laser printer.
-
Paper quality The PlanetPress Capture technology, when generating the Anoto Pattern, already accounts for ink dispersion on laser printers and on general-use laser paper. Therefore, using paper that is not of the same quality (for example, one where the dispersion rate is much higher) or the same type (reflective paper) may not permit the pen's camera to read the pattern properly.
-
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.
-
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. Multiple cultural characters can be interpreted with ICR once the correct language is selected such as û, à, é, etc. How: This option is available from the Capture Fields Processor task.
-
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.
-
l Any input task l "Create Metadata" on page 470 l "Capture Fields Generator" on page 452 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 466 l Archive or Print output Capture Post Processing Workflow Though the "Basic Functional Capture Workflow" on page 228 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 487) 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.
-
Workflow. This is what the OL Connect Send Get Job Data plugin is made for. (See "Get Job Data" on page 493.) l l The Create Web Content plugin. Each web page served by an interaction process is generated by this plugin. (See Create Web Content.) 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.
-
l l Action Task: Will manipulate the data in any number of ways. An action task is any task that is not an input or output task or a branch or condition. Output Task: Will output data to a specific location or send to a different service or computer. Some tasks are multipurpose and can be used as either an input, action or output task or any combination. These multipurpose tasks are indicated as such in the task description and can be found in the most relevant section of the available tasks.
-
Adding tasks You can add as many tasks as you want to your process by using the Plug-in Bar in PReS Workflow program. To insert a task: 1. Open the Plug-in Bar by clicking on its tab. If you can't see the Plug-in Bar tab, click on the View tab in the Ribbon and make sure the Plug-in Bar is highlighted in the Show/Hide section. 2. Locate the task you want to add to your process. You can navigate between the different task categories by clicking the icons at the bottom of the Plug-in Bar. 3.
-
1. In the PReS Workflow Process area, double-click the Task icon. A dialog box containing the available task properties is displayed. 2. Edit the task properties as required. Click specific tabs to see all the properties associated with the task. 3. Click OK to close the dialog box and save the new properties. 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 744.
-
Some Action, Create Content and Output tasks let you select a resource file to use with the task; for more information see "Selecting a resource file in task properties" on page 243. 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.
-
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. The lower part of the contextual menu is divided into 4 items that provide variable properties: l Variables l System: Contains system variables, also called "Standard variables" on page 569.
-
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. Field indicates a data selection for a database emulation — field(1,0,0,'Billing_ Email',KeepCase,NoTrim), for example.
-
Mask Format Here are the different mask formats available. l l Literal characters: Any alphanumerical character is considered a literal character and must appear. For example, a mask of "trigger.txt" will not capture any other files than that name. Wildcards: Two wildcards are available in masks. l l l Asterisk (*): Supports any number of characters. *.txt would pick up any text file, file*.txt would pick up any file starting with file and any characters: file1.txt, filetest.txt.
-
("Connect resources" on page 35), all PlanetPress Design documents ("PlanetPress Design documents" on page 39) or only to the PlanetPress Design documents installed on a printer queue. In most cases, you have three options: l l l You can choose a specific file from the list of installed documents (see "Workflow Configuration resource files" on page 35); these will be either Connect resources, or PlanetPress Design documents, depending on the task. You can choose a variable file (see below).
-
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 Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the file name 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 Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the file name 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 Info variables 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 92. 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.
-
option is ticked. The percent sign, the curly brackets and the period are all key 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).
-
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 Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the file name 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 92. 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 240).
-
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 92. 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.
-
Note Athough Workflow can serve both static and dynamic resources to a web browser, it is not meant to be used as a fully featured web server as it is not built for responsiveness nor guaranteed uptime. It is recommended to use a common web server (for example, IIS or Apache) to serve your contents 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.
-
Note By default, the request XML also contains a CDATA section which contains the raw input data, 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.
-
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 Info variables 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 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. 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.
-
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 91. "Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables 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 263 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 Info variables 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 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 196. 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" on page 242. 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 470. "Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables 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.
-
NodeJS Server Input NodeJS Server Input tasks are used to receive HTTP requests and to send replies to the servers from which the requests were made. Essentially this task does the same as the HTTP Server Input task, but it uses a NodeJS Server (installed by Workflow) instead of Workflow's custom server component. The NodeJS Server is more secure, more up to date and more standardized.
-
watch the Connect with Evie - IIS series. Note While you can insert the NodeJS Server Input task anywhere in your process as a secondary input task, in reality the NodeJS Server Input task will only function when used as the initial input, as it is triggered when Workflow's NodeJS Server receives a request and passes it on to the correct task.
-
Note Currently the NodeJS Server Input task only supports basic content-types: l multipart/form-data l application/x-www-urlencoded l application/octet-stream Any raw body content-type (application/json, application/xml, text/html or any other not mentioned above) might not behave as expected and will be supported in the next version. Processing Depending on the options chosen in the NodeJS Server Input task properties, the task may choose to ignore some of the files.
-
If the Send Immediate Response to client option is selected, the response file is sent back right away and the involvement of the input task ends then. However, if this option is not checked, it means there is a second output that comes out of the NodeJS Server Input task: the last output generated by PReS Workflow is sent back to the initial input, by which it is returned to the client.
-
l l l Respond on error: Enter a message to be sent to the client as the output file if the process encounters an error and is unable to send a reply that includes the actual output file. The information can be in any desired format such as HTML or plain text, but most browsers will interpret it as plain text. Note that this is a variable property box. You can use any combination of text, variables and data selections; see "Variable task properties" on page 240.
-
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 Workflow Tools working folders under the "Backup" folder. Backup filename: Enter the file name that you wish the input data file backup to be saved under. Delete Existing Metadata: Check to remove any Metadata from memory. This option is disabled on initial input tasks, and is checked by default on secondary input tasks.
-
Note PrintShop Mail Web and PReS Workflow must be installed on the same server in order to make the PrintShop Web Connect Input task available in your PReS Workflow. Input This task does not poll an input, it sits there and waits for a job file to be sent by the local PrintShop Mail Web installation. Processing When the job is received from PrintShop Mail Web, it is saved as a job file. No further processing is done on the file.
-
General Tab l l All documents: Lists, in a hierarchical view (Company -> Publication Types -> Documents), the PrintShop Mail documents already existing on the PrintShop Web server. Refresh: Click to update the list of PrintShop Mail documents available on the PrintShop Web server. "Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables are automatically created by the input task.
-
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 729). 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 file name 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 Info variables 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 file name 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 730). 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 file name 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 92. 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 Info variables 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 343 l "Open XSLT" on page 345 l "Push to Repository" on page 347 l "Rename" on page 349 l "Run Script" on page 397 l "Search and Replace" on page 353 l "Send Images to Printer" on page 354 l "Send to Folder" on page 356 l "Set Job Infos and Variables" on page 358 l "SOAP Client plugin" on page 553 l "Standard Filter" on page 362 l "Translator" on page 363 l "Windows Print Converter" on page 365 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 39).
-
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 92. 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 195 and "Working with Metadata" on page 80).
-
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 430). 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 354), 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 92. 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 163 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 740. 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 303.
-
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 17 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 92. 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 92.
-
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 92. 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 382). 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 92. 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 46).
-
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 92. 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 92.
-
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 567).
-
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 135. 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 92. 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 92. 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" on page 426 l "PReS Fax" on page 429 l "PReS Image" on page 430 l "PReS Print Controls" on page 440 l "PrintShop Mail" on page 443 l "ZUGFeRD plugin" on page 613 Create MRDX The Create MRDX Action task is used to register a job on a SureTrac server using an MRDX file. The MRDX contains information about the job and its finishing, as well as integrity features use by SureTrac.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 92. 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 The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document. 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 Microsoft SharePoint 2007 l Microsoft SharePoint 2010 l Windows SharePoint Services 3.0 SP2 l SharePoint Foundation 2010 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.
-
l l l l l l l SharePoint Site: The name of the SharePoint site from where you want to retrieve documents. You can click on the Refresh button to display a list of sites on your SharePoint server. Document Library: The document library where you want to retrieve the files. You can click on the Refresh button to display a list of libraries on the SharePoint site selected previously. Folder: The folder in the document library where your files are located.
-
"Other" Tab l Job Information group l l l l l Information elements: indicates what Job Info variables 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 Workflow Tools working folders under the "Backup" folder.
-
and will not work with previous versions. It also requires a valid PReS license. About Laserfiche Laserfiche is a provider of digital document and record management systems. Laserfiche has two components: the Laserfiche server, which hosts the repository, and the Laserfiche client, which serves as the user’s interface with the repository. For more information see the Laserfiche website: https://www.laserfiche.com/.
-
Laserfiche Image Viewer. l l l l l l Electronic files: All files will be stored in their original format in Laserfiche. When double-clicking on the document in Laserfiche the native Windows application associated with the file extension of the archive will be opened. Force folder creation: Select to force the folder creation if it does not already exist on the Laserfiche server. Volume: A list allowing to choose among available Laserfiche volumes.
-
Restrictions l l Each Laserfiche Repository Output task uses a connection to Laserfiche. You can use as many Laserfiche Repository Output tasks at the same time as your Laserfiche license allows. If you see the error message ‘The session number was exceeded’ in the PReS Workflow Service Console, it means you have exceeded your allowed number of connections.
-
task, otherwise it will run as many times as there are Metadata sequences, which will result in decreased performance. Use cases Here are some examples of how the Lookup in Microsoft® Excel® Documents task could be used in combination with PlanetPress Design documents. 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.
-
Output The original data file is unchanged. Metadata is updated according to the specified criteria. 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: Ads a new lookup line. You can have as many lines as you want. The lines will be executed in order from top to bottom, so you can rely on a previous line to bring additional information. l button: Removes the currently selected (highlighted) line. l button: Moves the currently selected line up one place. l button: Moves the currently selected line down one place.
-
l l l l l While debugging this task, the printer shows the message that the document can not be printed. This message is normal and will not appear when running a live configuration. The task uses a printer queue set with the “PReS Word to PDF Printer” driver, which is created and set by default on-the-fly the first time a Microsoft® Word® Documents to PDF Conversion action task is run.
-
PDF page generated by the document. When Mail Merge is not selected, this is the only available choice. 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.
-
l l Test connection: Checks if the Connection String and SQL Statement are valid, and if the resulting recordset is understood by the Microsoft® Word® document. This is optional, though highly recommended. 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.
-
Input This task ignores the input data file and any Metadata unless data selections are used in the variable data fields. 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).
-
out, and PDF for documents users can read. l 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 Cover Image: Enter the path to a cover image that is shown in the repository and library list, as well as the document property. The maximum image size is 512x512 px and it is required to be in JPG or PNG format.
-
OnTheGo Server. If this option is not selected, and if some of the listed categories are not present on the Capture OnTheGo Server, the process will go through and the listed categories will be added to the Server. 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.
-
document will not be removed from the repository based on this setting. Note that the date you enter will automatically be reflected in the For box above. l l Document Tracking: l l l Time zone: When you enter a number of days in the For box or a date in the Until box above, the computer’s time zone appears in this box. You may select a different time zone if required. Track documents sent: Check this option to track documents sent to the Capture OnTheGo Server.
-
Processing The task connects to the selected Document store and uploads the current data file. If the file already exists, it will be overwritten and, if this option is selected, marked as "checked in". The information accompanying the file (the SharePoint Metadata) is either updated or created. Output The output of this task is the original data file. Task properties General Tab l l l SharePoint Site: The name of the SharePoint site where you want to send the files.
-
l l Use PDF/A: Check to use the information contained within an PDF. This PDF must have been created with PReS Image and contain an Index field (data selection) of which the name corresponds exactly to the Field Name in the SharePoint Document Library. If this option is checked, the Field Information will change to "Use PReS Index (PDF/A)". Field Type: The type of field as set in the SharePoint Document Library.
-
and write to document libraries. l Password: The correct password for the user name. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 92. 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.
-
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. Refresh: Click to update the list of IP addresses displayed in the Host drop-down list box.
-
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 734). Note that those options are specific to each PReS Image installation and that they are immediately applied. The following describes the properties specific to PReS Image Output tasks.
-
output. l l If the data file and a document are selected, and Optimized PostScript Stream mode is used, the data file is merged with the document and the resulting OPS job is sent to the PReS Image host to produce output. If the data file is a postscript file and either mode is used, the postscript file is sent to the PReS Image host which generates output (since this is already Optimized PostScript, it is not regenerated).
-
l l l Add job information to the document: Select to add the available job info variables in the “header” of the generated output file. Output type: Select the output file type that you want. l l l 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. PDF: The output will be a PDF file.
-
TIFF G4, monochrome (1 bpp) is the only Color depth option you can select. This property is enabled for all output types except PDF. l l l l l l l l Multi-page: Select to generate a single file containing multiple pages. When this option is not selected, PReS Image creates a file for each page included in the output file. This property is enabled for all output types except PDF and JPEG. Add page number: Select to put a page number on each page included in the output file.
-
l l l PDI: Select if you want this task to add a PDI index file to the generated document. XML and PDI: Select if you want this task to add both an XML and a PDI index file to the generated document. Use Title as FormName for PDF/VT document: Check to use the Title (defined on the Job Options tab) as the PDF's FormName in the PDI, instead of the incoming PDF/VT document's dc.title meta data tag. If the Title is empty, a warning is logged and the FormName is not changed.
-
l l l l Subject: You may enter the subject of 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. 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 Resolution: Select the resolution to use for grayscale images. Note that this setting has an impact on the grayscale down sampling process. Color images group l l l l Downsampling: Select the down sampling option. Down sampling reduces image size by breaking images down into small areas in which multiple pixels are replaced by single pixels. The Grayscale resolution you enter in the following box is used to control the down sampling process. Select None to prevent grayscale down sampling.
-
l Set document permissions: Select to enter the Permissions password. l l Allow printing: Select to let users print the generated PDF files. l Allow changing the document: Select to let users edit the generated PDF files. l 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.
-
l Show: Select the information you want Adobe Acrobat or Adobe Reader (or other PDF viewer) to display with the generated PDF. Select Page only to leave the tabs area to the left of the PDF pages empty. Select Bookmarks and page to display the contents of the Bookmarks tab (you use data selection objects to create bookmarks in PReS) alongside the PDF pages. Select Page tab and Page to display the content of the Pages tab (thumbnails of each PDF pages) alongside the PDF pages.
-
l Password: Enter the password required to access the database. l Test Connection: Click to verify that PReSImage can connect to the specified database. l Enforce global table creation: Select this option, as it ensures that all database users are granted access to the database. This option is available only when you select SQL database in the Database type box. Login, Recipient, Attachments l For the Login, Recipient and Attachment tabs, please see the "Send Email" on page 561 task properties.
-
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. If the PReS Classic job selected is an uncompiled PReS Classic script (PDS), it will first be compiled on the fly and then run using the selected data file. If the PReS Classic job selected is a pre-compiled PReS job (PDC) file, then the pre-compiled job will run with the selected data file.
-
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. Note Note: If the Data File selection does not include the data file folder path, then the folder entered into the Working Folder entry will be used for determining the path. l Working Folder: Select the folder that contains the PReS Classic job and associated resources. This entry can either be explicitly selected or it could be set via Connect Workflow variable.
-
modifications to suit the changed output type. l l Log level: Specifies the verboseness of messages returned by job processing. The available levels are Error, Warning, Information and Debug. Connect Workflow logs a successful PReS Classic job processing with a “Job Status: Finished” status, followed shortly after by “Exec Status: 1”.
-
print as well as generate PostScript or PDF files. The PrintShop Mail and PrintShop Mail 7 action tasks are essentially the same except for the version supported: PrintShop Mail only supports 6.1 documents, while PrintShop Mail 7 supports 7.0 and 7.1 documents. Limitations In order for the PrintShop Mail tasks to be functional, some pre-requisites must be met: l l l PrintShop Mail version 6.
-
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 l l Select PDF to generate a PDF file. Select Windows PostScript driver to print to a PostScript printer available via Windows. Select Preflight to check if the merging of the data file and document would generate warnings or errors.
-
Mail User Guide. This option is only available when Windows PostScript driver is selected in the Output type box. l l l l Layout: Select which layout to use to produce the JPG file (output is limited to a single image). This option is only available when JPG is selected in the Output type box. User generated file as output: The output from the plugin will be the file generated by the merging (depending on the output type selected).
-
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.
-
Processing The condition is evaluated using the specified rules, combination (condition is true when...) and scope (condition scope). Output The original data file and Metadata is output by this task. If the rules used in the condition return True, the data and Metadata is sent down in the condition's branch. Otherwise, this same information is sent in the trunk.
-
l l Condition based on Pattern Availability : Select to base the condition on the availability or non availability of patterns in a specific pattern sequence. l l l l 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 l Pidget setting: Triggered by specific pidget settings. l l l l l l l Before: If the first stroke found in the Capture Field was made earlier than the specified date and time, the condition becomes true. After: If the first stroke found in the Capture Field was made later than the specified date and time, the condition becomes true.
-
l l ICR Confidence: Triggered when the confidence percentage the ICR engine gave to the ICR value compares with the value determined in the "Confidence" box, using the chosen comparison operator. ICR Resemblance: Triggered then the resemblance percentage the ICR engine gave to the ICR value in relation to its recognition database compares with the value determined in the "Resemblance" box, using the chosen comparison operator. For more information on ICR, see PlanetPress Capture ICR.
-
Capture Fields Generator The Capture Fields Generator action task is used to generate Capture patterns in your job, which will then be printed for use with an Anoto Digital Pen. It also interacts with the Capture database and does some operations. Warning PlanetPress Capture Fields cannot simply be inserted into an existing document as-is and expected to work properly, efficiently or consistently.
-
an error occurs most of your document sequences will get generated and you will not have to start the job over from the beginning. Processing The Capture Fields Generator action task uses an existing PlanetPress Design document containing Capture fields and assigns a unique Capture pattern to each printed page. The task then locks each pattern that it used so it cannot be reassigned to any other document.
-
l l l l l l Custom: Use the title in the input field as set by the user. The field is variable so the title can be set on a per-document basis using data or metadata selections. Output Format group l l From metadata: Use the Document Title property as set in the PlanetPress Capture section of a PlanetPress Design document's properties.
-
"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.
-
Error handling If the Capture Fields Processor generates a critical error during the processing of any document in the PGC file, all of its actions will be reverted. If your PGC file contains multiple documents, even those documents that were processed before will revert. It is strongly suggested to backup your PGC file before using this task and to create an error handling process to capture these errors. Logical errors do not cause this task to exit.
-
l l 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. Page Level: l CaptureField: Information on each capture field on the page. Repeated for each capture field that is present. Note There is no method of obtaining the information from a PGC except through a successful processing of this task, or via the use of the PlanetPress Capture API within a Script (see "Using Scripts" on page 135).
-
l l l l l Engine Language: Define the language the ICR engine will use for text recognition. This has a major effect on the way text is recognized, as different languages use different databases to recognize letters, numbers and characters. For example, accented letters are not correctly recognized in the English ICR database. Fail if new ink is found on non-rewritable fields: Check to trigger the On Error tab if and when a field set as Disable Rewriting receives ink in a new session.
-
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. Capture PGC Splitter The Capture PGC Splitter task can be used to separate each document into its own PGC file so they can be processed separately. The splitter then sends each document PGC to the next action, which should be the Capture Fields Processor task.
-
Task properties General tab l Pattern sequence group: Determines what Pattern Sequence will be assigned to each PGC file. l Type: Specify from where the Pattern Sequence should be taken. l l l l None: Do not use a Pattern Sequence. Pen Information: Use the Pattern Sequence assigned to the pen in the PlanetPress Capture Database. Custom: Overwrite the pen's information and specify a Pattern Sequence manually or use a data selection.
-
Extract ICR Data The Extract ICR Data task retrieves the ICR data from the specified document ID from the Capture Database and adds this information to the current Metadata in the process, at the specified level. Input Any data file, but generally one associated with the document in question (either a PGC or a PDF), along with an associated Metadata file. Processing A query is made to the Capture database and the ICR data is retrieved.
-
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 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. Output The data file generated by this task is an XML structure containing the data about each document.
-
l l l l l l l Pen user (by description): The description of the pen, as entered in the "PlanetPress Capture Pen Management Tool" on page 711. Generally, this is the name of the owner of the pen. Pen user (by serial number): The serial number of the pen (aka Pen ID) Pattern Sequence: The Pattern Sequence in which a document is entered. Template name: The name of the PlanetPress Design document used to generate the Capture document. This is set in the document's properties, in PlanetPress Design.
-
l l l l l l l l l Before: Date comparison, documents of which the date is previous to the specified value are included (Date Generated and Date Closed filters only). After: Date comparison, documents of which the date is closer than the specified value are included (Date Generated and Date Closed filters only). Last: Date comparison, documents of which the date is within the specified interval are included (Date Generated and Date Closed filters only).
-
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.
-
Note Performance-wise, when this plugin retrieves a document from a 10,000 page PDF in the database, it will take more time then if it retrieved it from a 100 page PDF. Output The Get Capture Document action task is a loop that outputs a PDF version of the Capture Document. The PDF contains the original document, any ink added by the "Capture Fields Processor" on page 455 action task.
-
l l l Get closed documents only: Get only the documents that have been closed in this process, according to the Metadata. Close document after retrieval: Once the task has retrieved the document from the Capture database, the document will be closed even if it is incomplete. Annotate PDF: Add annotations to the PDF that describe each Capture field and the ink that is included in those fields. Note that not all PDF readers support annotations.
-
Processing The ink contained in the PGC file is converted into an EPS layer, which is then applied on an blank, empty PDF file of the size specified in the task's properties. If more than one Pattern ID is found in the PGC file, each separate Pattern ID will generate a new page on which its ink is applied. Output A PDF file with a blank background and only the ink data found in the PGC file. Task properties General Tab l PDF page size: Choose the page size of the output PDF.
-
Metadata Tasks Metadata tasks are plugins that can create or edit metadata for a job file. For more information about the metadata structure and elements, see "Metadata" on page 69.
-
Processing If the Do not use a document (passthrough) option is used, the Metadata will contain a single Job, Group and Document level, as many data page levels as there are data pages (pages in a PDF, levels in XML, rows in a CSV, etc) in the file, and one page level per data page. Note In PlanetPress Design, this step is equivalent to a &metamode variable value of 1.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 92. 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 l Extract Metadata into PDF job file: the Metadata is extracted from the current data file (which is assumed to be a PDF file in which Metadata has been previously embedded), and it becomes the current Metadata from this point on, overwriting any current Metadata file that may already be set. Embed Metadata from PDF job file: the current Metadata file is inserted in the current data file, which is assumed to be a PDF file.
-
Input Any data file with accompanying Metadata. Processing Fields are added, removed, modified, etc, according to the actions defined in the task properties. If the field is present in a level that repeats (for example, the data page level), this task loops so that the action may take place on each of the occurrences of that level. Updating all nodes For a given Metadata Field Management action, all nodes of a given level might be updated with a New Field value.
-
l l l l l l Add/Replace: Create a new Metadata field. If the name already exists, the value is overwritten with the new one. Duplicate: Create a new Metadata field. If the field already exists, a new instance is created. Append: Append the new value at the end of the current one. If no field with that name exists, a new one is created. Sum: Calculate the sum of all values found in all fields of a given name, at a given level. The resulting number is formatted by default with the dot decimal separator.
-
l l ,: Treat every value with the comma (",") decimal separator. Dots (".") are treated as thousand separator. Rule: Define criteria for the Metadata Field Management action execution. The condition must be TRUE for the action to execute. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action. See the "Rule Interface" on page 681 page for more details.
-
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). Properties l Chose an action group l l l l l Load metadata file: Loads an external Metadata file that was previously saved. This can be useful in Error processes if you have previously saved the Metadata to file (ErrorBin outputs do not transfer Metadata).
-
condition set. The action will be performed sequentially beginning with the rule on the Group level, Document level and Data page level. The selection is performed on the node only. For more information about Metadata see "Metadata" on page 69. Input Any data file with accompanying Metadata. Processing Any Metadata that does not correspond to the rules set forth by the filter are removed from the active Metadata.
-
the work of any previous Metadata Filter or Metadata Sequencer, so be careful when using this option. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 92. 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.
-
Used in a rule, it indicates that a dynamic update of the current data page or level is required before evaluating the condition. For examples of how to use the wildcard parameter, see "Data selections" on page 48.
-
Task properties General Tab l l Document: Create a new Document level. Note: Attributes and Fields are deleted for all new Document levels created as well as existing Groups. Group: Create a new Group level. Note Attributes and Fields are deleted for all new Group levels created. l l Delimiter defines if the Condition parameter is triggering the beginning or the end of a Group or Document. If the delimiter option is set to None, the action is not performed.
-
sequence, the entire data file still gets carried from one task to another. Metadata records are simply selected/deselected, which has the same effect. For more information about Metadata see "Metadata" on page 69. Note When using a PlanetPress Design document as input, the PDF Splitter will do the job quicker than the Metadata Sequencer task. However, when using a PDF as input, the Metadata Sequencer might perform better.
-
after this sequence. l l The following number of sequences in the job: Divides the Metadata into a set number of sequences and equally distributes the number of levels between the sequences. For example, it the Metadata level is set to Document, and this value is set to 5, a 100 document job file will be divided into 5 sequences of 20 documents each. The following rule: Determine if a new sequence starts or if the current one ends.
-
For each 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. When you click on either of the sort boxes, a small pop-up displays the following options: l l l Sort by: The drop down displays a list of available fields and attributes in that level, letting you select on which to sort.
-
Input This task can use any data file, as long as it is accompanied by metadata. This metadata may have been directly generated or could be extracted from a PDF using the Embed and Extract PReS Workflow Metadata task. Processing The metadata is read and PDF indexes are located. These indexes are defined in the PlanetPress Design document as data selections, in which the Archive / Email / Fax properties define the data as an index with a name.
-
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. Metadata-Based N-Up The Metadata-based N-Up action task works in conjunction with the PlanetPress Design tool's N-Up functionality.
-
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. Task properties General Tab l l Number of virtual pages that appear on each physical page: This is equivalent to the N in N-Up. This number should be equal to the total number of virtual pages in your PlanetPress Design document.
-
printer driver while the other is a group of Workflow plugins (Job Processor, Get Job Data and Get Data). These two components work together indiscriminately, each needing the other to function. Connect Send can be used in unlicensed mode and licensed mode. The Unlicensed mode (default) allows users to push documents to Connect Send. They will receive a pop-up message in the Notification Area confirming whether the job was received or not.
-
Properties General Tab Filter options Filters are required for: l Start and end date (down to minutes) l Domain(s) l User(s) l Machine name(s) Except for start and end dates, it is possible to pass a list of multiple search criteria, separated with semicolons, containing: l Workflow variables l Job variables l Names. Tip No spaces are allowed around the listed names, respectively before or after a semicolon. Operators l Searches are case-insensitive.
-
This would look for all entries, where the user name is either: l as currently stored in the global Workflow variable User l "helen" l as stored in the job variable number 1 l equals "george napier" (case insensitive). These search criteria are combined with OR. Example 2 The domain name entered in the Filter Domains field is objmtl.objectiflune.com and the user name entered in the Filter Users field is rentel.
-
Results For each job that matches the search criteria, the following information will be put into the resulting data file: l Job UID l Date/Time stamp l Number of Copies l Number of pages l User name l Original file name l Original file size l Domain (workgroup) name l Domain / Workgroup Indicator l Machine name l Machine GUID. Results File Format The following result file formats are selectable: l XML l JSON l CSV (Separator = semicolon (0x3B), string indicator = quote (0x22)).
-
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 The Get Job Data plugin gets data from the OL Connect Send database which means it only works when Connect is in LICENSED mode. Properties General tab Three different settings affect the general behavior of the plugin: l Where to get the Print Job ID. l When to continue with the next step. l Where to store the job information details. Select Job ID Source The plugin can be used in a generic way.
-
plugin will wait for 5 seconds and then raise an error, which can be acted upon via the On Error tab settings. When selecting this option, the Status ID information has to be checked. A Status ID value of 1 or 6 indicates a fully processed job. Any value between 2 and 5 (inclusive) means that the job is still in progress. l When Job is Processed: When this option is selected, the plugin will query the database until the Status ID value is 1 or 6.
-
applications do not use the general print job information to define the number of copies. In such (rare) cases, the Number of Copies sent in the job can differ from what the user entered in the print dialog. For example: "IrfanView" does not use the regular Copies indicator, but instead sends the same job as many times as indicated by Copies in its print dialog. l l l l l l l l Number of pages: This is the number of pages for one copy of the print job.
-
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. Job Processor The Job Processor plugin is an output plugin that appears in the Plug-in Bar of Workflow under OL Connect Send.
-
License mode Each incoming print job is checked against the license to determine if it can be handled in licensed mode or in unlicensed mode. If OL Connect Send is unlicensed, the plugin stores the incoming job in the target folder using the specified file name, but it does not save any information in the database. The end user will receive a message in the Notification Area (also called "system tray") confirming the unlicensed status, and the printer driver will not request another web page.
-
spoofing can be detected. On the server side, if spoofing is detected a respective message will be created. Users can set up Workflow processes and filters to accept only specific jobs from known machine IDs, thus enhancing security. Database connection The Job Processor plugin works with a database to store all relevant job information. This database is a HyperSQL Database (HSQLDB, see https://en.wikipedia.org/wiki/HSQL_ Database_Engine).
-
Properties General tab l Data Output l Output Folder: Enter the target folder for the incoming print jobs. l Output File Name: Enter the file name for the incoming print jobs. Note 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. Workflow variables Variables can and should be used to create dynamic file and folder names for each print job.
-
Information Workflow Variable When licensed When unlicensed No. of Copies 1 %6 Number of copies set by the user Number of copies set by the user Domain Name 1 %7 The Domain Name "na" Machine Name 1 %8 The Machine Name "na" 1) These values originate from the Printer Driver machine. l Plug-in Information l l License: Shows whether a license for OL Connect Send could be found. If not, OL Connect Send will be running in unlicensed (default) mode.
-
OL Connect tasks OL Connect tasks are available in PReS Workflow 8.0 and up. They are used specifically to communicate with the Server component of PlanetPress Connect or PReS Connect and for such purposes as creating record sets, generating contents and generating output. All In One The All In One task extracts data from the job file, merges the data with a Connect Designer template, and creates print output. (See also: "OL Connect print jobs" on page 103.
-
given to the Content Creation part of the task. In order to optimize the process, blocks of 100 records are sent sequentially to the Content Creation in parallel, instead of waiting for the whole record set to be created. l Source: Indicates the source of the Record Set Metadata: l Data Mapping Configuration: Executes data mapping on the appropriate source.
-
l l Filter: l l l l l l l l l Add a condition: Click to add a new condition line. This adds the line to the current condition level, by default with an AND operator. Switch conditions: Click to swap two conditions on the same level, or two groups of conditions. 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.
-
Note Once the All In One plugin has been executed with this option selected, any task that attempts to access records in the database will fail. Content Creation Tab The Content Creation step generates Content Items either by merging a Record Set with a Template, or by processing a PDF/VT file into individual content items. l Template: Select the appropriate template or option to execute it: l l l l "None": Select to skip Content Creation completely. "%o": Select to use a dynamic template name.
-
l Preset Names: Select the appropriate Job Preset file. Listed are the Job Presets that are present in the Connect Resources (see "Connect resources" on page 35). Output Creation Tab The Output Creation step generates the output for the current job, using the selected Output Creation Preset. Note that the Job Creation task normally necessary when using the individual tasks is implicitly executed before output creation.
-
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 92.
-
l Validate Names: Click to check each line in the sort list against the currently active Metadata. Metadata must be loaded in the Data Selector or through the use of the Debugging feature. Create Email Content The Create Email Content task generates a set of email content items from a template's Email Context, which are then sent directly to the recipient set in each record. Input This task must receive either Metadata containing information regarding a valid Record Set, or JSON data.
-
Note Content creation may be aborted by a script in a Connect template that raises a fatal error. This triggers the On Error tab of the Content Creation task. See Designer Script API. Output Within the Workflow process, the output to this task is only modified metadata indicating that the task is complete. It is the Server component that outputs the emails themselves and sends them to each recipient.
-
l JSON: l JSON String: a JSON object or an array of JSON objects representing records (see "JSON string examples" on page 85) or a JSON Record Data List (see the REST API Cookbook and "JSON Record Data List example" on page 87). 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.
-
l Attachments: l l l 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. Web Content as HTML page: Check to generate the active Web section in the template as an HTML page and send it with the email as an attachment Test SMTP settings: Validates the format of the sender's address and mail host and tries to send a test email. This won't work when the option Start TLS is checked.
-
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. A Job is not actual contents but simply a collection of content items ready to be printed. See also: "About printing" on page 103.
-
l 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. Click on %o to change the expression that determines the name of the preset to use. The preset name must be available in the Connect Resources (see "Connect resources" on page 35). Preset Names: Select the appropriate preset to generate output.
-
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 Output The Create Output task generates Print output in a format specified by a Connect Print Preset and sends this output to the appropriate target location. See also: "About printing" on page 103. This task can be added as an Action task (see "Action Tasks" on page 299) or as an Output task (see "Output Tasks" on page 549).
-
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. Preset Names: Select the appropriate preset to generate output.
-
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 92. 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.
-
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. Add job information to document: Check to add the 9 Job Info variables to the PDF/VT metadata at the root level.
-
Note Content creation may be aborted by a script in a Connect template that raises a fatal error. This triggers the On Error tab of the Content Creation task. See Designer Script API. 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.
-
Note When the data mapping configuration provides multiple records, the preview is created based on the first record. 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.
-
l Metadata uses existing metadata, generally the output of a Create Record Set or a Retrieve Items task set to retrieve a record. Update fields with metadata: when this option is selected, the plugin will update fields in the Connect database based on the metadata content. This is only useful if the Workflow process has modified the metadata and the corresponding fields should be updated in the database before creating the preview PDF.
-
A JSON string with references to local variables and Job Info 2: { "first":"%{first}", "last":"%{last}", "email":"%2" } 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, '%{jo
-
Content Creation tab The Create Preview PDF plugin creates a preview PDF from a template selected on the Content Creation tab, using the record that results from the data source selected on the Datamapper tab. The record is then merged with the template to create a preview PDF. Select the appropriate template or option: 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.
-
Create Print Content The Create Print Content task generates a set of printable content items from a template's Print Context, and saves those content items in the database until output creation is requested. This task also accepts a PDF/VT file as input (see "Create PDF/VT" on page 516), allowing the task to be used without a Connect Template. 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 516).
-
Creation Presets need such a record set to group, sort and filter items. Processing In the case of a record set or a JSON object/array and template, this task loops through each record (or object) in the set (or array). For each record or JSON object, one or more pages are generated using the record's data and these pages are saved as a content item in the database.
-
l l Template Names: Select the appropriate template. Adding a template to the resources is done through the Send to Workflow option in the Designer Module. Data Source (see "Input" on page 523): l Metadata: l l Update Records from Metadata: If the process metadata has been modified by any of the "Metadata Tasks" on page 470, check this option to update the records in the Connect database with the metadata and use the updated records.
-
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 92.
-
Record ID A valid Record ID can be retrieved from various data sources. By default, when the Record ID input option is selected, the metadata is used as input. The "Execute Data Mapping" on page 530 task and the "Retrieve Items" on page 541 task output metadata containing information regarding records. JSON The Create Web Content task supports two types of JSON: l l A JSON object or an array of JSON objects representing records.
-
Output The task outputs HTML code as a job file. Within this HTML code, references to external resources point to the local OL Connect Server and are served to the requester directly when the HTML file is opened in a browser. Properties General Tab l Template File: l l 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. Template Names: Select the appropriate template.
-
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. Note Only the first record or JSON object is processed, since this task can only generate HTML output for a single record. l l Embed all resources: Check this option to download the resources and embed them in the HTML file.
-
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. 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.
-
Input Optional. Both main options can refer to external files, but either one can be the active data file using %F. By default the Data Source is set to use the active data file as input. 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.
-
Properties General Tab l Data Mapping Configuration: Executes data mapping on the appropriate source. Select the appropriate data mapping configuration in the list: l l l l "None": Select to execute default, basic data mapping on the input PDF/VT file. "%o": Select to use a dynamic data mapping configuration name. Click on %o to change the expression that determines the name of the data mapping configuration to use.
-
Result.) The JSON's result and recordcount fields are also stored at the Group[0] level. Each Document node contains the following fields: l index: The position of the record in the job. This value is 1-based. Note that this is not a record ID, since the record is never stored in the database. error: The error message, or an empty string when no errors have been reported for this record.
-
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 92. 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 (see the REST API Cookbook and "JSON Record Data List example" on page 87). Note The result of a Retrieve Items task can be used with the "Create Job" on page 512 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.
-
l Retrieve by: l l l l l l l l l ID: Depending on the option selected under Entity to retrieve this is a Record ID, Record Set ID, Content Item ID, Content Set ID, Job ID or Job Set ID. Multiple entities can be retrieved by entering multiple ID's, each on a new line. Conditions: l l Condition: Select entities based on one or more conditions, the value of a metadata field for example. Add a condition: Click to add a new condition line.
-
to retrieve drop-down. To modify any of the following options, click in the Parameters box and then click the [...] button that appears. l Document contents: Defines the Document ("Mail Piece") level and how they are built. l l l Pick items based on: Use the [...] to open the "Pick Parameters" on the facing page dialog and define how to pick which items will be placed in each document. Content items picked using this method will be part of the same mail piece. Sort items based on: Use the [...
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 92. 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 task must receive Metadata that contains appropriate entities, generally from the Create Record Set, Create Print Content, Create HTML Content Set or the Create Job tasks. Processing The task sets the chosen properties to all entities present in the Metadata. These properties are added to the entities on the OL Connect Server. Note that the properties are calculated only once, and are applied identically to all entities.
-
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.
-
a JSON Record Data List (see: "Types of JSON in Workflow" on page 85). Processing The records, of which the IDs are found in the source data, are updated either from the Metadata or from JSON. Output The Job File is not changed by this task. Task properties General Tab l Update Source: Select the data source from which the records in the Connect database will be updated. l l Metadata: Select this option to use the current content of the Metadata. JSON: Enter a JSON string, or a variable containing JSON.
-
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 92. 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.
-
Send to Folder tasks, which are considered as Action and Output tasks, are documented in the current chapter.
-
Task properties General tab l Move to recycle bin: Select to send the deleted files to the Windows recycle bin. When this option is not selected, files are deleted permanently. On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 92. 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 l FTP Server: Enter the IP address or host name of the FTP server. l Port number: Set the plugin to use a specific port number. l l Use FTP Client default port number: Use the value as specified in the Preferences (port 21 is the default value). FTP Port: Enter the specific port number to use when Use FTP Client default port number is unchecked. Enter a value between 1 and 9999. Note: There is no validation to ensure the port is available.
-
Check the option Use as step description to display the text next to the icon of the plugin in the Process area. SOAP Client plugin SOAP Client plugin tasks can be used as Input, Output and Action tasks, although their basic function is to generate output. SOAP (Simple Object Access Protocol) is a light protocol that defines a standard XML format used to communicate among systems across different architectures, languages, and operating systems.
-
Task properties General Tab l WSDL address: Enter the URL address of the WSDL file, or choose a previously selected address from the drop-down list. Note The WSDL Address of a PReS Workflow SOAP server is the following: http://127.0.0.1:8080/wsdl/isoapact (assuming you are on the same machine and did not change the default HTTP port). l l l Get: Click to get the WSDL file from the SOAP server and populate the Service box below.
-
l l l Value: Lets you enter fixed or variable values. To exchange variable information between the Web service and PReS Workflow, you must use job information variables %1 to %9 or variable %c (which contains the entire job file). Note that return values (arguments which are used to return information to the SOAP Client) are displayed in bold font. Namespace: Displays the namespace of the arguments associated with the selected method.
-
file, so this task will always generate a larger and slower print job. However, this Output task can work with non-PostScript printers such as HP PCL printers. The Print Using a Windows Driver Output task requires a PReS Workflow license, otherwise this plugin will cause a watermark. Note This type of output task does not support PDF transparency and duo-tone features, so you should not use it with PlanetPress Design documents that use those features.
-
l l Job name: Enter the job’s file name. By default, the variable %f (Job File Name) is used. You may use a different variable, but you may not use a data selection. This information may be used for the printer’s banner page. Job owner name: Enter the job owner name. You may use a PReS Workflow variable. Note This option is not functional when natively printing PDFs (without a PlanetPress Design 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.
-
Task properties General Tab l l Queues: Select the queues to which you want to send the output (see "PReS Workflow printer queues" on page 105). Documents: Select None if you want the job file to be printed as is. Select a specific PlanetPress Design document (see "PlanetPress Design documents" on page 39) if you want all the jobs to be printed 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.
-
l Load balancing group (Options from this group are only valid if multiple Workflow printer queues were selected.) l l l l l l l Split job: Split job means that jobs will be split according to the criteria set in the Page delimiter group (see below) and that an equal share of the job file will be sent to each one of the selected Workflow printer queues. For a hundred page job, for example, if two queues were selected, each one will get 50 pages.
-
On Error Tab For a description of the options on the On Error tab see "Using the On Error tab" on page 92. 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 While an email is always sent by this task (or at least attempted to be sent), the contents of the file and presence of attachments depends on the selected option. Refer to the property descriptions below to know what each option does. Once the contents of the file and attachments are determined, the email (including attachments) is either sent directly to the selected SMTP server, or is deposited in the "Outbox" folder of the local Microsoft Outlook account.
-
first line should start with or . It should not be any other character). Also note that it is not currently possible to send both an HTML and plain-text version of your message. Attachments Tab Use this tab to add the files received by this task (plus any other file that you may choose to attach) to the emails sent by PReS. l l l l l l l Attach input job files: Select to attach the file received by this task to the emails it will generate.
-
l l l l l l l l l l Use SMTP mail: Select to use Simple Mail Transfer Protocol (SMTP) to send the emails (and attachments). To use SMTP you must enter information in the Name, Email Address and Outgoing Mail (SMTP) boxes below. Name: Enter the sender’s name that will be used in emails sent by PReS Workflow for this task. Organization: Enter the organization name that will be used in emails sent by PReS Workflow for this task (this is optional).
-
Send to Folder Send to Folder Output tasks send the files they receive to a local folder. They perform the same function as Send to Folder Action tasks, with the only difference being that in this case, PReS Workflow will not wait for the task to be completed before going on to the next task in the configuration. Input Any data file. Processing and output The file is saved in the location specified, as the file name specified.
-
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. Unknown tasks An Unknown task is a task location that is not linked to any existing known task.
-
l l l l Global variables are available to all processes and tasks within the configuration, and any modification made to them affects all tasks and configurations. For more information see "Global variables" on page 575. Local variables are specific to an instance of a process. That is to say, when a process changes the information in a local variable, it changes it only for that process and only for that specific instance of the process. For more information see "Local variables" on page 573.
-
Note l l While the initial Job Infos are created by the input task, they can be overwritten by the Set Job Info and Variables Action task, by a Script, or by any secondary input task in the process. Whenever you use a job info in your process, make sure it contains the value that you want, and not one that has been overwritten by another task. Job infos are limited in quantity and are slowly being deprecated when transferring data to your documents.
-
ExpandString() function. For more information, please see the PlanetPress Design User Guide. Standard variables Standard variables, also known as "system variables", are variables that are created and managed directly by PReS Workflow. These variables are read-only and cannot be modified. They provide information about the job, process, and PReS Workflow environment.
-
Variable Name Example value when interpreted %m Current month (numeric) 06 %M Current month (text) June %L Current month (short text) JUN %d Current day (numeric) 16 %D Current day (text) Monday %l Current day (short text) MON %h Current hour 18 %n Current minute 03 %s Current second 41 %v Current millisecond 24 %u Unique 13char string (will be different every time it is used) 0ZIS4CW8U47VI00 Page 570
-
Variable Name Example value when interpreted %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 temporary folder C:\Documents and Settings\All Users\Application 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:\
-
Variable Name Example value when interpreted %i Current Loop iteration index (always the innermost loop) 2 The %i Loop Count variable The value of the %i variable is equivalent to the current iteration of loops inside of a process. It always contains the value of the innermost loop, and only certain tasks trigger the counter to start. The below image shows an example process and the value of %i during this process: Initial input tasks do not modify the value of %i.
-
l Loop l Capture PGC Splitter l PrintShop Mail Error handling variables The error handling variables are read only and are filled by the On Error mechanism. They can be accessed anywhere, but they only appear in the contextual menu of a task property field when the current process is an error-handling process (that starts with the Error Bin Input task). See also: "Variable task properties" on page 577. Variable Name %{error.process} Name of the process where the error was triggered. %{error.
-
example, you could store the current order ID for the process, a name, or an email. You can have as many local variables as you want in any given process. Adding a local variable To add a local variable: 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.
-
Setting a variable value within a process You can set the value of a variable within your process in two ways: l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 358. You can use Scripts. See the chapter "Using Scripts" on page 135. Tip Variables may be used as variable properties in Task Properties (see "Variable task properties" on page 577).
-
1. Click on the Home tab of the PReS Workflow Ribbon: 2. Click Global Variable in the Variables group. The new variable will appear as GlobalVar or GlobalVarX (the name is automatically incremented). To set the value of a global variable from the Configuration Components pane: 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.
-
l l Use the Set Job Info and Variable action task. See "Set Job Infos and Variables" on page 358. You can use Scripts. See the chapter "Using Scripts" on page 135. 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.
-
Variable properties can also be mixed, meaning you can combine, within a single variable property box, any number and order of variable types. You can, for example, do the following for 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.
-
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.
-
OL Connect Send processes Connect Send allows for PostScript files to be received over the internet from any Windows Desktop application. It is in fact an application with two components. The first is a Windows printer driver while the other is a group of Workflow plugins (Job Processor, Get Job Data and Get Data). These two components work together indiscriminately, each needing the other to function.
-
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 198. "Anoto" and the Anoto logotype are trademarks owned by Anoto AB.
-
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. The documents can be search through a few different criteria and can be displayed as PDF files, individually or as a group. Documents can also be closed or deleted from this interface.
-
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).
-
Pidget Type of PlanetPress Capture object. Page element used to give instructions to the Anoto pen, as opposed to recording ink. PlanetPress Capture Database A database containing the list of patterns, sequences, registered pens and documents. The Capture Database can be used by a single server, or by multiple servers in a Client/Server architecture. Session The time spent by the pen between events that trigger a new session.
-
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 . The following considerations should be kept in mind while working with ODBC Databases in PReS Suite. l All databases l l l l l l Minimum 100MB of database size is required as a minimum, but the space requirement depends on the implementation.
-
l MSSQL (Microsoft SQL Server) l l l l All versions of the SQL Server are supported, including all Express versions. Database can be in any location, but performance will depend on the speed of the connection between PReS Production and the SQL server. In the event where 2 requests are made simultaneously on the same record, SQL Server will drop the most complex request. Resubmitting the PGC for processing should resolve this issue. This, however, should happen only rarely.
-
digital pen. Consequently, it is still the most vulnerable piece of the workflow and as such, it should be the first objective of any security effort. In other words, as long as the physical piece of paper bearing markings is accessible to malicious users, no amount of security protocols can protect the signed contents. It is only after the paper trail has been secured that the security and privacy issues specific to PlanetPress Capture should be addressed.
-
l The same rules apply to PDF files as with PGC files, especially when they contain a signature from the pen. If you are already securing digital scanned copies of signed documents, the PDFs should be secured in similar ways. However, remember that as with most security concerns, in order to be a “threat”, someone would have to have a high level or working knowledge of either the Anoto SDK (which is not easily obtainable) or PReS Workflow and PlanetPress Capture.
-
and cannot be re-used. Then, when someone writes on the document and sends the pen data to PReS Workflow (through a docking station or through Bluetooth), if the required conditions have been met, the document will be "closed", its pattern released and available to be used immediately. An open document can also be called a "live" document, in the sense that it is only active between the time where it is printed and the time where ink from the Anoto Digital Pen is processed and the document is closed.
-
Extending There are actually 2 ways of dealing with extending the number of patterns using the currently available tools, each with its own advantages and disadvantages. Using separate PReS Workflow servers and licenses. In a scenario where there are multiple locations that use PlanetPress Capture and where neither pen nor paper has any risk of being moved from one location to another, the easiest (but costlier) solution is to have a separate installation of PReS Workflow in each location.
-
Note It's very important to note here that the Anoto Digital Pen has absolutely no concept of Pattern Sequences. When "attributing" a sequence to a pen, this is fully on the PReS Workflow side, in the Capture Database. This means that if a pen is mislabeled or someone picks up the wrong pen, this pen has absolutely no way to know that it is writing on the wrong paper. more about this in the Contamination section below.
-
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. Assuming proper processes were put in place, this document would eventually be closed by a manual or automatic procedure. However, the physical document with the pattern still exists even if it is closed in regards to the PlanetPress Capture database.
-
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 734. 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 487) 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 l l The Get Job Data plugin. Creating interactive processes for incoming print jobs requires that the relevant information about the respective job is available and can be used in Workflow. This is what the OL Connect Send Get Job Data plugin is made for. (See "Get Job Data" on page 493.) The Create Web Content plugin. Each web page served by an interaction process is generated by this plugin. (See Create Web Content.
-
“BASIC” profile is the lowest level, and is the level supported by the Workflow plugin. It holds structured data which is enough to cater for most requirements of the Federal Ministries and industries (such as the software and taxation sectors) participating in the standard. For more information, please see the ZUGFeRD website: https://www.ferdnet.de/zugferd/definition/index.html. Licensing The ZUGFeRD plugin is bound to the Connect Workflow Imaging license.
-
ZUGFeRD plugin The ZUGFeRD plugin provides a way to enrich German PDF invoices with data specific to the invoice. This is done via embedding the data in a standardized XML format within the PDF itself. For general information on the Plugin, see "ZUGFeRD" on page 611. The ZUGFeRD plugin is not currently included in the standard Workflow installation, and must be installed via the standalone ZUGFeRD plugin installer. The ZUGFeRD plugin will be installed to the Connectors Plugin bar.
-
Note All the fields with a maroon field name support the use of variable data. You can rightclick within these fields to insert a Workflow data selection. This provides an easy option for including Workflow information that relates to the currently processing invoice (such as Metadata and variables) into the ZUGFeRD fields.
-
l l Dokumentenart: The document type. This field will always be set to "RECHNUNG" (invoice), to cater for BASIC invoices. Rechnungsdatum: The invoice date. This entry can be set directly, or through the date selection pop-up that appears when the drop down icon is selected. Note The date must be formatted in standardized UTC format: yyyy-mm-dd Any other formatting will lead to a run-time error.
-
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. Note The plugin does not check if a given country code is in the list of valid country codes. It is the responsibility of the user to ensure that only valid country codes are 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.
-
l Postleitzahl: The postal address post/ZIP code. Note No postal code validation is done by the plugin, so it is up the user to make sure that the post code entry is valid and in the correct format for the indicated country. This field can be set via Workflow data and/or variables. 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.
-
right-click within these fields to insert a Workflow data selection. For more information on Workflow context menu data selection options, see this page: Workflow Variable Properties l Zahlungsinformationen group contains payment related information. l l Zahlungsreferenz: The payment reference, purpose, or payment number serving as identifier for the payment. This field supports alphanumeric strings, and can be set via Workflow data and/or variables.
-
l BIC: This is an international bank code that identifies particular banks worldwide, using the Bank Identifier Code (BIC) standard. The standard consists of a 4-letter institution or bank code, a 2-letter country code (following the ISO 3166-1 alpha-2 standard), a 2-character (letter or digits) location code and an optional 3-character (letter or digits) branch code. Note The plugin does not validate bank IBAN/BIC codes. It is the responsibility of the user to ensure that valid codes are entered.
-
l Detaillierte steuerliche Informationen group contains detailed taxation information. l l l l l l Gesamtbetrag der Positionen: The total amount This should be a numeric currency, which can be set via Workflow data and/or variables. 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.
-
About related programs and services Services are programs that run in the background and automatically perform tasks that often do not require any user interaction. With the exception of the PReS Workflow Configuration tool, all the programs used by PReS Workflow are run as service applications. PReS Workflow can thus use them as required without the need for any user interaction.
-
l HTTP/SOAP Server service: Monitors web pages and web sites as well as SOAP servers. Available Output services Output services are used to output jobs. The output services used by PReS Workflow are: 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.
-
Note The current PReS Workflow status is always displayed in the lower-right corner of the PReS Workflow Configuration program window. 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.
-
Local and network rights Programs, such as PReS Workflow and all their services, must identify themselves in order to be granted permission to perform operations on the computer on which they run as well as on other computers accessible via a network connection. On a given workstation, you can configure your PReS Workflow to use either the local system account or any specific user account (see "Workflow Services" on page 689).
-
User specificity PReS Workflow configurations are not user specific as such. If you make sure that all the user accounts have adequate network rights, that printer queues are defined the same way on all systems, and that all network drives are mapped using the same drive letters (or that the UNC option is selected in the network options), then you should have no problems running configurations on different systems using different user accounts.
-
you do not know the domain name and user name of the account you want to specify, it can also be very time-consuming if there are many domains. l l Domain: Select the domain in which the user account resides, or enter the name of the domain manually. 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.
-
The user 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: l "PReS Workflow Button" on page 637. l " The Quick Access Toolbar" on page 751. This toolbar is customizable. l The ribbon tabs; see "The PReS Workflow Ribbon" on page 752. l "The Process area" on page 744 l "Configuration Components pane" on page 638.
-
Customizing the Workspace You can combine and attach the Configuration Components pane, Messages area and Object Inspector into a single secondary window that can be docked to and undocked from the main PReS Workflow Configuration program window. Combining and attaching areas can facilitate the management of your screen real estate. It lets you reposition multiple areas in a single operation.
-
Dock and undock areas of the Program Window The Configuration Components pane, the Object Inspector, and the Messages area can be displayed in windows that are attached to the Program window (docked position) or that float above it (undocked position). You dock a window when you attach it to the Program window, and you undock it when you detach it from the Program window.
-
Release the mouse button when the rectangle is in a docked position (attached to the Program window). l Double-click either a title bar (separate or attached areas) or a tab (combined areas) displaying the name of the Configuration Components pane, the Object Inspector or the Messages area. The area will jump from an undocked to a docked position and viceversa. Show or hide areas of the program window You can choose to hide or display any of the customizable areas in PReS Workflow program.
-
Combining areas Click either a title bar (separate or attached areas) or a tab (combined areas) displaying the name of the Configuration Components pane, the Object Inspector or the Messages area and move the mouse pointer. As you drag, a rectangle is displayed to show the landing position. Drag the rectangle directly over another area and release the mouse button when the shape of a tab appears at the bottom of the rectangle.
-
Reordering tabs in a combined area At the bottom of the combined area, click the tab of the area you want to move, drag it to the left or right and drop it at the desired position. Image: Dragging a combined area to new position. Taking an area out of a combined area 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.
-
3. Resize each part of the new group as desired. Image: 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. Maximize or restore attached areas 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.
-
Image: A) Click to maximize this area. B) Click to restore this currently maximized area.
-
Image: C) Click to maximize this area. D) Click to restore this currently maximized area. Taking an attached area out of a group 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. Release the mouse button when the rectangle is away from the group.
-
To resize a program window area: 1. Move the pointer to an edge of the area that you want to resize, to display the resize pointer. 2. Then click and drag to resize the area. Change the Interface language PReS Workflow can be used in multiple languages, and the list of available languages grows as we translate the software. The first time you use PReS Workflow, it starts in the language used for the installation. To change the language used by the PReS Workflow Configuration program: 1.
-
Japanese. PReS Workflow Button The PReS Workflow button provides access to the File menu options. Options l l l l l New: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. See "Creating a new configuration" on page 30. Open: Displays the dialog to open an existing configuration file. Save: Saves the current configuration.
-
l l l l l Close: Closes the configuration that is currently opened and creates a new configuration, with a single example process and no printer queues. Closing the current configuration is the same as creating a new one. Recent Documents: Displays a list of the 9 most recently opened configuration files. Click on any of them to open it. Select Language: Click to display the language selection dialog, which changes PReS Workflow interface language. See " Change the Interface language" on page 636.
-
l Delete: Deletes the process from the configuration. l Rename: Renames the process. l l l Startup: Triggers whether the process is a startup process (runs before any other process). l Group, Ungroup: Triggers grouping functionality. l Properties...: Displays the process' properties, for scheduling and error handling. Subprocesses: Displays a list of subprocesses in your configuration (see: "About processes and subprocesses" on page 118).
-
l l Properties...: Displays the properties, which lets you set a default value for the global variable. Connect Resources: Displays a list of PReS Connect resources that can be used in processes (see: "Connect resources" on page 35). Different resources are divided into subfolders: l Data Mapping Configurations: Displays a list of data mapping configurations used with the Execute Data Mapping task.
-
l l Properties...: Displays the properties, which lets you see the form information and select its default printing behaviors. Printer Queues: Displays a list of printer queues in your configuration (see: "PReS Workflow printer queues" on page 105). Right-click on a printer queue to access a dropdown menu that offers these choices: l l Insert Printer Queue: Creates a new printer queue in your configuration. Replace Printer Queue By: Replaces the currently selected printer queue with a new one.
-
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: Select to make this process a startup process (see: "Startup processes" on page 119). This option is not available for self-replicating processes and error processes.
-
that's only scheduled to run one hour per week, it will capture the input 120 times during that period. Note that the polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to 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.
-
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. To select all the days or dates for a given time segment, 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 Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
-
l l l Document: The file name of the document, as entered in PlanetPress Design. This is the name of the file saved in PlanetPress Design, or the name you give it when you add a 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). Version: The version of PReS Workflow in which the document was originally created.
-
l l l RAM: Select if the PlanetPress Design document is on the printer's RAM (Random Access Memory). Document Update group (enabled only when using printer-centric mode and the document is on the printer) l l l l In printer flash memory: Select if the PlanetPress Design document is on the printer's flash 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.
-
configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box. If you are copying a configuration component to a valid location, the mouse cursor displays the normal cursor along with a small dotted box and a plus (+) sign. 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.
-
If you move an object in the Configuration Components pane on top of a group, the group name turns maroon (in the default color scheme) to indicate the object will be moved in the group after all the existing objects currently in that group. 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.
-
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 "Moving and copying configuration components" on page 648 to copy and move objects and tasks.
-
Items or processes, and groups, can only be grouped within their own category. Thus you can only group processes with other processes, resource documents with other resource documents, and printer queues with other printer queues. In the resource 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.
-
l Select the group and press CTRL+U. The contents of the group will move one level up. To remove objects from a group, without removing the group itself, select the object or objects and use one of the methods above or drag-and-drop. If a group becomes empty, you are prompted to confirm the deletion of the group.
-
In the case of process groups and printer queue groups, the group and all its members are deleted. In the case of documents, you are first prompted to confirm the deletion of each member of the group. You can turn off this prompt in the Notification Messages User Options. Note To disable the confirmation notification that you get when you delete something from the Configuration Components pane, you can check Always delete without asking in the notification.
-
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. Typically this IP should have all the accesses checked. 255.255.255.255: Everyone on the same subnet. This is equivalent to hard-coding the current subnet, such as 192.168.1.255 or 10.0.0.255. 192.168.0.42 : A single IP address. This can be any valid address on the same subnet. 10.0.255.255: Any IP in the 10.0.X.X range.
-
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. This means that wide ranges should always be at the top to increase performance. For example, if you accept HTTP connections from any IP, the first entry should be 255.255.255.255 with the Allow checkmark in the HTTP Input box. PReS does not continue processing after it has found an "Allow" checkmark.
-
l Send Config:Grants access to the remote computer to overwrite the configuration on the local PReS Workflow service Note In order for the changes made here to be effective, you will need to restart the PReS Messenger service. This can be done via the PReS Workflow Service Console. SOAP Access The SOAP tab of the Access Manager controls access from SOAP clients to local processes and SOAP processes. Each user name entered in this dialog can have access to one or more processes.
-
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.
-
Note In order for the changes made here to be effective, you will need to restart the PReS Messenger service. This can be done via the PReS Workflow Service Console. Activate a printer The Activate a Printer dialog lists the existing activated printers on the system and lets you add new activations. Note Activating a printer is required when you have a PlanetPress Suite Printer License.
-
The following buttons are available in this dialog: l Add: Brings up the Printer Activation dialog. This dialog lets you enter the information for the printer (see previous section), then click OK to save the new activation. l Delete: Removes the currently selected activation from the list. l Web Activation: Click to access the online activation manager on our website. l OK: Save changes and exit. l Cancel: Exit without saving changes.
-
Note MySQL, using ODBC 5.0, must be set to use a client-side cursor. Microsoft Access will always work better when using a Server-Side cursor. l l Expect record set: Check if you are expecting a result from the database after executing the SQL query. If the query is expecting a record set in return and does not return one, the task will trigger an error. Test SQL button: Verify the SQL statement's validity.
-
keys cannot be removed or edited. l l l l DateC is the creation date of the Key Set. l DateM is the date at which the Key Set was last modified. Delete Group: Click to delete the currently selected group. Warning: This action cannot be undone. Add Key: Click to add a key to the currently selected group. Enter a key name and click OK. If adding a key to a group with existing data, the key will be empty for all existing KeyGroups. Delete Key: Click to remove the currently selected key in the group.
-
l l l Clear All Data: Click to delete every KeySet of every group in the Repository. Warning: This action deletes all your data and cannot be undone. Clear Repository: Click to delete every group in the repository, including all their data. Warning: This action deletes all your data and cannot be undone. Show/Hide System Keys: Click to show or hide the ID, DateC (creation date) and DateM (modification date) keys.
-
l To add a KeySet, press CTRL+N. The Add Key Set dialog will appear. Use the arrow buttons to browse through the keys in the KeySet and add values to them. This dialog has a button at the bottom to add another KeySet. Navigating with the Keyboard Though of course the mouse is the easiest way to navigate through the Data Repository, the keyboard can be used as well. l l Press Tab to switch between the Repository Structure, Group Key Sets, Lookup Function Syntax and the Close and Help buttons.
-
l l l Choose Debug > Select, on the menu. Right-click a task property that may contain variables (recognizable by the color of its field label, which is maroon by default) and choose one of the Get Data ... or Get Metadata ... options. Debug your configuration and step through it until the option Debug > View Metadata gets enabled. This happens when the Metadata file has been created by a task in the process.
-
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 376) 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 54) 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.2. The File Viewer The File Viewer is like a Data Selector without any data related options, such as emulation settings.
-
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 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.
-
l l l l l All pages: Select to apply the Show used cells option to all pages in the sample data file. This option is not available in database emulation. Pages to analyze: Use this box to limit the number of data pages to which PReS Workflow applies the Show used cells option. Enter the number of pages to which you want PReS Workflow to apply the option, or use the spin buttons to adjust the value. This option is not available in database emulation.
-
l Font: Select the font you want to use to display the sample data file in the Data Pane. l Font style: Select a weight for the font. l Size: Select the point size for the font. l Sample: Displays a preview of the font selected in the Font box. l Script: Select the system-level encoding table you want to use for the font selected in the Font box.
-
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: Select to make this process a startup process (see: "Startup processes" on page 119). This option is not available for self-replicating processes and error processes.
-
that's only scheduled to run one hour per week, it will capture the input 120 times during that period. Note that the polling interval is ignored when multiple files are present in the input and will be used only when there are no longer any files to 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.
-
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. To select all the days or dates for a given time segment, 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 Set All Tasks button resets the On Error properties of all the tasks included in the current process to the On Error properties of the process itself.
-
l IS EQUAL TO OR LESS THAN (<=) l IS CONTAINED IN l IS NOT CONTAINED IN l CONTAINS l IS GREATER THAN l IS LOWER THAN l STARTS WITH l ENDS WITH l VALUE CHANGED Note When "VALUE CHANGED" is selected in the condition, the second parsed field is not considered. Expressions The first expression can either be a custom list or a parsable edit field. The second expression is always a parsable edit field.
-
l The following rule: (GetMeta(SelectedIndexInDocument[0], 11, Job.Group[?].Document [?].Datapage[?]) Equal 0 loops through all datapages in a job, comparing their index in the document to a value. Index/Count values When using Index/Count values in a rule, please note that these values 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.
-
3. Define condition B. 4. Select condition B and choose Add Sub Condition. This will indent condition B and allow to define the condition C. Specify the logical operator OR. 5. Define condition C. 6. Right click on the first AND operator (the one right after condition A) and choose Add Condition. Specify the logical operator AND. This will create a condition at the same level as A. 7. Define condition D.
-
To start a stopped service: 1. Right-click on the service. 2. Click on Start. 3. Look in the Log window on the right to see the service starting. To stop a service that is running: 1. Right-click on the running service. 2. Click on Stop. If the service is currently processing a file (if a process is running, output is being generated, job being received, etc), the service will wait for this action to complete before stopping. To pause a service temporarily: 1. Right-click on the running service. 2.
-
the view in real time. When a service is selected on the left pane, its log file (if any exists for the current day) is displayed. The log displays in a tree fashion. The log itself is the root, and each session (the time between the start and stop of a service) is listed. Under each session, each time a process runs, a new branch is created and it can be expanded to see each action within that process.
-
Browsing log files Select File > Browse logs, to open a folder that contains either Workflow or Connect log files. This is useful when you need to delete a log file or open it in another editor because it has reached a larger size than the Service Console can handle. With this option you cannot open a log file in the Service Console. Note For Connect log files, the browser opens the current user's default Connect logs location.
-
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 696). Each task has its own set of tabs available, though some tabs are common to most tasks. l l l l Most tasks have the General tab which lets you configure the main task properties for that specific task.
-
Select any document in the list (use CTRL+Click or SHIFT+Click to select multiple document or use the Select All button) and click OK to update these documents. To add any document to this list, you need to assign them to a printer queue. See "Associating PlanetPress Design documents and PReS printer queues" on page 113.
-
You can also manually start this procedure from the PReS Workflow Tools by following this procedure: click on the Tools tab in PReS Workflow Ribbon, then click Configure Services. Set the PReS Workflow applications permissions as required: l l l l Local System account: Select to run all the PReS Workflow Services (including PReS Workflow, PReS Fax, and PReS Image) under the Local System account. The Local System account is distinct from the Administrator account.
-
PReS Workflow applies the user account information to all the services (PReS Workflow, PReS Fax, PReS Image, LPD input, Serial input, Telnet input, FTP output, LPR output, PReS Messenger), that run on this computer. The PReS Workflow Configuration program does not test user names and passwords, but merely associates them with the services that require them. If you enter a bad user name or password, these services will be denied access to the selected account.
-
The contextual (right-click) menu displays the following items when at least one expression is present: l Copy Value (only when right-clicking an existing expression): Places the resulting value of the expression in your clipboard. l Revalue all: Refreshes the value of all the expressions. l Add Expression: Creates a new expression. l l Delete Expression (only when right-clicking an existing expression): Remove the selected expression. Clear Expression List: Removes all expressions.
-
l l l l l While a line is selected, press CTRL+X on your keyboard or right-click on the line and select Cut to place the line in the clipboard. Press CTRL+C on your keyboard or right-click on the line and select Copy to place a copy of the line in the clipboard. Press CTRL+A on your keyboard or right-click on any line and select Select All to select all the lines in the Message Area. Right-click anywhere in the Message Area and select Clear Messages to clear the contents of the Message Area.
-
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. 2. In the Object Inspector, click an editable property. 3. Depending on the values that can be entered for the selected property, edit the value by typing one or by selecting a new one from the drop-down list.
-
l Inputs l Actions l Data splitters l Process logic l Connectors l PlanetPress Capture l Metadata Related l OL Connect Send l OL Connect l Outputs Note 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 falls into such a category.
-
l Move plugins from one custom category to another (that you cannot move default plugins from the default categories, you can only copy them) l Copy plugins from one custom category to another by holding the CTRL key. l Delete plugins from any custom category by using the Delete key. l Revert to the default Plug-in Bar by selecting Reset to default. To import a plugin: 1. Click on the popup control ( ). 2. Click on Import Plugin. 3. Browse to the location of the plugin DLL file. 4. Click on Open. 5.
-
l l "OL Connect preferences" on page 714 l "PDF text extraction tolerance factors" on page 715 Plug-in: l "General and logging preferences" on page 717 l "Messenger plugin preferences" on page 718 l "HTTP Server Input plugin preferences 1" on page 719 l "HTTP Server Input plugin preferences 2" on page 723 l "LPD Input plugin preferences" on page 724 l "NodeJS Server Input plugin preferences 1" on page 725 l "NodeJS Server Input plugin preferences 2" on page 727 l "NodeJS Server Input plu
-
General appearance preferences Ribbon Color Scheme l Blue: Sets the general interface color scheme to a blue color. l Silver: Sets the general interface color scheme to a silver (gray) color. l Black: Sets the general interface color scheme to a black (coal) color. Colors l l l l Variable properties: Select a color for the labels identifying variable property boxes. Debug: Select the color applied to the PReS Workflow Process area background when in debug mode.
-
Options l l l l Vertical line 3D: Select to display the vertical line between property names and their values using a 3-dimensional effect. Use groups: Select to organize the display of properties into groups. Clear the selection to display properties in alphabetical order. When the Object Inspector displays properties in groups, it displays an expand/collapse button to the left of the name of the group for expanding or collapsing the group.
-
l l l l Show Tree Lines: Check to choose whether or not to display the lines that connect the different objects in the Configuration Components pane. Show Grid Lines: Check to choose whether or not to display grid lines between each object in the Configuration Components pane. Hot track: Check to choose whether or not to display the object in the Configuration Components pane under the mouse cursor as being underlined.
-
Notification Messages behavior preferences Notification Messages behavior preferences control the display of certain messages and prompts within PReS Workflow. Preferences l l l l l l l l l l l User mismatch: Select to have PReS Workflow display a prompt when a different user opens the application. Task deletion: Select to prompt for confirmation when deleting a task. Document deletion: Select to have PReS Workflow prompt for confirmation when deleting a document.
-
l l l l l l l l l l l Nothing to configure: Select to have PReS Workflow notify you when you try to set properties for a task that does not have any properties. For example, the Error Bin input has no properties because it only inputs jobs sent to it through On Error properties of tasks in other processes. When you attempt to edit its properties, it displays the "nothing to configure" message when this option is selected.
-
l l l l l Prompt on Emulation Change: Select to have PReS Workflow prompt when the default process emulation is being changed. The last emulation selected when debugging a process is the one the process begins with. Prompt on Form Refresh: Select to have PReS Workflow prompt for confirmation when recompiling the PostScript (PSx) version of a PReS Connect Document. Refreshing PReS Connect Documents that are currently in use can lead to unexpected results.
-
Network behavior preferences Network behavior preferences let you configure NetWare® Login user options, so that PReS Workflow can access your Novell® NetWare network. The following procedure also lets you choose the Universal Naming Convention (UNC), which removes inconsistencies when accessing paths on Novell and other networks. Preferences l NetWare Login: Check to enable the options PReS Workflow requires to access NetWare resources.
-
Note You can leave the Context box empty if there is a single root context on your NDS tree, if you can perform a context-free log in, or if you enter a server name in the Server box. PReS Workflow and PReS Image use the same security context when connected to a NetWare server and they each use one connection. Also note that using erroneous Tree or Context information may cause PReS Workflow and its services to crash.
-
l l Manage Pens...: Click to open the "PlanetPress Capture Pen Management Tool" on page 711 dialog. License Manager...: Click to open the "PlanetPress Capture License Management" on page 713 dialog. PlanetPress Capture Server/Client PlanetPress Capture can be set to be either in Server or Client mode from the PlanetPress Capture User Options. In Server mode, all pen licenses are stored locally. Other clients can connect to this server to validate pens. This allows all pen licenses to be managed locally.
-
l l l l l l l l l Document Title: Search in document title as specified in the Capture Field Generator task. Production date (YYYY-DD-MM): Search using the date at which the document was generated using the Capture Field Generator task. Pen user (by description): Search using the description field in the Pen Database. Pen user (by serial number): Search using the pen's serial number in the Pen Database. Pattern Sequence: Search using the Pattern Sequence in the Document Database.
-
Manage Documents Group l Document list: Displays the results from the search in 3 columns: l l l Document Title: Displays the title of the document as specified in the Capture Field Generator task Production date: Displays the date and time on which the document was added to the Capture Database. More info: A variable column that displays additional information about the search results, such as the Pen ID or Pattern ID. l Select all: Click to select all the documents in the list.
-
Settings l l l l Name: Click to displays and choose from a drop-down of each DSN (Data Source Name) available on the system, along with it's source (User DSN or System DSN) and the driver it uses (database type). Type: Click to display a drop-down of supported database types. This must correspond to the database type of the DSN chosen in the previous option. user name: If the database is secured with a user name and password, enter the user name here.
-
Database considerations (ODBC) Note 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 . The following considerations should be kept in mind while working with ODBC Databases in PReS Suite.
-
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.
-
Pen Data List: Displays a list of registered pens and those pens you just added. l l l Pen ID: The serial number of pen, as written on the Anoto Digital Pen. You can doubleclick this area to edit the Pen ID if necessary. Pattern Sequence: The pattern sequence the pen is assigned to. You can double-click this area and edit the pattern sequence as required. User ID: The name of the user assigned to this pen. You can double-click this area to edit the user ID. This can also be custom information.
-
Multiple pens can be registered at once simply by writing on the registration pattern and then docking each pen before clicking the Read PGC File button. If the pen that is being registered already exists in the pen database, the Replace User ID (Description) dialog appears, with the following options: l Pen ID: Displays the Pen ID (serial number) to identify the pen l Old desc.: Displays the content of the User ID field for the pen as it is now. l New desc.
-
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 PPLIC overwrites your current license, however it may contain more than one Pen Pack (your previous one and one you just purchased) and will display them individually. License List: Displays the licenses that have been added to this system.
-
l l l l 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. Password: Enter the password expected by the OL Connect Server for the above user name. Email Creation Settings l l Mail Host: Enter the default SMTP Server host or IP Address. Sender address: Enter the default email address used as the sender (FROM) address. l User name: Enter the default user name for the SMTP Server if it requires it.
-
two fragments will need to be exactly one beside the other with no space or overlap between them. When this value is at 1, a very large space or overlap will be accepted. This may case "false positives" and separate words and text blocks may be considered as a single word if the value is too high. Accepted values range from 0 to 1. The default value is 0.3, recommended values are between 0.05 and 0.30. Delta Height Defines the tolerance for the height and position difference between two target fragments.
-
fragments as a single word. To resolve this, the Gap setting can be changed. The lower this value, the higher the chance of a space being added between two characters. A value too low may add spaces where they do not belong. Accepted values range from 0 to 0.5. The default value is 0.3, recommended values are between 0.25 and 0.40. General and logging preferences General plugin preferences control the level of detail added to the PReS Workflow log file.
-
l Maximum numbers of replicated processes: Set the maximum number of times a process may be replicated. Note The index number of a task is logged immediately after the time stamp, between square brackets. For example: INFO : 00:00:21.534 [0015] Plugin Create File completed successfully - 12:00:21 AM (elapsed time: 00:00:00:001) The index number corresponds to the row number of the task in the Process Area (see "The Process area" on page 744).
-
l l Close inactive instances after: If you want the PReS Workflow Messenger to close inactive instances of the Alambic after a given number of minutes, enter a value in this box. Enter a value of ”0” if you do not want the Messenger to terminate idle instances of the Alambic. Logging options group l l Delete log files after: Enter the number of days after which to delete the Messenger service logs.
-
base64 encoded). Files in DER format, the binary encoded version of the PEM format, cannot be used to configure Workflow, although they may have the same file extension (e.g. .crt, .cer). Please check the format of your files, using a tool like: https://www.httpcs.com/en/ssl-converter. l l l l l Root certificate: Enter the absolute path to the public key certificate identifying the root certificate authority. The file generally has a .
-
SSL certificate, "https" appears in the URL. For more information on SSL and how to purchase a certificate, see for example Q10694 on SSL.com. l l l Disable SOAP Server: Check to disable all SOAP Server functionality. Verbose log: Select to enable to keep a verbose log. Note that a communication log is generated whether or not this option is selected. If you use a secure connection, the log will contain extra information.
-
Note Incoming binary files (sent through file upload in a form) can never be larger than 400 MB. PHP arrays example This example shows how incoming HTML is converted to XML with the two different PHP-like Arrays options. Incoming HTML PAGE 723
dent Resulting XML structure with Enhanced PHP-like arrays email@example.
-
l 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. Note Subfolders are accepted in the structure, so if your resource folder contains a folder called faces, you could refer to a file in this folder as href="images/faces/johnsmith.jpg". l Capture OnTheGo group l l Authentication Key: Enter the authentication key for the COTG repository.
-
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. They are named lpddate.log, where date is the current date in the yyyymmdd numerical format. Note that changing this option also affects the log displayed in the PReS Workflow Service Console.
-
Note Workflow's NodeJS and ppNode folders can be found in %PROGRAMFILES%\Objectif Lune\. l l l Port: Select the port to use. The task's default port is 9090. Port numbers > 9999 are possible. Note that it is possible to use both the NodeJS Server and the standard HTTP Server simultaneously, provided that they are not set to listen to the same port. See "HTTP Server Input plugin preferences 1" on page 719. Time out: Set the timeout period in seconds. The default value is 120 seconds.
-
l l l l Key: Enter the absolute path to the Private Key File. This file generally ends with a .key extension. Password: Enter the password (or passkey) for the Private Key File. Verbose log: Select to enable to keep a verbose log. Note that a communication log is generated whether or not this option is selected. If you use a secure connection, the log will contain extra information. Disable SOAP Server: Check to disable all SOAP Server functionality.
-
Note The 'Forward all HTTP traffic to HTTPS' option (see "NodeJS Server Input plugin preferences 1" on page 725) does not affect proxies. All routes set as proxy in Workflow will be forwarded to the target specified in the proxy list. l Cross-Origin Resource Sharing (CORS) l Allowed Origins: Enter an origin (everything in a URL before the path, e.g. http://www.example.com).
-
Note The user name and password aren't part of the plugin preferences. Users will have to provide their credentials themselves and will be presented with an HTML page for that purpose. Serial Input plugin preferences Serial input plugin preferences control certain functions of the PlanetPress Serial Capture service, which in turn has a direct impact on all Serial input tasks performed by PReS Workflow on a given computer.
-
about to begin and the stop bit(s) indicates when the data byte was transferred. The start bit is always 0 to mark the beginning of the byte, but the stop bit can be a single 1, or two bits each with a value of 1. l l l Time-out: Set the time in seconds the PReS Workflow process waits for the transfer of bytes in the data file before ending the transfer of this file.
-
computer, typically one that runs only PReS Fax and the faxing application that actually sends the fax. When you change the user options on a given computer, only that computer is affected. So you should consider changing the PReS Fax user options on the computer that actually performs the PReS Workflow Fax output tasks. The changes you make to the PReS Workflow Fax plugin preferences are stored in the PReS Fax configuration file. They will be applied when PReS Fax is started.
-
- Raster resolution: 196 dpi l Windows Fax Service l l l l l l Report Failures: Select to have PReS Fax generate a report whenever the maximum number of retries for a single fax is exceeded. The error generated by the Windows Fax Service is also logged in the report. Note that when PReS Fax is unable to send a fax because an empty fax number is used as the only recipient for a document, a failure will not be reported but an error will be logged.
-
the only recipient for a document, a failure will not be reported but an error will be logged. l l l l Report Successes: Select to have PReS Fax generate a report whenever one of the faxes in the PReS Fax Job reaches its destination successfully or at least as far as the Windows Fax service is concerned. Folder: Enter or select the location of the report file. PReS Fax generates report file names automatically with the file name extension PFX.
-
l l About: Click to display an About dialog box for PReS Fax. This dialog box contains information such as the version number, whether the software is activated or the number of days remaining in the trial. Select Language: Click to select a different interface language for the PReS Fax Configuration applet. Note that this button is not displayed if you edit the PReS Fax options directly (not via PReS Workflow Configuration program).
-
Bear in mind that Image Output tasks included in a given PReS Workflow configuration can be performed by a PReS Image installation running on a different computer, typically one that runs only PReS Image. When you change the user options on a given computer, only that computer is affected. So you should change the Image user options on the computer that actually performs the Image Output tasks. The changes you make to the PReS Image user options are stored in the PReS Image configuration file (ppimage.cfg).
-
service from its Control Panel applet, this is reflected when you open the Activation dialog box by clicking this button. l l l Check for updates: Click to access the Objectif Lune website to search for updates to PReS Image. You are guided through the updating process with the PReS Workflow Update Service wizard. About: Click to display an About dialog box for PReS Image.
-
name you chose when you configured the SQL database (refer to the “Using PReSSearch with an SQL Server Database” section of the PReS Search User Guide). l Password: Enter the password required to access the database. l Test Connection: Click to verify that PReSImage can connect to the specified database. l Enforce global table creation: Select this option, as it ensures that all database users are granted access to the database.
-
l l Account name: Enter the account name of the user on the server to be able to send emails via SMTP. You must select Server requires authentication to enable this field. Password: Enter the password corresponding to the Account name of the user on the server to be able to send email via SMTP. You must select Server requires authentication to enable this field.
-
l l l Retry interval: Select the interval, in seconds, at which time PReS Workflow attempts to dispatch the job using the LPR output. This takes place only within the Max. retry period, after which the attempt ends. Keep a backup when error occurs: Select to move the job file to a local folder relative to your install folder called pplpr\error in the case of an error. LPR settings group l l Time-out: Set the time in seconds the PReS Workflow process waits when it sends jobs using the LPR protocol.
-
Editor Options The Script Editor is used to edit scripts used in Run Script tasks and the XSLT Editor is used to edit scripts used in Open XSLT action tasks (see "Using Scripts" on page 135 and "The Script Editor and XSLT Editor" on page 136). There are a number of options for the editors, which you can set via the menu: Tools > Options, in the editor. Most of the options listed below are valid for both editors. Those options which are only valid for a specific editor are identified as such.
-
l l l l l l l l l l Group undo: Select to set the undo feature of the Editor to undo the last group of editing commands entered. An editing command is defined as a mouse click, a press on ENTER, or a press on any other key. A group of editing commands is a sequence of a single type of editing command. Clear to set the undo feature to undo only the last command entered. Cursor beyond EOF: Select to make it possible to position the pointer beyond the end of the program file. Clear to prevent this.
-
l l l l Find text at cursor: Use to set the behavior of the Find dialog box. Select to automatically copy the word under the pointer into the Text to find box when you open the Find dialog box. Clear to prevent the copy. If no previous search terms appear in the Text to find drop-down list, the Editor performs the copy regardless of whether this option is selected or cleared. Block indent: Enter the number of spaces to jump for each block indent. The default is 2 and the maximum is 16.
-
and does not enforce word wrap on lines that exceed the number of characters set for it. It can be useful to indicate the right margin of the printed page, making it easy to determine whether a line of code extends beyond the printable area of the page. l l l l l l Right margin position: Enter the position of the right margin indicator, in number of characters, relative to the left margin. For example, if you enter 80, the distance from the left margin to the right margin indicator is 80 characters.
-
l l Background: Select the background color that the element highlighted in the Element list box is displayed with in the Script Editor. The color is used to highlight the element as if it was selected with the cursor. Attributes Group l l l Bold: Select to bold the element highlighted in the Element list box when it is displayed in the Script Editor. Italic: Select to italicize the element highlighted in the Element list box when it is displayed in the Script Editor.
-
l "Undo a command" on page 751 l "Redo a command" on page 749 l "Highlight a task or branch" on page 747 l "Resizing the rows and columns of the Process area" on page 750 l "Zoom in or out within Process Area" on page 751 Cutting, copying and pasting tasks and branches Using cut and paste, and copy and paste, you can move as well as duplicate tasks and branches within a given process as well as between different processes and subprocesses. To cut and paste tasks or branches: 1.
-
l l l When you cut an Input or Output task, it is replaced with an Unknown Task, that you will need to replace with another task for the process to be functional. If you cut one task or branch, then cut another one, the first one is lost and replaced by the second. Remember however that you can always undo the command to retrieve it (see Undo a Command). Tasks and branches will always appear on top of (in other words, before) the task or branch where you paste it.
-
Highlight a task or branch The Highlight command lets you toggle the background color of selected tasks and branches. Note that the highlight color may be changed via the PReS Workflow Configuration preferences. To highlight a Process Area square: 1. Use the mouse pointer to select a given square. 2. In the PReS Workflow button, click the View tab. 3. Select Highlight from the Navigate group. To remove the highlight, repeat the procedure.
-
move tasks and branches between different processes, see "Cutting, copying and pasting tasks and branches" on page 745. Replacing Unknown tasks When you move a task or branch using drag-and-drop, it typically moves from its original location to a position immediately preceding the target onto which you dropped it. But if you drop an Input task over an Unknown input task, the moved task will replace the unknown task. The same will happen if you drag an Output task over an Unknown output task.
-
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.
-
Replacing tasks, conditions or branches You can replace existing tasks either by dropping a new task on it, or by pasting another task over it. To replace an existing task with a new task, see "Adding tasks" on page 238. To replace an existing task with another existing task or its properties, see Cutting, Copying and Pasting Tasks and Branches. Note You cannot replace a task by a branch or a condition. Trying to paste or drop a branch or condition over a task will insert it before the task instead.
-
Undo a command The Undo command lets you undo most commands performed with the PReS Workflow Configuration program. To undo a command: l From the Quick Access Toolbar, choose Undo. 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.
-
Note The Quick Access Toolbar buttons cannot be moved or reordered. If you wish to reorder them, you will need to remove all the buttons and re-add them in the desired order. Removing buttons To remove a button from the Quick Access Toolbar: 1. Locate the button you want to remove in the Quick Access Toolbar. 2. Right-click on the button. 3. Select Remove From Quick Access toolbar. Moving the toolbar To move the Quick Access Toolbar below or above the Ribbon: 1.
-
The PReS Workflow Ribbon has five tabs: the Home tab, the View tab, the Debug tab, the Tools tab and the Help tab. Each one of these tabs contains a series of groups, each group holding a number of controls. l The Home tab includes the Clipboard, Processes, Variables, (PPS) Documents and Printer Queues groups. l l l l l l The Clipboard group contains the typical Windows-based editing controls: Cut, Copy, Paste, Select All, Delete.
-
l The Debug tab includes the Data, Debug and Debug Messages groups. l l l l The Data group allows to associate a sample data file to the currently selected process, as well as update or replace it, and display it in its text/PDF or Hexadecimal format. The Debug group contains the debugger's controls, allowing to execute a process step by step, skipping over or ignoring certain tasks, as well as setting up breakpoints and resetting variables values.
-
l The PlanetPress Capture group contains: l l l The Pen Manager button opens the PlanetPress Capture Pen Management Tool. The Test Page group: l l l The Document Manager button opens the PlanetPress Capture Document Manager. The PS Test Page control allows to print a Status Page for the selected printer queue. Note that if no printer queue is selected in the Configuration Components pane, the control is disabled.
-
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 SFXwhich 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).
