Managed Reports API

Managed Report API

QaManagedReport

QaManagedReportXML

Define a New Managed Report

1.     Call QaDoc.CreateManagedReport() method

a.     No parameters

b.     Returns QaManagedReport object (e.g., myManagedReportObject = myDoc.CreateManagedReport())

2.     Set report properties

a.     Get QaManagedReport.XML property (e.g., reportXMLString = myManagedReportObject.XML)

3.     Modify XML content

a.     Set QaManagedReport.XML property (e.g., myManagedReportObject.XML = reportXMLString)

b.     Call QaManagedReport.UpdateDatabase() method (e.g., myManagedReportObject.UpdateDatabase())

Edit an Existing Managed Report

1.     Call QaDoc.GetManagedReportsXML() to get a list of jobs

a.     Returns XML of all defined jobs (e.g., myReportsString = myDocObject.GetManagedReportsXML())

2.     See if job already exists

a.     Deserialize XML (myReportsString)

b.     Iterate and search (use name attribute to identify job)

3.     If found

a.     Call QaDoc.GetManagedReportByID(<reportId>)

b.     Returns QaManagedReport object (e.g., myManagedReportObject = myDocObject.GetManagedReportByID(<reportId>))

c.      Access QaManagedReport.XML property

d.     Modify XML content

e.     Set QaManagedReport.XML property

f.        Call QaManagedReport.UpdateDatabase() method