The Header: <header> Element

<header> Element

The mandatory header element identifies the plugin and contains the following child elements:

<header> Child Elements Description
<identifier>

This element's three attributes identify the plugin:

  • version

    API version (the version number used for upgrading plugins is defined in the info.xml file).

  • id

    Identifies the plugin.

  • name

    The plugin name that appears on the Automation Plugins pane in Deployment Automation.

All values must be enclosed within single or double quotes.

<description> Describes the plugin. It appears on the Automation Plugins pane in Deployment Automation.
<tag> Defines where the plugin will appear on the process designer's hierarchy of available plugins. The location is defined by a string separated by slashes. For example, the Tomcat definition is: Application Server/Java/Tomcat. The Tomcat steps will be listed beneath the Tomcat item, which in turn is nested within the other two.

The following is a sample header definition:

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