1. Service Capability Exposure Function User's Guide
  2. SCEF Functional Summary
  3. MQTT Broker
  4. MQTT General Guidelines

MQTT General Guidelines

General

OCSG Appserver startup time may be extended due to screening of all existing subscriptions from DB.

CustomSLA

  1. Topic prefix mandatory in CustomSLA for mqtt feature, without topic prefix in CustomSLA mqtt feature will not function as expected.
  2. When mqtt Topic prefix is removed from CustomSLA then corresponding subscriptions will be removed.
  3. Subscriptions and PUBLISH data from SCS/AS or Device will be rejected if the topic name does not contain any valid topic prefix.

NIDD/ME for IPDD

  1. Subscriptions without device details are treated as topic level subscription. Such that all publish messages from allowed devices for SCS/AS that match to the subscribed topic will be notified to the application.
  2. NIDD DLD without device details are treated as broadcast messages. MT messages will be send to devices subscribed to the publishing topic.
  3. Custom Header "Xscef-message-type: MQTT" is mandatory in case of broadcast MT messages and subscriptions without device details.
  4. In the NIDD downlink data deliveries on the request url, config id needs to be provided with value ipdd. Refer to Request Mapping section. If the application wants to receive notifications on buffered data delivery, self element needs to be populated with notification url in request body.
  5. For NIDD Buffered data delivery status notification, topic name will be provided in the link to indicate topic for which the buffered message is delivered.
  6. Buffered messages for devices are deleted after configurable period. Refer to DB Auditor section.

Application Retain Messages

  1. NIDD DLD broadcast messages will be persisted in broker.
  2. Only latest DLD message is retained at broker per topic.
  3. Upon receiving new subscription from device, matching retained messages are delivered to device.
  4. To clear retain message, SCS/AS should send DLD broadcast with empty data.

    { "data": "", "self": "http://192.168.102.5:10001/scs/resources/t8" }

APN Rate Control

APN rate control check is performed for MQTT CONNECT, SUBSCRIBE, and PUBLISH (to/from) from Devices.

MQTT Protocol Specific

  1. MQTT client ID in CONNECT is mandatory.

    There are no specific restrictions, but the size of Client ID cannot be more than 256 characters. Also, it is expected that Client ID is unique for each device.

  2. Retain message from device not supported.
  3. Qos only between Device and Broker is not applicable to T8 traffic.
  4. Topic name should not start with /.
  5. MQTT PUBLISH message does not support Binary format data.
  6. As per the specification, connection to the device drops upon unexpected error in message processing at Broker.
  7. It is expected not to give subscription topic same as the mqtt topic prefix. Wildcard is added at the end to receive all messages published for the topic prefix. For example, if mqtt topic prefix is "/oracle/bangalore/valence/" then subscription topic should be similar to "/oracle/bangalore/valence/#".

MQTT PSK

  1. PSK for devices can be configured using MQTT MBean operation. Refer to MQTT configuration section for more details.
  2. PSK is encrypted and persisted in SCEF database.

Will message

Device will messages are not persisted at MQTT Broker. Once the device is disconnected from the Broker, will message is removed and notified to all subscribed applications.

CDR

CDR's are created for all T8 Traffic.

AAA Device Provisioning

  1. Diameter server supports only TCP transport channel.
  2. AAA Diameter Stack starts in server mode.
  3. External load balancer required between AAA Server and APIGateway (OCSG ).