Tag: <parameter> - Task Inputs

Definition

The <parameter> tag is used for two purposes:

  • Defining connection critical parameters that the PxM Platform needs to know so that it can connect to a device.
  • Defining fixed and selection dropdown lists for use in custom user tasks.

The attributes of the <parameter> tag have slightly different means depending its use. This page describes using the <parameter> tag for task inputs. To see how to use the <parameter> for connection critical parameters see this page: :ref:tag-parameter-connection-critical

A parameter tag is only required for configuration strings or select dropdown boxes. Free text inputs or tickboxes do not require a pre-defined parameter tag.

The <parameter> tag sits inside a group tag of <parameters>. You can define multiple <parameters> tags to hold each parameter or you can add <parameter> tags to other existing <parameters> tags.

This tag has the following attributes:

Parameters

  • fieldname (str) : The name of the parameter. This is used to link to this parameter from a task input using a substitution.

  • display_name (str): This is the display string used in the Web Management Interface when setting the parameters values. It is not seen by the user running the task. The display name seen by the user running the task is set on the task <input> tag.

  • fieldtype (str) : This defines the composite definition (compdef) type of the parameter. More info here: :ref:comp-defs

  • ondevice (yes, no) : This tells the PxM Platform whether the parameter is directly associated with a configuration parameter on a device. If the parameter is to be used as a task input then this value should be no.

  • ordering (int): This sets the order in which the task input parameters are listed in the Web Management Interface.

Example 1: Fixed String

To define a fixed string that can be used in tasks, use the following:

1
2
3
4
5
   <parameter fieldname='tomcat_webapp'
      display_name='Tomcat Web Application Name'
      fieldtype='string'
      ondevice='no'
      ordering='1' />

The value of this parameter is then set in the Web Management Interface like this:

Task input parameter

Example 2: Dropdown Select List

To define a dropdown select list that can be used in tasks, use the following:

1
2
3
4
5
   <parameter fieldname='tomcat_webapp_list'
      display_name='Tomcat Web Application List'
      fieldtype='list'
      ordering='1'
      ondevice='no' />

The list entries are then defined in the Web Management Interface, on the Device -> Tasks tab, like this:

Tasks input

The values of the list are set in the Edit value window, which is access by clicking on the |Edit pencil icon| icon next to the list you wish to edit:

Tasks input list

Parent Tags

Child Tags

  • None