Space Blueprints

Introduction to Space Blueprints

The Space Blueprints API (introduced in 5.3) is an extension of the existing Blueprints API (introduced in 5.1). Its main purpose is to help users bootstrap the space creation process. As a plugin developer, you can now hook into the Create Space dialog to add your own space blueprint. You can optionally do the following:

  • have a wizard to get user input for the new space
  • have a custom default home page for your space type
  • have a one or more templates with a predefined page hierarchy
  • promote page Blueprints for your space (show a set of Blueprints in the Create dialog as the default)
  • categorize your Space Blueprints

And lots more! It is really up to your imagination! For example the Team Space Blueprint provides a wizard to define 'team members' for a space and automatically adds the team members as space watchers and gives them explicit space permissions. 

If you haven't already, please read about the blueprint concepts. For a basic tutorial, start by writing a simple Confluence Space Blueprint. 

Example source

If you want to see some example code, the Hello Blueprint now contains a space blueprint. The source code is available on Atlassian Bitbucket: https://bitbucket.org/atlassian/hello-blueprint. To clone the repository, issue the following command:

git clone https://bitbucket.org/atlassian/hello-blueprint.git

Plugin module types used in space blueprints

Space Blueprints are built with the following plugin module types:

Module
Purpose

web-item

Add your Space Blueprint to the Create Space dialog.

You must specify a section of system.create.space.dialog/content and have a param element with name "blueprintKey" specified, where value is the space blueprint module key.

The icon resource should be 200 x 150 pixel PNG icon resource representing the blueprint icon.

space-blueprint

Defines the space blueprint

content-template

Describes the default home page and content for the space

promoted-blueprints Allows you promote blueprints for a space
dialog-wizard Define a dialog wizard for users to input data during space creation
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport