Colligo Briefcase. White Labeling

Transcription

1 White Labeling

2 CONTENTS White Labeling... 2 Registry Path and License Key... 2 Enabling Branding... 2 Disabling Branding... 2 Using the MSI... 3 Using Registry Settings... 4 Branding Properties and Locations... 5 Start Menu... 5 System Tray... 6 File Manager Root Folder... 6 About Screen and Splash Screen Images and Locations... 7 About Screen Image... 7 Splash Screen Image... 7 Page 1 of 7

3 White Labeling Colligo Briefcase includes the ability for customers to replace any instances of Colligo branding with their own company name and information. This document describes the fields and locations in Colligo Briefcase where you can modify that information, and provides a script with the keys that you can add to your registry. Registry Path and License Key All registry keys for Colligo Briefcase are located at the following file path: HKEY_LOCAL_MACHINE\SOFTWARE\Colligo\Contributor\Branding. Enabling Branding To enable branding, you need a branding-enabled license key, which you can purchase from Colligo. You have two options to modify the branding locations in the product: Add the branding settings to the MSI file and deploy the file to all users: see Using the MSI Update your users registries with the branding registry keys: see Using Registry Settings Disabling Branding To disable branding you can install a license key that doesn t include branding capability, or you can set the registry key EnableBranding to 0. However, there are 4 properties that you cannot set in the registry, so those properties would not change. Page 2 of 7

4 Using the MSI To update the MSI file: 1. Download and install Orca, a Microsoft MSI editor, from the following location: 2. Open the MSI file in Orca. 3. Navigate to the Property table in the Tables list. 4. From the Tables menu, select Add Row. The Add Row dialog displays: 5. Enter the Property name and Value. 6. Click OK. The new property displays in the Property Table. 7. Using this approach, add all the relevant properties listed in Branding Properties and Locations. Page 3 of 7

5 Using Registry Settings The following text is the registry script for the branding locations. [HKEY_CURRENT_USER\] "EnableBranding"="1" ;Generic needed branding property [HKEY_CURRENT_USER\] "AboutScreenFileName"="About.png" "AboutScreenInfoLocation"="300,30" "SplashScreenFileName"="SplashScreen.png" "SplashScreenInfoLocation"="330,250" "SystemTrayAppName"="Colligo Branding App Name" These keys are not present by default in the registry. To add them: 1. Copy and paste the script into Notepad. 2. Save the file as.reg. 3. Double-click the file to open it and add to the registry. 4. Enter your company name or the preferred wording in the second half of each key. NOTE: The following 4 properties can only be modified in the MSI file: CONTRIBUTOR_SHORTCUT_NAME START_MENU_FOLDER FILE_MANAGER_FOLDER_NAME Page 4 of 7

6 Branding Properties and Locations The following table describes the property names and registry keys for the different instances of branding throughout Briefcase. MSI Property Name Registry Key Default Value Format FILE_MANAGER_FOLDER_NAME n/a Text START_MENU_FOLDER n/a Text CONTRIBUTOR_SHORTCUT_NAME n/a Text ENABLE_BRANDING \EnableBranding 1 = enabled 0 or 1 ABOUT_SCREEN_FILENAME ABOUT_SCREEN_INFO_LOCATION SPLASH_SCREEN_FILENAME SPLASH_SCREEN_INFO_LOCATION SYSTEM_TRAY_APP_NAME Start Menu \AboutScreenFileName \AboutScreenInfoLocation \SplashScreenFileName \SplashScreenInfoLocation \SystemTrayAppName The following MSI properties display in the following locations: CONTRIBUTOR_SHORTCUT_NAME START_MENU_FOLDER Text x-pixel,ypixel ( 100,200 ) Text x-pixel,ypixel ( 100,200 ) Text Page 5 of 7

7 System Tray The registry key SystemTrayAppName displays in the following locations: File Manager Root Folder The MSI property FILE_MANAGER_FOLDER_NAME displays in the following location: Page 6 of 7

8 About Screen and Splash Screen Images and Locations The AboutScreenFileName and SplashScreenFileName registry settings point to a new About or Splash screen image. You can give the image names absolute paths, or by default, Briefcase looks for the images in one of the following locations: o %LOCALAPPDATA%\ColligoOfflineClient\Config\Branding o %APPDATA%\ColligoOfflineClient\Config\Branding o %ALLUSERSPROFILE%\ColligoOfflineClient\Config\Branding The AboutScreenInfoLocation and SplashScreenInfoLocation registry settings refer to the location of the version and build number on the About and Splash Screens. About Screen Image The registry keys AboutScreenFileName and AboutScreenInfoLocation display in the following locations: Splash Screen Image The registry keys SplashScreenLocation and SplashScreenInfoLocation display when you first launch Briefcase. Page 7 of 7