Client parameters

NSM service designers use the <clientParameter> element and the <name>, and <description> tags to define client parameters when designing NSM service templates. Client parameters can be passed as arguments to inject, SQL, or HTTP parameters. Client parameters can be used as both global and local parameters in a NSM service template.

When the service is submitted, the NSM client user populates the <value> tag with the appropriate value. This value is then used where the parameter is referenced.

The following sample XML shows the layout of the <clientParameter> element and associated tags that NSM service designers specify when creating a NSM service template:
<clientParameters>
	<clientParameter>
		<name>SOURCEZONE</name>
		<description>SOURCEZONE name is a string</description>
	</clientParameter>
</clientParameters>

The following sample XML shows the use of the <value> tag that NSM client users specify when submitting a NSM service template for execution:

<clientParameters>
	<clientParameter>
		<name>SOURCEZONE</name>
		<description>SOURCEZONE name is a string</description>
			<value>Customer100_Zone</value>
	</clientParameter>
</clientParameters>
Table 1. Client parameter element and tag details
Element/Tag Type Description
<clientParameters> Containing list Contains a list of one or more <clientParameter> elements.
<clientParameter> Container Contains the client parameter details. Each client parameter is encapsulated within a <clientParameter> </clientParameter> element pair.
<name> String Specifies the name of the client parameter. In the example, the client parameter name is SOURCEZONE.
<description> String Specifies the description of the client parameter. In the example, the client parameter description is SOURCEZONE name is a string.
<value> String The NSM client user populates this tag with an appropriate value. This tag is not required for generating a NSM service template, but it is required when an NSM client user submits a NSM service template. In the example, the client parameter value is Customer100_Zone.