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

Jira Service Management portal request create property panel

The jiraServiceManagement:portalRequestCreatePropertyPanel module is displayed on the request creation screen in the customer portal and enables apps to save arbitrary data during request creation as Jira issue properties. For more information on Jira entity properties, see Jira entity properties.

This module can be used in Jira Service Management.

See the PortalRequestCreatePropertyPanel component documentation for more details.

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

Example of a Portal request create property panel

Portal Request Create Property Panel Lifecycle

The jiraServiceManagement:portalRequestCreatePropertyPanel uses Jira entity properties. The form data from the Forge portal request create property panel can be saved to the original request create form state using view.submit method of@forge/bridge library.

Form data schema

PropertyTypeRequiredDescription
fieldsList of field objectYesThis is a list of all the field objects present in the Forge portal request create property panel form.
isValidbooleanyesThe value will be true if all the fields in the Forge portal request create property panel form are valid and false otherwise.
unlicensedAccessList<string>A list of unlicensed user types that can access this function. Valid values for this module are: unlicensed, customer, and anonymous. For more information, see Access to Forge apps for unlicensed Jira Service Management users.

Field Object schema

PropertyTypeRequiredDescription
keystringYesThis is a unique identifier for the fields present in the Forge portal request create property panel form.
valueobjectyes The data stored corresponding to each field in the Forge portal request create property panel form.

The view.submit method can be invoked every time the fields in the Forge portal request create property panel form is updated. The field data would be store in the Jira issue property when the request form is submitted.

Once the portal request creation form is saved, the data stored using the jiraServiceManagement:portalRequestCreatePropertyPanel module can be retrieved from the extension context of jiraServiceManagement:portalRequestDetail.

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

resourcestringYesA 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 to integrate with a remote backend.

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.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module.
portal:
id
numberThe id of the service desk, 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:
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: