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 needs 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:

var ServerObjects = IStore.Query("SELECT SI_NAME, SI_SERVER_KIND 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 Title property, Description property, and ID property.

Once the APS server objects are retrieved, you can use the PluginInterface Property to access the server plugin's ServerAdmin Property, which can then be used to retrieve the APS Administration plugin's default object, which the APSAdmin object.

var ServerPlugin = ServerObjects.Item(1).PluginInterface("");

var APSAdminPlugin = ServerPlugin.ServerAdmin;

Once you have retrieved the APS Administration plugin interface, you can access plugin-specific properties and methods.

A list of the available administration plugins follows. These plugins are stored in the CI_SYSTEMOBJECTS category in the APS InfoStore, and must be retrieved using SI_PROGID = 'CrystalEnterprise.Server' and the appropriate SI_SERVER_KIND property.

Plugin	SI_SERVER_KIND
Crystal Enterprise APS Administration Library	aps
Crystal Enterprise Cache Page Server Admin PlugIn Library	cacheserver
Crystal Enterprise Event Server Admin Library	eventserver
Crystal Enterprise File Repository Admin Library	fileserver
Crystal Enterprise Job Server Admin Library	jobserver
Crystal Enterprise Web Component Server Admin Library	wcs