Xerox 5 manual System built-in macros, Rule file variable references, Examples, VIPO-74

Page 74

System built-in macros

Use these built-in macros as variables in a rule file for DataFileTemplate and

CommandTemplate definitions:

PDF_DIR_PATH — Full path of the directory location where the distilled PDF file associated with the job can be found.

PDF_FILE_PATH — Full path of the individual split PDF file associated with the index file record currently being processed.

PDF_FILE_NAME — File name only of the individual split PDF file associated with the index file record currently being processed.

USER_NAME_ID — User ID associated with the job being processed.

JOB_NAME_ID — Job Name ID associated with the job being processed.

Rule file variable references

The DataFileTemplate, CommandTemplate, and PostProcessingCommandTemplate definitions allow the use of variable references. The variable names used can be field names from the header of the job index file, variable names defined within the rule file itself (RuleVars) or system built-in macros. The reserved character “$” is used to indicate a variable reference. Only these two syntax forms are supported:

$varname $(varname)

Examples:

The following are examples only and are not intended to work in all conditions.

These DataFileTemplate definitions have variable references:

body C:\xvtp\bin\$(TempFolder)\bodytemp.txt 0

body C:\xvtp\bin\temp\$(BodyFileName) 0

These CommandTemplate definitions have variable references:

blat C:\xvtp\bin\$(TempFolder)\bodytemp.txt -t $mailto

blat C:\xvtp\bin\$(TempFolder)\$(BodyFileName) -t $mailto

xcopy $(OutputDir)\$(FileName) C:\xvtp\dispatch\MyArchiveFolder /y

xcopy $(PDF_FILE_PATH) C:\xvtp\dispatch\MyArchiveFolder /y

VI PDF Originator User’s Guide

VIPO-74

FreeFlow Variable Information Suite 5.0 (7/2006)

Image 74 Contents
User’s Guide Page Table of contents Using lpr to submit Vipo jobs Using Vipo WebUsing Vipo and Adobe Distiller VIPO-4Index Using Vipo DispatchUsing Vipo Services VIPO-5VIPO-6 VIPO-7 VIPO-8 Vipo Server and Client VIPO-9Using the Vipo Local Server VIPO-10File menu options VIPO-11VIPO-12 Job Selection menu optionsHelp menu options Title bar Using the Vipo Job Submission ClientWindow elements Menu barFunction buttons Job creation areaVipo job status area VIPO-14Current Profile Job creation area field descriptionsData File Init Nub File VIPO-15Job Server Job TypeUser Name Output FolderOutput Filename Template Index File Template VIPO-17Profile files VIPO-18Template syntax VIPO-19FS=‘char’ DFNAMEx..yFnBKMARKx..yFn DIGITS=nAdd Data Filename VIPO-21Add File Split Count CancelAdd Bookmark Add Field SeparatorSpecifying an index file VIPO-23VIPO-24 Field separator VIPO-25BFS=‘c’ VIPO-26Bookmark Field Separator Template field descriptionsHeader Field Separator VIPO-27Using the Vipo Watched Folders Client VIPO-28VIPO-29 Watched folder details area Title bar Menu barWatched folders list Status areaAdding watched folders VIPO-31File ready check VIPO-32Command line options for the Vipo Watched Folders Client VIPO-33Bulk Processing VIPO-34Accessing Vipo via your web browser VIPO-35VIPO-36 VIPO-37 Job Submission/View/RetrievalJob Submission upper frame Output Filename Template Create Index File Template Create Data FileCurrent Profile Load/Save VIPO-38VIPO-39 Submit JobRefresh Status VIPO-40 Job Submission lower frameAction Pages Distilled Pages Split Files Generated Job NameJob Status VIPO-41VIPO-42 Change PasswordAdministration User Administration VIPO-43Changing passwords VIPO-44Server Administration VIPO-45VIPO-46 Cluster Administration VIPO-47VIPO-48 VIPO-49 VIPO-50 VIPO-51 Basic Authentication Quick StepDisable Basic Authentication Web browser notes VIPO-52Using Vipo and Adobe Distiller VIPO-53VIPO-54 Acrobat Distiller 6.0 and later Adobe Distiller and fontsAcrobat Distiller versions prior to ExampleAssigning a Distiller job options file VIPO-56Using the Vipp Bookmark command VIPO-57Extended bookmarks VIPO-58Using VI Project Containers VIPO-59VIPO-60 Lpr command syntax for Windows VIPO-61Parameter definitions VIPO-62VIPO-63 Parameter defaultsExample lpr job submissions VIPO-64 Using Vipo Dispatch VIPO-65Dispatch filters VIPO-66Dispatch Rule files VIPO-67VIPO-68 DataFileTemplate RuleNameRuleVars VIPO-69 LogStdOut CommandTemplate TimeOut LogStdErrRetValTrigger FailOnErrorRetValTriggerTrumpsStdoutStderr VIPO-71VIPO-72 StdOutTriggerStdErrTrigger RunPostProcessCmd=true/false PostProcessCommandTemplate=...command stringAutoRun VIPO-73Examples System built-in macrosRule file variable references VIPO-74Special Character Sequences in CSV and XML Index Files VIPO-75Vipo Dispatch window VIPO-76Pending Jobs Eligible Jobs Select Dispatch Rule Conflict JobsIneligible Jobs View IndexRecord Field NamesRelease Job Held JobsCompleted Jobs Review Job StatusPause Dispatcher File menuHide Dispatcher Save LogfileSet Active Filter Edit menuFilter Filename Delete FileAdd ResetEdit DeleteOK/Cancel VIPO-84VIPO-85 Rule Filename VIPO-86VIPO-87 DefaultClear Job Selection Loop Trace menuClear Display Job Selection TraceUsing Vipo Dispatch a simple example VIPO-89VIPO-90 Setbufsize\temp\temp.txt VIPO-91$cc VIPO-92VIPO-93 VIPO-94 VIPO-95 VIPO-96 Definitions VIPO-97Constraints VIPO-98Index VIPO-99VIPO-100 FreeFlow Variable Information Suite 5.0 7/2006 FreeFlow Variable Information Suite 5.0 7/2006 VIPO-101 Page