docs/guides/onap-user/onap-portal-user/onap-portal-user.rst

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