Reserved Keys for Detailed Status for NOVEXX Solutions Devices

The following reserved keys can be used to refer to detailed device data retrieved from a NOVEXX Solutions or Avery Dennison EasyPlug EasyPlug, a printer command language by NOVEXX Solutions. NOVEXX Solutions originated from Avery Dennison's Industrial Paint & Apply (IPA) line of business. device by using a detailedDeviceStatus or detailedDeviceInfo business rule component. For examples, see Retrieve Detailed Device Status (XML).

Important! The detailedDeviceStatus and detailedDeviceInfo business rule components are supported for use only with Avery Dennison, cab, Datamax-O'Neil, Epson, Intermec IPL, Loftware, NOVEXX Solutions, PCL, Printronix, QuickLabel, SATO, Toshiba, and Zebra devices.

Important! Content in a business rule is case sensitive. This includes business rule component names, attributes, and values.

Device Status Data

The following reserved keys can be used to refer to detailed device data retrieved from a NOVEXX Solutions device by using a detailedDeviceStatus business rule component.

Reserved Key	Description
DDS_BYTES_AVAILABLE_IN_SPOOLER	The amount of space available in the spooler in bytes.
DDS_LABELS_REMAINING	The number of labels remaining to be printed for this current print job.
DDS_OPEN_FORMAT	Whether there is a label open, not yet closed by using the #Q command. true: A label is open false: No labels are open
DDS_STATUS_ACKNOWLEDEGMENT	Whether the device status has been acknowledged by the physical device. true: Acknowledged false: Not acknowledged
DDS_STATUS_NUMBER	The error ID number for an error that has occurred. For information about the meaning of a specific status number, see NOVEXX Solutions documentation.
DDS_STORED_FORMAT	Whether a label is stored. true: Stored false: Not stored
DDS_VALID_FORMAT_PRINTING	Whether a valid label is printing. true: Valid and printing false: Not valid or not printing

Common Reserved Keys for Device Status

These keys are available for most devices supported by Loftware Enterprise SP.

Reserved Key	Description
DDS_CONNECTIONERROR	Whether any connection errors have occurred. true: Connection errors occurred false: No connection errors occurred
DDS_ENABLED	Whether Detailed Device Status reporting is enabled for this device in Loftware Enterprise SP. true: Enabled false: Disabled
DDS_FATALERRORS	Whether any errors that would prevent printing occurred. true: Errors that prevent printing occurred false: No errors that prevent printing occurred Note: Not supported on Avery Dennison, NOVEXX Solutions, PCL, QuickLabel, or Toshiba devices.
DDS_PAPERERROR	Whether the device is out of label stock. true: Out of stock false: Not out of stock Note: Not supported on Avery Dennison, NOVEXX Solutions, PCL, QuickLabel, or Toshiba devices.
DDS_PRINTHEADERROR	Whether the print head is up and not ready for printing. true: Print head is up, not ready to print false: Print head is down, ready to print Note: Not supported on Avery Dennison, NOVEXX Solutions, PCL, QuickLabel, or Toshiba devices.
DDS_RAWDATA	The raw data (base 64 encoded) returned from a call to retrieve detailed device status from this device by using a business rule.
DDS_RIBBONERROR	Whether the device is out of ribbon. true: Out of ribbon false: Ribbon available Note: Not supported on Avery Dennison, NOVEXX Solutions, PCL, QuickLabel, or Toshiba devices.
DDS_SUPPORTED	Whether Detailed Device Status reporting is supported and enabled for this device in Loftware Enterprise SP. true: Supported and enabled false: Not supported, disabled, or both

Device Information Data

The following reserved keys can be used to refer to detailed device data retrieved from a NOVEXX Solutions device by using a detailedDeviceInfo business rule component.

Reserved Key	Description
DDI_VERSION	The version number of the firmware installed for the device.

Common Reserved Keys for Device Information

These keys are available for most devices supported by Loftware Enterprise SP.

Reserved Key	Description
DDI_CONNECTIONERROR	Whether any connection errors have occurred. true: Connection errors have occurred false: No connection errors have occurred
DDI_DEVICEFAMILY	The name of the device family in Loftware Enterprise SP.
DDI_DEVICEMODEL	The model of the device in Loftware Enterprise SP.
DDI_ENABLED	Whether Detailed Device Info reporting is enabled for this device in Loftware Enterprise SP. true: Enabled for this device. false: Disabled for this device.
DDI_RAWDATA	The raw data (base 64 encoded) returned from a call to retrieve detailed device information from this device by using a business rule.
DDI_SUPPORTED	Whether Detailed Device Info reporting is supported and enabled for this device in Loftware Enterprise SP. true: Supported and enabled for this device. false: Not supported, disabled, or both for this device.