Last updated 21/07/2026
Overview
The
DIQ_CustomValue
type represents the definition of a custom value associated with a DIQ_DimensionGroupRevision
.
It contains the metadata required for DimensionIQ to define custom values for a dimension group, including the custom value name, unit of measurement, and the formula used to
calculate the value for individual dimensions.
DIQ_CustomValue
objects are created and maintained by DimensionIQ. The values contained within the object are generated and managed by DimensionIQ and
should be treated as read-only by the host application.
The host application is responsible for persisting
DIQ_CustomValue
records within its preferred storage system, such as a database, file storage, or
object storage service. When DimensionIQ creates or updates a custom value definition, the complete object should be stored or updated using the values supplied by DimensionIQ.
When dimensions are created or updated within the associated dimension group, DimensionIQ uses the custom value definition to generate and maintain the corresponding
DIQ_DimensionCustomValue
objects. The host application may use the persisted custom value definitions for application specific workflows including
reporting, estimating, configuration displays, exports, and integration with external business systems.
Properties
| Property | Type | Required | Description |
|---|
key | string | Yes | Unique identifier for the custom value definition |
dimensionGroupRevisionKey | string | Yes | References the DIQ_DimensionGroupRevision this custom value belongs to |
name | string | Yes | Display name of the custom value |
UOM | string | Yes | Unit of measurement associated with the custom value |
formula | string | Yes | Formula used by DimensionIQ to calculate the custom value for dimensions within the associated dimension group |
Implementation Guidelines
Data Persistence
DIQ_CustomValue
objects should be persisted by the host application exactly as provided by DimensionIQ.
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
DIQ_CustomValue
values. DimensionIQ is responsible for generating and maintaining custom
value definitions and the formulas used to calculate custom values.
When a new
DIQ_CustomValue
is received from DimensionIQ, the host application should persist the object. When an updated object is received, the
existing stored record should be updated using the values supplied by DimensionIQ.
Custom Value Relationships
The
dimensionGroupRevisionKey
property identifies the dimension group revision that owns the custom value definition.
This relationship should be preserved exactly as provided by DimensionIQ to maintain the association between the custom value definition and the corresponding dimension group
revision.
DimensionIQ uses this relationship to determine which custom values should be generated for dimensions belonging to the associated dimension group.
Custom Value Definitions
Each
DIQ_CustomValue
defines a reusable custom value that applies to all dimensions within the associated dimension group.
The formula property defines how DimensionIQ calculates the corresponding DIQ_DimensionCustomValue
for each dimension. The host application is not
responsible for interpreting, evaluating, or modifying this formula.
The
name
property provides the primary user-facing identifier for the custom value, while the UOM
property specifies the unit
of measurement associated with the calculated value.
The host application may use these properties for reporting, estimating, exports, dashboards, or other application-specific workflows.
Read-Only Behavior
All
DIQ_CustomValue
properties should be considered read-only from the perspective of the host application.
The host application may read and use the stored custom value definitions for its own workflows but should not modify identifiers, relationships, units of measurement, formulas,
or other DimensionIQ managed metadata.
DIQ_CustomValue
definitions are used internally by DimensionIQ to generate and maintain DIQ_DimensionCustomValue
objects. Any
changes to a custom value definition should be performed through DimensionIQ, which will provide the updated DIQ_CustomValue
object to the host application
for persistence.