Preparing custom branding assets

Branding assets are uploaded to Pega 7 Platform as a single .zip file. While the contents of this file can differ, depending on your version of the Pega 7 Platform, it holds the image files that are used as icons displayed in the Apple iTunes and Google Play app stores, on the home screen of the mobile device, or as splash screens when the app is started. The.zip file also stores CSS files to fine-tune the appearance of the bootstrap application.

Simplified use case

In a simplified use case, a full set of branding graphics used by a native application is automatically generated at application building stage.

1. Right-click and save the branding-assets.zip (0.1 MB) file to obtain the sample file.

2. Optional: For Android, the latter two files are automatically processed:

   1. Create custom splashlogo.png files in different resolution versions and place them in their respective folders.

   2. Create the notification_icon.svg file and place it within the android directory.

   3. Create the icon.svg file and place it within the common_assets directory.

3. Optional: For iOS, all resources can be automatically generated, based on template files:

   1. Create the icon.svg file and place it in the common_assets directory.

   2. Create the splashlogo.png file and place it in the ios directory. For better re-scaling results, the splash screen file can be provided in high resolution with either the @2x or the @3x suffix.

For a detailed description of the assets.zip directory structure, see Contents of the assets package.

Advanced use case

In an advanced use case, if specific images must be displayed on selected displays, for example, to create detailed icons with text visible on Retina devices only, you can create such files manually in PNG format, according to the following guidelines:

• For Android, see Google Icon Guidelines
• For iOS, see iOS Human Interface Guidelines

Right-click and save the following file, which includes a full set of branding graphics that can be replaced by your custom resources: branding-assets-advanced.zip (0.38 MB)

Notes:

• When you add custom images and CSS files, make sure that the directory structure, file names, and image dimensions are identical to those in the default .zip file.
• Color settings for the bootstrap application are made in the .css files that can be found in the bootstrap directory.

• When there is no bootstrap directory in the file, no bootstrap branding is applied.

• When a specific asset is missing from the .zip file, the device's operating system rescales the existing assets (Android) or replaces the missing assets with system-default resources (iOS).

• When the .zip file contains unnecessary files, they are ignored and a warning is displayed.

Related information

Open topic with navigation