Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Adding a new background image to your login screen

Updated on November 15, 2021
Applicable to Theme UI-Kit applications

You can integrate a custom background image into your Pega application login screen HTML through a binary file.

Before you begin: If you have not yet done so, create an authentication service. Your application requires an authentication service for users to securely log in. For more information, see Creating an authentication service.

After creating an authentication service, you must configure your browser requestor. For more information, see Configuring a browser requestor.

  1. In the navigation header of Dev Studio, selectCreateTechnicalBinary File. Pega Platform displays the Binary File Record Configuration form.
  2. Complete the configuration form:
    • In the Label field, enter a unique label for the image.
    • In the App Name (Directory) field, enter webwb.
    • In the File Type (extension) field, enter the Windows extension (for example, png, jpeg) for the file you want to upload to the binary file. Do not include a period.
  3. In the Context section, select the application that contains your unauthenticated ruleset.
  4. In the Add to ruleset list, select the unauthenticated ruleset that you created.
  5. Click Create and open to display the Binary File rule form.
  6. Click Upload file to open the file browser.
  7. Click Save. In the Image details section, Pega Platform displays the file that you uploaded and its dimensions.
  8. Note the dimensions of the image for future use in the CSS file.
  9. In the navigation pane of Dev Studio, selectRecordsTechnicalText File.
  10. In the File Name column, click the Search icon.
  11. In the search text field, enter the Text rule that contains the CSS of the login screen you want to customize with the image as a background.
  12. Click Apply.
  13. Click the resulting row.
  14. Press CTRL + F and enter the following text:

    body {

  15. In the background-image element, replace the existing values with the image name and extension in the following format:


  16. Below the background-image element, enter a background-size element with the dimensions of the image for width and height in pixels (px).
    For example: background-size: widthpx heightpx;
  17. Click Check-in to add changes to the unauthenticated ruleset that you created.
  18. Confirm that the background image appears correctly on your background for the selected login screen.
What to do next: If you want to edit the source CSS of your login screens, see Editing the text rules containing the source CSS for login screens.

If you want to edit the source HTML of your login screens, see Editing the source HTML of your login screen.

  • Previous topic Editing the text rules containing the source CSS for login screens
  • Next topic Styling controls at run time

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us