Page Status: Copied from R6 - Mar, 22, 2020
Component Status: Pending PTL Updates and ArchCom Review


1. High Level Component Definition and Architectural Relationships 


  • Usecase-UI is an application portal which provides the ability to manage ONAP service instances. 

  • Usecase-UI allows customers to create/delete/update service instances, as well as to monitor the alarm and performance of these instances.

2. API definitions

Usecase-UI provides the following interfaces:


Interface Definition Interface Capabilities
UU-APIE-1Operator PortalUser interface for operators:
  • Customer management
  • Package management
  • Service lifecycle management for use cases
  • KPI Monitoring
  • Network topology management
UU-APIE-2Customer Portal

User interface for customer:

  • Service order
  • Service management
  • Service monitor

Note:   xxxI interface is a Component internal interface.  xxxxE interface is a component external interface

The provided UI interfaces are found at: Usecase-UI latest user guide

Usecase-UI consumes the following interfaces:

Interface Name

Interface Definition

 Interface Capabilities

SDCE-6*SDC InterfaceAn interface to receive resource Templates from SDC design catalog.
SO-E-01*Service and Resource order requests

Service Instance management (Service, Volume Group, VF Module, VNF)

Health check, global and node.

Infrastructure provider management (Certificates, networks, sub-networks, security groups)

VFCE-2Service Orchestrator / Policy InterfaceAn interface to allow Service Orchestrator and Policy request NS Lifecycle Management ( ETSI SOL-005 ).
AAIE-1*Inventory Service Interface

An interface to create, update, query, and delete resource information and relationships.

MSBE-1*Micro Service Bus InterfaceAn interface for registration and discovery with the ONAP Micro Service Bus.
etsicatalogAPIE1~4Modelling Tosca Parser Interfaces and catalog interfacesAn interface for the Tosca Parser from Modelling project to parse the NS and VNF Descriptors.
DCAE-DESDCAE Service ComponentsAn interface for DataLake Exposure Service Rest APIs

*Current description is based on Frankfurt documentation, will be updated accordingly if correspondent API update in Guilin.

3. Component Description:

Usecase-UI  is a web application which contains two parts: 

  • Usecase-UI GUI
  • Usecase-UI Server

4. known system limitations

Now the component Redundancy and scaling depends on Kubernetes.

5. Used Models

Usecase-UI use the following models:

  • TOSCA  - VNF Descriptor/NS Descriptor  ETSI NFV SOL001  v2.4.1 & v2.5.1

6. System Deployment Architecture

Usecase-UI consists of 4 containers:

  • Usecase-UI-Operator Portal

  • Usecase-UI-Operator Server

  • Usecase-UI-Customer Portal
  • Usecase-UI-Customer Backend

7. New Release Capabilities

The Guilin Release supports two capabilities:   

  1. Transport  5G Slicing: Adding endpoint parameters to the Slicing Tasks portal to support transporting the An and Cn region
  2. E2E Network Slicing: KPI Monitoring: Supporting KPI data shown to users and also supporting standard API interface with EXT-API for KPI monitoring, and KPI data reporting to tenant/operator

And also, Guilin Release includes a POC requirement:

  • Supporting an entry for IBN module to creating 5G Slicing service via the existing IBN individual system, as well as accepting the response data from IBN NLP module for creating CSMF Service.


8. References

Usecase-UI Installation & User Guide: usecase-ui docs



  • No labels