Quintessence Studio – Overview
Quintessence Studio is a desktop application used to browse data, create reports and custom calculations, and manage security for users and groups. It provides a comprehensive set of tools for configuring, analysing, and extending the Quintessence environment.
This article specifically covers the modules and functionality available in Quintessence Studio version 25.1, providing a brief and concise overview of what each module does and how it is typically used.
Entity Browser
The Entity Browser allows users to look up entities and view their identifiers, TimeSeries, RelationshipData, and parent-child relationships. Multiple entities can be loaded at once, and users can switch between TimeSeries and relationship views to inspect values, effective dates, and related entities.
Relationships
The Relationships window defines and manages relationship types between parent and child entities. Users can configure read/write security, set defaults for the Relationship() and RelationshipPeriod() calls, and define preferred parameters for viewing relationship data in the Entity Browser.
TimeSeries
The TimeSeries window lets users define and manage TimeSeries types – data values associated with entities over time. Users can set value types, indicate whether the TimeSeries applies to an entity or a relationship, configure read/write permissions, and set defaults for the TimeSeries() calls. Preferred viewing parameters for the Entity Browser can also be defined here.
Collections
Collections allow users to group Entities, TimeSeries, and Relationships into organised sets. Collections can be created manually or via Data Feeds (recommended) and appear in the Entity Browser as a folder‑style hierarchy. They can also be returned programmatically via the Relationship() call.
Custom Sources
The Custom Sources window lets users define custom TimeSeries, Relationship, and RelationshipData sources for use wherever a Source parameter is required. These sources may combine multiple inputs, apply conditional logic, or retrieve data from external systems. Behaviour can vary by context (such as entity, period, or unit), allowing highly flexible sourcing rules.
Functions
The Functions window allows users to build custom functions that run in Quintessence Studio or any integrated third‑party application. Users define parameters, create logic in the equation editor, and test results directly. Functions can accept various parameter types and encapsulate reusable calculation logic across the system.
Reports
The Reports window enables users to create parameterised reports using the Quintessence equation editors. Reports can be organised into groups, tested in the editor, and used in Data Feeds, Functions, other reports, and third‑party integrations. They execute using parameters in their defined order, providing a consistent method for retrieving structured results.
Function Debug
Function Debug generates a calculation tree for any Quintessence function call, showing intermediate results, execution times, and node types. Users can drill into problem areas and launch directly to the underlying definition, making it an essential tool for diagnosing failing or incorrect logic.
Modules
The Modules window allows users to create reusable functions and classes that can be imported into reports. While similar in layout to Functions and Reports, the folder structure determines how module components are referenced. Modules help encapsulate complex or repeated logic for cleaner report design.
Scheduler
The Scheduler runs automated tasks on a schedule or adhoc basis, such as importing files, transforming data, or feeding data into the Quintessence database. Tasks consist of workflow components (e.g., importers, notifications) and support success/failure branches. Scheduled tasks track history, parameters, and logging for system automation.
Third Party
The Third Party window manages integrations with external applications. Users can generate packages or queries for third‑party systems and access their personal API keys for authenticated HTTP and HTTPS calls, enabling secure and flexible interoperability across connected platforms.
Data Feeds (and Virtual Feeds)
The Data Feeds window configures both persistent data feeds and virtual feeds. Data feeds load external files into the Quintessence database via defined transforms and mappings, usually executed through tasks. Virtual feeds use the same configuration but load data only into memory at runtime, avoiding duplication and enabling real‑time access to external systems. Both share identical configuration workflows.
Admin
The Admin window manages user access and group membership, supporting both Quintessence and Active Directory groups. Administrators can also control which icons appear in Studio for each user, simplifying the interface and ensuring role‑appropriate access.
Dashboard
The Dashboard provides real‑time runtime statistics, including executed calls, engine uptime, thread usage, and memory cache activity. The Memory Tables view helps confirm that key in‑memory components are operating correctly, making this an essential monitoring tool for system health.
System Config
System Config contains the foundational settings for code hierarchies, TimeSeries periods/units/attributes, global variables, and other core configuration elements. These settings are used system‑wide – in reports, functions, data feeds, and other modules – to ensure consistent interpretation of data and behaviour across the entire Quintessence environment.