URL Mapping Configuration
- Damian Wileński
- Aleksandra Pykacz (Unlicensed)
The application contains a feature that supports external links to Atlassian platforms. The most common and basic example is Confluence. The platform itself handles references between both products when you try to link a page from Confluence to a selected Jira issue. Unfortunately, this is not that easy on a separate application that does not have access to explicit resources from Jira.
For this purpose, we have decided to provide a distinct configuration that enables the user to provide links and the URL for a specific platform. This feature is not limited to only Confluence; for now, it was only tested with Confluence.
To enter the configuration, you have to move in the following way:
(1) Apps → (2) Manage your apps → (3) Find “Links From Comments” in your Apps section
The configuration view consists of three major elements. The first element (1) is a table that views all currently configured mappings. The second element (2) is the 'Create Mapping' button, which opens the form to create a new mapping. And the third element is an action cell that is allocated to each mapping row. It is possible to edit (3) and delete (4) each mapping.
The first and only form that we are interested in is a creation mapping form, which is built on top of dialog. Each mapping consists of the following data:
Property Name | Explanation | Example |
|---|---|---|
Application Link ID | Represents the application link ID of platform connected with our Jira. To list all the application links, you have to use the Rest API or some tricks with extraction of the ID from Jira internal UI. To simplify this process, we have placed a special link under the application link ID input (selected with pink in image below):
Please be advised that the endpoint returns JSON. Use browsers built-in formatter feature to get the best performance. Other than the application link ID, you can also extract other important data used in the mapping creation form. | 77ccfba2-5157-452c-b9b4-a87f51eeefdd |
Base URL | This property is as important as the application link ID. The value of that field should be a prefix of each URL to the given platform that will be linked. | https://<your-atlassian-sub-domain>.atlassian.net/wiki (this example represents a Confluence URL prefix) |
Application Name | Field that identifies the platform for which mapping is configured. | System Confluence |
Application Type | Field that identifies the platform type. Atlassian often provides different types of platforms with special identifiers. | com.atlassian.confluence |
Is Link Active | This field is a placeholder for features that will appear in the future. | True/False (checkbox) |
It is important to note that both the application name and the application type are optional. But we hardly suggest that you fill these fields when creating config for any of the platforms provided by Atlassian. The reason for such a situation is that not all linked applications have to have both fields, but both fields are used in for example Confluence linking. Without them, the provided links will not be regarded as Confluence links, but rather as normal remote links.
The following image represents the mapping creation form:
After successfully adding the mapping, the new mapping should appear in the main configuration screen's table. If there will be any issue with the provided data, the application should indicate which fields are invalid.
The same form is used in the edit URL mapping action. All fields should behave as in create URL mapping dialog.