Branding of the WinCC OA MSI Installation

Important: The branding package is available for OEM customers on https://winccoa.com. Note that the branding is only available for customers with a corresponding contract.

This chapter gives you a brief overview of the possibilities of branding. You can find detailed examples of branding in the chapters Branding Example of Use 1 and 2.

Note: The product branding feature of WinCC OA provides you with even more options than what is described within these chapters. To clarify your detailed requirements and what limitations apply for more advanced options get in contact with ETM professional control GmbH

You can adapt the texts and the layout of the WinCC OA setup to your wishes:

CAUTION: To avoid dll hijacking attacks, on the computer on which the setup is generated, upgrade the WIX software 3.10 to 3.10.2. Caution, the WIX version 3.11 cannot be used.

Change the product name, the manufacturer, the default installation directory, the product directory as well as the start menu entries

  • For the brand labelling automatism switch to the to the Branding/Resource folder. The ProductConfiguration.wxi file defines the name of the product, the manufacturer, the standard installation directory, the project directory as well as the start menu entry names. The product name, the product long name, the description and the installation and project directories are shown in the install wizard (see the Branding Example).

    The manufacturer is shown in the control panel -> Programs and Features and the comments via right-click on the setup-exe file -> Properties. For the desktop UI option, see chapter Branding the Desktop UI Installation.

Figure 1. ProductConfiguration.wxi file

Change the version number, visibility of the version text and the version text color

In the ProductVersion.wxi file you can change the version number - Note that a higher version number is required for each major upgrade and that leading zeros are cut from the version number.

Figure 2. ProductVersion.wxi file

In the BundleFeatureStructure.xml file you can change the visibility of the version text and the version text color:

Figure 3. Parameter VersionStringVisible and VersionStringColor

The version text is visible by default and the color is #FFFFFF (white).

Figure 4. Setup with version string
Figure 5. Setup without version string - VersionStringVisible= "no"

The color of the progress bar can be changed in the BundleFeatureStructure.xml by changing the color of the "ProgressBarColor" - see figure below:

Figure 6. BundleFeatureStructure.xml - "ProgressBarColor"
Figure 7. Color of the Progress Bar

Change the login panel image, splashscreen and the logo of the password dialog

To brand WinCC OA login panel image, splash screen and the logo, these can be changed in the directory BuildStructure/data/webClient:

Figure 8. Branding images
Figure 9. Changed splash screen and logo

Change the setup texts

The Theme_[language].wxl file contains the setup texts, which can be adapted. Below you can find a figure of the Theme_en-us.wxl. You can change the texts <String Id="[Name]"> :

Figure 10. Branding - Theme_en-us.wxl file

Change the names of the components that are opened via the shortcuts of the start menu

The lower part of the file contains the names of the components that are opened via the shortcuts of the start menu. These can be branded for your product (see the figure below).

Figure 11. Branding - Theme_en-us.wxl file - Shortcuts

The Option for the Default help

You do not have to change the option Default Help.

The Default Help option defines the default documentation option for the setup. For the Theme_en-us.wxl file the default option is the english documentation.

Figure 12. Branding - Theme_en-us.wxl file - Default Help Options

Change of the EULA file (EULA license agreement)

You can change the EULA license agreement in the file Branding/Resources/WinCC_OA_EULA.html file.

CAUTION: The name of the license file may not be changed!
Note: The license agreement of the desktop UI cannot be branded.
Figure 13. EULA license agreement file: Branding/Resources/WinCC_OA_EULA.html

Generate Setup

In order to generate a brand labeled setup, open the command line and the branding directory. Call the build.bat with the following parameters:

  • If the product should not be digitally signed: build.bat -name [Productname.exe]

  • If the product should be digitally signed: build.bat -name [Productname.exe] -sign [Path_to_PFX] -pass [Password]:

     build.bat -sign certificate_[certificateName].pfx -pass MyPassWord -name MyExeName.exe

The Deployment directory contains all other files that are necessary for the deployment of the Executable.

The brand labeled setup is saved in the Branding/Output directory. Open the .exe file.