After successfully adding the GeoData app to Jira, there are a few essential setup steps that need to be completed to enable the full functionality of our product. We kindly ask you to carefully follow each step on this page to ensure the full functionality of the app’s features.

GeoData Location custom field configuration

The first thing you need to do before you start using GeoData app is to create a GeoData Location custom field. In order to create GeoData Location custom field, click the Administration button in the top right corner. Then select Issues.

Open

Next, locate the Custom fields button in the left panel. Look for and click on the Add custom field button on the right side of the page.

Open

This will open a new modal window where you will be able to search for and add a GeoData Location custom field. Make sure you select All in the left panel and type GeoData into the search field. This should show you the correct custom field.

If there are more than one results, simply select GeoData Location custom field and press Next.

Fill in a Name and a Description (optional) for the new custom field and click Next.

On the next screen you have the option to select issue types and projects for which this custom field will be available.

By default, it is set for all issue types.

You have to select at least one project from the select field. After you select desired projects, you can finish this configuration by clicking on the Create button in the lower right corner.

On the next screen, make sure you assign the correct screens to the newly added custom field as shown in the image below.

There are more optional settings in the Custom field → Configuration page.

Configuration

On this page, you may adjust the context in which the Custom field will be active. For example, you can choose to show the field only for specific projects or issue types.

Default location

On the Custom fields administration screen, you have the option to specify a default location that will be automatically populated whenever you create a new issue. This setting can be useful if you know that the majority of issues will be using a specific location. The address selection process is the same as in the rest of the app, more details can be found here.

GeoData Route custom field configuration

Configuring the Route custom field with GeoData is a straightforward process, ensuring a simple setup for users.

Upon the installation of the GeoData application, the Route custom field is automatically created. To start using this field, the only essential configuration is to associate it with the appropriate screens in your desired projects. This can be easily accomplished from the Custom fields page as shown in the following images.

Firstly, navigate to the Custom fields page in Jira administration.

Next, locate the Custom fields button in the left panel.

Locate the Route custom field and from the dots menu choose Screens.

For the Route custom field, there are only two necessary options — Create Issue Screen and Edit/View Issue Screen.

Please make sure, if you have multiple projects, to choose shown screens for the right project(s).

GeoData Route issue type configuration

Before you can start using Route planner, it is essential to add Route issue type to an existing project. As the Route issue type is automatically created when installing the GeoData plugin, the only settings you need to change is inside the project settings. Navigate to the desired project and select Project settings from the left panel.

Then navigate to Issue types and from the Actions selector navigate to Edit issue types.

On the Modify issue type scheme page, locate the Route issue type in the Available issue types panel and drag it over to Issue Types for Current Scheme panel.

Click Save and you should be ready to start using the GeoData Route planner.

GeoData administration — Nominatim server

Another configuration step you need to complete is to select a Nominatim server. This can only be done by a Jira administrator and is necessary to enable the geocoding and reverse geocoding features of the app.

You can do this on the app administration page, which is accessible through the link in the top bar. On the administration page, you will need to provide a Nominatim Server URL and specify a Search results limit.

An example of an open-source Nominatim API is https://nominatim.openstreetmap.org/.

Notice: Prior to utilizing this open-source alternative, we strongly recommend that you thoroughly read and adhere to their Usage policy.

GeoData administration — Map layers

This screen allows you to configure a list of tile servers for use on the GeoData map board. If no tile servers are set up, the map board will only display a low-resolution placeholder map image.

In release 4.2.0 we updated Map layers administration screen. We added a few pre-defined providers of map layers and an option to Activate / Deactivate individual map layers.

Before using pre-defined map layers, be sure to read the usage policy for any map layers you are going to use.

All provided map layers are Disabled by default. To enable or edit them, you need to click on the Edit button in the corresponding row.

You can also change the order of map layers by click & drag on button on the left side of each row. This order is reflected to map layer selection on all maps provided by our application.

To add a tile server, fill in the form, (required columns are marked with an asterisk) and click the Add button. You can also edit existing tile server configurations by clicking the Edit button in their row, or delete them by clicking Delete.

The configuration fields are explained below.

Name

This is the name that will be displayed in the Layer selection widget on the map board.

Description

You can use this field to provide information about the tile server.

Attribution

Some tile servers may require the map tile data to be attributed to them under certain circumstances. Please check the License policy of the server which you wish to use for more specific information.

URL

This is the URL of the tile server. It must contain "{z}", "{x}" and "{y}" substrings, which act as placeholders for coordinate data.

Max. zoom

Some servers may not provide map tiles for all zoom levels. This field allows you to limit the maximum zoom level.

You can see all added layers in table, where you have options to Edit and Delete individual layers. The Delete button is only available for layers which are not active.

GeoData administration — Permissions

On this screen, you can manage which Jira groups are allowed to view the map board. This setting can only be changed by a Jira administrator.