Configuration

All Project and Screen Configurations are saved on the OAS server, and as changes are made, these Configs are updated immediately. This means that any user opening those Screens will see new updates when the browser loads.

Configs are managed by opening the App Options menu from the Admin Tools in the side bar.

Admin Tools

App Configuration

In addition to the Project and Screen Configs are settings at the server level. These include custom branding and session behavior.

Application Title - the title that appears in the Top Nav along with the logo or image defined in the Theme

Logout when idle - forces the session to end when no user activity is detected in the browser

Timeout/Warning - when automatic logout is enabled, the timeout (minutes) is the hard limit for when an inactive session is invalidated and the browser returns to the login Screen. The warning (seconds) is the time before the hard limit is reached when an idle warning alert is displayed to the user.

Session Check - because the server maintains the session state, this is the interval (minuites) at which the browser checks for a valid server session, in case the server session invalidates before the browser session expires.

Saving a Config

If you would like to save a Config as a backup or to use on another server, select Save Configuration from the Options menu.

In the Name field, enter a title for the backup. This will be saved on the OAS server with this name, so select something that will help you remember the purpose of the backup.

Then select the Projects and Screens you would like to include in the backup. Optionally, you can select to Save All if you want a full backup of the current config.

Finally, if you check the box to download the backup, along with a server backup, you will be prompted to save the backup to a local file. This can be used to load into another server or back into the current server if you choose.

Loading a Config

To load a saved Config select Load Configuration from the Options menu

Next, you can either choose to select an external file from a previous saved Config, or you can load a previously saved Config saved on the current server. You can also choose to Restore Default Config.

WARNING

Choosing to restore the default config will overwrite the existing configurations on the server. All unsaved data will be lost. Before doing this, be sure to back up your configuration, either on the server or as a local file...or both.

When you select to load a config, either from a local file or from a config on the server, you can then chose which elements to load.

From this Screen you can choose to Overwrite Current App Configuration, which will load the previously saved title and automatic logout options, otherwise the current options will be retained.

Then you can select which Projects and Screens to load. If you do not select Retain existing Projects, your current Projects and Screens will be lost.

Security Configuration

Select Security Configuration to apply access rights to Projects and Screens.

From this option you will be able to select which Security Groups will have access to Read or Edit Projects and Screens. These Security Groups are configured on the OAS server from within the OAS Configuration App.

Optionally, you can choose to select which Projects and Screens are marked as Public. Doing so will make them accessible without a login session. This is also referred to as Public Mode.

The following is a breakdown of how access rights operate:

Server Level

Within the OAS Server, apply access levels to Security Groups to either disable access (default), enable access, or assume admin rights. Access only guarantees that the users within that group can log into the UIEngine, but an Admin must grant rights to Projects and Screens for either viewing or editing.

In short, Access is the base level needed to be able to log into the UIEngine, and Admin is full administrative access. All other rights are managed within the application itself by Admins only.

ActionNo AccessAccessAdmin
Log into UIEngine
Access UIEngine options
Save/Load configurations
Set Project/Screen security
Set UIEngine theme
Edit Projects/Screens
Add/delete media

Read more about configuring Server Security

Project Level Access

ActionNoneOperatorEditor
See the Project in the sidebar
Edit Project name
Add/Remove Screens
Rearrange Screens

TIP

Marking a Project as NOT Public will disable all public access to any Screens within it, even if sub-Screens are marked Public. This is a quick way to shut down or enable access on all sub-Screens. Once a Project is marked Public, only those sub-Screens also marked public will be accessible without a login session.

Screen Level Access

ActionNoneOperatorEditor
See the Screen in the sidebar
See the Screen in Run Mode
Edit Screen name & options
Edit Screen and components
See and access the Project Nav
See and access UIEngine Docs Search

WARNING

While you may grant access to run or edit Screens within the UIEngine, reading or writing live OAS Tag data must also be granted to the same security group if you would like those users to interact with live data.

Read more about OAS Server Security

Public Level (Public Mode)

When a Screen has been marked as Public, users without a login session have the following access

ActionAccess
See the sidebar and tools
See the Screen in Run Mode

WARNING

Users without a login session are granted access to OAS Tag data under the Default security group. If you would like live data to be available on Public Screens, you must grant read access to those Tags for the Default group within the OAS server.

Read more about OAS Server Security

Custom Themes

If you would like to configure your server and application to match your own company branding, or if you would just like to customize the login Screen, you can create your own Theme. At any time you can switch Themes from this menu, as well.

The Default Theme cannot be deleted or edited, but you can create a new Theme by clicking the icon.

Give your Theme a unique name and description and edit any of the text, color, and image fields. The Preview thumbnail will update to help you to visualize your changes.

Last Updated: