Super Map Custom Layers – QBeeQ

The Super Map comes standard with 10 map layers covering the world, the US, and Canada, with varying levels of granularity (ZIP, Census, CBSA, etc.).

This guide is intended for Sisense Admins and provides instructions for the setup and configuration of adding custom layers to the Super Map for a Dashboard Designer to use when using the Super Map.

Before you start

Planning your layers

There is no limit on the number of custom layers that can be added; however, please keep both your Designers and Viewers in mind when adding more layers, which can affect user experience and performance. It is recommended to review the layers regularly and remove those that are not needed.

💡

To achieve this easily, when layers are no longer needed, the files can stay in the folder, and the object can be commented out in the config.js to be used for later if/when needed.

Compilation

The Super Map add-on will need to compile twice during this process. Once when a GeoJSON file is added to the plugin folder, and another when the config.js file is saved.

💡

It is recommended to open a separate window or tab and navigate to Server & Hardware > Add-ons.

If the Add-ons page is open, the compilations will happen automatically when the above actions and changes are made.

GeoJSON file format

The Super Map only accepts files formatted using the GeoJSON structure. You can use the file provided below as a reference for the correct formatting.

Configuring custom map layers

Add GeoJSON file(s) to the plugin folder

Navigate to Admin > App Configuration > File Management

Navigate to Plugins > QBeeQGeojsonMap > KML views

Drag or upload your GeoJSON file(s) into the folder

Update config.js to include the new layer

Navigate to Plugins > QBeeQGeojsonMap > js

Locate and open the config.js file

Scroll down to the bottom of the file

Copy and paste the template object as a new entry, removing the comment slashes (//)

Update the property values of the new object

Save the file

        {
            "key": "Custom Geojson",   //this needs to be set to "Custom geojson" always when adding a custom layer
            "display_name":"US States custom", // This name will be reflected in the under the dropdown options in design panel.we can update this property if we want to change the display name.
            "fileLink": `${prism.proxyurl}/plugins/QBeeQGeojsonMap/KML views/US_states.geojson`,
            "keyId": "name", // Here keyId represents the key that is present in the properties object of geojson features object of respective file.
            "vectorTileId": "", //This must be kept empty
            "sourceLayer": "", //This must be kept empty
            "objectId": "US States custom", // do not change once set. Also do not write any text with parenthesis. for example use "US custom" instead of "US(custom)".
        },

🛑

The key value must be Custom geojson when adding a custom layer

The vectorTileId and sourceLayer must be left empty

Do not include parentheses in the objectId value

Do not change the objectId value once set

Verify the new layer is displaying in the design panel

Confirm that the add-on compilation process is complete

Navigate to a dashboard and either create or edit a Super Map widget

Expand the the Map Appearance section and open the Geoid identification dropdown

Custom layers should appear at the bottom of the list, underneath the divider.