SchedulePoint Object

Job schedules are encapsulated in a SchedulePoint object.

SchedulePoint Properties

The SchedulePoint object contains the following properties.

Property	Type	Description
Title	String	The name of the job being scheduled. Uniqueness not required.
Description	String	The long-form name of the job being scheduled.
HssService	String	The Site.Service of the HSS that owns the schedule points.
MssKey	String	The unique MSS database key for the associated MSS record.
MssSchedule	Object	The object representation of an MSS record.

SchedulePoint Methods

The SchedulePoint object contains the following methods:

AddScheduledJob CheckValid CreateMonitoringPoint CreateSchedule DeleteSchedule GetAsString

GetScheduledJobs LoadFromPoint (1) LoadFromPoint (2) LoadFromString RemoveScheduledJob UpdateSchedule

AddScheduledJob

Adds a job to the schedule.

Syntax

AddScheduledJob(strJobTitle As String, nJobType As Integer, arrJobData As Array)

Parameters

Parameter	Required	Description
strJobTitle	Yes	The name that describes this job.
nJobType	Yes	The type of job being run. Currently supported types: Reports
arrJobData	Yes	An array of objects that can be passed into a job to describe its parameters. Reports: arrJobData[0] = Path to the report definition file arrJobData[1] = File type ("FileSys" or "GRP")

Remarks

None.

CheckValid

Checks to see if the SchedulePoint properties constitute a valid schedule.

Syntax

CheckValid() As Boolean

Parameters

None.

Remarks

Returns true if the object is valid; returns false otherwise.

CreateMonitoringPoint

Creates a point in the HSS to monitor changes in value from the MSS to trigger this schedule.

Syntax

CreateMonitoringPoint(strPointTag As String) As Boolean

Parameters

Parameter	Required	Description
strPointTag	Yes	The tag for the point to be created.

Remarks

None.

CreateSchedule

Creates a new schedule in the MSS and the HSS based on the settings in this SchedulePoint object.

Syntax

CreateSchedule() As Boolean

Parameters

None.

Remarks

Returns true if the HSS point and MSS task were successfully created; returns false otherwise.

DeleteSchedule

Deletes the schedule in the MSS and the HSS.

Syntax

DeleteSchedule() As Boolean

Parameters

None.

Remarks

Returns true if the HSS point and MSS task were successfully deleted; returns false otherwise.

GetAsString

Returns an XML string representation of the schedule.

Syntax

GetAsString() As String

Parameters

None.

Remarks

None.

GetScheduledJobs

Returns a list of the jobs scheduled.

Syntax

GetScheduledJobs() As Array

Parameters

None.

Remarks

Returns ragged array describing the jobs currently scheduled. The length and contents of the internal arrays is determined by job type.

Job types

• Reports

Array[Index][0] = Report Title

Array[Index][1] = Report definition file path

LoadFromPoint (1)

Loads the SchedulePoint object with the schedule details as defined in an HSS point.

Syntax

LoadFromPoint(strPointTag As String) As Boolean

Parameters

Parameter	Required	Description
strPointTag	Yes	The tag for the HSS point that contains the definition for this schedule.

Remarks

Returns true if the load was successful; returns false otherwise.

LoadFromPoint (2)

Loads the SchedulePoint object with the schedule details as defined in an HSS point.

Syntax

LoadFromPoint(pointTag As Object) As Boolean

Parameters

Parameter	Required	Description
pointTag	Yes	As AESharedLib.FullPointTag.

Remarks

Returns true if the load was successful; returns false otherwise.

LoadFromString

Loads the SchedulePoint object with the schedule details defined in the given XML string.

Syntax

LoadFromString(strSchedulePoint As String) As Boolean

Parameters

Parameter	Required	Description
strSchedulePoint	Yes	An XML string that describes a schedule.

Remarks

Returns true if the load was successful; returns false otherwise.

RemoveScheduledJob

Removes a job from the schedule.

Syntax

RemoveScheduledJob(strJobTitle As String, nJobType As Integer, arrJobData As Array)

Parameters

Parameter	Required	Description
strJobTitle	Yes	The name that describes this job.
nJobType	Yes	The type of job being run. Currently supported types: Reports
arrJobData	Yes	Array of objects that can be passed into a job to describe its parameters. Reports: arrJobData[0] = Path to the report definition file arrJobData[1] = File type ("FileSys" or "GRP")

Remarks

The parameters are needed to determine which job to remove from the schedule, as Title isn't sufficient alone.

UpdateSchedule

Updates the schedule in the MSS and the HSS based on the settings in this SchedulePoint object.

Syntax

UpdateSchedule() As Boolean

Parameters

None.

Remarks

Returns true if the HSS point and MSS task were successfully updated; returns false otherwise.