Skip navigation links
Oracle Enterprise Performance Management Cloud, Groovy Rules Java API Reference

Oracle Enterprise Performance Management Cloud, Groovy Rules

This document is the API specification of the EPM Groovy Scripting Platform.

See: Description

Packages 
Package Description
oracle.epm.api  
oracle.epm.api.grid  
oracle.epm.api.model  
oracle.epm.api.model.csv  
oracle.epm.api.model.excel  
oracle.epm.api.model.rest  
oracle.epm.api.script  
This document is the API specification of the EPM Groovy Scripting Platform.

This API allows Groovy scripts to perform a variety of operations against the EPM object model. Most objects such as the current application, cube, grid can be retrieved from the operation variable. For example the following after load script will set each cell to a random color each time the grid is refreshed:

Random r = new Random()
operation.grid.dataCellIterator.each { DataCell cell ->
    cell.setBgColor(r.nextInt(0xFFFFFF))
}

Using the APIs

In most case, the entry point to the API will either be methods on the EpmScript base class or the Operation object.

The base script and the current operation have a set of variables that are applicable for the script. If a script references a variable such as operation.grid, the system stops the script with an error in the job console if the grid does not exist in the operation. If the script has optional processing such as formatting the grid if it exists, the script can first check for existence of the grid by calling operation.hasGrid(). The same pattern is available for other objects in the model.

Example Groovy Scripts

The example Groovy scripts provided here demonstrate the syntax and power of the EPM Groovy object model.
Skip navigation links
Oracle Enterprise Performance Management Cloud, Groovy Rules Java API Reference

Copyright © 2017, 2020, Oracle and/or its affiliates. All rights reserved.