Installing a custom-function library
To install your function library for a given Data Server or Display Server, do both of the following:
Include a line in the Data Server or Display Server’s
EXTENSIONS.ini file that specifies the fully qualified name of your
IFunctionLibrary implementation. The line must have the following form:
function fully-qualified-classname
create a
jar file that contains your
IFunctionLibrary implementation, and either add it to
APAMA_DASHBOARD_CLASSPATH (changes to this environment variable are picked up by dashboard processes only at process startup) or add it to the list of
External Dependencies in your project's
Dashboard Properties. (In Software AG Designer, right click on your project and select
Properties, expand
Apama, select
Dashboard Properties, activate the
External Dependencies tab, and click the
Add External button).
A Data Server or Display Server’s EXTENSIONS.INI is, by default, located in the lib directory of its Apama installation. You can specify a Data Server or Display Server’s EXTENSIONS.ini file at startup by using the -X or --extensionFile option — see Deploying Apama Applications.
The EXTENSIONS.ini specifies the function library to use. This file identifies all the user supplied extension classes (including command libraries and scenario authorities). Here is a sample EXTENSIONS.ini:
function com.apama.dashboard.sample.SampleFunctionLibrary
command com.apama.dashboard.sample.SampleCommandLibrary
scenarioAuthority com.apama.dashboard.sample.SampleScenarioAuthority
This file installs a function library, a command library, and a scenario authority.