OceanBIM Docs
Upload settings and rules

Name code

What a name code is, how it is built from your naming rules, and how to show it or use it for downloads.

Work in progress

This page is a draft. Some sections are placeholders and details may change.

A family has a long, readable name such as Wall_Ulma_formwork_20x20. A name code is the short code that goes with it, for example Wa-Ul-F2. Codes are handy for drawings, schedules and downloads where a short, stable identifier works better than a long name.

Where a code comes from

Every family has two names stored side by side:

HoldsExample
NameThe readable file nameWall_Ulma_formwork_20x20.rfa
Name codeA short code for the same familyWa-Ul-F2

A family you simply upload has no name code. It shows No name code under its name in the list; every family uploaded in our tests showed it. The code is set when the family is named through the app's name suggestion: the suggestion builds the name from your naming pattern, and the Code of each value it used is joined with a dash and saved as the family's name code, next to the readable name. The examples above are illustrative.

This means:

  • To get name codes, give the fixed values in your pattern a Code.
  • A code appears after a name suggestion is accepted, for example from Verify file rules.
  • Changing a value's label in a classification standard never renames a family on its own. The family is only marked as out of date, and you choose when to refresh its name.

The Name code settings

Open Settings, Family, Name code. The page saves each choice as soon as you change it. There is no Save button.

The Name code settings page with the Show under family names switch and the Downloaded file name options

Show under family names

Adds the code as a second line in tables and previews.

With this on, each family in your tables shows its name, with its code in smaller text underneath. It is a display preference for you only. It does not change any family.

Downloaded file name

Families without a code always use their name.

Choose what a downloaded .rfa file is called:

OptionDownloaded as
Name codethe code only, for example Wa-Ul-F2.rfa
Family name and name codethe name, a dash, then the code
Family name onlythe name, as it is

The page shows a preview of the resulting file name under the options.

The recommended defaults are: show the code under family names on, and download as Family name only. When both are at their defaults the page says Using default settings.

See families by code

In the My families list, Group by switches between Flat list and Name code. Choosing Name code groups the list by the families' codes.

TODO — Confirm before publishing

  • Every path that sets a name code besides accepting a suggestion for one family: bulk auto-suggest, and the Revit add-in. Also what the No name code label does when you click it, and what the "Refresh name" action is called where it appears.
  • What happens to codes already saved when the naming pattern changes later.
  • What the grouping by name code looks like and how deep it goes: add a screenshot.
  • A realistic example from a real standard in place of the illustrative Wa-Ul-F2.