FRAMES | NO FRAMES
GetAvailableReportFormats Method

Gets the list of all available report formats.

Availability: Business Analyst Server.

string[] GetAvailableReportFormats ( 
    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.

Returns

Variable of type String[] containing the list of all available formats

Remarks

The following report formats are available in Business Analyst Server 10.0.

Format Name Description
"CSV" Comma separated values format.
"HTML" HTML format.
"PDF" PDF format.
"S.XML" Simplified XML format. Available with Business Analyst Server 9.3.1.
"XLSX" Excel 2007 format. Available with Business Analyst Server 10.0.
"XML" XML format.
"ZIP" Zipped HTML format.

The S.XML format is the simplified version of the XML format in which all simple nodes having a unique tag relative to its parent are replaced with corresponding attributes of parent. Additionally, text fields associated with data in the report template are attached to data fields as decriptions.

Examples

The example below requests a string array of available report output formats.

C# 
// Instantiate the BAServerHelper class to access analysis methods
BAServerHelper baServerHelper = new BAServerHelper();
baServerHelper.ActiveDatasetID = "USA_ESRI"; // Optional parameter
 
string[] reportFormats = baServerHelper.GetAvailableReportFormats();

See Also