Show TOC

Background documentationParameters

 

You can customize the parameters with default values for the selected data type. The Default Value column allows you to enter fixed values when you choose None in the Context column. When you choose a context, you can select a value from the available default values.

You can also choose a parameter from a query template and set default value to selected parameters from the selected query template. You can either display the parameter value as value help or in a drop-down list. When you view the query parameter in Preview mode, a dialog box with the customized list of parameters appears. You can view the parameter either as value help or drop-down list.

You can specify parameters for each dashboard which are displayed at runtime. These parameters can be used within the dashboard when you configure display template and query template parameters, text field, text area in UI elements, and so on. The dashboard displays the specified parameter values. For each input parameter, you can select a data type (string, boolean, double, integer, and timestamp), a context, and default value. On choosing a context, you can select a value from the available values. For example, if the context is ChartType, a list of available chart types are displayed at runtime. You can select the parameter value from this list.

On choosing None in the Context column, the Default Value column allows you to enter fixed values. When you choose Query Template, the list displays a dynamic list of values from the query result. You can either display the parameter value as value help or in a drop-down list. The query parameters can be configured which are applied before executing the query. At runtime, a dialog box displays all the customized list of parameters. You can enter the parameter value or select from the list and apply to the dashboard.

The Session Parameters in Context column displays the logged user's session parameters and custom attributes. At runtime, the dashboard displays the customized value of the selected parameters on the dashboard. For more details on creating custom attributes, see Custom Attributes.

The User Input tab allows you to retain default values or enter your values to the selected parameters at runtime. The Skip Initial User Input allows you to retain the default values of the selected parameters. The Allow User Input Any Time allows you to enter values to the selected parameters at runtime. You can change the default values by choosing the .

Activities

  1. From the Self Service Composition Environment screen, choose Preferences.

  2. To create new parameters, choose Parameters.

    1. Choose any checkbox from the User Input tab.

      When you choose Apply User Input Any Time checkbox, at runtime the Parameters screen allows you to enter a value in the Default Value column for the selected parameters. You can choose to edit the parameters again.

      1. The Parameters screen appears.

    2. Choose Add.

    3. Enter a name in Parameter Name column.

    4. Choose the type from the drop-down list of Type column.

    5. Choose a relevant context from the Context column.

    6. Select default values for the selected context from the drop-down list of Default Value column. Or, enter a fixed value if you have chosen None in the Context column.

    7. Additionally, you can configure selected parameters.

      Example Example

      If you have selected Query Templates in Context column, do the following:

      1. Select the browse button from the Context column.

        The Configure Query Parameters for Input Parameter appears.

      2. Enter or browse for a query template in the Query Path field. The parameters relevant to the selected query template are displayed in the drop-down list.

      3. Select a parameter in Show Query Column field

      4. From the Show As field, choose either DropDownBox or ValueHelp.

      5. Choose OK.

        In Preview mode, a parameters dialog box with the customized parameter list is displayed. You can enter a value, if you have selected ValueHelp or select a value from the drop down list if you have selected DropDownBox.

      6. The selected display template will display the values in the Preview mode.

      End of the example.

    8. Enter a value in Default Value column.

      The Context fields are enabled only for string datatype.