Using Calculation Scripts

When loading data to Oracle Essbase or Oracle Hyperion Planning, Oracle Hyperion Financial Data Quality Management, Enterprise Edition enables you to run custom calculation scripts. A calculation script is a series of calculation commands, equations, and formulas that enable you to define calculations other than those defined by the database outline. Calculation scripts are defined in Essbase and Planning.

Custom calculation scripts are supported in the target application and the check entity group. In the target application:

• parameterize the script so that you can specify a parameter for each script.

• assign scripts to run before or after the data load.

• assign a scope of applicability to scripts. The scope can be at the application, category, location, and data rule level. If scripts are assigned at the lowest level, then they take precedence over script at higher level. The data Rule is the lowest level and application is the highest level. Only scripts at one level are executed.

To add a calculation script:

1. On the Setup tab, under Register, select Target Application.
2. From the Calculation Script tab, select a calculation script.
3. Click to display the Parameter window.
4. For Planning applications only, select the Plan Type to retrieve the parameters defined in the calculation script.
5. Click the Add to add a script parameter.
6. Select the parameter that has been defined for the script.

   You can also click Browse, select the parameter, and click OK. You can also manually type in the parameter name.

7. In Script Value select a predefined parameter value, or select Custom to specify your own script value.
8. Optional: If you selected Custom in the Script Value field, enter the value in Custom.

   For example, enter: 0001.

9. Click OK.
10. In Script Name, specify the name of the script.
11. Click to add the parameters for the calculation script.

    See Using Calculation Scripts.

12. In Script Scope, select the scope of applicability.

    Note that scripts assigned at the lowest level take precedence over scripts at higher level.

    Available scopes in order of highest scope to lowest are:

    • Application (default scope)

    • Category

    • Location

    • Data Rule

13. In Scope Entity, select the specific value associated with the script scope.

    For example, if the script scope is "Location," select the location associated with the application.

    The Scope Entity is disabled for the Application Script Scope.

14. In Event, select the event that executes the calculation script.

    Available events:

    • Before Data Load

    • After Data Load

    • Before Check

    • After Check

15. In Sequence, specify the order in which the script is executed.

    Since multiple scripts can be executed for an event, this sequence value provides the numeric order in which each script is executed. You can enter any number, but the number must be unique within an event.

16. Click Save.