1. Introduction¶

Traditionally, web-based applications and services have relied on non-standard interfaces to participate as first-class citizens in the DDS Global Data Space. Web Integration Service leverages the Web-Enabled DDS OMG standard to provide a simple generic standards-based interface that provides a transparent bridge between web-based services and unmodified DDS applications.

Simply set up Web Integration Service to create DDS entities associated with web-based client applications. No changes are required in the Connext DDS applications.

Figure 1.1 Web Integration Service Overview

The key benefits of Web Integration Service are:

It reduces the time and effort spent integrating web-based protocols with Connext DDS applications, providing a standards-based generic out-of-the-box solution.
It supports disconnected or stateless clients that would otherwise need to join a domain, discover remote entities, and ensure that subscribers receive the information they sent.
It enables interoperability between applications written in different programming languages and operating systems.
It provides access control mechanisms to ensure that only authorized applications can access the DDS Global Data Space.

1.1. Available Documentation¶

Web Integration Service documentation includes:

User’s Manual—Describes how to install, configure, and use Web Integration Service.
Tutorials—Walks you through some some examples so you can quickly configure Web Integration Service to publish and subscribe to DDS data.
API Reference—Documents all available REST APIs that allow web-based applications to participate as first-class citizens the DDS Global Data Space.
Release Notes—Provides the list of supported platforms and describes what’s new and what has been fixed in this version of Web Integration Service.
Examples Repository—GitHub repository with more complex client applications using Web Integration Service.

1.2. Paths Mentioned in Documentation¶

This documentation refers to:

<NDDSHOME> This refers to the installation directory for Connext DDS. The default installation paths are:
- Mac OS X systems: /Applications/rti_connext_dds-version
- Unix-based systems, non-root user: /home/your user name/rti_connext_dds-version
- UNIX-based systems, root user: /opt/rti_connext_dds-version
- Windows systems, user without Administrator privileges: <your home directory>\rti_connext_dds-version
- Windows systems, user with Administrator privileges: C:\Program Files\rti_connext_dds-version
You may also see $NDDSHOME or %NDDSHOME%, which refers to an environment variable set to the installation path.

Whenever you see <NDDSHOME> used in a path, replace it with your installation path.

Note for Windows Users: When using a command prompt to enter a command that includes the path C:\Program Files (or any directory name that has a space), enclose the path in quotation marks. For example: “C:\Program Files\rti_connext_dds-version\bin\rtiwebintegrationservice.bat”

Or if you have defined the NDDSHOME environment variable: "%NDDSHOME%\bin\rtiwebintegrationservice.bat"
<path to examples> By default, examples are copied into your home directory the first time you run RTI Launcher or any script in <NDDSHOME>/bin. This document refers to the location of the copied examples as <path to examples>.

Wherever you see <path to examples>, replace it with the appropriate path. Default path to the examples:
- Mac OS X systems: /Users/your user name/rti_workspace/version/examples
- UNIX-based systems: /home/your user name/rti_workspace/version/examples
- Windows systems: your Windows documents folder\rti_workspace\version\examples. Where 'your Windows documents folder' depends on your version of Windows. For example, on Windows 7, the folder is C:\Users\your user name\Documents; on Windows Server 2003, the folder is C:\Documents and Settings\your user name\Documents.