Package com.crystaldecisions.sdk.plugin.admin.cmsadmin

This package has been deprecated as of version 12.0.

See:
Description

Interface Summary

ICMSAdmin

Deprecated. As of version 12.0.

Package com.crystaldecisions.sdk.plugin.admin.cmsadmin Description

This package has been deprecated as of version 12.0. This package allows you to retrieve the metrics specific to an APS cluster. This information is useful to monitor APS clusters, and includes metrics on the APS database, licenses, scheduled jobs, and user connections.

Retrieving administration plugins

The administration plugins cannot be queried for directly. Administration plugins are used to monitor all of the servers in the system, which means that the server objects need to be retrieved before using the plugins to access information about them.

Each server object in Crystal Enterprise is represented by an InfoObject. These objects are stored in the CI_SYSTEMOBJECTS category in the APS InfoStore, and are marked with a programmatic identifier (ProgID). Using SI_PROGID and SI_SERVER_KIND, you can query the APS InfoStore for a collection of server objects of a particular type.

Example

The following query selects the names, and IDs of all APS servers in the APS:

IInfoObjects serverObjs = iStore.query("SELECT SI_NAME, SI_SERVER_ID FROM CI_SYSTEMOBJECTS Where SI_PROGID='CrystalEnterprise.Server' AND SI_SERVER_KIND = 'aps'");

The query method returns a collection of InfoObjects, which in this case are APS server objects. Like other InfoObjects, APS server objects are uniquely represented by their ID property. Through the server object, you can access general InfoObject properties, such as the SI_NAME property, SI_DESCRIPTION property, and SI_ID property.

Once the APS server objects are retrieved, you can use the IServer interface and the getServerAdmin() method to get the APS Administration plugin's default object. Then you can use IAPSAdmin interface to retrieve the metrics specific to an APS cluster.

To access the APS server object, the resulting IInfoObjects need to be cast. The following code illustrates how the IInfoObjects retrieved by the query can then be cast as the APS administrative object, IAPSAdmin.

for (int i = 0; i < serverObjs.size(); i++)
{
        IInfoObject obj = (IInfoObject) serverObjs.get(i);
        IServer serverObj = (IServer) obj;
        IAPSAdmin apsServer = (IAPSAdmin) serverObj.getServerAdmin();
}