Creating a Space Blueprint
How to create a blueprint at the space level.
The value and power of 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. Therefore, before you begin building your space blueprint, you'll want to consider the substitution fields you'll want to employ and what pages will exist in your space.
Once you're familiar with the .json file, substitution fields, and the basics of blueprints, you can begin creating a space blueprint.
You will need to have the Brikit Blueprint Maker app installed and have administrative permissions in order to create a blueprint.
- Create a set of page that will become a space blueprint
- Define the blueprint in the spaceBlueprints object in the json file
- Name
- Description
- Appears below the blueprint name in the Blueprint Menu
- blueprintSpace Key: The key of the space where the space blueprint pages resides
- Blueprint Fields: 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
- 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
- Define each substitution field in the blueprintFields object in the json file
ID: A unique ID for the field
Name: A human-readable name
Required: A toggle for whether the field is required
Type: Defines the 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 blueprint wizard
Placeholder: Default text in the field