Geographic Maps

Download this manual as a PDF file

This section describes how to view, create, and manage geographic maps for the various elements, also called nodes, in Skylar One.

What is a Geographic Map?

A geographic map is an interactive tool that visually represents location-based data associated with different devices or services. The map displays devices or services as nodes positioned according to their physical locations (longitude and latitude).

Each node on the map reflects the current status based on calculated health: for devices, this is determined by the most severe active event (device state); for services, it represents the service’s overall calculated health. By integrating data types with mapping layers, Skylar One provides intuitive insights into the health and location of a system or service.

If you install AP2 9.38.2 (Revani) or later, you can also display high-fidelity map tiles from your own Esri ArcGIS Location Platform account beneath the devices and services on a geographic map. The tiles show street-level detail, including roads, waterways, landmarks, and boundaries. For more information, see the section on Displaying Esri Map Tiles.

Viewing Geographic Maps

The Geographic Maps page (Maps > Geographic Maps) lists all geographic maps associated with your organization. Each map visually represents devices or services, also referred to as nodes, within your environment that have been discovered by Skylar One. Geographic maps position objects using their longitude and latitude coordinates and plot them based on the physical location of each device or service.

This page includes a table that lists key details for each map entry. The table can include the following columns:

  • ID. A unique identifier for the map record.

  • Name. The name assigned to the geographic map.

  • Organizations. The organizations associated with the map.

  • Map Entity. The entity type represented by the map.

  • Created By. The user who originally created the map.

  • Date Created. The date and time the map was initially created.

  • Last Edited By. The user who last modified the map.

  • Date Edited. The date and time of the most recent edit.

If you do not see one of these columns, click the gear icon (gear icon) and then select Column Preferences to add or remove columns. You can also drag columns to different locations on the page or click on a column heading to sort the list by the values in that column. Skylar One retains any changes you make to the columns that appear on the page and automatically recalls those changes the next time you open the page. For more information, see the section on Editing the Settings for an Inventory Page in the Introduction to Skylar One manual.

To view a geographic map, go to the Geographic Maps page (Maps > Geographic Maps) and click the name of the map you want to view under the Name column. The geographic map view is split into two sections:

  • The geographic map
  • The geographic map table

image of a geographic map

Viewing Geographic Map Nodes

Geographic maps display a node for each location that contains devices or services. This applies to both device and service maps. By default, the map is zoomed out to show all in-filter devices or services.

You can zoom in and out to reveal different levels of detail about a location:

  • Zoomed-out view (clustered locations). Nodes use different icons to show whether a location contains a single device or service, multiple devices or services, or a cluster of several locations. If multiple locations are close together, the map displays a single cluster node that shows the number of locations in that area. For example, a node marked "3" in California means that three nearby locations contain devices.

  • Zoomed-in view (location separation). As you zoom in, a cluster node splits into individual nodes labeled with their location names, such as Los Angeles, Long Beach, and Marina. If you zoom in further, multi-location nodes split into single-location nodes.

  • Single-location behavior. If only one location in a region of the map contains devices or services, the map displays a single node labeled with that location name, even when zoomed out.

  • Full-screen view. You can expand a geographic map to full screen. The full-screen view shows the map only, without the geographic map table or any other components of the Skylar One user interface. This functionality is available if you install AP2 9.38.2 (Revani) or later.

To see the devices or services at a location, hover your cursor over its node. The map lists devices by device name and services by service name.

Viewing the List of Devices or Services Associated with a Geographic Map

When you view devices or services on the geographic map, a table to the right lists all items plotted on the map. You can customize which columns are shown, including additional attributes such as location details or device/service metadata. The set of available columns depends on whether you are viewing a geographic map of devices or services.

You can sort the list by a column's values by clicking its column heading. You can also filter the items on the page by typing or selecting filter options in one or more of the filters found above the columns. For more information, see the topic on Filtering Inventory Pages.

If you do not see one of these columns, click the gear icon (gear icon) and then select Column Preferences to add or remove columns. You can also drag columns to different locations on the page or click on a column heading to sort the list by the values in that column. Skylar One retains any changes you make to the columns that appear on the page and automatically recalls those changes the next time you open the page. For more information, see the section on Editing the Settings for an Inventory Page in the Introduction to Skylar One manual.

You can adjust the size of the rows and the size of the row text on this inventory page. For more information, see the topic on Adjusting the Row Density.

You can save the current list of items as a comma-separated list by clicking the gear icon (gear icon) and selecting Export to CSV.

For each device, the table can display the following information:

  • Favorite. Indicates whether the device has been marked as a favorite for quick access.
  • ID. A unique identifier assigned to the device.
  • Device Name. The device name. Clicking the name takes you to the Device Investigator page for that device.
  • State. The current condition of the device, based upon events generated by the device.
  • Hostname. The network hostname associated with the device.
  • IP Address. The primary IP address used to reach the device.
  • Date Added. The date the device was added to the system inventory.
  • Date Created. The original creation date of the device record.
  • Organization. The organization to which the device is assigned.
  • Organization ID. A unique identifier for the organization associated with the device.
  • Class. The device’s classification category (for example: server, router, appliance).
  • Class ID. A unique identifier associated with the device’s classification.
  • Category. A broader grouping that describes the type or role of the device.
  • Category ID. A unique identifier for the device’s assigned category.
  • Type. Specifies the device type, often tied to its functional characteristics.
  • Collector Group. The name of the collector group responsible for polling the device.
  • Collector Group ID. A unique identifier for the assigned collector group.
  • Asset ID. An asset‑tracking identifier used for inventory.
  • Last Poll. The date and time when the device was most recently polled.
  • Uptime. Shows how long the device has been running since its last restart.
  • Collection State. Indicates whether the device is actively being polled or monitored.
  • SNMP Credential. Identifies the SNMP credential used to poll the device.
  • SNMP Version. Specifies the SNMP protocol version used for polling.
  • SL Agent. Indicates whether the device is reporting through an installed ScienceLogic Agent.
  • ID (Location). A unique identifier associated with the device’s assigned geographic location.
  • Name (Location). The location of a device based on its city name.
  • Latitude (Location). The geographic latitude of the device’s location.
  • Longitude (Location). The geographic longitude of the device’s location.
  • Street (Location). The street address associated with the device’s location.
  • City (Location). The city in which the device’s location resides.
  • State (Location). The state, province, or region of the device’s location.
  • Zipcode (Location). The postal or ZIP code of the device’s location.
  • Country (Location). The country associated with the device.
  • Domestic Region (Location). The internal region within the country in which the device's location resides.
  • Global Region (Location). The device's broader geographic classification such as EMEA and APAC.
  • Notes (Location). Any additional comments or annotations associated with the location.
  • Description (Location). A more detailed description of the location.
  • Organizations (Location). Lists the organizations linked to or operating within the location of the device.

For each service, the table can display the following information:

  • Favorite. Indicates whether the service has been marked as a favorite for quick access.
  • ID. A unique identifier assigned to the service.
  • Name. The service name. Clicking the name takes you to the Service Investigator page for that service.
  • Description. A short explanation of the service and what it represents.
  • Label. A tag or label applied to categorize or group the service.
  • Type. Specifies the type or classification of the service.
  • Health. Shows the current health status of the service.
  • Availability. Indicates whether the service is currently available or experiencing downtime.
  • Risk. Represents the assessed risk level associated with the service.
  • Policy. Displays the policy or rule set applied to the service.
  • Organization. Identifies the organization associated with the service.
  • Date Updated. The most recent date when service details were updated.
  • Last Updated By. The user or system that last modified the service record.
  • Contact User. The primary user contact associated with the service.
  • Contact Organization. The organization responsible for or linked to the service’s primary contact.
  • Service Analysis. Shows summary analysis or diagnostic insights related to the service.
  • Status. Indicates the current operational status of the service.
  • Refresh Interval. Specifies how frequently the service data is refreshed or polled.
  • ID (Location). A unique identifier associated with the service’s assigned geographic location.
  • Name (Location). The location of a service based on its city name.
  • Latitude (Location). The geographic latitude of the service’s location.
  • Longitude (Location). The geographic longitude of the service’s location.
  • Street (Location). The street address associated with the service’s location.
  • City (Location). The city in which the service’s location resides.
  • State (Location). The state, province, or region of the service’s location.
  • Zipcode (Location). The postal or ZIP code of the service’s location.
  • Country (Location). The country associated with the service.
  • Domestic Region (Location). The internal region within the country in which the service's location resides.
  • Global Region (Location). The service's broader geographic classification such as EMEA and APAC.
  • Notes (Location). Any additional comments or annotations associated with the location.
  • Description (Location). A more detailed description of the location.
  • Organizations (Location). Lists the organizations linked to or operating within the location of the service.

Creating a Geographic Map

Creating a geographic map is a two-step process. First, you must assign location data to the devices or services you want to display. This can be done either by importing location data in bulk using a spreadsheet and script, or by aligning devices or services through the Locations page (Manage > Locations) in the Skylar One user interface.

After you assign location data, you can create a geographic map by selecting those devices or services from the Geographic Maps page (Maps > Geographic Maps).

How Location Data Is Used by Geographic Maps

Geographic maps display only devices or services that already exist in the Database Server and have location data assigned. Location data includes information such as latitude, longitude, and organization alignment. Devices or services without assigned location data do not appear as options when you create a geographic map.

Location data can be assigned using one of the following methods:

Both methods update the same underlying data and determine which devices or services are available when creating a geographic map.

Assigning Location Data Using Bulk Import

Device and service data can be managed in bulk using spreadsheets. This approach allows you to assign location data to multiple devices or services and upload them efficiently, rather than updating each individually. The process can be repeated as needed to keep location data current. After you upload them, the devices or services appear on the Geographic Maps page for selection during map creation.

Prerequisites for Bulk Assigning Location Data

To assign location data to devices or services using the bulk import method, you must first do the following:

Step 1: Download the "ScienceLogic: Geographic Maps" PowerPack

Download the latest version of the "ScienceLogic: Geographic Maps" PowerPack. This PowerPack contains the reports you need to run to generate a spreadsheet of all devices or services you want to plot on a geographic map. To do so:

  1. Search for and download the PowerPack from the PowerPacks page at the ScienceLogic Support Center (Skylar One > PowerPacks, login required).

  2. In Skylar One, go to the PowerPack Manager page (System > Manage > PowerPacks).

  3. Click the Actions menu and choose Import PowerPack. The Import PowerPack modal appears.

  4. Click Browse and go to the "ScienceLogic: Geographic Maps" PowerPack.

  5. Select the PowerPack file and click Import. The PowerPack Installer modal displays a list of the PowerPack contents.

  6. Click Install. The PowerPack is added to the PowerPack Manager page.

Step 2: Download the "GeoMapImport" ZIP file

When creating a geographic map for devices or services, you need the bulk import file and its configuration file, both of which are included in the "GeoMapImport" ZIP file. The bulk import file uploads geographic data to the server. Later, you run a report (provided in the "ScienceLogic: Geographic Maps" PowerPack) to generate a spreadsheet of the devices or services you select, enter the location details in that spreadsheet, and upload the updated data to the Database Server.

To download the "GeoMapImport" ZIP file:

  1. Go to the ScienceLogic Support Center and download version 11 of the "GeoMapImport" ZIP file locally to your machine from the AP2 Release Versions page (Skylar One > Downloads > AP2 Releases).

  2. Select "GeoMapImport" from the Release Files table and then click the Download File button located under the Release File Downloads section of the page. Doing so downloads the ZIP file, Sciencelogic-geolocation-import-scripts-v11.zip.

  3. The ZIP file includes both the bulk import script (geo-location-import-device-v10.py for devices and geo-location-services-import-v1.py for services) and its configuration file (geo_import.devices.cfg for devices and geo_import_services.cfg for services). You need both files to create a geographic map.

  4. Extract the ZIP file, locate the corresponding script (geo-location-import-device-v10.py for devices or geo-location-services-import-v1.py for services), and confirm that the target device is configured with the following:

    • Python 3.7 or later

    • Python PIP

    • The following Python packages installed:

      • requests
      • sys
      • logging
      • urllib3
      • configparser
      • os
      • csv
      • defaultdict
      • time
      • json
    • All of these packages are included by default when you install Skylar One.

Step 3 (Optional): Align the "ScienceLogic: Geographic Maps Usage" Dynamic Application

Align the "ScienceLogic: Geographic Maps Usage" Dynamic Application to the primary Database Server if you are on-premises, or ask an administrator to align it to their virtual IP address if you are on a SaaS Skylar One deployment. Doing so assists ScienceLogic with implementing future updates. After alignment, complete the steps outlined below:

  1. Align the Dynamic Application to a Skylar One Database Server. For more information, see the section on Manually Aligning a Dynamic Application to a Device.

  2. Make sure the Dynamic Application's Poll Frequency is set to run once every 24 hours. For more information, see the section on Updating the Poll Frequency for a Dynamic Application Aligned to a Device.

  3. Ensure the Dynamic Application runs successfully. For more information, see the section on Running a Dynamic Application on a Device.

  4. Schedule the "Geographic Maps V1 - Device location export" report for devices, or "Geographic Maps V1 - Service location export" for services, to run once a week and email the resulting .xlsx file to Geo-MapsPM@sciencelogic.com. For more information, see the section on Scheduling Custom Reports.

Files Required for the Bulk Import Method

To assign location data using the bulk import method, you must have the following files:

  • A spreadsheet file. An Excel (.xlsx) file that lists the devices or services to be assigned location data. This spreadsheet is generated by running either the Extract Location Data – Devices report or the Extract Location Data – Services report included in the "ScienceLogic: Geographic Maps" PowerPack. After generating the report, add the required location data and save the file in CSV UTF‑8 format.

  • Bulk import script. The bulk import script uploads the devices or services and their associated location data from the spreadsheet into the Database Server. After the data is imported, the devices or services become available for selection on the Geographic Maps page.

  • Configuration file. The configuration file controls how the bulk import script runs, including the target server and authentication details. This file is included in the same ZIP package as the bulk import script.

After extracting the "GeoMapImport" ZIP file (described in the prerequisites above), you have both the bulk import script and its configuration file. The final step is to generate the spreadsheet, add location data, and run the script to upload the updated information. The script connects to the target Database Server specified in the configuration file and does not need to be run directly on the Database Server itself.

After you complete this process, you can create a geographic map using the imported location data.

  1. Generate the spreadsheet for devices or services. Run the appropriate Extract Location Data report to generate an Excel spreadsheet containing the devices or services to be plotted.

  2. Assign location data for devices or services. Add latitude, longitude, and other optional location fields to the spreadsheet and save it in CSV UTF‑8 format.

  3. Import the location data. Run the bulk import script to upload the updated spreadsheet to the Database Server.

  4. Create the geographic map. Select the imported devices or services from the Geographic Maps page. Only entities with assigned location data appear as options.

Generating the Excel Spreadsheet for Devices

To generate the Excel spreadsheet used to add location data to devices:

  1. Go to the Reports page (Reports > Reports).
  2. Click Run Report > Asset Management > Location Data Extract - Devices.
  3. In the Select devices by field, choose the devices you want to include in the report. You can list devices by Organization, Category, or Device Group. To select specific devices instead of all devices within these groups, select the Select individual devices checkbox and then select the individual devices you want to include.
  4. The devices selected when generating this report are uploaded to the Database Server, where they become available for selection when creating a geographic map.

  5. In the Output format field, select Microsoft Excel 2007+ Spreadsheet (.xlsx).
  6. Click Generate.

Generating the Excel Spreadsheet for Services

To generate the Excel spreadsheet used to add location data to services:

  1. Go to the Reports page (Reports > Reports).
  2. Click Run Report > Asset Management > Location Data Extract - Services.
  3. Select one or more organizations to include in the report. All services belonging to the selected organizations are included automatically, or you can select the All Organizations checkbox to include every organization and all of their services.
  4. The services selected when generating this report are uploaded to the Database Server, where they become available for selection when creating a geographic map.

  5. In the Output format field, select Microsoft Excel 2007+ Spreadsheet (.xlsx).
  6. Click Generate.

Assigning Location Data to Devices

To assign location data to the devices you want to add to your geographic map:

  1. When the report is generated, open the report spreadsheet and edit the necessary columns:
    • Mandatory fields:
      • Device ID. The unique identifier assigned to the device.
      • Latitude. The geographic latitude of the device’s location.
      • Longitude. The geographic longitude of the device’s location.
      • Organization ID. The unique identifier for the organization associated with the device.
      • If this is your first time creating a report for geographic maps, the cells under the Longitude and Latitude columns in the spreadsheet are empty. You must supply values for each device in these two columns.

    • Optional fields:  
      • Device Name. The name of the device.
      • Location Name. The location name of the device that appears on your geographic map.
      • The cells under the Location Name column are empty. This field is optional but highly recommended, as these are the location names that appear on your geographic map.

      • Organization. The organizations to which the device is aligned. These organizations appear on your geographic map.
      • Global region. The broad area where the device is located, such as North America or Asia-Pacific.
      • Country. The nation where the device is located.
      • Domestic region. The internal or local area within a country where the device is located, such as Northeast or West Coast.
      • City. The city or town where the device is located.
      • Street. The street address or road name for the device’s location.
      • Zip code. The postal code for the device’s location.
      • Description. A brief explanation of the device’s purpose or details.
      • State. The state where the device is located.
      • Note. Any additional information relevant to the device.

    Populate the optional fields in the spreadsheet depending on the level of complexity required for your search filters.

  2. After you have filled in all the required details, save the spreadsheet in CSV UTF‑8 format.

Assigning Location Data to Services

To assign location data to the services you want to add to your geographic map:

  1. When the report is generated, open the report spreadsheet and edit the necessary columns:
    • Mandatory fields:
      • Service GUID. The globally unique identifier assigned to the service.
      • Latitude. The geographic latitude of the service’s location.
      • Longitude. The geographic longitude of the service’s location.
      • Organization ID. The unique identifier for the organization associated with the service.
      • If this is your first time creating a report for geographic maps, the cells under the Longitude and Latitude columns in the spreadsheet are empty. You must supply values for each service in these two columns.

    • Optional fields:  
      • Service Name. The name of the service.
      • Location Name. The location name of the service that appears on your geographic map.
      • The cells under the Location Name column are empty. This field is optional but highly recommended, as these are the location names that appear on your geographic map.

      • Organization. The organizations to which the service is aligned. These organizations appear on your geographic map.
      • Global region. The broad area where the service is located, such as North America or Asia-Pacific.
      • Country. The nation where the service is located.
      • Domestic region. The internal or local area within a country where the service is located, such as Northeast or West Coast.
      • City. The city or town where the service is located.
      • Street. The street address or road name for the service’s location.
      • Zip code. The postal code for the service’s location.
      • Description. A brief explanation of the service’s purpose or details.
      • State. The state where the service is located.
      • Note. Any additional information relevant to the service.

        Populate the optional fields in the spreadsheet depending on the level of complexity required for your search filters.

  1. After you have filled in all the required details, save the spreadsheet in CSV UTF‑8 format.

Importing Location Data

  1. For a geographic map that plots devices, move the geo-location-import-device.v10.py bulk import script file, the geo_import_devices.cfg script configuration file, and the spreadsheet file you have created and updated in the previous step to the same folder. If you are creating a geographic map that plots services, move the geo-location-import-services.v1.py bulk import script file, the geo_import_services.cfg script configuration file, and the spreadsheet file you have created and updated in the previous step to the same folder.

    If you are working from an environment with no access to the Internet (air-gapped installations), copy the bulk import script file, script configuration file, and the spreadsheet to a Skylar One appliance by using SSH to access the Skylar One appliance. Then, move all files to the same folder.

  2. Update the geo_import_devices.cfg for devices or the geo_import_services.cfg script configuration files by adding the following information to the fields shown:
    • URL. Enter the URL of the Skylar One stack to which you upload the file, which is the IP address of the Database Server.
    • Username. Enter the username used to connect to Skylar One.
    • Password. Enter the password used to connect to Skylar One.
    • Excel File Path. Enter the CSV file name you have created in the Generating the Excel Spreadsheet for Devices or Generating the Excel Spreadsheet for Services section above.
  3. Either go to the console of the Skylar One Database Server or use SSH to access the Database Server, then run the following Python script: python3.11 geo-location-import-device-v10.py. For a geographic map that plots services, run the following Python script: python3.11 geo-location-import-services-v1.py. The console displays five different logging levels with a number assigned to them.
  4. Alternatively, you can connect through the console of a server that has SSH access to the Database Server. In air-gapped environments, you can use SSH to access the Database Server itself.

  5. Enter the level of information you want on your geographic map by entering the number corresponding to the desired logging level. The script reads the spreadsheet file, de-duplicates locations, adds new locations to Skylar One, and associates devices or services with location data.
  6. The script connects with the GraphQL interface of the IP address, username, password, and Excel file path specified in the geo_import.cfg script configuration file. The script also creates a list of single entries for each device or service and their location. If devices or services have identical locations (longitude and latitude), the script associates them to a single location, which is displayed as a single entry. This is so that the script can capture the number of unique locations in your spreadsheet report.

Assigning Location Data Through the Locations Page

This method allows you to assign and manage location data directly through the user interface by using the Locations page (Manage > Locations). Instead of generating a spreadsheet and running bulk import scripts, you can select an organization, view the devices or services associated with it, and align those entities to locations through guided modals. After you align devices or services, they automatically become available for selection when creating a geographic map.

For more information on managing locations and aligning devices or services to them, see the section on Locations.

Creating the Geographic Map

After you have assigned location data to your devices or services, they appear as options when you create the map. To create the map:

  1. Go to the Geographic Maps page (Maps > Geographic Maps).

  2. Click the Create Geographic Map button.

  3. Enter information in the following fields:

    • Map Name. Enter a name for your geographic map.

    • Organizations. Select the organizations that can view this map.

    • Entity Type. Select Device or Service to choose whether to plot devices or services.

    • Tile Provider. (Optional) Select the provider of the map tiles. This field populates automatically if an Esri credential is aligned to the same organization as the map. For more information, see the section on Displaying Esri Map Tiles.

    • Tile Provider Credential. (Optional) Select the Esri credential that contains your Esri public API key. This field displays only if you select an option in the Tile Provider field, and populates automatically if a matching credential exists. If you have more than one matching credential, select the one to use.

    • Default Style. (Optional) Select the map tile style that users see by default when they view the map.

      The Tile Provider, Tile Provider Credential, and Default Style fields display if you install AP2 9.38.2 (Revani) or later.

  4. Under the Search and Filter Devices To Map field, enter the filter expression to specify which devices appear in the geographic map.

  5. If you select Service in the Entity Type field, this field is labeled Search and Filter Services To Map.

    A filter expression, sometimes referred to as an expression match, is used to locate and filter data from a database. This can be any combination of alphanumeric and multi-byte characters, up to 64 characters in length. Skylar One's expression matching is case-sensitive. For details on the regular-expression syntax allowed by Skylar One, see http://www.python.org/doc/howto/.

    You can sort and filter the column data in the table on the page by clicking the Filter field under the column names.

  6. Click Save.

Editing a Geographic Map

To edit an existing geographic map:

  1. Go to the Geographic Maps page (Maps > Geographic Maps) and find the map you want to edit.

  2. Click the actions icon (actions icon) for the geographic map you want to edit, then select Edit.

  3. Make changes to the fields on the page as necessary. For descriptions of these fields, see the section on Creating the Geographic Map.

  4. Click Save.

Deleting a Geographic Map

To delete a geographic map:

  1. Go to the Geographic Maps page (Maps > Geographic Maps) and find the map you want to delete.

  2. Click the actions icon (actions icon) for the geographic map you want to delete, then select Delete. The Delete Geographic map modal appears.

  3. Click Delete to confirm.

Displaying Esri Map Tiles

You can display high-fidelity map tiles from your own Esri ArcGIS Location Platform account beneath the devices and services on a geographic map. The tiles show street-level detail, including roads, waterways, landmarks, and boundaries.

You can display Esri ArcGIS map tiles in your geographic maps only if you install AP2 9.38.2 (Revani) or later.

To display Esri map tiles, complete the following tasks:

  1. Create an Esri public API key in your Esri account.
  2. Create an Esri credential in Skylar One that contains the API key.
  3. Select the credential when you create or edit a geographic map.

Creating an Esri Public API Key

To display Esri map tiles, you first need an Esri ArcGIS Location Platform account. You must then create an Esri public API key. For instructions, see the knowledge base article How To Create an ESRI ArcGIS Location Platform API Key.

Copy the API key after it is generated. You must paste the API key value into the Esri API Key credential that you create in Skylar One.

Skylar One sends the API key to the web browser of each user who views a map that uses Esri map tiles. Restrict the key to the hostname you use for Skylar One and enable only the Basemaps permission. ScienceLogic also recommends that you set up usage and billing alerts in your Esri account.

Creating an Esri Credential

Esri designs public API keys for use in a web browser. For this reason, Skylar One stores the key in a credential field that does not encrypt the key.

If it does not already exist, you must first create the "ESRI_API_KEY" credential type before you can create an Esri credential. You need to create the credential type only once.

To create the "ESRI_API_KEY" credential type:

  1. Go to the Credentials page (Manage > Credentials).
  2. Click the Types tab.
  3. Click Create New.
  4. In the Type Name field, type "ESRI_API_KEY".
  5. In the JSON Definition field, paste the following definition:
    {
      "fields": [
        {
          "propName": "esri_api_key",
          "displayName": "Esri Public API Key",
          "type": "string",
          "encryption": false,
          "required": true      
        }
      ],
      "layout": {
        "sections": [
          {
            "border": true,
            "lines": [
              {
                "fields": ["esri_api_key"] }
            ]
          }
        ]
      }
    }
  6. Click Create.

 

To create an Esri credential:

  1. Go to the Credentials page (Manage > Credentials).
  2. Click Create New and select the ESRI_API_KEY credential type. The Create Credential modal appears.
  3. Supply values in the following fields:
    • Name. Enter a name for the credential, such as "Esri Public Geographic Maps API Key". This field is required.
    • All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then use the Select the organizations the credential belongs to field to select the specific organizations you want to align with the credential. This field is required.
    • Esri Public API Key. Paste the Esri public API key you created. This field is required.
  4. Click Save & Close.

The credential and the geographic map must be aligned to the same organization. Otherwise, you cannot select the credential for the map.

Selecting an Esri Credential

To display Esri map tiles, select the Esri credential when you create or edit a geographic map. If an Esri credential is aligned to the same organization as the map, the Tile Provider and Tile Provider Credential fields populate automatically. If more than one matching credential exists, you can select the one to use.

If the API key is valid, the map displays high-resolution tiles that show more detail as you zoom in. You can use the selector at the top of the map to change the map tile style. If you select a credential that contains an invalid API key, the geographic map page displays an error.