DIQ_Constant
Overview
The
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
The host application is responsible for persisting
The host application may use persisted
Properties
| Property | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Unique identifier for the constant |
constantFolderKey | string | Yes | References the DIQ_ConstantFolder used to organize this constant within the folder hierarchy |
name | string | Yes | Display name of the constant used when referencing or identifying the value |
value | string | Yes | The stored constant value used within formulas |
unit | string | Yes | Unit of measurement associated with the constant value |
Implementation Guidelines
Data Persistence
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
Constant Folder Relationship
The
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
The
DimensionIQ is responsible for resolving and applying constants when evaluating formulas.
Read-Only Behavior
All
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