OceanBIM Docs
Identity data

Verify identity data

See how complete your families' identity data is, and run an identity check to fill in what is missing.

Work in progress

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

Verify identity data tells you how well your library is described, and helps you improve it. It is on Settings, Family, Verify identity data.

The Identity data health card with a score and Complete, Partial and Missing counts

The health card

Identity data health. See how complete identity data is across your families. Scores are averaged across evaluated family versions.

The card shows the average score as a percentage, how many family versions were evaluated, and how many are Complete, Partial or Missing. A link next to the description takes you to Fields mapping.

If no field is mapped yet, a warning appears above the card: No fields are mapped to a classification system yet. with a Map fields button.

How the score works

Each identity field carries a weight. A family version's score is how much of the total weight is filled in, scaled to a number from 0 to 100. Fields that matter more for classification, such as the classification number and title, weigh more than minor fields such as a keynote.

Only the current version of each family is scored, not its older versions.

The grade follows the score:

GradeScore
Complete77 or more
Partial38 to 76
SparseAbove 0, but under 38
Missing0: no identity data was read from the family

The card combines Partial and Sparse under Partial.

What is dragging the score down

Under the card, Show score breakdown and field contributions opens a list of the families affected and, for each field, how often it is missing and how much of your score it costs. For example, on a small test library: Classification: missing in 3/5, −13.8%. Start with the fields at the top: filling them in lifts the score the most.

Run identity check

Choose Run identity check to open the review: Identity check, with a line such as 5 of 5 families on this page need review.

The identity check review with a family's identity data open as an editable table

The list has one row per family, with its Category and its Identity score (a short bar). Use the search box to find a family, and Manage field definitions to open the fields.

Choose a family's row to open its identity data. You see every field as a line with three columns, Name, Code and Description. A tick means the field has a value; a dashed circle means it is empty.

  • Type a value straight into a cell. The family's score is recalculated at once. An orange dot beside the family's name means it has changes you have not saved.
  • At the end of the opened row, three icons: Run suggestion (propose values for this family), Discard changes and Save.
  • At the top, Run suggestions proposes values for the families on the page, and Apply suggestions applies the ones you accepted.

Nothing is changed in your library until you save or apply it.

TODO — Confirm before publishing

  • Where a suggestion shows its source (a matching rule, a similarity match, AI, or set by hand), and how to accept one suggestion versus many. On DEV the suggestion run finished without showing any values to accept, so this could not be captured.
  • Who can run the check in a workspace (the workspace owner and admins) and what its page looks like there. (B3)
  • Whether suggestions use AI credits. Link to the Pricing page for the limits without copying numbers here. (B3)
  • The exact field weights, which are configurable. (B3)