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

Jira Service Management portal request view action

The jiraServiceManagement:portalRequestViewAction module adds an option item to the request view action section that shows up request details page on Jira Service Management customer portal. When the menu item is clicked, the module’s function renders a modal dialog.

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.

See the PortalRequestViewAction component documentation for an example.

Unlicensed user access: This module supports interaction with customer accounts and unlicensed accounts. It does not support anonymous access. For information, see Access to Forge apps for unlicensed users.

When adding this to your app, use it as a top-level component.

Example of a Portal request view action button

This is an example of the triggered modal dialog:

Example of a Portal request view with the above sample code

Properties

PropertyTypeRequiredDescription
key

string

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

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

functionstringThe issue action module requires either a function for usage with the UI kit, or a resource when building with custom UI.A reference to the function module that defines the issue action. This function must return the PortalRequestViewAction component, which renders the modal dialog for its content.
resourcestringA reference to the static resources entry that your issue action 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.

viewportSize'small', 'medium', 'large' or 'xlarge'The display size of resource. Can only be set if the module is using the resource property. Remove this property to enable automatic resizing of the module.
titlestringYesThe title of the issue action, which is displayed as a menu item.
iconstringYesThe URL of the icon that's displayed next to the title. A generic app icon is displayed if no icon is provided.
unlicensedAccessList<string>A list of unlicensed user types that can access this function. Valid values for this module are: unlicensed and customer. This module does not support anonymous access. For more information, see

Access to Forge apps for unlicensed Jira Service Management users.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.
portal:
id
numberThe id of the service desk where the module is rendered.
request:
key
stringThe key of the request where the module is rendered.
request:
typeId
numberThe id of the request type where the module is rendered.

UI kit

PropertyTypeDescription
typestringThe type of the module.
portal:
id
numberThe id of the service desk where the module is rendered.
request:
key
stringThe key of the request where the module is rendered.
request:
typeId
numberThe id of the request type 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: