Skip to main content

Parameters

Unleashing Dynamic Drawings: Adaptable drawings using parameters and overrides

Introduction

This article covers how to use parameters in Live Plans. Parameters let you pass information from your model directly into your documents, so that values like plan names, dimensions, and room data populate automatically rather than being entered by hand.

Once set up, parameters can be used across Drawing Templates, Data Tables, and View Templates, keeping information consistent without having to update each drawing separately.

What are Parameters?

Parameters are variables used within Live Plans that allow you to create dynamic documentation. They are used both in Live Plans conditional statements and as dynamic variables to populate information throughout Live Plans text annotations. This is essential for:

  • Regional Variations: Adapt your documents to meet specific regional permit requirements, codes, or construction practices.

  • Project-Specific Information: Dynamically populate project names, addresses, sheet numbers, revision data, and other project-specific details throughout your drawing set.

  • Option-Driven Drawings: Create Master Sets that show different design options (Ex: garage types, elevations) without creating separate files.

Parameter Types

There are 3 types of parameters, each with unique applications & behavior.

1. System Parameters

System Parameters are built-in variables that exist in all Studio files with Values that are read from pre-defined locations

  • The 5 types each define their Value from a different source. Some allow a user-defined Default Value that appears when the actual Value is undefined.

    1. Builder Information: Value defined in the Builder Info tab of Account Settings.

    2. Sheet Information: Value is defined on each Sheet Instance in a Plan Set Template.

    3. Config Information: Value is defined in Config based on the Master Plan, Community Plan, Home Plan, or Lot information.

    4. Current Date: Value is defined by the current system date.

    5. Active Model Information: building stats whose Value is defined by the current active model configuration (Ex: [BuildingBedCount]).

    6. Active Option State: Option information whose Value is defined by the current active model configuration. One Global Parameter for each option in the Studio file (not exposed in the Global Parameter catalog).

  • The Default Value is always overridden with the actual Value during export if one is defined at the export location

  • Use Case: To report information that dynamically changes in any of the sources noted above. Ex: Community Name. In Studio, you may assign a DefaultValue of “Test Community” for the CommunityName System Parameter. When exported from Studio where a community name is not defined, any instance of the CommunityName System Parameter will appear as “Test Community”. When exported from Config in a community called “Lakeview”, all instances of CommunityName will be filled with “Lakeview”.

2. Global Parameters

Global Parameters are user-defined variables created in the Global Parameter Catalog and available across Live Plans.

  • The Default Value is inserted at all parameter usages.

  • These are created at the project level & Document Reference-able between Studio files.

  • Use Case: They are useful for project-wide information that is repeated in multiple locations across multiple Live Plans templates. Ex: drafter name or revision number

3. User-Defined Parameters

User-defined Parameters are variables specific to a single Drawing, Sheet, or Plan Set Template. These can only be used within the template where they were created and do not appear in the Global Parameters Catalog.

  • The Default Value is inserted at all parameter usages unless overridden at the instance level.

  • Use Case: When information is repeated in multiple locations within a single Live Plans template. Ex: a single sheet may include a viewport & a text annotation that both reference the Front Elevation

Creating Parameters

Creating a Parameter

  1. System Parameters

    1. Cannot be created or deleted. Automatically appear in every Studio file.

  2. Global Parameters

    • Navigate to the “Catalogs” tab of the Explorer

    • Find the "Global Parameters” section & click the + button

  3. Drawing Template, Sheet Template & Plan Set Template Parameters:

    • Open a Plan Set Template, Sheet Template, or Drawing Template.

    • In the Inspector, find the “Parameters” section & click the + button.

Assigning Parameter Information

  • Define the parameter’s Name (Ex: "DrafterName" or "RevisionNumber")

    • Parameter names cannot contain spaces or special characters

    • Note: The names of System Parameters cannot be edited

  • Choose the parameter’s Type (Ex: Text, Number, ViewTemplate)

    • Note: The types of System Parameters cannot be edited

  • Enter a Default Value (optional)

    • This default value will be inserted wherever the parameter is used.

    • The Default Value for Drawing Template, Sheet Template & Plan Set Template Parameters can be overridden at the instance level

    • Note: System Parameters with Values that are always known do not allow a Default Value (Ex: CurrentMonth). Those that do will be overridden with the actual Value during export if one is available (Ex: LotNumber).

Using Parameters

Using Parameters in Live Plans text annotations for Dynamic Text

  • Open a Drawing Template, Sheet Template, or Sheet Instance: Open the Drawing Template where you want to use a parameter (Ex: your Title Block Drawing Template).

  • Insert Parameter: Use the Note or Leader tool to create a text annotation in a Drawing Template, Sheet Template, or Sheet Instance. While authoring the text, select the desired parameter (Ex: [SheetNumber], [MasterPlanName]) from the Add Parameter dropdown.

  • The text will now dynamically display the Default Value (or for some System parameters, the Value.

Using Parameters in Live Plans Conditional Statements

  1. Access the Live Plans Conditions Builder: Open the Inspector for any Live Plans content where you want to use a parameter in a conditional statement.

  2. Add a Condition: Click the + button next to the Conditions Inspector section & select the desired parameter & value. In the Live Plans context, only parameters are exposed in the conditions builder. Otherwise, conditional statements for Live Plans entities function the same as conditional statements on all other entities in Studio.

  3. When the criteria defined in the Conditional Statement has been met, the content will appear.

Using Parameters for Dynamic Properties on Live Plans content

  • Access Dynamic Properties: In the Inspector for any Live Plans entity (Ex: viewport, data table, etc.), look for properties that can be dynamically defined by a parameter (Ex: "View Template," "Data Sequence," or "Option Preset"). These are indicated by a "parameterize" icon (a function symbol) next to the property field.

  • Parameterize the Property: For a property you want to make dynamic, click the parameterize icon & select a Parameter from the dropdown list to link it to this property.

  • Now, the property (Ex: View Template) will be dynamically driven by the value of the chosen parameter. You can set or change parameter values in the locations indicated above.

Example Scenarios for Parametrization

  • Option-Driven Elevations: Use a Parameter called "GarageOption" in your Sheet Template for Elevations. Create View Overrides to show or hide the 3-car garage option based on the "GarageOption" parameter value.

  • Regional Code Compliance: Use View Overrides to highlight elements that meet specific regional code requirements (e.g., insulation levels, window U-values) based on a "Region" Global Parameter.

  • Dynamic Sheet Index: Use parameters to automatically populate sheet numbers and sheet names in your title blocks, ensuring a consistently numbered and named drawing set.

Did this answer your question?
Higharc Knowledge Center