Table of Contents

Article

Customizing the Pega 7 login screen

The standard login and logout screens for desktop applications and mobile applications, which are accessed by using the Pega 7 app, feature Pega 7 branding:

Pega7_original-login.png

You can customize some or all of the graphic elements for these login and logout screens. However, to make any changes, you need to create and deploy a custom ruleset that contains rules that hold and display your custom images.

This article covers Pega 7. To replace the login screen in earlier versions, see How to customize the login screen (6.2 SP2).

Create and deploy a custom ruleset and access group for visitors

The default login page is displayed to guest requestors — users who have started PRPC but have not yet been authenticated by logging in. The system by default uses the PRPC:Unauthenticated access group for guest requestors.

To customize the pages, you need to create an alternate access group and a ruleset for your custom rules for the login and logout screens, and then instruct the system to use them instead of the defaults for guest requestors.

  1. Create a ruleset
  2. Create a new access group
  3. Save rules to the new ruleset

1. Create a ruleset

Create a ruleset and version to hold the custom rules for the login and logout screens. Give the ruleset a name that makes it easily identifiable, such as unauthenticated:01-01-01.

unauthenticated1.png

Log out and back in again, and the new ruleset is available for selection.

2. Create a new access group

Create a new access group for unauthenticated users.

accessgroup-guest.png

  • Enter "PegaRULES" as the application name
  • Enter the current ruleset version
  • Add the guest access role
  • Add unauthenticated:01-01 as a production ruleset to the new access group and to your own current access group (so you can save rules into it).
When you save the access group, a warning appears that the ruleset that you created is not defined in the application. You can disregard the warning for this ruleset.

3. Save rules to the new ruleset

Save copies of the standard rules listed below for customization in the unauthenticated:01-01 ruleset:

RuleDescription
web-login
  • This HTML rule defines the login page, specifying (among other things) the images to use.
  • Copy this rule into your ruleset without changing the name.

web-session-return

 

  • This HTML rule defines the logged-out page, specifying (among other things) the background image to use.
  • Copy this rule into your ruleset without changing the name.

loginCacheManifest

  • The branding logo image path should be added to the loginCacheManifest HTML rule and saved in the unauthenticated ruleset.

Update the Requestor Type

Requestor type data instances define the types of requestors that can access Pega 7, such as a browser session, an external application, or an internal background process. The BROWSER Requestor Type establishes what is available to someone trying to access Pega 7 in the normal way through the browser.

  1. In Records Explorer, select SysAdmin > Requestor Type.
  2. Find your system name in the first column and click the Requestor Type "BROWSER" related to it. Note, that it is not possible to edit prpc-BROWSER record.
  3. Add your "unauthenticated" access group to the Access Groups list and select the radio button next to it.
    browser.png
  4. Save the Requestor Type.
Ensure that the "unauthenticated" access group is selected.

Add custom images

To add custom images to the login or logout screens, you must upload them to Rule-File-Binary records in your unauthenticated ruleset.

Published August 12, 2014 — Updated November 7, 2018


81% found this useful

Related Content

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.