Esri Maps for MicroStrategy (v2.0.2 Archive)

In this topic
  1. Administrative settings

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

Configure administrative settings

As the Esri Maps for MicroStrategy 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.

On Windows, the configuration file is in the following location: <MicroStrategy plugin directory>\em4mstr\JavaScript\configuration\settings.js

On Linux, the configuration file is in the following location: <MicroStrategy plugin directory>/em4mstr/JavaScript/configuration/settings.js

After you save and close the file, restart your web application server. Clearing the browser cache may be required to implement changes.

Administrative settings

The following properties are used to define user options.

  • keepAliveInterval—Specifies the interval between checks for user interaction to keep the current session active.

    Esri repeats keep-alive transmissions checking for user interaction. If no response is received, the application continues to send keep-alive transmissions at the specified interval, to verify that idle connections are still active. This property value is specified in milliseconds; the default is 60000.

    For example: keepAliveInterval: 60000

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

    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"

  • incFetchSize—Specifies the number rows that are returned for each data request made for any dataset that is drawn in a map-enabled document. This setting helps control the size of requests made to the Esri Maps for MicroStrategy Intelligence server, which assists administrators in managing database calls.

    For example: incFetchSize: 1000

  • currencySymbol—Specifies the currency code corresponding to the currency symbol to be used on the map by default.

    For example, currencySymbol:"USD"

    Esri Maps for MicroStrategy supports the following currency symbols:

    • USD: $
    • GBP: £
    • EUR: €
    • JPY: ¥

  • infographicsEnabled—Controls whether infographics can be configured and accessed from pop-up windows in Esri Maps for MicroStrategy. 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, designers will be able to configure infographics for a report or document and infographics will be available to users 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. For more information, see Work with proxies.
  • docRoot—This value defines the default location from which the Esri Maps for MicroStrategy documentation is retrieved when users click the Help button on the map. 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-microstrategy/"

    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.

    For example: docRoot: "installed"

    The Help button will launch the appropriate installed help system for the dashboard designer or the dashboard consumer.