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

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