Skip to end of banner
Go to start of banner

Configuration Guide

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »


The plugin allows you to replace the default global dashboard with your custom one in Confluence. It even enables you to have team dashboards or personal dashboards. The plugin also includes macros for displaying the popular pages, a beautiful weather widget or the daily Dilbert strip on your custom dashboard.

Please check out our blog post for many detailed examples of how to use Custom Dashboards for Confluence!

Feature Highlights

  • Replaces the native dashboard  Replace the default global dashboard with a custom one defined on a simple wiki page

  • Full access control  Limit access to the global dashboard by defining filter rules for selected users and groups

  • Unique and customizable Create different dashboards for different teams

  • Personal instances  Allow users to create personal dashboards

  • Most importantly, Dilbert  Display the daily Dilbert strip on your custom dashboard

Configuration Guide

Go to Browse > Confluence Admin > Configuration > Dashboard Configuration to configure your filter rules. Filter rules define which dashboard needs to be displayed for which user when he clicks on a dashboard link anywhere within Confluence. Each filter rule is specified by the following information:

Filter Priority

The priority of the filter rule. The priority is used to determine the order the filter rules should be processed. The priority is only important if you define more than one filter rule. A lower value means a higher priority.

Show content from

Which content to show as your dashboard. Choose one of the following options:

Global Dashboard

The default global dashboard of Confluence.

Site Homepage

Either the global site homepage configured in the general configuration of Confluence or the personal site homepage, if the user has configured one in his user settings. Note: The user's personal settings will override the global setting. Use this option to allow personal dashboards.

Wiki Page

Any wiki page within your Confluence. Use this option to display a specific wiki page as dashboard instead of the default dashboard.

Show content as

Enable Show content always as dashboard to render wiki pages as dashboards as well, without edit button, comments, etc.

Show content to

You can restrict filter rules to either all users or a specific set of users and/or groups. Choose All Users if you want the rule to apply to all users or choose Restrict to and define the users and/or groups for which the rule should be applied to. Check Anonymous users if the restriction should also affect anonymous users.

Note: A filter rule will be applied as long as the user meets at least one of the restrictions. If no filter rule matches or no filter rules are defined, the default dashboard of Confluence will be displayed.

Configuring Common Use Cases

Dashboards for the team, the company, or individuals.

Custom Global Dashboard

Use the following configuration to display a wiki page instead of the default dashboard for all users:

Filter Priority:

1

Show content from:

Choose Wiki Page and select the desired wiki page in the autocomplete field.

Show content as:

Enable to render wiki page as dashboard.

Show content to:

Choose All users.

Team Dashboards

To create different dashboards for different teams you need to define a filter rule for every team:

Filter Priority:

1

Show content from:

Choose Wiki Page and select the team dashboard (e.g. Sales Dashboard) in the autocomplete field.

Show content to:

Choose Restrict to and specify the team (e.g. sales-group) in the Groupsautocomplete field.

Filter Priority:

2

Show content from:

Choose Wiki Page and select the team dashboard (e.g. Sales Dashboard) in the autocomplete field.

Show content to:

Choose Restrict to and specify the team (e.g. marketing-group) in the Groups autocomplete field.

Personal Dashboards

To allow personal dashboards set the site homepage as dashboard location. With this configuration the plugin tries to use the user's personal site homepage if configured. Otherwise the plugin reverts back to the global site homepage.

Filter Priority:

1

Show content from:

Choose Site Homepage.

Show content to:

Choose All users.

Limit Access To Global Dashboard

You can also use the Custom Dashboards plugin to limit access to the default dashboard. E.g. the following configuration restricts the access of the default dashboard for anonymous users by redirecting them to another wiki page:

Filter Priority:

1

Show content from:

Choose Wiki Page and select the desired wiki page which should be displayed to anonymous users in the autocomplete field.

Show content to:

Choose Restrict to and check Anonymous users.

Macros for Sprucing up Dashboards

In addition to existing macros like the Chart Macro, Panel Macro or the Image Slider Macro, the Custom Dashboards plugin offers the following macros to help you make your dashboards even cooler:

Popular Pages Macro

Use the Popular Pages macro to display the most popular pages of the last 7 days as list. It allows you to display the same content as shown on the right side of the default dashboard of Confluence.

Macro Parameters

Parameter

Default

Description

Max Results
maxResults

10

The maximum number of results to display.

Hide Header
hideHeader

false

Allows you to hide the header of the table.

Dilbert Macro

Use the Dilbert macro to display the daily Dilbert strip on your dashboard and make your employees smile in the morning.

Note: Mohami is the official licensed distribution partner of Dilbert for Atlassian Confluence. If you are looking for a legal solution to display the daily Dilbert strip in Confluence, this is the way to do it.

Macro Parameters:

Parameter

Default

Description

Width
width

None - Maximum width will be used.

Width of the Dilbert strip in pixels. Leave blank for maximum width.

Forecast Macro

Use the Forecast macro to display a beautiful weather widget in Confluence. Choose whether you want to display the current weather with or without a daily forecast.

Note: The weather widget will only be displayed if the user's browser has access to the internet. Also the city search feature only works if your Confluence server has access to the internet. If your Confluence doesn't have internet access, please enter latitude and longitude manually.

Macro Parameters:

Parameter

Default

Description

City Name
name

None - No name will be displayed in header.

Name of the city displayed in header. Leave blank for no name.

Latitude
lat

-

Latitude of the city.

Longitude
long

-

Longitude of the city.

Display Mode
mode

currentWeatherWithDailyForecast

Choose whether to display the current weather with or without a daily forecast. Valid values are:

  • currentWeather - Current weather

  • currentWeatherWithDailyForecast- Current weather with daily forecast

Units
units

us

Choose between the following units:

  • us - Fahrenheit and mph

  • uk - Celsius and mph

  • ca - Celsius and km/h

  • si - Celsius and m/s

Text Color
textColor

#333333

Color of all the text in the widget.

Bar Color
barColor

#333333

Color of the bars in the widget.

Animated Skycons
animatedSkycons

true

Enable to display animated skycons.

Hide Header
hideHeader

false

Enable to hide the header of the widget.


Scheenshot Walkthrough

  • No labels