OceanBIM Docs
Identity data

Fields mapping

Tell the app which classification system each identity field should be checked against.

Work in progress

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

Fields mapping connects your identity fields to the classification systems. It is what lets the app say "this family's classification number is valid" or "this code does not exist in your system".

Open Settings, Family, Fields mapping.

The Fields mapping table with Parameter, System, Tables and Type columns

The table

ColumnMeaning
ParameterThe identity field, for example Classification or Assembly Code. A small mark beside it shows whether it is mapped.
SystemThe classification system this field is checked against.
TablesWhich tables of that system count. Useful for systems such as OmniClass, where only one or two tables apply to families.
TypeWhat kind of value the field holds.

Above the table, Manage Systems takes you to the list of systems and Add parameters creates a field of your own.

Map a field

  1. In the System column of a row, choose Select a system and pick one from the list.
  2. If the system has several tables, use Connect to table in the Tables column and choose which ones count. Leave it empty and every table of the system is included.
  3. Use Change system, Remove system, Change table or Remove table to alter a row later. Choose — None — to leave a field out.

Suggestions

For some rows the app proposes a mapping: it shows the proposed system and tables marked Suggested by default, with a tick and a cross. Choose Save suggestion (the tick) to keep it, or Dismiss suggestion (the cross) to ignore it. On DEV, Classification is suggested against OmniClass, Assembly Code against UniFormat 2010 and Keynote against MasterFormat. A saved mapping shows a green check.

Why it matters

If no field is mapped, the Verify identity data page shows this warning:

No fields are mapped to a classification system yet. The identity check scores families against your fields mapping. Without it, results may be inaccurate.

So mapping is the first thing to do before you trust a score.

Your own fields

You are not limited to the built-in fields. Choose Add parameters to add a field of your own, for example Fire rating or Supplier code. The New identity data field window asks for:

SettingMeaning
Key (required)A stable name used in APIs and scoring. It cannot be changed later.
Label (required)The name people see.
DescriptionWhat the field is for.
Value type (required)What kind of value it holds: Text, Number, Yes / No or URL.
Revit value aliasesThe Revit parameters whose values fill the plain-text side of the field.
Revit code aliasesThe Revit parameters whose values fill the code side. Leave empty for a field that holds a value only.
Max lengthThe longest value allowed.
Score weight (0–5)How much the field counts towards a family's identity score.
Display orderWhere the field appears in the list.

Fields you create apply to your own families, or to a workspace when you make them in its settings. Platform fields are the defaults for everyone and can only be changed by application administrators.

TODO — Confirm before publishing

  • What a suggestion is based on and when the app offers one. (B3)
  • How to edit or archive a field of your own. (B3)
  • Whether the mapping page itself lets you change a field's weight (it is set when the field is created). (B3)