Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules
Rovo modules (Preview)

Jira Service Management queue page

The jiraServiceManagement:queuePage module adds an item in the Apps section. You can find the Apps section in the left navigation of Queues in a service project. When the item is clicked, content is rendered on a new Jira page.

This module can be used in Jira Service Management.

The page URL is constructed in the following format: /jira/servicedesk/projects/{projectKey}/queues/apps/{appId}/{envId}

For UI Kit 1, see the QueuePage component documentation for an example. When adding this to your app, use it as a top-level component.

Unlicensed user access: This module does not support interaction with anonymous users, customer accounts, or unlicensed accounts.

Example of a queue page

Properties

PropertyTypeRequiredDescription
key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringRequired if using UI Kit 1 or triggers.A reference to the function module that defines the module.
resourcestringRequired if using custom UI or the latest version of UI Kit.A reference to the static resources entry that your context menu app wants to display. See resources for more details.
render'native'Yes for UI Kit.Indicates the module uses UI Kit.
resolver{ function: string } or
{ endpoint: string }
Yes

Set the function property if you are using a hosted function module for your resolver.

Set the endpoint property if you are using Forge remote to integrate with a remote back end.

titlestringYesThe title of the project page, which is displayed at the top of the page. The title also appears as an item in the `Apps` section. You can find the `Apps` section in the left navigation of `Queues` in a service project.
iconstring

The icon displayed next to the title.


For custom UI and UI Kit apps, the icon property accepts a relative path from a declared resource. Alternatively, you can also use an absolute URL to a self-hosted icon. See Icons for more information.

If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed.

layout UI Kit:
  • native
  • basic
Custom UI:
  • native
  • blank
  • basic (deprecated)
(default: native)
The layout of the service management queue page that defines whether a page is rendered with default controls (native), lays out the entire viewport with a margin on the left and breadcrumbs (basic for UI Kit), or is left blank allowing for full customization (blank for custom UI).

Extension context

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method in custom UI.

PropertyTypeDescription
typestringThe type of the module.
project.idstringThe id of the project where the module is rendered.
project.keystringThe key of the project where the module is rendered.

UI Kit 1

PropertyTypeDescription
typestringThe type of the module.
projectIdstringThe id of the project where the module is rendered.
projectKeystringThe key of the project where the module is rendered.

Rate this page: