.. _set_the_login_page_theme:

Set the Login Page Theme
------------------------

.. _12.5(1)|VOSS-346:
.. _18.1-Patch-Bundle-3|VOSS-346:
.. _21.1.1|EKB-5993:


#. Choose the hierarchy level in which the theme was created or to 
   which the theme belongs.
#. Choose **Role Management > Themes** to open the Themes list view.
#. Click the required **Theme Name** that you want to use for the Login page.   
#. On the **Base** tab, select the **Use this Theme to style Login page** check box.

   If the check box is selected, and a theme with the same Interface already has the
   Login page check box selected, this will result in the disabling of the 
   check box on the existing theme. There can only be one Interface-Login page
   combination on the system, so that any new themes or updates to existing themes
   may modify other themes on the system with the same Interface by disabling their
   Login page attributes. If no Interface is specified, the new login theme will
   also have its interface set to Administration.

#. On the **Login Page Details** tab, enter the required text in the **Title** field
   and **Banner Text** field. The text entered in the **Title** field will be
   displayed at the top of the Login page, above the logo. The text entered
   in the **Banner Text** field will be displayed at the bottom of the Login page,
   below the **Log In** button.

   The banner text input box allows for multi-line input so that paragraphs
   can be created. 
   
   The maximum character length of the banner text is 2048 characters.
   
   Banner text is displayed in the format that it is entered into the input box
   upon configuration. If cookie and security policy references are added, these
   show as links that open in new browser tabs.

#. In the **Banner Text** field, references to the cookie policy and privacy policy are added to the text as
   placeholders:
   
   * ``{{cookie_policy}}``
   * ``{{privacy_policy}}``
   
   Input boxes are available on the Banner input form to add a caption and URL for each.
   
   Although the cookie and privacy policy references are both optional,
   both their caption and URL fields become mandatory if they are used.
   The placeholder reference is then also required in the banner input box.

   For suggested input on the use of cookies by VOSS-4-UC in the cookie policy text,
   see :ref:`VOSS-4-UC_cookie_policy`.

   Note that if a browser has a blocker installed that prevents new tabs from opening,
   this will affect the functionality of the links in the login banner.

   Privacy policy links can also be added to user menus.
   Refer to :ref:`privacy_policy_menu_items` and :ref:`manage_privacy_policy_menu_items`.

   To customize the banner text style, refer to the topic on "Theme Banner Customization"
   in the "Advanced Configuration Guide".

#. Click **Save** on the button bar when complete to implement the selection.


The Login page theme can also be applied to the login page during the log in
process. Do this by adding the URL parameter ``theme=<theme-name>`` to the login request URL.
This usage in the URL will apply and override any theme that is set as the login theme.

For example, when 2 themes are available in the system,
XYZ and ABC and XYZ login page is set to be the *default*:

* Legacy Admin GUI:

  ``https://instance/login/``  - Login page will show use XYZ theme
  
  ``https://instance/login/?theme=ABC`` - Login page will show use ABC theme
* New VOSS Admin Portal:

  ``https://instance/portal/#/admin``  - Login page will show use XYZ theme
  
  ``https://instance/portal/#/login?targetAppMode=admin&theme=ABC``  - Login page will show use ABC theme
* Business Admin Portal:

  ``https://instance/portal/#/business-admin``  - Login page will show use XYZ theme 
  
  ``https://instance/portal/#/login?targetAppMode=business-admin&theme=ABC``  - Login page will show use ABC theme


.. |VOSS-4-UC| replace:: VOSS-4-UC
.. |Unified CM| replace:: Unified CM