Reserved Keys for Detailed Status for Datamax-O'Neil Devices
The following reserved keys can be used to refer to detailed device data retrieved from a Datamax-O'Neil (DPL
Datamax-O'Neil Programming Language, a printer control language.) device by using a detailedDeviceStatus or detailedDeviceInfo business rule component.
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 Datamax-O'Neil device by using a detailedDeviceStatus business rule component.
| Reserved Key | Description |
|---|---|
| DDS_CUTTERERROR |
Whether there is a mechanical problem with the cutter. true: Cutter error false: No cutter error |
| DDS_INTERPRETERBUSY |
Whether the interpreter is busy. true: Busy false: Ready |
| DDS_LABELWAITING |
Whether a printed label is waiting to be torn off and removed from the device. true: Label waiting false: No label waiting |
| DDS_PAUSED |
Whether the device has been manually paused. true: Paused false: Not paused |
| DDS_PRINTING |
Whether the device is busy with a print job. true: Currently printing a job false: Not currently printing a job |
| DDS_READY |
Whether the device is ready to receive data. true: Ready for data false: Not ready for data |
| DDS_REWINDERERROR |
Whether there is a mechanical problem with the rewinder. true: Rewinder error false: No rewinder error |
| DDS_RIBBONSAVERERROR |
Whether there is a mechanical problem with the ribbon saver. true: Ribbon saver error false: No ribbon saver error |
| DDS_TOPOFFORMERROR |
Whether the sensor is not properly calibrated for the media. true: Top of form error false: No top of form error |
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 Datamax-O'Neil device by using a detailedDeviceInfo business rule component.
| Reserved Key | Description |
|---|---|
| DDI_BACKUPSPEED | The speed at which the device rewinds media. |
| DDI_COLUMNOFFSET | Horizontal adjustment of the point where printing begins. |
| DDI_FEEDSPEED | The speed at which the device feeds blank media. |
| DDI_FIRMWAREVERSION | The version number of the firmware installed for the device. |
| DDI_MEDIATYPE |
Whether the device is configured for Direct Thermal or Thermal Transfer media. Values: DIRECT_THERMAL, THERMAL_TRANSFER |
| DDI_PRESENTDISTANCE | The distance for the label to travel at output. |
| DDI_PRINTSPEED | The speed at which the device prints labels. |
| DDI_ROWOFFSET | Vertical adjustment of the point where printing begins. |
| DDI_SENSORTYPE |
The type of media the sensor is configured to detect. Values: GAP, REFLECTIVE, CONTINUOUS |
| DDI_SLEWRATE | The slew rate or speed at which paper is fed when advancing over non-printing areas. This value may affect device throughput. |
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. |