standards-and-mappings

Model Properties

Knowledge Base
Model Properties

In This Article



Note: Project Properties was renamed to Model Properties in Guardian 3.3.5.

Overview

Guardian's Model Properties is a powerful engine for aligning your project model properties with your firm's graphical and Revit standards. Model Properties identifies, processes, and cleans the furthest reaches of your project models and Revit families.

Model Properties functions in two distinct ways:

  1. All Model Properties dialog — Guardian administrators use this to map and clean the Revit properties within the active Revit model or an individual Revit family so they align with firm standards.
  2. Incoming Properties — When content is loaded into the active model, Guardian's Incoming Properties automatically launches to identify, process, and clean the incoming content. Depending on how Guardian is configured for end-users, Guardian will either process properties automatically based on known mappings, or (for administrators) prompt the Model Properties dialog for manual cleanup. Learn more about Incoming Properties here.

In both cases, Model Properties allows you to identify properties that are in (or out of) alignment with the firm’s standards and Guardian Sync Properties, duplicate properties, and property usage. Model Properties works in conjunction with Mapping Configurations and Transactions. Mapping Configurations store the mapping rules, and Transactions control how those rules are applied to end-users when content is loaded.

How Mapping Properties Works with Mapping Configurations

At the heart of Model Properties is Mapping Configurations. Model Properties and Incoming Properties are the interfaces in which mappings are created. Mapping Configurations are how and where Guardian memorizes those mappings, or conversions, of non-standard Revit properties to a standard Revit property. It's these Mapping Configurations that establish the automations Guardian uses to clean incoming content and align it with a firm's or project's graphical and Revit standards.

A Mapping Configuration must be created and assigned to the registered model before Model Properties functionality is enabled. For details on what Mapping Configurations do, how to set one up, and best practices for structuring master, discipline-specific, and client-specific configurations, see the Mapping Configurations article.

Model Properties Dialog Interface

Overview

Model Properties dialog overview

Model Properties can map and clean the Revit properties of the active model. Access it from Model > All Model Properties (A). Before mapping and cleaning, always confirm the correct Mapping Configuration is assigned to the active model (B). Also note the number next to Review Changes (C) in the lower-right corner. This shows how many mappings Guardian has already recognized automatically, based on the Mapping Configuration's existing rules.

Walkthrough

Model Properties dialog walkthrough

The Model Properties dialog is made up of a few key panes:

  • History (A): Shows the history of the current panel, including when, by whom, and what content and properties were added, modified, or deleted. Clicking on any one transaction opens detailed information on all the property changes made in it.
  • Property Usage (B): Clicking an individual or multiple properties under In Model displays where (a loadable family, system family, schedule, settings, etc.) the property is used in this pane. For some property types (such as line patterns), this also shows a visual preview of the property.
  • In Model (C): The tabs along the top of the dialog, organized by specific Revit property category (system family types, line patterns, materials, etc.) will show all properties within the model.
    • Within this pane, you have columns for property name, usage, duplicates, and Guardian Sync Properties (D). Learn more about Guardian Sync Properties here.

The Model Properties settings menu (E) provides several options for controlling what is displayed and how mapping rules are managed:

Setting What It Does
Hide system properties Hides system-type properties from the list
Show only mapped properties Filters to properties that have an existing mapping rule applied
Show only unused properties (from scanned) After scanning for usage, filters to properties with no usage
Show only duplicate properties (from scanned) After scanning for duplicates, filters to properties with detected duplicates
Expand All / Collapse All Expands or collapses all properties across all tabs
Show additional mapping insight Shows whether a mapping will rename or map a property; displays [Remove] for properties set to be removed
Reset all mappings (session only) Restores any changes made during the current session to what was set when Model Properties was opened
Remove mappings from rules (session only) Temporarily removes applied mapping rules for the session; rules are reapplied when Model Properties is reopened. This does not delete rules from the mapping configuration

Note: "Show only unused" and "Show only duplicate" filters require the relevant tab to be scanned first (via Scan for Usage / Scan for Duplicates) before they'll return results.

Mapping Functions

Mapping functions icons

Model Properties gives you several functions for renaming properties, adding, or editing mappings.

  • Rename: Select the property you want to rename, then click the Rename icon and enter the new name. If the Add to mapping rules checkbox is checked, Guardian will rename this property automatically going forward. Leaving it unchecked applies the rename just this time.
  • Edit Mapping: Select an existing mapping, then click the Edit mapping icon. Choose the property you want to merge, or map, it with from the list on the right, and click OK.
  • Remove Mapping: Select an existing mapping to remove. A dialog will ask whether Guardian should remember the action. Remember (update rules) applies the change to your Mapping Configuration going forward, while Don’t remember (do this time only) applies it as a one-time mapping.
  • One-Time Mapping: A one-time mapping is the same as a typical mapping, but the mapping is not stored to the Mapping Configuration and will not be automatically applied to all future mapping sessions. See One-Time Mapping below.

Full Mappings

Full mappings

A full mapping, or a typical mapping, is a mapping stored in a Mapping Configuration and is mapping from one property (non-conforming standard) to another property (standard). When Edit Mapping is selected, the Map Properties dialog will appear. This dialog will show the selected property to merge on the left, along with a display of the property when available, and the list of all of the available like properties within the active model on the right.

Note: Project administrators will only have one-time mapping capabilities unless they are assigned as a Project Administrator on the assigned Mapping Configuration.

Properties listed with the link icon indicate they are also hosted on Guardian Sync Properties. This provides quick identification of the firm’s standards during the mapping process. Please note Guardian only maps to properties in the active model and does not map to properties that exist on Guardian Sync Properties but are not in the active model. They must first be downloaded from Guardian Sync Properties.

Pro tip: Guardian assumes the model you are working from is the source of truth, and all Revit and graphical properties are pre-loaded into the model as a Revit template or Starter Project.

One-Time Mappings

A mapping can be applied on a one-time basis without being saved to a configuration. This approach is useful for project-specific cleanup that should not become permanent, typically associated with unique project-specific requirements that do not constitute a full standard.

A one-time mapping is indicated by a superscript 1 displayed next to the mapping symbol in Model Properties.

One-time mappings can be set two ways:

One time mapping from create dialog

1. From the create/edit dialog: Toggle the Remember / Don't Remember option when creating or editing a mapping rule.

One time mapping from model properties dialog

2. From Model Properties directly: Select an existing mapping rule and click the Remember / Don't Remember option to toggle its behavior.

Renaming

Renaming is a form of mapping that keeps the makeup of the original property but only renames the property. This is an effective tool for updating naming standards.

Since Guardian treats renaming and mappings equally within Mapping Configurations, a rename can lead to a helpful mapping.

Example: If Family B is renamed to Family A. However, if an older and different version of Family B is loaded into the active model, Guardian will map the old Family B to the current Family A, thus eliminating the old Family B.

Pro Tip: Historically, bringing families and details from old Revit projects meant bringing those old standards along, limiting the full adoption for standards updates. Between Mappings and Renaming, over time, Guardian effectively purges those old standards to ensure the new standards are effectively adopted.

When a Mapped Property Doesn’t Exist

When a mapping rule is applied to a property, Guardian determines whether to map or rename based on whether the destination property already exists in the current model.

  • Map: If the destination property already exists in the current model, Guardian converts all instances of the source property to the destination property.
    • Example: If Property B does exist in the model, then Guardian will convert all instances of Property A to Property B.
  • Rename: If the destination property does not exist in the current model, Guardian renames the source property to match the destination name.
    • Example: When mapping Property A to Property B, if Property B doesn’t already exist in the current model, then Property A will be renamed to Property B.

To preview which behavior will apply before committing to a change, enable Show additional mapping insight in the Model Properties settings menu. Properties that are set to be removed will display as [Remove].

Preview System Family Type(s)

To see a quick side-by-side comparison of the makeup up of each property:

Preview system family types dialog
  1. Select one or multiple System Family Types (Text Types, Dimension Types, Line Styles)
  2. Click the Preview System Family Types icon

Scanning for Usage and Duplicates

Scan selection for usage

Scan selection for usage is a great way to see how frequent, or infrequent properties are used in the active project model.

Scan for usage
  1. Select a property or multiple properties to scan for usage.
  2. Click the Scan selection for usage button
    • Note: A yellow caution icon flags properties Guardian may not be able to fully map. For example, properties applied to elements inside a Revit group or some system settings such as Revit Phase Settings, which Guardian cannot access due to API limitations. Guardian will still identify where these elements reside so they can be edited manually.
  3. Once scanning is completed, a number will appear in the Usage column indicating how many times that property is used in the open model.
  4. A list will also appear in the Property Usage pane showing where that property is being used in the model. The yellow caution icon flags will also show up next to the elements or settings that Guardian cannot map.
  5. If a scan shows a property is unused (-), deselecting its checkbox deletes it from the model entirely, the same as the Purge Unused command.

Note: if a “remove mapping” is assigned to a property, Guardian will delete that property in all future mapping sessions regardless of if the property is used.

Guardian will then prompt to remember the action:

  • Remember (update rules): Applies the choice to the Mapping Configuration so it's automated going forward.
  • Don't remember (do this time only): A one-time mapping that isn't saved to the configuration. See below for more on one-time mappings.

Pro Tip: Every property is a mapping opportunity to make Guardian smarter. It is recommended, especially early in a firm’s mapping journey, to map (or rename) unused properties of a non-conforming standard to a standard. More than likely, there will be instances in the future in which that property is used and it’s best to have the property mapped versus deleted.

Scan property for duplicates

Scan property for duplicates is an effective feature of Model Properties to identify properties that are identical in makeup, but named differently.

Note: Not all duplicates are bad as designers routinely have duplicate properties (example: line patterns) of the same makeup but are used for entirely different purposes as indicated by their names.

Scan for duplicates
  1. Select the tab to scan for duplicates
  2. Click the Scan property type for duplicates button
  3. Once scanning is completed, a number appears in the Duplicates column showing how many times that property is duplicated within the model.
  4. Hovering over the number in the Duplicates column highlights the matching cells in yellow
  5. Clicking the number opens the Duplicates Found dialog, listing the identical types.
  6. From there, select or multi-select the non-standard properties, then click Edit Mapping
  7. Select the correct property to map them to
    • Once mapped, Guardian stores the mapping in the mapping configuration. Any future model using that configuration will automatically convert the same non-standard types.

Mapping Duplicate Properties Workflow

In the screenshot below, we have already scanned the Line Styles tab for duplicates. Guardian reported there are 3 styles that are the same.

In this example, ACME_05 represents our company standard naming convention and the one we ultimately want to remain in our template.

After scanning duplicates, the next step is to scan the usage of these three line styles.

  • OLD_5 is being used a disproportionate number of times compared to the other two.
  • A traditional and intuitive workflow would be to map OLD_5 and 5 to the desired outcome of ACME_05
  • However, it's not hard to imagine that converting 736 instances will take a considerable amount of time compared to the alternative.
Mapping old to new

Instead of mapping OLD_5 and 5 into ACME_5, we will reverse the operation by mapping everything into OLD_5 to minimize processing time and then simply rename it.

mapping to the old

After mapping 5 and ACME_5 into OLD_5, we have a combined usage of 803. Now all we need to do is rename OLD_5 to ACME_5 and we saved ourselves a considerable amount of time.

Renaming the old to new property

Review Changes and Processing

Once all mappings are complete, select Review Changes to proceed with cleaning the model or family. Guardian prepares the model for the changes tied to each mapping, then opens the Review Changes dialog, a single consolidated list (rather than separate tabs) where administrators can:

  • Review all mappings and their usages
  • Undo specific mappings
  • Convert mappings to or from one-time mappings
  • See all loadable families affected by the changes
  • Export files for the affected loadable families before changes are processed

Selecting Process executes the changes, and the Revit model or family is cleaned accordingly.

Happy Mappings!

Best Practices and Workflows

Need More Help?

Contact our support team to receive personalized assistance.

Guardian graphic