Including metadata in input parameter names


In most cases, the BMC Atrium Orchestrator process that you choose to associate with your Workflow Job already has input parameters defined through its Start activity. Use the information in this topic to modify the existing input parameters so that they include metadata that can be used by the Workflow Job. Use the naming guidelines described in this topic also for any subsequent input parameters that you may decide to add to the process.

For an example, see Example-of-modified-parameter-names.

To modify input parameters to include metadata

  1. In the BMC Atrium Orchestrator Development Studio, double-click the Start Activity of the process to display the Property panel.
  2. For each input parameter that you want to modify, double-click in the Input Parameter Name column and modify the name of the input parameter in the following manner:
    1. Remove any underscore characters included in the original parameter name.
    2. Add the data type before the existing parameter name and connect it with an underscore character. For a list of data types, see Data-types-for-input-parameters-of-a-Workflow-Job.
    3. Add any of the optional elements described in the following table after the parameter name. Connect all elements with the underscore character. If the optional element requires a value (this is true for all elements except required), separate the value from the name of the element with a space.

      Optional metadata elements for parameter name
      The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.


       1 If you specify an invalid default value for a Boolean type parameter, a value of false is used instead. Similarly, if you specify an invalid default value for a numeric parameter, a value of 0 is used instead. If you specify an invalid default target server, the corresponding field on the Workflow Job panel displays "invalid default value" (and you should choose a different value during job configuration).

  3. When you have finished modifying the names of all relevant input parameters, click OK to save the input parameters. 

    Note

    Any input parameters that you do not modify continue to be passed on to the BMC Server Automation Workflow Job as a string-type input parameters, with no control over their order or relative location on the Workflow Job panels. This is also applicable for any parameters for which your modifications do not properly follow the rules for adding metadata.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*