Set process parameters for a button

If you configure a button to run a TurboIntegrator process that requires input parameters, you must configure questions that can be answered to provide parameter values or specify default parameter values.

1. To set process parameters for a button, you must be in edit mode.
2. After adding the button to a sheet, click the button to select it. You should see several sizing handles on the perimeter of the button indicating that it is selected.
3. Click the Properties icon , then click Button target.
4. Click Set parameters.

   If the process does not include any parameters, you see a message that says No data available in table. In this case, you can click Cancel - you don't need to set any parameter values before running the process.

   Otherwise, you can see all the parameters that are include in the process on the Parameters screen.

   

   The name and type for each parameter is defined in the process. You can't change these parameter properties, but knowing them helps you create a relevant prompt and set default values.

5. For each parameter:
   1. Enter a Prompt that the user will respond to when providing a parameter value. This should be a simple statement or question that clearly indicates what kind of response is required from the user.
   2. Set the Prompt user option. Select this option to display the prompt that you created when the process is run from the button. The value that the user provides in response to the prompt is passed into the process. Deselect this option to pass the default parameter value directly into the process. Default parameter values are describe a bit later in this topic.
   3. Select a Control type and if necessary, set Control detail. These options determine how the user responds to the prompt to set the parameter value. The Control types available vary according to the parameter type.

      For string parameters, the following Control types are available:

      Text input

      Presents a box where the user can enter the parameter value. You do not need to specify any Control detail.

      List

      Presents a list of values from which the user can choose the parameter value. You must enter the values that you want to appear in the list in the Control detail column, with all values separated by commas.

      Dimension list

      Presents a list of dimension set members from which the user can choose the parameter value. To specify the dimension set, click Select a dimension and pick the dimension that contains the set you want to appear in the list. Then, click Select a hierarchy and pick the hierarchy that contains the set you want to use. Finally, click Select a set and pick the set that contains the members that you want to appear in the list.

      Synchronized

      The process automatically picks up parameter values from other synchronized items in a book.

      Select the dimension and hierarchy to be synchronized under the Control Details column.

      A process can receive synchronized parameter values from any of the following items:

      • cube view (exploration or visualization)
      • websheet
      • dimension selector
      • synchronization tile

      File

      The File control type passes the file name of the uploaded file to the process parameter. This parameter displays only when the Allow file upload property is selected. By default, the Prompt user is disabled for this parameter.

      For numeric parameters, the following Control types are available:

      Text input

      Presents a box where the user can enter the parameter value. You do not need to specify any Control detail.

      List

      Presents a list of values that can be chosen to set the parameter value. You must enter the values that you want to appear in the list in the Control detail column, with all values separated by commas.

      Boolean

      Presents binary values that the user can choose. In the Control detail column, you can specify the True label and False label. The default values are True and False, but you can use Yes and No, Yup and Nope, or any labels you want.

      Number range

      Presents a box where the user can enter the parameter value. The value entered is validated against the range that is specified by the From and To limits in the Control detail column. If the value entered is outside the range, the user receives an error message.

      Calendar

      Presents a calendar from which the user can select a date value.

6. If necessary, enter a Default value that is appropriate for the Control type you're using. If you chose to not prompt users for parameter input, the default value is passed directly into the process when it is run.

   Not all Control types require you to specify a default value, some derive the default value as outlined here:

   Text input

   Enter the default value that you want to use.

   List

   Uses the first value in your comma-separated list as the default value. You can't modify this default value directly.

   Dimension list

   After you define the dimension set from which users can pick from in the Control detail column, click the Pick an element list in the Default column. Pick the member that you want to use as the default value.

   Boolean

   After you define a True label and False label, those labels appear in a menu on the Default column. Click the menu and pick the label that you want to use as the default value.

   Number range

   Uses the From (lowest) value in number range as the default value. You can't modify this default value directly.

   Calendar

   When you specify a calendar Control type, a date picker is available on the Default column. Click the date picker and pick the date that you want to use as the default value.

7. Click OK to save the parameter configuration.
8. While still in edit mode, you can click the button and then click see how the button behaves and how the process runs.