Share via

Adding a rule parameter

  • Article

You can add a rule parameter to any procedural rule, or make any rule into a parameter-based rule when you create the rule. When you add a parameter in the Business Rule workspace by using the Create New Parameter dialog box, the parameter is automatically declared in the selected rule.

To use parameters with a rule, create the parameters, and then reference the parameters in the rule text. When you reference a parameter, use the parameter label enclosed by dollar signs ($), such as $MyParameter$. Each time that you execute the rule, you will be prompted to enter values for the parameters.

Note

At run time, Planning Business Modeler verifies that the user who runs a rule has permission to read the data members that are exposed as parameters. However, if the rule parameter is a reference member that is used to navigate to a sibling, parent, or child member, Planning Business Modeler does not determine if the user has permission to read the other members. Therefore, Modelers must make sure that when a user is assigned to run a job, the user meets appropriate security requirements.

To add a rule parameter to an existing rule

  1. In the Workspace Browser pane, click Models.

  2. In the model site workspace, click the Business Rules tab.

  3. From the list of rule sets and rules, select the rule for which you want to add a parameter.

    You cannot use parameters in definition rules.

  4. Right click the rule for which you want to add a parameter, and then select Add Rule Parameter. The Create New Parameter dialog box appears

  5. In the Label text box, enter a label for your parameter, such as MyParameter. The label is the primary identifier of objects throughout the system, cannot exceed 40 characters, and must be unique. The rule parameter label has reserved words and restricted characters that cannot be used in the label. See the topic About names and labels for more information about how to create labels and label restrictions

  6. Optional. In the Description text box, enter a description for your parameter. The description can be up to 512 characters long.

  7. From the Data type drop-down list, select a data type for your parameter. Be certain that the data type you select matches the rule elements this parameter will reference.

    When you select data type Member of Dimension or Members of Dimension, the Dimension drop down box appears. Select the dimension that your parameter represents.

    Note

    Rules with SQL implementation will not accept parameters that are of type Members of Dimension. Rules with SQL implementation will only accept parameters that represent single members, such as Member of Dimension.

  8. Click OK.

To add a rule parameter when you create a rule

  1. In the Workspace Browser pane, click Models.

  2. In the model site workspace, click the Business Rules tab.

  3. Create a new rule.

    For more information, see Creating a new rule.

  4. In the Rule expression pane, enter the rule text for your new rule.

  5. Right-click in the Rule expression pane, and then select Add Rule Parameter. The Create New Parameter dialog box appears

  6. In the Label text box, enter a label for your parameter, such as MyParameter.

  7. Optional. In the Description text box, enter a description for your parameter. The description can be up to 512 characters long.

  8. From the Data type drop-down list, select a data type for your parameter. Be certain that the data type you select matches the rule elements this parameter will reference.

    When you select data type Member of Dimension or Members of Dimension, the Dimension drop down box appears. Select the dimension that your parameter represents.

    Note

    Rules with SQL implementation will not accept parameters that are of type Members of Dimension. Rules with SQL implementation will only accept parameters that represent single members, such as Member of Dimension.

  9. Click OK.