Settings

Prerequisites

The Broker requires:

• the Inventory module installed
• a configured connection to the system database

Enabling Message Intake

Message intake is disabled by default, and the Broker journal stays empty. To enable intake, open Main Menu - Settings - Dev Tools and run the request:

PUT _cluster/settings
{
  "persistent": {
    "sm.broker.enabled": true
  }
}

After that, the modules start sending messages to the journal.

To disable intake, run the same request with the value false. New messages stop arriving in the journal, while the messages and objects already received are kept.

Journal Retention Period

By default, messages are kept in the journal for 12 months, and older messages are deleted. The period is set in months by the cluster setting sm.broker.retention_months. The value 0 disables deletion.

Example request that sets a retention period of 6 months:

PUT _cluster/settings
{
  "persistent": {
    "sm.broker.retention_months": 6
  }
}

Access Permissions

Access to Broker data is granted by permissions on modules and on identification configurations:

• read permission on a module opens its messages in the journal
• read permission on an identification configuration opens its objects: the list, the cards and the link graph
• write permission allows enabling and disabling a module, or changing, rebuilding and deleting a configuration

Access to a single module is set with the Permissions item in the module's action menu on the Message sources page. Access to a single configuration is set the same way on the Identification rules page.

Access to all modules and configurations at once is granted by cluster permissions assigned to a role:

Permission	Grants
cluster:admin/sm/broker_sources/read_all	viewing all modules
cluster:admin/sm/broker_sources/write_all	changing all modules
cluster:admin/sm/broker_identity_configs/read_all	viewing all identification configurations
cluster:admin/sm/broker_identity_configs/write_all	changing and deleting all identification configurations
cluster:admin/sm/broker_identity_configs/create	creating identification configurations

Adding a Section to the Main Menu

To add the Broker to the menu, go to Main Menu - Settings - Module Settings - Main - Menu Settings - JSON Structure and add the JSON object below to the data list.

Broker menu

{
  "itemType": "group",
  "name": "broker",
  "id": "7fe7e349-698b-48e5-a132-cd67b6f7f49e",
  "title": "Broker",
  "enabled": true,
  "sections": [
    {
      "itemType": "page",
      "name": "sources",
      "id": "e737692c-6e1f-47dd-be5c-e6dc42716386",
      "title": "Message sources",
      "enabled": true
    },
    {
      "itemType": "page",
      "name": "messages",
      "id": "058de378-b050-4fa5-a4ec-62e10d28f096",
      "title": "Journal",
      "enabled": true
    },
    {
      "itemType": "page",
      "name": "objects",
      "id": "f41800c7-0710-46e2-8c54-74f4303de08b",
      "title": "Objects",
      "enabled": true
    },
    {
      "itemType": "page",
      "name": "identity",
      "id": "a057f380-33da-47b0-8bdb-cfcaa441b86d",
      "title": "Identification rules",
      "enabled": true
    }
  ]
}