Author | |
|---|---|
Version | 1.0 |
Classification | DRAFT |
4. Overview
The Ozone Admin Portal serves as an internal web tool exclusively available to LFIs for managing the API Hub. Designed to streamline administrative tasks and enhance operational efficiency. The portal features a user-friendly menu structure, providing quick access to essential functionalities. Sections include:
Menu Name | Page Description |
|---|---|
Manage Section | |
Bank | Provides oversight of the LFI's API Hub configuration and grants access to the Platform Key Performance Indicators dashboard. Administrators can configure various components such as banks. |
TPPs | Facilitates the management of TPPs registered in the API Hub. |
Software Statements | Offers the ability to manage TPPs' software statements. |
Clients | Allows management of TPPs' clients registered under software statements. |
API Logs Section | |
Search by Interaction ID | Enables searching of API Hub logs using an API call's Interaction ID. |
Query API Logs | Provides the capability to query API Logs using a wide range of call parameters. |
Reports Section | |
Reports | Offers a comprehensive set of predefined reports containing data on the platform’s availability, performance, and API volumes and usage. |
Outage Reports Section | |
List Outage Reports | Allows viewing of a list of previously registered outage reports. |
Publish Outage | Enables registration of new planned or unplanned outages. |
Resources Section | |
Postman Collection | Allows downloading of the Postman collection with exposed Open Finance standards. |
User Section | |
Logout | Provides the option to sign out from the Ozone Admin Portal. |
| |
|---|---|
Environments | Each environment available to the LFI (including Staging, and Production) is equipped with its own dedicated Ozone Admin Portal supplied with unique access URL. |
Key Considerations5. Portal Sign-in
Sign-in will be integrated with the OFTF
.png?version=1&modificationDate=1719587674810&cacheVersion=1&api=v2&width=714&height=808)
6. Admin Portal Menu
6.1 Bank
The bank menu allows access to the bank configuration page, which displays the settings applied to the FI’s API Hub, and to the dashboard page, which features widgets that showcase the platform's Key Performance Indicators.
6.1.1 Bank Configuration Page
The bank configuration page can be accessed by clicking on the bank name within the bank configuration menu on the bank page:
⚙️ Configuration | |
Configuration Change | Configuration changes can be made by submitting a Change Request through the Service Desk. |
6.1.2 Dashboard and Widgets Page
The portal dashboard allows users to monitor service activity across different environments by providing various metrics for regulatory requirements and Open Finance services. Users can specify a custom date range from several years to the current day to analyse platform performance and identify areas for improvement. Additionally, a refresh button is available for each metric, allowing users to see the most recent updates.
6.2 TPP Management
6.2.1 TPP Page
6.2.2 Software Statements Page
6.2.3 Clients Page
6.3 API Logs
The 'Logging' section of the Admin Portal provides customers with the ability to query API logs using a variety of filters. This feature is designed to help troubleshoot issues by offering detailed insights into each individual API call. It enables administrators to effectively troubleshoot by identifying and analysing relevant API calls, monitor and audit API usage across different environments, and quickly resolve errors by examining detailed request and response data. This enhances system management and streamlines issue resolution.
6.3.1 Search by Interaction ID Page
The 'Search by Interaction ID' page enables the Administrator to locate specific log records by using the API call interaction ID. This feature provides detailed information about the requested API call.
| |
|---|---|
Interaction ID | The "Interaction ID" is a unique identifier found in the headers of API calls. It is used to ensure traceability of API calls by maintaining the same interaction ID across both the initial TPP call and subsequent calls to the Local Financial Institution (LFI). This continuity allows for effective tracing of the API calls from start to finish.
|
6.3.2 Query API Logs Page
6.4 Reports
API Hub Reporting Datasets
6.5 Outage Reports
The Outage Reports Menu provide the possibility to register planned and/or unplanned outage and view previously registered outages. This functionality is available through two pages - ‘List Outage Reports' and 'Publish Outage’.
6.5.1 List Outage Reports
List of Outage Reports Page provide possibility to manage Outrage Reports.
🔁 Usage | |
View List of Outage Reports | By accessing the List Outage Reports Page, the Administrator can view a comprehensive list of all registered Outage Reports. |
View Outage Report Details | Clicking the ‘three dots’ button to the right of the Outage Report record and selecting 'View Report' will allow you to view the details of the report. |
Delete Outage Report | Clicking the ‘three dots’ button to the right of the Outage Report record and selecting 'Delete Report' will allow you to delete the report. |
6.5.2 Publish Outage
6.6 Resources
The Resource Menu includes a Postman collection aligned with the relevant Open Banking standard. This collection can be downloaded and imported into Postman software, facilitating testing of the Platform's Open Banking interface.