The header element

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

Table 1. Contents of the header element
header child elements Description
<identifier> This element's three attributes identify the plug-in:

  • version

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

  • id

    Identifies the plug-in.

  • name

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

All values must be enclosed in single quotation marks.
<description> Describes the plug-in. This element is shown on the Automation Plugins pane, and on informational pages for the plug-in.
<tag> Defines where the plug-in is listed in the process editor's hierarchy of available plug-ins. The location is defined by a string that is separated by slashes. For example, the Tomcat definition is the following string: Application Server/Java/Tomcat. The Tomcat steps are listed after the Tomcat item, which in turn is nested under the other two.
Note: Do not include underscore character (_) in this element.

The following sample shows a header element definition:

<header>
  <identifier version="3" id="com.&company;.air.plugin.Tomcat" name="Tomcat"/>
  <description>
  The Tomcat plugin is used during deployments to run Tomcat run-book 
  automations and deploy or undeploy Tomcat applications.
  </description>
  <tag>Application Server/Java/Tomcat</tag>
</header>