Introduction

Starting from 2.9 b795 we have extended the re-branding options to include Omniscope view versions deployed to browsers as HTML5/JS

In order to able to brand Omniscope you need:
1) Ensure getStatic="true”:

To do this, it is recommended you modify the folder.xml file and change the anonymous user permissions to allow all users to benefit from the UI customisation:
...
<anonymous>
<permissions listDirectory="false" downloadFile="false" viewInMobile="false" fileManagement="false" getStatic="true" viewServerState="false" />
</anonymous>
...


2) Have a “branding.internal\mobile” folder (see attached example folder) in the directory you want to customise under the Mobile sharing folder. Alternative, have a “branding” folder in the Omniscope installation directory.

The branding has been split into three different areas, “Admin, Server and App” where resources for each of these areas is stored inside of “branding.internal” folder.

The description below refers to the main "Mobile sharing folder" as the root folder.

Admin web server

You can customise various resources and htmls files relating to the Admin server, by placing a “branding.internal\mobile\admin” folder in the root folder.

You can then override or replace the existing files with your own custom logo or add text to the appropriate html files.

Note, placing the folder in sub-directory won't work - branding can only be done from the root folder.

Mobile web server

You can customise various resources and htmls files relating to the Mobile web server, by placing a “branding.internal\mobile\server” folder in the root mobile sharing root folder, or even in a sub-folder within mobile sharing folder to show different branding on a per-customer basis.

For example, if you have three different clients, then you can place “branding.internal\server” folder in each of the client’s directory and configure them to have their own logo etc.

App

Just like Mobile web server you can override on a per-folder basis the app-splash and favicon shown for the IOK file is loading. In order to customise app specific resources, you need create “branding.internal\mobile\app” folder in the appropriate directory containing the file.

Omniscope (Desktop/Mobile sharing)

Omniscope will look for branding\app folder in the installation branding folder (branding folder of Omniscope application itself) for the resources.

Further information

Omniscope Mobile looks for branding resources in a hierarchical way and falling back to installation branding folder.

For example, to find the favicon to load when loading the IOK file in Mobile web server. Omniscope Mobile will search for favicon.ico file in the following order:

1. Looks for branding.internal\app in the folder that contains the IOK that it is loading.
2. If found, uses that, otherwise, goes into parent folder and does the same as 1. It does this all the way up to the mobile sharing folder. Note, if the folder that Omniscope is using to display the resource is protected, then the user will be prompted to enter authentication details.
3. If it can’t find it the resource in the mobile sharing folder, it will check installed branding folder (branding folder “branding” installed in the Omniscope installation directory). No authentication is required to access resources from installed branding.
4. If it can’t find the file, it will check if the file is bundled with Omniscope, otherwise throws a File not found error.
Note: This allows you to have a possibly a generic branding inside some folder, which all sub-folders will inherit. One only needs to customise or place specific resources they want to override in the sub-folders.