Plugin Documentation : Custom Mentions

Mention groups and other sets of users.

Have you ever wondered why mentioning users on a Confluence page is straightforward and easy, but mentioning entire groups seems impossible? Many people did...

One of the highest voted feature requests in Atlassian's product backlog for Confluence is this: Extend 'Mentions' to work with groups as well.

Since we from //SEIBERT/MEDIA were also missing this feature, we've implemented a small prototype app to allow group mentions.


How does it work?

Simply install the app and groups will appear in the @-mention autocomplete. Just select the group and it gets inserted the same way as for user mentions.

Mentions work on Confluence pages, blogposts, comments and in Microblog posts.

Groups are distinguished in the dropdown using the Confluence group icon (three heads on blue background).

After saving the page, all current members of the group receive an email and a workbox notification by default.

Settings

You can configure in which way you'd like to receive custom mentions, i.e. mentions of groups that you are a part of: by email, or as Confluence notification in your workbox.

To reach this configuration page, use the 'Notification Settings' link in your user dropdown menu

(question) Administrators can also configure this for other users: /plugins/custommentions/notificationsettings.action?userName=<USER_NAME>

What is planned for the future?

  • Allow configuration of the mention limit (current limit: 500 users within one group)
  • Provide a way to block certain (large) groups from being mentioned
  • Expand which sets of users can be mentioned
    For example: we are currently working to support mentions for Space Privacy extranet roles.

Prototype restrictions

As this is a prototype, not all functionality is supported, and some might not work as you'd expect.

  • For now, Custom Mentions is only tested on Confluence Server. Confluence Data Center and Confluence Cloud are not supported. 
  • At most 500 users from one group can be notified with a mention, the other users will not receive a notification (this is due to performance risks).
  • Custom Mentions do not work in the Mobile app (including Linchpin Mobile).
  • Custom Mentions only work when they are added in the Confluence editor with the @-mention autocomplete syntax. Custom Mentions do not work if inserted through Wiki markup ([~name]) or any other API that can modify content (SOAP, REST).
  • There is no link target for rendered Custom Mentions (regular user mentions link to that user's profile).
  • Custom Mentions cannot be renamed (their displayed name cannot be altered).
  • Custom Mentions do not work with Confluence tasks (they won't appear on your personal task list).

Download 

Please note that you install the app at your own risk!