Creating a Space Blueprint
How to create a blueprint at the space level.
Create a set of pages (space) that will become a space blueprint
MORE DETAIL HERE
Navigate to the Blueprint Definitions Page and download the JSON File
See Accessing and Editing the JSON File for instructions on how to download the file.
Define the blueprint in the spaceBlueprints object in the json file
- Name (A human-readable name)
- Description (Appears below the blueprint name in the Blueprint Menu)
- blueprintSpace Key (The key of the space where the space blueprint pages reside)
- blueprintFields (List of the substitution fields used in the blueprint)
- Both built-in and custom fields
- Not required, but useful
- Sets the order the fields will appear in the Wizard
- Both built-in and custom fields
- spaceName (A name for the new space)
- spaceKey (A key for the new space)
- spaceCategories (One or more words to categorize the space)
- Will be added as space labels
- spaceDescription (A description of the space)
- access (a permission scheme for the new space)
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 to 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 space blueprint)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 space from this blueprint.
- Enter values for each of the substitution fields
- Click next
- Verify where you want this page created
- Click Create