Scheduler Jobs API

Topic ContentsTopic Contents
  1. Scheduler Job API
  2. Define a New Scheduler Job
  3. Edit an Existing Scheduler Job

Scheduler Job API

QaSchedulerJobSetting

QaSchedulerJobSettingsXML

QaSchedulerJobSettingXML

Define a New Scheduler Job

Call QaDoc.CreateSchedulerJobSetting() method

No parameters

Returns QaSchedulerJobSetting object (e.g., myJobSettingObject = myDocObject.CreateSchedulerJobSetting())

Set job properties

Get QaSchedulerJobSetting.XML property (e.g., jobXMLString = myJobSettingObject.XML)

Modify XML content

Set QaSchedulerJobSetting.XML property (e.g., myJobSettingObject.XML = jobXMLString)

Call QaSchedulerJob.UpdateDatabase() method (e.g., myJobSettingObject.UpdateDatabase())

Edit an Existing Scheduler Job

Call QaDoc.GetSchedulerJobSettingsXML() to get a list of jobs

Returns XML of all defined jobs (e.g., myJobsString = myDocObject.GetSchedulerJobSettingsXML())

See if job already exists

Deserialize XML (myJobsString)

Iterate and search (use jobName attribute to identify job)

If found

Call QaDoc.GetSchedulerJobSettingByID(<jobId>)

Returns QaSchedulerJobSetting object (e.g., myJobSettingObject = myDocObject.GetSchedulerJobSettingByID(<jobId>))

Access QaSchedulerJobSetting.XML property

Modify XML content

Set QaSchedulerJobSetting.XML property

Call QaSchedulerJob.UpdateDatabase() method

 

 

Can we improve this topic?