Client SDK for macOS Developers' Guide

Creating a Branding Package

In order to customize your session client, you must create a client branding package using the HP Custom Branding Package Utility. The HP Custom Branding Package Utility is located in the following location:

  • macOS clients: "path-to-unzipped-sdk-package"/sdk/usr/bin/TeradiciBrandingPackageUtility

To create a custom branding package:

  1. Create a product icon as a png file at 128px x 128px.

  2. Create a company logo as a png file at any size.

  3. Create a text layout file describing the customized UI element strings and dialog content.

  4. Create the branding package with TeradiciBrandingPackageUtility. When specifying more than one image, prefix each image with the "-i" argument. For example:

    Teradici Branding Package Utility -x my_custom_branding.xml -i <my_custom_icon.png> -i <my_custom_logo.png> -o my_custom_branding.bp
    

Teradici Branding Package Utility

Options for the branding package utility

TeradiciBrandingPackage Utility --help

Note

USAGE:
TeradiciBrandingPackageUtility  [-d] [-o <path>] [-i <image>] ... [-x <path>] [--] [--version] [-h]

Where:

-d, --dump-xml-schema
Dumps the xml schema describing the customization options and required
fields

-o <path>, --output <path>
The output filename to write to

-i <image>, --image <image> (accepted multiple times)
An image file, the file must exist on the filesystem

-x <path>, --xml-layout <path>
The layout file used to describe the customizations to be made. Note:
this file must adhere to the xml schema

–
, --ignore_rest
Ignores the rest of the labeled arguments following this flag.

--version
Displays version information and exits.

-h, --help
Displays usage information and exits.

Creates a branding package to customize Anyware Desktop Client

In this example, two images (my_custom_icon.png and my_custom_logo.png) are passed, each with the "-i" argument.

The system will respond with the output file and hash:

```xml
Output file: my_custom_branding.bp
Hash:cbc3fd3c6d001a1e1f06342bcccf2a62bd748c3cf1dd2e4c9c29561ea07bd089
```
  1. Note the output file name and the hash value. These will be passed to pcoip_client.

Last updated: Friday, February 14, 2025