DIQ_VariableFolder

Last updated 21/07/2026

Overview

The

DIQ_VariableFolder

type represents a folder used to organise

DIQ_Variable

objects within a hierarchical structure.

It allows variables to be grouped using a tree-based folder structure, making them easier to navigate, manage, and search within DimensionIQ and the host application.

Folders may contain child folders, allowing nested structures such as a/b/c to be created using the

parentFolderKey

relationship.

Unlike constants, which are global and available across all projects, variables belong to a specific

DIQ_Project

. The

projectKey

property identifies the project that owns the folder hierarchy, allowing each project to maintain its own independent variable organisation.

DIQ_VariableFolder

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_VariableFolder

records using the values supplied by DimensionIQ and may use them to provide folder navigation, filtering, searching, and organization of variables.

Properties

Property	Type	Required	Description
key	string	Yes	Unique identifier for the variable folder
parentFolderKey	string	Yes	References the parent DIQ_VariableFolder and defines the folder hierarchy
projectKey	string	Yes	References the DIQ_Project that owns this folder hierarchy
name	string	Yes	Display name of the folder

Implementation Guidelines

Data Persistence

DIQ_VariableFolder

objects should be persisted exactly as provided by DimensionIQ.

The host application should not create or modify folder metadata. When a new folder is received it should be persisted, and when an updated folder is received the existing record should be updated using the values supplied by DimensionIQ.

Folder Hierarchy

The

parentFolderKey

property defines the parent-child relationship between folders, allowing nested folder structures to be constructed and displayed.

The host application should preserve these relationships exactly as provided by DimensionIQ to ensure the hierarchy remains consistent.

Project Relationship

The

projectKey

property identifies the

DIQ_Project

that owns the variable folder hierarchy.

Because variables are project specific, each project maintains its own independent folder structure. This differs from

DIQ_ConstantFolder

, which organizes global constants shared across all projects.

Variable Organization

DIQ_VariableFolder

provides the organizational structure for

DIQ_Variable

objects.

The host application may use the folder hierarchy for browsing, filtering, and searching variables but should not modify the structure managed by DimensionIQ.

Read-Only Behavior

All

DIQ_VariableFolder

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

The host application may read and use stored folder information but should not modify:

• The identifier -
  key
• The parent relationship -
  parentFolderKey
• The associated project -
  projectKey
• The folder name -
  name

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

DIQ_VariableFolder

object for persistence.