Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

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.

You can use the UI kit or custom UI to create content for the Jira page.

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

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_-]+$

functionstringThe queue page module requires a function for use with the UI kit or a resource when building with custom UI.A reference to the function module that defines the queue page. This function must return the QueuePage component.
resourcestringA reference to the static resources entry that your queue page wants to display. See resources for more details.
render'native'Yes for UI Kit 2Indicates if the module is a UI Kit 2 module.
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 (preview) to integrate with a remote back end.

Can only be set if the module is using the resource property.

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

Custom UI

PropertyTypeDescription
typestringThe type of the module.
project:
  id
stringThe id of the project where the module is rendered.
project:
  key
stringThe key of the project where the module is rendered.

UI kit

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.

UI kit 2

This module now has support for UI Kit 2 (preview) for faster user experiences and to access additional React features.

For more information on all the supported modules, see the Supported products and their modules section.

Rate this page: