Creating a Space Blueprint
How to create a blueprint at the space level.
Create a space and then its page blueprints
Similar to page blueprints, space blueprints are templates from which copies are made. So the process for creating a space blueprint is rather like that of creating a page blueprint for however many pages you want in your space. It is convenient to have these pages packaged as a space blueprint because often a space needs to be able to be replicated in a standardized way.
For example, on a company intranet, every department may need its own space, and yet every department shares at least some standardized (archetypical) pages, such as a home page, a team-member page, a mission statement page, and schedule or calendar page. With a space blueprint, you can bundle four page blueprints together so that when a new team space is created all four of these pages are created as part of the new space.
Simply put: think about your need for a space blueprint, what pages are needed, and then create each page inside this space. To tap the full power and value of using blueprints, you can use substitution fields in the pages in your space blueprint.
See Accessing and Editing the JSON File for instructions on how to download the file.
In the JSON File, create a spaceBlueprint object
The spaceBlueprint object defines some properties used to help guide users when creating a space from this blueprint.
These properties include:
- Name (A human-readable name)
- Description (Appears below the space blueprint name in the Blueprint Menu)
- blueprintSpace Key (The key of the space where the space blueprint resides)
- blueprintFields (List of the substitution fields used in the blueprint, also sets the order the fields will appear in the creation process)
- spaceName (A name for the new space)
- spaceKey (A key for the new space)
- spaceCategories (One or more words used to categorize the space, will be added as space labels)
- spaceDescription (A description of the space)
- access (a permission scheme for the new space)
What's especially convenient about Space Blueprints is that you do not need to define each individual page in the space as a pageBlueprint in the JSON file. The spaceBlueprint object ensures that during the create space from blueprint process each page from the space blueprint, including page trees, will be automatically created and rendered with the substitution field values.
In the JSON file, add and define your substitution fields
In the same JSON file, you must define each of the substitution fields; again with helpful information for the users creating a space from this blueprint.
For each substitution field, you must define the:
ID (The unique ID for the field–that is, what is between the
[[ ]] brackets in your page blueprints)
Name (A human-readable name for the field)
Required (A toggle for whether the field is required)
Type (Defines the display length of the field)
Help Text (Additional text to assist the user in filling out the field - appears below the data-entry field in the creation process)
Placeholder (Default text inside the field)
Save and upload the JSON File
See again Accessing and Editing the JSON File for how to upload the file.
Create a space from this Blueprint
- Click the 'Blueprints' button in the Confluence Header (not the 'Create' button).
- Select the space blueprint you created
- You are now in the "Wizard" which walks you through entering the substitution fields (if there are any) and the creation of the pages from this blueprint.
- Enter values for each of the substitution fields
- Click Create