Package com.crystaldecisions.sdk.plugin.admin.jobserveradmin

This package has been deprecated as of version 12.0.

See:
Description

Interface Summary

IJobServerAdmin	Deprecated. As of version 12.0.
IJobServerDestination	Deprecated. As of version 12.0.

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

This package has been deprecated as of version 12.0. For more information, see BusinessObjects Enterprise Java SDK Developer Guide. This package allows you to monitor a Job Server and includes metrics on the scheduled jobs, object types and process types. You can also set the maximum number of allowable jobs and retrieve a collection of Job Server destinations (FTP, SMTP, and Unmanaged disk). Through each job destination object, you can enable or disable the destination and reactivate the associated destination plugin. Use the plugin to set the global options for the Job Server.

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 Job 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 = 'jobserver'");

The query method returns a collection of InfoObjects, which in this case are Job server objects. Like other InfoObjects, Event 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 Job server objects are retrieved, you can use the IServer interface and the getServerAdmin() method to get the Job Server Administration plugin's default object. Then you can use IJobServerAdmin interface to retrieve the metrics specific to the Job Server and IJobServerDestination to retrieve the plugin associated with the output destination (FTP, SMTP, Unmanaged Disk) used to trigger events.

To access the Job 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 Job Server administrative object, IJobServerAdmin.

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