| Redirection Notice This page should redirect to http://www.adaptavist.com/display/Plugins/Descendant+Notifications. |
Overview
Confluence already allows you to watch for activity on an entire space or individual pages. This plugin fills the gap between these two extremes. Allowing you watch a family of pages (a page and its descendants), receive notification of updates to the children of a watched page, or notifications of just news/blog posts if you so wish.
This is a much requested feature in Confluence as documented here CONF-6478. This plugin can go some of the way towards that feature request by allowing users to specify that they want to watch space news.
Features
- Descendant Notifications
A user can watch an entire hierarchy of pages via a new item in the Tools menu, and manage them from a new screen in their Profile.
- Automatic Child Page Notifications
A user can opt to receive notifications of updates to the immediate child pages of pages they are watching.
- News Notifications
A user can elect to be notified of just news/blog posts in a space, rather than page changes.
- Group News Notifications
A space administrator can specify groups of users to be notified of news/blog posts in a space.
- Watchlink Macro
Allow you to add a link to any page, which sets a watch on any other page in any space.
|
Automatic Child Page Notifications |
Installation:
The plugin is available through the Atlassian Plugin Repository (see here). It can also be downloaded manually (version 1.2 jar) then uploaded/installed into Confluence using the plugin manager.
Uninstall:
| Restart required to uninstall Please note, to uninstall this plugin a Confluence restart will be required. |
As this plugin replaces the default Confluence notification manager with its own version after you uninstall the plugin in the normal way you also have to restart Confluence to enable normal notifications to work.
Usage:
Descendant Notifications
This part of the plugin allows you to automatically be added as a page watcher for any new pages added under a given page family.
Adding descendant notifications
|
To watch a page hierarchy click on the 'Watch Page Family' item in the 'Tools' menu. You will then be added as a watcher of the current page and all of its descendant pages. You will also automatically become a watcher of all new descendants of the page too. Any descendant pages that were already selected with 'Watch Page Family' will no longer appear in the list when managing watches - since they are now covered by the newly selected page higher up the hierarchy. (Managing watches is explained in the next section) You can manually unwatch any of the descendant pages if you no longer want to receive notifications for an individual page. This will also stop you being automatically added as a watcher to any new child pages that are added to that page. |
Managing descendant notifications
|
When you are in a page hierarchy where Watch Page Family is active, you will see that the menu item has changed to 'Manage Page Family Watch'. This will take you to your profile, where you can view all of the page families you are currently watching. |
|
From this screen you have three options (circled in the screenshot) for each of the notifications you have set up:
|
Automatic Child Page Notifications
|
If you are not watching the entire page hierarchy you still have the option to receive notifications for updates to the immediate child pages of pages you are currently watching. This setting can be controlled through your user profile, by default it will be set to true for all users when the plugin is installed. |
News Notifications
This feature allows you to be notified of just blog posts in a space.
Adding news notifications
|
You can elect to watch news/blog posts by visiting the 'Advanced' space details page (from the 'Browse' menu), and clicking on the 'Watch Space News' link. You will now receive an email notification of all new blog posts within the space. |
Managing news notifications
|
You can review and manage your news notifications from your profile. Visit your profile and select the 'Page Family Watches' tab. |
Group News Notifications
|
This allows a space administrator to enable news notifications for a whole group of users. Enter the groups you wish to be notified in the text field or use the group picker to ease selection. Group can be removed from the notification by clicking 'Remove' to the right of the group name. |
{watchlink} macro
The {watchlink} macro creates a link on the page that allows you to set a watch on another page.
Parameters
- space (required)
Is the key of the space that contains the page to be watched.
- page (required)
The title of the page to be watched.
- descendents (optional)
Whether to watch just the specified page (false), or to watch all of it's descendants too (true).
Defaults to true.
- class (optional)
Allows you to specify a class attribute on the generated link markup, to allow custom styling in CSS.
{watchlink:space=ds|page=Home|descendents=false|class=watchlink}Watch Demonstration Home Page{watchlink}
TO DOs / Discussion
- Child page notifications aren't sent on a remove event, this doesn't seem to be possible since the page parent information is thrown away before the listener gets page event :-\
If you have any suggestions for improvements or notice any bugs please leave comments on this page. Please create a topic in our Forum or a bug report in the jira project for this plugin.


Comments (8)
Mar 04, 2010
David Hergert says:
Where is the option for Automatic Child Page Notifications? We are using 3.0.2 ...Where is the option for Automatic Child Page Notifications? We are using 3.0.2 and when you view your profile (https://wiki.company.com/users/viewmyprofile.action) or click edit, there is no option to change this setting.
And whats even more frustrating is some users have this setting turned on in the DB (I can see watchPageChildrenPreference set to true in the OS_PROPERTYENTRY table) but they have no way to turn it off via the UI.
Mar 10, 2010
Shannon Krebs says:
There is an open issue for that problem here: https://studio.plugins.atlassian.c...There is an open issue for that problem here: https://studio.plugins.atlassian.com/browse/CDESC-10
Mar 10, 2010
David Hergert says:
Thank you, that was especially helpful since the issue contains a workaround tha...Thank you, that was especially helpful since the issue contains a workaround that allows us to go straight to the page to change the preference for now. Thanks again!
Feb 10, 2011
Al Mecklenburg says:
If we install this plugin (we're on 3.3.6 and use Theme Builder), what, if anyth...If we install this plugin (we're on 3.3.6 and use Theme Builder), what, if anything, will happen to watches on pages that have been set prior to the new plugin install? Will they still exist? Also, what will happen to the "Watch this page" icon/function; will it still work as usual?
Feb 10, 2011
Shannon Krebs says:
Nothing will happen with the previous watches, they will remain as they are. Th...Nothing will happen with the previous watches, they will remain as they are. The watch page icon will also continue to work. Depending on how you have customised your menus with Themebuilder you may need to add the plugin menu items for watching a page hierarchy to you theme.
Feb 10, 2011
Al Mecklenburg says:
Thanks for your prompt response. Also, will the "Stop watching this page" funct...Thanks for your prompt response. Also, will the "Stop watching this page" function work?
Feb 10, 2011
Shannon Krebs says:
Yes that will continue to work as normal. If you stop watching a single page w...Yes that will continue to work as normal.
If you stop watching a single page where you have selected to watch the hierarchy you won't get added to any new pages under that one.
Mar 18, 2011
Joseph Davis says:
Hello, I am wanting to add the Watch Page Family option under tools but i'm hav...Hello,
I am wanting to add the Watch Page Family option under tools but i'm having a heck of a time trying to figure out how to do that. I've already added:
compound-menuitem:watchpage|caption=%Watch% this %page%
compound-menuitem:watchspace|caption=%Watch% entire space
Is there a simple compound menuitem I can add or is would I have to create a menulink alias pointing to webui link?
Thanks!