Special fields in composed strings
A composed string (such as used in a composite field, an output file specification or a PDF password) can contain embedded field names enclosed in curly brackets e.g. Dear {name}. The value of the field is substituted at the time of invoking the string e.g. when constructing an output file name. As well as the user-defined fields there are certain special ones:
_{ |
An opening curly bracket. |
_} |
A closing curly bracket. |
_back |
Value is BACK if on a back page or null if not a back page. |
_bates |
The 'bates' page number as defined in the Configuration|Layout dialog. Related item: _page. |
_bin |
The current output bin number. Related item: _tray. |
_CR |
Carriage Return (character 13 decimal, 0D hex). Related items: _CRLF, _LF. |
_CRLF |
Carriage Return & Line Feed (0D0A hex). Related items: _CR, _LF. |
_day |
Today's day number (1-31). Related item: _month. |
_DocAuthor |
PDF only: the name of person who created the document. |
_DocCreationDate |
PDF only: the date that the document was created. |
_DocCreator |
PDF only: the name of the program that created the original document. |
_DocKeywords |
PDF only: keywords for the document. |
_DocProducer |
PDF only: the name of the program which output the document. |
_DocSubject |
PDF only: the subject of the document. |
_DocTitle |
PDF only: the title of the document. |
_DocUpdateDate |
PDF only: the most recent update date of document. |
_ext |
Same as _Iext, see below. |
_filename |
Same as _Ifilename, see below. |
_filenum |
The current file number within a list of files being processed. |
_filepages |
The number of pages in a current input file. Valid only for input formats such as PDF, TIFF or DCX where the number of pages can be easily determined. |
Value is FRONT if on a front page, otherwise null. |
|
_GMT |
Same as _UTC, see below. |
_hour |
Time in hours. Related items: _minute, _second. |
_id |
Unique numeric ID; used to construct the default output file name: {_title}{id} |
The original (Input) file extension, including the 'dot'. Related item: _Oext. |
|
_Ifilename |
The full Input file name. Related item: _Ofilename. |
_Iname |
The file name stem of the original (Input) file. Related item: _Oname. |
_Ipath |
The full path of the original (Input) file. Related item: _Opath. |
_LF |
Line Feed (character 10 decimal, 0D hex). Related items: _CR, _CRLF. |
_local |
Subsequent times are 'local'; the default time is specified in Universal Coordinated Time. |
_minute |
Time in minutes. Related items: _hour, _second. |
_month |
Today's month number (1-12). Related item: _day. |
Same as _Iname, see above. |
|
_numpages |
When using /FROM to read a CSV Control file, _numpages obtains the number of pages in the current file segment. |
The Output file extension, including the 'dot'. Related item: _Iext. |
|
_Ofilename |
The full Output file name. Related item: _Ifilename. |
_Oname |
The file name stem of the Output file. Related item: _Iname. |
_Opath |
The full path of the Output file. Related item: _Ipath. |
_orient |
The orientation of the page. |
_page |
The current page number. Related items: _bates, _sheets, _sides. |
_paper |
The name of the paper used for the page e.g. LETTER |
_path |
Same as _Ipath, see above. |
_PJL_ |
This is a special construct for extracting data from PJL commands: see PJL note, below. |
_RT |
This is defined by the value from the @PJL COMMENT REDTITAN DIR value. |
_second |
Time in seconds. Related items: _minute, _hour. |
_sheets |
The number of pieces of paper that have been output. Related items: _page, _sides. |
_side or _sides |
The current side number starting at 1. Related items: _page, _sheets. |
_title |
The job title; used to construct the default output file name: {_title}{_id} |
_tray |
The current input tray number. Related item: _bin. |
Subsequent times are in Universal Coordinated Time. Related item: _local. |
|
_year |
Today's year number. Related item: _month. |
All these special 'symbols' start with the "underscore" character, followed by characters that may be in upper, lower or mixed case. The underscore characters are to distinguish predefined fields from those defined by the user, but may be omitted if there are no user-defined fields with conflicting names.
Special fields beginning {_PJL_ can be used to extract data from PJL commands. For example, {_PJL_OUTPAPER} could be used to search for a command such as @PJL SET OUTPAPER LETTER and extract the OUTPAPER parameter (LETTER in this case). Similarly, the composite field {_PJL_JOB} will yield the name of the job. See also Document properties: PJL |
|
Links