DIQ_ConstantFolder

Last updated 21/07/2026

Overview

The

DIQ_ConstantFolder

type represents a folder used to organize

DIQ_Constant

objects within a hierarchical structure.

It allows constants to be grouped and stored using a tree-based folder structure, making constants easier to navigate, manage, and search within the host application or DimensionIQ user interfaces.

Folders can contain child folders, allowing nested structures to be created using parent-child relationships. For example, a folder hierarchy such as a/b/c can be represented using multiple

DIQ_ConstantFolder

objects, where each folder references its parent folder.

DIQ_ConstantFolder

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_ConstantFolder

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

The host application may use persisted

DIQ_ConstantFolder

objects to provide folder navigation, filtering, searching, and organization of constants within application specific workflows.

Properties

Property	Type	Required	Description
key	string	Yes	Unique identifier for the constant folder
parentFolderKey	string	Yes	References the parent DIQ_ConstantFolder , used to create hierarchical folder structures
name	string	Yes	Display name for the folder, used when rendering navigable folder trees and user interfaces

Implementation Guidelines

Data Persistence

DIQ_ConstantFolder

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 or modify

DIQ_ConstantFolder

metadata. DimensionIQ is responsible for maintaining folder definitions, names, and parent-child relationships.

When a new

DIQ_ConstantFolder

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.

Folder Hierarchy

The

parentFolderKey

property defines the relationship between folders and is used by DimensionIQ and the host application to construct the folder tree.

Root-level folders do not have a parent folder reference, while child folders reference their parent folder using

parentFolderKey

. This allows nested folder structures to be represented and stored, such as a/b/c.

The host application should preserve these relationships exactly as provided by DimensionIQ to ensure the folder structure remains consistent when displaying, searching, or grouping constants.

Constant Organization

DIQ_ConstantFolder

provides the organizational structure used to group

DIQ_Constant

objects.

The host application may use the folder hierarchy to allow users to browse and locate constants more efficiently. Constants stored within folders can be grouped logically based on application requirements while maintaining a consistent structure across systems.

The host application should not use

DIQ_ConstantFolder

as a replacement for constant data management. The folder structure exists to organise and classify constants, while the actual constant definitions remain managed through

DIQ_Constant

objects.

Read-Only Behavior

All

DIQ_ConstantFolder

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

The host application may read and use stored folder information for navigation and organization but should not modify the folder identifier, parent relationships, or display names.

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

DIQ_ConstantFolder

object to the host application for persistence.