This page last changed on Dec 14, 2005 by jeff.

JIRA Report and Portlet plugins use 'Object Configurable' atlassian module to request configuration parameters form users. These parameters are described in the atlassian-plugin.xml as part of the plugin entry. For example, for the Time Tracking Report report that ships with JIRA the input parameters are:

        <properties>
      <property>
          <key>versionId</key>
          <name>common.concepts.version</name>
          <description>report.timetracking.version.description</description>
          <type>select</type>
          <values class="com.atlassian.jira.portal.VersionOptionalValuesGenerator"/>
      </property>
      <property>
          <key>sortingOrder</key>
          <name>report.timetracking.sortingorder</name>
          <description>report.timetracking.sortingorder.description</description>
          <type>select</type>
          <values class="com.atlassian.jira.portal.SortingValuesGenerator"/>
      </property>
      <property>
          <key>completedFilter</key>
          <name>report.timetracking.filter</name>
          <description>report.timetracking.filter.description</description>
          <type>select</type>
          <values class="com.atlassian.jira.portal.FilterValuesGenerator"/>
      </property>
   </properties>

Types

The various <types> that can be used are:

Type Input HTML Type
string text box
long text box
select select box
multiselect multi-select box
hidden hidden field
date text box with calendar pop-up
user text box with user picker pop-up
text text area

(for an example of how to add new types, see the Adding checkbox as a type example)

Values

Values can be provided by a value provider class that must subclass ValuesGenerator.

Or.

You can hard code the values into the descriptor in the form:

                <values>
  <value>
    <key>KEY1</key>
    <value>somevalue</value>
  </value>
  <value>
    <key>KEY2</key>
    <value>someothervalue</value>
  </value>
</values>

Defaults

You can specify a default for the following types: User, Long and Date.

The format for this is:

<default>5</default>
Document generated by Confluence on Oct 06, 2009 00:31