Xerox FreeFlow User Manual
FreeFlow
V ersion 5.0, July 2006
™
VI PDF Originator
User’s Guide
©2006 by Xerox Corporation. All rights reserved.
Xerox®, FreeFlow
™
and all identifying numbers used in connection with the products mentioned in this publication are trademarks of
XEROX CORPORATION. GlossMark® is a Registered Trademark of XEROX CORPORATION. Copyright protection claimed includes
all forms and matters of copyrightable material and information now allowed by statutory or judicial law or hereinafter granted, including
without limitations, material generated from the software programs which are displayed on the screen such as styles, templates, icons,
screen displays looks, etc.
While every care has been taken in the preparation of this material, no liability will be accepted by Xerox Corporation arising out of any
inaccuracies or omissions.
Microsoft, Windows, Windows 2000, and Windows XP are registered trademarks of Microsoft Corporation.
Macintosh is a registered trademark of Apple Computer, Inc., registered in the US and other countries. Elements of Apple's Technical
User Documentation used by permission from Apple Computer, Inc.
PostScript is a registered trademark of Adobe Systems Incorporated. All instances of the name PostScript in the text are references to
the PostScript language as defined by Adobe Systems Incorporated unless otherwise stated. The name PostScript also is used as a
product trademark for Adobe Systems' implementation of the PostScript language interpreter, and other Adobe products. Adobe,
Acrobat, Distiller, Illustrator, InDesign, and Photoshop are registered trademarks of Adobe Systems, Inc. This product is not e ndorse d
or sponsored by Adobe Systems, publisher of Adobe Photoshop.
All other product names and services mentioned in this publication are trademarks or registered trademarks of their respective
companies. They are used throughout this publication for the benefit of those companies, and are not intended to convey endorsemen t
or other affiliation with the publication.
Companies, names, and data used in examples herein are fictitious unless otherwise noted.
This publication and the information herein are furnished AS IS, subject to change without notice, and should not be construed as a
commitment by Xerox Corporation. Xerox Corporation assumes no responsibility or liability for any errors or inaccuracies, makes no
warranty of any kind (expressed, implied, or statutory) with respect to this publication, and expressly disclaims a ny and all warranties
of merchantability, fitness for particular purposes, and non-infringement of third party rights. Changes are periodically made to the
document contained herein. Changes, technical inaccuracies, and typographic errors will be corrected in subsequent editions.
Produced in the United States of America.
Table of contents
Using VI PDF Originator 7
VI PDF Originator....... .......................................... ... .......................................... ..................8
The VIPO Server and Client ........................................ ................. ................ ............. ...........9
Using the VIPO Local Server..............................................................................................10
File menu options..................................................................... ... .... ......................11
Accounting file format.................................................................................11
Job Selection menu options....................................................................................12
Help menu options............................. .... ... ... .......................................... ................12
Using the VIPO Job Submission Client................................................................................13
Window elements.................................................. ... ... .... ......................................13
Job creation area field descriptions....................................................................... ...15
Profile files................................................................................................18
Specifying PDF outpu t file names............................................................................19
Template syntax ................................. .......................................... .............19
Examples ........ ................ ................ ................ ................ ................. .........21
Template field descriptions.................................... ... ... ... ... .... ... ...................21
Specifying an index file...........................................................................................23
Template syntax ................................. .......................................... .............24
Examples ........ ................ ................ ................ ................ ................. .........26
Template field descriptions.....................................................................................27
Using the VIPO Watched Folders Client............................................... ................ ................28
Window elements.................................................. ... ... .... ......................................30
Adding watched folders....................................................................... ... ... .... ... ... ...31
File ready check....................................................... ... .... ... ... ... ... ..........................32
Command line options for the VIPO Watched Folders Client................... ................ ...33
Bulk Processing................................................................................................................34
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-3
Table of contents
Using VIPO Web 35
Accessing VIPO via your web browser.................................................................................35
Job Submission/View/Retrieval.................................... .......................................... .............37
Job Submission - upper frame................................................................. ... .... ... ... ...37
Job Submission - lower frame............. .... ... ... ... .... ... ... .......................................... ...40
Change Password................................................... .......................................... ... .............42
Administration.................. ................. ................ ................ ................ ................ ............. ...42
User Administration................................................................................................43
Changing passwords..................................................................................44
Adding new users ............................... .... ... ... ... .... ......................................44
Assigning users to groups...........................................................................44
Server Administration...... ... .......................................... ..........................................45
Cluster Administration...................................................... ... ...................................47
Basic Authentication Quick Step..............................................................................51
Disable Basic Authentication................................................................ ...................51
Web browser notes............................................................... ... .... ......................................52
Using VIPO and Adobe Distiller 53
PDF security options..........................................................................................................53
Adobe Distiller and fonts ................................ ................. ................ ................ ................ ...55
Acrobat Distiller versions prior to 6.0........................................ ................ ................55
Acrobat Distiller 6.0 and later ..................................................... ................ .............55
Assigning a Distiller job options file............................ ............. ................ ................ .............56
Using BOOKMARK, PDF features, and Project Containers 57
Using the VIPP BOOKMARK command.................................. ... .... ... ... ... ... ..........................57
Extended bookmarks .............................................................................................58
Using VIPP PDF interactive features...................................................................................59
Using VI Project C ontainers................................................................................................59
Using lpr to submit VIPO jobs 61
lpr command syntax for Windows 2000................................................................................61
Parameter definitions..................................... .......................................... ..........................62
Parameter defaults............................... ... ... ... .... ... ... .......................................... ................63
Example lpr job submissions ..............................................................................................63
VI PDF Originator User’s Guide
VIPO-4 FreeFlow Variable Information Suite 5.0 (7/2006)
Table of contents
Using VIPO Dispatch 65
Dispatch filters..................................................................................................................66
Dispatch Rule files.............................................................................................................67
System built-in macros.............. ... .......................................... ................................74
Rule file variable references....................................................................................74
Special Character Se quences in CSV and XML I ndex Files...................................................75
VIPO Dispatch window.......................................................................................................76
Pending Jobs........................................................................................................77
Eligible Jobs..........................................................................................................78
Conflict Jobs......................... ... ... ... ... .......................................... ..........................79
Ineligible Jobs...... .... ... ... ... .... ... .......................................... ... ................................79
Held Jobs ...................... ... .... ... ... .......................................... ................................80
Completed Jobs ....... ... ... ... .... ... ... ... .......................................... .............................80
File menu.............................................. ... ... ... .......................................... .............81
Edit menu.............................................................................................................82
IncomingFolders Filters ..............................................................................82
AutoRun Filters..........................................................................................84
Dispatch Rules ..........................................................................................86
Trace menu...........................................................................................................88
Using VIPO Dispatch - a simple example.............................................................................89
Using VIPO Services 97
Definitions ........................... ............. ................ ................ ................ ................ ................97
VI PDF Originator Server........................................................................ ................97
VI PDF Originator Service............................................. .... ... ...................................98
Constraints................................ ................ ............. ................ ................ ................. .........98
FreeFlow VI PDF Originator Secure Web Service.................................................................98
Index 99
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-5
Table of contents
VI PDF Originator User’s Guide
VIPO-6 FreeFlow Variable Information Suite 5.0 (7/2006)
Using VI PDF Originator
This User’s Guide is designed to provide information about how to use a properly installed
version of the FreeFlow VI PDF Originator (VIPO). For information about installing or
updating the software refer to the Variable Information Suite Installation Guide
(VISInstallation.pdf) provided a s a part of the FreeFlow VI Suite Docum entation CD
included in the VI Suite Ship kit.
“Using VI PDF Originator” describes the VI PDF Originator, and explains how to use VIPO
features, menus, and dialo gs. These topics are cove red:
• VI PDF Originator
• The VIPO Server and Client
• Using the VIPO Local Server
— File menu options
— Accounting file format
— Job Selection menu options
— Help menu options
• Using the VIPO Job Submission Client
— Window elements
— Job creation area field descriptions
— Specifying PDF output file names
— Specifying an index file
— Template field descriptions
• Using the VIPO Watched Folders Client
— Window elements
— Adding watched folders
— File ready check
• Bulk Processing
NOTE — SOFTWARE SUPPORT
The VI PDF Originator supports Acrobat Distiller 5.x, 6.x and Acrobat
Distiller Professional 7.0. The VI PDF Originator does not support
Acrobat Elements 7.0
Beginning with version 4.0, VIPO is not supported on Solaris systems.
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-7
VI PDF Originator
VI PDF Originator is a client/server application that allows you to generate Adobe PDF
documents from VIPP-based variable data applications and forward them to other
processes within your environmen t. VIPO extends the VIPP workflow into electronic
distribution and archive by providing the ability to generate Adobe PDF files from the
same data files sent to a VIPP-enabled print device. The PDF files, along with information
from the data record that produced them, can then be passed to a user defined process
using the VIPO Dispatch module. Th e files can be integ rated into proc esses within y our
environment, which can include E-mail servers or archive systems. In additio n, the VIPO
Server can forward the data submission file to an identified VIPP-enabled print device for
hard copy output.
A standard VIPP application that is submitted to a VIPP-enabled print device can be
submitted directly to the VI PDF Originator server. No changes in the data or VIPP
resources are required. VIPP resources are installed on the VIPO Server just as they a re
installed on a printer disk. VIPO uses the same resource management structures.
VIPO operates like any other VIPP-enabled printer. A job submitted to the print device
using lpr can use the VIPO lpr client to submit to VIPO. In addition , VIPO provides three
other job submission clients:
• Watched Folder client
• Web submission client
• Job Submission client
A VIPP job processed by the VIPO Server results in the generation of an Adobe PDF file.
This PDF file will be output to a named directory on the server. A print path can also be
specified. The data file processed by VIPO will be forwarded to the print device after
being processed by VIPO. This allows both electronic and hard copy printing from a single
job submission.
Any job that uses the VIPP BOOKMARK command can be further enhanced to create
individual sets of PDF files. For example, a statement run containing 10,000 customer
records can be split into 10,000 individual variable length customer PDF statements.
These PDF files, along with additional information contained in the bookmark, can be
dispatched to a “user defined” process that may include, but is not limited to, web
presentment, archive or viewing systems, all without making any changes to the data or
your workflow.
PDF Interactive features such as PDF Bookmarks, PDF notes, or URL's, can be added to
the PDF output file using the VIPP SETPIF command. In the statement example above
several additional PDF bookmarks can be set to guide the user to different sections within
the statement. PDF notes can be placed in the PDF file and a URL can be inserted into
the PDF that can link the user to additional web sites.
NOTE
This book, which is part of the FreeFlow VI Suite Documentation,
describes the VI PDF Originator and provides information on using VI
PDF Originator and its features. For instructions on installing VI PDF
Originator or any other VI Suite information, refer to the appropriate
book, which can be located from the FreeFlow VI Suite Documentation
“Master Table of Contents.”
VI PDF Originator User’s Guide
VIPO-8 FreeFlow Variable Information Suite 5.0 (7/2006)
The VIPO Server and Client
A VIPO Server must be running and accessible by the Job Submission Client in order for
VIPP jobs to be processed via VIPO. Each VIPO Server automatically starts when the
workstation on which it is installed boots, and it subsequently runs as a background
process.
You can tell a VIPO Server is running by the presence of its icon in the Windows task bar
(by default, this is in the lower-right corner of the desktop). Right-click the VIPO Local
Server icon to display these options:
• Launch Job Submission Client — Select this option to open the VI PDF Originator
Job Submission Client window.
• Launch Watched Folders Client — Select this option to open the VIPO Watched
Folders Client window. For more information on the VIPO Watched Folders feature,
see “Using the VIPO Watched Folders Client.”
• Launch Web Server — Select this option to open the VI PDF Originator Web Server
Window. For information on the VIPO Web Server, see “Using VIPO Web.”
• Launch Secure Web Server — Select this option to open the VI PDF Originator
Secure Web Server Window. For information on the VIPO Secure Web Server, see
“Using VIPO Web.”
• Launch Dispatcher — Select this option to open the VI PDF Originator Dispatch
Window. For information on the VIPO Dispatch option, see “Using VIPO Dispatch.”
• Restore VI PDF Originator Local Server — Select this option to maximize the VI
PDF Originator Local Server window, allowing access to more Server options.
• Exit — Select this option to exit the Server. If you exit the Server, VIPO jobs will not
be processed by that workstation until the Server is restarted. You can restart the
Server from the workstation's Start menu (Start > Programs > VI PDF Originator >
Start VI PDF Originator Server).
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-9
Using the VIPO Local Server
The VI PDF Originator Local Server w indow provid es access to the File, Job S election,
and Help drop-down menu options.
You can maximize the VIPO Local Server window in one of two ways:
• By double-clicking its task bar icon
• By right-clicking its task bar icon, then choosing Restore VI PDF Originator Local
Server from the menu
Clicking the X button in the upper right corner of the window does not cause the Server
to exit; instead, it minimizes the Server (that is, it returns to the task bar icon). Jobs will
still be processed.
To exit the VIPO Local Server, either select Exit from the File drop-down menu or select
Exit from the task-bar icon's right-click menu.
VI PDF Originator User’s Guide
VIPO-10 FreeFlow Variable Information Suite 5.0 (7/2006)
File menu options
These options are available from the File drop-down menu:
• Hide Server — Returns the VIPO Local Server window to a task-bar icon.
• Pause Server — Pauses/unpauses the Server. You must pause the Server before
dumping an accounting file.
• Save Logfile — Used when reporting software problems.
• Clear Logfile — Used when diagnosing software problems.
• Dump Accounting File — Saves accounting information to a file, then clears. See
“Accounting file format” for a list of fields included in accounting files.
• Show Billing Meters — Tracks the number of pages distilled, pages split, and PDF
files generated on the Server.
• Exit — Exits the Server; jobs will not be processed.
Accounting file format
The accounting file is a field delimited format file. There is no header on the accounting
file. Each record in the accounting file is delimited with commas. These fiel ds are included
in each record:
• VIPO Server Name
• User Name
• Input Job Name
• Distill Start Date
• Distill End Date
• Distill Start Time
• Distill End Time
• Distill CPU Time Used — in seconds (this field is not yet available)
• Distill Result — “Completed” or “Failed”
• Distill Message — empty if Result is “Completed,” otherwise within double quotes
• Number Distill Pages
• Distill PDF Name
• Split Start Date
• Split End Date
• Split Start Time
• Split End Time
• Split CPU Time used — in seconds (this field is not yet available)
• Split Result — “Completed” or “Failed”
• Split Message — empty if result is “Completed,” otherwise within double quotes
• Number Split Pages
• Number Split Files
The following is an example accounting file record:
MYSERVER,John_Doe,bigjob.ps,2001-09-18,2001-09-18,16:35:39,16:36:19 ,0,
Completed,,1060,bigjob.pdf,2001-09-18,2001-09-18,16:36:20,16:37:0 5,0,
Completed,,1060,1060
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-11
In addition to the standard Server Accounting file created when you select Dump
Accounting File from the File menu on the VIPO Local Server window, a corresponding
XML-formatted Accounting file is also created automatically. Both accounting files have
the same filename except for the file extension (*.acct and *.xml).
The following is an example of an XML-formatted Accounting file.
<?xml version="1.0" encoding="ISO-8859-1" ?>
<XVTPAF Version="0.1">
<XVTPDOC>
<XVTP_Server_Name>XRX-MAVILES-W2K</XVTP_Server_Name>
<User_Name>maviles</User_Name>
<Input_Job_Name>credit.vpc</Input_Job_Name>
<Distill_Start_Date>2002-07-16</Distill_Start_Date>
<Distill_End_Date>2002-07-16</Distill_End_Date>
<Distill_Start_Time>01:14:45</Distill_Start_Time>
<Distill_End_Time>01:14:53</Distill_End_Time>
<Distill_CPU_Time_Used>0</Distill_CPU_Time_Used>
<Distill_Result>Completed</Distill_Result>
<Distill_Message />
<Number_Distill_Pages>14</Number_Distill_Pages>
<Distill_PDF_Name>credit.pdf</Distill_PDF_Name>
<Split_Start_Date>2002-07-16</Split_Start_Date>
<Split_End_Date>2002-07-16</Split_End_Date>
<Split_Start_Time>01:14:53</Split_Start_Time>
<Split_End_Time>01:14:53</Split_End_Time>
<Split_CPU_Time_Used>0</Split_CPU_Time_Used>
<Split_Result>Completed</Split_Result>
<Split_Message />
<Number_Split_Pages>14</Number_Split_Pages>
<Number_Split_Files>8</Number_Split_Files>
</XVTPDOC>
</XVTPAF>
Job Selection menu options
Select one of these options from the Job Selection drop-down menu to determine the
order in which the VIPO Server processes jobs:
• First In First Out (FIFO)
• Shortest Job First (SJF)
• Longest Job First (LJF)
The length of a job is based on the size of the VIPP file submitted for processing.
Help menu options
These options are available from the Help drop-down menu:
• VIPO Help — Provides access to the online help facility.
• About — Displays the VIPO Server version information.
VI PDF Originator User’s Guide
VIPO-12 FreeFlow Variable Information Suite 5.0 (7/2006)
Using the VIPO Job Submission Client
You can use the VI PDF Originator Job Submission Client window, shown below, to select
and configure a job for submission.
Window elements
The VI PDF Originator Job Submission Client window consists of these elements:
Title bar
Displays the product name.
Menu bar
Provides access to the File and Help menus.
The File drop-down menu provides access to the Exit option. Select this option to close
the Job Submission Client window. Closing this window while a job is in progress will not
cancel the job; it will continue to process to completion unless explicitly canceled.
The Help drop-down menu provides access to the About option, which displays the
version information of the VIPO Job Submission Client.
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-13
Job creation area
Contains the fields necessary to select and configure a job for submission. See “Job
creation area field descriptions” for a description of each of the fields.
VIPO job status area
Provides the status of each job submitted, including the number of pages distilled and/or
split, and the number of files split.
When a job submission has been successfully completed, the PDF do cuments generated
can be found and viewed using Acrobat Reader by selecting the job folder entry in the
Job Status list and double-clicking to invoke a File Selection dialog. If Acrobat Reader is
not present or the file cannot be opened, an error message will be displayed.
NOTE
Acrobat Reader is not supplied with VIPO. It can be obtained from the
Adobe website at www.adobe.com.
Function buttons
These buttons appear at the bottom of the VIPO Job Submission Client window:
• View Current Session Jobs/View All Pending Jobs/View All Jobs — Choose to view:
— Current session jobs that are submitted only within the current session
— All pending jobs from the currently selected user's folder that have not yet been
processed and completed, or whose Cancel requests have not yet been
acknowledged by the Server, whether the jobs were submitted before or after
the current session began
— All jobs from the currently selected user's folder, whether they were submitted
before or after the current session began
• Cancel Selected Job — Click this button to cancel your job during processing.
Select your job in the VIPO job status area before clicking this button. Depending on
the job processing status at the time of cancella tion, the job may run to completion
before the cancellation request is initiated by VIPO.
Multiple jobs can be selected and a request to cancel them as a group can be
submitted. By default, you can cancel only the jobs from your own folders and from
the folders of the “default_user.” Use one of these valid settings in the VIPO
Configuration file (xvtp.ini) to change the default:
— ## User may cancel jobs ONLY from his own folders ##
jsc_cancel_job_scope=1
— ## User may also cancel jobs from the folders of “d efault_user ” ##
jsc_cancel_job_scope=2
— ## User may also cancel jobs from any other users' folders ##
jsc_cancel_job_scope=8
VI PDF Originator User’s Guide
VIPO-14 FreeFlow Variable Information Suite 5.0 (7/2006)
NOTE
Job cancellation requests are only submitted by the client; in order for
jobs to be cancelled they mus t be proces sed by the VIPO Server. A
cancellation request submitted by the client while the Server is not
running, or is in a paused state, will not be processed until the Server is
executing a VIPO job.
• Job Name and Job Status column headers — Left-click either of these headers to
sort the list of jobs.
— Left-clicking Job Name sorts the job list by the job name or by the job date/time
stamp, in ascending or descending order, one sorting type per mouse left-button
click in the following sequence:
– Sort by Job Name, alphabetic ascending order (A to Z, from top)
– Sort by Job Name, alphabetic descending order (Z to A, from top)
– Sort by Date/Time stamp, ascending order (la test at the bottom)
– Sort by Date/Time stamp, descending order (latest at the top) (default)
— Left-clicking Job Status sorts the job list alphabetically based on the status
string in ascending or descending order, one sorting type per mouse left-button
click.
• Submit Job — Click this button to submit your job after completing the appropriate
fields in the job creation area.
• Help — Click this button to access the VIPO online help facility.
Job creation area field descriptions
The following fields/buttons are located in the job creation area of the VIPO Job
Submission Client window.
Data File
Enter the name of the data file, or use browse to locate the VIPP data file (or print file) to
be submitted. This can be a VIPP line mode, database mode, native mode, or XML mode
print file (.lm, .dbf, .nm, .xml); a VI Project Container (.vpc); or a PDF file with bookmarks.
Init (Nub) File
Enter the name of the init file to be used when processing the job. This file must be
specified for each “raw” data file (one without a VIPP preamble su ch as START LM. For
these jobs, the init (nub) file supplies the appropriate VIPP preamble.
Current Profile
Optional. Load or save a profile using the Load Profile or Save Profile buttons. Profiles
are sets of previously used job submission options, which save you from re-entering the
data. The default folder for loading and saving profiles is the Profiles folder belonging to
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-15
the current VIPO user (as selec ted in the J ob Submission C lient dialog). However, you
may browse any other directories on the VIPO Client system for loading or saving profiles,
including the virtual printers profile directory loca ted in the VIPO<server_root>/Profiles
folder.
For more information, see “Profile files.”
Job Type
Select one of these job types:
• Distill Only
• Distill and Split into Pages — Requires that bookmarks be present in the VIPP job
(via the BOOKMARK command). If bookmarks are not present in the VIPP job, the
job will be processed successfully, however, no splitting will occur.
• Split into Pages Only — PDF files that must contain one or more bookmark.
User Name
Enter the user name. This will most often be the logon name of the current user
(default_user is used by lpr and is not normally used from within the Job Submission
Client).
Job Server
Select either local (Server is installed on your local workstation and is using your
workstation's CPU and disk resources) or remote (use a network VIPO Se rver's CPU and
disk resources).
Output Folder
Select the destination folder for the job. These are “ nam ed” fold ers, me aning tha t you do
not browse for a path on your disk(s), but choose from named directories that you or an
administrator already created in a special pre-designated location under control of the
VIPO Server.
Printer Action
Conditional action of optional job printing is selected. Select one of these options:
• print_always — Sends the job to the selected printer no matter what the outcome
of the VIPO job submission.
• print_if_job_completes — Sends the job to the selected printer only if it
successfully completes to VIPO.
Printer for VIPP Job Output
Specify the printer for printing the job that was submitted to VIPO for processing. If you
do not want the job to print, select none.
Only PostScript printers will be listed. You must ensure that the VI Interpreter is installed
on the printer selected for VIPP job output, a s well as any resources the VIPP job may
need.
VI PDF Originator User’s Guide
VIPO-16 FreeFlow Variable Information Suite 5.0 (7/2006)
Output Filename Template
Select a pre-defined Output Filename template from a drop d own list o r create an Output
Filename template using the Output Filename template wizard. The template you select
will be applied to the job being processed. The output file name of the PDF files being
produced will be controlled via this Output Filename template.
This option is only available when the VI PDF Originator Job Type option is set to “Distill
and Split into Pages” or “Split into Pages Only.”
For more information on this option, see “Specifying PDF output file names.”
Index File Template
Select the default index template or define an Index file template using the Index template
wizard. The Index template will be applied to the job being processed. Use the Index
Template wizard to add additional fields, from the VIPP BOOKMARK, to the index file
generated by VIPO when the job type option is set to “Distill and Split into Pages” or “Split
into Pages only.” VIPO generates a comma separated and an XML index file. The index
files are used by VIPO Dispatch, or other third party components, to identify individual
PDF records and additional data contained in the BOOKMARK for that record, for
example, an e-mail address, location ID or printer address.
This option is only available when the VIPO Job Type option is set to “Distill and Split into
Pages” or “Split into Pages Only.”
For more information, see “Specifying an index file.”
NOTE
The PDF filename is based on the name of the data submission file.
When using the “Distill Only” Job Type, the output PDF filename uses the
data submission filename as the output PDF filename. If a single “.”
character is included as part of the data file filename, VIPO considers this
a file extension and replaces this information with the .pdf file extension.
If the “.” character is a part of the filename, you must include an
additional “.” character followed by at least one other valid character. The
second period character will be treated as the file extension. VIPO
replaces this with the .pdf file extension, and maintains the first period in
the filename.
For example, if the submission filename is:
• P31199-SS.234, the resulting PDF filename is P31199-SS.pdf
• P31199-SS.234.xx, the resulting PDF filename is P31199-SS.234.pdf
Using the other Job Type options allows you to use the Output Filename
Template. When doing so, the value “DFNAME,” or the option “Add Data
Filename,” result in the same filename as the job submission data file
being used as part of the filename template.
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-17
Profile files
A Profile file must contain the necessary job parameters for the VIPO job submitted via
lpr. The table below lists the valid job parameters.
Job parameter Parameter default Parameter description
InitFile=text No default (Optional) VIPP startup file that
prepends to the submitted data file.
JobType=text distill_only Valid values are:
• distill_only
• distill_and_split into PDF files
• split_only into PDF files
OutputFolderName=text Default Folder location of the VIPO job output.
OutputFilenameTemplate=text <DFNAME><DIGITS=6>.pdf Controls the name(s) created for the
PDF output file(s).
IndexFileTemplate=text <FS=’:’>FileName:InputFile:
EndSplitDate:EndSplitTime:
OutputDir:Pages:
FileSequence:Bookmark
PrinterName=text None Specifies the printer for printing the job
PrinterAction=print-action print_if_job_completes Conditional action if optional job printing
DistillJobOptions=filename Default filename is an existing Acrobat Distiller
Controls header creation and bookmark
extraction in the index file that is
generated as part of the VIPO
file-splitting output.
submitted to VIPO for processing. If you
do not want the job to print, select none.
Ensure that VI Interpreter is installed on
the printer selected for VIPP job output,
as well as any resources the VIPP job
may need. Only PostScript printers will
be listed.
is selected. Select one of these options:
print_always — Sends the job to the
selected printer no matter what the
outcome of the VIPO job submiss ion.
print_if_job_completes — Sends the
job to the selected printer only if it is
successfully completed by the VIPO
server.
job options file. See “Assigning a
Distiller job options file“
The default location for loading and saving the profiles is your user Profiles directory.
However, you may select any other directory on the Clie nt for loading and saving profiles,
including the virtual printers profile directory located in VIPO <server_root>/profiles.
VI PDF Originator User’s Guide
VIPO-18 FreeFlow Variable Information Suite 5.0 (7/2006)
Specifying PDF output file names
You can use a template to specify how PDF file names are formatted during the PDF split
operation. To create a template, click Create Template next to the Output Filename
Template field on the VIPO Job Su bmission Clien t window. Th e Create an O utput
Filename Template window appears.
Template syntax
Template syntax must be enclosed within matching < >. All other char acters, other th an
characters that are invalid for file names and those described here, are treated as literal
characters in the resulting output file name generated by VIPO.
By default, “strict filename checking” is performed on filename templates. These
characters are considered invalid:
\ / : * ? " < > | ' ` ~ ! $ ^ & , ; [ ] { } ( ) % # = + @ tab and blank space
You can modify the default behavior by setting the following value in the VIPO
configuration file (xvtp.ini):
output_filename_strict_checking=false
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-19
By setting the value to false, these invalid characters will be considered valid literals in
the filename template:
[ ] { } ( ) % # = + @
NOTE
The square brackets, [ ] , must be “escaped” (preceded by a backslash
character “\”) to be valid literals in the tem plate syntax (fo r example:
“filename_\[OK\].pdf”). Use the other characters without the “escape”
backslash.
<DFNAME[x..y][Fn]>
Uses the data file name. [x..y] and [Fn] are optional. When producing multiple files, this
is the first part of the file name.
<BKMARK[x..y][Fn]>
Uses the bookmark field. [x..y] and [Fn] are optional.
[x..y]
An optional range modifier that can appear in any order or number after a DFNAME or
BKMARK; for example, [0..5] indicates to use character 0 through character 5 of
DFNAME or BKNAME. Valid values for x and y are 0 through 99.
[Fn]
An optional field number that can appear in any order or number after a DFNAME or
BKMARK; for example, [F2] indicates to use field 2 of DFNAME or BKMARK. Valid values
for n are 0 throu gh 99.
<FS=‘char’>
A field separator character that must be specified if [Fn] is used. Valid values for char are
any printable ASCII character except: [ ] < >.
You can use more than one FS designation. If used within [ ], it only has an effect within
those [ ]. If used outside of the [ ], it takes effect until the next FS is encountered outside
of the [ ].
<DIGITS=n>
The number of digits to use in t he output file n ames when multip le files are pr oduced. If
only a single PDF file is produced, no digits are used in the output file name. Valid values
for n are 1 throu gh 10.
VI PDF Originator User’s Guide
VIPO-20 FreeFlow Variable Information Suite 5.0 (7/2006)
<GET_INDEX_WITHOUT_SPLIT>
Indicates that the resulting PDF file will go through the split process without actually being
split into smaller PDF child files. However, the corresponding CSV/XML index files will be
generated, which then allows the job to be processed by the VIPO Dispatch server.
You can submit a “Distill Only” VIPP job with the non-split option to generate the job index
files needed to process the distilled PDF file with the Dispatch module.
Examples
The following data file name and bookmarks will produce the named files in the table
below when the indicated templates are used:
data file name = mybigjob.lm
pg1 bookmark = account number 01234:xyz
pg2 bookmark = account number 43210:abc
Template syntax Output file names
<DFNAME><DIGITS=3>.pdf mybigjob001.pdf
mybigjob002.pdf
...
<DFNAME[0..4]><DIGITS=5>.pdf mybig00001.pdf
mybig00002.pdf
...
<FS=' '><BKMARK[F2][0..4]>_<DIGITS=4>.pdf 01234_0001.pdf
43210_0002.pdf
...
In the last example, the syntax specifies to extract field number 2 (zero based) from the
bookmark using a space as the field delimiter, then extract digits 0 through 4 from that
result and use that as the first part of the file name. Then append the lite ral character “_”,
followed by 4 digits that increment with each file produced.
Template field descriptions
Use the buttons on the Create an Output Filename Template window to build your
template; as you click the buttons, your selections appear in the display window. The
default template is:
<DFNAME><DIGITS=6>.pdf
You can manually edit the template shown in the display window; just make sure you
follow the template syntax rules.
Add Data Filename
Adds <DFNAME> to the displayed template at the current insertion point, if legal;
otherwise adds it at the most logical insertion point.
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-21
Add Bookmark
Adds <BKMARK> to the displayed template at the current insertion point, if legal;
otherwise adds it at the most logical insertion point.
Add File Split Count
Adds <DIGITS=n> to the displayed template at the current insertion point, if legal;
otherwise adds it at the most logical insertion point. n is specified in the box to the right
of the button.
Add Field Separator
Adds <FS=‘char’> to the displayed template at the current insertion point, if legal;
otherwise adds it at the most logical insertion point. char is specified in the box to the right
of the button.
Add Field Index
Adds <Fn> to the displayed template at the current insertion point, if legal; otherwise adds
it at the most logical insertion point. n is specified in the box to the right of the button.
Add Start/End Index
Adds [x..y] to the displayed template at the current insertion point, if legal; otherwise adds
it at the most logical insertion point. x (start index) and y (end index) are specified in the
boxes to the right of the button.
Undo Changes
Undoes your last change. You can undo multiple changes by clicking this button multiple
times.
Redo Changes
Redoes your last change. You can redo multiple changes by clicking this button multiple
times.
OK
Saves your changes and closes the template window. The template created appears in
the window under the Output Filename Template field on the Job Submission Client
window.
Help
Provides access to the online help facility.
Cancel
Closes the template window without saving any changes.
VI PDF Originator User’s Guide
VIPO-22 FreeFlow Variable Information Suite 5.0 (7/2006)
Specifying an index file
During the PDF splitting process, two index files are autom atically created : an ASCII file
formatted in Comma Separated Values (CSV) and a corresponding XML-fo rmatted index
file. Both have the same file name, except for the file extension (*.c sv and *.xml).
This is a sample of output for an automatically generated XML-formatted index file:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<XVTPIF Version="0.1">
<XVTPDOC>
<FileName>credit000000.pdf</FileName>
<InputFile>credit.pdf</InputFile>
<EndSplitDate>2002-07-15</EndSplitDate>
<EndSplitTime>17:20:13:890</EndSplitTime>
<OutputDir>C:\xvtp\users\maviles\incoming\default\
maviles_credit_vpc_2002_07_15_17_20_09</OutputDir>
<Pages>2</Pages>
<FileSequence>0</FileSequence>
<Bookmark>David Kirk</Bookmark>
</XVTPDOC>
<XVTPDOC>
<FileName>credit000001.pdf</FileName>
<InputFile>credit.pdf</InputFile>
<EndSplitDate>2002-07-15</EndSplitDate>
<EndSplitTime>17:20:13:921</EndSplitTime>
<OutputDir>C:\xvtp\users\maviles\incoming\default\
maviles_credit_vpc_2002_07_15_17_20_09</OutputDir>
<Pages>1</Pages>
<FileSequence>1</FileSequence>
<Bookmark>Michael Sotelo</Bookmark>
</XVTPDOC>
<XVTPDOC>
<FileName>credit000002.pdf</FileName>
<InputFile>credit.pdf</InputFile>
<EndSplitDate>2002-07-15</EndSplitDate>
<EndSplitTime>17:20:13:968</EndSplitTime>
<OutputDir>C:\xvtp\users\maviles\incoming\default\
maviles_credit_vpc_2002_07_15_17_20_09</OutputDir>
<Pages>3</Pages>
<FileSequence>2</FileSequence>
<Bookmark>Carolyn Cliff</Bookmark>
</XVTPDOC>
</XVTPIF>
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-23
You can also use a template to specify the contents of the index file header and index file
record. To create a template, click Create Template next to the Index File Template field
on the VIPO Job Submission Client window. The Create an Index File Template window
appears; the default template appears in the display window.
Additional checks are made when creating and supplying an Inde x File Template to make
sure the field names have the appropriate syntax for XML tag creation. These char acters
are invalid for template field names:
\ / : * ? " < > | ( ) [ ] { } ' ` ~ ! @ # $ % ^ & + = , ; tab and blank space.
Template syntax
The Create an Index File Template window consists of the following eight fields (seven
index file fields and a bookmark field). A defined character separates each field; see
“Field separator” for more information.
1. FileName
2. InputFile
3. EndSplitDate
4. EndSplitTime
5. OutputDir
6. Pages
7. FileSequence
8. Bookmark
The first seven fields are names of corresponding fields in each line of the index file
generated by VIPO. Only the names of these seven fields can be changed in the Index
File Template.
VI PDF Originator User’s Guide
VIPO-24 FreeFlow Variable Information Suite 5.0 (7/2006)
The bookmark field (the eighth field) can be replaced with as many field names as
needed, each separated by the defined field separator. For more information, see
“Bookmark field.”
NOTE
All fields in the index file header and index file record are enclosed in
double quotes. This feature cannot be turned off.
Field separator
A field separator is a single character that separates the index file fields and bookmark
fields. The separator is used to generate the field separators in the inde x file he ader an d
in each index file record. You can change the field separator used in the template. The
syntax for the field separator is:
<FS=‘char’>
where char is any printable ASCII character except: [ ] < >. The field separator in the
default template is a comma (,).
Bookmark field
You can replace the bookmark field with an unlimited number of field names. Each
bookmark field name appears in the index file header.
Use the following syntax with any bookmark field name in the template to control which
portions of the bookmark are extracted and placed into the corresponding fields in each
index file entry generated by VIPO.
NOTE
The default template places the entire bookmark into the last fiel d of each
index file.
[x..y]
Uses a substring of Bookmark from zero-bas ed indices x to y. This is an optional range
modifier that can appear in any order or number after the fixed fields in the temp late. Valid
values for x and y are 0 through 99.
[Fn]
Uses field number n of the bookmark according to BFS. This is an optional field number
that can appear in any order or number after the fixed fields in the template. Valid values
for n are 0 throu gh 99.
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-25
Template
<BFS=‘c’>
A bookmark field separator (BFS) that must be specified if [Fn] is used. Valid values for
c are any printable ASCII character except: [ ] < >.
You can use more than one BFS designation. If used within [ ], it only has an effect within
those [ ]. If used outside of the [ ], it takes effect until the next BFS is encountered outside
of the [ ].
Examples
The following bookmark contents will produce the index file headers and index file
records below when the indicat ed templates are used:
bookmark contents = John Doe 123-45-456
Example 1:
<FS=':'>Fld1:Fld2:Fld3:Fld4:Fld5:Fld6:Fld7:BookFld1|<BFS=' '>[F1]:BookFld2|[0..2]:
BookFld3|[F2][0..2]
Index file header
produced
Index file record
produced
Template
Index file header
produced
Index file record
produced
Template
Index file header
produced
Fld1:Fld2:Fld3:Fld4:Fld5:Fld 6:Fld7:BookF ld1:BookFld2 :BookFld3
outfile_001.pdf:infile:10-2-01:“ 23:56:34”:“c:\user\...”:5:1-50:Doe:Joh:123
Example 2:
<FS=':'>FldA:FldB:FldC:FldD:FldE:FldF:FldG:Bookfield1|<BFS=' '>[F1]:
Bookfield2|[F2][<BFS='-'>[F2]]
FldA:FldB:FldC:FldD:FldE:FldF:FlgG:Bookfield1:Bookfield2
outfile_003.pdf:infile:10-2-01:“ 13:06:14”:“c:\user\...”:7:3-80:Doe:456
Example 3:
<FS=','>Fld1,Fld2,Fld3,Fld4,Fld 5,Fld6,Fld7 ,FirstNam|<BFS=' '>[F0],LastNam|[F1],
Num|[F2][<BFS='-'>[F0]]
Fld1,Fld2,Fld3,Fld4,Fld5,Fld6,Fld7,FirstNam,LastNam,Num
Index file record
produced
VIPO-26 FreeFlow Variable Information Suite 5.0 (7/2006)
file_xyz.pdf,infile,10-7-01,14: 29:14,c:\ user\...,4,10-100,John,Doe,123
VI PDF Originator User’s Guide
Template field descriptions
Use the buttons on the Create an Index File Template window to build your template; your
selections appear in the display window. The default template is:
<FS=':'>FileName:InputFile:EndSplitDate:EndSplitTime:OutputDir:
Pages:FileSequence:Bookmark
NOTE
You can manually edit the template shown in the display window; just
make sure you follow the template syntax rules.
Header Field Separator
Adds the index field separator to the displayed template at the current insertion point, if
legal; otherwise, adds it at the appropriate insertion point. Specify the field separator in
the box to the right of the button.
Bookmark Field Separator
Adds the bookmark field separator to the displayed template at the cu rrent insertion point,
if legal; otherwise, adds it at the appropriate insertion point. Specify the field separato r in
the box to the right of the button.
Add Field Index
Adds <Fn> to the displayed template at the current insertion point, if legal; otherwise adds
it at the most logical insertion point. n is specified in the box to the right of the button.
Add Start/End Index
Adds [x..y] to the displayed template at the current insertion point, if legal; otherwise adds
it at the most logical insertion point. x (start index) and y (end index) are specified in the
boxes to the right of the button.
Undo Changes
Undoes your last change. You can undo multiple changes by clicking this button multiple
times.
Redo Changes
Redoes your last change. You can redo multiple changes by clicking this button multiple
times.
OK
Saves your changes and closes the template window. The template created appears in
the window under the Index File Template field on the Job Submission Client window.
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-27
Help
Provides access to the online help facility.
Cancel
Closes the template window without saving any changes.
Using the VIPO Watched Folders Client
The VIPO Watched Folders Client (WFC) allows you to specify one or more directories
where VIPP jobs can be placed for automatic submission to VIPO. A VIPO user (remote
or local) and an optional profile are associated with each watched folder, which controls
the processing of all jobs submitted from that folder. Submitted jobs can be monitored
using the Job Submission Client in the same manner as for lpr-submitted jobs. All VIPP
jobs found in each watched folder are checked at ea ch watch interval to deter mine file
readiness.
Start the Watched Folders Client either from the VIPO program folder or from the
right-click menu of the VIPO Local Server icon. The Client runs as a background process.
A VIPO Server must be running in order for watched folders to be processed.
You can tell the Watched Folders Client is running by the presence of its icon in the
Windows task bar. Right click the VIPO Watched Folders Client icon to display these
options:
• Restore VI PDF Originator Watched Folders Client — Maximizes the VIPO
Watched Folders Client window.
• Exit — Exits the Watched Folders Client. If you exit the Client, folders will not be
watched until the Client is restarted.
VI PDF Originator User’s Guide
VIPO-28 FreeFlow Variable Information Suite 5.0 (7/2006)
The VI PDF Originator Watched Fold ers Client wi ndow is used to control and monitor
watched folders.
NOTE
When the Client is invoked, the watch process is inactive.
VI PDF Originator User’s Guide
FreeFlow Variable Information Suite 5.0 (7/2006) VIPO-29
Window elements
The VIPO Watched Folders Client window consists of these elements:
Title bar
Displays the product name (VI PDF Originator Watched Folders Client).
Menu bar
Provides access to the File and Help menus. These options are available fro m the File
drop-down menu:
• Hide Watched Folders Client — Returns the VIPO Watched Folders Client window
to a task-bar icon.
• Input File Disposition — Controls what happens to watched jobs after they are
submitted to VIPO. There are two sub-menu choices:
— Delete Input File: Deletes the job from the watched folder (default).
— Move Input File to Saved Jobs Folder: Moves the job to the Saved Jobs folder
contained under each watched folder.
• Exit — Exits the Watched Folders Client; folders will no longer be watched.
The Help drop-down menu provides access to the About option, which displays the
version information of the VIPO Watched Folders Client.
Watched folders list
Lists the folders currently defined for watching.
Watched folder details area
Shows the details for the selected watched folder (folder name, VIPO user associated
with the folder, and profile file (optional)) in the watched folders list. If a profile file is
specified, the contents of the file display in the Profile Cont ents box.
Status area
Displays the current watch interval, which can be changed using the Change Interval
button, and the current method used to check file readiness. It also indicates if folders are
currently being watched.
VI PDF Originator User’s Guide
VIPO-30 FreeFlow Variable Information Suite 5.0 (7/2006)
Loading...