| FRAMES | NO FRAMES |
Options of a report to be generated.
Availability: Business Analyst Server, Business Analyst Online.
class ReportOptions
| Property | Description |
|---|---|
| AreaTitleField (optional) | Area description attribute field name
in a boundary layer used as a source for summary report.
Type String. Available
with Business Analyst Server 10.0 and Business Analyst Online
10.0. Default: "AREA_DESC2". |
| LocationNameField (optional) | Location attribute field name
in a boundary layer used as a source for summary report.
Type String. Available
with Business Analyst Server 10.0 and Business Analyst Online
10.0. Default: "SITE_NAME". |
| ReportFormat | Required format of report. Type String. |
| ReportHeader (optional) | Array of key/value pairs specifying header properties to be customized. Type KeyValue[]. |
| StoreAddressField (optional) | Store address attribute field name
in a boundary layer used as a source for summary report.
Type String. Available
with Business Analyst Server 10.0 and Business Analyst Online
10.0. Default: "STORE_ADDR". |
| StoreLatitudeField (optional) | Store latitude attribute field name
in a boundary layer used as a source for summary report.
Type String. Available
with Business Analyst Server 10.0 and Business Analyst Online
10.0. Default: "STORE_LAT". |
| StoreLongitudeField (optional) | Store longitude attribute field name
in a boundary layer used as a source for summary report.
Type String. Available
with Business Analyst Server 10.0 and Business Analyst Online
10.0. Default: "STORE_LONG". |
| TemplateName | Report template name. Type String. |
The TemplateName property is used in summary reports only. In standard reports whose parameters inherit from the StandardReportParameters class, this property is ignored.
The following report formats are now supported.
| 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.
Since Business Analyst 10.0, five new properties are available with this type. They specify a binding of source boundary layer fields with report header fields of summary reports. Their default values are tuned for using with summary reports to be generated with tasks producing trade areas:
| Trade Area Task | Default Binding |
|---|---|
| CustomerDerivedAreas | AreaTitleField, StoreAddressField, StoreLatitudeField, StoreLongitudeField |
| DriveTime | AreaTitleField, StoreAddressField, StoreLatitudeField, StoreLongitudeField |
| Grids | — |
| RemoveOverlap | — |
| SimpleRings | AreaTitleField, StoreAddressField, StoreLatitudeField, StoreLongitudeField |
| StandardLevelsOfGeography | AreaTitleField, StoreAddressField |
| ThresholdRings | AreaTitleField, StoreAddressField, StoreLatitudeField, StoreLongitudeField |
The ReportHeader array specifies additional options to customize headers of reports. The "subtitle" header option allow the user to customize the subtitle in reports with a subtitle. Other header options allow the user to customize header values in summary reports only. The following custom header options can be specified for summary reports.
| Header Option | Description |
|---|---|
| "address" | Store address text. |
| "areadesc2" | Area description text. |
| "binarylogo" | Custom logo graphic specified as MIME64 string. |
| "latitude" | Store latitude text. |
| "locationname" | Custom location name. |
| "logo" | Custom logo graphic specified as a complete URL reference. Available with Business Analyst Server 10.0 SP3. |
| "longitude" | Store longitude text. |
| "reportstyle" | Style to get the report in. Available styles are "Screen" and "Paper". Default: "Screen". |