SchedulingInfo Object

Crystal Enterprise InfoStore Library
See Also  

The SchedulingInfo object contains a collection of properties used by the APS to store scheduling information (for example, schedule start time information, schedule destination information, schedule dependency information). All objects that can be scheduled have the same scheduling properties; however, these objects have their own set of ProcessingInfo Object properties.

In Crystal Enterprise, only Report objects can be scheduled. Note that if the InfoObject is cannot be scheduled, the object will return NULL. Also note that when an object is scheduled, it uses the time zone specified in the TimeZone Property.

Note:    You must query for the SI_SCHEDULEINFO bag before you can retrieve the properties of this object from a query's result set. See SchedulingInfo properties.

Example

Select SI_SCHEDULEINFO From CI_INFOOBJECTS Where SI_ID = 133

Properties
Property Description

BeginDate Property

The begin date on which the object will be scheduled.

CalendarRunDays Property

Returns a collection of calendar days that determine when the schedule will run.

Dependants Property

Returns the collection of events that are dependant on the object being triggered.

Dependencies Property

Returns the collection of dependency events that the object waits for before being triggered.

Destination Property

Returns the scheduled object's output destination information.

EndDate Property

The end date on which the object will be scheduled.

Flags Property

The instance status.

ErrorMessage Property

The error message for a failed job. It may include plugin-specific information. Read-Only.

IntervalDays Property

The number of days between job processing when using a daily schedule.

IntervalHours Property

The number of hours that are set between job processing when scheduling hourly.

IntervalMinutes Property

The number of minutes that are set between job processing when scheduling hourly.

IntervalMonths Property

The number of months that are set between job processing when scheduling monthly.

IntervalNthDay Property

The day of the month to process job when scheduling every nth day.

Outcome Property

Indicates the result of a job after it has finished processing. Read-Only.

Properties Property

A list of the properties set within the Properties collection.

RetriesAllowed Property

The maximum number of retries allowed.

RetryInterval Property

The number of seconds between retries.

RightNow Property

Sets the schedule to run immediately.

ScheduleOnBehalfOf Property

The ID of the user who the report is scheduled on behalf of.

ServerGroup Property

The ID of the server group that will be used to process scheduled report objects.

ServerGroupChoice Property

Allows you to specify how to choose the server group on which to process scheduled reports.

Status Property

The current status of the scheduled job.

TimeZone Property

The time zone that is used to schedule a job. Read-Only.

Type Property

The frequency type of the schedule (e.g. hourly, monthly).



Crystal Decisions, Inc.
http://www.crystaldecisions.com
Support services:
http://support.crystaldecisions.com