Status
======

Overview
--------

Upon successfully logging into the Swivel Core Administration Web Console, the first screen presented is the **Status** page. This page acts as the dashboard for the appliance, providing immediate insight into the health and current state of the system.

The main navigation menu is located on the left-hand side of the page, providing access to all configuration and administration areas.

.. image:: images/Status/Status.png
   :alt: Swivel Core Status Screen
   :align: center


The Status Screen
-----------------

The Status screen provides a high-level summary of the system status. Information visible on this dashboard typically includes:

* **User Statistics:** The total number of users and the count of users in specific states (e.g., Locked, Inactive).
* **License Information:** Details regarding the current license status and limits.
* **Version Information:** The current version of the Swivel Core software.
* **Database Status:** Connection status to the internal or external database.

Swivel Web Console Main Menu
----------------------------

The left-hand menu provides navigation to the various configuration options. Below is a summary of these menu items:

.. list-table::
   :widths: 25 75
   :header-rows: 1

   * - Menu Item
     - Description
   * - **Status**
     - Displays the system status dashboard (current page).
   * - **Log Viewer**
     - Interface for viewing System and Activity logs.
   * - **Server**
     - General Swivel Server configuration settings.
   * - **Policy**
     - Configuration for Authentication policies and Password standards.
   * - **Logging**
     - Configuration for log levels and external logging targets (Syslog).
   * - **Messaging**
     - Setup for SMTP (Mail) and SMS (Mobile phone) messaging gateways.
   * - **Database**
     - Connection settings for the Swivel user database.
   * - **Mode**
     - Configuration for the operational mode of the server (e.g. read only/write mode).
   * - **Repository**
     - Configuration for User Data Sources (e.g., Active Directory, XML).
   * - **RADIUS**
     - Configuration for RADIUS NAS clients and protocol settings.
   * - **Migration**
     - Tool for migrating database formats or to external databases.
   * - **Appliance**
     - Appliance authentication session synchronisation settings.
   * - **OATH**
     - Management of OATH tokens and (virtual and hardware tokens).
   * - **Config Sync**
     - Settings for High Availability configuration synchronisation.
   * - **Reporting**
     - Tools for generating data reports on usage.
   * - **User Administration**
     - Interface for managing individual user accounts and attributes.
   * - **Save Configuration**
     - Exports the current settings to an XML file. See details below.
   * - **Upload Email Images**
     - Manager for email assets. See details below.
   * - **Administration Guide**
     - Link to the internal documentation.
   * - **Logout**
     - Ends the current administration session.

Additional Menu Functions
-------------------------

While most menu items lead to dedicated configuration pages, there are specific utility functions available directly in the menu list.

Save Configuration
~~~~~~~~~~~~~~~~~~

Selecting **Save Configuration** triggers a download of the current server configuration as an XML file.

.. note::
   This XML file can be used to restore the configuration in the event of data loss or when migrating to a new server. The Swivel appliance also performs daily backups which include this configuration data.

Upload Email Images
~~~~~~~~~~~~~~~~~~~

This option opens the image manager, displaying a list of images currently available for use in HTML emails (such as Dual Channel security strings). It allows administrators to upload new custom images to the appliance.

.. image:: images/Administration/Messaging/2020-05-05_15-40-09.png
   :alt: Upload Email Images Screen
   :align: center

Administration Guide
~~~~~~~~~~~~~~~~~~~~

Clicking this link opens the built-in guide to administering the Swivel server, providing context-sensitive help and general usage instructions.