Reserved Keys for Detailed Status for cab Devices
The following reserved keys can be used to refer to detailed device data retrieved from a cab 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 cab device by using a detailedDeviceStatus business rule component.
| Reserved Key | Description |
|---|---|
| DDS_APPLICATORNOTREADY |
Whether the applicator is not ready (hardware dependent). true: Not ready false: Ready |
| DDS_ERRORCODE | If there is an error, an error message is displayed. Otherwise, nothing is displayed. |
| DDS_EXTPAUSESIGNAL |
Whether an external pause signal is active (hardware dependent). true: Active false: Not active |
| DDS_EXTPRINTSIGNAL |
Whether an external print signal is active (hardware dependent). true: Active false: Not active |
| DDS_JOBSINQUEUE |
Whether the device has jobs enqueued. true: In queue false: None in queue |
| DDS_LABELSREMAINING | For the current job, the number of labels remaining in the print buffer waiting to be printed. |
| DDS_LABELWAITING |
Whether a label is waiting in the in demand position to be torn off. true: Label waiting false: No label waiting |
| DDS_ONLINE |
Whether the device is online or offline. true: Online false: Offline |
| DDS_PAPERMOVING |
Whether the paper in the device is currently moving. That is, whether the Feed button is being held. true: Moving false: Not moving |
| DDS_PAUSED |
Whether the device has been manually paused. true: Paused false: Not paused |
| DDS_READYFORDATA |
Whether the device is ready to receive print data. true: Ready false: Not ready |
| DDS_VACUUMPLATE |
If the device includes an applicator with a vacuum plate, whether a label is on the vacuum plate. true: Label on vacuum plate false: Vacuum plate is empty |
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 cab device by using a detailedDeviceInfo business rule component.
| Reserved Key | Description |
|---|---|
| DDI_FIRMWAREVERSION | The version number of the firmware installed for the device. |
| DDI_FREEMEMORY |
The amount of memory in bytes available on the device. |
| DDI_HARDWAREMODEL | The model number of the device. |
| DDI_RESOLUTION |
The resolution configured for the device in Dots Per Inch (dpi). Tip: You can configure the Device Resolution in the Options tab. |
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. |
more