Index

This documentation relates to version 4.1 of the Structure Plugin for JIRA and subsequent patch releases. Documentation for previous versions is available via Documentation Index.

Skip to end of metadata
Go to start of metadata

Structure provides a dashboard gadget that allows you to view and edit structure. The gadget may be also be imported into Confluence and included on a Confluence page.

Adding Structure Gadget to Dashboard

Structure gadget is added as any other gadget: click Add Gadget button in the top right corner of the dashboard, find "Structure" and click Add It Now. You need to have change permissions on the dashboard (if you don't have permissions to change the dashboard, you can try to create a copy using Tools | Copy Dashboard).

You can add several gadgets showing different structures on the same dashboard.

Configuring the Gadget

When you first add a gadget to dashboard, gadget configuration panel appears with a dimmed preview of the gadget below. (The same panel is shown when you use Edit command from the gadget header drop-down or when you edit macro with Structure gadget in Confluence.)

To configure the gadget:

  1. Select a Structure. Click arrow down in the Structure selector to view recently used and favorite structures, or start typing structure name and let the drop-down suggest the matching structures.
  2. Select a View. Click arrow down to choose from views associated with the selected structure, or start typing and let Structure suggest matching views. The selected view determines which columns gadget displays. (You will be able to adjust the view later.)
  3. Optionally, configure a Filter. The displayed structure will be filtered in the same way as in the Structure Board – see Filtering. You can choose between a simple text filter, JQL, S-JQL, or a saved JQL filter – see Simple, JQL, and S-JQL Search.
  4. Optionally, define the Title for this gadget. By default it is the name of the selected structure.
  5. Decide how large the gadget is allowed to be and specify Visible Rows number. If there are fewer visible rows, the gadget shrinks; if more, a vertical scroll bar appears. Pick any number between 2 and 50.
  6. Decide if you'd like dashboard viewers to make changes to the structure or issues (subject to the user's permissions) and select or un-select the Allow Changes checkbox.
  7. Optionally, decide if you'd like the gadget to have different View and Visible Rows settings when maximized. Select the Alternative settings when maximized checkbox to configure these parameters for maximized gadget.
  8. Click Save.

Deselect Allow Changes to protect the structure from accidental changes, such as changes caused by drag-and-drop or hitting Delete key.

It may be useful to have different View and Visible Rows settings when gadget is maximized. In this case you can use the wide screen of the maximized gadget's window optimally and see more information for the same structure. Select Alternative settings when maximized to configure these parameters.

Configuring Gadget View

There are several ways to configure view (columns) for the gadget.

  • Select a predefined view from drop-down.
    Just select a view or start typing and allow Structure to suggest matching views. Set up other gadget parameters and click Save.
  • Start with an existing view and modify it.
    To use this method you need to have Update permission on the modified view.

    Note that if the view you're changing is used in other gadgets, you will be modifying other gadgets' columns configuration as well.

    1. Select a view in the gadget configuration panel.
    2. Click Save.
    3. Adjust view by adding, removing or rearranging columns – see Customizing Columns for details.
    4. A message "View has been adjusted. Save | Revert" will appear in the gadget footer. Click Save.
  • Start with an existing view, adjust it and save as a new view.
    Use this method if you don't have Update access to the view you start with or if you don't want to change it to avoid messing up other gadgets configuration.
    1. Select a view in the gadget configuration panel.
    2. Click Save.
    3. Adjust view by adding, removing or rearranging columns – see Customizing Columns for details.
    4. Open gadget configuration again by clicking Edit in the gadget header drop-down menu.
    5. Click New View button, located beside view selector. Additional form appears – enter new view name and click Create View.
    6. If this gadget is going to be visible to other users, make sure they have access to the view you've created. Gadget configuration panel will suggest to make this view public – click Let everyone use this view to make the view available to everyone.
  • Start with a new view and adjust it.
    1. Without selecting a view in the gadget configuration panel, click New View button.
    2. Additional form appears – enter new view name and click Create View.
    3. If this gadget is going to be visible to other users, make sure they have access to the view you've created. Gadget configuration panel will suggest to make
      this view public – click Let everyone use this view to make the view available to everyone.
    4. Click Save.
    5. The created view will have basic default columns (issue key and summary). Adjust view by adding, removing or rearranging columns – see Customizing Columns for details.
    6. A message "View has been adjusted. Save | Revert" will appear in the gadget footer. Click Save.

If the user viewing the gadget does not have Use permission on the configured view, the gadget will show a default view with only Issue Key and Summary as columns.

When you see "View has been adjusted. Save | Revert" message in the gadget footer, it means that you have changed columns configuration for this gadget. These changes are local and are effective only in the same browser they were made in. Click Save to save and share the changes or Revert to go back to the configuration stored on the server. See Saving and Sharing Views for details.

Using the Gadget

The Structure gadget contains a stripped-down version of the standard Structure widget that you see on other pages. Because the screen space available to a gadget is usually limited, it lacks features like search and secondary panels. It also doesn't have a toolbar. However, most keyboard shortcuts are functional. If the gadget allows editing, you can rearrange issues with drag-and-drop; you can also move, create, edit, and delete issues using the keyboard.

Structure Dashboard Gadget is a bit limited where it comes to editing issue fields, due to some incompatibilities between field editors and gadget framework. Because of that, only a handful of fields can be edited from within Structure Gadget. See Editing from Gadget for more details.

If gadget is displayed in its "home" JIRA dashboard (not in Confluence or elsewhere), the last column lets you use action drop-down for the issues.