4. Documentation and Support — OpenSplice Getting Started Guide

### Navigation

- index
- next |
- previous |
- OpenSplice Getting Started Guide »

# 4. Documentation and Support

The Vortex OpenSplice documentation set provides detailed information about Vortex OpenSplice, including its API, usage, installation and configuration.

The following table lists all of the documentation and manuals included with Vortex OpenSplice. The table includes brief descriptions of the documents and their likely users.

## 4.1. Vortex OpenSplice Documentation Set

Document | Description and Use
--- | ---
Release Notes | Lists the latest updates, bug fixes, and last-minute information. For product installers, administrators, and developers, who need to be aware of the latest changes which may affect the Service’s performance and usage. A link to the Release Notes is in `index.html` located in the directory where OpenSplice is installed.
Getting Started Guide | General information about OpenSplice, including installation instructions, initial configuration requirements and instructions for running the Opensplice examples on supported platforms. For managers, administrators, and developers to gain an initial understanding of the product, as well as for product installers for installing and administering OpenSplice. Essential reading for users new to DDS.
Evaluation Guide | A short guide to help new users evaluate Vortex OpenSplice.
Tutorial Guide | A short course on developing applications with OpenSplice. Includes example code in C, C++ and Java.
Deployment Guide | A complete reference on how to configure and tune the OpenSplice service.
Tuner Guide | Describes how to use the Tuner tool for monitoring and controlling Opensplice. For programmers, testers, system designers and system integrators using OpenSplice.
IDL Pre-processor Guide | Describes how to use the Opensplice IDL pre-processor for C, C++ and Java.
OpenSplice Automated Testing and Debugging Tool User Guide | Provides a complete reference on how to configure the ‘Tester’ tool and how to use it to test scenarios generated with Vortex OpenSplice
C Reference Guide C++ Reference Guide Java Reference Guide | Each of these reference guides describes the Vortex OpenSplice Application Progammers Interface (API) for C, Classic C++ and Classic Java. This is a detailed reference for developers to help them to understand the particulars of each feature of the Vortex OpenSplce API.
C# Reference Guide ISO C++ Reference Guide Java 5 Reference Guide | Describes the Vortex OpenSplice APIs for C#, the new ISO C++ and Java 5 Supplied as HTML rather than PDF with the product Release Notes.
RMI over DDS Getting Started Guide | Explains how to take advantage of the client/server interaction paradigm provided by OpenSplice RMI layered over the publish/subscribe paradigm of Vortex OpenSplice.
Streams User Guide | Explains the Streams API where continuous flows or ?streams? of data have to be transported with minimal overhead and therefore maximal achievable throughput.
GPB User Guide | Explains how to use Google Protocol Buffers with the new ISO C++ and Java 5 APIs.
Record and Replay Service Guide | Explains how to configure and use the Record and Replay Service.
Security User Configuration Guide | Explains how to configure security when using the Real Time Native Networking Protocol.
Node Monitor | Explains how to the Node Monitor Tool to watch over the Vortex OpenSplice middleware.
Examples | Examples, complete with source code, demonstrating how applications usiong Opensplice can be written and used. Documentation for the examples can be found in the OpenSplice Release Notes.
White Papers and Data Sheets | Technical papers providing information about Vortex Opensplice. These technical papers are in PDF format and they can be obtained from the PrismTech web site at http://www.prismtech.com

## 4.2. Information Sources

### 4.2.1. Product Information

Links to useful technical information for PrismTech’s products, including the Vortex OpenSplice and associated components, are listed below.

  These links are provided for the reader’s convenience and may become out-of-date if changes are made on the PrismTech Web site after publication of this guide. Nonetheless, these links should still be reachable from the main PrismTech Web page located at http://www.prismtech.com.

### 4.2.2. Knowledge Base

The PrismTech Knowledge Base is a collection of documents and resources intended to assist our customers in getting the most out of the OpenSplice products. The Knowledge Base has the most up-to-date information about bug fixes, product issues and technical support for difficulties that you may experience.

The Knowledge Base can be found at:

> http://www.prismtech.com/knowledge-base

### 4.2.3. Additional Technical Information

Information provided by independent publishers, newsgroups, web sites, and organisations, such as the Object Management Group, can be found on the Prismtech Web site:

> http://www.prismtech.com

## 4.3. Support

PrismTech provides a range of product support, consultancy and educational programmes to help you from product evaluation and development, through to deployment of applications using OpenSplice DDS. The support programmes are designed to meet customers’ particular needs and range from a basic Standard programme to the Gold programme, which provides comprehensive, 24 x 7 support.

Detailed information about PrismTech’s product support services, general support contacts and enquiries are described on the PrismTech Support page reached via the PrismTech Home page at http://www.prismtech.com.

### Navigation

- index
- next |
- previous |
- OpenSplice Getting Started Guide »