Client SDK Examples

This collection of example components provide basic starting blocks for using the Integration Theme in DriveWorks Live.

We provide these examples as a guideline to assist you in getting started quickly, with sample code ready to copy.

Please note these small examples are intended as reference, and a starting point for production-ready code.

Default Configuration

The Integration Theme and these examples are pre-configured to use a single Group, known as the Default Group.

The Default Group is denoted by a hyphen ( - ) when required to provide a Group Alias.

This is pre-configured in the Client SDK Examples config.js file.


Advanced Configuration Optional

Integration Theme Configuration

To specify your own Default Group, or access multiple DriveWorks Groups using the Integration Theme, you must register a Group Alias for each Group in a configuration file.

Group Aliases are defined within DriveWorksConfigUser.xml on the host machine:

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

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


Client SDK Examples Configuration File

All examples within this documentation use the same Group Alias, which is set within a common config.js file.

This file can be found here:

C:\ProgramData\DriveWorks\[Version]\Live\Themes\Integration\wwwroot\api-docs\examples\config.js

Using a centralized, shared configuration file is merely a suggestion to assist with easy maintenance.

Configuration options can also be stored alongside code in the same file, or passed directly into methods.


Basic Examples

Login & Logout Projects Specifications Specification Forms Operations & Transitions Variables & Constants Macros Documents Reports Group Tables Events OData