Home Search

DriveWorks Pro 23
Live UI Settings

Send Feedback

Live UI Settings

The configuration of the DriveWorks Integration Theme Live UI can be controlled within the site itself.

To access settings:

  1. Open the site in a browser and login to the Group as an administrator.
  2. Click the Settings button from the bottom of the Live UI menu.

The settings page allows the behavior and appearance of the site to be modified.

To access the settings page the user requires the Administer Group Security permission.

For more information on DriveWorks Security please refer to: Security Settings - General.

Group Configuration

Group Alias

The Group Alias property allows you to set the alias your group is hosted under.

By default the alias is - but can be customized by modifying the DriveWorksConfigUser.xml file.

A Group Alias is a saved connection that can be easily retrieved using the Client SDK and the Server API.

For more information on modifying the DriveWorksConfigUser.xml file please refer to: Integration Theme Settings.

To change the Group Alias and have the site log into a different group:

  1. Click Edit...
  2. Enter the new Group Alias
  3. Depending on the login method either:
    1. Enter a username and password
    2. Click Login
    Or:
    1. Click Sign in with Microsoft

      Microsoft Entra Id will need to be configured for this to work.

      Please refer to: Using SSO with DriveWorks Live for more information on configuring this.

    The credentials used need to be for a user with the Administer Group Security permission.

Site Configuration

Brand Name

This is the name of the site used in the browser tab name.

The value entered here will be appended after the page name a pipebar in the tab name eg.:

  • Login | [Brand Name]
  • Projects | [Brand Name]
  • DriveApps | [Brand Name]
  • Run | [Brand Name]
  • History | [Brand Name]
  • Details | [Brand Name]
  • Settings | [Brand Name]

Specification Ping Interval

A Specification will timeout after a configured period of inactivity (see specificationTimeout for more information).

This function prevents a Specification timing out as long as the page is in view.

The default value is 30 seconds.

To disable the ping you can set this to 0.

These settings control the behavior of the navigation pane.

This controls if the icons are displayed next to the navigation items:

  • Projects
  • DriveApps
  • History

Default value is true, this will display the icons.

Login

These settings control the behavior of the Login page.

Enable Login Return URLs

This controls the behavior when a user browses to a page without being logged in.

In this scenario users are redirected to the login page.

This setting controls if the page they had browsed to is remembered.

With this set, the original url will be appended to the address when redirected to the login page.

Doing so will restore the previous location after logging in successfully.

Redirect URL

This is the next page after a successful login.

Default value is Projects, this will navigate to the Projects page after login.

Login Options

The Integration Theme provides two methods of authentication:

This allows you to chose which method is available to your users.

By default, Both is selected enabling both methods of authentication.

Log Out

These settings control the behavior of the when logging out of the site.

Redirect URL

This is the next page after a logging out.

Default value is /index.html, this will navigate to the Login page.

Project

These settings control the behavior of the Run page when a specification is displayed (when a project is run).

Redirect on close

This is the next page after a specification is transitioned.

Default value is /details.html, this will navigate to the Details page when a specification is transitioned.

Redirect on cancel

This is the next page after a specification is cancelled.

Default value is /projects.html, this will navigate to the Projects page when a specification is cancelled.

DriveApps

These settings control the behavior of the Run page when a DriveApp is displayed.

Redirect on close

This is the next page after a DriveApp is transitioned.

Default value is /details.html, this will navigate to the Details page when a DriveApp is transitioned.

Redirect on cancel

This is the next page after a DriveApp is cancelled.

Default value is /driveapps.html, this will navigate to the DriveApps page when a DriveApp is cancelled.

Run

These settings control the behavior of the Run page.

Show Warning on Exit

This functionality is limited by browser support and isn't 100% reliable.

This controls if a dialog is displayed when a user tries to close the browser/tab while a specification is still running.

Default value is false, this will not show a dialog to users when they try to leave a running specification.

Loading Custom Scripts

This controls if a custom script is loaded when a project/DriveApp is started.

Default value is false, this will not load a custom script, .

Loading Custom Styles

This controls if a custom style sheet is loaded when a project/DriveApp is started.

Default value is false, this will not load a custom style sheet, .

Please refer to: Custom Project Content for information on doing this.

History

These settings control the behavior of the History page.

Update Interval

This is how regularly the data on the History page will be refreshed.

Default value is 60 seconds, this will refresh the specification list every 60 seconds.

Display Specification Properties

Default value is true, the Expand button will be available on each specification and at the top of the page to show specification properties.

Pre-load Specification Properties

Default value is false, specification properties will only be retrieved when the specification is expanded using a button.

Pre-loading specification properties can impact performance as more data is retrieved from the server.

Search Specification Properties

Default value is false, specification properties will not be searched when using the search box.

See To Add a Specification Property for more information.

Searching specification properties will have a significant negative impact on server performance, especially with a large amount of specifications.

Details

These settings control the behavior of the Details page.

Update Interval

This is how regularly the data on the Details page will be refreshed.

Default value is 5 seconds, this will refresh all the specification and it's properties, transitions, and documents every 5 seconds.

Show "Start New Specification" Action

This controls the visibility of a button to start a new specification based on the same project the existing specification was created from.

Default value is true, this will display a "New" button on the Details page to easily start a new specification.

/command Function

These settings control the behavior of the /command behavior.

For more information on using the /command behavior please see How To: Create and Edit Specifications Using URL Parameters.

Default Group Alias

This allows you to set the alias used by the command functionality.

Default value is <blank>, this won't allow users accessing the /command page to automatically log in.

Setting this to an alias with credentials declared inside the DriveWorksConfigUser.xml file will enable automatic login when accessing the /command page if no alias has been declared in the query string.

Default Project Name

This is the default project run after accessing the command functionality.

Default value is <blank>, this won't start a specification automatically after accessing the /command page.

Setting this to the name of a project will automatically start a specification based on that project when accessing the /command page if no project or specification has been declared in the query string.

Auto Login

This controls if a user accessing the command functionality is automatically logged in.

Default value is false, this won't automatically log a user is using the Default Group Alias when accessing the /command page.

Setting this to true with a Default Group Alias declared will automatically log users accessing the /command page into the site.

Require New Session

This controls if a new session is started or an existing session used when accessing the command functionality.

Default value is false, this won't log any existing sessions out.

Setting this to true will log any current session out and, in combination with Auto Login, log in with the Default Group Alias.

Require Exact Alias

This checks if the current session is using the same alias as the provided alias.

Default value is false, this won't log any existing session out.

Setting this to true will log out the current session if the provided alias doesn't match the existing session's alias.

Appearance

Each section within appearance allows you to configure the colors for the Light color scheme and Dark color scheme.

If you have modified an appearance from the default a reset icon will be visible to set the value back to the default.

Color Picker

Settings color picker

When setting a color you can use any CSS declaration method:

  • Hexadecimal

    eg. #eee, #171717, #0001, #ffffff0d

  • RGB

    eg. rgb(255, 255, 255), rgba(255, 255, 255, 0.05), rgb(255 255 255 / 5%)

  • Named colors*

    eg. rebeccapurple, aliceblue, etc.

  • HSL (Hue, Saturation, Lightness)*

    eg. hsl(150 30% 60%), hsl(150 30% 60% / 80%)

  • HWB (Hue, Whiteness, Blackness)*

    eg. hwb(12 50% 0%), hwb(194 0% 0% / 0.5)

  • LAB (Lightness, A-axis, B-axis)*

    eg. lab(50% 40 59.5), lab(50% 40 59.5 / 0.5)

  • LCH (Lightness, Chroma, Hue)*

    eg. lch(52.2% 72.2 50), lch(52.2% 72.2 50 / 0.5)

  • Oklab (Lightness, A-axis, B-axis)*

    eg. oklab(59% 0.1 0.1), oklab(59% 0.1 0.1 / 0.5)

  • Oklch (lightness, Chroma, Hue)*

    eg. oklch(60% 0.15 50), oklch(60% 0.15 50 / 0.5)

Declarations with an asterisk (*) won't update the color preview swatch.

Additionally, inherit can also be used to inherit the color from a previous declaration.

Appearance - Base

Logo

Uploading a file here will replace the logo displayed on the top left of the website.

Logo in menu
Uploaded images will be scaled to fit the space.

Cover Image

Uploading a file here will replace the image (grid) displayed on the right when on the Login page.

Grid on login
Uploaded images will be scaled to fill the space.

Body

Background is the color of the main page background.

Text is the color of text displayed on the site.

Link is the color of links displayed on the site.

Link (Hover)is the color of links displayed on the site when hovered.

Content

Background is the color of the tiles displayed on the body background.

Background (Stacked) is the color of stacked tiles.

Border is the color of the border on the Color Scheme selector and login separator.

Navigation

Background is the color of the navigation pane.

Text is the color of the text of the navigation pane.

Navigation Items

Background is the color of the navigation elements on the navigation pane.

Background (Hover) is the hover color of the navigation elements on the navigation pane.

Background (Current) is the current/selected color of the navigation elements on the navigation pane.

Border is the border color of the navigation elements on the navigation pane.

Border (Hover) is the border hover color of the navigation elements on the navigation pane.

Border (Current) is the current/selected border color of the navigation elements on the navigation pane.

Text is the text color of the navigation elements on the navigation pane.

Text (Hover) is the text hover color of the navigation elements on the navigation pane.

Text (Current) is the current/selected text color of the navigation elements on the navigation pane.

Login

Background is the color of the background of the login pane.

Text is the color of the text of the login pane.

Run

Background is the color of the page background behind the form.

Outline

Hover is the color of the border when a user hovers over a clickable element, eg. a project on the Projects page.

Focus is the color of the border when a user focusses on a clickable element, eg. a project on the Projects page.

Loading

Backdrop is the color of the overlay displayed on top of the content while it is loading.

Spinner (Primary) is the color of the larger spinner portion on the default loading state.

Spinner (Secondary) is the color of the smaller spinner portion on the default loading state.

Text is the color of the text displayed below the spinner on the default loading overlay.

Appearance - Input

Inputs

Eg. the username and password fields of the Login page.

Background is the color of the input background.

Border is the color of input border.

Text is the color of input text.

Appearance - Buttons

The Default, Primary, Secondary, Tertiary and Ghost properties control the styling of the general buttons in the Live UI site.

The Transition and Operation properties control the appearance of transition and operation buttons on the Details page.

Properties

Background is the color of the button background.

Background (Hover) is the color of the button background when a cursor is hovered the button.

Border is the color of the border.

Border (Hover) is the color of the border when a cursor is hovered over the button.

Text is the color of the text.

Text (Hover) is the color of the text when a cursor is hovered the button.

Appearance - States

Notifications - Danger / Warning / Success / Information

Login error

Background is the color of a strong notification.

Text is the color of the text displayed within a strong notification.

Background (Faint) is the color of a subtle notification.

Text (Faint) is the color of the text displayed within a subtle notification

Specification States

These colors control the highlighting of the state names on the History page and Details page.

Background is the color of the specification state.

Text is the color of the text displayed within the specification state.

Only default specification flow state names will have colors applied:

  • Saved
  • Pending
  • Completed
  • Released

Other states will display with the Default color.

You can apply colors to your custom state names using the Customizations.css file.

Document States

These colors control the highlighting of the document state names ( Generating / Ready )on the Details page.

Background is the color of the document state.

Text is the color of the text displayed within the document state.

Custom Project Content

The Live UI also lets you load project-specific custom content if desired.

With the respective "Load Custom Scripts" and "Load Custom Styles" settings checked the DriveWorks Live UI will look for the following files:

  • project-name.js
  • project-name.css

The Live UI determines these names by replacing all spaces within the project name with hyphens and appending the desired file format.

If the respective setting is checked and the files don't exist, an error will be rendered by the browser in the Developer Console (F12).

Please refer to the Run settings for information on these settings.

© DriveWorks Ltd 2025 - All rights reserved.
Privacy Policy | Terms & Conditions