Skip to main content

DIQ_Constant

Last updated 21/07/2026

Overview

The

DIQ_Constant
type represents a reusable constant value that can be referenced within formulas in DimensionIQ.

It contains the metadata required to define a constant, including its name, value, and unit of measurement. Constants allow commonly used values to be stored once and referenced within formulas rather than being manually entered multiple times.

The

constantFolderKey
property associates the constant with a
DIQ_ConstantFolder
, allowing constants to be organised within a hierarchical folder structure for easier navigation, management, and searching.

DIQ_Constant
objects are created and maintained by DimensionIQ and should be treated as managed metadata by the host application.

The host application is responsible for persisting

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

The host application may use persisted

DIQ_Constant
objects for application specific workflows including formula configuration, reporting, estimating, configuration displays, and integration with external business systems.

Properties

PropertyTypeRequiredDescription
key
string
YesUnique identifier for the constant
constantFolderKey
string
YesReferences the
DIQ_ConstantFolder
used to organize this constant within the folder hierarchy
name
string
YesDisplay name of the constant used when referencing or identifying the value
value
string
YesThe stored constant value used within formulas
unit
string
YesUnit of measurement associated with the constant value

Implementation Guidelines

Data Persistence

DIQ_Constant
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_Constant
values. DimensionIQ is responsible for maintaining constant definitions and the values used by formulas. When a new
DIQ_Constant
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.

Constant Folder Relationship

The

constantFolderKey
property identifies the
DIQ_ConstantFolder
that contains the constant.

This relationship should be preserved exactly as provided by DimensionIQ to maintain the association between the constant and its location within the folder hierarchy.

The host application may use this relationship to display, filter, and search constants using the folder structure defined by DimensionIQ.

Formula Usage

DIQ_Constant
objects provide reusable values that can be referenced within DimensionIQ formulas.

The

name
,
value
, and
unit
properties define the constant available for use. The host application may display and manage these values for user-facing workflows but should not interpret or modify how constants are used within formulas.

DimensionIQ is responsible for resolving and applying constants when evaluating formulas.

Read-Only Behavior

All

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

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

  • The identifier -
    key
  • The folder relationship -
    constantFolderKey
  • The constant name -
    name
  • The stored value -
    value
  • The unit of measurement -
    unit

Any changes to constants should be performed through DimensionIQ, which will provide the updated

DIQ_Constant
object to the host application for persistence.