Skip to main content

Configurations

The Configurations domain is an advanced, internal-only area used to store and manage core settings that control the behavior of the Intervengine platform.

Think of it as the central control panel or "settings file" for the entire application. It allows administrators to fine-tune system operations, customize templates, and toggle features without requiring code changes.

Caution

This is a powerful domain intended for use by authorized staff only. Incorrectly modifying these settings can have a significant and immediate impact on the platform's functionality for all users.

The Configurations domain is used to manage a wide variety of system settings. Common examples include:

  • Customizing Templates: Storing the content for automated messages, such as the Onboarding SMS Template or the Unread Message Email Template. This includes using dynamic variables like {first_name} to personalize the content.
  • Controlling Timings: Defining time-based settings, such as the delay for sending an unread message notification (snoozerTimer).
  • Enabling/Disabling Features: Using a simple true/false value to act as a feature flag, like the Enable Unread Message Notification setting.

Each setting in the domain has a consistent structure that defines what it is and how it behaves.

Name and Description​

The Name is a human-readable label for the setting, while the Description explains its purpose and how it's used within the system.

Path (The Unique Key)​

The Path is the most critical field. It is a unique, machine-readable identifier (e.g., platformConfigs.onboarding) that the application code uses to look up the setting's value. This path must be precise and should not be changed without consulting the development team.

Value (The Setting)​

The Value is the actual data for the setting. This could be text, a number, a true/false value, or even a block of HTML code for email templates.

Readable/Writeable Toggles​

These flags control the permissions of the configuration item itself, determining if its value can be accessed (Readable) or modified (Writeable) by different parts of the system.

Authorized staff can browse, search, and filter all existing configuration items from the main Configurations screen.

To edit a setting, you click on it to open the detail view, modify its Value or other properties, and save the changes. Creating a new configuration item is an advanced task that requires a deep understanding of the system, as a corresponding Path must be implemented in the application code for the new setting to have any effect.