IntegrationsCommands for Use with File Drop Integration

PAS commands, CSV commands, and XML (LPS) commands, including the alternative syntax, are supported in Loftware Enterprise SP except as noted.

The PAS syntax is a simple ASCII structure that has all the commands, field names, and data for the labels that are to be printed. The field names in the file match the ones given to their corresponding fields on the label in Label Design Label Design. Each PAS file can have many different label requests within it.

PAS and CSV Commands

The following commands apply to the PAS and CSV file syntaxes. The commands for XML (LPS) are the same as the LPS commands with the exception of beginning with an underscore (_) instead of an asterisk (*).

Command

Description

*FORMAT,<name>

The fully-qualified name of the label template to which to send the data. Each PAS file must begin with this command. 

*PRINTERNAME,<name>

The fully-qualified name of the device to which to print.

If you are using *PRINTERNAME, do not use *PRINTERNUMBER. The latter always takes precedence over the former.

*PRINTERNUMBER,<number>

The LPS device number of the device to which to print. 

Note: Use *PRINTERNUMBER only if the PAS file was generated for use with LPS and if you are not using *PRINTERNAME.

*JOBNAME,<name>

The name of the job for status reporting purposes. The *JOBNAME is applied to all labels printed within the job.

Note: In Loftware Enterprise SP, the job name is stored in the job rather than as part of the data map.

*QUANTITY,<number>

The number of labels to print.

*DUPLICATES,<number>

The number of copies of the label to print. This is useful if you are using incrementing numbers and you need to print multiple copies of the same number before incrementing it. For example, you may need to put two labels on a box with the same serial number—one label for each corner.

*PAGES,<number>

The number of pages to print. This is only used if you are using a layout.

*PRINTLABEL

Print the current label. A PAS file generated for use with LPS must end with the *PRINTLABEL command.

*DELINKODBC

Override the database. You must provide all data for the labels. Include this command in your .pas file to turn off the database links for normal production.

*SENDFORMAT,0

Suppress the sending of the format information to the device. The device recalls the format from memory and throughput time is increased. This is supported only on devices that support the pre-downloading of the fixed fields in your format.

*TRAY,<name|number>

Specify a paper source. This command is available for Windows devices and devices that use the PCL 5 driver. If the device you are printing to has more than one tray, this command is designed to send a label to a particular tray on the device.

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, such as lower or upper, and is not case sensitive.

For PCL 5 drivers, the tray is one of the following numbers.

0: Print current page (paper source remains unchanged)

1: Feed paper from main paper source

2: Feed paper by using manual feed

3: Feed envelope by using manual feed

4: Feed paper from alternate paper source

5: Feed from optional large paper source

6: Feed envelope from envelope feeder

7: Select the paper source automatically

8: Feed paper from Tray 1 (right side tray)

20 - 39: Feed paper from High Capacity Input (HCI) Trays 2-21

*INLINE_DOCUMENT

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

*INLINE_TYPE

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

*LABEL_RANGES

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.

*PAGE_HANDLING

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!.

*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.

*FORCE_IMAGE

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.

*TARGET_MEDIA_HEIGHT

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!.

*TARGET_MEDIA_WIDTH

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

*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.

Alternative Commands

You can use the following commands as alternatives to the previously mentioned commands. The alternative syntax makes it easier for report generation software to create the file. 

Command

Alternative Syntax

*FORMAT FORMAT
*PRINTERNAME PRTNAME
*QUANTITY LLMQTY
*PAGES PAGE
*JOBNAME JOBNAME
*PRINTERNUMBER PRTNUM
*DUPLICATES LLMDUP

Note: In Loftware Enterprise SP, the job name is stored in the job rather than as part of the data map.

Note: The *PRINTLABEL command has no alternative because it is not used in CSV syntax.

Note: Null characters are not allowed in PAS files.