Parameters

NSM service designers use parameters in NSM service templates to enable appropriate values to be passed on to Netcool Configuration Manager command sets as parameters.

NSM service designers can use the following types of parameters when defining how parameters values can be calculated:

  • Constant parameters — NSM service designers can define constant parameters in the NSM service template XML using the <constantParameter> element and assign values to them using the <name> and <value> tags when they design NSM service templates.
  • Client parameters — NSM service designers can define client parameters in the NSM service template XML using the <clientParameter> element and their values are populated by NSM client users. The <clientParameter> element makes use of the <name> tag.
  • Inject parameters — NSM service designers can define inject parameters in the NSM service template XML using the <injectParameter> element and their values are populated by evaluating the results of functions when the service is executed. The <injectParameter> element makes use of the <name>, <methodCall>, and <arguments> tags.
  • SQL parameters — NSM service designers can define SQL parameters in the NSM service template XML using the <sqlParameter> element. SQL parameter values are validated when they are submitted and before the service is run. The <sqlParameter> element makes use of the <name> and <sql> tags.
  • HTTP parameters — NSM service designers can define HTTP parameters in the NSM service template XML using the <httpParameter> element. HTTP parameters are populated by running a GET command and are evaluated when the service is run. The <httpParameter> element makes use of the <name>, <arguments>, and <url> tags.
  • Client parameter lists — NSM service designers can define client parameter lists in the NSM service template XML using the <clientParameterList> element and their values are populated by NSM client users. The <clientParameterList> element makes use of the name attribute and the <parameter name> and <value> tags.

Each parameter type can be either global or local. Global parameters are used by all implementations. Local parameters are specific to the <implementation> element in which they are defined. For example, if there is a global client parameter called ZONENAME and a local SQL parameter also called ZONENAME then the value of the local SQL parameter will be used.

Client parameters that are global are sent to the NSM client user to be populated irrespective of the <implementation> element that is selected for the NSM service template. The data is set in the <value> tag of the <clientParameter> element.

SQL, HTTP, and inject parameters that are global are also used by the <implementation> element that is selected for the NSM service template. The data is set in the <value> tags of these parameters when the service is executed.

Local parameters are specific to their own <implementation> element, and they do not affect anything outside this implementation. For client parameters that are local, if the <implementation> element in which they are contained is selected based on the device type, only then are they sent to the NSM client user to be populated at service run time.

For SQL, HTTP, and inject parameters that are local, they are only calculated during service execution if the <implementation> element in which they are contained is selected based on the device type.

Client parameter lists that are placed at the global level of the NSM service template can be used by all implementation. Use of client parameter lists within an implementation is determined by the placement of the name attribute found in the <clientParameterList> element, for example, <clientParameterList name="CPL_01"> . The name attribute should be placed in the list of parameters within an <operation> element. The <clientParameterList> elements at a global level are similar to <clientParameter> elements at a global level in that they are sent to the NSM client user to be populated irrespective of the <implementation> element that is selected for the NSM service template. The data is set in the <value> tag of the <clientParameterList> element and can contain multiple values that can be populated by the NSM client user.