FRAMES | NO FRAMES
GetReportTemplates Method

Gets the list of all available report templates for summary reports.

Availability: Business Analyst Server, Business Analyst Online.

ReportTemplateInfo[] GetReportTemplates ( 
    string  ActiveDatasetID           
);

Parameter Description
ActiveDatasetID (Since version 9.3.1, this parameter is optional — it can be null).
ID of the active dataset. Type String. Available with Business Analyst Server.

Returns

Variable of type ReportTemplateInfo[]

Remarks

Business Analyst SOAP comes with a number of standard demographic report templates which can be used by SummaryReports to see what your customers look like demographically.

This method is used to get all available report templates for SummaryReports method and for trade area tasks such as Simple Rings, Drive Time, etc.

Examples

The example below requests an array of descriptions of all report templates available in the current instance of Business Analyst Server.

C# 
// Instantiate the BAServerHelper class to access analysis methods
BAServerHelper baServerHelper = new BAServerHelper();
baServerHelper.ActiveDatasetID = "USA_ESRI"; // Optional parameter
 
ReportTemplateInfo[] templates = baServerHelper.GetReportTemplates();
 
// Iterate through report templates and create their description in the
// templateDescriptions array.
string[] templateDescriptions = new string[templates.Length];
for (int i = 0; i < templates.Length; i++)
{
    ReportTemplateInfo template = templates[i];
 
    templateDescriptions[i] =
        string.Format("NAME: {0}; TITLE: {1}; CATEGORY: {2}; FORMATS: {3}; HEADERS: {4}",
            template.Name, template.Title, template.Category,
            string.Join(",", template.Formats), string.Join(",", template.Headers));
}

See Also