Page tree

Space Blueprints

Last updated

Here's what you need to know about building Space Blueprints.

The first array in the .json file relates to space blueprints. Within each object, you define key/value pairs that help users generate a space from a template. In the image below, one object exists in the spaceBlueprints array.

The following table describes keys that you define in a spaceBlueprints object. If you prefer to omit space templates from your Blueprints wizard, leave the values for each key empty.

 KeyDescription

namea name for the Blueprint template; appears in the Blueprints wizard when a user clicks the Blueprints button

descriptiona description for the Blueprint template; appears in the Blueprints wizard when a user click the Blueprints button

blueprintSpaceKeythe space from which to copy content and settings into the new space

blueprintFieldsa list of fields to show in the Blueprints wizard; values in these fields can act as substitutions in subsequent fields

spaceNamea name for the new space; use substitution fields where appropriate

spaceKeya key for the new space; use substitution fields where appropriate

spaceCategoriesone or more words used to categorize the new space; added as space labels

spaceDescriptiona description for the new space; use substitution fields where appropriate

accessa permission scheme for the new space

Once you upload your .json definitions to Confluence, the Space Blueprints section in the Blueprint Definitions screen appears as such.

The following images show how the .json file maps to the Blueprints wizard.

First Screen

Second Screen

Third Screen

The Copy Current Space option will only be visible if the user has Space Administrator permission or Space Export permission.

Still need help?