|
|
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. See the Report live sample Create sample header for reports option for an example.
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 |
|
SubTitle |
null |
90 |
|
LocationName |
SiteName |
50 |
|
CustomLogo |
ESRI logo |
100 |
|
Address1 |
null |
30 |
|
Address2 |
null |
30 |
|
LatitudeName |
"Latitude:" |
15 |
|
LatitudeValue |
SiteLocation.Y |
12 |
|
LongitudeName |
"Longitude:" |
15 |
|
LongitudeValue |
SiteLocation.X |
12 |
|
SiteType |
"Site Type:" |
15 |
|
SiteTypeValue |
"Circle" or "Polygon" |
15 |
|
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 |
|
Footer |
null for XML format; telephone number to obtain more information for PDF format; footer not available for Excel format |
100 |
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.
SOAP requests for reports in XML format do not return the XML; they only return the URL to the XML file. Requests for reports in PDF and Excel format also only return the URL.
The basic XML structure is <REPORT> with one ore more <SITE>, and each <SITE> contains a <HEADER> with <KEY> and <DATA> with <FIELDS>.
View an XML example of a custom report with three variables.
NOTE: Custom reports—getCustomSiteReport() and getCustomStandardGeographyReport()—allow users to get back a subset of variables from any report. Since report charges are calculated according to the number of variables, this typically is less costly than getSiteReports() and getStandardGeographyReport().
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.
Pricing for the getCustomStandardGeographyReport and getCustomSiteReport methods is the number of variables selected times the amount for each report. The cost for getCustomStandardGeographyReport is 1 credit per variable, so a report with 5 variables will cost a total of 5 credits. The cost for getCustomSiteReport is 16 credits per variable, so a report with 2 variables will cost a total of 32 credits.
Visit the Feedback page to give comments or suggestions about the ArcWeb Developer's Guide.