Home Search

DriveWorks Pro 23
Live UI Customization

Send Feedback

Customizing the Live UI

The Live UI of the Integration Theme is designed to enable extensive customization without affecting the System files.

This allows all future service packs and major versions to be installed with minimal impact to any modifications that have been made.

Customization can be on two levels:

  • Standard - Involves using the UI to make modifications.
    To access the settings page the user requires the Administer Group Security permission.
  • Advanced - Involves copying core files to be customized and using proprietary editors to alter settings.

Standard Customization

The UI of the Integration Theme default site can be used to customize the following Settings:

Additionally the image and description used for your projects can be changed by following the instructions in the topic Project Image, Name and Description.

File Customization

Customizing the Live UI is done by:

  1. Identify the file for customization.
  2. Copy the identified file to the relative location within the Custom folder.
  3. Apply the customizations to the copied files.

Not all the files need to be copied. Only the files that are to be modified are needed.

DriveWorks Live will always take the files available from the Custom folder first.

Any missing files will be picked up from the System folder.

Customizing a file

Once the file has been copied to the relative Custom location the file can be customized.

The files associated to a skin that are typically customized include:

ItemNotes
Pages.json This file controls the navigation of the site.

Here you can change page titles and HTML file names for translation into your local language.

favicon.ico This file is the icon displayed on the tab within the browser.

Placing a your own file in the Custom folder will update the favicon used by the site.

\ImagesThe default images used by the site:
  • Logo (logo-dark.png and logo-light.png)
    This can be modified using the site UI, please see Appearance - Base settings for more information on this.
  • Login page cover image (cover-dark.png and cover-light.png)
    This can be modified using the site UI, please see Appearance - Base settings for more information on this.
  • Projects page placeholder image (ProjectPlaceholderDark.png and ProjectPlaceholderLight.png)
\IconsThe icons used by the site.

Advanced Customization

Before undertaking any modifications to the files DriveWorks Live uses it is important to understand the following:

  • The Folder Structure of the themes used to display your projects in a browser.
  • The System Files that will be overwritten when installing service packs.
  • The Custom Files that are intended to be modified.

Folder Structure

All files that enable the DriveWorks Live Integration Theme Live UI are stored in the location:

%ProgramData%\DriveWorks\[version number]\Live\Themes\Integration\Templates\FrontEnd

System Files and Custom Files

The table below identifies the Core (System) and Custom files that are located in the above folder:

ItemTypeNotes
\SystemSystemThe files in this folder should not be changed directly.

To customize anything in the System folder, e.g. a page or configuration, copy it across to the relative location in the Custom folder.

Files in the Custom folder override files in the System folder.

Config.json

SystemThis file should not be changed.

Pages.json

SystemThis file should not be changed.

favicon.ico

SystemThis file should not be changed.

*.html

SystemThese files should not be changed.

\Command

SystemThe files in this folder should not be changed.

\Fonts

SystemThe files in this folder should not be changed.

\Icons

SystemThe files in this folder should not be changed.

\Images

SystemThe files in this folder should not be changed.

\Locatization

SystemThe files in this folder should not be changed.

LocalizedResources.json

System This file should not be changed.

It contains the default text for the site.

\Scripts

SystemThe files in this folder should not be changed.

\Styles

SystemThe files in this folder should not be changed.
\CustomThis folder should be used to contain any custom pages or configurations that you create, or copy from the originals in the System folder.

All files copied from the System folder should be placed in the relative location within the Custom folder.

If the relative folder does not already exist, create the folder to copy the file into.

about.txt

SystemThis file explains the purpose of the Custom folder as detailed above.

\Styles

SystemThe file in this folder should be changed.

Customizations.css

System This is where additional CSS customizations should be applied for the site.

See Custom States CSS for the syntax required to declare your own state colors.

Display Order

When running DriveWorks Live the files in the Custom folder will be read first.

If the required file is not found DriveWorks Live will read the file from the System folder.

To revert any changes, remove the respective file(s) from the Custom folder.

The site will fallback to the default values and files from the System folder.

Custom State CSS

Custom states can be declared within the Customizations.css file found in the Custom\Styles folder.

This is the easiest method to have unique state names color coded in the Live UI.

To do this the following syntax is required:

:root.light {
    --color-state-[yourstatename]-background: [light background color];
    --color-state-[yourstatename]-text: [light text color];
}

:root.dark {
    --color-state-[yourstatename]-background: [dark background color];
    --color-state-[yourstatename]-text: [dark text color];
}

.state-[yourstatename] {
    background-color: var(--color-state-[yourstatename]-background);
    color: var(--color-state-[yourstatename]-text);
}

This allows you to specify both a light and a dark color scheme for your state.

Your state name should replace [yourstatename] and be in lower case.