Rate this page:
The jiraServiceManagement:assetsImportType
module displays a modal that allows users to configure their Forge-based imports with information such as login details or configuration information for their app.
The modal appears when a user selects an object schema within Assets, then selects Schema configuration
, then selects Import
, then selects their import type, then selects Configure App
in the dropdown.
The module also contains functions for optional use - onDeleteImport, startImport, stopImport, importStatus.
The content of the module is rendered below the text Configure {Import Structure Name}
and above the Save Configuration
and Cancel
buttons.
This module can be used in Jira Service Management.
See the AssetsImportType component documentation for more details.
Unlicensed user access: This module does not support interaction with anonymous users, customer accounts, or unlicensed accounts.
Property | Type | Required | Description |
---|---|---|---|
key |
| Yes |
A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: |
function | string | A reference to the function rendering the UI.
Regex: | |
description | string | A description of the Assets Import Type that displays under it.
Regex: | |
title | string | Yes | The name of an Assets Import Type, which is displayed on each of the import structure cards.
They live on the Imports tab of each Object Schema in Assets .
|
icon | string | Yes |
The icon displayed next to the For custom UI and UI kit apps, the If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed. |
onDeleteImport | { function: string } | Contains a function property, which is executed on deletion of an Assets Import Type.
Regex: | |
startImport | { function: string } | Yes | Contains a function property, which is executed when an import of this Assets Import Type is started.
Regex: |
stopImport | { function: string } | Yes | Contains a function property, which is executed when an import of this Assets Import Type is cancelled.
Regex: |
importStatus | { function: string } | Yes | Contains a function property, which is executed when Imports UI is loaded to display the status of the import.
There are two status enums that can be returned currently, Regex: |
Property | Type | Description |
---|---|---|
type | string | The type of the module. |
importId | string | The id of the Assets Import Type. |
workspaceId | string | The id of the Assets workspace. |
Rate this page: