Creating On-Demand Rules

You can add custom rules to your application either to the consolidation process or as on-demand rules. Configurable Consolidation and Configurable Calculation rules run automatically during consolidation. On-demand rules run when a user launches them from the Rules card or from a data form. They do not run as part of consolidation.

On-demand rules are also available in Oracle Smart View for Office, and as part of post-data load processing from Data Load.

You must be an Administrator to create, edit, or delete on-demand rules. Administrators can run on-demand rules, but Power Users and Users can only run them if the Administrator provides launch permissions, and if they have access to the POV dimension members.

You can also add on-demand rules to forms. See Adding On-Demand Rules to Data Forms.

Note:

You add on-demand rules to the Consol cube. You cannot add them to the Rates cube. The Consol cube is seeded with six placeholder rules for Configurable Calculations. You cannot delete or rename these rules.

To create on-demand rules:

1. Click the Navigator icon .

2. Under Create and Manage, click Rules.

   Calculation Manager opens and displays both System-created rules and User-defined rules.

3. Expand the "Planning" folder and navigate to the "FCCS Consol Rules" folder.

4. Right-click on the Rules folder and select New.

5. Enter a rule name and click OK.

   The name must be unique and cannot start with the FCCS_ prefix. This prefix is reserved for seeded rules. You also cannot use the name of an existing system rule, including ClearEmptyBlocks, Consolidate, ForceConsolidate, ForceTranslate, or Translate.

6. For Application Type, use "Planning". For Application, use the name of your application.

7. For Cube, use the default setting of Consol.

   The system will open to the Script editor where you can enter your script statements. If you prefer to work in the graphical mode, you can change to Designer in the drop-down list. In Calculation Manager, you can create Calc Script or Groovy Script-based rules.

   For a list of supported functions, see Working with Calculation Manager Custom Defined Functions and Supported Essbase Functions. For information on working with Groovy Script, see "Using Groovy Rules" in the Administering Planning guide.

8. In the Properties pane, you can enter an optional description and comment for the rule.

9. In the Value column, select default members for the Run-Time Prompts for the Consolidation, Currency, Entity, Period, Scenario, and Year dimensions:

   • You must have Write access to the Scenario, Year, Period and Entity.

   • For the Currency dimension, select Entity Currency or Input Currency.

   • For the Consolidation dimension, you can select"FCCS_Entity Input", "FCCS_Translated Currency Input","FCCS_Amount Override", or "FCCS_Rate Override".

     Note:

     For the Consolidation dimension, if you want to use FCCS_Amount Override or FCCS_Rate Override, you must first set the following substitution variable for the Consol cube to enable it:

     ODR_ENABLE_RATE_AMOUNT_OVERRIDE = TRUE.

     See Creating and Assigning Values to Substitution Variables.

   • For the Entity dimension, if you use shared entities, you must explicitly define both the primary and shared entities in the Run-Time Prompt, in order for the shared entities to be impacted.

   • For the Entity dimension, to run the On-Demand rule on all Level 0 descendants, you must select the Level 0 descendants function from the Member Selector. For example, to run the rule on all Level 0 descendants of "FCCS_Total Geography", select the Level 0 descendants function with"FCCS_Total Geography" as its parameter. Example: IDescendants ("FCCS_Total Geography".

   • Note that the FIX statements in on-demand rules cannot include any run-time prompt dimensions. You also cannot use run-time prompt dimensions in the left side or Target side of formulas, although you can use these dimensions on the right side or Source side.

10. To validate the rule, from the Actions menu, select Validate and Save.

    You must specify members for any of the Run-Time Prompt dimensions for which you did not previously specify a default value.

    If validation fails, from the Home page, click Application, and then click Jobs to view the job details.

11. From the confirmation prompt, click OK.

12. To view the rule, navigate to the Rules folder and right-click Refresh.

    The new rule is displayed in the Rules list. On-demand rules are listed in alphabetical order after the seeded configurable calculation rules.

    It does not become active until it is deployed.

13. To deploy the rule, from the Actions menu, select Deploy.

    You cannot undeploy a rule after it has been deployed. If the rule is no longer needed, you can delete it.

14. From the confirmation prompt, click OK.

15. To verify that the rule was deployed, on the Home page, click Rules and click Refresh.

    The deployed rule will be displayed in the list of rules after the system rules.