Report header character limits and default sources
The object KeyValue is used to define fields for the report header. Different methods use different subsets of keys from the table below—in other words, not all keys are used by all methods. The table below shows the default value or source and the character limit for each header key field. NOTE: If you define the header key value as an empty string, the field is left blank (i.e., the default does not appear) except for customLogo which returns an error.
|
Header key |
Default value or source |
Character limit |
|
Address1 |
null |
30 |
|
Address2 |
null |
30 |
|
SiteType |
"Site Type:" |
15 |
|
SiteTypeValue |
"Circle" or "Polygon" |
15 |
|
LatitudeName |
"Latitude:" |
15 |
|
LatitudeValue |
SiteLocation.Y |
12 |
|
LongitudeName |
"Longitude:" |
15 |
|
LongitudeValue |
SiteLocation.X |
12 |
|
SiteUnitsName1 |
"Radius:" |
15 |
|
SiteUnitsValue1 |
Smallest RingRadii + RingUnits |
12 |
|
SiteUnitsName2 |
"Radius:" |
15 |
|
SiteUnitsValue2 |
Middle RingRadii + RingUnits |
12 |
|
SiteUnitsName3 |
"Radius:" |
15 |
|
SiteUnitsValue3 |
Largest RingRadii+RingUnits |
12 |
|
StandardGeographyValue1 |
1st GeographyLevel + list of geographyIds |
100 |
|
StandardGeographyValue2 |
2nd GeographyLevel + list of geographyIds |
100 |
|
StandardGeographyValue3 |
3rd GeographyLevel + list of geographyIds |
100 |
|
SubTitle |
null |
90 |
|
CustomLogo |
ESRI BIS logo |
100 |
|
LocationName |
SiteName |
50 |
If you input multiple rings (through the object Site.ringRadii), your report pages are ordered from the smallest to largest ring. The object KeyValue header key values match the ring order of your report pages. In other words, if your rings are reordered smallest to largest, so are your values in the header keys.
For example:
Three rings: 5, 2, 15 miles
SiteUnitsNames: a, b, c
You see the reports in this order: 2/b, 5/a, 15/c
ResultSet does not always return fields in same order
Be aware that fields returned by object ResultSet might be returned in a different order than expected. There is no guarantee that the field order will be consistent with each response.
Custom logos should be 318 pixels by 215 pixels. Image sizes other than this will affect the look and feel of the logo in the report.
The data document type definition (DTD) describes the format and properties of the XML file for reports.
View the DTD of the XML report sent by the Report Web Service.
Save a local copy of the report file if you need the report for more than 24 hours. ArcWeb Services stores the generated report for 24 hours. The URL you receive to the report is valid only for that period of time.
Visit the Feedback page to give comments or suggestions about the ArcWeb Developer's Guide.