Administrative and login settings—Esri Maps for IBM Cognos (v6.0 Archive) | Location Analytics

Esri Maps for IBM Cognos (v6.0 Archive)

In this topic
  1. Login properties
  2. Administrative settings

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/.

Administrative and login settings

Esri Maps for IBM Cognos requires an ArcGIS subscription. This can be an ArcGIS Online organizational subscription or an on-premise Portal for ArcGIS deployment. It is assumed that the authentication method used to access the platform has been properly configured by the ArcGIS administrator.

As the Esri Maps for IBM Cognos administrator, you configure the application's settings file to specify the login method used to trigger the appropriate authentication method for your platform subscription. You also specify the location of the ArcGIS platform and various user options. For detailed information about login settings, see Configure login settings.

The settings file is located on the EM4C Gateway in:

<em4c_location>\webcontent\esrimap\configuration\settings.js

Login properties

The following properties are used to define various settings related to the login method. For more information, see Configure login settings.

  • arcgisUrl— Points to the location of your ArcGIS Online organization or Portal for ArcGIS. This property value must be specified for Esri Maps for IBM Cognos to function properly. The value is a string that must be enclosed in quotation marks. For ArcGIS Online, the default value is http://www.arcgis.com. To enter a different value, you must use the format http://[OrgAccount].maps.arcgis.com, where [OrgAccount] is the root of your organization's ArcGIS Online organizational account. For Portal for ArcGIS, the format is http://[PortalHost]/[PortalApp].

    For example:

    arcgisUrl: “http://www.arcgis.com�

OR

arcgisUrl: “http://www.lacs.maps.arcgis.com�

OR

arcgisUrl: “http://portalhost.esri.com/gis�

  • arcgisAuthType— Specifies the login method used to access ArcGIS. This property value is a string that must be enclosed in quotation marks.

    Available values are:

    • user— The user login method requires individuals to provide their own ArcGIS credentials to access ArcGIS items. This is the default login method.

      When the user login method is specified for ArcGIS Online, the arcgisAppId property must also be specified.

    • app— The application login method uses a single account to access all ArcGIS items. If this authentication type is specified, the arcgisAppUser and arcgisAppPassword properties must also be specified.

  • arcgisAppUser— When the login type (arcgisAuthType) is set to app, this property specifies the user name used to retrieve an authentication token, which in turn is used to retrieve ArcGIS items. This property value is a string that must be enclosed in quotation marks. If the login method is set to user, this property is ignored.

    For example: arcgisAppUser: "TestUser"

  • arcgisAppPassword— When the login type (arcgisAuthType) is set to app, this property specifies the password used to retrieve an authentication token, which in turn is used to retrieve ArcGIS items. This property value is a string that must be enclosed in quotation marks. If the login method is set to user, this property is ignored.

    For example: arcgisAppPassword: "Test123"

  • arcgisAppId— This property is used only when the user login method is specified for ArcGIS Online. The value must specify a unique application ID generated when you register your application with the ArcGIS platform. This property value is a string that must be enclosed in quotation marks.

    For example: arcgisAppID: "nvgHDDFXzMRWmKfY"

    For details, see Generate an application ID.

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 acrgisUrl). Acceptable values are true and false; the default is false. This is a Boolean property value and does not require quotation marks.

    For 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.

    For example: selectionColor: "#FF0000"

  • 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.

    For example: infographicsEnabled: false

  • corsEnabledServers—Optionally specifies one or more URLs for known CORS-enabled servers.

    Esri Maps for IBM Cognos automatically detects servers that use Cross-Origin Resource Sharing (CORS) and communicates with these servers without issue. In some cases, however, the initial request (an HTTP POST, for example) is automatically routed through the Esri Maps for IBM Cognos internal proxy, even though the server is CORS-enabled. You can specify the server's URL in this setting to ensure that all calls originating from this location are automatically considered CORS-enabled, thereby bypassing the proxy.

    Each URL must be enclosed within quotation marks, with multiple URLs separated by commas.

    For example: corsEnabledServers: ["mapserver.mycompany.com", "otherserver.othercompany.com"]

    Servers listed here must be pre-configured to support CORS. Before adding a server URL to this list, verify that the server is, in fact, CORS-enabled. If a server specified in this setting is not CORS-enabled, communication with the Esri Maps for IBM Cognos server will fail. For more information, see enable cross-origin resource sharing.

    For more information about proxies, see Configure proxy settings.

  • 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 icon. By default, this value points to the most recent version of the online Help, in the language defined by the user's locale.

    For example: docRoot: "http://doc.arcgis.com/{LOCALE}/maps-for-cognos/"

    If localized documentation is not available for the user's locale, the Help icon 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.

    For example: docRoot: "installed"

    The Help icon will launch the appropriate installed Help system for the report author and report consumer.