STATUS: DraftProject approved, ArchCom Approved

Portal:

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.

...

• 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:CLAMP provides the following interfaces: (to be done, add the links)

Interface Name	Interface Definition	Interface Capabilities

Interface Name

Version

Interface Definition

 Interface Capabilities

CLAMPE

Status	Consumed Models
PortalE-1

Control Loop Lifecycle Management

Portal Admin Interface.

  A user interface for:

• Selecting the control loop flow
• entering configuration policy paramaters
• entering operational policy parameters
• Managing lifecycle of DCAE conrol flow blueprint 

CLAMPE-2Control loop dashboard.  User interface to show the status of the control loop

 Display and update:

xxxxx

	GUI to the portal administrator to: Manage user and application administrations onboard applications and widgets edit functional menue
PortalE-2	Application Admin Interface	GUI to the application administrator to
PortalE-3	External App Interface	Platform 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
PortalE-4	Role Approval Interface	Platform API for application to: Delete application roles for a user Create application user with specific roles Updates user to have specific roles
PortalE-5	Session Communication Interface	Platform API for application to: Session slot check (integrated through MUSIC) Extend session timeout values
PortalE-6	Shared 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
PortalE-7	Ticket Event Interface	Platform API for the application to: Accept message from external ticketing system and create notification for portal user
PortalE-8	Web Analytics Interface	Platform API for the application to: Accept data from partner with web analytics Retrieve web analytics snippets
PortalE-9	External Request Interface	Platform API to: Add new application to the portal Retrieve application information Create new user as Portal Administrator
PortalE-10	External 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

Portal however provides multi-language support.

...

 3. Component Description:

A more detailed figure and description of the component.

Image Removed

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

Add link to read.the.docs

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:

...

6. System Deployment Architecture

None.  Dependent on the user.FFS.

7 References

• Portal Architectural Description: https://onap.readthedocs.io/en/latest/submodules/portal.git/docs/platform/architecture.html
• Portal APIs Specification: https://docs.onap.org/en/beijing/submodules/portal.git/docs/platform/offeredapis.html
• Portal on OOM