Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
namePage Info
id278129461
classwatermark-layer
Content Column
namePage Body
width100.00001%
id278129463
Content Block
background-colortransparent
namePrompt
id494677873
classtight manual-prompt-flex

How to create a blueprint at the space level.

Content Block
nameOutcome
rich-link-hoverstrue
id1042866408
classtight manual-outcome-flex

HTML Wrap
classcallout

Prerequisites

The value and power of space blueprints comes from the ability to ask the user to populate a given substitution field, and then populating that field throughout the pages of the blueprinted space

Requirements / Permissions

Before you begin building your space blueprint, you'

l

ll want to: 

familiarize yourself with the .json files

of

consider

  • Consider the substitution fields you'll want to employ

consider

  • Consider what pages will exist in the space

  • make sure Brikit Blueprint Maker is installed and enabled
  • confirm that you have administrative permissions 

    Content Block
    nameSteps
    rich-link-hoverstrue
    id494842117
    classsteps-block numbered manual-steps-flex

    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. 

    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.

    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:

      1. Name (A human-readable name)
      2. Description (Appears below the space
    • set of page that will become a space blueprintDefine the blueprint in the spaceBlueprints object in the json file
    • Name
    • DescriptionAppears below the
      1. blueprint name in the Blueprint Menu)
      2. blueprintSpace Key
    • :
      1. (The key of the space where the space blueprint
    • pages
      1. resides)
    • Blueprint Fields:
      1. blueprintFields (List of the substitution fields used in the blueprint
    • Both built-in and custom fields
    • Not required, but useful
    • Sets
      1. , also sets the order the fields will appear in the
    • WizardspaceName:
      1. creation process)
      2. spaceName  (A name for the new space)
      3. spaceKey
    • :
      1. (A key for the new space)
      2. spaceCategories
    • :
      1. (One or more words used to categorize the space
    • Will
      1. , will be added as space labels)
      2. spaceDescription
    • :
      1. (A description of the space)
      2. access
    • : a
      1. (a permission scheme for the new space
    • Define each substitution field in the blueprintFields object in the json file
    • ID: A unique ID for the field

    • Name:
      1. )

    Info

    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:

      1. ID (The unique ID for the field–that is, what is between the [[ ]] brackets in your page blueprints)

      2. Name (A human-readable name for the field)

      3. Required

    :
      1. (A toggle for whether the field is required)

      2. Type

    :
      1. (Defines the display length of the field)

      2. Help Text

    :
      1. (Additional text to assist the user in filling out the field

    Appears
      1. - appears below the data-entry field in the

    blueprint wizard
      1. creation process)

      2. Placeholder

    : Default text in the field
      1. (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

    1. Click the 'Blueprints' button in the Confluence Header (not the 'Create' button). 
    2. Select the space blueprint you created
    3. 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.
    4. Enter values for each of the substitution fields
    5. Click Create
    Content Block
    nameNote
    rich-link-hoverstrue
    id495965127
    classmanual-note-flex
    collapsiblecollapse
    Note

    If using:

    1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
    2. Add the tight-bottom class to the Steps block above to narrow the gap between the two blocks.
    Content Block
    nameTip
    rich-link-hoverstrue
    id894522670
    classmanual-tip-flex
    collapsiblecollapse
    Tip

    If using:

    1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
    2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
    Content Block
    nameWarning
    rich-link-hoverstrue
    id894530759
    classmanual-warning-flex
    collapsiblecollapse
    Warning

    If using:

    1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
    2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
    Content Block
    nameInfo
    rich-link-hoverstrue
    id894537203
    classmanual-info-flex
    collapsiblecollapse
    Info

    If using:

    1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
    2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
    Content Layer
    background-color$lightGrayColor
    nameRelated
    id888168050
    Content Column
    nameRelated
    width100%
    id888168051
    Content Block
    rich-links-hide-descriptiontrue
    rich-link-hoverstrue
    rich-links-columns4
    rich-links-verticaltrue
    rich-links-image-height100px
    rich-links-hide-site-icontrue
    rich-links-details-padding10px
    nameRelated
    rich-links-enabletrue
    border-width0
    rich-links-details-alignmentleft
    rich-links-margin20px 30px 0 0
    id496234544
    classrelated-block clean manual-related-flex