PRODUCT GUIDE

Toolbox Handbook for ExyViewer and JaMo App

Use this page as a working manual. It explains the real controls exposed in ExyViewer and the supported JaMo App workflows represented in this codebase, so users can find a tool, understand its inputs, and know what to expect before they click.

Coverage is derived from the live ExyViewer toolbar, side panels, drawing module, and the current JaMo App purchase, download, compatibility, and product-content flows in this repository.

Audit Snapshot

Weaknesses in the current page

The current Toolbox page behaves like a promotional landing page instead of a reference page.
JaMo App content is broad and benefit-led, but it does not explain real workflows, setup steps, or user inputs.
ExyViewer commands are not documented even though the viewer contains a large command surface in code.
Long-form support content is missing, so users have no clear jump points, task guidance, or result expectations.

Content map used for the rebuild

ExyViewer: file loading, navigation, visibility, structure tree, properties, markup, IDS, clashes, BCF, classification, drawing, and reporting.
JaMo App: version selection, installer download, activation flow, Revit compatibility, modular ribbon deployment, smart element selection, parameter validation, and mass modeling references present in repo content.
Information architecture: hero, audit summary, table of contents, separate product sections, category anchors, and repeatable command cards.

WEB VIEWER

ExyViewer

ExyViewer is the browser-based model review workspace in this repository. Its tools are implemented in the viewer toolbar, side panels, and drawing module.

This section documents the actual viewer controls surfaced in code, including paid panels and technical drawing tools.

Load IFC or FRAG

Purpose

Open a model file into the viewer.

When to use it

Use this at the start of a session or whenever you want to add another model to the current workspace.

Where to find it

Top toolbar: `Load` button. The structure panel can also add another model.

Main options or inputs

Accepted formats: `.ifc` and `.frag`.
`.frag` is the preprocessed fast-loading format generated by ExyViewer.

How to use it

1. Click `Load` and choose an IFC or FRAG file.
2. Wait for the viewer canvas and structure tree to populate.
3. If you are working with multiple models, use the structure panel to unload or add more files.

Expected result

The model appears in the scene, becomes available in the structure tree, and its data can be used by the analysis panels.

Notes and limits

A model must be loaded before visibility, markup, IDS, clash, classification, drawing, or reporting tools become useful.
FRAG files are intended for faster repeat opening, not for authoring changes back to IFC.

Best practice

If you review the same large file often, export a FRAG version once and reopen that for later sessions.

Navigation Controls

Purpose

Move around the scene and reset your viewpoint quickly.

When to use it

Use these controls whenever you need to inspect geometry from another angle or recover a lost view.

Where to find it

Top toolbar: `Orbit`, `Pan`, `Zoom All`. Top-right overlay: `ViewCube` and quick view buttons.

Main options or inputs

Navigation mode: `Orbit` or `Pan`.
Orientation shortcuts: front, back, left, right, top, bottom, and isometric views from the ViewCube.

How to use it

1. Choose `Orbit` to rotate around the model or `Pan` to shift the camera target.
2. Click `Zoom All` if the model is off-screen or you want to frame everything again.
3. Use the ViewCube to jump to a standard orthographic or isometric direction.

Expected result

The camera updates immediately and the ViewCube stays synchronized with the current orientation.

Notes and limits

Reset also returns the viewer to orbit mode and performs a zoom-all action.
The ViewCube is an orientation helper, not a saved-view manager.

Best practice

Use `Zoom All` before creating reports, screenshots, or BCF issues if you want a clean overall framing.

Visibility and Focus Controls

Purpose

Cut, hide, isolate, restore, and declutter the scene.

When to use it

Use these tools when you need to inspect a dense area, compare only a few elements, or recover the full scene after focused work.

Where to find it

Top toolbar: `Section`, `Hide`, `Isolate`, `Reset`, and `Grid`. Section settings open from the split button chevron.

Main options or inputs

Section edge options: show edges, edge color, and edge thickness.
Grid visibility is remembered in local storage between sessions on the same browser.

How to use it

1. Select one or more elements if you want to hide or isolate only those items.
2. Toggle `Section` to enable clipping planes, then adjust edge settings if you need stronger cut-line feedback.
3. Use `Hide` or `Isolate` for focused review, and use `Reset` to clear section planes, restore visibility, close split views, and return to the default navigation state.

Expected result

The scene becomes easier to read and you can focus on a problem area without permanently changing the source model.

Notes and limits

Hide and Isolate require an active selection.
Reset is intentionally broad: it clears sectioning, restores visibility, disables markup mode, closes drawing split views, and zooms back to the full scene.

Best practice

Isolate is faster than repeated hide actions when you already know the exact elements you want to review.

Selection and Inspection

Use these tools to locate elements, inspect shared metadata, and move from model structure to element detail.

Jump to a section

Structure Tree and Properties Panel Markup Overlay

Structure Tree and Properties Panel

Purpose

Browse the IFC hierarchy, select elements, and inspect their metadata.

When to use it

Use this when you need to understand where an element sits in the model, compare multiple selections, or read IFC properties and property sets.

Where to find it

Top toolbar: `Structure` opens the model structure panel. Side panel tab: `Properties`.

Main options or inputs

The structure panel can add and unload models.
The properties panel supports searching and multi-selection summaries.

How to use it

1. Open `Structure` to browse the loaded model hierarchy and select an item.
2. Open `Properties` to inspect identity data, IFC information, property sets, materials, layers, and shared values across multi-selection.
3. Use the search field in Properties to narrow long property lists.

Expected result

You can move from spatial structure to exact element metadata without leaving the viewer.

Notes and limits

With multi-selection, only shared properties are shown and differing values are marked explicitly.
The structure tree also lists loaded models and lets you unload them individually.

Best practice

Use the structure tree to get to a known storey or assembly quickly, then switch to Properties for detailed checks.

Markup Overlay

Purpose

Create lightweight review annotations directly over the 3D scene.

When to use it

Use this during coordination or review meetings when you need quick visual notes without opening the full drawing module.

Where to find it

Top toolbar: `Markup`.

Main options or inputs

Overlay tools include text, cloud, arrow, and coordinate annotations.
Markup anchors can follow scene geometry through camera updates.

How to use it

1. Toggle `Markup` on from the toolbar.
2. Place notes, clouds, arrows, or coordinates over the area you want to explain.
3. Exit markup mode when finished so regular viewer interactions stay clean.

Expected result

You get fast in-scene visual comments that can also be captured into manual BCF snapshots.

Notes and limits

Markup is separate from the paid technical drawing editor.
The toolbar tracks whether markup is active and whether unsaved overlay changes exist.

Best practice

Capture a BCF snapshot after adding markup if you want the note to travel with an issue package.

Validation, Coordination, and Reporting

These panels support compliance checks, clash review, issue packaging, classification, and exports.

Jump to a section

IDS Validation Clash Detection BCF Issues Classification Drawing Module Report Export

IDS Validation

Purpose

Load an IDS XML file, validate the model against its rules, and turn failures into trackable issues.

When to use it

Use this when you need to confirm that model content matches exchange requirements or office standards.

Where to find it

Side panel tab: `IDS`.

Main options or inputs

Input file: IDS XML.
Result filters: `FAIL`, `PASS`, or `ALL`.

How to use it

1. Open the `IDS` tab and load an IDS file.
2. Click `Run Validation` once the model and IDS file are both ready.
3. Filter the grouped results, click a failing element to isolate and zoom it, and create or open the related BCF issue if needed.

Expected result

You get rule-based pass and fail results grouped by specification, plus element-level issue details.

Notes and limits

Validation needs model metadata to be loaded first.
Failing elements can be highlighted in batch or converted into BCF issues for follow-up.

Best practice

Start with the `FAIL` filter so you review only exceptions before checking the wider pass summary.

Clash Detection

Purpose

Run model-to-model or in-model clash checks with a configurable entity matrix and tolerances.

When to use it

Use this for BIM coordination, model auditing, and targeted checks between selected IFC entity types or model pairs.

Where to find it

Side panel tab: `Clashes`.

Main options or inputs

Mode: `internal` for one model or `federated` for model-to-model checks.
Clash matrix: enable or disable IFC type pairs.
Tolerances: horizontal, vertical, optional volume tolerance, and minimum reportable volume.
Clash classes: duplicate, inside, and overlapping.
Optional `.clss` import to limit scope using a classification file.

How to use it

1. Choose the clash mode and, if needed, the active model or model pair.
2. Adjust the matrix so only the relevant type combinations stay enabled.
3. Set tolerances and run the clash detection pipeline, then inspect grouped results, isolate clash pairs, or export selected clashes to BCF.

Expected result

You receive grouped clash results with viewer integration, clash metrics, and exportable issue selections.

Notes and limits

A custom imported `.clss` scope can restrict the run and may block detection until the imported file resolves correctly.
The panel supports docking and undocking for longer review sessions.

Best practice

Reduce the matrix first. Smaller, intentional checks are easier to review than one large catch-all run.

BCF Issues

Purpose

Create, edit, import, and export coordination issues with viewpoints, comments, and snapshots.

When to use it

Use this when review findings need to leave the viewer and become shareable coordination tasks.

Where to find it

Side panel tab: `BCF`.

Main options or inputs

Issue fields: title, description, priority, status, type, assignee, and due date.
Optional snapshot capture and linked selected elements.
Import and export formats: `.bcfzip` and XLSX.

How to use it

1. Select one or more elements if the issue should stay linked to model components.
2. Capture a snapshot if you want a visual reference, then create the issue.
3. Edit existing issues to add comments, update metadata, restore viewpoints, or export the issue list.

Expected result

You get BCF-style coordination issues that can be reviewed inside ExyViewer or handed off externally.

Notes and limits

Snapshots can combine the model view with the current markup overlay.
Imported BCF packages can be reopened, edited, and exported again from the panel.

Best practice

Use clear assignee and due-date fields when you expect the issue list to become an action register.

Classification

Purpose

Create rule-based classification layers, color the model, calculate metrics, and export scope files or workbooks.

When to use it

Use this when you need a reusable filtered view of the model based on metadata, property sets, property values, or nested classifications.

Where to find it

Side panel tab: `Classification`.

Main options or inputs

Classification layers with colors and duplicate support.
Criteria sources: query-based rules or existing classifications.
Query dimensions include IFC type, metadata fields, property-set names, property names, and property values.
Export options include templates, custom headers, chosen columns, formula rows, element rows, XLSX export, and `.clss` scope export.

How to use it

1. Create a classification and add one or more layers.
2. Choose the rule source, define the query or referenced classification, then review the matched candidates and metrics.
3. Apply colors in the viewer, isolate a result if needed, and export either the workbook or the `.clss` scope file.

Expected result

The model can be filtered and color-coded by a repeatable logic set, and the result can be reused in clash scope workflows or downstream reporting.

Notes and limits

Later classifications visually override earlier ones when the same element belongs to more than one layer.
A `.clss` export requires at least one resolved classification with matched elements.

Best practice

Use classification exports when you want the same scope to drive both reporting and clash review.

Drawing Module

Purpose

Generate technical views, place measurements and annotations, and export sheet outputs.

When to use it

Use this when you need review drawings, paper-space style dimensions, or lightweight technical deliverables from the viewer.

Where to find it

Side panel tab: `Drawing`.

Main options or inputs

Measurement tools: dimension, angle, slope, tape, and area.
Measurement preferences: colors, units, precision, font size, and text offset.
Technical editor tools: leader, callout, and symbol placement.
View tools: smart views, storey plans, context elevations, capture current view, open split view, and close views.
Export formats: SVG, PDF, PNG, and DXF with toggles for measurements, annotations, and custom drawings.

How to use it

1. Generate a smart view, storey plan, elevation, or capture the current scene.
2. Open a generated view in split mode when you need official technical editor tools such as dimensions, angles, slope tags, leaders, callouts, or symbols.
3. Add annotations or manual drawings, then export the sheet in the format that matches your downstream workflow.

Expected result

You get view-based measurements and annotations tied to a drawing workspace, plus export-ready technical outputs.

Notes and limits

Official technical editor tools only work on generated plan or elevation views opened in the split pane.
Manual SVG markup inside the drawing module is separate from the lighter top-toolbar markup overlay.

Best practice

Use `Smart Views` first. It prefers storey plans for buildings and falls back to context elevations for infrastructure-style models.

Report Export

Purpose

Export validation results, clash results, and BCF issue data in report-friendly formats.

When to use it

Use this after running IDS validation, clash detection, or issue creation when you need files for review, archiving, or handoff.

Where to find it

Side panel tab: `Report`.

Main options or inputs

Formats: JSON, CSV, and XLSX.
Include toggles: IDS validation, clash results, and BCF issues depending on available data and selected format.

How to use it

1. Open `Report` after the relevant analysis has been completed.
2. Choose the export format and enable the data blocks you want to include.
3. Run the export and use the generated file names based on the model name and timestamp.

Expected result

You receive machine-readable or spreadsheet-friendly output without re-running the analysis.

Notes and limits

XLSX supports validation and BCF issue export, while clash CSV export stays in the CSV path.
The panel stays disabled until at least one analysis result or issue exists.

Best practice

JSON is best for system-to-system reuse; CSV and XLSX are better for review meetings and manual follow-up.

REVIT ADD-IN

JaMo App

JaMo App is a Revit add-in with a real ribbon command surface in the current refactor repository. This section documents the live panel structure, command names, and the main use cases exposed in code.

Coverage below is based on the current `Calculator1980/JaMoApp_refactor` ribbon setup, command classes, tooltips, and related implementation notes for Revit 2024, 2025, 2026, and 2027.

Choose the Correct Revit Edition and License Term

Purpose

Make sure the user downloads the installer that matches the correct Revit year and license duration.

When to use it

Use this before purchase, during procurement, and before sharing a download link with a user.

Where to find it

Website product selection, checkout metadata, dashboard downloads, and license emails.

Main options or inputs

Supported product editions in repository metadata: Revit 2024, 2025, 2026, and 2027.
License terms in repository mappings: 3-month, 6-month, and 1-year.

How to use it

1. Confirm which Revit version the user runs.
2. Choose the matching JaMo App product edition and license term.
3. Use the matching installer file and download mapping for that exact combination.

Expected result

The user receives the installer that matches both the Revit year and the purchased license period.

Notes and limits

The repository contains explicit MSI mappings for each supported edition and term.
Using the wrong edition can lead to installation or activation mismatch later in the process.

Best practice

Treat the Revit year as a hard requirement, not a preference.

Install and Activate JaMo App

Purpose

Install the MSI, enter the delivered activation keys, and unlock the ribbon commands inside Revit.

When to use it

Use this after purchase, after receiving a demo package, or whenever a new workstation must be activated.

Where to find it

Website download flow, purchase or demo email, installer prompts, and the JaMo App ribbon after installation.

Main options or inputs

Activation uses a license key plus hash key.
The refactor repo includes installer, license-service, and About-window flows for activation and later validation.
Most ribbon commands stay disabled until license validation succeeds.

How to use it

1. Download the MSI that matches the target Revit year.
2. Run the installer and enter the activation keys when prompted.
3. Open Revit and confirm that the `JaMoApp` tab appears with its panels.
4. If commands remain disabled, open `About` and complete or re-check license activation.

Expected result

JaMo App loads into Revit and the licensed commands become available after validation.

Notes and limits

The codebase checks stored license data at startup and refreshes button states from the result.
The `About` command remains available even when the license is invalid so users can recover access.

Best practice

Keep the activation email open during install so you can copy the keys without interrupting setup.

About and License Recovery

Purpose

Open the JaMo App information window, review license status, and reach the purchase or activation path when other commands are locked.

When to use it

Use this when JaMo App starts with disabled commands, when a license has expired, or when a user needs product or license status information.

Where to find it

JaMoApp tab, `Info` panel, `About` button.

Main options or inputs

The `About` button is always enabled.
The About window is the supported access point for purchase and activation recovery when licensing blocks the rest of the ribbon.

How to use it

1. Open `About` from the `Info` panel.
2. Review the displayed license state, expiry, and activation status.
3. Use the available purchase or activation actions if the add-in is not currently licensed.

Expected result

The user can inspect the current license state and recover access without reinstalling the add-in.

Notes and limits

Button-state logic in the repo explicitly keeps `About` enabled while other commands can be disabled.
This command is the safe entry point when users report that the ribbon is visible but unusable.

Best practice

Check `About` first before troubleshooting deeper license or deployment issues.

Check Compatibility Before Deployment

Purpose

Confirm that the workstation and Revit environment meet the documented JaMo App prerequisites.

When to use it

Use this before individual installs or enterprise rollout.

Where to find it

Installer planning, deployment scripts, website product metadata, and the refactor repository build matrix.

Main options or inputs

Operating system: Windows 10 or 11, 64-bit.
Supported Revit editions reflected in the web and add-in repos: 2024, 2025, 2026, and 2027.
The add-in uses version-specific builds and API compatibility handling for these Revit releases.

How to use it

1. Verify the user machine is on a supported Windows version.
2. Verify the user has the target Revit year installed.
3. Confirm you are deploying the correct JaMo App build for that Revit year.
4. Check required runtime and installer prerequisites before large rollout.

Expected result

You reduce failed installs and avoid handing out builds to unsupported workstations.

Notes and limits

The refactor repository includes installer scripts and per-version build handling rather than one universal binary.
If your internal IT image adds other prerequisites, keep those documented separately from the public manual.

Best practice

Confirm compatibility before generating a batch deployment package.

Pset_Parameters Panel

These commands focus on parameter browsing, checking, and auditing inside the active Revit model or family.

Jump to a section

Parameters Parameter Checker PaRadar

Parameters

Purpose

Browse shared parameters and run parameter calculations through the dedicated JaMo App parameters window.

When to use it

Use this when you need to inspect parameter values, work through shared-parameter workflows, or apply calculation logic from the add-in.

Where to find it

JaMoApp tab, `Pset_Parameters` panel, `Parameters` button.

Main options or inputs

Runs through `ParametersWindow` with a parameter service and calculation service.
Uses the active Revit document and opens as a modeless window.

How to use it

1. Open `Parameters` from the `Pset_Parameters` panel.
2. Review the available parameter data and choose the calculation or browsing workflow you need.
3. Leave the window open while continuing to work in Revit if needed.

Expected result

You can inspect and work with shared parameters without leaving the Revit session.

Notes and limits

This command checks the license before opening.
The command uses a single-instance window pattern, so clicking it again should refocus the existing window instead of opening duplicates.

Best practice

Use this as the base parameter workspace before switching to specialized audit or mapping commands.

Parameter Checker

Purpose

Check for parameter presence and color elements based on the check result.

When to use it

Use this when you need a fast visual review of whether required parameters exist across visible elements.

Where to find it

JaMoApp tab, `Pset_Parameters` panel, `Parameter Checker` button.

Main options or inputs

Launches the `ParameterCheckerWindow` against the current `UIDocument`.
Built for quick checking and color feedback rather than long-form reporting.

How to use it

1. Open `Parameter Checker`.
2. Choose the parameter or checking scope in the dialog.
3. Run the check and review the color-coded result in the model.

Expected result

Elements can be checked and visually distinguished by parameter status directly in Revit.

Notes and limits

This command is practical for quick QA sweeps before more formal mapping or IDS work.
Unlike several newer commands, the command file does not currently perform an explicit license check before window launch.

Best practice

Use it early to spot missing data visually before exporting or validating against external requirements.

PaRadar

Purpose

Open the parameter audit dashboard to filter, analyze, and manage project and family parameters with color-coded status indicators.

When to use it

Use this when you need a broader parameter audit view than the simple checker, especially across project and family content.

Where to find it

JaMoApp tab, `Pset_Parameters` panel, `PaRadar` button.

Main options or inputs

Requires an active Revit document.
Launches a modal dashboard window and passes the active `UIDocument` into the audit workflow.
Designed for filtering, analysis, and status-led review.

How to use it

1. Open `PaRadar` from the ribbon.
2. Filter the parameter inventory or audit scope based on the current model or family context.
3. Review the dashboard status indicators and use the findings to guide cleanup or follow-up actions.

Expected result

You get a more structured audit of project and family parameters than a one-off visual check.

Notes and limits

The command shows a clear error if no active document is available.
The ribbon tooltip positions PaRadar as an audit dashboard rather than a parameter editor.

Best practice

Use PaRadar when you need to understand parameter health across a wider scope, not just check one field.

Family_Panel

These commands support geometry-heavy modeling workflows directly in Revit.

Jump to a section

Mass Surface FloorFromTopo

Mass Surface

Purpose

Create mass-surface geometry through the dedicated JaMo App mass workflow window.

When to use it

Use this when you need fast geometry generation support for conceptual or geometry-heavy modeling tasks.

Where to find it

JaMoApp tab, `Family_Panel`, `Mass Surface` button.

Main options or inputs

Opens the `MassSurfaceWindow` against the active `UIDocument`.
Runs as a focused modal workflow.

How to use it

1. Open `Mass Surface`.
2. Provide the required mass-surface inputs in the dialog.
3. Review the created result in Revit and continue with normal refinement if needed.

Expected result

You can generate geometry through a guided JaMo App workflow instead of building everything manually.

Notes and limits

The ribbon tooltip is concise, so the code confirms the command exists but not every field in the modeling dialog.
This is the current ribbon command that best matches the earlier mass-modeling messaging on the website.

Best practice

Use this where repeatable geometric setup matters more than one-off manual sculpting.

FloorFromTopo

Purpose

Create or reshape a floor from a selected Toposolid by projecting dense topo-derived points into the floor slab shape.

When to use it

Use this when a project floor must follow site or terrain conditions more closely than a flat slab allows.

Where to find it

JaMoApp tab, `Family_Panel`, `FloorFromTopo` button.

Main options or inputs

Requires selecting one Toposolid and one Floor.
Uses slab-shape editing and dense sampled points from the selected Toposolid edges.

How to use it

1. Click `FloorFromTopo`.
2. Select the source Toposolid when prompted.
3. Select the floor to modify.
4. Let JaMo App rebuild the slab-shape points from the topographic geometry.

Expected result

The chosen floor receives a denser shape edit driven by the selected Toposolid.

Notes and limits

This is the command behind the site-adaptation use case often described as `Floor-to-Topo` in existing website content.
The command writes directly to the selected floor, so it needs a writable document and a floor that supports slab-shape editing.

Best practice

Use a clean source Toposolid and a target floor with a stable boundary before running the command.

OpenBIM_Panel

This panel contains the newest and most specialized JaMoApp commands for IFC mapping, IDS workflows, quantity and property-set mapping, phasing, and georeferencing.

Jump to a section

IFCmap Pset_map Qto_map IDS Spec IDS_Map PH4D BIMGeoRef

IFCmap

Purpose

Assign IFC export entities to elements visible in the active filtered view.

When to use it

Use this before IFC export, before Pset or Qto mapping, and whenever you need a controlled export classification for visible model elements.

Where to find it

JaMoApp tab, `OpenBIM_Panel`, `IFCmap` button.

Main options or inputs

Works against elements in the active view.
Needs a writable document.
Supports IFC schema exploration and entity assignment workflows.

How to use it

1. Open the target Revit view and filter it to the elements you want to process.
2. Launch `IFCmap`.
3. Review the visible elements and assign the intended IFC export entities.

Expected result

Elements in the current view can receive IFC entity assignments for downstream export and mapping workflows.

Notes and limits

The command can still open when the active view has no elements, but mapping is only useful once elements are visible.
This is the foundation command for later `Pset_map` and `Qto_map` work.

Best practice

Start from a tightly filtered working view so entity assignment stays deliberate and reviewable.

Pset_map

Purpose

Validate and attach buildingSMART standard property sets to elements in the active view.

When to use it

Use this after IFC entities are assigned and before IFC delivery, IDS checks, or exchange-quality reviews.

Where to find it

JaMoApp tab, `OpenBIM_Panel`, `Pset_map` button.

Main options or inputs

Requires a writable document and an active view with visible elements.
Intended for elements that already have IFC entity assignments via `IFCmap`.

How to use it

1. Prepare an active view with the elements you want to process.
2. Confirm IFC mapping has already been applied where needed.
3. Open `Pset_map` and run the property-set validation and attachment workflow.

Expected result

The selected scope can be checked against standard property-set expectations and updated accordingly.

Notes and limits

The command opens modelessly so users can keep interacting with Revit.
If the active view is empty, the command cancels early because there is nothing to attach property sets to.

Best practice

Run IFC entity mapping first. Pset work is cleaner when the export entity is already known.

Qto_map

Purpose

Validate and attach buildingSMART standard quantity sets to elements in the active view.

When to use it

Use this when quantity metadata must be prepared for IFC exchange, QA, or downstream measurement workflows.

Where to find it

JaMoApp tab, `OpenBIM_Panel`, `Qto_map` button.

Main options or inputs

Requires a writable document and an active view with visible elements.
Designed for elements already prepared through `IFCmap`.

How to use it

1. Open a working view containing the target elements.
2. Confirm IFC entity assignments are already in place.
3. Launch `Qto_map` and run the quantity-set workflow.

Expected result

Elements can be checked and updated against standard quantity-set requirements.

Notes and limits

Like `Pset_map`, this command is view-scoped and expects visible elements.
Use it when the deliverable depends on richer quantity metadata, not only geometry export.

Best practice

Keep Qto mapping in the same scoped view you used for IFC entity assignment to reduce mismatches.

IDS Spec

Purpose

Open the IDS editor and model-checking workflow for buildingSMART IDS-based validation.

When to use it

Use this when you need to load, create, edit, or validate Information Delivery Specifications against the model.

Where to find it

JaMoApp tab, `OpenBIM_Panel`, `IDS Spec` button.

Main options or inputs

Based on IDS 1.0 style workflows in the refactor repo.
Uses document, validation, and IFC-mapping services together.
Opens as a modeless single-instance window.

How to use it

1. Open `IDS Spec`.
2. Load or create the IDS definition you want to work with.
3. Run the validation workflow and review the resulting compliance findings.

Expected result

You can manage IDS specifications and validate the active model against them from inside Revit.

Notes and limits

This is the validation and editing side of the IDS workflow.
The repo keeps this window single-instance so repeated clicks reactivate the current session.

Best practice

Use `IDS Spec` for rule authoring and validation, then use `IDS_Map` when the goal is correcting values.

IDS_Map

Purpose

Set required IDS values on elements by scanning the active view for wrong or empty values and helping correct them.

When to use it

Use this after IDS requirements are defined and you need to fix noncompliant property values instead of only reporting them.

Where to find it

JaMoApp tab, `OpenBIM_Panel`, `IDS_Map` button.

Main options or inputs

Needs a writable document.
Works as the value-setting companion to `IDS Spec`.
Focuses on wrong or empty property and attribute values.

How to use it

1. Open the model and ensure the document is editable.
2. Launch `IDS_Map`.
3. Load the relevant IDS content, review mismatches, and apply required values to the target elements.

Expected result

Noncompliant IDS-related values can be corrected from within the add-in instead of being left as a report-only issue.

Notes and limits

The command is explicitly described in code as a value setter, not only a checker.
Use this carefully in controlled scopes because it writes back to model data.

Best practice

Use a scoped active view before running IDS_Map so corrective writes stay focused and reviewable.

PH4D

Purpose

Create 4D BIM phasing workflows with phase templates, view instances, and animated construction sequences.

When to use it

Use this when teams need to simulate build sequence, organize phasing views, or present a construction timeline inside Revit.

Where to find it

JaMoApp tab, `OpenBIM_Panel`, `PH4D` button.

Main options or inputs

Requires a writable document and an active view.
Depends on numeric project parameters in the phasing group, such as `JM_Existing`, `JM_Demolished`, `JM_TEMporary`, and `JM_New`.
Supported in the refactor repo for Revit 2024 through 2027.

How to use it

1. Prepare the required phasing parameters and assign values to elements.
2. Open `PH4D` and build or review the phase templates and rows.
3. Run the simulation or view-generation workflow to inspect the construction sequence.

Expected result

You can organize phased views and run a progressive 4D construction-style visualization where elements appear over time.

Notes and limits

Implementation notes in the repo describe the newer behavior as a true timeline visualizer instead of a simple template switcher.
If the required JM_* parameters are missing, the command warns before continuing.

Best practice

Treat parameter preparation as part of setup. PH4D is strongest when phase values are clean and consistent before simulation begins.

BIMGeoRef

Purpose

Validate and correct IFC4 georeferencing to reach LoGeoRef 50 quality.

When to use it

Use this before IFC delivery when GIS alignment, projected CRS metadata, or map-conversion quality must be checked and corrected.

Where to find it

JaMoApp tab, `OpenBIM_Panel`, `BIMGeoRef` button.

Main options or inputs

Targets IFC4 georeferencing workflows.
Covers checks around `IfcProject`, `IfcGeometricRepresentationContext`, `IfcMapConversion`, and `IfcProjectedCRS`.
The related PRD describes editable values such as EPSG, easting, northing, height, axis rotation, and scale.

How to use it

1. Open `BIMGeoRef`.
2. Run the validation workflow on the IFC georeferencing data.
3. Review failed rules, edit the required georeferencing values, and save the corrected IFC output where needed.

Expected result

You can inspect IFC georeferencing quality and correct missing or malformed data before exchange.

Notes and limits

The implementation is positioned specifically around IFC4 and LoGeoRef 50 workflows.
This command is intended for model exchange quality, not for general-purpose Revit coordinate management.

Best practice

Use BIMGeoRef near the end of the IFC-prep workflow, after entity and property mapping are already in good shape.

Visual references

This structure supports real screenshots later. No fabricated UI images were added where the repository does not provide actual captures.

Need help choosing the right tool?

Use this handbook to self-serve first, then contact the team if you need a walkthrough, a demo, or help matching the right product to your workflow.

Request a Demo Open documentation