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.

For UI Kit 1, 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

Property	Type	Required	Description
`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_-]+$`
`resource`	`string`	If using Custom UI or modern versions of UI Kit	The key of a static `resources` entry that your module will display. See resources for more details.
`render`	`'native'`	If using modern versions of UI Kit	Indicates the module uses UI Kit.
`function`	`string`	Deprecated Required if using UI Kit 1	The key of a function module that returns a UI Kit 1 component.
`resolver`	`{ function: string }` or `{ endpoint: string }`		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.
`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.
`title`	`string` or `i18n object`	Yes	The title of the issue action, which is displayed as a menu item. The `i18n object` allows for translation. See i18n object.
`icon`	`string`	Yes	The URL of the icon that's displayed next to the title. A generic app icon is displayed if no icon is provided.
`unlicensedAccess`	List<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.

i18n object

Key	Type	Required	Description
`i18n`	`string`	Yes	A key referencing a translated string in the translation files. For more details, see Translations.

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.

Property	Type	Description
`type`	`string`	The type of the module.
`portal.id`	`number`	The id of the service desk where the module is rendered.
`request.key`	`string`	The key of the request where the module is rendered.
`request.typeId`	`number`	The id of the request type where the module is rendered.

UI Kit 1

Property	Type	Description
`type`	`string`	The type of the module.
`portal.id`	`number`	The id of the service desk where the module is rendered.
`request.key`	`string`	The key of the request where the module is rendered.
`request.typeId`	`number`	The id of the request type where the module is rendered.