Print job

The simplest form deselects any existing jobs, or selects a single label, but it can also set up a database driven job. The job can either replace the existing job, or add it to a queue.

All parameters are optional, but there needs to be one to specify the label, i.e. labelName, labelColumn or labelData. If any of the table parameters is used, then tableName, keyColumn and key must all be set.

Parameter	Type	Description
autoPrintGap	number	Auto-print gap in nanometers.
autoPrintInterval	number	Auto-print interval in nanometers.
checkpoint	boolean	See the seekPrintQueueCheckpoint API method.
copies	number	Limit the number of copies to print. Default is unlimited.
copiesColumn	string	Table column where the number of copies to print is available.
description	string	Description which will be displayed on the Overview tab in the user inteface.
firstRow	number	First table row index to use when selecting with tableName and labelName. Defaults to 0.
freeze	boolean	If true, then the label will be frozen, i.e. the current label content, as well as all dynamic text, will be copies and unaffected by any changes. It will also cause all used counters to increment immediately. The default value is the value of the queue parameter.
key	string	Value to search for in the keyColumn of the table.
keyColumn	string	Column in which to search to select the row to use.
labelName	string	The name of a label.
labelData	Label	A complete label object.
labelColumn	string	Table column where the label name is available.
printDelay	number	Per-job print delay override in millimeters.
printedColumn	string	Table column where to number of printed labels is stored. The value in this column will be incremented when printing.
queue	boolean	If true, then the label will be added to the end of the queue of jobs, else it will replace any existing queue with this job.
rowCount	number	Number of table rows to use when selecting with tableName and labelName. Defaults to all remaining rows from firstRow.
repeatPrintGap	number	Repeat print gap in nanometers.
repeatPrintInterval	number	Repeat print interval in nanometers.
roundRobin	boolean	If set, then the print job will be moved to the back of the queue when completed.
stepCounters	boolean	If true, step counters when the job is frozen. Default is true.
tableName	string	The name of a table.

Auto-print

Auto-print is a feature that automatically triggers a job after the previous job is completed, and the configured gap/interval has elapsed.

tip

Since v4.2.0, if there are no other print jobs waiting in the queue, the job will be automatically printed once the configured gap/interval has elapsed.

Examples

Deselect all print jobs (clearing the queue):

{}

Select a single label "MyLabel":

{"labelName": "MyLabel"}

Select a single label "MyLabel", limit to a single print, and add to the end of the queue:

{
  "labelName": "MyLabel",
  "copies": 1,
  "queue": true
}

Search the table "MyTable" in the column "Product" for "MyProduct", and select the label from the column "Label":

{
  "tableName": "MyTable",
  "keyColumn": "Product",
  "key": "MyProduct",
  "labelColumn": "Label"
}