Welcome to the DriveWorks Live Integration Theme

The Integration Theme hosts the DriveWorks Live Web API - which enables you to embed and access your DriveWorks implementation in an existing web site or application.

Here you will find a range of resources to assist you in getting started with the Integration Theme, Server API and Client SDK.

This page is the default landing page for the Integration Theme. It is visible to any user accessing your DriveWorks Live server endpoint directly - although it is unlikely to be accessed.

Consider editing or removing this page in a production environment.

Before You Begin

1) Integration Theme Setup

To access DriveWorks Groups using the Integration Theme, you must first register a Group Alias for each Group using the DriveWorksConfigUser.xml file on the host machine:

C:\ProgramData\DriveWorks\[Version]\Live\Themes\Integration\DriveWorksConfigUser.xml

More information about the connection settings in this file can be found in the online help file.

2) Load the JavaScript Client SDK

The Integration Theme provides a fully-fledged JavaScript SDK, to assist with using the API.

Whilst not a requirement to use the API, this vastly simplifies common commands in environments that support JavaScript.

It is advised that you load the JavaScript SDK files from your own DriveWorks Live server, not a local copy.
This ensures the use of the latest version to match your currently installed version of DriveWorks.

To load the JavaScript SDK, include the following script tag on each page:

<script src="https://[your-live-server.com]/DriveWorksLiveIntegrationClient.min.js"></script>

This script should be placed before the closing </body> tag, and before any scripts using SDK functionality.

3) View the Examples

We have created a range of examples that showcase how the Integration Theme Client SDK can be used.
These interact with the API to create custom web content - all powered by DriveWorks.

These collections are a great way to get started or provide inspiration.

They are completely customizable and ready to use with your existing DriveWorks Projects and Specifications.

View Client SDK Examples View Example Sites

Client SDK Documentation

The Client SDK Documentation displays all of the functions and properties that are available when utilizing the SDK to communicate with the Server API.

Here you will find:

View the Client SDK Documentation

Server API Documentation

The Server API Documentation displays all of the endpoints that can be interacted with using the Integration Theme.

Here you will find:

View the Server API Documentation

DriveWorks Help

For further help using DriveWorks in general, please visit the main Online Help File.

Here you will find a wide range of help, information and tips to assist you.

View DriveWorks Help