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

Rate this page:

Compass admin page

The compass:adminPage module adds a configuration page that is accessible by navigating to Apps, then clicking Configure for the app. Content is then rendered on a new Compass page that is accessible to Compass administrators only. You can use the UI kit or custom UI to create content for the page.

Example of an admin page app

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 admin page 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 admin page.
resourcestringA reference to the static resources entry that your admin page 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.
titlestringYesThe title of the admin page, which is displayed at the top of the page.
iconstring

The icon displayed next to the title.


For custom UI and UI kit apps, the icon property accepts a relative path from a declared resource. Alternatively, you can also use an absolute URL to a self-hosted icon. See Icons for more information.

If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed.

Extension context

Custom UI

PropertyTypeDescription
typestringThe type of the module (compass:adminPage)
urlstringThe URL of the admin page.

UI kit

PropertyTypeDescription
typestringThe type of the module (compass:adminPage)
urlstringThe URL of the admin page.

Rate this page: