Configuring Preferences

There are several top-level settings that can be configured under the Provisioning area of edgeCore.

Default Preferences #

Default Preferences have more options than Domains, and are accessed by clicking the “Manage By” pull-down, and then selecting “Defaults”.  Preferences are found under the “Preferences” tab.

Global preferences include the following properties:

Property
Description
Session Timeout

This shows the read-only default Session Timeout in minutes. The system default is set to 60 minutes.

This value is a read-only property because it is applied on a server initialization, and thus cannot be changed without restarting the server.

See Session Management for more information.

Custom Login Page Defines the location on the filesystem for a custom login page. If a login page is not found, the system will fall back to the system shipped login page.

Refer to the Login Page documentation for further information.

Touch Icon The Apple touch icon affects mobile devices. It appears as soon as you add it to your home. An administrator can change the Touch Icon image that will appear on mobile devices by placing a new apple-touch-icon.png in the following location:

[Install_Home]/static-web/lookandfeel/

Look and Feel Preferences #

This section allows an administrator to customize the default look and feel of edgeSuite. Look and Feel files have been bundled together on the server for ease of deployment. Configuration has been streamlined so it only requires an administrator to point to a directory on the server. If the appropriate file names exist in that directory, then the client will pick them up automatically. If not, then the client will use default edge-branded look and feel elements. If the selected Look and Feel refers to files that do not exist on the server (e.g. the files were somehow deleted), the server will fall back to the system default Look and Feel.

The Name of the look and feel directory is the only property that is needed. The rest of the properties are read-only values that show whether appropriate files exist on the server.

Property
Description
Name

Name of the look and feel directory. edgeSuite ships with two base look and feel directories:

  1. Edge Light
  2. Edge Dark
Theme The edgeSuite system theme used by this look and feel.
Title Prefix This property affects the prefix used inside the HTML <title> tag for all pages in the system. The default value for this prefix is “edge:”. A page’s name is concatenated with this STRING to form the value used as the title in the underlying HTML. For example, if a user clicks on a tab called “Summary”, then the title will for the corresponding page would be “edge: Summary”.

The Prefix Value + Page Name will appear as the name when bookmarking any page in the system.

Banner Logo

The logo that appears in the upper left hand corner of the edgeSuite banner bar. By default, this references the system provided Edge logo. As a system shipped file, it should not be edited since any such changes will be lost upon future upgrade.

About Logo The logo used on the About and System Information Screens.
Favicon

The icon that appears on web browser tabs.

Creating a Custom Look and Feel #

To create a custom Look and Feel, create a new directory under

[Install_Home]/static-web/lookandfeel/  

The name used for this directory will also be the name of the Look and Feel presented in the administrator’s user interface. You can place the following files in this directory:

File Name
Description
bannerLogo.png

The logo that appears in the upper left hand corner of the edgeSuite banner bar. The system default CSS has a CSS class that sets the banner’s logo height to be 48px. This will resize any “bannerLogo.png” to be the appropriate height for the banner.

.navbar-brand-logo {height: 48px;}
aboutLogo.png

The logo that appears in the on the About and System Info pages. The system default CSS has a class that sets the logo width to be 320px. This will resize any “aboutLogo.png” to be the appropriate width for the About Dialog.

.about-logo > img {width: 320px;}
favicon.ico The icon that appears on web browser tabs.
override.css

This is a collection of CSS classes used to override default edgeSuite theme values. This file can be used to alter the appearance of the user interface, resulting in a custom theme.

For example, to change the banner’s background-color simply add the following property to the override.css file in the appropriate directory:

#edgeBannerContainer {background-color: #336699;}
setting.properties Contains three properties:

  1. title.prefix
    title.prefix is for setting the browser’s tab title prefixed with page name. To use domain name just reference it with ${domain} and to add a space at the end just put in \u0020, for example: title.prefix=${domain}:\u0020
  2. theme.name
    theme.name is the edgeSuite system theme to use as the base for this LAF. Currently only Light and Dark theme are supported, for example: theme.name=Light
  3. theme.edge.darklogo
    theme.edge.darklogo is for setting the “Powered by Edge” Logo at the upper right corner of the page when a custom LAF is used. A value of true will use a dark “Powered by Edge” Logo, otherwise (default) a light color will be used.

Overriding Look and Feel per Domain #

You can provision a look and feel at the Domain level as well as at the default. If a look and feel directory is missing a file, then the missing file will look up the ancestor chain in the following order:

  1. Domain Look and Feel
  2. Default Look and Feel
  3. System Look and Feel (edge branded files shipped with the product)

For any given LAF (except system defined Edge Light and Edge Dark), you can suffix .png file with -<domain name> to get a domain override for that LAF. For example you can create ‘Fire’ LAF directory and place a bannerLogo-domainA.png in it along with the set of files listed above and assign domainA LAF Fire. Then, when a user logs in with domainA, they will see bannerLogo-domainA.png instead of bannerLogo.png.

Overriding System favicon #

To override system favicon.ico, place your favicon.ico file into [Install_Home]/static-web/lookandfeel/. Edge Dark or Edge Light LAF, as well as login page, will use this favicon. You can view what favicon will be used under the Preferences tab in the Domain or the default provisioning UI.

No Domain Override for Apple Touch Icons #

There is no support for Domain-level overrides of Apple Touch Icons at this time.  An administrator can override the system default apple-touch-icon.png, but it will be used regardless of who is logged in. To override the system’s default, place apple-touch-icon.png in the following location:

[Install_Home]/static-web/lookandfeel/ 

Domain Preferences #

Domain preferences are currently restricted to Session Timeout. They are accessed by clicking the “Manage By” pull-down, and then selecting Domains and clicking a Domain name and the “Preferences” tab.

Property
Description
Inherit Session Timeout from Default

Allows an administrator to override the Default Session Timeout per Domain. The choices are:

  1. Yes: Inherits the Default Session Timeout for the Domain
  2. No: Allows a custom Session Timeout

If No, a “

Setting the Session Timeout to -1 will prevent the session from timing out. This is often used in conjunction with Kiosk mode.