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 that are displayed on the home screen of the mobile device, or as splash screens when the app starts.

Simplified use case

In a simplified use case, you can generate a full set of branding graphics for a native app automatically at the app building stage.

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

1. To obtain the sample file:
   1. Right-click the branding-assets.zip (0.1 MB) file.
   2. Save the file in your directory.

2. For Android only: Prepare the ZIP file by doing the following:

   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.

   These two files are processed automatically.

3. For iOS only: Prepare the ZIP file by doing the following:

   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.

      Optional: For better re-scaling results, you can provide the splash screen file in high resolution with either the @2x or the @3x suffix.

   All resources are automatically generated based on the template files.

Advanced use case

An advanced use case applies, if specific images are only 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.

A sample file includes a full set of branding graphics that you can replace by your custom resources.

To obtain the sample file:

1. Right-click the branding-assets-advanced.zip (0.38 MB) file.
2. Save the file in your directory.

Notes:

• When you add custom images, make sure that the directory structure, file names, and image dimensions are identical to those in the default .zip file.

• 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.

• If you encounter warnings, which indicate that you might have used an incorrect version of the .zip file, see Branding assets templates for various Hybrid Container versions on the PDN portal for guidelines on how to select the best template.

Open topic with navigation