LabelPrintDefinition Section
These are settings for a label print definition.
- Parent Sections
- Full Section Key Path Examples
Workstation:LabelPrinting:PrintDefinitions:0
Workstation:LabelPrinting:PrintDefinitions:1
These settings apply to all label print definition types:
Key | Value Type | Default Value | Description |
---|---|---|---|
Name | string | The name for this label print definition. This is optional when there is only one label print definition. When there are multiple label print definitions, this name is used to select the print definition when printing a label. | |
Type | string | The label print definition type. This must be LoftwarePrintServer , Zebra , or the full name of a type derived from LabelPrintDefinitionBase. |
Additional settings are available, depending on the label print definition type, as detailed below. For custom label print definition types, additional settings correspond to public properties on the class.
LoftwarePrintServer
Type
This defines a label print job that will be submitted to a Loftware Print Server via the file interface by dropping an XML file into a shared network drive. These additional settings apply:
Key | Value Type | Default Value | Description |
---|---|---|---|
DropDirectoryName | string | The drop directory name into which to place the print job files. This is typically a shared network drive. | |
PrintJob | LoftwarePrintJob Section | The Loftware print job definition. |
Zebra
Type
This defines a label defined via a ZPL template that prints to a local or network Zebra printer. These additional settings apply:
Key | Value Type | Default Value | Description |
---|---|---|---|
LocalPrinterName | string | The name of the label printer installed on the computer. Use this setting when the label printer shows up as an installed printer on the Windows computer. | |
NetworkPrinterHostName | string | The network hostname or IP address of the Zebra bar code label printer. Use this setting when the label printer is connected via the network. | |
NetworkPrinterPort | integer | 9100 | The network port of the Zebra bar code label printer. This is typically 9100 but might also be 6101. |
LabelTemplateFile | string | The full path to the default label template file (on the Acuit Pinpoint Server), which should be ZPL (Zebra Programming Language) and can optionally contain placeholders. | |
Emulate | boolean | false | Whether to emulate label printing. When this is true , printing labels will cause an entry to be logged to the application log file instead of actually printing a label. |
Either LocalPrinterName
or NetworkPrinterHostName
can be configured, but not both.
The label template file is a file that includes ZPL (Zebra Programming Language), except that placeholders should be used where variable data should appear.
The recommended way to create label template files is to use Zebra's ZebraDesigner software. The general procedure is as follows (refer to the ZebraDesigner documentation for more information):
- Install ZebraDesigner and make sure the correct label printer is installed. If the actual printer will not be accessible to this computer, "FILE:" can be chosen as the port.
- Run ZebraDesigner and use it to create a label for the desired printer and label size. While
creating the label:
- For bar codes:
- Do not check "Print bar code as graphic".
- For bar code data, select "Fixed bar code data" and use placeholders where variable data should appear.
- For text:
- For content, select "Fixed text" and use placeholders where variable data should appear.
- For bar codes:
- Choose File, Print (Ctrl+P) to initiate printing the label.
- Set "Quantity" to the desired number of labels that should be printed each time a ticket is scanned.
- Check "Print to file".
- Click "Print", saving the output to a file, which will produce the ZPL label template for the label for the desired print quantity.
For more information about ZPL, see the following:
- Zebra (programming language) - Wikipedia
- Zebra Programming Guide (ZPL II, ZBI 2, Set-Get-Do, Mirror, WML)
- Labelary Online ZPL Viewer - This is a good resource for testing ZPL.
Label Placeholders
Placeholders should be used where variable data should appear. Placeholders are specified as named
items within {
and }
. Each placeholder may occur zero, once, or multiple times.
Labels printed via Acuit Pinpoint Workstation workflow configurations can use the following placeholders:
Placeholder | Gets Replaced By |
---|---|
{unitSerialNumber} |
the unit serial number, for stations that work with units |
{unitModelNumber} |
the unit model number |
{unitModelNumberAlias} |
the unit model number alias |
{unitProductionGroupName} |
the unit production group name, from the production schedule |
{unitSequenceNumber} |
the unit sequence number, from the production schedule |
{assemblySerialNumber} |
the assembly serial number, for stations that work with assemblies |
{assemblyModelNumber} |
the assembly model number, for stations that work with assemblies |
{scheduleName} |
the production schedule name (this is deprecrated and will be removed in a future version; unitProductionGroupName should be used instead) |
Labels printed by plug-ins can use whatever placeholders the plug-in provides.