Specifying File Names in Symbol Notation

Sometimes you need to specify a file in the spool directory even though you do not know the file name. Use the getFileName, getAbsoluteFileName, or getOperInst method to return the name of the file.

For example, when you create a Passthrough printer, you need to specify the command that submits jobs to the printer device. This command has to specify the name of the print file, which is different for each job. Use the getFileName or getAbsoluteFileName methods to return the name of the print file. As an option, you can specify a command that prints special instructions on a separator sheet before the job is printed. Use the getOperInst method to return the name of the file that contains the special instructions.

getFileName and getAbsoluteFileName Syntax

Use the getFileName and getAbsoluteFileName methods to return the name of a specific print file. The difference between the two methods is that getAbsoluteFileName fails if a file of the requested data type or types does not exist, but getFileName continues to search. If it finds a print file of data type unknown, it returns the name of that file.

Use one of these syntaxes:

  • To search for a print file when you know the data type:
    ${getFileName(print,Datatype,read)}
    ${getAbsoluteFileName(print,Datatype,read)}
  • To search for a print file when the data type might be one of several data types:
    ${getFileName(print,(Datatype1,Datatype2...),read)}
    ${getAbsoluteFileName(print,(Datatype1,Datatype2...),read)}

where:

print
This keyword specifies that you are searching for a printable file.
Datatype or (Datatype1, Datatype2...)
These keywords specify the datatype of the file that you want to find. Values for Datatype are:
pcl  
pdf  
ps  
tiff  
png  
jpeg  
unknown Use unknown for any datatype that does not have a keyword.
read
This keyword specifies that the print command reads the job file from the print spool.

getOperInst Syntax

The getOperInst method to return the name of a file that contains printable special instructions.

Use this syntax to search for a special instructions file:

${getOperInst(pdf)}

Examples

These examples show commands that you can specify as values for the Command or Command for special instructions property of a Passthrough printer. They submit files from TotalFlow Production Manager to the Passthrough printer. Do not use these commands to submit files to a TotalFlow Production Manager workflow.

This Windows lpr command reads a PCL, PostScript, or PDF file from the print spool and sends it to a Passthrough printer called officeprinter.acme.com with a print queue called PASS:

lpr -S officeprinter.acme.com -P PASS -o l 
${getAbsoluteFileName(print,(pcl,ps,pdf),read)}
The -o l flag indicates that the file is binary.

This command reads a PDF file that contains special instructions and sends it to officeprinter:

lpr -S officeprinter.acme.com -P PASS -o l 
${getOperInst(pdf)}