Understanding HUVR Nomenclature

To build anything with HUVR, you have to understand the core objects and their purpose. This is not an all encompassing list -- instead focusing on the most used features. These entities typically have a central data model, corresponding API, and other supporting data models.

Assets

Assets typically represent a physical object that is inspected, repaired, maintained etc. Assets use a nesting approach similar to a file system to handle arbitrary organization structures. In other systems, the asset data may correspond to an Equipment table. Unlike other rigidly defined hierarchy systems (e.g. Complex -> Equipment -> Component); HUVR handles simple and complex hierarchies together.

Assets are owned by a Company.

Company

An organization that owns assets, employees users, and can be assigned work (subcontractor). The connection to a company in HUVR plays a large part in data access.

Crews

Crews are individuals or groups of users. Crews are convenient way to assign work to a person or team. Crews can be isolated to a specific company (subcontractor crews).

Projects

Projects are a core unit of work inside HUVR. Projects can represent inspections, repairs, surveys or any variety of work. Customers have digitized thousands of different workflows to date.

Projects are bucket of work performed on an Asset by a set of users. Projects can be assigned to crews and/or a third-party vendor (subcontractor).
The details of the workflow for a project are defined by its Project Type. The contents of the project can handle media files, digital forms (called checklists in our API), structured meta data around inspection Findings, and detailed measurements for flows like Ultrasonic testing (UT).

The output of a project is delivered as a Report. HUVR supports multiple reports per project.

Checklists

Work instructions or digital forms to be completed by users are called checklists inside HUVR. The data model for a Checklist consists of multiple parts including a Checklist Template, a Checklist Instance, and individual changes (Checklist Edits). Checklist Instances are most commonly used connected to a project.

Inspection Media

The ability to store an unlimited amount of files organized with an Asset hierarchy is a core capability of HUVR. Inspection Media are the files and the metadata associated with them. Inspection Media is normally added to the system thru projects.

Report (Project Report)

A Report is a dynamically generated rendering of a project. These reports can be customized to filter specific data.

Defect (aka Finding)

For historical reasons, the API refers to Findings as Defects. The UI and end-user documentation typically will use the word Finding. However, the code uses defect. Defects are structured data to capture the where and what for an Asset. Defects are commonly associated with one or more Inspection Media files.

Defects are created/sourced from a Project, but are tied to an Asset and are useful to track the condition of a part over time.

Workspace

HUVR isolates customer data into individual tenants we call workspaces. These tenants are accessed through a unique subdomain assigned to the customer when they come onboard. The workspace url is required for all API calls.