The header element

The mandatory header element identifies the plug-in and contains four mandatory child elements and one optional child element:

Table 1. Contents of the header element
<header> Child Elements Description
<identifier> Required. This element's four attributes identify the plug-in:

  • version

    API version (the version number for upgrading plug-ins is defined in the info.xml file).

  • id

    Identifies the plug-in.

  • name

    The plug-in name is shown on the Plugins pane, and on informational pages for the plug-in.

All values must be enclosed within quotation marks.
<description> Required. Describes the plug-in; is shown on the Plugins pane, and on informational pages for the plug-in.
<tag> Required. The only tag type supported is the Change tag.
<plugin-type> Required. The type of plug-in. The only type supported is the Connector type.
<server:required-server-version> This optional element defines the minimum version of IBM® UrbanCode™ Release required for use with the plug-in. The version is defined by 4 digits. For example, a plug-in that requires IBM UrbanCode Release Version 6.0.1 or later would include the following element in the header: 
<server:required-server-version>6.0.1.0</server:required-server-version>

Example

The following code is a sample header definition:

<header>
  <identifier version="2" id="com.urbancode.plugin.rtc" name="Rational Team Concert plug-in" plugin-type="Connector" />
  <description>
  The Rational Team Concert plug-in is an example plug-in.
  </description>
  <tag>Change</tag>
  <plugin-type>Connector</plugin-type>
</header>