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 10 Current »

This feature is restricted to Jira Administrators and Dashboard Folders Administrator only

This is the main page to configure the Folders and the Dashboard within the Folders.

Navigate to Dashboard Folders

  1. Click Settings → Issues on the top right hand corner

  2. Click Dashboard Folders under Dashboard Folders Configuration section on the left panel

Alternatively, you can use the keyboard shortcut if you are Jira Administrator:

  1. Key 'g' + 'g' consecutively on any Jira page

  2. Type Dashboard Folders in the search box

  3. Click Dashboard Folders

Dashboard Folders Page

The main Dashboard Folders page allows the admin to:

  • View the Dashboard Folders hierarchy 

  • Add or Delete Folders

  • Edit each Folder details

  • Manage each Folder contents (Dashboard)

  • Toggle Dashboard and Folder Details view (on this page)

  • Search Folder/Dashboard (on this page)

User Action

Description

1

Toggle Dashboard

Toggle button to display the list of Dashboard within each folder

2

Toggle Folder Details

Toggle button to display the Folder Details for each folder.

Folder Details include:

  • "Viewer" permission

  • Folder “Ordering”

3

Add Folder

Add a sub-folder to the current selected folder

Refer to https://akeles.jira.com/wiki/spaces/DFOLDER/pages/7300415489/Configure+Dashboard+Folders#Add%2FEdit-Folder

4

Edit Folder 

Edit the current selected folder "Name" and "Viewer" permission

Refer to https://akeles.jira.com/wiki/spaces/DFOLDER/pages/7300415489/Configure+Dashboard+Folders#Add%2FEdit-Folder

5

Manage Folder

Manage the Dashboard in the current selected folder

Refer to https://akeles.jira.com/wiki/spaces/DFOLDER/pages/7300415489/Configure+Dashboard+Folders#Manage-Folder

6

Delete Folder

Delete the current selected folder

Add/Edit Folder

From each Folder, administrator can add new sub-folder to it or edit the details of the existing Folder (except for the "Home" folder).

  • Adding new Folder:

  • Editing a Folder:

Field

Description

Folder Name

The name of the Folder.

Folders will be displayed in the Ordering and/or natural sort order of the Folder Name.

Tip: if you do not want to set an Ordering, try prefix the Folder Name with a number so that it will be naturally sorted by this prefix number

e.g. 1. General, 2. Teams, 3. Departments

Ordering (Optional)

Allows administrator to define an ordering number to position the current child Folder within the parent Folder.

See https://akeles.jira.com/wiki/spaces/DFOLDER/pages/7300415489/Configure+Dashboard+Folders#Folder%2FDashboard-Ordering

Viewers

This is the selected list of viewers that can view this Folder. 

Refer to Select Viewers field below on how to select the list of viewers.

For groups/project roles, click on the × icon on each label to remove the selected group/project role.

Select Viewers

Select the permissible groups of user that can view this Folder. 

  • If a folder is not visible to a user, all it's sub-folders will also be hidden from the user

  • Visibility of the Dashboard in each Folder will still adhere to the viewer permission set on each Dashboard

  • A folder will not be shown to user if it has no visible Dashboard or sub-folders within it

Refer to the next table for the different types of Viewers.


Folder Viewers can be set to one of the following types:

Type

Description

Private

  • This is the default type

  • Only Jira Administrators and Dashboard Folders Administrators can view

Public

  • This allows anyone to view the Folder, including users that are not logged in

    • For users not logged in: this is only applicable to Jira instance set to "Public" mode and the Folder contains Dashboard shared to the public

Logged in users

  • This allows any logged in user to view the Folder

Shared to Group/Project

  • This allows user in the selected group(s) and project role(s) to view the Folder

  • After selecting the group(s) or project role(s), click on "+ Add" button to add the selection to "Viewers"

  • For Dashboard Folders Administrators, they can only add/remove  

    • Group(s) that they belong to

    • Project(s) where they have browse or administrator permission for

Manage Folder

From each Folder, administrator can edit the Dashboard within it.

Field

Description

Dashboard

The Dashboard to be filled into the current Folder

Alias Name (Optional)

An alias name for the Dashboard within the current Folder

This alias name will appear in the top menu bar Dashboards dropdown and also on the side bar when viewing a Dashboard

The Dashboard will be sorted automatically in natural order by alias name (if applicable) followed by Dashboard name

An alias name can help to:

  • simplify Dashboard name without changing the actual Dashboard name

  • promote generic Dashboards that are placed into multiple Folders using different alias name that are relevant to the Folder

  • reorder the Dashboard position – actual Dashboard name is shown in brackets

Without Alias Name

With Alias Name

Ordering (Optional)

Allows administrator to define an ordering number to position the Dashboard within the current Folder.

See https://akeles.jira.com/wiki/spaces/DFOLDER/pages/7300415489/Configure+Dashboard+Folders#Folder%2FDashboard-Ordering

Remarks (Optional)

Allows administrator to leave a short note to other administrators

This field has a character limit of 255 characters

Folder/Dashboard Ordering

From Dashboard Folder v2.1.0 onwards, admin can set an “Ordering” number to place an item before or after the naturally sorted items.

  • Item here refers to either the child Folder or Dashboard within a parent Folder

“Ordering” is a whole number where:

Ordering

Description

No value or 0

there is no ordering defined and the item will be sorted by natural order

> 0 (positive number)

ordering is above the natural sort items, with the smallest positive number on top and largest positive number right before the natural sort items

  • e.g. 1 → 5 → 10 → 0

< 0 (negative number)

ordering is below the natural sort items, with the largest negative number right after the natural sort items and smallest negative number at the end

  • e.g. 0 → (-1) → (-5) → (-10)

Folder Ordering

Dashboard Ordering

Configure

See https://akeles.jira.com/wiki/spaces/DFOLDER/pages/7300415489/Configure+Dashboard+Folders#Add%2FEdit-Folder

See https://akeles.jira.com/wiki/spaces/DFOLDER/pages/edit-v2/7300415489#Manage-Folder

View

The plugin will validate that there are no duplicated “Ordering” of the same item type within the same parent Folder.

Duplicate Folder

Duplicate Dashboard

The same “Ordering” can be used for different item type within the same Folder:

e.g.

Sub-Folder Ordering within a “General” Folder

Dashboard Ordering within a “General” Folder

If your instance has migrated from Dashboard Folder v1.x to v2.0.0 before, “Ordering” might not be re-migrated.

Refer to /wiki/spaces/DFOLDER/pages/7417561184 for more details.

  • No labels