Configuration

There are a few required configuration steps that you will need to complete before you can start using GeoData.

Some of the following instructions require site administrator privileges.

Accessing the app configuration

GeoData configuration can be accessed by clicking the Apps button in Jira’s top navigation bar and selecting the Manage your apps option in the dropdown. You should be able to see the GeoData Admin Page in the left sidebar of the Manage your apps screen.

Permissions

This section allows you to configure members of which Jira groups will be able to access the GeoData Map board.

Select the group that you wish to add using the dropdown menu and confirm your selection by clicking the Add button.

To remove a group, click the recycling bin button next to it.

 

image-20240227-172642.png

Geocoding

To find location coordinates by their address (geocoding) and vice-versa (reverse geocoding), GeoData uses Nominatim. The Geocoding section allows you to configure the server that GeoData will use for searches and a few search parameters.

Nominatim server URL is the address of the server. It can be any server that exposes an identical API.

The search result limit controls the maximum number of results returned by the address search.

Language determines the localization of the returned results. The value of this field should be an IETF language tag—some common examples of such language tags can be found here.

On first installation, GeoData will add configuration for OpenStreetMap Nominatim, a free, limited-use geocoding service, for testing purposes. When using this service, warnings about it will be displayed throughout the app. The warnings can be dismissed (dismissal gets saved locally per client). To get rid of them globally, you may configure a custom geocoding service, or edit and re-save the predefined one—this will clear the trial flag on the service configuration, although the limitations will still apply.

Make sure to read and follow the usage policy of your chosen geocoding server!

 

image-20240227-172730.png

Map layers

In this section, you can add one or more servers that will provide map tiles to GeoData.

Clicking the Add a tile server button will open the form which will allow you to define a new tile server. The tile servers you add will be listed in a table below.

The tile server form contains the following fields:

Name is the name of the tile server that will be used by GeoData.

Server URL is the URL of the tile server. It must contain placeholders for zoom level {z}, x {x} and y {y} coordinates and it can optionally contain a placeholder for a subdomain {s}.

Max. zoom controls the maximum zoom level of the tile server. Use this option if your tile server doesn’t provide tiles for high zoom levels.

Description is used to give additional information about the tile server.

Attribution is used to show data attribution information on the map, as required by some tile providers. Please refer to your chosen tile provider’s policies to correctly fill this field.

A saved tile server can be edited by clicking the pencil button or deleted by clicking the recycling bin button. Tile servers can be reordered by clicking and dragging their handle ( ⁝⁝ ).

Predefined layers

The Predefined layers table contains a few free example tile server configurations, which can easily be added to your tile servers by clicking the Add tile server button. When using these tile servers, please read and follow their respective usage policies.

API information

This screen contains information necessary to pair GeoData for Jira Cloud with its GeoData for JSM Cloud companion app.

API URL contains the URL which you will need to enter in the companion app’s configuration screen. Clicking the button will copy the address to your clipboard.

Paired GeoData for JSM Cloud API URL is a read-only field that will get automatically filled after successful pairing with the companion app. For more information about app pairing, please refer to this page: GeoData for JSM Cloud