Documentation

Blueprint

Blueprints allow your connect add on to provide content creation templates.

{
  "modules": {
    "blueprints": [
      {
        "template": {
          "url": "/blueprints/blueprint.xml",
          "blueprintContext": {
            "url": "/blueprints/context"
          }
        },
        "createResult": "edit",
        "icon": {
          "width": 48,
          "height": 48,
          "url": "/my-blueprint-icon.png"
        },
        "name": {
          "value": "Simple Remote Blueprint"
        },
        "key": "remote-blueprint"
      }
    ]
  }
}

Properties

key

Type
string
Required
Yes
Description

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:

{
    "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.

name

Required
Yes
Description

A human readable name.

template

Required
Yes
Description

Defines where the blueprint template is located and the context for variable substitution.
For more about how to define variables in blueprint template and template context please follow the example in Blueprint Template Context.

createResult

Type
string
Defaults to
edit
Allowed values
  • edit
  • EDIT
  • view
  • VIEW
  • Description

    Defines the screen to go to when creating this type of Blueprint. A value of view causes Confluence to bypass the editor page and automatically create the page content. The user lands in the view of the created page. When edit, the user is sent to the editor which is pre-filled with the template content.

    icon

    Type
    Description

    Defines an icon for this Blueprint, to be shown in the Create Content dialog.