Topics
Arlanix Notifications

For arlanix/notification 1.0.0

Topics

A topic is what a message is about, such as Feed alerts or Orders. A rule names the topic it sends to, and the people subscribed to the topic get it.

Open Topics

Click Arlanix in the admin's menu, then Topics under Notifications.

The Arlanix menu open, with Topics lifted

The grid lists the topics: what each is about, whether it delivers, how many active subscriptions it has and when it last got a message.

The Topics grid: name, description, whether it delivers, its active subscriptions and its last message

Make a topic

  1. Click Add topic.

    The Topics grid with Add topic lifted

  2. Enter a Name, such as Orders, and a Description of what is sent to it, such as Orders the sales team should hear about.: whoever subscribes reads it. Leave Delivers on.

    The topic form: Name Orders, the description, Delivers on

  3. Click Save. The topic's page stays open and says Topic "Orders" saved., now with Subscriptions under it.

    The topic's page after the save: Topic "Orders" saved., and Subscriptions with Add subscription

Two topics cannot have the same name: a second Orders is refused, and the form keeps what you typed.

The form refusing a second topic of the same name: A topic with this name already exists.

Then make the rule that sends to it. Until then, nothing is published to it but your tests.

Subscribe people on its page

A saved topic's page lists its subscriptions under Subscriptions, with how each is delivered, where to, and how its last delivery went.

A topic's page: its subscriptions, with Add subscription

  1. Click Add subscription. The subscription form opens in a panel over the page, on this topic.

  2. Fill it in, as Subscriptions says, such as Sales team by Email to [email protected], and click Save in the panel.

    The panel over the topic's page: Sales team on Orders, Everything, Email, sales@example.com

  3. The panel closes, and the list shows the subscription.

    The topic's page after the save: Subscription "Sales team" saved., and the subscription in the list

In a row, Select > Edit opens the subscription in the panel again, and Select > Send test message sends it a test: see Subscriptions. A refused save, such as a second subscription to the same address, says why at the top of the panel, which stays open. A topic not saved yet has no list: save it first.

Try it

Publish test message publishes a message as a module would: it goes into the Message Log and to every subscription of the topic that takes everything, within a minute or so.

  1. In the topic's row, click Select, then Publish test message.

    The Topics grid: Feed alerts' Select open, with Publish test message

  2. Click OK to publish it.

    The confirmation before a test message is published to the topic

A subscription that takes only warnings and errors does not get the test, which is informational. To test one subscription on its own, use its Send test message: see Subscriptions.

Mute a topic

  1. In the topic's row, click Select, then Edit.

  2. Switch Delivers off, and click Save.

    Delivers switched off on the topic's page

What is published to it is dropped, and no subscription gets it. Switch it on again to resume; nothing published in between is sent.

Delete a topic

  1. In the topic's row, click Select, then Delete.

  2. The confirmation says what goes with it. Click OK.

    Delete topic: the confirmation, with what goes with the topic, and OK

Its subscriptions and rules go with it. Its messages stay in the Message Log.