DriveWorks Pro 17: Select the Integration Theme [send feedback...]

Select the Integration Theme

The Integration Theme hosts the DriveWorks Live Web API enabling you to embed 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.

To Select the Integration Theme

To select the Integration Theme:

  1. From DriveWorks Live, open the required Group and select Stage 1: Specification> Live.
  2. Click the Theme button from the command bar
  3. Select the Integration Theme from the Theme configuration dialog.

  4. Click Next.
  5. Browse to the location where the static files will be stored.
    We recommend this being a different location to where the Integration Theme files are stored.

  6. Copy Client SDK Examples to this folder.
    • Check this option to Copy the SDK examples.
    • Leave this option unchecked if SDK examples are not required.
  7. Click Finish.

    If the location specified already contains the files you will be prompted to overwrite them. Click Yes to overwrite any files in that location.

Setup

In order to use the Integration Theme, you must first register your DriveWorks Group(s) in the DriveWorksConfigUser.xml file.

More information about this file can be found in the topic Integration Theme Settings.

Examples

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

This collection of web pages is a great way to get started or provide inspiration, and they are completely customizable and ready to use with your existing DriveWorks Projects and Specifications.

If the option to Copy Client SDK Examples to this folder was selected, these can be accessed from the landing page:

  1. From DriveWorks Live, select Stage 1: Specification > Live.
  2. Click Start from the command bar.
  3. Click Open Browser from the command bar.
  4. Once the default landing page is loaded click the Examples button from the Client SDK Examples section.

The examples page is a collection of components that provide a basic starting block for using the Integration Theme for DriveWorks Live.

Select the example you require to integrate and click the Developer Tools in your browser to copy the code each component uses.

Browser Developer Tools
  • Chrome - Ctrl+Shift+I
  • Firefox - Ctrl+Shift+J
  • Edge - F12

Help

The landing page also provides links to the SDK Documentation for:

  • Server API
  • Client SDK

See also

Integration Theme Settings

How To: Configure DriveWorks Live For IIS

How To: Make Your Website React To Specification Events With The Integration Theme

Table of Contents