ONAP Portal for Administrators

General

The ONAP Portal platform integrates different ONAP applications into a central core. The Portal platform provides common management services and connectivity, while the applications run separately.

From the Portal, users access applications. Administrators onboard and manage applications and widgets, and manage user access.

The Portal SDK for application developers includes bundled tools, technologies, and built-in capabilities such as services, APIs, and UI controls. Existing applications can migrate to the Portal with the provided APIs and libraries. See ONAP Portal SDK :ref:`Documentation<onap-portal:master_index>.

Access

Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac) at the provided URL. For example: https://<hostname:port>/ONAPPORTAL/login.html.

Access the ONAP portal via the 8989 LoadBalancer documented :ref:` here<onap-oom:onap-on-kubernetes-with-rancher>`

From the Portal, users access applications directly or by function using the Manage menu.

See also:

• Applications in the Portal

• Application Catalog

Roles

The Portal displays different menus for the following functions:

• Users

• Portal Admins

• Application Admins

• Governor

• Operator

Each application also defines a distinct set of user roles. See Users .

Admin Tasks

From the ONAP Portal, administrators:

• access the same functionality accessible to users (see ONAP Portal for users)

• manage users and application admins

• onboard applications and widgets

• edit the functional menu

Administrators see the following menu when accessing the ONAP Portal:

Left menu descriptions:

Admins Menu

Use the Admins section to:

View or search for application admins

1. From the ONAP Portal Home, click Admins in the left menu.

2. View or search for admins:

• The Admins table shows all admins in alphabetical order by first name. Select an application from the dropdown list to view admins for a single application.

• Search for an admin by entering a full or partial search term in the search box. Search by first name, last name, or user ID. Searches are not case-sensitive.

• Filter further using a combination of the applications dropdown and the search box.

Add an application admin

1. From the ONAP Portal Home, click Admins in the left menu.

2. Click Add Admin.The New Admin window displays.

3. Enter any combination of the user’s first name, last name in the search field and click Search.Note: A minimum of three characters is required to search.

4. Select the user from the results and click Next.

1. Select an application from the dropdown list.

1. Click Save.

The user can administer and manage users for the applications listed in the Admins table.

Modify application admin privileges

1. From the ONAP Portal Home, click Admins in the left menu.

2. Search for an admin and then select one by clicking the row in the Admins table (see View or search for application admins.

3. Modify the admin’s application privileges:

• Add an application to the Administrates list by selecting it from the dropdown list

• Delete an application from the Administrates list by clicking the trash icon

.

1. Click Save.

Delete an application admin

To delete an application admin completely, first remove access for each application.

1. From the ONAP Portal Home, click Admins in the left menu.

2. Search for a name and then select one by clicking the row in the Admins table (see View or search for application admins.

3. Click the trash icon

 and click OK to confirm for each application in the Administrates list.

1. Click Save.

The application Admin is removed from the table. The Admin is only removed from the Admins table when they have no application access.

Users Menu

Use the Users section to:

View or search for users

1. From ONAP Portal Home, click Users in the left menu.

2. Select an application from the dropdown list.

3. Enter a full or partial first name, last, name, user ID, or role in the search box; or click the column header to sort that column in alphabetical or reverse alphabetical order.

Add a user

Portal admins can add or manage users for any application. Application admins can only add and manage users for their specific applications.

1. From ONAP Portal Home, click Users in the left menu.

2. Click Add User.

3. The New User window displays.

4. Search for or add a new user:

• To search for a user, enter the user’s complete first name, last name, or user ID and click search.

• To add a new user, click New User, fill in the user details, and click Add New User. The new user appears in the results list.

1. Select the user from the results and click Next.

1. Select a role from the dropdown lists for each application required by the user.

2. Click Save.

The user can access the applications with the roles listed in the Users table.

Modify users and roles

1. From ONAP Portal Home, click Users in the left menu.

2. Select an application from the dropdown, search for a user, and select one by clicking the row in the Users table. The user’s access and roles display.

1. Modify the user’s role for each application:

• Add or change a user role by selecting or clearing the role from the dropdown list.

• Remove all the user’s roles for an application by clicking the trash icon

.

1. Click Save.

Delete a user

To delete a user completely, remove access for each application.

1. From the ONAP Portal Home, click Users in the left menu.

2. Select an application from the dropdown, search for a user, then click the row in the Users table to select (see View or search for users. The user’s access and roles display.

3. Click the trash icon

 beside an application and click OK to confirm.

1. Click Save.

The User is removed from the applications. The User is only removed from the Users table when they have no application access.

Portal Admins

Use the Portal Admins section to:

View or search for Portal Admins

1. From ONAP Portal Home, click Portal Admins in the left menu.

2. Enter a full or partial first name, last, name, or ATTUID in the search box, or click the sorting arrows in any column to sort that column in alphabetical or reverse alphabetical order.

Add a Portal Admin

Only Portal Admins can add or delete other Portal Admins.

1. From the ONAP Portal Home, click Portal Admins in the left menu.

2. Click Add Portal Admin. The Add New Portal Admin window displays.

3. Search for or add a new user:

• To search for a user, enter the user’s complete first name, last name, or user ID and click search.

• To add a new user, click New User, fill in the user details, and click Add New User. The new user appears in the results list.

1. Select the user from the results and click Save.

The user is listed in the Portal Admins table and can manage users and admins.

Delete a Portal Admin

Only Portal Admins can add or delete other Portal Admins.

1. From ONAP Portal Home, click Portal Admins in the left menu.

2. Search for or scroll to a name in the Portal Admins table and click the trash icon in the Delete column.

3. Click OK to confirm.

The Portal Admin is removed from the table.

Application Onboarding

Use the Application Onboarding section to:

Add an application to the Portal

1. From the ONAP Portal Home, click Application Onboarding in the left menu.

2. Click Add App.

3. The Application Details window displays.

4. Fill out the fields as described in the table:

Hyperlink only application	Select to add an application with a URL only.
Application name	Application name to display in the Portal.
URL	Application landing page for hyperlink-only applications.
REST API URL	[Optional] The endpoint for RESTful API calls.
Username	The username for the RESTful API calls. Default = Default
Password	Password for the RESTful API call. Default = AppPassword!1
Name Space	Namespace value when Application registered in AAF.
Communication Inbox	Do not fill out. Populated by the application.
Communication Key	Do not fill out. Populated by the application.
Communication Secret	Do not fill out. Populated by the application.
Upload image	Click Browse to select the application image to display in the ONAP Portal.
Allow guest access	Select to allow access for users not listed as Users or Admins.
Active	Select to make the application active.
Centralized	Indicate this application is using AAF for centralized role management.

5. Click Save.

The application appears in the Applications section and in the Application Onboarding table. The Portal Admin receives an email with Communications details.

6. Add the application URL to the appropriate Manage menu items:

7. Click Edit Functional Menu in the left menu.

8. Expand the Manage menu to find the correct items.

9. Right-click an item and select Edit.

1. In the URL field, enter the server URL of the new application and click Save.

Collect and forward application communication details

The Portal administrator forwards communications details and a list of servers to the application developer. The application developer adds the details to the portal-properties file located in \<app web directory>/WEB-INF/classes.

Prerequisites: Add an application to the Portal

1. Collect the following details and send them to the application developer.

Key-value pair	Obtain from
redirect_url = ** /** /process_csp	The redirect URL defined as ** /** /process_csp.

1. Request that the application developer:

2. Add the key-value pairs above to the portal.properties file located in ** /WEB-INF/classes.

3. Add the key-value pair shared_context_rest_url = **  to the system.properties file located in the ** /WEB-INF/conf directory.

4. Restart the application

Delete an application from the Portal

1. From the ONAP Portal Home, click Widget Onboarding in the left menu.

2. Search for or scroll to an application in the table and click the trash icon

 in the Delete column.

1. Click OK to confirm.

The application is removed from the Portal.

Widget Onboarding

Use the Widget Onboarding section to:

Add an application widget to the Portal

1. From ONAP Portal Home, click Widget Onboarding in the left menu.

2. Click Add Widget.

The Widget Details window displays.

3. Fill out the fields as described in the following table.

Application Name	Select from a dropdown list of onboarded applications.
Widget Name	The name for the widget that appears in the Widgets section of the Portal.
Width, Height	Automatically populated fields.
URL	Widget landing page.

4. Click Save.

The widget appears in the Widgets section of the Portal. Users with permissions to the widget’s application can access the widget.

Remove a widget from the Portal

1. From ONAP Portal Home, click Widget Onboarding in the left menu.

2. Search for or scroll to a widget in the table and click the trash icon

 in the Delete column.

1. Click OK to confirm.

The widget is removed from the Portal.

Edit Functional Menu

Edit or rearrange the ONAP Portal functional menus in the Edit Functional Menu section.

ONAP Portal menus have 4 levels. The menu levels correspond to how and where the menu items appear in the Portal UI.

Use the Edit Functional Menu section to:

Add a menu item

1. From ONAP Portal Home, click Edit Functional Menu in the left menu.

2. Use the arrows to expand the menu, then right-click on the intended parent menu item and select Add.

1. Enter a title for the menu item, then enter a URL or select the application to link to from the App dropdown list.

2. Click Save.

3. Click Regenerate Menu to finalize the changes and update the menu.

Edit a menu item

1. From the ONAP Portal Home, click Edit Functional Menu in the left menu.

2. Use the arrows to expand the menu, then right-click on the menu item and select Edit.

3. Make changes to the title, URL, or application and click Continue.

4. Click Regenerate Menu to finalize the changes and update the menu.

Move a menu item

1. From ONAP Portal Home, click Edit Functional Menu in the left menu.

2. Use the arrows to expand the menu.

3. Click and drag a menu item to move it.A blue line appears to indicate where the menu item will move. A blue box indicates the moved item will be a child of that item.

1. Click Regenerate Menu to finalize the changes and update the menu.

Delete a menu item

A menu item with children cannot be deleted. Delete all child menu items first.

1. From ONAP Portal Home, click Edit Functional Menu in the left menu.

2. Use the arrows to expand the menu, then right-click on the menu item and select Delete.

3. Click OK

4. Click Regenerate Menu to finalize the changes and update the menu.

Portal Microservices Onboarding

From left menu Microservice Onboarding section:

Add a microservice widget to the Portal

1. From ONAP Portal Home, click Microservice Onboarding in the left menu.

2. Click Add Microservice.

The Microservice Details window displays.

3. Fill out the fields as described in the following table.

Field	Explanation
Microservice Name	The name for the microservice that appears in the Microservice section of the Portal.
Microservice Description	Describe what the microservice does
Application Name	Select from a dropdown list of onboarded applications.
Microservice End Point URL	Enter Microservice URL
Security Type	Select from dropdown for Authentication Method
Add User Parameter	Enter parameter key and value if applicable to microservice end point URL
Active	Active check/uncheck to show/hide the microservice

4. Click Save.

The microservice appears in the Microservices section of the Portal. Users with permissions to the Microservice application can access the microservice.

Remove a microservice from the Portal

1. From ONAP Portal Home, click Microservice Onboarding in the left menu.

2. Search for or scroll to a microservice in the table and click the trash icon

 in the Delete column.

1. Click OK to confirm.

The mocroservice is removed from the Portal.