DIQ_DimensionGroupFolder

Last updated 27/02/2026

Purpose

The

DIQ_DimensionGroupFolder

type represents a logical folder used to organize dimension groups within a project in DimensionIQ.

It defines the structual and descriptive metadata required for the DimensionIQWidget to correctly group, display, and associate collections of dimensions within a project.

A

DIQ_DimensionGroupFolder

enables:

• Logical grouping of related dimension sets
• Hierarchical folder organization
• Clear association between dimension groups and a project
• Structured navigation within the widget UI
• Clean separation of organizational structure from dimension data

This is commonly used when:

• Creating or organizing dimension groups
• Structuring project measurement data
• Displaying folder hierarchies in the UI
• Persisting dimension group organization
• Managing nested dimension categories

By standardizing the folder structure, DimensionIQ ensures predictable grouping behavior and consistent project organization.

Why This Type Exists

As projects grow, dimension data can become complex and difficult to manage without structure. Measurements may be grouped by things such as:

• Trade (electrical, structual, architectural)
• Area or level
• Drawing sheet
• Scope or package
• Phase of work

The

DIQ_DimensionGroupFolder

type exists to:

• Provide a structured container for organizing dimension groups
• Support hierarchical folder relationships
• Decouple organizational structure from dimension data itself
• Enable clean UI navigation and filtering
• Maintain project-scoped grouping integrity

Because dimension data is often extensive and multi-layered, the widget requires a clear structural contract defining how folders are represented and associated. The

DIQ_DimensionGroupFolder

provides that contract.

Properties

Properties	Type	Required	Description
key	string	Yes	Unique identifier for the dimension group folder
parentFolderKey	string	No	References the parent folder for hierarchical organization
projectKey	string	Yes	Identifies the project this folder belongs to
name	string	Yes	Display name of the folder shown in the UI
notes	string	No	Optional free-text notes or description associated with the dimension group folder

Behavioral Expectations

Identity and Association

• key
  must be unique and stable
• projectKey
  must reference an existing project
• parentFolderKey
  optional reference to a valid folder within the same project
• Folder hierarchies must not create circular references

A dimension group folder cannot exist outside the context of a project.

Hierarchical Structure

• parentFolderKey
  defines nesting
• Nested folders enable multi-level organization
• Folder structure determines UI tree rendering

The widget may render these folders as a collapsible tree.

Organizational Behavior

• The folder does not store dimension data directly
• Dimension groups reference the folder via its
  key
• Renaming a folder does not modify associated dimension data
• Moving a folder updates the
  parentFolderKey

Display Behavior

• name
  is the primary user-facing label
• notes
  may be shown in metadata panels or tooltips
• Folder hierarchy influences sorting and navigation
• The project context determines visibility scope

Summary

DIQ_DimensionGroupFolder

defines the structured container used to organize dimension groups within a project in DimensionIQ.

It ensures that measurement data can be logically grouped, hierarchically structured, and cleanly associated with a project context.

By separating organizational structure from dimension data itself, DimensionIQ provides scalable, navigable, and predictable dimension management for host integrations.