Incoming Properties

standards-and-mappings
Knowledge Base
Incoming Properties

In This Article


Overview

When content is loaded into the active model, Guardian's Incoming Properties dialog automatically launches to identify, process, and clean the incoming content. This dialog launches based on the transaction assigned within the Project Configuration and through Load Family Protections.  

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.  

Incoming Properties works in conjunction with Mapping Configurations, Model Properties, and Transactions. Mapping Configurations store the mapping rules, Model Properties maps and cleans properties, and Transactions control how those rules are applied to end users when content is loaded.

How Transactions Work with Incoming Properties

Transactions are the Revit commands that Guardian monitors when content is brought into a project model, such as Load Family, Insert from File, Copy and Paste from another model, or even Explode CAD. When one of these commands is detected, Guardian responds by automatically processing and cleaning incoming properties for end-users while providing a full Incoming Properties dialog for administrators. Learn more about Transactions and how to customize the end-user experience.

How Load Family Protections Work with Incoming Properties

Load Family Protections can respond differently to incoming families based on different conditions and rules, such as enacting Incoming Properties when the family comes from a non-approved source and disabling scanning and processing for content inserted from the firm’s content management solution.  

Guardian does this by comparing incoming families with any rules created by administrators. These rules can be specific to the location the file is loaded from, the families category, or even the name of the file itself.  

If a match is determined, Guardian will, or will not, scan and process the family’s Incoming Properties as determined by the user experience set by company/project administration for that rule. If the protection mode for the triggered rule is set to Guide or Prevent, Guardian will provide the end-user a customized Command Message.

Learn more about customizing rules for Load Family Protections.

Incoming Properties Dialog Interface

Once a family is loaded, admins will be prompted with a dialog to see the incoming elements or process them as normal.  

  • ‍Remove new properties that are not used: Processes all known mappings in the background and purges unused properties. The Incoming Properties dialog is not shown. ‍
  • Let me choose which properties to keep: Opens the Incoming Properties dialog with full access to all mapping capabilities for the incoming content.

The Incoming Properties dialog looks similar to the Model Properties dialog and is made up of a few key panes:

  • ‍Families (A): Shows the incoming family and any nested families. Clicking on any one family filters the dialog to the properties that are loaded into that family.  ‍
  • Property Usage (B): Clicking an individual or multiple properties under Added Recently displays where the property is used in this pane.  ‍
  • Added Recently (C): Shows all properties within the incoming families.
  • Within this pane, you have columns for property name, usage, duplicates, and Guardian Sync Properties (D). Learn more about Guardian Sync Properties here.

The Incoming 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

Incoming 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. Learn more about mappings. ‍
  • 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. Learn more about one-time mappings. ‍
  • One-Time Mappings [Remove]: By default, any property that is present, but not used with the family, or incoming content, will be automatically be set to be removed. This does not apply to Families and Types.

Cleaning Property Types

Families and Types

Families and their family types are listed and grouped by family category. They can be renamed, purged, or mapped to families of the same category that already existed in the project. Please note, family types must be mapped independently of the family itself. There are unique situations for family types:

  • If a type is not present in the family being mapped to, Guardian will add that type to the family.  
  • If a type exists in both families (ie, Flush Door and Flush Door) but the parameter values differ, unless a mapping is assigned, Guardian will create a duplicate type in the family.

System Family Types

System family types are usually more common when used with insert views from another project or transfer project standards.  

Shared Parameters

Guardian can identify the incoming shared parameter. Tooltips are available to examine information about the shared parameter. This is useful for comparing the GUID when there are multiple shared parameters with identical names.  

Shared parameters can be mapped to those in the current model, to other shared parameters loaded in the family or model, or to ones in which mapping rules have already been assigned. The shared parameter can also set to be converted to Family Parameters.

Guardian will maintain all values, formulas and linked shared parameters wherever they existing within the family and nested families.  

Materials, Line Patterns, Fill Patterns, Object Styles, and Line Styles

This provides an opportunity to update the old standards that exist in the incoming family with the new standard material.  

When initially getting started with Guardian, it is best practice to use each of the cleanings as an opportunity to teach Guardian the proper mappings from an old or non-standard to the new standard.

Guardian will memorize these mappings for all future projects and automatically convert these properties.  

When mapping Revit properties hosted in the Guardian Cloud, a green link icon will appear next to each of those properties.

Export and Process

  1. Before processing the mappings, the Export button can be selected to save the cleaned families. For single families, they will be saved back to their source file. For multiple families, they can be saved as a zip file.
  2. Once all mappings are complete, select Process to proceed with cleaning the family.  

Best Practices and Workflows

Knowledge Base
Incoming Properties

In This Article


Overview

When content is loaded into the active model, Guardian's Incoming Properties dialog automatically launches to identify, process, and clean the incoming content. This dialog launches based on the transaction assigned within the Project Configuration and through Load Family Protections.  

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.  

Incoming Properties works in conjunction with Mapping Configurations, Model Properties, and Transactions. Mapping Configurations store the mapping rules, Model Properties maps and cleans properties, and Transactions control how those rules are applied to end users when content is loaded.

How Transactions Work with Incoming Properties

Transactions are the Revit commands that Guardian monitors when content is brought into a project model, such as Load Family, Insert from File, Copy and Paste from another model, or even Explode CAD. When one of these commands is detected, Guardian responds by automatically processing and cleaning incoming properties for end-users while providing a full Incoming Properties dialog for administrators. Learn more about Transactions and how to customize the end-user experience.

How Load Family Protections Work with Incoming Properties

Load Family Protections can respond differently to incoming families based on different conditions and rules, such as enacting Incoming Properties when the family comes from a non-approved source and disabling scanning and processing for content inserted from the firm’s content management solution.  

Guardian does this by comparing incoming families with any rules created by administrators. These rules can be specific to the location the file is loaded from, the families category, or even the name of the file itself.  

If a match is determined, Guardian will, or will not, scan and process the family’s Incoming Properties as determined by the user experience set by company/project administration for that rule. If the protection mode for the triggered rule is set to Guide or Prevent, Guardian will provide the end-user a customized Command Message.

Learn more about customizing rules for Load Family Protections.

Incoming Properties Dialog Interface

Once a family is loaded, admins will be prompted with a dialog to see the incoming elements or process them as normal.  

  • ‍Remove new properties that are not used: Processes all known mappings in the background and purges unused properties. The Incoming Properties dialog is not shown. ‍
  • Let me choose which properties to keep: Opens the Incoming Properties dialog with full access to all mapping capabilities for the incoming content.

The Incoming Properties dialog looks similar to the Model Properties dialog and is made up of a few key panes:

  • ‍Families (A): Shows the incoming family and any nested families. Clicking on any one family filters the dialog to the properties that are loaded into that family.  ‍
  • Property Usage (B): Clicking an individual or multiple properties under Added Recently displays where the property is used in this pane.  ‍
  • Added Recently (C): Shows all properties within the incoming families.
  • Within this pane, you have columns for property name, usage, duplicates, and Guardian Sync Properties (D). Learn more about Guardian Sync Properties here.

The Incoming 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

Incoming 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. Learn more about mappings. ‍
  • 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. Learn more about one-time mappings. ‍
  • One-Time Mappings [Remove]: By default, any property that is present, but not used with the family, or incoming content, will be automatically be set to be removed. This does not apply to Families and Types.

Cleaning Property Types

Families and Types

Families and their family types are listed and grouped by family category. They can be renamed, purged, or mapped to families of the same category that already existed in the project. Please note, family types must be mapped independently of the family itself. There are unique situations for family types:

  • If a type is not present in the family being mapped to, Guardian will add that type to the family.  
  • If a type exists in both families (ie, Flush Door and Flush Door) but the parameter values differ, unless a mapping is assigned, Guardian will create a duplicate type in the family.

System Family Types

System family types are usually more common when used with insert views from another project or transfer project standards.  

Shared Parameters

Guardian can identify the incoming shared parameter. Tooltips are available to examine information about the shared parameter. This is useful for comparing the GUID when there are multiple shared parameters with identical names.  

Shared parameters can be mapped to those in the current model, to other shared parameters loaded in the family or model, or to ones in which mapping rules have already been assigned. The shared parameter can also set to be converted to Family Parameters.

Guardian will maintain all values, formulas and linked shared parameters wherever they existing within the family and nested families.  

Materials, Line Patterns, Fill Patterns, Object Styles, and Line Styles

This provides an opportunity to update the old standards that exist in the incoming family with the new standard material.  

When initially getting started with Guardian, it is best practice to use each of the cleanings as an opportunity to teach Guardian the proper mappings from an old or non-standard to the new standard.

Guardian will memorize these mappings for all future projects and automatically convert these properties.  

When mapping Revit properties hosted in the Guardian Cloud, a green link icon will appear next to each of those properties.

Export and Process

  1. Before processing the mappings, the Export button can be selected to save the cleaned families. For single families, they will be saved back to their source file. For multiple families, they can be saved as a zip file.
  2. Once all mappings are complete, select Process to proceed with cleaning the family.  

Best Practices and Workflows

Need More Help?

Contact our support team to receive personalized assistance.

Guardian graphic