Define a SCOPE statement

When you write business a rule in PerformancePiont Planning Business Modeler by using the PerformancePoint Expression Language (PEL), you can include one or more SCOPE statements. Each SCOPE statement determines the set of member cells in a model subcube that will be affected when one or more PEL statements execute. The SCOPE statement evaluates the PEL statement list in the context of a scope expression.

When you define a SCOPE statement, you specify the dimension members that you want the statement to evaluate. In effect, a SCOPE statement selects a set of cells, and limits the selection to a specified region of cells in a model. Thus, if no SCOPE statement is specified, the PEL statement uses the whole cube, which is the default scope.

In the Business Rules workspace, you can enter code for a SCOPE statement directly in the Rule Expressions pane, or you can select dimension members by using the Define Scopes option.

What do you want to do?


Examples of SCOPE statements

The following examples illustrate some of the different forms a SCOPE statement might take in Planning Business Modeler.

  • SCOPE statement in simple procedure rule
    The following example shows a very simple form of a SCOPE statement in a procedural rule.
    SCOPE([Scenario].[All Members].[Budget],
    [Time].[All Members].[7/2/2000],
    [Account].[All Members].[Cons 7100000],
    [BusinessProcess].[Standard].[INPUT],
    [Entity].[All Members].[Tahoe],
    [TimeDataView].[All Members].[PERIODIC],
    [Flow].[All Members].[ADD] );
    THIS = 1;
    End SCOPE;
  • Outbound rule
    The following example shows the same scope, used in an Outbound rule.
    SCOPE([Scenario].[All Members].[Budget],
    [Time].[All Members].[7/2/2000],
    [Account].[All Members].[Cons 7100000],
    [BusinessProcess].[Standard].[INPUT],
    [Entity].[All Members].[Tahoe],
    [TimeDataView].[All Members].[PERIODIC],
    [Flow].[All Members].[ADD] );
    CurrentTuple;
  • Currency rule
    The following example shows a much more complex SCOPE statement that uses multiple nested SCOPE statements. This example is an excerpt from the Currency rule template that is included with Planning Business Modeler.
    SCOPE [Account].ClassificationFilterInclude("Balance Sheet");
    SCOPE [Flow].TypeFilterInclude("Opening", "PY Adj");
    () += OPE * CURRENTTUPLE;
    END SCOPE;
    SCOPE [Flow].TypeFilterInclude("Appropriation");
    () += PRIORAVE * CURRENTTUPLE;
    END SCOPE;
    SCOPE [Flow].TypeFilterInclude("Increase", "Short Term MVT", "Gap", "Decrease", "Change In Group");
    () += AVE * CURRENTTUPLE;
    END SCOPE;
    SCOPE [Flow].TypeFilterInclude("Merger", "NONE", "Closing");
    () += CLO * CURRENTTUPLE;
    END SCOPE;
    END SCOPE;

Top of Page Top of Page

Define or modify a SCOPE in the Rule expressions pane

  1. In the Workspace Browser pane, click Models.
  2. In the Models table, double-click the model that you want to open, and then click the Business Rules tab.
  3. From the list of rules and rule sets, select the rule for which you want to create or modify a SCOPE statement.

 Note   If you select a rule that is already coded, the rule text appears in the Rule expressions pane. If you select a new rule, the Rule expression pane opens.

  1. Position the cursor in the Rule expressions pane where you want the new SCOPE statement to appear.

 Note   If this is a new rule, begin by typing SCOPE(

  1. Right-click in the Rule expression pane, select Insert Member(s) of Dimension, and then select the dimension to which you want to add a member.

 Note   This displays the Add or remove members to include them in the selection for [] dialog box.

  1. (Optional) Use the Add, Remove, or Find buttons to modify the list of dimension members, or to progress through the member list.
  2. Select the check box next to each member that you want to include, and then click OK.
  3. Repeat steps 5– 7 until you select a dimension member for each dimension listed, including any dimensions that you added. Click OK when you are done.
  4. Type a closing parenthesis and a semicolon at the end of the SCOPE statement.
  5. Write the PEL statements that you want your rule to execute. The PEL statement list must end with a semi-colon.
  6. End the business rule statement by typing END SCOPE;

Top of Page Top of Page

Define or modify a Scope in the Define Scopes pane

 Note   When you use the Define scope pane to create a SCOPE statement for your rule, Planning Business Modeler auto-generates the rule text of the scope that you specify.

  1. In the Workspace Browser pane, click Models.
  2. In the Models table, double-click the model that you want to open, and then click the Business Rules tab.
  3. From the list of rules and rule sets, select the rule for which you want to create or modify a SCOPE statement.
  4. Click the Toggle Scope Editor icon to open the Define Scopes pane above the Rule Expressions pane.

 Important   This icon is disabled for outbound rules because the Define Scopes pane appears automatically for those rules.

For each dimension, the Define scopes pane displays a list of placeholders that resemble this example:
/*[Scenario].[All Members].[All].LeafMembers*/

Each placeholder represents an expression that includes the dimension name and its member hierarchy or hierarchies. For example, in the placeholder expression that is shown in the previous paragraph, the dimension name is Scenario The member names All Members and LeafMembers denote the member hierarchies that the SCOPE statement includes.

  1. For each placeholder listed in the Define Scopes pane, click the ellipsis (…) button next to the placeholder.

 Note   This displays the Add or remove members to include them in the selection for [] dialog box.

  1. (Optional) Use the Add, Remove, or Find buttons to modify the list of dimension members, or to progress through the member list.
  2. Select the check box next to each member that you want to include, and then click OK.
  3. Repeat steps 5 – 7 until you select a dimension and its related member hierarchy or member for each dimension listed, including any dimensions that you added. Click OK when you are done.

If your rule is an Outbound rule, this procedure completes the scope definition and rule creation process. For all other rules, you must type the remaining text to your rule statement in the Rule expression pane.

Top of Page Top of Page