/
Rebranding Your Deployment(5.1)

Rebranding Your Deployment(5.1)

Warning!

You will need to rebrand your deployment for every new installation or upgrade.

Preparing the Rebranded Package

The following steps will instruct you on how to create a rebranding package for you to use in rebranding your deployments. You will need an existing Usage Engine deployment on your end to run the necessary commands required to build the package.

  1. Have your Usage Engine installed and Platform is running.

Note!

Please approach support to get the zip file.

  1. Extract the zip and replace all the default graphics with your rebranded graphics and the default property values with your own. You can use Java jar utility to extract the file.

    jar xvf UEPE-Rebranding-master.zip cd <REBRANDING_UNZIP_DIR>

    Upon extraction, you will find a branding.properties file where you will be able to make changes to properties related to certain graphical and text elements in the supported UIs. 

    ls -l com/rebranding/assets/branding.properties

    You can find more information about the properties at Rebranding Properties(5.1).

  2. Run this command to package the updated properties and images into a jar file.

    jar -cvf brand.jar com/digitalroute/rebranding/*.class com/rebranding/assets/*.*

  3. Run this mzsh command to package the brand.jar into your very own brand_<version>.mzp .

    mzsh <username>/<password> pcreate Brand <version number> <mzp filename> -level platform file=brand.jar

Example!

mzsh mzadmin/dr pcreate Brand 1.0.1 brand_1.0.1.mzp -level platform file=brand.jar

Steps to Rebrand Your Deployment

These steps will instruct you on how to include your branding in an installation package. It is important to rebrand the package before you provide it to your customers. You will need to rebrand your package for every new installation or when there is an upgrade to be made.

  1. Deploy Usage Engine on the private cloud or AWS infrastructure. This will be the Usage Engine installation that will be used by your customer. Your Platform database must be persisted for the brand to persist.

  2. Run this kubectl command to move the brand_<version>.mzp from your local filesystem into the Platform pod. 

    kubectl cp brand_1.0.1.mzp <namespace>/<platform pod>:/destination/for/brand.mzp

  3. Run this mzsh command in the Platform pod to commit the changes from the brand_<version>.mzp to the deployment

    mzsh pcommit brand_1.0.1.mzp

  4. Delete the Platform and Web Desktop pod to trigger a restart for the changes to take effect on your deployment.