You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

STATUS: Draft

Portal:


1 High Level Component Definition and Architecteral Relationships 



Portal is a GUI platform that provides the ability to integrate different ONAP platform GUIs into a centralized portal.

It provides:

  • The capability to allow other ONAP components to run within their own infrastructure while providing common management services and capabilities in a centralized way
  • Provides common capabilities such as application on-boarding and management, centralized access management and hosting application widgets, Context-Aware UIControls, Visualization & Reporting Engine
  • Provides SDK capabilities to access portal capabilities

Portal is used by:

  • VID, Policy, AAI, SDC, MSB and CLI

In addition to regular user, there are admin roles available for Portal to perform some administrative activities of Portal itself and the administration of on-boarded apps.

From the ONAP Portal, administrators:

  • access the same functionality accessible to users
  • manage users and application admins
  • onboard applications and widgets (developed using the Portal as a platform)
  • edit the functional menu

2. API definitions

Portal does not in itself provide APIs to other ONAP components, the Portal users do. [Please replace this statement, as Portal do provide APIs like - https://docs.onap.org/en/beijing/submodules/portal.git/docs/platform/offeredapis.html]

Portal provides the following interfaces:

Portal provides the following interfaces:

Interface Name

Interface Definition

 Interface Capabilities

PortalE-1Portal Admin Interface. 

  GUI to the portal admininstrator

PortalE-2Application Admin InterfaceGUI to the application administrator

 

PortalE-3External App InterfacePlatform API for application to:
  • Get functional menue items appropriate for the current user
  • Get favorite items within the functional menue for the current user
  • Create Portal notifications for from external application
PortalE-4Role Approval InterfacePlatform API for application to:
  • Delete application roles for a user
  • Create application user with specific roles
  • Updates user to have specific roles
PortalE-5Session Communication Interface

Platform API for application to:

  • Session slot check
  • Extend session timeout values
PortalE-6Role Approval Interface

Platform API for application to:

PortalE-7Shared Context Interface
PortalE-8Ticket Event Interface
PortalE-9Web Analtyics Interface
PortalE-10Internal Request Interface

Portal however provides multi-language support.

The multi-language support provides:

  • Login user langage settings
  • Update user language settings
  • Language options to user
  • Ability to add/remove and query supported languages.

 3. Component Description:

A more detailed figure and description of the component.


The main functional comonents of porta alre:

  • Portal Core Integration: APIs in the SDK provide simplified integration between the ONAP Portal Core and ONAP applications. By default, any application built on the SDK will have implicit integration with the Portal Core.
  • Centralized Access Control: The Portal core acts as a gatekeeper for all ONAP applications. Site administrators decide who gets access to which applications with a distributed access management scheme.
  • Common UI Controls: These are used to ensure a common look and feel and a consistent user experience.
  • Context-Aware UI Controls: Since the ONAP Portal Core serves both as the point of entry and as the provider of context-aware menus and UI controls, it can ensure that when a user jumps from one application to another, the application menu items remain consistent and comply with the user’s access level. (This property of access control is called "Single Sign-On (SSO)".)
  • Visualization & Reporting Engine: This component is used to develop analytical reports and visualizations on AVP / RCloud / RSpeed / RAPTOR.
  • Collaborative Services: Collaboration services include video, text chatting, and screen sharing.
  • Web Component & Widget Development Framework: This framework is used to build widgets and visual components that will be hosted on the ONAP Portal Core. It has access to services exposed by ONAP applications running in separate environments.
  • Management for Internal/External Users: The administrators will import, or integrate with, internal and external users.
  • Dashboards: The Portal provides customizable dashboards tailored for each user, based on their access level. Dashboards are comprised of widgets that provide summary content hosted by applications.
  • Application Administration: Portal Core administrators can on-board and manage applications.
  • Services Registration/Discovery: Applications can publish or discover services & APIs.

4. known system limitations

Runtime: none

Language capability limitations:

  • Language support for different screens
  • Portal applications that do not use the portal SDK will not get multi-language support. 

5. Used Models

none

6. System Deployment Architecture

None.  Dependent on the user.

7 References



  • No labels