Rebranding Properties(5.1)
The following are properties that can be modified by you for the customizable graphical and text elements for rebranding. Screenshots are provided to help identify the elements that relate to the properties.
Info!
We support GIF, JPEG, PNG and SVG images for all graphic properties. We recommend vector graphics so that the image scales without issue.
We do not support ICO format.
Common Properties
These properties are used for elements that are found in one or more of the supported UIs.
Properties | Description |
|---|---|
CompanyName | This property defines the text where you would like the name of company to be displayed. The company name can be found in the Desktop Client and Web Desktop. |
PrimaryColorHex | This property defines the main colour theme for all supported UIs. Different shades of the main color will be automatically generated based on the PrimaryColorHex for certain backgrounds as well as on certain headers. |
ProductName | This property defines the text where you would like the name of your product to be displayed. |
ProductVersion | This property defines the version number for your product, it does not necessarily need to follow Usage Engine's version numbers. |
BrandLogo | This property contains the location of the graphic to be used for the logo defined in the Login screen of the web interface. Recommended size 960 x 1075. |
Icon | This property contains the location of the graphic to be used for the favicon on the web and icons on the taskbar. It is recommended to use a gif formatted graphic for the icon. Recommended size : 150 x 150. |
Desktop Online Properties
These properties are used for elements found in the Desktop Online Interface.
Desktop Online Login
Icon (Found in Common Properties)
ProductName (Found in Common Properties)
WebBackgroundImage (Found in Common Properties)
BrandLogo (Found in Common Properties)
PrimaryColorHex
Desktop Online Main Dashboard
Icon (Found in Common Properties)
ProductName (Found in Common Properties)
DarkPrimaryColorHex
ProductName (Found in Common Properties)
DesktopBackgroundImage (Found in Desktop Client Properties)
WebLogoImage(Found in Desktop Documentation Generator Banner Logo)
Properties | Description |
|---|---|
DarkPrimaryColorHex | This property defines the main colour for the dark theme for the Desktop Online UI. Different shades of the color will be automatically generated based on the DarkPrimaryColorHex for certain backgrounds as well as on certain headers. |
WebLogoImage | This property contains the location of the graphic to be used for the logo in the Document Generator, (index.html). Recommended size: 540 x 166. |
Desktop Client Launcher Properties
The property is used for elements found in the Desktop client launcher.
LauncherBackgroundImage
LogoBackgroundColorHex
Properties | Description |
|---|---|
LauncherBackgroundImage | This property contains the location of the graphic to be used for the background image on your Desktop Launcher. If no background image is in use, the background color will be based on the PrimaryColorHex property. Recommended size: 1920 x 1080. |
LogoBackgroundColorHex | This property defines the background color of the desktop client launcher background image. This is an optional property, if you leave this property empty it will default to the value set in PrimaryColorHex. |
Desktop Client Properties
The property is used for elements found in the Desktop client.
Icon (Found in Common Properties)
ProductName (Found in Common Properties)
ProductVersion (Found in Common Properties)
DesktopBackgroundImage
Properties | Description |
|---|---|
DesktopBackgroundImage | This property contains the location of the graphic to be used for the background image on your Desktop client. This same image should appear on your Web Desktop background image. If no background image is in use, the background color will be based on the PrimaryColorHex property. Recommended size: 1920 x 1080. |