DriveWorks Pro 22

Further Customization

Further Customization

The Web Theme is optimized to allow extensive modifications without affecting the system files.

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

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 DriveWorks Live are stored in the location:

%ProgramData%\DriveWorks\[version number]\Live\Themes

The Themes folder contains the following sub folders:

• \Application

  All files required for the Application Theme are stored here.

  These files are continually updated by DriveWorks and should not be modified at all.
• \Web

  All files required for the Web Theme are stored here. The Web Theme is highly customizable.

System Files and Custom Files

The table below identifies the Core and Custom files that are located in the \Web folder:

Applying Trusted Redirect Domains to the DriveWorks.config file

Some circumstances require a list of third party domains that are permitted for redirection purposes to be added to the DriveWorks.config file.

This could be:

• If the Login Module is in use and no URL has been applied in the Next Page after Logon setting.
• When a query string redirect is used

  An example of a query string to logout can be found in the topic Logging Out of a Browser Session under Redirect the Logout URL.

  This could occur when a user has visited a page prior to logging in, DriveWorks can redirect to the login page and then back to the original page being viewed once authenticated.

  This can only be done from a query string. Since query strings can be changed in the browser (or sent via email etc.) it may not be trusted.

If your site requires redirection to a trusted third party domain, this must be specified in the DriveWorks.config file as detailed below:

1. Using Windows Explorer, locate the DriveWorks.config file for the Web Theme and make a copy for back up purposes.

   This is located in the folder %ProgramData%\DriveWorks\[version number]\Live\Themes\Web\

2. Open this file using notepad or a similar text editor.
3. Locate the line below:

       <driveworksLive>
       </driveworksLive>

   If this file has already been modified for a Group Connection String it could also appear as:

       <driveworksLive groupConnectionString="Provider=RemoteGroupProvider;Server=MachineName;Name=GroupName;">
       </driveworksLive>

4. Add the following in between the driveworksLive tags:

       <driveworksLive>
           <trustedRedirectDomains>
               <domain>*.driveworks.co.uk</domain>
               <domain>driveworkslive.com</domain>
           </trustedRedirectDomains>                        
       </driveworksLive>

   Replace .driveworks.co.uk or driveworkslive.com with the trusted domains redirects are permitted to use.

   The wildcard behavior (demonstrated in the first given domain above) is as follows:

   • The * character acts as a wildcard placeholder in the url
   • Wildcards match a single label in the domain hierarchy
   • Wildcards will match a single label wholely (it cannot be combined with other characters like ab*yz.123.com to make it partially match a label)
   • Wildcards are only valid at the start of the domain name (the leftmost label)

   Using the examples above:

   • *.driveworks.co.uk
   • driveworkslive.com

   the table below shows the domains that are permitted and not permitted:

   Permitted	Not Permitted
   http[s]://www.driveworks.co.uk http[s]://driveworks.co.uk http[s]://anything.driveworks.co.uk http[s]://driveworkslive.com http[s]://driveworks.co.uk/the/rest/of/the/path?doesnt=matter	The following redirects would not be permitted because wildcards only permit one matching label: http[s]://abc.123.driveworks.co.uk The following redirects would not be permitted because no wildcard subdomains have been permitted by the configuration: http[s]://www.driveworkslive.com http[s]://anything.driveworkslive.com http[s]://abc.123.driveworkslive.com

5. Save and close the DriveWorks.config file.

Skin Customization

Customizing a Skin is done by:

1. Identify a system skin to base the customization on.
2. Copy the identified skin to the \custom folder.
3. Apply the customizations to the copied files.

Identify the System Skin

To identify a skin to base your customization on:

1. In DriveWorks Administrator go to Personal Web Edition.
2. Click the Theme button and select Web Theme.
3. Start PWE by clicking the Start button.
4. When your browser loads log onto the implementation using your credentials (must have administrator privileges).
5. Type setup/ at the end of the URL.
6. Click the skins link at the top of the setup page.
7. Click Preview on the skin options to find the required skin. Make a note of the name.

   

Copying a Skin

To copy a skin, for customizing, follow the steps below:

1. Locate the skin folder from %ProgramData%\DriveWorks\[version number]\Live\Themes\Web\content\system\skins.

   This will be one of the folders from:

   • Black Glass
   • Blue Glass
   • Standard
   • Standard Fluid
   • Carbon Fluid
   • Tiled Fluid
2. Copy the skin folder to %ProgramData%\DriveWorks\[version number]\Live\Themes\Web\content\custom\skins.

   It is the files in this folder that should be modified to create the new skin.

3. Rename the folder of the copied skin. This is optional to ensure the original skin is displayed.
   If the original skin name is kept for the copied skin, the original skin will not be available for selection.

Customizing a Skin

Once the Skin has been copied to the \custom\skins folder the files in the skin folder can be customized.

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

Module Customization

Modules give each of the web pages a function. The method to apply a module can be generalized as:

• Drag a module from the toolbox into position on a page.
• Apply any settings to the module.
• View the module in action

  A module can be viewed in 3 modes:

  • View Mode - The normal view of the module a user would see.
  • Edit Mode - The view of the module during Edit mode in a browser.
  • Edit Settings Mode - The view of the module that is being edited to have settings applied.

Customizing a module is done by:

1. Identify a system module to base the customization on.
2. Copy the identified module to the \custom folder.
3. Apply the customizations to the copied files.

Identify the System Module

This is simply a case of running through the specification process using PWE and noting the URL and position of the module you require.

Once the module is found enter edit mode on the page and the name will be displayed in the module.

Copying a Module

To copy a module, for customizing, follow the steps below:

1. Locate the module folder from %ProgramData%\DriveWorks\[version number]\Live\Themes\Web\content\system\modules.

   This will be one of the folders from:

   • Image Upload
   • Integration
   • Login
   • Markup
   • Menu
   • Projects
   • Specification Details
   • Specification Form
   • Specification History
   • Specification Navigation
   • Specification Tasks
2. Copy the module folder to %ProgramData%\DriveWorks\[version number]\Live\Themes\Web\content\custom\modules.

   It is the files in this folder that should be modified to create the new skin.

Customizing a Module

Once the Module has been copied to the \custom\modules folder the files in the modules folder can be customized.

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