Skip to main content

Document References

Document References

Settings for home studio plans can be set up as a reference from another studio file to another, often referred to as the Central Data Model. The Central Data model holds all possible settings for all home plans in a builder’s suite of designs, communities or special zoning needs.

Higharc Plan Hierarchy

Settings from Higharc Studio plans can be inherited from the Template Studio File, or Central Data Model, to other studio files.

The diagram below demonstrates how settings are inherited in a hierarchy.

Notion Image

  • Template Studio Document - Studio document being used as a reference, or a Central Data Model.

  • Studio Document - The base home plan design, inheriting the settings from the Central Data Model.

  • Master Plan - A Published Studio Document ready to sold to customers.

  • Community Plan - A Master Plan with specific settings selected to be sold in a specific community.

  • Home Plan - A Lot Specific Community Plan utilizing site specific settings and customer selected options.

See Intro to Config: Adding Master Plans to a Community to learn more.

Publishing a Studio File

For updates to be seen lower in the hierarchy, the file must be published. For example,

  • For a Central Data model to be loaded as a reference, it must be published first.

  • For a plan to be seen in Config and Showroom, it must be published first.

Add a Document Reference

To add a Document Reference to a file, the minimum required permissions on the reference file must be assigned as Viewer.

To add a reference file, follow these steps:

  1. In the Home tab in the Inspector, select Document Reference.

  2. Select the ‘+’ to add a Document Reference.

  3. Select the Option Sets, Setting Sets and Palettes to import into the studio file.

When there are updates published to the reference file, a banner with the word UPDATE will appear.

  • To update the existing Option Sets, Setting Sets and Palettes as they are, only select the UPDATE button.

  • To import new Option Sets, Setting Sets and Palettes, select their respective check marks.

    • NOTE: ‘Import All’ will override inherited settings in Setting Sets.

Document Reference Management and Id Conflict Resolution

Document Reference Management

After a document reference has been added to a file, you will see it listed in the Home Inspector under Document References.

Notion Image

Click on the Document Reference to navigate to its Inspector. You will see the option to 'Import All' or you can expand the various categories to selectively import entities of interest.

Notion Image

Selecting entities to Import can be done at various levels of granularity.

  • Categories > Import All under a category

  • Groups > Indicated by Folder Icon

  • Specific entities

Notion Image

Upon Import, your document referenced entities will include the Ref badge, indicating the entity is from another document. Most properties of these referenced entities are read-only.

Though read-only, these referenced entities can be used in the Active Document and can be referenced by other entities in the Active Document just like other non-document referenced entities.

Notion Image

In some circumstances, the Document Reference is useful as a seeding mechanism for adding entities to the Active Document. Rather than maintaining the link to the Document Reference, an entity or selection of entities is imported and then un-imported leaving local copies of the entities in the active document (most entities support this workflow, others do not leave local copies when un-imported).

For the entity types that leave local copies when un-imported, they now are editable local entities and their properties are editable (aka not readonly).

Notion Image

Notion Image

Id Conflict Resolution

When some entity types are un-checked and subsequently un-imported, local copies are placed in the active document. Notice the display of duplicate id indicators in the Document Reference inspector. This indicates active document entities and un-imported document reference entities have the same ids. If the entities are re-imported from the document reference, they will overwrite the active document entities that were just copied locally by un-importing.

Notion Image

As long as the entities and all of their properties are the same, there will be no changes to the home upon re-import of the entities. In many cases, these duplicate id indicators can be ignored. But if any changes have been made to the active entity that aren’t present in the document reference entity a warning indicator will highlight the difference.

Notion Image

A warning indicator signals any differences between the active document entity and the document reference entity in order to prevent introducing unintended changes to the home during document reference import. Additionally, hovering over the indicator will provide a text summary of the differences between the active and reference documents.

Notion Image

In this instance, the active document has a detail drawing that is not present in the Drawing Catalog Settings in the document reference settings set.

Notion Image

There are two ways to mitigate this situation based on what is desired.

  1. If the entity is imported from the Document Reference, the active document entity’s changes will be overwritten.

    1. Notion Image
  1. If keeping both the active and document reference entities is desired, hover over the duplicate id badge and select assign new id and then importing the document reference entity is possible without overwriting the active document entity and its child entities.

    1. Notion Image

Id Conflict Resolution while adding a Document Reference

A warning modal will show, if a document reference is added to a file that was created by saving a version of the same document to file and importing it. It will indicate the number of id conflicts and the categories the conflicts are found in. Canceling the modal will abort adding the document reference.

Notion Image

Select 'Confirm' to proceed with adding the Document Reference. The categories and entities can be explored to determine where the ids conflict with the active document.

Notion Image

If overwriting the entities with conflicting ids is desired, 'Import All' can be used to import as normal. All active document entities will be overwritten.

Notion Image

Some categories will almost always be different in the active document than those in the document reference. It is recommended to check these entities and confirm that overwriting local changes doesn’t remove desired data from the local document.

Notion Image

For example, room layout document reference entities also manage any rooms and room hosted entities (annotation, props, windows, doors and casework), so any changes in these managed entities will cause an id conflict warning sign in the parent room layout.

Did this answer your question?