4 4 3 Beefalo:SEP sesam Web UI: Difference between revisions

From SEPsesam
(Beefalo V2-related update, in progress.)
(Beefalo V2-related update, in progress.)
Line 117: Line 117:
<ul><li><translate>'''setting date range''': use the time 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 time range for the reports (see [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#time|Time range selector]]).</translate></li>
<ul><li><translate>'''setting date range''': use the time 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 time range for the reports (see [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#time|Time range selector]]).</translate></li>
<li><translate>'''show/hide report''' (first button), '''refresh''' (second button), '''open help wiki''' (third button), '''collapse widget and show dashboard''' (fourth button): use the buttons to hide your reports, refresh them, open SEP sesam wiki documentation page, or collapse a widget and open Web UI dashboard.</translate></li>
<li><translate>'''show/hide report''' (first button), '''refresh''' (second button), '''open help wiki''' (third button), '''collapse widget and show dashboard''' (fourth button): use the buttons to hide your reports, refresh them, open SEP sesam wiki documentation page, or collapse a widget and open Web UI dashboard.</translate></li>
<translate>[[image:Common_options.jpg|150px|link=]]</translate>
<br clear=all>
<li>{{anchor|refresh}}<translate>'''automatic refresh''': use the '''refresh''' button to refresh the window immediately or set time interval to refresh the window automatically (e.g., every 30 seconds).</translate></li>
<translate>[[File:Web_UI_automatic_refresh.jpg|200px|link=]]</translate>
<br clear=all>
</ul>


<translate>[[image:Common_options.jpg|150px|link=]]</translate>
<translate>=={{anchor|status}}Status==
 
The ''Status'' is now the default start page of the SEP sesam Web UI. The menu provides a status overview of your jobs, clients, data stores, etc. You can define [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#time|time range]] for your reports or [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#refresh|refresh]] your reports.
 
Clickable items in the tables open related ''Monitoring'' window, e.g., clicking ''Backups'' in the ''Job status'' table, opens ''Backups'' window under the Monitoring, where you can check the details of all performed backups, see [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#monitoring|Monitoring section]]. By clicking the ''info icon (i)'', you can check the next events details (start, priority, etc.), or SEP sesam Server details (license details, available service packs, etc).
 
Status overview consists of the following reports:</translate>
<ul><li><translate>'''''Job status''''': Displays the status of all jobs (''backups'', ''restores'', ''migrations'', and ''replications''). You can also check only active jobs.</translate></li>
<translate>[[File:Web_UI_job_status.jpg|700px|link=]]</translate>
<br clear=all>
<li><translate>'''''Data stores''''': Displays the status of your data stores and the data stores with highest utilization ratio.</translate></li>
<translate>[[File:Web_UI_data stores.jpg|700px|link=]]</translate>
<br clear=all>
<li><translate>'''''Next events''''': Displays the details about the next events, e.g., ''start'', ''event type'', ''priority'', ''schedule'', etc.</translate></li>
<translate>[[File:Web_UI_next_events.jpg|700px|link=]]</translate>
<br clear=all>
<li><translate>'''''Clients''''': Displays a number of ''all'', ''updateable'', ''inaccessible'', and ''disabled'' clients.</translate></li>
<translate>[[File:Web_UI_clients.jpg|230px|link=]]</translate>
<br clear=all>
<li><translate>'''''Server''''': Displays the details about SEP sesam Server. By clicking the ''info icon'' shows its properties, configuration file <tt>sm_ini</tt>, process log, license details, and available updates.</translate></li>
<translate>[[File:Web_UI_server_details.jpg|450px|link=]]</translate>
<br clear=all>
</ul>
 
<translate>=={{anchor|dashboard}}Dashboard==
 
SEP sesam web dashboard enables you to check if all your backups and restores have been completed successfully and review custom statistics on total size of backed up and restored data. You can define [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#time|time range]] for your reports or [[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#refresh|refresh]] your reports. You can also generate reports by clicking the ''Report'' button.
 
The dashboard contains the following reports:</translate>
*<translate>[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#application|Application based backup state]]: Overview of state of all application backups within the specified time range.</translate>
*<translate>[[Special:MyLanguage/4_4_3_Beefalo:SEP_sesam_Dashboard#backups|Backup state over time]]: Overview of state of all backups within the specified time range.
*Restore state over time: Overview of state of all restores within the specified time range.</translate>
*<translate>Total backup data size over time: Overview of total backup data size over time within the specified time range.</translate>
*<translate>Total restore data size over time: Overview of total restore data size over time within the specified time range.
 
==={{anchor|application}}Application based backup state===
 
Application-based report provides an '''overview of all backups''' sorted by applications which were backed up during a '''given time period'''. Each bar represents the results of one [[Special:MyLanguage/SEP_sesam_Glossary#backup_day|sesam backup day]], depending on the [[Special:MyLanguage/SEP_sesam_Glossary#NEWDAY|newday]] event. The information includes: the number of ''successful'' application backups, the number of ''failed'' application backups (error), the number of application backups that completed with ''warning'' and the number of ''cancelled'' application backups. You can filter the results by time.
 
[[File:Dashboard_applic_bck_status_Beefalo.jpg|450px|link=]]</translate>
<br clear=all>
 
<translate>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 ''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 also remove all filters by clicking the '''Remove filters''' button.
 
[[image:Dashboard_applic_bck_status-by_client_Beefalo.jpg|800px|link=]]</translate>
<br clear=all>
 
<translate>==={{anchor|backup}}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 [[Special:MyLanguage/SEP_sesam_Glossary#backup_day|sesam backup day]], depending on the [[Special:MyLanguage/SEP_sesam_Glossary#NEWDAY|newday]] event. 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 ''cancelled backups''. Hovering over the report displays additional details.
 
[[image:Dashboard_bck_status_Beefalo.jpg|500px|link=]]</translate>
<br clear=all>
 
<translate>You can '''filter''' the results by time, by state or by client.</translate>
<ul><li><translate>To '''filter the results by job's state''', click the state(s) which you want to '''exclude''' from report.</translate></li>
<translate>[[image:Dashboard_bck_status_filtered_Beefalo.jpg|500px|link=]]</translate>
<br clear=all>
<li><translate>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. <br />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 also remove all filters by clicking the '''Remove filters''' button.</translate></li>
<translate>[[image:Dashboard_bck_status-by_client_Beefalo.jpg|500px|link=]]</translate>
<br clear=all>
<br clear=all>
</ul>
</ul>

Revision as of 17:04, 12 December 2019

Draft.png WORK IN PROGRESS
This is a draft document for the SEP sesam upcoming 4.4.3 Beefalo V2 release. Note that the 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.
Other languages:

Template:Copyright SEP AG en

Docs latest icon.png Welcome to the latest SEP sesam documentation version 4.4.3 Beefalo V2. For previous documentation version(s), check Documentation archive.


Overview

Up to v. 4.4.3 Beefalo V2, SEP sesam allows you to handily check the state of SEP sesam Servers online by using its web dashboard. From Beefalo V2, SEP sesam web Dashboard has been completely redesigned to provide a more detailed overview and improved monitoring of the SEP sesam environment.

New SEP sesam Web UI is a modern web client with several components, including the dashboard and the restore assistant. It enables you to handily check a status overview (data store status, client status, next events, etc.), access SEP sesam Dashboard, monitor SEP sesam operations (backups, restores, etc.), check logs and reports, and access the restore assistant. The Web UI supports recent versions of Chrome, Firefox, Edge, and Safari browsers.

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 dashboard, check the authentication settings. For details, see About Authentication and Authorization.

The dashboard (Web UI) 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 configure that this page is not shown automatically: in the SEP sesam GUI -> menu bar -> Configuration -> Defaults -> General tab, deselect the checkbox Show SEP sesam web client landing page on startup.

Navigating Web UI

New SEP sesam Web UI provides efficient menu on the left, which includes the following options, described in the sections below: Status, Dashboard, Monitoring, System logs, Reports, and Restore Assistant. You can also check the latest Release notes and new SEP CAPS solution. You can collapse or expand the menu by clicking on two arrows on the top.

Web UI menu.jpg

Notifications, help, language & account

In the upper right corner, the notifications, help, language, and account menus are available. This menu is always present and enables you to review notifications, access online help, choose or change the display language, and modify Web UI settings.

Web UI other menus.jpg

Notifications
SEP sesam Server sends different types of messages – notifications. They are intended to notify a user of important events and announcements, such as information on latest patches, license violations, non-configured interfaces, as well as announcements of a new release or alerts about issues and errors that are sent via RSS feeds.
Web UI notifications.jpg


A notification's status can be open or acknowledged. Notification remains open until being acknowledged through the notification center in the GUI. This means that you can check all messages displayed in the dashboard, but you cannot change their state. For this, you have to use SEP sesam GUI -> menu bar -> Window -> Show Notification Center. For details, see Notification Center.
Web UI notifications-details.jpg


Help
The menu Help provides shortcuts to different types of user assistance:
Web UI Help
  • Dashboard provides a description of all dashboard reports and functions.
  • Restore Assistant provides a description of online restore assistant functions.
  • Sesam REST API documentation is available to provide access to the SEP sesam functions and services as a third-party software.
SEP sesam Help
  • 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 recovery in specific environments.
  • SEP Support leads you to the SEP Support Portal, where you can select different support options.
Web UI help.jpg


Language
Enables you switching between English and German display language.
Web UI language.jpg


Account
In the Account menu, you can log out from the Web UI and modify different settings; you can enable text wrapping, select data prefix (binary or decimal), change date and time format, enable dashboard 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.jpg


Time range selector

Time range selector allows you to specify the time span of the report. By selecting start and enddates from the calendar you can specify a custom date range. You are able to view reports for any time period, including days, weeks, months, and years. Your Web UI is updated every time you log in and reloads data every few seconds.

Note that the days are always defined by sesam backup day that depends on the newday event.

Web UI calendar.jpg

Common navigation options

Generally, the Web UI provides navigation through its reports with the following common items:

  • setting date range: use the time 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 time range for the reports (see Time range selector).
  • show/hide report (first button), refresh (second button), open help wiki (third button), collapse widget and show dashboard (fourth button): use the buttons to hide your reports, refresh them, open SEP sesam wiki documentation page, or collapse a widget and open Web UI dashboard.
  • Common options.jpg
  • automatic refresh: use the refresh button to refresh the window immediately or set time interval to refresh the window automatically (e.g., every 30 seconds).
  • Web UI automatic refresh.jpg

Status

The Status is now the default start page of the SEP sesam Web UI. The menu provides a status overview of your jobs, clients, data stores, etc. You can define time range for your reports or refresh your reports.

Clickable items in the tables open related Monitoring window, e.g., clicking Backups in the Job status table, opens Backups window under the Monitoring, where you can check the details of all performed backups, see Monitoring section. By clicking the info icon (i), you can check the next events details (start, priority, etc.), or SEP sesam Server details (license details, available service packs, etc).

Status overview consists of the following reports:

  • Job status: Displays the status of all jobs (backups, restores, migrations, and replications). You can also check only active jobs.
  • Web UI job status.jpg
  • Data stores: Displays the status of your data stores and the data stores with highest utilization ratio.
  • Web UI data stores.jpg
  • Next events: Displays the details about the next events, e.g., start, event type, priority, schedule, etc.
  • Web UI next events.jpg
  • Clients: Displays a number of all, updateable, inaccessible, and disabled clients.
  • Web UI clients.jpg
  • Server: Displays the details about SEP sesam Server. By clicking the info icon shows its properties, configuration file sm_ini, process log, license details, and available updates.
  • Web UI server details.jpg

Dashboard

SEP sesam web dashboard enables you to check if all your backups and restores have been completed successfully and review custom statistics on total size of backed up and restored data. You can define time range for your reports or refresh your reports. You can also generate reports by clicking the Report button.

The dashboard contains the following reports:

  • Application based backup state: Overview of state of all application backups within the specified time range.
  • Backup state over time: Overview of state of all backups within the specified time range.
  • Restore state over time: Overview of state of all restores within the specified time range.
  • Total backup data size over time: Overview of total backup data size over time within the specified time range.
  • Total restore data size over time: Overview of total restore data size over time within the specified time range.

Application based backup state

Application-based report provides an overview of all backups sorted by applications which were backed up during a given time period. Each bar represents the results of one sesam backup day, depending on the newday event. The information includes: the number of successful application backups, the number of failed application backups (error), the number of application backups that completed with warning and the number of cancelled application backups. You can filter the results by time.

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 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 also remove all filters by clicking the Remove filters button.

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, the number of failed backups (error), the number of backups that completed with warning and the number of cancelled backups. Hovering over the report displays additional details.

Dashboard bck status Beefalo.jpg

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

  • To filter the results by job's state, click the state(s) which you want to exclude from 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 also remove all filters by clicking the Remove filters button.
  • Dashboard bck status-by client Beefalo.jpg