How to associate web items with a web section?

Per the Web Section docs:

To insert the links themselves, see the Web Item Module.

However, simply setting the location of the web item to the key of the web section does not work, as far as I can tell.

Example atlassian-connect.json:

{
    "key": "my-cool-addon",
    // etc etc
    "modules": {
      "webSections": [
        {
          "location": "atl.jira.view.issue.right.context",
          "weight": 1,
          "name": {
            "value": "My Web Section"
          },
          "key": "my-web-section"
        }
      ],
      "webItems": [
        {
          "key": "my-web-item",
          "location": "my-web-section",
          "name": {
            "value": "My Web Item"
          },
          "target": {
            "type": "dialogmodule",
            "options": {
              "key": "my-dialog"
            }
          }
        }
      ]
      
  }
}

hi @mitch,

The location “atl.jira.view.issue.right.context” isn’t actually a location for a web section, it’s a location for a web panel. See this page: https://developer.atlassian.com/cloud/jira/platform/issue-view-ui-locations/ and that’s the reason why your code isn’t working.

But I did notice that the example on the web section page is wrong. I’ll get that fixed.

The best way to find all UI extension points is installing the Web Fragment Finder app from Wittified, this will help you figure out where you can add web sections (in menus) and web items.

Cheers,
Peter

hi @pvandevoorde

I have the Web Fragment Finder.

I have visited the issue view UI locations.

Can you give me a list of the locations that are compatible with web sections? Because that specific information is neither in the link of the link nor in the Web Fragment Finder.

For instance, next I tried “jira.issue.tools” location, still not appearing.

@pvandevoorde Any updates on this, or where to find the locations specific to Web Sections?

Hi Mitch,

The Jira developer documentation for different pages describes locations that support web sections:

Regards,
Dave

Hi @dmeyer Thanks for your quick reply.

I am building something in the issue view, so we will focus on that one.

I followed the relevant link you mentioned, here’s what I found:

For web items:
jira.issue.tools: Add a button in the issue actions area
Ellipsis menu locations:
operations-top-level
operations-work
operations-attachments
operations-attachments
operations-voteswatchers
operations-subtasks
operations-operations
operations-delete
<snip>
For web panels:
atl.jira.view.issue.left.context
atl.jira.view.issue.right.context

Where can I find issue view locations specific to Web Sections?

Hi @mitch,

There are no supported locations on the Issue View page for web sections. You can add multiple web items to any of the locations listed for the ... menu, or you can add a button by declaring a web item with the location jira.issue.tools, or you can add a panel in either of the locations described.

I had a small issue with the Web Fragment Finder so it was showing the web-sections - that’s been fixed now. I should point out that the web-sections that are shown (just like anything else for Jira Cloud) are the locations identified in Server so they could be removed later by Atlassian.

(Just saw @dmeyer’s response - so what he said as well).