Reserved Keys for Print Parameters

The name of the print job detail A single request to use a label template to print to a specific destination. Depending on the values for Quantity, Duplicates, and Pages, a print job detail may generate multiple labels..

Tip: In a scenario using on-demand print, you can allow the Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. to specify the name of a print job detail by including a Prompt for which the Data Ref is /!PJD_NAME!. When Data Providers use that form to submit a print request in Print , they can enter a name for the print job detail. In the Job Inspector dialog box in Status, that name is displayed when that print job detail is selected.

Quantity The number of times to print a label by using the same data. Each printed label produced is identical except for any incrementing or decrementing field.

Note: To use this reserved key, you must select the Hide Quantity check box on the Print tab when editing a form in Label Design  or Application Design .

Duplicates The number of times to reprint a label by using the same data and without changing the value in any incrementing or decrementing field. Each duplicate printed label is identical.

Note: To use this reserved key, you must select the Hide Duplicates check box on the Print tab when editing a form in Label Design  or Application Design .

Pages The number of times to print the content for the labels in a layout. Each page is identical, including the value in any incrementing or decrementing field.

Tray To which output tray to direct printed labels or documents. If a printer has only one output tray or otherwise does not support this feature, this is ignored. For Windows drivers the tray is the name of the tray that supplies the paper. The name corresponds to the configured tray name in the driver setup (not case sensitive). For PCL 5e drivers the tray is the ID number of the tray that supplies the paper. The ID corresponds to the configured tray number in the driver setup.

The Fill Direction for the layout. For more about Fill Direction, see Layout Properties.

For example, en_US.

This property is not currently used. The default value is 0.

The Start Origin for the layout. For more about Start Origin, see Layout Properties.

The Text Box Overrun Mode for Text Box fields, which can also be configured in System  or in Devices .

How Loftware Enterprise SP should respond if the amount of data received for a Text Box field is more than can fit.

Tip: If the Text Box Overrun Mode is specified in the job data, that overrides any mode specified in Label Specific Options in Label Design , device options in Devices , or system preferences in System . Otherwise, if specified in Label Specific Options, that overrides device options and system preferences, and if specified in device options, that overrides system preferences.

Allow Overrun: The text continues beyond the bottom of the envelope for the field. For a printed label, as much of the text as can fit on the label is printed.

Truncate Data: Text that does not fit is not printed or displayed. The preceding text is printed or displayed.

Truncate Data at Paragraph Break: A paragraph that does not fit is not printed or displayed. The preceding paragraph is printed or displayed.

Fail Print Job on Overrun: Any print job that includes a Text Box field in which the data received does not fit is failed and is not printed or displayed.

Use Global Setting: The value for Text Box Overrun Mode that is set in System  is used. (Default)

Example

!TEXTBOX_OVERFLOW_RULE!,TRUNCATE

How the reprint target value is interpreted.

• Sibling: For stacked jobs and nested process designs, print the process immediately before it by default, or specify a relative index to the reprint process and print a different sibling.
• Job: For on demand reprints, reprint every print job detail within the listed job to the same target printer.

If the Reprint Target Type is Sibling, this value specifies the number of previous sibling processes to traverse when determining which process is to be reprinted. The default value is 1, which will reprint the previous sibling process in the local containers process list.

If the Reprint Target Type is Job, this value is the target job's Job ID.

A set of comma delimited label ranges to reprint in a multi-label or quantity reprint. When printing external files, this is the range of pages to print. An asterisk is a wildcard value that resolves to the last label printed.

Example

A value of 1,3,4-6,9-10 would print labels 1,3,4,5,6,9 and 10.

Required for printing external files. Print an external file, such as a PDF, without associating the file with label template.

Required for printing external files. The list of supported external file types. For example, INLINE_PDF.

The page handling for imaged files. Maintains aspect ratios.

ACTUAL_SIZE: Do not increase or decrease the image size on the page. Default value.

FIT: Increase or decrease the image size as appropriate to fit the page.

INCREASE: Increase the image size of undersized images only to fit the page.

DECREASE: Decrease the image size of oversized images only to fit the page.

CUSTOM: Increase or decrease the image size as specified in !PAGE_CUSTOM!.

Required if !PAGE_HANDLING! is CUSTOM. For imaged files, the percentage as an integer value to increase or decrease the image size on the page. A value greater than 100 will increase the image size, and a value less than 100 will decrease the image size on the page. Can be used when printing external files. Default: 100.

When printing external files, whether to force the file to print as an imaged file.

TRUE: An external file is imaged regardless if the target device is configured and supports the !INLINE_TYPE! natively.

FALSE: Default value.

Required if !PAGE_HANDLING! is not CUSTOM. For imaged files, the height of the target media size in thousandths of an inch (mils), unless specified otherwise in !TARGET_MEDIA_UNITS!.

For imaged files, the width of the target media size in thousandths of an inch (mils), unless specified otherwise in !TARGET_MEDIA_UNITS!.

The target unit of measurement. Can be used when printing external files.

INCHES: Thousandths of an inch (mils). Default value.

CM: Centimeter.

MM: Millimeter.

The actual time when the print job is submitted in the format:

EEEEE EEE MMMMM MMM MM-dd-yyyy HH:mm:ss (locale defined full day of the week, locale defined abbreviated day of week, locale defined month name, locale defined abbreviated month name, month number, two-digit date, year, hour, minutes, seconds in 24-hour format).

Example

Wednesday Wed June Jun 06-22-2016 10:28:10