Configuration Page Opens as Full Screen in Jira Cloud Add-On

Jira Development Jira Cloud
,
1

Hello Atlassian Community,

I’m currently developing a Jira Cloud add-on and I’m facing an issue with the configuration page that is linked in the admin menu. Despite following the official documentation on Administration UI locations, when I click on the “Configuration” link under my add-on section, it opens as a full-screen page instead of being embedded in the admin interface.

Here are the relevant parts of my setup:
atlassian-connect.json:

"modules": {
  "webSections": [
    {
      "key": "addon-section",
      "location": "admin_plugins_menu",
      "name": {
        "value": "Addon Name"
      }
    }
  ],
  "webItems": [
    {
      "key": "addon-webitem-key",
      "location": "admin_plugins_menu/addon-section",
      "name": {
        "value": "Configuration"
      },
      "url": "/addon-config-url",
      "condition": {
        "condition": "user_is_admin"
      },
      "weight": 100
    }
  ]
}

html file:

<script src="https://connect-cdn.atl-paas.net/all.js"></script>
<div class="ac-content">
    <div id="addon-container">test</div>
</div>

thymleaft config:
@Controller
public class ScreensController {

@GetMapping(value = "/addon-config-url")
public String  addonConfigScreen(@RequestParam("lic") String licenseStatus) {
    if (licenseStatus.equalsIgnoreCase("active") || licenseStatus.equalsIgnoreCase("none")) {
        //Path to the html file
        return "addon-config-url/config-index";
    }
    return "path to the license";
}

}

What steps can I take to ensure that my configuration page opens within the Jira admin interface as an embedded iframe? Are there specific settings or configurations I might have missed?

Thank you for your help!

2

Hi @HadiAbouHamzeh,

We use “generalPages” instead of “webItems” to show a page in the admin section. I think you just have to change webItems to generalPages in the above code.

As a reference, this is our atlassian connect : https://cloud.ativo.io/atlassian-connect.json , you can see the various admin pages listed.

Notice in https://developer.atlassian.com/cloud/jira/platform/modules/page/ that the ‘location’ field defines how it is shown (as an admin page, or as a normal page).

2 Likes
3

Hello @edwin_ro it worked thank you so much for your help and for the shared references.
Have a great day/evening

1 Like