Esri Maps for IBM Cognos (v6.0 Archive)

In this topic
  1. Report variable and conditional block
  2. HTML item
  3. Esri Maps payload block

This is an archive related to a previous version of Esri Maps for IBM Cognos. If you need the current version go to http://doc.arcgis.com/en/maps-for-cognos/.

Items added to map-enabled reports

The map specification for an IBM Cognos report configured with Esri Maps for IBM Cognos will be updated with items specific to Esri Maps for IBM Cognos. These items are required by both IBM Cognos and Esri Maps for IBM Cognos to ensure proper report operation. The following items are added to a map-enabled report configured with Esri Maps for IBM Cognos:

  • Report variable
  • HTML item
  • Conditional block (contained within a block)
  • Esri Maps payload block

Report variable and conditional block

Once a report has been configured by Esri Maps for IBM Cognos, a report string variable named Esri_Maps_Mode is created with the following values:

  • DYNAMIC—renders the map during interactive HTML viewing.
  • STATIC—renders the map during PDF and Excel viewing. This condition typically references an image whose source is an export of the map. This report variable is bound to the conditional block that has been inserted to hold the map.
  • Other—When viewing the report in Report Studio, the Other condition is true, showing the original Esri Map container (placeholder).

The newly created block replaces the original Esri Map placeholder. All attributes set on the original placeholder image are copied to this block; for example, if a border is set on the map placeholder, this setting will be copied to the new block.

HTML item

Once a report has been configured using the Esri Maps Designer user interface, HTML items are created.

There will always be at least one HTML item with a description of Esri Maps Definition Scripts. This HTML item contains JavaScript references to the EM4C Gateway files and is required to perform all interaction and synchronization tasks.

For each IBM Cognos report element chosen for synchronization during the Esri Maps Designer configuration process (List, Crosstab, Chart, and so on), two HTML items are added: one at the start and one at the end of the target element. These elements identify the target element at runtime so they are capable of receiving and broadcasting information. The descriptions for these HTML items are as follows:

  • Esri Maps [object name] Start
  • Esri Maps [object name] End

The [object name] portion is the value of the Name property. For example, suppose a pie chart has Pie Chart1 as its name. The Esri Maps HTML items appear as Esri Maps Pie Chart1 Start and Esri Maps Pie Chart1 End.

Esri Maps payload block

Once a report has been configured with Esri Maps for IBM Cognos, all the Esri Maps-related report specifications are stored inside an Esri Maps payload block. This mechanism associates a particular IBM Cognos report with its Esri Maps-related report specifications. This payload block is set to DONTRENDER and is not sent to the clients.