FishEye and Crucible Web Panel Locations

This page describes the places in the FishEye and Crucible UI where you can add a Web Panel.You can control whether a Web Panel is shown using a condition.

If you find that the locations provided are not sufficient for the plugin you wish to write, please raise an issue explaining where you would like a location to be added, and we will consider providing that location in a future release.

On this page:

Web Panels Listing and Reference

Each location has a number of Helper Objects available, which can be used to generate parts of the links and titles.

Key

Location

Helpers available

crucible.review.close.dialog

At the top of the 'review closed' dialog.

global, project, review

crucible.review.close.dialog.jira.action

When a review is linked to a JIRA issue, shows under the JIRA issue transition controls.

global, project, review

crucible.review.complete.dialog.jira.action

When a review is linked to a JIRA issue, shows at the bottom of the 'linked issue' section of the 'marked as complete' dialog.

global, project, review

crucible.review.overview

Below the 'Objectives' section of a review.

global, project, review

fisheye.changeset.links

Below the change set summary on the change set page.

global, repository, changeset

system.fisheye.changeset.toolbar

In the toolbar of a change set page

global, repository, changeset

system.fisheye.directory.toolbar

In the toolbar of a directory list

global, repository, directory

system.global.header

Below the header on every page.

global

system.search.results.header

Before any search results on the search page.

global

system.admin.repository.tab

In the repository edit dialog, as a tab. (FishEye/Crucible 3.5.0 and later only)

global, repository

system.admin.repositories.defaults.tab

In the repository defaults page, as a tab. (FishEye/Crucible 3.5.0 and later only)

global

Visual Locations of Crucible Web Items

crucible.review.close.dialog

Screenshot: The crucible.review.close.dialog Web Panel

crucible.review.close.dialog.jira.action

Screenshot: The crucible.review.close.dialog.jira.action Web Panel

crucible.review.complete.dialog.jira.action

Screenshot: The crucible.review.complete.dialog.jira.action Web Panel

crucible.review.overview

Screenshot: The crucible.review.overview Web Panel

Screenshot: The fisheye.changeset.links Web Panel

system.fisheye.changeset.toolbar

Screenshot: The system.fisheye.changeset.toolbar Web Panel

system.fisheye.directory.toolbar

Screenshot: The system.fisheye.directory.toolbar Web Panel

system.global.header

Screenshot: The system.global.header Web Panel

system.search.results.header

Screenshot: The system.search.results.header Web Panel

 system.admin.repository.tab

This item adds web panel as a tab to the repository administration dialog. It must define a <label> element within the <web-panel> -- this is used as the tab name.

For example:

<web-panel key="event-publisher-repository-config-tab" location="system.admin.repository.tab">
        <label key="jiradevsummary.events.config.tab"/>
        <condition class="com.atlassian.fisheye.plugin.web.conditions.HasFishEye"/>
        <resource name="view" type="soy" location=":event-publisher-config-resources/JiraDevSummaryPlugin.EventPublisher.adminTabContent"/>
        <context-provider class="com.atlassian.fecru.plugin.jira.status.configuration.web.EventPublisherConfigContextProvider"/>
</web-panel>

The label and resource elements are required. The condition and the context-provider are optional.

This plugin point also receives Javascript events:

Event Name Triggering Action
system.admin.repository.tab.loaded When the edit repository settings dialog is shown.
system.admin.repository.tab.save When the 'Save' button at the bottom of the dialog is clicked.
system.admin.repository.tab.cancel When the 'Close without saving' button at the bottom of the dialog is clicked.

 system.admin.repositories.defaults.tab

This item adds web panel as a tab to the repository defaults administration page. It must define a <label> element within the <web-panel> -- this is used as the tab name.

For example:

    <web-panel key="event-publisher-defaults-config-tab" location="system.admin.repositories.defaults.tab">
        <label key="jiradevsummary.events.config.tab"/>
        <condition class="com.atlassian.fisheye.plugin.web.conditions.HasFishEye"/>
        <resource name="view" type="soy" location=":event-publisher-config-resources/JiraDevSummaryPlugin.EventPublisher.adminTabContent"/>
        <context-provider class="com.atlassian.fecru.plugin.jira.status.configuration.web.EventPublisherConfigContextProvider"/>
    </web-panel>

The label and resource elements are required. The condition and the context-provider are optional.

This plugin point also receives Javascript events:

Event Name Triggering Action
system.admin.repositories.defaults.tab.loaded When the 'Repository Settings, Defaults' page is shown.
system.admin.repositories.defaults.tab.save When 'Save changes' is clicked.
system.admin.repositories.defaults.tab.cancel When 'Revert' is clicked.
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport