This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

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

Compare with Current View Page History

Version 1 Next »

Web Panel plugin modules allow plugins to define panels, or sections, on an HTML page. A panel is a set of HTML that will be inserted into a page

On This page:

Unable to render {include} The included page could not be found.

Bamboo specific notes for Web Panels

Locations

Bamboo supports the following web panel locations:

Location

Description

Since

plan.navigator

Renders below the plan navigator on all Plan, Job, Plan result and Job result screens

3.0

job.configuration.artifact.definitions

Renders below the Artifact definitions table in the Job configuration

3.0

job.configuration.artifact.subscriptions

Renders below the Shared Artifacts table in the Job configuration

3.0

plan.result.artifacts

Renders below the default content of the Plan result artifacts tab

3.0

job.result.artifacts

Renders below the default content of the Job result artifacts tab

3.0

Default Context Objects

The following objects are available by default without having to specify your own context-provider. 

Name

Description

Availability

plan

Refers to the current Plan

Any page that shows a Plan, Job, Plan Result or Job Result

resultSummary

Refers to the current ResultsSummary

Any page that shows a Plan Result or Job Result

Freemarker resource type

In addition to the standard velocity and static Web Panel resource types Bamboo introduces a freemarker type used to render Bamboos preferred templating engine Freemarker.

  <web-panel key="feedbackPanel" location="plan.navigator">
    <resource name="view" type="freemarker" location="/fragments/feedback/feedbackWebPanel.ftl" />
  </web-panel>

Adding Web Panel locations to your own plugins

Bamboo provides easy support for adding your own Web Panels via the ui.renderWebPanels freemarker macro.

Example

[@ui.renderWebPanels 'my.webpanel.location' /]

Once specified in any Freemarker template any plugin can specify my.webpanel.location in their web-panel location declaration and be expected to render along side your template.

  • No labels





Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.