Functional Requirements: DSaaS (Appliance) #
Last Updated: October 28, 2024
Definitions and Interpretations
The following definitions apply:
- Biza Guides
- refers to the technical documentation hosted at https://guides.biza.io
- Appliance
- refers to the full software package of DSaaS, including the Data Adapter, Data Router & Accelerator (DRA), and databases; hosted via Kubernetes.
- Data Adapter
- refers to the Data Adapter as specified within Biza Guides.
Energy Adapter #
Provides an implementation of the Energy Data Adapter specification via native integration to the Flux API.
| Functional Requirement | Category | Requirement |
|---|---|---|
| C1 | Adapter API (General) | SIEM logging of adapter events. |
| C2 | Adapter API (General) | OAuth2 token based authentication and authorisation. |
| C3 | Adapter API (Auth) | Get Username Attributes. |
| C4 | Adapter API (Auth) | Get User Principals. |
| C5 | Adapter API (Common) | Get User. |
| C6 | Adapter API (Common) | Get Customer. |
| C7 | Adapter API (Admin) | Get Service Health Status. |
| C8 | Adapter API (Admin) | Get Endpoint Metadata. |
| C9 | Adapter API (Admin) | Get Closed Principals (Optional). |
| C10 | Adapter API (Notification) | Get User Notification Information. |
| E1 | Adapter API (Energy) | List Energy Accounts. |
| E2 | Adapter API (Energy) | Get Energy Account Agreed Payment Schedule. |
| E3 | Adapter API (Energy) | List Energy Account Concessions. |
| E4 | Adapter API (Energy) | List Energy Account Balances. |
| E5 | Adapter API (Energy) | List Energy Account Invoices. |
| E6 | Adapter API (Energy) | List Energy Account Billing Transactions. |
| E7 | Adapter API (Device) | Retrieve FRMP Details |
| E8 | Adapter rules | Apply pagination rules for List Energy Account Invoices and List Energy Account Billing Transactions. |
| E9 | Adapter rules | Enforce the eligibility criteria for CDR Consumers in the energy sector. |
Banking Adapter #
Provides an implementation of the Energy Data Adapter specification via native integration to UniVerse.
| Functional Requirement | Category | Requirement |
|---|---|---|
| C1 | Adapter API (General) | SIEM logging of adapter events. |
| C2 | Adapter API (General) | OAuth2 token based authentication and authorisation. |
| C3 | Adapter API (Auth) | Get Username Attributes. |
| C4 | Adapter API (Auth) | Get User Principals. |
| C5 | Adapter API (Common) | Get User. |
| C6 | Adapter API (Common) | Get Customer. |
| C7 | Adapter API (Admin) | Get Service Health Status. |
| C8 | Adapter API (Admin) | Get Endpoint Metadata. |
| C9 | Adapter API (Admin) | Get Closed Principals (Optional). |
| C10 | Adapter API (Notification) | Get User Notification Information. |
| B1 | Adapter API (Banking) | List Banking Accounts. |
| B2 | Adapter API (Banking) | List Payees. |
| B3 | Adapter API (Banking) | List Payments. |
| B4 | Adapter API (Banking) | List Banking Transactions. |
| B5 | Adapter rules | Apply pagination rules for List Banking Transactions. |
| B6 | Adapter rules | Apply masking rules as required by the data adapter. |
| B7 | Adapter rules | Enforce the eligibility criteria for CDR Consumers in the banking sector. |
DSaaS Admin #
Provides a web based interface for overall administrative management of DSaaS functionality.
| Functional Requirement | Category | Requirement |
|---|---|---|
| DA1 | DSaaS Admin | A web based interface for monitoring principals which have arrangements associated with DSaaS. |
| DA2 | DSaaS Admin | A web based interface for instructing DSaaS to refetch consumer data from the Customer Data Source. |
| DA3 | DSaaS Admin | A web based interface for monitoring errors which have occurred when DSaaS has attempted to fulfil the functional requirements of the Data Adapter. |
| DA4 | DSaaS Admin | Single sign-on support for Client personnel access in alignment with the technical specifications outlined on Biza Guides. |
| DA5 | DSaaS Admin | SIEM logging of admin events. |
Appliance Admin #
Provides a web based interface for administrative management of the DSaaS Appliance.
| Functional Requirement | Category | Requirement |
|---|---|---|
| AA1 | Appliance Admin | Web interface for updating DSaaS Appliance software configuration. |
| AA2 | Appliance Admin | Web interface for updating DSaaS Appliance software versions. |
| AA3 | Appliance Admin | Capability to configure multiple brands within the same DSaaS integration. |
| AA4 | Appliance Admin | Single sign-on support for Client personnel access in alignment with the technical specifications outlined on Biza Guides. |
Terraform #
Terraform infrastructure-as-code created by Hashicorp, used for the deployment of the DSaaS Appliance.
| Functional Requirement | Category | Requirement |
|---|---|---|
| T1 | Terraform | Terraform-based infrastructure as code for bootstrapping the appliance components. |
| T2 | Terraform | Support for deployment to Azure cloud environments. |
| T3 | Terraform | Support for deployment to AWS cloud environments. |
| T4 | Terraform | Set up of the Kubernetes infrastructure (EKS for AWS, AKS for Azure). |
| T5 | Terraform | Set up of databases as required by DSaaS (Amazon DocumentDB and Amazon Aurora for AWS, Azure Cosmos DB and Azure Database for Azure) |
| T6 | Terraform | Set up of Appliance Admin. |