You use the Custom-Defined Function Manager window to view, create, edit, or delete custom-defined functions that are defined at the global (server) level or the local (application) level.
You do not edit fields in this window. Rather, to operate on a function, you select a row and click a button, or click New to create a function.
When you use the window to create functions, you are registering functions that were previously developed in Java in the custom-defined function and macro catalog and, thereby, adding the functions to the Essbase calculator framework. When you use the window to edit, delete, or refresh functions, you are modifying the function and macro catalog.
Note: | Custom-defined functions enable you to extend the Essbase calculator language. For creation and use of custom-defined functions, Java Runtime Environment, which is installed with Essbase, is required. Custom-defined functions do not apply to aggregate storage applications. |
The following columns of the Custom-Defined Function Manager window provide information about the listed functions:
Essbase Server—Name of the current Essbase Server instance
Application—For local functions, the current application name; for global functions, <all apps>
Name—Name of the function; for example, @JSUM (For local functions, the name does not reflect the double-naming convention that is used in MaxL.)
Class Name—Fully qualified name of the Java class associated with the function, for example, CalcFunc
Method Name—Name of the Java class method associated with the function (For example, in CalcFunc.sum,sum identifies the method.)
Spec—Essbase calculator-syntax specification string, if one was given when the function was registered; for example, @COVARIANCE (expList1, expList2)
Note: | If the function is to be returned by the output string of the EssListCalcFunctions API function, a specification string must be used. |
Comment—Optional, and possible only if a specification string is used
Runtime—Yes or No, whether the Runtime property is assigned to the function
State:
Loaded: The function is validly defined in Java, and the application is started.
Not Loaded: The function is not validly defined in Java, the application is not started, or JRE is not installed.
Unknown: Essbase cannot determine whether the function is validly defined in Java. You may need to refresh the custom-defined function and macro catalog or restart the application. Unknown is the default setting.
Buttons available in the Custom-Defined Function Manager window:
New—To add a function that was previously developed in Java
Edit—To reregister or edit, but not rename, a function
Copy—To copy a function to another server or application
Rename—To rename a function, but not edit it
Delete—If the function that you delete has been loaded into the application, the deletion may not become effective until you restart the application.
Refresh—To load newly created or updated functions into the function and macro catalog, you may need to restart the application.
create function (MaxL) in the Oracle Essbase Technical Reference
display function (MaxL) in the Oracle Essbase Technical Reference
drop function (MaxL) in the Oracle Essbase Technical Reference