DIQ_DimensionGroupFolder

Last updated 20/07/2026

Overview

The

DIQ_DimensionGroupFolder

type represents a logical folder used to organize dimension groups within a DimensionIQ project.

It contains the structural and descriptive metadata required for DimensionIQ to maintain hierarchical organization, display folder structures, and associate dimension groups with their project context.

DIQ_DimensionGroupFolder

objects are created and maintained by DimensionIQ. The values contained within the object are generated and managed by DimensionIQ and should be treated as read-only by the host application.

The host application is responsible for persisting

DIQ_DimensionGroupFolder

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

The host application may use the persisted folder data to support its own workflows, including organizing dimension groups, generating reports, maintaining project structures, or providing additional navigation and filtering capabilities.

Properties

Property	Type	Required	Description
key	string	Yes	Unique identifier for the dimension group folder
parentFolderKey	string	No	References the parent folder for hierarchical organization
projectKey	string	Yes	Identifies the project this folder belongs to
name	string	Yes	Display name of the folder shown in the UI
notes	string	No	Optional free-text notes or description associated with the dimension group folder

Implementation Guidelines

Data Persistence

DIQ_DimensionGroupFolder

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. This may include relational databases, document databases, file storage, object storage, or any other persistence solution appropriate for the application.

The host application should not create, calculate, or modify

DIQ_DimensionGroupFolder

values. DimensionIQ is responsible for generating and maintaining the folder structure and relationships contained within the object.

When a new

DIQ_DimensionGroupFolder

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 Relationships

The

projectKey

property identifies the project that owns the folder and should be stored as provided by DimensionIQ.

The optional

parentFolderKey

property defines the hierarchical relationship between folders. When provided, it references another folder within the same project.

The host application should preserve these relationships exactly as provided by DimensionIQ to ensure the folder hierarchy can be correctly reconstructed.

Folder hierarchies should not contain circular references.

Organizational Usage

DIQ_DimensionGroupFolder

provides organizational structure only and does not contain measurement data or dimension values.

Dimension groups reference folders to determine their location within the project hierarchy. The folder structure may be used by the host application to organize, filter, navigate, or report on dimension groups.

Changing the folder name or hierarchy does not modify the associated dimension data.

Display Behaviour

The

name

property represents the primary user-facing label for the folder.

The folder hierarchy defined through

parentFolderKey

may be used by DimensionIQ and the host application to display nested folder structures, navigation trees, or grouped measurement categories.

The optional

notes

property may be used to provide additional descriptive information within metadata views, reports, or application-specific interfaces.

Read-Only Behavior

All

DIQ_DimensionGroupFolder

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

The host application may read and use the stored folder data for its own workflows but should not modify identifiers, relationships, or metadata values.

Any changes to folder structure or properties should be performed through DimensionIQ, which will provide the updated

DIQ_DimensionGroupFolder

object to the host application for persistence.