Create parameters

A parameter is a container or a placeholder such as a number, date, or string that can replace a constant value or a list of values. Create Worksheet parameters to optimize your data inquiries. Use parameters to run different scenarios with adjustable values, without creating or modifying the constants in formulas for each new value.

Parameters are useful for 'what-if' analysis, financial planning, cohort analysis, and so on. When you create parameters for your Worksheet, you guide users in their exploration of the data as they search on your Worksheet.

For a parameter to be used in a Liveboard, you must create it in a Worksheet.

Creating parameters

There is no maximum number of parameters you can create for a single Worksheet or Answer. However, parameters don’t work across Worksheets or Answers. They only affect a single Worksheet or Answer.

Creating Worksheet Parameters

To create a Worksheet Parameter, follow these steps:

  1. Navigate to the Worksheet to which you would like to add a Parameter.

  2. Select Edit Worksheet in the upper right corner.

  3. In the Data panel on the left of your screen, select the + button that appears when you hover over the Parameters section.

    Select the + button to add a Parameter

  4. The Create parameter dialog appears:

    Create parameter dialog

  5. In the Parameter name text box, enter a name for your Parameter. This name should be unique for the object, and easy for users to understand.

  6. Optionally, enter a description for the Parameter in the Add a description text box. Use this field to add additional information users might need before using this Parameter in their analysis. It is a best practice to use this field to specify the formulas this Parameter is used in, in addition to any other information you add.

  7. Under Data settings, specify the data type the Parameter must be: Integer, Double, String, Boolean, or Date. For more information about data types, refer to Data types.

  8. For integer, double, or date data types, specify the allowed values: Any, List, or Range. For the string data type, specify either Any or List.

    Any

    Allows any value within the data type’s constraints.
    List

    Allows values only in the list you create. Enter a value in the Enter value…​ text box, and optionally enter what the value should display as in the Display as…​ text box. To add more values, select + Add row. To delete values, select the x to the right of the row the value is in.

    Create a list of allowed values
    Range

    Allows values only within the range you specify. In the Minimum value and Maximum value text boxes, specify the values the range begins and ends with.

    Create a range of allowed values

  9. For the boolean data type, optionally set custom names for true and false; for example, 0 and 1.

  10. Set the default value for your Parameter. In the default value text box, enter the value this Parameter should default to. For the boolean data type, the Default value option is a dropdown. true and false are the only options.

  11. Select Save.

  12. Save your Worksheet. Select Save in the upper right corner.

Creating Answer Parameters

To create an Answer Parameter, follow these steps:

  1. Navigate to the Answer to which you would like to add a Parameter.

  2. In the Data panel on the left of your screen, select the + button in the Parameters section.

    Select the + button to add a Parameter

  3. The Create parameter dialog appears:

    Create parameter dialog

  4. In the Parameter name text box, enter a name for your Parameter. This name should be unique for the object, and easy for users to understand.

  5. Optionally, enter a description for the Parameter in the Add a description text box. Use this field to add additional information users might need before using this Parameter in their analysis. It is a best practice to use this field to specify the formulas this Parameter is used in, in addition to any other information you add.

  6. Under Data settings, specify the data type the Parameter must be: Integer, Double, String, Boolean, or Date. For more information about data types, refer to Data types.

  7. For integer, double, or date data types, specify the allowed values: Any, List, or Range. For the string data type, specify either Any or List.

    Any

    Allows any value within the data type’s constraints.
    List

    Allows values only in the list you create. Enter a value in the Enter value…​ text box, and optionally enter what the value should display as in the Display as…​ text box. To add more values, select + Add row. To delete values, select the x to the right of the row the value is in.

    Create a list of allowed values
    Range

    Allows values only within the range you specify. In the Minimum value and Maximum value text boxes, specify the values the range begins and ends with.

    Create a range of allowed values

  8. For the boolean data type, optionally set custom names for true and false; for example, 0 and 1.

  9. Set the default value for your Parameter. In the default value text box, enter the value this Parameter should default to. For the boolean data type, the Default value option is a dropdown. true and false are the only options.

  10. Select Save.

  11. Save your Answer. Select the more options menu more options menu image in the upper right corner, and select Save.

Editing and deleting Parameters

To edit or delete existing Parameters, follow these steps.

You can only delete Parameters that are not in use in any formula, Answer, or Liveboard. If a Parameter is in use in any objects, you must first remove the Parameter from these dependents, then delete the Parameter. For Parameters that are in use, you can only edit the following fields: Name, Description, and Default value.

Editing and deleting Worksheet Parameters

  1. Navigate to the Worksheet with the Parameter you would like to edit or delete.

  2. Select Edit Worksheet in the upper right corner.

  3. In the Data panel on the left of your screen, select the Down arrow to the right of the Parameters section. This expands the list of Parameters.

  4. To edit a Parameter, select the edit icon edit icon image to the right of the Parameter name.

    Note that you may not be able to edit all fields, if the Parameter is in use in formulas, Answers or Liveboards. For Parameters that are in use, you can edit the following fields: Name, Description, Allowed values, and Default value. You can also add or delete values from a list parameter while it’s in use, or increase or decrease the minimum and maximum values in a range parameter.

    To edit other fields, you must first remove it from these Answers and Liveboards. To see which Answers and Liveboards use the Parameter, select View Details in the Edit parameter dialog that appears.

  5. Make your changes, and select Save.

  6. To delete a Parameter, select the delete icon Delete icon image to the left of the Parameter name.

    Note that you may not be able to delete the Parameter, if the Parameter is in use in Answers or Liveboards. You must first remove it from these Answers and Liveboards. To see which Answers and Liveboards use the Parameter, select View Details in the Delete this parameter dialog that appears.

  7. Select Delete in the dialog that appears.

  8. Save your Worksheet. Select Save in the upper right corner.

Editing and deleting Answer Parameters

  1. Navigate to the Answer with the Parameter you would like to edit or delete.

  2. In the Data panel on the left of your screen, select the arrow to the right of the Parameters section. This expands the list of Parameters.

  3. Select the more options menu more options menu icon image.

  4. To edit a Parameter, select Edit.

    Note that you may not be able to edit all fields, if the Parameter is in use in a formula in the Answer. For Parameters that are in use, you can edit the following fields: Name, Description, Allowed values, and Default value. You can also add or delete values from a list parameter while it’s in use, or increase or decrease the minimum and maximum values in a range parameter. To edit other fields, you must first remove the formula from the search.

  5. Make your changes to the Parameter, and select Save.

  6. To delete a Parameter, select Delete.

    Note that you may not be able to delete the Parameter, if the Parameter is in use in a formula in the Answer. You must first remove the formula from the search.

  7. Select Delete in the dialog that appears.

  8. Save your Answer. Select the more options menu more options menu image in the upper right corner, and select Save. == Using parameters

After you create parameters for your data, use them to run different scenarios when searching on your data or viewing Liveboards or Answers. To learn how to use parameters, see Using parameters.

Was this page helpful?
×