Administration
      Back to home
      1. Klir Knowledge Hub
      2. Administration

      Setting Up and Configuring ArcGIS Maps in Klir

      Overview

      Klir integrates ESRI ArcGIS Maps for GIS functionality, providing the ability to configure and manage base maps, public and private map layers, and their visibility within the Klir platform. This integration leverages both ArcGIS Online and Enterprise services to enhance the mapping experience for users. Below are the key features available with the map component in Klir:

      • Configurable Basemaps: Select from a variety of basemaps provided by ESRI.
      • API Key Integration: Use the ArcGIS Online Organization API Key to track and manage map usage.
      • Layer Management: Add or remove public and private map layers, and control their order on the map.
      • Table of Contents (TOC) Control: Manage layer visibility with the ability to toggle layers on or off and collapse the TOC panel.

      Configuration Process

      The setup of map components in Klir is performed through the Klir user interface and can be done by a Klir Customer Success Manager (CSM) for specific tasks, while others are handled by the Utility team.

      Path to Map Settings in Klir:

      • Klir Administration → System Administration → Settings → Map Settings

      Note: Steps in blue text must be completed by the Klir CSM, while steps in black text are to be completed by the Utility team.

      Setting Up ArcGIS Basemaps

      1. For Public Map Layers

      Step 1 - Obtaining the API Key

      To use ArcGIS Online base maps in Klir, you must first obtain an ArcGIS API Key from your ArcGIS Online Organization. This API key allows Klir to access the ArcGIS Online base maps and ensures that usage is tracked and controlled.

      Instructions to obtain the API Key:

      1. Log in to your ArcGIS Developer Dashboard.
      2. Navigate to API Keys and click New API Key.

      1. Provide a title and description (if necessary) for the API key and click Create API Key.

      1. After the key is generated, copy the API key.

      Step 2 - Share API Key with Klir CSM

      Once you have the API Key, provide it to your Klir CSM. The CSM will then paste it into the API Key field under Map Settings in Klir Administration.

      2. For Secure Map Layers

      Step 1 - Obtain ClientID and Client Secret

      If you are using secure map layers that require OAuth 2.0 authentication, you will need to register an OAuth application in your ArcGIS Online Developer Portal. This will provide you with a ClientID and Client Secret, which are required for Klir to access these secure layers.

      Instructions to Obtain ClientID and Client Secret:

      1. Register your application in the ArcGIS Online Developer Portal.
      2. Upon registration, you will receive a ClientID and Client Secret.
      3. Provide these credentials to your Klir CSM, who will store them securely in the Klir database.

      Step 2 - Configuring Basemap Style

      You can choose from a variety of basemap styles provided by ArcGIS Online. These styles can be accessed from the ArcGIS website.

      Instructions:

      1. Visit the ArcGIS Basemap Styles page.
      2. Select the desired basemap style (e.g., "arcgis-navigation", "arcgis-streets-night").
      3. Copy the URL of the chosen style and share it with your Klir CSM.

      If no specific style is selected, the default style will be "arcgis-navigation".

      Once your CSM has the style URL, they will:

      1. Enter the style into the Base Map textbox under Map Settings in Klir.

      1. Click Save All.

      1. Refresh the page, and the map will display the selected base map

      .

      Adding Map Layers

      Klir allows you to add both public and private map layers from ArcGIS Online or Enterprise into the Klir Maps. This functionality is configurable in the Map Settings and will apply to all maps across the platform.

      Instructions to Add a Map Layer:

      1. Obtain the Layer URL:

      1. Provide the Following Information:
        • Order: The layer’s position in the stack (0 is at the bottom, 1 is on top of 0, etc.).
        • Layer Name: The name of the map layer.
        • Layer URL: The ArcGIS REST API URL.
      2. Provide Information to Klir CSM:
        • Your Klir CSM will enter the Order, Layer Name, and Layer URL into the Map Settings page in Klir.
      3. Add the Layer:
        • The CSM will click Add to save the layer.
        • Repeat this process for each layer you wish to add.

      Once the layer has been added:

      • The layer will appear in the List of Layers section.
      • The layer can be edited or removed at any time using the Actions buttons.



      Viewing and Managing Layers in the Map

      Once your layers are configured, they will be displayed on the map. You can also manage their visibility through the Table of Contents (TOC) widget.

      • Layer Visibility: You can toggle the visibility of each layer on/off within the TOC.
      • Order of Layers: The order of layers is determined by the numeric values provided in the Order field.

      To refresh the map and confirm the layer changes:

      1. Go to the Map Settings page in Klir.
      2. Click the Save All button to apply any changes.
      3. Refresh the page to see the updated map with your selected base map and layers.

      Conclusion

      By following the above steps, you can effectively integrate and manage ArcGIS Maps within Klir, ensuring that you can configure base maps, add map layers, and control layer visibility to meet your organization’s GIS needs.

      If you need further assistance, please contact your Klir CSM for support with configuration and troubleshooting.