Product Documentation

MQTT V3 Plug-in Reference

Previous Topic

Next Topic

Rename Persistence Topic

"operation"

  • String
  • Required
  • No default value
  • Value: "RenamePersistenceTopic"

It renames a Persistence Topic.

Renaming a Persistence Topic causes FairCom MQTT Broker to listen for and handle messages published to the renamed topic instead of the original topic. This is because the "PersistenceTopic" property specifies the topic of data messages for FairCom MQTT Broker to listen for.

It does not change any other properties of the Persistence Topic.

"PersistenceTopic"

  • String
  • Required
  • No default value

It is the existing Persistence Topic you want to rename.

If this name does not correspond to an existing Persistence Topic, the operation fails. c-tree logs an error to its CTSTATUS.FCS file.

"newPersistenceTopicName"

  • String
  • Required
  • No default value

It is the new name for the Persistence Topic, and the new topic for the data messages to which this Persistence Topic will subscribe.

Example JSON message payload published to the "ctreeAdministration" topic.

{

"operation": "renamePersistenceTopic",

"persistenceTopic": "AirInfo",

"newPersistenceTopicName": "AirQualityInfo"

}

TOCIndex