ThingWorx Connection Services Extension (CSE) Reference
ThingWorx Connection Services Extension (CSE) Reference
The ThingWorx Connection Services Extension (CSE) is used to manage event notifications between Connectors and the ThingWorx Platform. You must install it before launching the Azure IoT Hub Connector because the Connector checks for the existence of the ConnectionServicesHub Thing. Make sure that you have imported the CSE before starting the Connector.
Contents
The CSE contains the supporting framework of objects that are required to enable event notification messaging for ThingWorx Connectors, such as:
ConnectionServicesHub Thing Template — Defines the base functionality of the Connection Services Hub, using Data Shapes and events.
ProtocolAdapter Thing Template and ProtocolAdapterWithAvailability Thing Template — Define the base functionality of a Connector and a Connector with High Availability created using the ThingWorx Protocol Adapter Toolkit.
Thing Shapes — Define services and properties for the Thing Templates and Things. Refer to CSE Thing Shapes for more information.
Data Shapes — Data structures that define the structure of the events. Refer to Data Shapes for descriptions of the Data Shapes provided with the Thing Template. Data Shapes also define Events, which in ThingWorx are notifications concerning changes in the state or value of properties.
Subsystem — A custom subsystem, ProtocolAdapterSubsystem that supports Connectors created using the ThingWorx Protocol Adapter Toolkit.
Functionality
Importing the CSE creates a default ConnectionServicesHub Thing from the ConnectionServicesHub Thing Template. The ConnectionServicesHub Thing is mutable, which means that you can alter it (not recommended). The ConnectionServicesHub Thing Template is immutable; you cannot change or delete it.
The CSE is used to define the set of events that allow the Connection Services Hub to send events to the ThingWorx Platform. Once your Connector is running, the Connection Services Hub is available to notify you if any warnings/errors occur on the Connector and to notify ThingWorx Platform of a configuration or state change.