Xerox 5 manual RuleName, RuleVars, DataFileTemplate, VIPO-69

Page 69

Dispatch Rule entries are defined as follows:

RuleName

The user-specified name by which the rule is identified to the user. Examples might be “E-mail via Exchange” or “Submit to DocuShare.”

RuleVars

A set of name-value pair definitions that define the specified field names for use in the CommandTemplate. When a RuleVars name is the same as a field name encountered in a VIPOD job's splitfile index record, the field name contents of the splitfile index record takes precedence over the RuleVars value.

Example:

RuleVars=(profileName="Bill Walker-Test2" password=wazoo)

The RuleVars entry can be empty, indicating that no RuleVars name or value pairs are defined for the given Dispatch Rule.

DataFileTemplate

The template from which the data file preprocessing step(s) are defined.

These steps specify the writing to disk of zero or more files containing the contents of one or more splitfile index fields. This is required to support external programs like some batch e-mail clients, where the body of an e-mail message must be specified as a file name on the client's command line.

The template consists of a set of rules internally delimited by the “” character and interstitially delimited by the “;” character of the form:

FieldNameDestinationFilePathdeleteOnExit;...

where the fieldName is the name of a field in the splitfile index (i.e., “body” or “mailtext”), the path resolves to the full path of a destination file. The boolean deleteOnExit indicates whether the destination file is deleted by VIPOD upon successful processing of the subtask. An example:

DataFileTemplate=(body c:\xvtp\bin\bodytemp.txt 1)

results in the contents of the body field of the splitfile index record being written to the file c:\xvtp\bin\bodytemp.txt, which would then be deleted after the execution of the rule's command. This example:

DataFileTemplate=(body c:\xvtp\bin\$(destFilename) 0)

where destFilename is a field of the splitfile index record having the value “jones.txt,” results in the contents of the body field of the splitfile index record being written to the file c:\xvtp\bin\jones.txt. The file is not deleted after the execution of the rule's command.

A DataFile Template can be empty, indicating that no file creation is to take place.

VI PDF Originator User’s Guide

FreeFlow Variable Information Suite 5.0 (7/2006)

VIPO-69

Image 69 Contents
User’s Guide Page Table of contents Using Vipo and Adobe Distiller Using Vipo WebUsing lpr to submit Vipo jobs VIPO-4Using Vipo Services Using Vipo DispatchIndex VIPO-5VIPO-6 VIPO-7 VIPO-8 VIPO-9 Vipo Server and ClientVIPO-10 Using the Vipo Local ServerVIPO-11 File menu optionsJob Selection menu options Help menu optionsVIPO-12 Window elements Using the Vipo Job Submission ClientTitle bar Menu barVipo job status area Job creation areaFunction buttons VIPO-14Data File Init Nub File Job creation area field descriptionsCurrent Profile VIPO-15User Name Job TypeJob Server Output FolderVIPO-17 Output Filename Template Index File TemplateVIPO-18 Profile filesVIPO-19 Template syntaxBKMARKx..yFn DFNAMEx..yFnFS=‘char’ DIGITS=nVIPO-21 Add Data FilenameAdd Bookmark CancelAdd File Split Count Add Field SeparatorVIPO-23 Specifying an index fileVIPO-24 VIPO-25 Field separatorVIPO-26 BFS=‘c’Header Field Separator Template field descriptionsBookmark Field Separator VIPO-27VIPO-28 Using the Vipo Watched Folders ClientVIPO-29 Watched folders list Title bar Menu barWatched folder details area Status areaVIPO-31 Adding watched foldersVIPO-32 File ready checkVIPO-33 Command line options for the Vipo Watched Folders ClientVIPO-34 Bulk ProcessingVIPO-35 Accessing Vipo via your web browserVIPO-36 Job Submission/View/Retrieval Job Submission upper frameVIPO-37 Current Profile Load/Save Data FileOutput Filename Template Create Index File Template Create VIPO-38Submit Job Refresh StatusVIPO-39 Job Submission lower frame ActionVIPO-40 Job Status Job NamePages Distilled Pages Split Files Generated VIPO-41Change Password AdministrationVIPO-42 VIPO-43 User AdministrationVIPO-44 Changing passwordsVIPO-45 Server AdministrationVIPO-46 VIPO-47 Cluster AdministrationVIPO-48 VIPO-49 VIPO-50 Basic Authentication Quick Step Disable Basic AuthenticationVIPO-51 VIPO-52 Web browser notesVIPO-53 Using Vipo and Adobe DistillerVIPO-54 Acrobat Distiller versions prior to Adobe Distiller and fontsAcrobat Distiller 6.0 and later ExampleVIPO-56 Assigning a Distiller job options fileVIPO-57 Using the Vipp Bookmark commandVIPO-58 Extended bookmarksVIPO-59 Using VI Project ContainersVIPO-60 VIPO-61 Lpr command syntax for WindowsVIPO-62 Parameter definitionsParameter defaults Example lpr job submissionsVIPO-63 VIPO-64 VIPO-65 Using Vipo DispatchVIPO-66 Dispatch filtersVIPO-67 Dispatch Rule filesVIPO-68 RuleVars RuleNameDataFileTemplate VIPO-69TimeOut CommandTemplateLogStdOut LogStdErrRetValTriggerTrumpsStdoutStderr FailOnErrorRetValTrigger VIPO-71StdOutTrigger StdErrTriggerVIPO-72 AutoRun PostProcessCommandTemplate=...command stringRunPostProcessCmd=true/false VIPO-73Rule file variable references System built-in macrosExamples VIPO-74VIPO-75 Special Character Sequences in CSV and XML Index FilesVIPO-76 Vipo Dispatch windowPending Jobs Eligible Jobs Ineligible Jobs Conflict JobsSelect Dispatch Rule View IndexRecord Field NamesCompleted Jobs Held JobsRelease Job Review Job StatusHide Dispatcher File menuPause Dispatcher Save LogfileFilter Filename Edit menuSet Active Filter Delete FileEdit ResetAdd DeleteVIPO-84 OK/CancelVIPO-85 VIPO-86 Rule FilenameDefault ClearVIPO-87 Clear Display Trace menuJob Selection Loop Job Selection TraceVIPO-89 Using Vipo Dispatch a simple exampleSetbufsize VIPO-90VIPO-91 \temp\temp.txtVIPO-92 $ccVIPO-93 VIPO-94 VIPO-95 VIPO-96 VIPO-97 DefinitionsVIPO-98 ConstraintsVIPO-99 IndexVIPO-100 FreeFlow Variable Information Suite 5.0 7/2006 FreeFlow Variable Information Suite 5.0 7/2006 VIPO-101 Page