Display conditions
Modules

Rate this page:

Jira Service Management portal subheader

The jiraServiceManagement:portalSubheader module adds a panel rendered underneath the title of customer portal pages.

This module can be used in Jira Service Management.

You can use the UI kit or custom UI to create content for the Jira Service Management page. When using the UI kit in the app, use the PortalSubheader component as a top-level component.

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 portal subheader 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 PortalSubheader component.
resourcestringA reference to the static resources entry that your customer portal subheader wants to display. See resources for more details.
resolver{ function: string }Contains a function property, which references the function module that defines the configuration of resource. Can only be set if the module is using the resource property.
viewportSize'xsmall','small', 'medium', 'large' or 'xlarge'The display size of resource. Remove this property to enable automatic resizing of the module.
pageshelp_center,portal, create_request, view_request, approvals,profile or my_requestsRestrict the module to only be visible in specified customer portal pages.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.
pagestringThe location of the page where the module is rendered. Values include help_center,portal, create_request, view_request, approvals,profile and my_requests.
portal:
id
numberThe id of the service desk, depending on the page where its rendered.
request:
typeId
numberThe id of the request type, depending on the page where its rendered.
request:
key
stringThe key of the request, depending on the page where it is rendered.

UI kit

PropertyTypeDescription
typestringThe type of the module.
pagenumberThe location of the page where the module is rendered. Values include help_center,portal, create_request, view_request, approvals,profile and my_requests.
portalIdnumberThe id of the service desk, depending on the page where it is rendered.
requestTypeIdnumberThe id of the request type, depending on the page where it is rendered.
requestKeystringThe key of the request, depending on the page where it is rendered.

Rate this page: