DIQ_DimensionCustomValue

Last updated 21/07/2026

Overview

The

DIQ_DimensionCustomValue

type represents the calculated result of executing a

DIQ_CustomValue

definition against an individual

DIQ_Dimension

.

It contains the value generated by DimensionIQ using the formula defined within the associated

DIQ_CustomValue

object. Each

DIQ_DimensionCustomValue

represents the result of applying a specific custom value calculation to a specific dimension.

DIQ_DimensionCustomValue

objects are created and maintained by DimensionIQ and should be treated as read-only by the host application.

The host application is responsible for persisting

DIQ_DimensionCustomValue

records within its preferred storage system. When DimensionIQ creates or updates a dimension custom value, the complete object should be stored or updated using the values supplied by DimensionIQ.

The host application may use persisted

DIQ_DimensionCustomValue

objects for application specific workflows including reporting, estimating, dashboards, exports, analytics, and integration with external business systems.

Properties

Property	Type	Required	Description
key	string	Yes	Unique identifier for the dimension custom value result
dimensionKey	string	Yes	References the DIQ_Dimension that this calculated value applies to
customValueKey	string	Yes	References the DIQ_CustomValue definition used to generate this result
value	string	Yes	The calculated result produced from the associated DIQ_CustomValue formula

Implementation Guidelines

Data Persistence

DIQ_DimensionCustomValue

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, which may include databases, file storage, object storage, or other suitable persistence solutions.

The host application should not create, calculate, or modify

DIQ_DimensionCustomValue

values. DimensionIQ is responsible for maintaining these objects and providing the calculated results.

When a new

DIQ_DimensionCustomValue

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.

Dimension Relationship

The

dimensionKey

property identifies the

DIQ_Dimension

that the calculated custom value belongs to.

This relationship should be preserved exactly as provided by DimensionIQ to maintain the association between the calculated value and the source dimension.

A single

DIQ_Dimension

may have multiple

DIQ_DimensionCustomValue

objects, with each representing a different custom value calculation.

Custom Value Relationship

The

customValueKey

property identifies the

DIQ_CustomValue

definition used to generate the calculated result.

This relationship allows the host application to associate the calculated value with its custom value definition, including the custom value name, unit of measurement, and formula.

The host application should not attempt to interpret, evaluate, or modify the associated formula.

Read-Only Behavior

All

DIQ_DimensionCustomValue

properties should be considered read-only from the perspective of the host application.

The host application may read and use the stored values for its own workflows but should not modify:

• The identifier -
  key
• The associated dimension -
  dimensionKey
• The custom value definition -
  customValueKey
• The calculated result -
  value

Any changes to a dimension custom value should be performed through DimensionIQ by modifying the underlying dimension data or custom value definition. DimensionIQ will then provide the updated

DIQ_DimensionCustomValue

object to the host application for persistence.