OceanBIM Docs
Upload settings and rules

Verify file rules

Score the families you already have against your rules and fix the ones that fall short, with AI-suggested names.

Work in progress

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

Upload rules only protect the future. The families you already have may break rules that you added later, or that were bypassed by a rename. Verify file rules checks the whole library and tells you how well it measures up.

It is on Settings, Family, Verify file rules.

The compliance card

File rules compliance. See how well families across My families satisfy saved file rules. Scores are averaged across evaluated families.

The File rules compliance card with a score, Compliant, Failing and Violations counts
FigureMeaning
ScoreThe average compliance score of all families checked.
Current families evaluatedHow many families were checked.
CompliantFamilies that pass every rule.
FailingFamilies that break at least one rule.
ViolationsThe total number of broken checks.

If you have not saved any rules yet, the card says No file rules saved yet. Create some first in File rules, Filename rules or the Naming pattern. A library with no families shows no score. Do not read an empty library as 100%.

How a family's score is worked out

Each family is tested against up to five kinds of check:

  1. the filename rules,
  2. the naming pattern, counted one part at a time,
  3. file size,
  4. category,
  5. Revit version.

Only rules you have saved count. The score is the share of checks passed:

score = checks passed, divided by checks run, times 100, rounded

For example, with filename rules, a three-part naming pattern, and a size rule saved, there are five checks (one, plus three, plus one). A family that fails the size rule and one pattern part passes three of five, so it scores 60.

The card's Score is the average of these over all families.

Review file issues

Choose Review file issues to open the list of families that need attention.

The review list of families with their rule violations shown as chips

The toolbar has a search box (Search family names), the rule set the check used (Rules: My families), and two tabs: Needs attention and All, each with a count. The table lists, for every family, its thumbnail and name, its Score, its Violations (for example Naming or Category) and when it was last updated. A line under the name says which rule set judged the family: your general rules, or the convention on its folder.

For a single family you can open its issues and ask for a suggested name. To work through many, use auto-suggest.

Auto-suggest names

For families whose name breaks your rules, the app can propose a corrected name. The button at the top right does it:

  • Auto-suggest current page (N) works on the families on the page you are looking at.
  • Its small arrow opens a menu with Auto-suggest all (N), for every family that needs attention.

What happens next:

  1. The suggestions are produced on the server as a job. It keeps running if you close the browser, and you can come back to it. Once a job exists, the button reads Review N name suggestion and opens the results; Re-run starts again, and Clear the check in the same menu removes the job.
  2. Each suggestion follows your naming rules. Where the app cannot produce one with AI, it falls back to a rule-based suggestion.
  3. The results window shows how many suggestions are ready, need input, were skipped or failed. Suggestions are grouped by the kind of change, for example Replace separator " " with "_", each group with the number of families. For every family you see the old name crossed out and the new one below it, and you can edit it (pencil) or take it out (bin). Tick the ones you want.
  4. A suggestion that still contains a placeholder such as --- needs your input: Replace every "---" placeholder before applying this name. It cannot be applied until you edit it.
  5. Apply changes (N) renames the ticked families. Undo job puts the names back, and every rename is recorded in the family's history.
  6. Delete job removes a job you no longer need.

Review before applying

Suggestions are proposals. Look at a sample of each group before you apply it to many families, and edit any that are wrong. The undo window is a safety net, not a substitute for looking.

A family that is locked by someone else cannot be renamed until the lock is released.

If auto-suggest has nothing to offer, a notice above the list tells you why (for example, no naming rules saved, AI suggestions switched off, or no AI credits left) and links to the fix.

AI suggestions use your AI credits. The credits reset on the payer's purchase day, and your plan decides how many you get: see Pricing.

You can switch AI suggestions off in File rules under Settings. In a workspace, the same switch is in the workspace's rules settings. It is on by default.

TODO — Confirm before publishing

  • How long Undo job stays available. The design says about 7 days, but no such limit was found in the code. (B3)
  • On DEV, four of five suggestions failed with "AI suggestion unavailable: parse_error", so no result with AI answers could be captured. Re-check once AI works on DEV.