Control CoreDocs

General Settings

This guide explains how to configure general platform settings, including platform preferences, security settings, subscription management, and telemetry configuration.

Overview

The General Settings page provides centralized configuration for:

  • Platform Preferences: Timezone configuration
  • Security Settings: Login session idle timeout for the Control Plane web UI
  • Subscription: View and manage subscription plan
  • Telemetry: Configure License Server connection and telemetry transmission
  • Display language: Control Plane UI locale (English, Español, or Français Canada)

Display language (Control Plane UI)

The admin console can show English, Español, or Français (Canada) for shared navigation and any screens that have been wired to the product translation bundles.

Steps

  1. Sign in to the Control Plane.
  2. Open your profile menu (user menu in the application header).
  3. Under Language, choose English, Español, or Français (Canada).
  4. Reload if the UI does not pick up the selection immediately.

Troubleshooting: If the menu still shows English after switching language, clear site data for your Control Plane origin (or remove localStorage key i18nextLng) and reload. If specific pages remain English, those routes may not yet use the translation bundles; see Troubleshooting or contact support with the page URL.

Note: The interactive API reference is served separately from the React app (Developer Portal at GET /devdocs on your Control Plane API host). Its language controls (if any) are independent of the Control Plane UI locale above.

Accessing General Settings

  1. Log in to the Control Core admin console
  2. Navigate to Settings → General
  3. Select the appropriate tab for the settings you want to configure

Platform Preferences Tab

Timezone Configuration

Configure the timezone for audit logs and system timestamps.

Steps:

  1. Navigate to Settings → General → Platform tab
  2. Select your timezone from the Timezone dropdown
  3. Default timezone is UTC
  4. Click Save to apply changes

Impact:

  • All audit logs will use the selected timezone
  • System timestamps will display in configured timezone
  • Changes apply immediately to new logs

Tooltip: "Select the timezone for audit logs and system timestamps. All timestamps will be recorded in this timezone."

Security Settings Tab

Control Plane login session (idle timeout)

Administrators tune how long a signed-in Control Plane browser session may remain idle before users are prompted. Idle means no pointer, keyboard, scroll, touch, or in-app navigation producing activity signals in that tab. Routine work—including moving between screens—normally counts as activity and resets the countdown. The UI also rotates the underlying access token on a throttled cadence during active use, within server-side boundaries described below.

Steps:

  1. Navigate to Settings → General → Security tab
  2. Set Session Timeout (minutes) (default 60, allowed range 5–480)
  3. Click Save to apply

Experience for end users:
Before the idle limit is reached, a warning modal appears with a countdown. The user chooses Stay Logged In (the server validates the browser and issues a refreshed token, starting a fresh idle clock) or Logout Now. If neither action occurs before that countdown completes, Control Plane closes the browser session and returns to the login page.

For long continuous use, deployments may enforce maximum uninterrupted session duration independently of idle settings. Operators typically control this ceiling with CONTROL_CORE_SESSION_MAX_ABSOLUTE_HOURS (default 8). When that bound is exceeded, signing in again is required—even if idle warnings were dismissed—because uninterrupted browser sessions should not stretch without limit.

Maximum concurrent interactive sessions per user can be tightened with CONTROL_CORE_SESSION_MAX_CONCURRENT where your deployment documents it.

Troubleshooting: If operators change session timeout minutes and timers still feel stale, reload the Control Plane UI—saved values apply on the next Save via the documented API—and confirm the Control Plane API deployment picked up CONTROL_CORE_SESSION_* overrides. Users who idle past the countdown see the login screen; that is expected. If interactive work still triggers idle warnings prematurely, reproduce with a fresh browser profile to rule out extensions blocking scripted activity.

Two-Factor Authentication

Two-Factor Authentication (2FA) settings have been moved to the User Management page.

To Configure 2FA:

  1. Navigate to Settings → Users
  2. Select a user from the list
  3. Click Enable MFA or use the MFA tab
  4. Follow the setup wizard to configure Google Authenticator or Microsoft Authenticator

Note: Only TOTP-based 2FA (Google Authenticator, Microsoft Authenticator) is supported.

Subscription Tab

The Subscription tab displays your current subscription plan and license information.

See: Subscription Management Guide for detailed information.

Quick Access:

  • View current plan (Kickstart or Custom)
  • Check trial status and expiration
  • Understand license requirements
  • Contact support for upgrades

Telemetry Tab

The Telemetry tab allows you to configure License Server connection and telemetry transmission.

See: Telemetry Management Guide for detailed information.

Quick Access:

  • Configure License Admin URL and API Key
  • Test License Server connection
  • Configure transmission frequency
  • Enable/disable encryption and anonymization
  • View telemetry data preview
  • Review transmission history

The General Settings page uses tabs for organization:

  • Platform: Timezone preference
  • Security: Idle timeout for Control Plane login sessions (CONTROL_CORE_SESSION_MAX_ABSOLUTE_HOURS caps continuous duration)
  • Subscription: Subscription plan and license information
  • Telemetry: License Server connection and telemetry configuration

Tip: Use the tab navigation to quickly switch between different setting categories.

Saving Changes

Individual Tab Saving

Each tab may have its own Save button:

  • Platform Tab: Save timezone preference
  • Security Tab: Save session idle timeout minutes
  • Telemetry Tab: Save telemetry configuration

Note: Some settings are saved automatically when changed (e.g., toggles).

Verifying Changes

After saving:

  1. Check for success message/notification
  2. Verify settings are reflected in the UI
  3. Test functionality (e.g., test connection, verify timezone)

Troubleshooting

Settings Not Saving

Issue: Changes are not being saved

Solutions:

  1. Check for error messages in the UI
  2. Verify you have admin permissions
  3. Check browser console for errors
  4. Try refreshing the page and re-entering settings
  5. Check backend logs for errors

Session Timeout Not Working

Issue: Idle warning or “Stay Logged In” misbehaved after an upgrade

Solutions:

  1. Save Settings → General → Security → Session Timeout again and reload the UI (timers reconcile from /auth/session-config)
  2. Clear site data only if the browser tab was left open across an upgrade boundary
  3. Verify the Control Plane API is reachable; token refresh relies on POST /auth/refresh while the countdown is visible
  4. Check browser extensions that block scripted events if genuine activity does not bump the idle clock

Timezone Not Applied

Issue: Audit logs still showing UTC instead of configured timezone

Solutions:

  1. Verify timezone is saved correctly
  2. Check that new logs use configured timezone
  3. Existing logs may still show UTC (this is expected)
  4. Verify backend timezone handling is working