Retrieving and setting global and schedule destination options

Both the global and schedule options are set through the corresponding object: the DiskUnmanagedOptions object, FtpOptions object, or SmtpOptions object. Set the global options by using the PluginInterface Property of the JobServerDestination Object to retrieve the destination plugin. Set the schedule options by directly querying the APS InfoStore for the destination plugin. The query returns the plugin's default object, through which you can access the destination options object.

Note:    Enable the destination on the Job Server before a job for that destination is run.

Global options

Global options set for a Job Server are the default destination options for that Job Server. If you schedule an object for a Job Server and do not set the object's destination options, the Job Server's default destination settings are used. For instructions on how to set the Job Server's default options for a report, see Setting and customizing the default destination options for a report.

The following example retrieves the FTP destination plugin for a job server.

var Servers = IStore.Query("SELECT SI_NAME, SI_SERVER_KIND FROM CI_SYSTEMOBJS WHERE SI_PROGID='CrystalEnterprise.Server' AND SI_NAME = 'jobserver'");

var JobServer = Servers.Item(1).PluginInterface(""):

var FtpDestination = JobServer.Destinations.Item("Ftp").PluginInterface;

Schedule options

Schedule options set and committed through the InfoStore are the default options for a destination plugin. You set a report's destination options through the SetFromPlugin Method of the Destination Object. If you schedule a report and set the report's destination options, the destination plugin settings are used.

Each Destination plugin is stored in the CI_SYSTEMOBJECTS category in the APS InfoStore under the Destination Plugins folder. This folder has an ID of 29. When used in conjunction with the destination plugin's SI_NAME property, the folder ID can be used to retrieve the InfoObject.

The following example retrieves the FTP destination plugin:

var FTP = IStore.Query("Select Top 1* from CI_SYSTEMOBJECTS WHERE SI_PARENTID=29 AND SI_NAME='CrystalEnterprise.Ftp'").Item(1);

A list of the available Authentication plugins and their names follows. These plugins must be retrieved from CI_SYSTEMOBJECTS:

Plugin	SI_NAME
Crystal Enterprise DiskUnmanaged PlugIn Library	CrystalEnterprise.DiskUnmanaged
Crystal Enterprise Ftp PlugIn Library	CrystalEnterprise.Ftp
Crystal Enterprise Smtp PlugIn Library	CrystalEnterprise.Smtp