DIQ_DimensionGroupRevision
Overview
The
It contains the measurement configuration, display settings, calculated totals, and revision relationships required for DimensionIQ to display, organize, and report grouped measurements.
The host application is responsible for persisting
The host application may use the persisted data for business workflows such as quantity reporting, estimating, cost analysis, exports, dashboards, and other application-specific processes.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Unique identifier for the dimension group revision |
folderKey | string | No | References the folder that organizes the group |
revisionKey | string | Yes | Identifies the revision this group belongs to |
previousDimensionGroupRevisionKey | string | No | References the previous revision of this dimension group, allowing revision history to be tracked |
name | string | Yes | Display name of the dimension group |
displayType | string | Yes | Controls how measurements are visually displayed in the UI |
measurementMode | string | Yes | Defines how dimensions are measured and aggregated |
positiveColor | string | Yes | Color applied to positive dimensions |
negativeColor | string | Yes | Color applied to negative dimensions |
defaultHeight | number | No | Default height applied to dimensions within the group |
defaultOffset | number | No | Default offset applied to dimensions within the group |
count | number | Yes | Aggregated count |
length | number | No | Aggregated horizontal length |
elevatedLength | number | No | Aggregated elevated or sloped length |
area | number | No | Aggregated calculated surface area |
verticalArea | number | No | Aggregated vertical surface area |
volume | number | No | Aggregated calculated volume |
weight | number | No | Aggregated calculated weight |
notes | string | No | Optional descriptive notes for the group revision |
Implementation Guidelines
Data Persistence
The host application is responsible for selecting and maintaining its own storage mechanism. This may include relational databases, document databases, file storage, object storage, or any other persistence solution appropriate for the application.
The host application should not create, calculate, or modify
When a new
Measurement Data Usage
The aggregated measurement values contained within a
Properties such as
These values should be treated as authoritative outputs generated by DimensionIQ.
Revision Relationships
Each
Where provided,
The host application should persist these relationships as provided by DimensionIQ.
Configuration Data
Properties such as
These values should be stored without modification to ensure the group can be accurately reconstructed when requested by DimensionIQ.
Read-Only Behavior
All
The host application may read and use the stored data for its own reporting and business workflows but should not modify configuration settings, calculated totals, identifiers, or revision relationships.
Any changes to a dimension group revision are performed by DimensionIQ, which will provide the updated object to the host application for persistence.