Apama 10.3 | Apama Documentation | Building and Using Apama Dashboards | Building Dashboard Clients | Defining Dashboard Commands | Creating custom commands | Installing a Custom-Command Library
Installing a Custom-Command Library
* To install your function library for a given data server or display server
1. Include a line in the data server or display server's EXTENSIONS.ini file that specifies the fully qualified name of your ICommandLibrary implementation. The line must have the following form:
command fully-qualified-classname
2. Create a jar file that contains your ICommandLibrary 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 your project and select Properties, expand Apama, select Dashboard Properties, activate the External Dependencies tab, and click the Add External button). You can also use the --dashboardExtraJars command line argument to specify this jar file.
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 and Managing Apama Applications.
The EXTENSIONS.ini specifies the function library to use. This file identifies all the user supplied extension classes (including function 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.

Copyright © 2013-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.