Label Formatter parameter definitions
Label Formatter parameters can be set on the page or entered directly.
Below is a list of parameters that can be sent to the Formatter.
| Parameter | Syntax | Description |
|---|---|---|
| Copies | /C=n "n" copies of each record are printed |
The number of copies accepted is 1 - 999999. This can be set once for the entire print job, or can be set on each label. Once it is set, that number of copies is in effect until it is set again. |
| Data Record Format (Field Names) | ubfmt /L=label /P=printer /DRtxdata_name txdata_name is the name of the TXDATA entry in the Label Data Dictionary for the given label format |
The Data Record Format defines the order and identity of data fields as they will appear in the data stream or file. The data record format is specified in the Label Data Dictionary under TXDATA, or it can be located at the beginning of the data file. |
| Delimiter Character | /DEL= d where "d" is the field delimiter |
For delimited files, the field delimiter defaults to the tilde (~), or the default set on the Formatter Options page, but can be overridden with the /DEL parameter. The Label Formatter takes one character immediately following the equal sign. |
| File (Input) | /F =data file | This command is an alternate to using stdin. When included on the command line, the records in the specified data file are passed to the Label Formatter, enabling you to print a batch of labels. In this file, you will include the information that will vary from label to label. |
| File Type | /T =type of file | The Label Formatter supports both delimited and fixed length ASCII files. The /T parameter selects a file type as follows:
The file type can be also set on the Formatter Options page by selecting the Data Format Type. |
| Label Name | /L = Label Name | This parameter is used to assign a label template for a print job. The Label Name is the name assigned to a label by the user in the Label Designer. The program looks up the Label Name in the labels.lst file in the base directory. If the Label Name cannot be found, the command is ignored. The Label Name can be set on the command line or in a job file. If no label is assigned, the Label Formatter will abort the print job. Note: Label Names are case sensitive and cannot contain spaces. |
| New Page | /NP | Used when a print page is not full and you want to advance to the next page. The New Page option is used to signify that this label should begin a new page. Normally this command is used with laser printers with multiple labels per page. |
| New Row | /NR | Needed only if row is not filled. The New Row option is used to signify that this label should begin a new row. This can be used, for example, on laser printers where the label paper has four labels across on each row. |
| Print Destination | /P=Logical Printer | The Print Destination is the Logical name of a print destination that is defined on the Printer Setup page. This information is saved in the application's configuration file. If the Print Destination cannot be found in the configuration file, the print job is aborted. |
| Report | /R= report component | This parameter is used to identify the components of a report, enabling header, detail, and footer information to be printed. Definitions for all three report components are required to produce a full report. This parameter is not supported in QuickLabel.
|
| Sheet | /Sheet | Places subsequent labels on a single sheet. This command is valid only within the data file. |
| Skip | /Skip | Moves to the next row/column to begin printing. This command is valid only within the data file. |
| Eject | /Eject | Signals the end of a printed sheet of label media and terminates 'Sheet Mode' so that an individual label can follow on that printer. This command is only valid within the data file. |
Example:
$ ubfmt < input.dat /P=logical_printer_name /L=label_name /DRtxdata_name
Call the Label Formatter by name (ubfmt), tell it to take as input the data from input.dat, print it to logical_printer_name (which is defined on the Printer Setup page), using label_name as the label format and the Label Data Dictionary entry txdata_name. The TXDATA (defined in the Data Dictionary) contains the mapping from the variables to the data in the given data file.
Note:
-
The label name parameter must always come before the label data information.
-
When printing from the command line and NOT using a data file, a user will have to press CTRL + Z and the Enter key once they are done entering data, rather than using the "/End" command.
Refer to Label formatter parameters/switches for information about which parameters are required for all print jobs, and where parameters can be defined.
Loading...
There was a problem loading this topic