ThingWorx Connection Services Extension (CSE) Reference > CSE Data Shapes > CXSEvent.ProtocolError Data Shape
CXSEvent.ProtocolError Data Shape
The CXSEvent.ProtocolError Data Shape defines a set of fields that are associated with a ProtocolError event. This event indicates a problem at the message protocol level, such as an invalid type for a data item, the use of an identifier by the ThingWorx Platform when sending egress for an edge device that is running an eMessage agent, or other unexpected message.
Fields
The CXSEvent.ProtocolError Data Shape includes the following fields:
Field Name
Base Type
Description
id
STRING
Defines the event id which is typically a UUID.
message
STRING
Defines the message for the event, which provides details about the event.
ThingName
STRING
Defines the name of the Thing associated with the protocol error.
context
JSON
Provides additional context information as a JSON object. Refer to the table below for information that the context field includes for different errors.
The context field provides different content, based on the actual error.
Actual Error
Context
Invalid type for a data item
A map of the invalid data items, which shows the name of each data item and its corresponding type. Both the name and type are STRING fields.
Invalid registration message (Agent Ingress message)
The message did not contain the ping rate for the Agent. It is unlikely that this event will occur. However, if it does, you can use the SetPingRate service to set a ping rate on the Agent. Keep in mind that this service does not change the Agent configuration; the setting stays in effect only until the Agent is restarted.
Invalid quality for a data item
The Azure IoT Hub Connector handles the quality of a data item value, supporting the possible values, good, bad, and uncertain. It is unlikely that this event will occur. If it does, the context provides a map of the invalid data items, which shows the name of each data item and its corresponding quality. Both the name and quality are STRING fields.