blob: 8fd8854f4574d90ba7b5598d4c7b3ff7d2b69b18 [file] [log] [blame]
Thomas Kulikafca8392020-02-28 08:40:49 +01001|image2017-10-27_15-56-53.png|
2
3ONAP Portal for Users
4=====================
5
6General
7-------
8
9The ONAP Portal platform integrates different ONAP applications into a
10central core. The Portal platform provides common management services
11and connectivity, while the applications run separately.
12
13From the Portal, users access applications. Administrators onboard and
14manage applications and widgets, and manage user access.
15
16The Portal SDK for application developers includes bundled tools,
17technologies, and built-in capabilities such as services, APIs, and UI
18controls. Existing applications can migrate to the Portal with the
Aric Gardner6ceaa842020-04-10 14:00:17 -040019provided APIs and libraries. :ref:`ONAP Portal SDK Documentation<onap-portal:master_index>`
Thomas Kulikafca8392020-02-28 08:40:49 +010020
21Access
22------
23
24Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac)
25at the provided URL. For example: `https://<hostname:port>/ONAPPORTAL/login.html`.
26
Aric Gardner6ceaa842020-04-10 14:00:17 -040027:ref:`Access the ONAP portal via the 8989 LoadBalancer <onap-oom:onap-on-kubernetes-with-rancher>`
Thomas Kulikafca8392020-02-28 08:40:49 +010028
29From the Portal, users access applications directly or by function using
30the `Manage menu`.
31
32See also:
33
34- `Applications in the Portal`
35
36- `Application Catalog`
37
38Roles
39-----
40
41The Portal displays different menus for the following functions:
42
43- Users
44
45- Portal Admins
46
47- Application Admins
48
49- Governor
50
51- Operator
52
53Each application also defines a distinct set of user roles. See *Users* .
54
55Portal personalization and features
56-----------------------------------
57
58Show and hide the left menu
59~~~~~~~~~~~~~~~~~~~~~~~~~~~
60
61To hide the left menu, click the menu icon. Click the menu icon again to
62show the menu.
63
64|image2017-10-31_12-21-53.png|
65
66Applications
67~~~~~~~~~~~~
68
69Access applications in the Portal directly from the `Application Catalog`
70or using the `Manage menu`.
71All the default applications in the ONAP Portal are integrated, but
72applications may also be onboarded as hyperlink-only. Integrated
73applications open in tabs below the header in the Portal; linked
74applications open in a new browser window. To close an integrated
75application, click the x in the tab.
76
77|image2017-12-5_14-53-43.png|
78
79A maximum of six applications (tabs) can be open at once in the ONAP
80Portal.
81
82Manage menu
83-----------
84
85The Manage menu provides links to applications by function. Choose from
86a list of functional or management tasks for each area. This example
87shows the options in the top-level functional Design category:
88
89|image2017-12-5_14-57-22.png|
90
91Favorites
92~~~~~~~~~
93
94Hover over a menu item and click the star beside it to add it to
95Favorites. Click the star again to remove the item from Favorites.
96
97Editing the Menu
98~~~~~~~~~~~~~~~~
99
100Portal Admins edit and manage the menu. See `Edit Functional Menu`
101
102Support Menu
103------------
104
105The Support menu provides Contact Us and Get Access links. Portal admins
106can add contact details and also edit Support menu. See `Edit Functional Menu`.
107
108Home
109----
110
111Home is the default view after login.
112
113|image2017-12-5_16-52-40.png|
114
115Personalize the Home Page
116~~~~~~~~~~~~~~~~~~~~~~~~~
117
118Add or remove applications using the `Application Catalog`.
119Sort applications or widgets by clicking the drag handle to drag and
120drop the application or widget to a new location.
121
122|image2017-12-5_16-57-24.png| Add, manage, and edit what appears in the
123widgets by clicking the settings icon and selecting Edit.
124
125|ep_home_editwidget.png|
126
127Application Catalog
128-------------------
129
130Use the Application Catalog to select which application should appear on
131your Home page. Applications with a check mark already appear on the
132Home page.
133
134- To select an application to appear on the Home page, click the check
135 box in the top right corner of the application tile.
136
137- To remove an application from the Home page, click the check box
138 again.
139
140- Use the Filter to view specific applications: All applications,
141 Accessible (currently available) applications, or applications On
142 Home Page.
143
144- Click the drag handle to sort application tiles in the Application
145 Catalog.
146
147|image2017-12-5_15-8-37.png|
148
149Widget Catalog
150--------------
151
152Widgets are small applications that interact with their host application
153and each other to provide quick access for certain tasks. Use the
154Widgets section to view and interact with widgets.
155
156- Click a widget tile to open the widget.
157
158- Click the drag handle to sort widget tiles.
159
160|image2017-12-5_15-9-27.png|
161
162
163.. |image2017-10-27_15-56-53.png| image:: attachments/16004343_image2017-10-27_15-56-53.png
164.. |image2017-10-31_12-21-53.png| image:: attachments/16004980_image2017-10-31_12-21-53.png
165.. |image2017-12-5_14-53-43.png| image:: attachments/20086818_image2017-12-5_14-53-43.png
166.. |image2017-12-5_14-57-22.png| image:: attachments/20086819_image2017-12-5_14-57-22.png
167.. |image2017-12-5_16-52-40.png| image:: attachments/20086839_image2017-12-5_16-52-40.png
168.. |image2017-12-5_16-57-24.png| image:: attachments/20086846_image2017-12-5_16-57-24.png
169.. |ep_home_editwidget.png| image:: attachments/1018906_ep_home_editwidget.png
170.. |image2017-12-5_15-8-37.png| image:: attachments/20086820_image2017-12-5_15-8-37.png
171.. |image2017-12-5_15-9-27.png| image:: attachments/20086821_image2017-12-5_15-9-27.png