Sidra Web Overview¶
Sidra Web is a management and operational UI web interface to ease many operational tasks related to configuration, data governance and operations management on the Sidra platform.
Sidra Web users are mostly operations and data stewardship teams that need an easy interface to manage the platform and data assets.
Current and future developments on Sidra Web are part of an ongoing roadmap of features, with the goal of making configuration and management as easy and intuitive as possible.
Sidra Web is deployed and updated with every Sidra release, and any new features and changes are periodically covered in the Release Notes section in the present documentation.
The web is automatically deployed in the Core resource group and integrated with Sidra's Identity Server. It is brandable, so each customer can set it up for alignment with their corporate image in terms of accent colours, logo, etc.
This section summarizes the key modules in Sidra Web management interface. Specific document sections have been created
Main sections in Sidra Web¶
The different sections of Sidra Web are accessible through the navigation icons on the left-hand side of the main panel, as seen here:
Some of these components are described in this page, and some other important sections are documented in separate linked pages:
- Operational Dashboard
- Data Catalog
- Log Search
- Release Notes
- Client Applications Catalog
By providing an overview of the current state of the platform, the operational dashboard acts as a simplified version of the Power BI management dashboards. Basic KPIs are shown, as well as the status of the Databricks clusters, an overview of the last errors and warnings and the status of the intake processes over the last days.
This home dashboard contains several widgets linking important operational information from the Sidra installation.
Available services widget:
This widget displays information about the different Sidra services that are installed and enabled for the Sidra installation. These modules are not UI modules, but rather specific Client Applications or Backend components of Sidra.
The Dashboard or Home page includes a visual indicator of the environment where the Web points to (e.g. Dev/Test/Pre/Prod).
Sidra Core is the only component that is mandatory for Sidra Web to work.
Modules in grey colour mean that these components have not been installed or enabled in the Sidra installation.
These components have been designed to serve different purposes for specific use cases, in coordination with Sidra Core. Some modules, like Master Data Management or Data Quality usually require some adaptations to the specific Sidra installation in order to be enabled.
By clicking on each of these services in the list, web users can get a detailed description about each of the services.
Data Intake KPIs and trends:
Sidra Web Operational Dashboard displays two important pieces of information regarding Data Intake:
On one hand, cards with different indicators display a static view of current data volumes stored in Sidra, as well as information about total number of Providers, Entities and Client Applications configured in the platform.
A dynamic view of data intake, including figures and trends for customizable time periods, is available through the page Sidra Operational DW Power BI reports.
On the other hand, a trend view bar chart displays latest information about volumes ingested and validation errors.
The notifications widget is a small widget with the shape of a small bell icon in the home page, which displays the total number of unread notifications in the system.
Once a new notification is received, the bell icon shakes and the counter is increased.
By clicking on this bell icon, users can see an expanded Notifications widget with information about the latest unread notifications of each type.
These are the available notification types in Sidra: General, Intake and App.
The Notifications widget displays a link to see the detail and full list of unread notifications as explained in section Notifications in this page.
Errors and warnings:
Errors and warnings widget display the latest errors and warnings in Sidra.
Errors are entries of the Util.Log table with the Level field set up to Error, while Warnings are the entries of the Util.Log table with the Level field set up to Warning.
In both of these widgets, there is a link to review these elements in the Logs Search page. See the Logs Search section in this document.
Cluster status is a widget in Sidra Web Dashboard page, which displays the full list of clusters, including their status, uptime and number of nodes.
Data Storage Units map:
Finally, the Data Storage Units map displays in a geographical map all the DSUs configured in the installation, including location and total data volume stored.
From the data catalog view, users can navigate or search through all the Providers and Entities which are visible given the permissions in place. Sidra Data Catalog provides data managemenet capabilities from a user-friendly interface.
A detailed documentation about the Sidra Data Catalog is found in the Data Catalog page.
Roadmap for 2021 includes the creation of new data intake connectors through wizard interface (e.g. from SQL server data sources) for future releases.
Besides the notifications widget, a full-size section has been created to review these notifications with a larger area for the text descriptions.
This detailed notification list can be accessed either by the widget, or via the new Notifications menu option, under the Home main menu option.
The Notifications page displays a full list of unread notifications in the Sidra installation that the Web is associated to.
From this page, notifications can be marked as read, which means that they will no longer appear in the UI for that user, however, they will still be available in the Core.Notifications table.
The Logs page in Sidra Web displays the latest logs as they are retrieved from the Util.Log table. This page includes several filters to refine searches.
The Release Notes page includes a list of all past releases of Sidra. Clicking on each item, it is possible to see the full details of each release as also included in the Release Notes of Sidra Documentation.
This section of Sidra Web allows displaying and managing the different objects of the Balea Authorisation Framework.
The Authorization section displays the applications registered under Sidra Core, and includes capabilities to assign and enable roles to users, including mappings, delegated credentials and bespoke permission sets on the underlying resources (DSU, Provider and Entity-scoped authorization).
A detailed section about the Authorizations section in Sidra Web can be displayed in the Authorizations page.
Client Applications Catalog¶
The Client Applications catalog allows the user to explore the different Client Applications registered on the system.
At the time of this release, it is a read-only feature, but the roadmap for 2021 includes the creation of new client apps from this UI in future releases.