Objectif Lune PRes Workflow - 8.6 User Guide
User Guide
Version:8.6.1
User Guide
Version 8.6.1
Last Revision:4/12/2017
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-2017. 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. disclaims
responsibility for any errors and omissions in this documentation and accepts no responsibility
for damages arising from such inconsistencies or their further consequences of any kind.
Objectif Lune Inc. Inc reserves the right to alter the information contained in this documentation
without notice.
Table of Contents
Table of Contents 4
Welcome to PReS Workflow 8.6.1 10
Icons used in this guide 10
System Requirements 12
Operating System (64-bit only) 12
Minimum Hardware Requirements 12
Basics 13
Setting Up the Working Environment 13
Setting Up Preferences 13
Create a New Process 13
Considerations 14
Send your Configuration 14
Features 16
The Nature of PReS Workflow 16
About Branches and Conditions 16
Branches 17
Conditions 17
Configuration Components 17
Connect Resources 17
Available Resources 18
Resource Save Location 18
Resource Archives 19
About Data 19
Data File and Job File 20
Job File Names and Output File Names 21
About Data Selections 22
The Data Selector 28
AboutData Emulation 32
Using the File Viewer 33
Sample Data 33
Metadata 35
Data Repository 49
Structure 49
Page 4
Accessing the Data Repository 50
Where to find the Data Repository 51
About Documents 51
Import Documents 52
Import PrintShop Mail Documents 52
Debugging and Error Handling 53
About Error Handling 53
Using the On Error tab 53
Creating and Using Error Processes 55
Accessing the Logs 56
Resubmit Backed Up Input Files to a Process 58
Knowing What to Resubmit 59
Debugging your PReS Workflow Process 60
The Plug-in Bar 63
Categories 64
Settings & customization 64
About Printing 65
PReS Workflow Printer Queues 67
Shared Printer Queue Properties 67
Windows Output Printer Queue 69
LPR Output Printer Queue 70
FTP Output Printer Queue 72
Send to Folder Printer Queue 73
Triggers 74
Load Balancing 75
Objectif Lune Printer Driver (PS) 75
About Processes and Subprocesses 78
Processes 78
Subprocesses 79
Process Properties 79
Activate or Deactivate a Process 84
Convert a Branch to a Subprocess 84
Import Processes from Another Configuration File 85
Toggle the Run on Desktop Property 86
Using Scripts 87
The Script Editor and XSLT Editor 88
SOAP Server API Reference 94
Page 5
The Watch Object 101
Data repository API 116
Stopping Execution 134
Special Workflow processes 135
PDFworkflow 135
PlanetPress Capture workflow 136
HTTPServer workflow 136
OL Connect Send workflow 136
SOAPWorkflow 136
PlanetPress Capture Workflow 137
Database Considerations (ODBC) 143
HTTP Server Workflow 172
PDF Workflow 179
Capture OnTheGo Workflow 182
About Tasks 183
Task Properties 184
Variable Properties 184
Contextual Menu 185
Unknown Tasks 186
Masks 186
Date and Time Format 188
Input Tasks 189
Task Properties 253
Variable Properties 253
Data Splitters 347
Process Logic Tasks 374
Connector Tasks 404
PlanetPress Capture 442
Metadata Tasks 475
OL Connect Tasks 503
Output Tasks 567
Working With Variables 591
Types of Variables 591
Job Info Variables 592
Standard Variables 593
Manipulate Local Variables 598
Manipulate Global Variables 599
Page 6
About Configurations 601
Create a New Configuration 602
Open a PReS Workflow Configuration File 602
Saving and Sending 603
Exit PReS Workflow Configuration Program 605
About Related Programs and Services 606
Available Input Services 606
Available Output Services 606
Start and Stop PReS Workflow Service 608
The Interface 610
Customizing the Workspace 611
Dock and Undock Areas of the Program Window 611
Show or Hide Areas of the Program Window 613
Combine and Attach Areas 613
Resize the Program Window Areas 618
Change the Interface Language 618
PReS Workflow Button 619
Options 619
The Configuration Components Pane 621
Components Area Sections 621
Processes and Subprocesses 624
Manipulate Global Variables 632
Connect Resources 634
PPS/PSM Documents 636
Associate Documents and PReS Printer Queues 641
Using the Clipboard and Drag & Drop 642
Rename Objects in the Configuration Components Pane 645
Reorder Objects in the Configuration Components Pane 645
Grouping Configuration Components 646
Expand and Collapse Categories and Groups in the Configuration Components Pane 647
Delete Objects and Groups from the Configuration Components Pane 648
Other Dialogs 648
Activate Your Printers 648
Workflow Services 649
Process Properties 651
Advanced SQL Statement Dialog 656
Access Manager 656
Page 7
PDF Viewer 663
The PReS Workflow Service Console 666
Update document 668
Data Repository Manager 668
Virtual Drive Manager 671
The Debug Information Pane 672
The Message Area Pane 673
The Object Inspector Pane 674
The Plug-in Bar 675
Categories 675
Settings & customization 676
Preferences 677
Other Preferences and Settings 678
General appearance preferences 678
Object Inspector appearance preferences 679
Configuration Components Pane appearance preferences 680
Default Configuration behavior preferences 681
Notification Messages behavior preferences 681
Sample Data behavior preferences 684
Network behavior preferences 684
PlanetPress Capture preferences 685
OL Connect preferences 694
PDF Text Extraction Tolerance Factors 695
General and logging preferences 697
Messenger plugin preferences 697
HTTP Server Input 1 plugin preferences 698
HTTPServer Input 2 plugin preferences 701
LPD Input plugin preferences 702
Serial Input plugin preferences 703
Telnet Input plugin preferences 705
PReSFax plugin preferences 705
FTP Output Service preferences 708
PReS Image preferences 709
LPR Output preferences 712
PrintShop Web Connect Service preferences 714
Editor Options 714
The Process Area 719
Page 8
Zoom In or Out within Process Area 719
Adding Tasks 720
Adding Branches 721
Edit a Task 721
Replacing Tasks, Conditions or Branches 721
Remove Tasks or Branches 722
Task Properties Dialog 723
Cutting, Copying and Pasting Tasks and Branches 724
Moving a Task or Branch Using Drag-and-Drop 726
Ignoring Tasks and Branches 727
Resize Rows and Columns of the Process Area 728
Selecting Documents in Tasks Links 728
Highlight a Task or Branch 729
Undo a Command 729
Redo a Command 729
The Quick Access Toolbar 730
The PReS Workflow Ribbon 731
The Task Comments Pane 734
Copyright Information 735
Legal Notices and Acknowledgements 736
Page 9
Welcome to PReS Workflow 8.6.1
Note
Complementary information that is not critical, but may help you better use PReS Workflow.
Tip
Information that is useful or suggests an easier method.
This PDF documentation covers version 8.6.1. To view the documentation of previous versions
please refer to the PDF files available in the Downloads section of our website:
http://www.objectiflune.com/OL/Download/DownloadCenter.
Workflow is the heart of all of our solutions. Working in conjunction with PReS Connect, PReS
Capture, CaptureOnTheGO, PReS Imaging, PReS Fax, and a variety of plugins, it helps
improve your communications processes. Processes such as communication creation,
interaction, distribution and even maintenance.
Workflow is the "super dispatcher". It caters for inputs from a huge variety of sources, such as
email, web pages, databases, individual files (PDF, csv, XML, etc), print streams, FTP, Telnet
and even ERP systems! This data can then be analysed, modified, stored, verified, routed and
used as triggers for other processes from entirely within Workflow. Finally it is passed to one of
our other products (or not) to be outputted in multiple ways (printed, emailed, posted, archived,
sent to third party solutions, etc..).
Consider Workflow as a set of buildings blocks that enable you to build your own customised
automated processes which will fit your environment and not the other way around. Create
processes that will save you time and money!
Icons used in this guide
Icons are used throughout this guide to point your attention to certain information.
Page 10
Technical
Information that may require specific knowledge to understand.
Warning
Information that is potentially critical to using PReS Workflow. Pay close attention.
Page 11
System Requirements
Note
Windows XP, Windows 2003 and older versions of Windows are not supported by PReS
Workflow.
These are the system requirements for PReS Workflow 8.6.1.
Operating System (64-bit only)
l Microsoft Windows 2008/2008 R2 Server
l Microsoft Windows 2012/2012 R2 Server
l Microsoft Windows Vista
l Microsoft Windows 7
l Microsoft Windows 8.1
l Microsoft Windows 10 (Pro and Enterprise versions only)
Minimum Hardware Requirements
l NTFS Filesystem (FAT32 is not supported)
l CPU Intel Core i7-4770 Haswell (4 Core)
l 8GB RAM (16GB Recommended)
l Disk Space: At least 10GB (20GB recommended)
Page 12
Basics
PReS Workflow is a tool for the automation of the processing, the distribution and the printing of
your business documents. Once installed on the server, it can be set up to automate all tasks
related to document processing.
Setting Up the Working Environment
Setting up the working environment has to be done the first time you start PReS Workflow.
1. Defining the printer (see Activate Your Printers).
2. Configure PReS Workflow Services (see Workflow Services).
Setting Up Preferences
PReS Workflow Configuration program lets you configure a variety of options, from how the
application itself looks or behaves, to plugin specific options. For more information about
preferences accessible through the Preferences button in the PReS Workflow Button, please
refer to Preferences.
Create a New Process
You can create a new process in a two different ways:
l
In the Ribbon, go to the Home tab and click the Process button in the Processes group.
l
In the Configuration Components pane, right-click on any process or the Processes
folder and select Insert Process.
Regardless of the method, a new process is created with a default name (Process1, Process2,
etc), Input Task and Output Task. The defaults are configurable in the "Default Configuration
behavior preferences" on page681 screen. The same methods can be used to create a new
Startup process.
Page 13
To add a PReS Workflow startup process:
Note
You can only have one Startup Process in any given configuration and cannot add more.
l
In the Ribbon, go to the Home tab and click the Startup Process button in the
Processes group.
l
In the Configuration Components pane, right-click on any process or the Processes
folder and select Insert Startup Process.
Considerations
l While your configuration is limited to a maximum of 512 processes, any given process
can have as many tasks as necessary.
l A given process may include output tasks that generate files used by input tasks from
other processes.
l When you send a configuration to your PReS Workflow service, all its active processes
are applied.
l Each process’ schedule determines when its initial input task can be performed.
l Other tasks included in the process are performed regardless of schedule, granted that
the previous task was performed.
Send your Configuration
PReS Workflow Configuration saves entire configurations in the form of a single file. Like any
other file, configuration files may be saved and reopened, as well as rename as desired. Simply
saving a configuration has no effect on the configuration actually used by the PReS Workflow
when it is started. To change any currently active configuration, you must use the Send
Configuration command.
When you use the Send command, the PReS Workflow Configuration program uses the
currently opened configuration (Any_name.pw7) to overwrite PReS Workflow service's current
configuration (ppwatch.cfg).
Page 14
If PReS Workflow service is running when you send a new configuration, it stops and restarts
Note
If PReS Workflow service is paused when you send a new configuration, it will not stop
and restart. Since PReS Workflow service reads its configuration file when it starts up,
when you resume processing, PReS Workflow service will continue using the old
configuration.
automatically with the new configuration. If the service is stopped, it will not start automatically.
To send a Configuration to the local server:
1. Open the configuration you want to use as a new configuration.
2. Edit the configuration, if required.
3.
When the configuration is ready to be used, from the PReS Workflow button, choose
Send Configuration, then Send Local.
To send a Configuration to a remote server:
1. Open the configuration you want to use as a new configuration.
2. Edit the configuration, if required.
3.
When the configuration is ready to be used, from the PReS Workflow button, choose
Send Configuration, then Send Remote.
Alist of available servers on the local network appears.
4. Put a checkmark next to each server where the configuration should be sent.
5. Click OK.
If a server is grayed out, this may mean you do not have access to send a configuration
remotely to it. For more information, please see "Access Manager" on page656.
Page 15
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.
The Nature of PReS Workflow
PReS Workflow act as sorts of dispatchers. On the one hand, they retrieves data and controls
plugins that retrieve data from watched locations, and on the other hand they send data and
controls plugins that send data to various devices, for printing or to generate documents that
can then be emailed or faxed. PReS Workflow can also perform a variety of operations on the
data using its action plugins.
In fact, the PReS Workflow plugin based architecture enables almost limitless customization.
You can create or purchase compatible plugins, drop them in any of PReS Workflow plugin
folder and use them to perform other operations. You can even find free unsupported plugins on
the Objectif Lune Web site.
PReS Workflow are service applications, or if you will, applications that continuously run on a
given computer and that perform actions automatically. Those actions are defined in a PReS
Workflow configuration. A given computer can only run one PReS Workflow configuration at a
time. The PReS Workflow Service Console may be used to monitor the services running on a
given computer.
About Branches and Conditions
While some processes can simply start with an input task, manipulate the data with a few action
tasks and finish with an output task, in some cases you may want to have more control over the
flow of your process. For example, you may want multiple outputs, such as printing to multiple
printers as well as generating a PDFand emailing it. To do this, you will need branches. You
may also want to detect certain criteria in your data and act differently depending on that data,
such as sending a fax only when a fax number is found, or printing to a different printer
depending on who send you a print job. To do this, conditions are used.
Page 16
Branches
A branch is effectively a doubling of your job file. As your job file goes down the process, when
it encounters a branch it will go in that branch, process all tasks up to the output, and return to
the main trunk to continue processes. You can have branches within branches, and all
branches must have an output. For more information on branches, see Branch.
A branch is represented as a crossing .
Conditions
Acondition will either execute the branch it creates or the main trunk, but never both. As your
job file goes down the process, when it encounters a condition it will verify whether that
condition results in a "true"or "false"value. If the result is true, it goes in the branch, processes
all tasks up to the output, and the process finishes. If the result is false, it goes down the main
trunk and continues processing until the process finishes.
A conditional branch (or condition) is shown as a crossing with a red diamond over it .
For the list of operations you can perform on Branches and Conditions, please refer to The
Process Area.
Configuration Components
The Configuration Components items displayed in the pane are processes, subprocesses,
variables, documents and printer queues. For more information on operations that you can
perform on each component, please refer to The Configuration Components pane.
Connect Resources
Connect resources are visible in The Configuration Components pane and are added by
using the Send to Workflow option from the PReS 's File menu.
Page 17
Available Resources
Note
Package Files are not saved anywhere. The individual resources contained within the
l Data Mapping Configurations:Displays a list of data mapping configurations used with
the Execute Data Mapping task. Each of the templates have been sent from PReS
Connect using the Send to Workflow tool. For each template in the list, the following two
items appear within them:
l Data Model:Displays the data model used in the data mapping configuration.
Double-click on the data model to view it in your default XMLviewer (generally,
Internet Explorer).
l Sample Data File(s):Displays a list of sample files that are included in the data
mapping configuration. Double-click on a file to use it as a sample data file for the
active process.
l Document Templates:Displays a list of templates that can be used in content creation
tasks:"Create Email Content" on page509, "Create Web Content" on page531 and
"Create Print Content" on page527.
l Job Presets:Displays a list of Job Presets that can be used in the "Create Job" on
page513 task.
l Output Presets:Displays a list of Output Presets that can be used in the "Create Output"
on page516 task.
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 (.OL-template)
Page 18
package are extracted and placed in the folders noted above.
Resource Archives
From version 8.2, PReS Workflow maintains an archive of previous versions of resources, in
the following location:%PROGRAMDATA%\Objectif Lune\PReS Workflow 8\PReS
Watch\OLConnect\Archive , each in their own folder:
l datamapper contains archives of the data mapping configurations (.OL-datamapper)
l jobcreation contains archives of the Job Presets(.OL-jobpreset)
l outputcreation contains archives of the Output Presets (.OL-outputpreset)
l template contains archives of the templates (.OL-template)
l workflow contains archives of Workflow configurations received by the server.
The archives are saved using the template named followed by a timestamp. A maximum of 30
of each instance of a resource is kept (meaning if you have 10 different templates, a maximum
of 300 files will be present in the archive\template folder). Older archives are deleted
automatically as new archives are created.
About Data
Data is what drives your business, and our software. We define data as anything that is
obtained through an Input Task and used within the process itself. Once the data is obtained, it
becomes the job file that is passed from one task to another and generally used to generate
output.
Data can be manipulated using the tasks in the process, used as comparison for conditions and
loops, complemented with data from other sources, and used to generate your output. It
originates from many different sources (as many as the input tasks support), parts of it can be
stored in variables, and is always accessible by the task that currently handles it.
Data is referred to using Data Selections either from PReS Workflow or a PlanetPress Design
Document that is being merged with the data (for example in a printed output).
For more information about Data, please refer to "Sample Data" on page33.
Page 19
Note
Null characters present in the data may not be displayed properly when using PReS
Workflow Configuration program, and that they may also be printed differently by different
printers. To ensure consistency, you should consider filtering out such characters.
Data File and Job File
Whichever source it may come from, a serial port, an e-mail message, or an LPR request, for
instance, and whatever its format, data entering a PReS Workflow process via an input task is
always referred to as a data file. Job file is a more general term, that can refer to data files as
well as other types of files traveling through a process. Image files, for example, can be passed
from task to task in order to be downloaded to a printer. So files traveling within a process are
mostly referred to as job files.
By default, job file names are generated using the %f variable. You may change the wayPReS
Workflow names job files by using any combination of static characters, variables and Job info
variables. You could for instance enter Process_%w_Job_%f in the File name box to add the
process name in the name generated by the PReS Workflow Tools.
A single job file can be the source of multiple job files. This is the case, for example, when a
process includes multiple branches, as each branch is given a duplicate copy of the job file.
This is also the case when a job file is split into multiple smaller files by a Splitter action task,
for instance (See "Data Splitters" on page347).
It is important to note that job files may be used as a helpful debugging resource (See
"Debugging and Error Handling" on page53).
Actual Data and Sample Data
The actual data is the dynamic data captured by PReS Workflow at run-time. The sample data
file is a static sampling of the run-time data.
In the PReS Workflow Configuration program, you use sample data files to create and edit
PReS Workflow configurations.
Page 20
Job File Names and Output File Names
When an input task sends a new data file down a process, it gives it an internal file name
referred to as the job file name (associated with the %f variable). The new job file typically
keeps the same name until the end of the process.
l If the job file comes to a branch in the process, PReS Workflow makes a copy of the job
file and give the new file a new job file name.
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. In the case of Send to Folder output tasks, for example, output files are
saved under their job file names by default (using the variable %f), but you may use a static
(MyOutput.txt, for example) or variable name (%O_Invoices, for instance) of your choosing.
Variables such as %o (original file name) bring up the issue of file overwriting. If the process
receives two source files with the same name, the second output file may overwrite the first one.
This may be what you want, but otherwise you may consider using another variable, such as in
%u (unique 13-character string).
When choosing naming schemes for output files, consider the following:
l For the benefit of users who must identify files, be it in a folder or on a printer queue,
consider using names that are as meaningful and precise as possible.
l Some devices or applications may use file name extensions to know what to do with
incoming files.
Since variable properties can be entered in the boxes where you specify the folder and file
names, you can use variables, data selections and static text. You could, for example, use the
following: ClientID_@(1,1,1,1,14,KeepCase,Trim)_StatMonth_%m.
One last consideration regarding output file names has to do with standard JPEG and TIFF files
generated by PReS Image. When an output job contains multiple pages, multiple JPEG or TIFF
files are generated (one image per file), each one identified by a sequence number appended
to its name (this is managed by your PReS Workflow). A three page job to be called Invoice, for
Page 21
example, will generate three JPEGs or TIFFs called Invoice0, Invoice1 and Invoice2. Note that
Note
You can change the name of a previously named file using a Rename action task (see "Rename"
on page317).
this does not apply to multiple TIFFs, which can include multiple images in a single file.
About Data Selections
A data selection could be compared to an address. It indicates a location within a data file
using coordinates. PReS Workflow includes a tool called the Data Selector that helps you
make data selections. The Data Selector does two things:
l It uses the current emulation (either the emulation chosen when the sample data file was
selected, or the one chosen in the last Change Emulation action task appearing above
the current task) to format the data.
l It displays the formatted data to let you make selections easily using the mouse pointer.
The Data Selector is essentially the same as the one used in PlanetPress Design.
Data selections
A data selection could be compared to an address. It indicates a location within a data file or
database (the job file, metadata file, or Data Repository).
Data selections are always evaluated at run-time so they are always dynamic and depend on
the job file that is currently being processed.
There are several types of data selections you can use, depending on which emulation you are
using, whether or not Metadata have been created by a previous task in the process, and
whether or not data have been entered in the Data Repository.
Adding a data selection
A data selection can be used in any task property that may contain a variable. These properties
are recognizable by their colored field label (maroon, by default). Right-click the property field
and choose Get Data Location or Get Metadata Location to open the Data Selector (see "The
Page 22
Data Selector" on page28) or Get Repository Location to open the Data Repository Manager
Note
The Get (...) Value options will also open the Data Selector or the Data Repository Manager, but
once selected, the value becomes static and does not change between each datapage and job file.
(see "Data Repository Manager" on page668).
After opening a sample of the data and/or metadata, you can easily make a selection.
It is also possible to manually enter a data selection, or to change it after making a selection
with the mouse pointer.
Wild card parameter "?"
Data/metadata selection functions accept a wildcard parameter "?", indicating the function
operates on allnodes (not just one) of a given level.
Examples
l In a PDF emulation, the format of a selected region could be:
region(?,0.59375,2.21875,1.85416,2.51041,KeepCase,NoTrim)
In this case “?” represents the current physical data page processed by the task.
l In the following rule, the Metadata selection function loops through all datapages in a job,
comparing their index in the document to a value:
(GetMeta(SelectedIndexInDocument[0], 11, Job.Group[?].Document
[?].Datapage[?]) Equal 0
l In the following rule, the question mark in the text-based data selection represents the
current page number:
(@(?,1,1,1,9,KeepCase,NoTrim) IS EQUAL TO Page 1 of)
Text-based data selections
Text-based selections are used for text data files such as Line Printer, ASCIIand Channel Skip
emulations. The selection refers to a rectangular selection that may contain multiple lines, rows,
columns on a given page.
Page 23
Syntax
@(page number, from line, to line, from column, to column, case option, trim
option)
Here is a breakdown of the syntax (all options are mandatory):
l @():Always surrounds a data selection.
l Page Number:The data page number from which you want the data selection to grab the
data. If you want to get data from each page individually, this has to be done after a
splitter.
l From Line:The starting line of the data selection.
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
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.
l Trim Option:Can either be "Trim"if you want to trim empty spaces before and after the
data selection or "NoTrim"if you want to retain the extra spaces.
Alternate Syntax
@(line number, from column, to column)
The alternate "quick"syntax lets you grab data from a single line from the first data page in the
file. Here is a breakdown of the syntax (all options are mandatory):
l @():Always surrounds a data selection.
l Line Number: The line from which to get the data.
l From Column: the leftmost character position of the data selection.
l To Column: the rightmost character position of the data selection.
Page 24
Database data selections
These selections are used for database-driven data files such as Database and
CSVemulations. The selection refers to a specific field on any given data page.
Syntax
field(record set number, child number, field name, treatment of character case,
treatment of empty trailing cells)
Here is a breakdown of the syntax (all options are mandatory):
l field():Always surrounds database field selections.
l Record Set Number: The data page (or "record") of the data selection.
l Child Number:Line Number in the record (if there are multiple lines returned for one
single record).
l Field Name: The name of the field you want to retrieve.
l Case Option: This can be one of three options:
l KeepCase:Keeps the current uppercase and lowercase letters as they are.
l UpperCase:Converts all letters to their uppercase equivalent.
l LowerCase:Converts all letters to their lowercase equivalent.
l Trim Option:Can either be "Trim"if you want to trim empty spaces before and after the
data selection or "NoTrim"if you want to retain the extra spaces.
Data 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 page668. 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):
Page 25
l group:The name of the group in which to retrieve the value. Does not need to be
surrounded by quotes.
l return key:The name of the key where the information you want to retrieve is located.
Does not need to be surrounded by quotes.
l lookup key:The name of the key in the group with which to look up the value. The return
key of the KeySet in which the lookup key's value matches the lookup value will be
returned.
l lookup value: A string surrounded by quotes which will be used in the lookup.
PDF data selections
These selections are used for PDF data files. The selection refers to a specific area of any
given page of the PDF by using precise region coordinates (in inches).
Syntax
region(page, left, top, right, bottom, case option, trim option)
Here is a breakdown of the syntax (all options are mandatory):
l region():Always surrounds PDFdata selections.
l Page:The page of the PDFfrom which to retrieve the data.
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 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.
l Trim Option:Can either be "Trim"if you want to trim empty spaces before and after the
data selection or "NoTrim"if you want to retain the extra spaces.
Metadata selections
Metadata selections are used with any type of emulation, as long as a metadata file was
created by a previous task in the process.
Page 26
Note
To get a sample of the metadata file, debug your process and step through it until the option 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 metadata sample file in the Data
Selector.
Syntax
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.
GetMeta(Field Name [, Option Flags, Metadata Path])
Here is a breakdown of the syntax:
l GetMeta():Always surrounds metadata selections.
l Field/Attribute Name:specifies the name of the field (or attribute, if the GetAttribute
option flag is set) to retrieve (see "Metadata" on page35).
l Option Flag (optional):Sets the options for the selection (see table below).
l Metadata Path (optional):Defines the precise path where the Metadata Field is located.
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'.
Page 27
Name Value Behavior
GetAttribute 1 Search for the name argument in the attribute collection
instead of the default field collection. See: "Metadata" on
page35.
NoCascade 2 Search only the level specified by the path argument
(defaults to Page level when path argument is empty),
instead of default behavior, going from the Page level to
the Job level.
FailIfNotFound 4 Raise an error and crash the job is the specified name is
not found instead of returning an empty string.
SelectedNodesOnly 8 Returns values from the selected nodes only.
The Data Selector
The Data Selector is the tool you use to choose your sample data and metadata files, to select
the appropriate emulation, make data selections, and to stabilize your data.
The Data Selector is divided in two tabs:Data and Metadata. The Data tab contains the Data
Options, which let you select your emulation, and the Selector Options, which lets you
personalize the data selector's display options (see Data Selector Display Preferences)
Page 28
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
the Emulation section)and a grid-like display of each character on each line. The following
emulations however, will be slightly different.
Database Emulation
l
The Database emulation changes the Browse button( ) for the Database Emulation
Configuration button ( ), which displays the Database Emulation Configuration (see
Database Emulation).
l
Once a database has been opened and query entered, the Data pane displays the results
of the SQLQuery in a grid format, which each line representing a single returned row from
Page 29
the database. Each column represents a field returned by the query, with its field name as
a row header.
XMLEmulation
l XMLdata is represented in a tree structure which corresponds to the data in the XMLfile.
Each node of the XMLcan be expanded to see the nodes under it. See XML Data
Emulations.
PDF Emulation
l
If you use a PDF emulation, the Data pane displays the data as you would see it in any
PDFreader.
l A new zoom drop-down list is displayed to let you set the zoom in percentage or fit the
PDFto the window or the width of the window.
l A new status bar, displaying the (Left, Top) and (Right, Bottom) coordinate pairs, is shown
under the Data pane.
Page 30
Loading...