Configure administrative settings
In this topic
As the Esri Maps for IBM Cognos administrator, you can modify the application's configuration file (settings.js) to specify a variety of user options. Available options are described below.
Use a standard text editor to modify the application's configuration file.
Configuration file
The configuration file is on the EM4C Gateway in the following location: <em4c_location>\webcontent\esrimap\configuration\settings.js
Note:
- If your Esri Maps for IBM Cognos implementation includes more than one gateway, the settings.js file must be updated on each gateway. The settings should be identical on all gateways.
- If you make changes to settings.js and subsequently want to restore the default administrative and login settings for any reason, you can do so by deleting settings.js and copying and renaming the default settings file (settings.js.default) to settings.js. The settings.js.default file is in the same location as settings.js on each gateway in your environment.
Administrative settings
The following properties are used to define user options.
- arcgisSharing—Controls whether web maps and layers can be
shared with ArcGIS (as specified by arcgisUrl). Acceptable values
are true and false; the default is false. This is a Boolean
property value and does not require quotation marks.
Example: arcgisSharing: false
- selectionColor—Specifies the color to use for areas that define a selection on the map. Colors are defined using hexadecimal values; the default value is #FF0000 (red). This property value is a string that must be enclosed in quotation marks.
Example: selectionColor: "#FF0000"
- outlineColor—Specifies the color to use to outline polygon features and points styled as shapes on the map. Colors are defined using hexadecimal values; the default value is #A5A5A5 (gray). To use the default layer color, specify the value as FillColor. This property value is a string that must be enclosed in quotation marks.
Example: outlineColor: "#FF0000" or outlineColor: "FillColor"
- infographicsEnabled—Controls whether infographics can be configured and accessed from pop-up windows in Esri Maps for IBM Cognos. Supported values are true and false; the default is true. This is
a Boolean property value and does not require quotation
marks.
Because using infographics consumes ArcGIS service credits, system administrators may want to restrict user access to this service.
If infographicsEnabled is set to true, authors will be able to configure infographics for a report and infographics will be available to consumers from pop-ups. If false is specified, both configuration and pop-up access will be disabled.
Example: infographicsEnabled: false
corsEnabledServers—Optionally specifies one or more URLs for known CORS-enabled servers. For more information, see Work with proxies.
- docRoot—This value defines the default location from which the Esri Maps for IBM Cognos documentation is retrieved when designers or consumers click the Help button. By default, this value points to the most recent version of the online help, in the language defined by the user's locale.
Example: docRoot: "http://doc.arcgis.com/{LOCALE}/maps-for-cognos/"
If localized documentation is not available for the user's locale, the Help button launches the English online help. Contact Esri Support to verify the languages in which the documentation is available.
If no Internet connection is available, you can change the docRoot property to specify the locally installed help.
Example: docRoot: "installed"
The Help button will launch the appropriate installed help system for the report author and report consumer.
- preserveDrillContextPDF—This setting controls whether or not the drill action is preserved when viewing a map-enabled report with drill-up and drill-down capabilities in PDF. Supported values are true or false; the default value is false. This is a Boolean property value and does not require quotation marks.
When set to true, the drill action is preserved when a user views a map-enabled report in a PDF. For more information, see the knowledge base article How To: View a map-enabled report with drill-up and drill-down capabilities in PDF format.
- clusterThreshold—This setting defines the value at which point layers are automatically clustered when adding data. The default is 1000 points.
Example: clusterThreshold: "1000"