Create a New Parameter Definition and Instance

To create a new Parameter definition and instance at the same time, do the following:

1. Select Create a New Parameter Definition and Instance. Additional fields appear.
2. Enter values in the following fields:

   • Name. See Naming Objects.

     Note:

     Do not use spaces in the name of any Parameter you create for use in a Report Set. This will cause an error in post-processing because the Parameter name becomes an HTML tag, and spaces are not allowed.

   • Description. See Creating and Using Object Descriptions.

3. Set the following attributes:

   • Visible (Required). If set to Yes, the Parameter is visible and its value can be changed. If set to No, it will not be visible at runtime and is therefore effectively bound to the value set in the Execution Setup definition.

   • Required (Required). If set to Yes, the Parameter must have a value; the system will not execute the Program if this Parameter does not have a value. If set to No, the system executes the Program even if the Parameter does not have a value.

   • Read Only (Optional, and only Visible Parameters can be Read Only). If set to Yes, the person submitting the Program for execution can see the Parameter's value but cannot change it. If set to No, the submitter can change the Parameter's value at runtime.

   • Input Output (Required). From the drop-down list, choose one of the following values: Input, Output, or Input/Output, to define the role of the Parameter in the Program. If set to Input, the Parameter can receive a value at runtime and pass it to the Program's source code. If set to Output, the Parameter value is generated by the Program and can be passed to another Program in the same Workflow or Report Set. If set to Input/Output, the Parameter can receive a value at runtime and pass it to the Program's source code, which may transform the value before reporting it.

   • Prompt (Optional). Use this field to specify the label to be displayed in the Execution Setup for this Parameter. If you do not specify a Prompt, the system uses the Parameter Name.

   Note:

   All the above attributes except Input/Output can be changed during the definition of the Execution Setup.

4. Specify the LSH Variable to be used as a definition source for the Parameter. You can select an existing Variable or create a new one. See About Variables, Parameters, and Columns and Creating Variables Manually.
5. Define the allowed and default values of the Parameter. See Defining Allowed Values.
6. Define the validation rules for the Parameter. See Setting Validation Rules.
7. Click Apply. The system returns you to the Parameters subtab of the Program Properties screen. To continue defining the Parameter, click its hyperlink. Follow instructions to Defining Parameter Details.