5 0 0:SEP sesam Web UI

From SEPsesam
Revision as of 15:43, 5 March 2021 by Sta (talk | contribs) (Jaglion draft (many enhancements), in progress.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Other languages:

Template:Copyright SEP AG en

Draft.png WORK IN PROGRESS
This article is in the initial stage and may be updated, replaced or deleted at any time. It is inappropriate to use this document as reference material as it is a work in progress and should be treated as such.


Docs latest icon.png Welcome to the latest SEP sesam documentation version 5.0.0 Jaglion. For previous documentation version(s), check SEP sesam Web UI in Beefalo V2.


Overview

As of 5.0.0 Jaglion, SEP sesam Web UI has been significantly enhanced with a more detailed overview of jobs and tasks, improved monitoring of the SEP sesam environment and the possibility of performing different operations, e.g., running or locking the backups, restarting failed jobs, etc.

Web UI is a modern web client with several components, including the web dashboard and the restore assistant. It enables you to handily check status (for data store, client, next events, etc.), monitor SEP sesam operations (backups, restores, etc.), perform different operations, access check logs and reports, and start online restores by using the restore assistant. The Web UI supports recent versions of the major web browsers: Google Chrome, Firefox, Edge, and Safari.

Web UI (dashboard) access

You can access the Web UI by typing the following information in the browser address bar:
http://[servername]:11401/sep/ui
or
https://[servername]:11401/sep/ui.

Example: On the SEP sesam Server the following 'localhost' link will open the Web UI: http://localhost:11401/sep/ui

Information sign.png Note
If you cannot access the Web UI, check the authentication settings. For details, see About Authentication and Authorization.

The Web UI (dashboard) is also available in the GUI from menu bar -> Activities -> Dashboard, from Main Selection -> Monitoring -> Dashboard, or by clicking the dashboard icon in the toolbar.

SEP Tip.png Tip
When running the SEP sesam GUI as an administrator, the new SEP sesam Web UI landing page opens by default (with access to the Web UI, links to documentation, etc). You can prevent it from automatically opening when starting SEP sesam GUI, in the GUI menu bar -> Configuration -> Defaults -> General tab, deselect the check box Show SEP sesam web client landing page on startup.

Navigating Web UI

The SEP sesam Web UI menu allows you to navigate directly to a specific view: UI Mode (opens Settings), Status, Dashboard, Monitoring, System logs, Notifications, Reports, and Restore Assistant. You can easily check the latest Release notes and get information on SEP CAPS solution.

Information sign.png Note
In case of licensing and data store problems, the related alarms are shown on the top. You can check the alarm details by clicking Check details button on the right.

Web UI menu.jpg

Notifications, help, language, theme & account

There are a few icons located in the upper right corner: Notifications, Help, Language, Theme, and Account. These icons are always present and enable you to quickly review notifications, access online help, choose or change the display language, select light/dark theme for your Web UI display, and modify Web UI settings (located under Account).

Web UI other menus Jaglion.jpg

Notifications
SEP sesam Server sends different types of messages – notifications. They are intended to notify users when there are important messages they should know about, such as information on the latest available issues and patches (sent via RSS feeds), information about license violations and non-configured interfaces, new release announcements, etc. They can be accessed by clicking the notification icon or from the Web UI left menu.
Web UI notifications Jaglion.jpg


The notification status can be open or acknowledged. If there are open (unacknowledged) notifications, the flag icon turns yellow and the number of open notifications is shown next to it. The notification remains open until being acknowledged through the notification center in GUI. You can check all listed messages, but you cannot change their state in the Web UI. (To change their state, use SEP sesam GUI -> menu bar -> Window -> Show Notification Center. For details, see Notification Center).
Web UI notifications-details.jpg


Help
A Help icon provides access to different types of user assistance:
Web UI help
  • The Dashboard link leads to description of all dashboard reports and functions.
  • The Restore Assistant link provides a description of online restore assistant functions.
  • The Sesam REST API reference guide provides information on SEP sesam functions and services.
SEP sesam Help
  • Release notes and Known Issues provide release-related enhancements, known issues and fixes.
  • SEP sesam Wiki (you are currently using it) is a set of wiki topics documenting SEP sesam concepts, procedures and tasks.
  • SEP sesam Forum is a place where you can find helpful solutions and workarounds from the SEP sesam users.
  • Video tutorials provide step-by-step tutorials and screencasts covering a wide range of topics, from basic configuration to setting up backup and performing recovery in different environments.
  • SEP Support leads you to the SEP Support Portal where several different support options are available.
Web UI help Jaglion.jpg


Language and Theme
Clicking the language icon enables switching between English and German language. Clicking the next theme icon enables switching between the light and dark theme of your Web UI display.
Web UI language Jaglion.jpg


Account
Use the Account menu to log out from the Web UI and modify various settings; under four new tabs, you can select UI mode (Basic, Advanced or Expert), change the theme of your Web UI display (light or dark), select data prefix (binary or decimal), change date and time format, set data tables options, enable text wrapping and/or Web UI automatic refresh, and set visibility of the dashboard widgets. You can reset your settings to default at any time by clicking Reset to defaults button.
Web UI account Jaglion.jpg


Date range selector

The date range selector allows you to specify the date span of the report. By selecting start and end dates from the calendar you can specify a custom date range. You are able to view reports for any time period specified (days, weeks, months, and years). To select only one specific day, click on it twice. SEP sesam Web UI is updated every time you log in and reloads data every few seconds if the automatic refresh is set to on.

Web UI calendar.jpg

Common buttons and menus

SEP sesam Web UI features have the following buttons and menus available:

  • setting date range: Use the date range picker to display a report for a predefined time period, such as today (default), 2 days (2D), 3 days (3D) or 1 week (1W), or define your custom date range for the reports (see Date range selector).
  • toggle report (the first button), refresh (the second button), open help wiki (the third button), expand/collapse widget (the fourth button): Use these buttons to expand or collapse the reports, hide your reports, refresh them, open SEP sesam wiki documentation, or expand widget to view the item in a new window.
  • Common options.jpg
  • automatic refresh: Use the refresh button to refresh the window immediately or set the time interval for automatic refresh (e.g., every 30 seconds). SEP sesam web UI is updated every time you log in and reloads data every few seconds if automatic refresh is set to on.
  • Web UI automatic refresh.jpg

Status

Status is the default start page of the SEP sesam Web UI. It provides a status overview of your jobs, data stores, events, clients, etc. You can define the date range for the status overview and set the refresh option for your status window.

Clickable links in the tables open the related item status in a new window, e.g., clicking Backups in the Job status table opens the Backups monitoring window, where you can check the details of all performed backups; for more information, see the Monitoring section.

Each table features a variety of clickable details, for example, the Job status table shows the number of failed, successful and total number of backups, migrations, replications, and restores for a given date range; clicking the displayed numbers opens a new window with the related details.

By clicking the info icon (i), you can check the details of the next events (start, priority, etc.) and the SEP sesam Server details (license, available software updates, etc).

Status overview consists of the following reports:

  • Job status: Displays the status of all jobs (backups, restores, migrations, and replications). Next to it is the Active jobs table that shows the number of currently running jobs.
  • Web UI job status corr.jpg
  • Data stores: Displays the status of your data stores.
  • Web UI data stores.jpg
  • Next events: Displays the details about the next events, such as the event start time, event type, related task and schedule.
  • Web UI next events.jpg
  • Clients: Displays the total number of clients, followed by the numbers of updateable, inaccessible, and disabled clients.
  • Web UI clients.jpg
    When selecting clickable items, all related clients are listed. You can filter the results by backup execution (turned on/off), access state (accessible/inaccessible), access mode (SMSSH, PROXY, etc.), update state (new version available or up to date) or client type (client, server or RDS). Web UI clients details.jpg
    By clicking on a single client, the new Client window opens with more details on the selected client (location, OS, SEP sesam version, etc.). Under the Backup data size tab, you can also check a graph with the data size of backup jobs for a client. Hovering over a graph shows the details of the selected item. Web UI client data size.jpg
  • Server: Displays the details about SEP sesam Server (status, license, release, package and details about software update). Clicking the info icon shows its properties; you can examine and download the configuration file sm_ini and process log.
  • Web UI server details.jpg

Dashboard

SEP sesam web dashboard enables you to check if all your backups and restores have completed successfully and review statistics on the total size of backed up and restored data. You can define the date range for your reports and set the time interval for automatic refresh of the dashboard reports. You can also search for saveset, restore, migration, replication, or media result by specifying its complete ID in the Search field. If found in the database, its details are displayed.

The dashboard contains the following reports:

Application based backup state

The application-based backup report provides an overview of all backups according to the application type that were performed during a given time period. The information includes: the number of successful backups, the number of failed backups (error), the number of backups that completed with warning, and the number of canceled backups. You can filter the results by date.

Dashboard applic bck status Beefalo.jpg

To filter the results by application, click the link View backup state by application over time (or click on table row). A report with backup graphs for each individual application is displayed. If you want to check the details only for a specific application, enter its name in the Filter by application name field. Use the legend buttons above the graph – successful, with warning, cancelled, error, or use the Sort drop-down list to filter information that you want to be displayed in a graph. You can remove all filters by clicking the Remove filters icon.

Dashboard applic bck status-by client Beefalo.jpg

Backup state over time

This report provides an overview of all backups that occurred during a given time period in the form of a bar graph. Each bar represents the results of one sesam backup day (depending on the newday event). The information includes: the number of successful backups, failed backups (error), backups that completed with warning and cancelled backups. Hovering over the report displays additional details.

Dashboard bck status Beefalo.jpg

You can filter the results by date, by state or by client.

  • To filter the results by job state, click the status which you want to exclude from the report.
  • Dashboard bck status filtered Beefalo.jpg
  • To filter the results by client, click the link View backup state by client. A report with backup graphs for each individual client is displayed. If you want to check the details only for a specific client, enter its name in the Filter by client name field.
    Use the legend buttons above the graph – successful, warning, cancelled, error, or use the Sort drop-down list to filter information that you want to be displayed in a graph. You can remove all filters by clicking the Remove filters icon.
  • Dashboard bck status-by client Beefalo.jpg

Total backup data size over time

This report provides information on total and average data size that was backed up during a given time period, in the form of a line chart for all clients and tasks. The size chart can help administrators to analyze and predict growth trends for the SEP sesam environment. This report can also be useful for estimating the amount of data to be restored.

Dashboard total data size bck Jaglion.jpg

Restore state over time

This report provides an overview of all restores that occurred during a given time period in the form of a bar graph. Each bar represents the results of one sesam backup day (depending on the newday event). The information includes: the number of successful restores, failed restores (error), restores that completed with warning canceled restores. Hovering over the report displays additional details.

You can filter the results by date, by state or by client.

  • To filter the results by job state, click the status which you want to exclude from report.
  • Dashboard rst status Beefalo.jpg
  • To filter the results by client, click the link View restore state by client. A report with restore graphs for each individual client is displayed. If you want to check the details only for a specific client, enter its name in the Filter by client name field.
    Use the legend buttons above the graph – successful, warning, cancelled, error, or use the Sort drop-down list to filter information that you want to be displayed in a graph. You can remove all filters by clicking the Remove filters icon.
  • Dashboard rst status-by client Beefalo.jpg

Total restore data size over time

This report provides information on total and average data size that was restored during a given time period in the form of a line chart.

Dashboard total data size rst Jaglion.jpg