Page

A key to identify this module.

This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.

Keys must only contain alphanumeric characters and dashes.

The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:

1
2
3
4
5
6
7
8
9

{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

A human readable name.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
4

{
  "value": "My text"
}

The url to retrieve the content from. This must be relative to the add-on's baseUrl.

Returns whether the URL should be cacheable. Cacheable URLs are taken directly from the add-on descriptor, and lack all additional query parameters:

• standard iframe query parameters
• product context parameters
• JWT token

Conditions can be added to display only when all the given conditions are true.

The supported conditions for pages are:

Common conditions

• addon_property_exists
• addon_property_equal_to
• addon_property_equal_to_context
• addon_property_contains_any
• addon_property_contains_all
• addon_property_contains_context
• addon_property_contains_any_user_group
• user_is_admin
• user_is_logged_in
• user_is_sysadmin
• addon_is_licensed
• feature_flag

Jira conditions

• entity_property_exists
• entity_property_equal_to
• entity_property_equal_to_context
• entity_property_contains_any
• entity_property_contains_all
• entity_property_contains_context
• entity_property_contains_any_user_group
• can_use_application
• project_type
• has_global_permission

Confluence conditions

• content_property_exists
• content_property_equal_to
• content_property_equal_to_context
• content_property_contains_any
• content_property_contains_all
• content_property_contains_context
• content_property_contains_any_user_group
• space_property_exists
• space_property_equal_to
• space_property_equal_to_context
• space_property_contains_any
• space_property_contains_all
• space_property_contains_context
• space_property_contains_any_user_group

An optional icon to display with the link text or as the link, specified by URL to its hosted location. You can specify a particular width and height for the icon. Most link icons in Atlassian applications are 16 by 16 pixels.

Defines an icon to display.

Example

1
2
3
4
5
6
7
8

{
  "icon": {
    "width": 16,
    "height": 16,
    "url": "/my-icon.png"
  }
}

The location in the application interface where the page's link should appear. For the Atlassian application interface, a location is something like the coordinates on a map. It points to a particular drop-down menu or navigation list in the UI.

Places in the Atlassian UI are identified by what are known as "well-known locations." For example, the "system.admin/globalsettings" location is in the administrative menu link on the left side of the Administration Console.

Find product locations with the Extension Point Finder:

• Jira Locations
• Confluence locations

You can also find all Confluence locations on this page.

If the location property is not specified, a default location is used:

Jira:

• generalPage: system.top.navigation.bar
• adminPage: advanced_menu_section/advanced_section

Confluence:

• generalPage: system.help/pages
• adminPage: system.admin/marketplace_confluence

You may wish to have no link to the page shown anywhere - for example, if you are using the page as the target of a JavaScript API dialog. In this case, set the value of location to "none".

This object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.

Example

1
2
3
4
5
6
7

{
  "params": {
    "someOtherProperty": "someValue",
    "myCustomProperty": "myValue"
  }
}

Determines the order in which the page's link appears in the menu or list.

The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.

Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.