Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 2 Current »

Page Status: Copied from Guilin-R7 - Aug-24-2020
Component Status: Pending PTL updates and ArchCom Review

Last Reviewed on:

Certified by:

1. High Level Component Definition and Architectural 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 provides the following interfaces:

Interface Name

Interface Definition

 Interface Capabilities

ProtocolVersion  Status Consumed ModelsAPI Spec (Swagger)
PortalE-1Portal Admin Interface. 

GUI to the portal administrator to:

  • Manage user and application administrations
  • onboard applications and widgets
  • edit functional menus
RESTv1Available
Internal
PortalE-2Application Admin Interface

GUI to the application administrator to:

  • Add/Update/Delete Admin to Applications

 

RESTv1Available
Internal
PortalE-3External App InterfacePlatform API for application to:
  • Get functional menu items appropriate for the current user
  • Get favorite items within the functional menu for the current user
  • Create Portal notifications for from external application
RESTv3Available
Link
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
RESTv3Available
Link
PortalE-5Session Communication Interface

Platform API for application to:

  • Session slot check (integrated through MUSIC)
  • Extend session timeout values
RESTv3Available
Link
PortalE-6Shared Context Interface

Platform API for application:

  • Set Context Value
  • Test context kep presence
  • Clear context values
  • Get context values
  • Get user information for the context
RESTv3Deprecated
Link
PortalE-7Ticket Event Interface

Platform API for the application to:

  • Accept message from external ticketing system and create notification for portal user
RESTv3Available
Link
PortalE-8Web Analytics Interface

Platform API for the application to:

  • Accept data from partner with web analytics
  • Retrieve web analytics snippets
RESTv3Available
Link
PortalE-9External Request Interface

Platform API to:

  • Add new application to the portal
  • Retrieve application information
  • Create new user as Portal Administrator
RESTv3Available
Link
PortalE-10External Access Role Interface

Platform API application to:

  • Provide active roles for the application
  • Delete user roles for the application
  • Delete roles for the application
  • Manage role information
  • Manage role function information
  • Bulk upload
  • Get Roles of User
RESTv3Available
Link

Portal however provides multi-language support.

The multi-language support provides:

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

 3. Component Description:

https://docs.onap.org/projects/onap-portal/en/latest/platform/index.html

4. known system limitations

Runtime:

  • For https Apps on-boarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
  • For on-boarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.

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

FFS.

7 References




  • No labels