Preparing custom branding assets

You upload branding assets to the Pega Platform as a single ZIP file. While the contents of this file can differ, depending on your version of the Pega Platform, it contains the image files for icons that are displayed on the home screen of the mobile device, and as splash screens when the app starts.

You can generate a full set of branding graphics for a native app automatically at the app building stage. If needed, you can choose to display specific images on selected displays. In the latter case, 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 the icon design section of the Material Design guidelines published by Google.
• For iOS, see the graphics section of the iOS Human Interface Guidelines published by Apple.

To avoid issues with newer devices, download the most recent version of the assets package from PDN, when you are updating an existing custom mobile app.

Generating branding graphics automatically

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 file.
   2. Save the file in a directory of your choice.

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 following files and place them within the android directory:

      • notification_icon.svg
      • keepalive_icon.svg
      • icon_round.svg

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

   The SVG files are processed automatically.

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

   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.

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

Providing a complete set of branding graphics

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

To obtain the sample file:

1. Right-click the branding-assets-advanced.zip file.
2. Save the file in a directory of your choice.

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

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

Open topic with navigation