| Icon | Meaning |
| <img src="images/2a05f87a4292bfecb242bff603249f384f86fc8d046326ed5c2af664e82a5224.jpg"/> | Item of special significance or where caution needs to be taken. |
| <img src="images/2f8a03184f07ba6929c0610d462b5baa13e1b03d87dee3b76889cd5a2761eb27.jpg"/> | Item contains helpful hint or special information. |
| <img src="images/4fe2b4a96e5a4b452bc5568d6f3865119632a2c2edabd550e9a06ba0786d19b9.jpg"/> | Information applies to Windows (e.g. XP, 2003, Windows 7) only. |
| [4B6K] | Information applies to Unix-based systems (e.g. Solaris) only. |
| <img src="images/8900901b866cfe9cfcd7831571589bc731bf0d8c1bc097997ff86d32e54d94ff.jpg"/> | Information applies to Linux-based systems (e.g. Ubuntu) only. |
| <img src="images/8722f419d393c3bbb0a636f2f9be25626b1ff366bae29885cce82fe83d6c1e42.jpg"/> | C language specific. |
| <img src="images/5187ea8199f4587188507201b111cab32a79fe7de38664ea33120658de893b1d.jpg"/> | C++ language specific. |
| <img src="images/0388ee0b2ce3ef57acafdcc66c22e17bfdd93ab5193748ca350639f6a130cba1.jpg"/> | C# language specific. |
| <img src="images/16f7797247fe2ad4c3e888f65321777b2aaf2ae21b5f4149dd3385a6356449ea.jpg"/> | Java language specific. |
# 2
# Introduction
The Vortex OpenSplice Record and Replay Manager, or RnR Manager, is a tool to control Vortex OpenSplice Record and Replay Services (RnR Services) and to inspect and change recorded data.
# 2.1 Overview
This section provides a brief introduction to the Vortex OpenSplice RnR Service and the RnR Manager tool.
Version 6.4 of RnR Manager is compatible with Vortex OpenSplice version 6.4. It is not compatible with earlier versions of Vortex OpenSplice.
# 2.1.1 Vortex OpenSplice Record and Replay Service
RnR Services are the Vortex OpenSplice software modules responsible for implementing record and replay.
# Vortex OpenSplice RnR Service Features
Features provided by the RnR Service include the ability to:
• Control and monitor the service using regular DDS topics.
• Use expressions with wildcards to select partitions and topics of interest, for record and/or replay.
• Store data in XML records for easy post-analysis and data-mining.
• Store data in CDR records for efficient recording and replaying of high-volume data
• Create scenarios, grouping multiple commands into a logical set.
• Use replay filters to replay only the data recorded in a specific time-range.
• Query and edit storage data.
# Non-Intrusiveness of Vortex OpenSplice RnR
Vortex OpenSplice Record and Replay is a pluggable service of the Vortex OpenSplice Middleware and is capable of recording and/or replaying DDS datasets (i.e. topic samples) in a DDS system. As a ‘DDS service’, Record and Replay benefits from the inherent ‘decoupling in time and space’ that the DDS architecture offers, with respect to automatic discovery of the service’s dynamic interest in subscribing or publishing data as well as the transparent routing of information to and from the service.
Relevant characteristics of this service with respect to ‘intrusiveness’ for an existing system are:
1. The RnR service can be optionally configured on any DDS node in the system.
(a) When run as part of an existing federation of applications, it utilizes the federation’s shared memory segment to obtain the data. (So locally-published data is not required to travel over the network to be recorded by the service and vice versa for replaying towards co-located subscribers.)
(b) When run on a dedicated RnR node, to be recorded data is transparently forwarded to that RnR node typically using multicast network features (so as not to induce extra network traffic).
2. RnR services are controlled in ‘the DDS way’, i.e. a data-centric way where command and status topics enable DDS based ‘remote control’ of the service from anywhere in the system.
(a) A dedicated record and replay partition is utilized by RnR to bound the control/status flows.
(b) In the case of a dedicated RnR node, this partition can be configured to be a so-called ‘local partition’, thus bounding all control/status traffic to the RnR node (see Section 2.5.2.6 in the Vortex OpenSplice Deployment Guide).
3. Replaying (subsets) of recorded data ‘by definition’ has an impact on an existing system:
(a) As it can induce unanticipated traffic flows towards subscribing applications.
(b) As it typically triggers application processing of such replayed data.
(c) Which can be considered intentional and inherent to the purpose of replaying recorded data.
Summarizing, it can be stated that when dedicating a specific computing node for Recording and Replaying and confining the control and status traffic to control the service to stay inside that node, recording the data in a multicast-enabled network is non-intrusive.
Note: The few shared topic-definitions (definitions ONLY, not actual samples of these topics when these are ‘confined’ to the RnR node) that would be visible system-wide when inspecting the built-in topics of the system (for instance with a tool like the Vortex OpenSplice Tuner) are considered not instrusive as they only imply a small amount of static data space occupied by the related built-in topic samples.)
# Vortex OpenSplice Deployment Documentation
Please refer to the Vortex OpenSplice Deployment Guide (OpenSplice\_Deployment.pdf) for more detailed information on how to configure Vortex OpenSplice.
The Vortex OpenSplice configuration editor (osplconf) provides facilities to create, modify and save configuration files. This tool is described in Section 3.2 in the Vortex OpenSplice Deployment Guide.
# Vortex OpenSplice RnR Service Configuration Example - ospl.xml
In order to use the RnR service, a new service needs to be defined in the xml configuration files. In the example below, the RnR-related entries are highlighted in red.
RnR Service Configuration in ospl.xml
The service name in the example is rnrService1. A system can have many rnr services. The service name can be any string value.
# 2.1.2 RnR Manager Product Overview
The Vortex OpenSplice Record and Replay Manager, or RnR Manager, is a tool to control Vortex OpenSplice Record and Replay Services (RnR Services) and to inspect and change recorded data.
RnR Manager uses the internal Control and Monitoring API for access to the Vortex OpenSplice Middleware. Connections to local nodes via JNI and remote nodes (via SOAP) are supported. The manager tool does not need to have Vortex OpenSplice installed locally. A connection can be made remotely to a node that is running Vortex OpenSplice.
# RnR Manager Features
Features provided by the RnR Manager product include:
• Control and Monitor all Recorder and Player instances in the system.
• Connect to local and remote nodes.
• Monitor RnR Service status (scenarios, storages and services).
• Record and Replay scenarios.
• Import and export recorded data.
• Query and edit recorded data.
# 2.2 Key Concepts
# 2.2.1 Services
The Vortex OpenSplice middleware RnRService is responsible for implementing record and replay functionality.
A system may be configured to have multiple RnR Service instances.
An RnR Service is identified by a name. This name (also known as rnrId) is used to address the commands to a specific RnR Service. It is defined by the ‘name’ attribute of the service tag in the Vortex OpenSplice configuration. For example:
# 2.2. Key Concepts
```xml
<OpenSplice>
<Domain>
<Name>domain_name</Name>
<Id>0</Id>
<Database>
<Size>10485670</Size>
</Database>
<Service name="durability">
<Command>durability</Command>
</Service>
<Service name="cmsoap">
<Command>cmsoap</Command>
</Service>
<Service name="rnr_service_name">
<Command>rnr</Command>
</Service>
</Domain>
<RnRService name = "rnr_service_name"/>
```
Where "rnr\_service\_name" will be used to identify this service.
The middleware uses this identifier to resolve the configuration options that apply to the service. A Record and Replay service only accepts commands with an rnrId that matches its Service name. In addition, an asterisk ‘\*’ can be used as rnrId for commands targeted at all available RnR Services in a domain.
# 2.2.2 Scenarios
The actions of a Record and Replay service are organized in ‘scenarios’. Scenarios are used to logically discriminate between different recording and replay command sequences (or sessions). A scenario is an instance of the scenario topic, a group of commands sharing the same scenarioName.
During initialization the RnR Service starts an initial scenario, called the BuiltinScenario. This is a special scenario that is always running while the service is operational. RnR Manager uses the BuiltinScenario to configure and control the RnR Service and create new scenario topic readers for each scenario ‘rr\_scenarioReader\_<scenarioName>’.
A Scenario may be in one of the following states:
SCENARIO\_RUNNING Scenario is active and able to receive and process commands
SCENARIO\_STOPPED Scenario is stopped and unable to receive commands
SCENARIO\_SUSPENDED Scenario is suspended and will resume processing commands when scenario is (re)started or continued
Note that the BuiltinScenario can not be stopped.
# Scenario Commands
RnR commands are sent to the Scenario’s Command topic. Supported scenario commands are: Add Record, Add Replay, Remove Record, Remove Replay, Set Replay Speed, Truncate, Start, Stop and Suspend.
Add Record Specify interest to record data to a storage.
Add Replay Specify interest to replay data from a storage.
Remove Record Remove record interest from a storage.
Remove Replay Remove replay interest from a storage.
Set Replay Speed Change the replay speed of a storage.
Truncate Remove data from a storage.
# 2.2. Key Concepts
Start Start a scenario, or continue a suspended scenario.
Stop Stop a running scenario.
Suspend Suspend processing of new commands in a running scenario.
Config Add a storage to the service or modify properties of an existing storage.
It is important to understand that a scenario, once stopped, cannot be started again. However, it is possible to start a new scenario with the same name as the stopped scenario. If any commands of the original scenario were published as transient data they will be delivered to and processed by the new scenario, giving the impression that the scenario has been re-started.
# Different versions of the scenario topic
Starting with Vortex OpenSplice RnR Manager V6.6.0, the tool interacts with two versions of the RnR service provided scenario command topic: rr\_scenario and rr\_scenario\_v2. The new version of the topic contains support for Transformations (partition, QoS) of data during replay.
The tool will only publish comands to the v2 command topic. If there exist scenarios from the previous version of the topic, e.g. from a persistent DDS store, then the tool will be able to read in the scenario commands for display in the Scenario Editor but if the scenario is stopped and started again from the editor, the scenario commands will be republished in the the v2 command topic, and the old topic scenario will be disposed.
Vortex OpenSplice RnR Manager expects the rr\_scenario\_v2 topic to be registered by the time it needs to publish commands, e.g. when starting/stopping a scenario or creating a storage. If the v2 topic is not registered, command publication will not take place. The tool does not attempt to publish commands on the old rr\_scenario topic.
# 2.2.3 Storages
The RnR Service operates in conjunction with storages, which can be configured statically in a configuration file or dynamically through interaction with the service.
RnR Manager determines the available storages by subscribing to the storage status topic. It can be used to add new storages to a service.
Storages may have the following states:
STORAGE\_READY Defined, but not opened yet.
STORAGE\_OPEN Storage successfully opened and can be written to.
STORAGE\_ERROR An unrecoverable error has occurred in the storage.
STORAGE\_OUTOFRESOURCES The storage is out of resources.
STORAGE\_CLOSED The storage has been closed and can no longer be written to.
# 2.2.4 Samples
The RnR Service records and replays DDS data, or Samples. A recorded Sample is stored in XML form in the file associated with the Storage. In addition to recording the topic data (for future replay), the RnR Service records additional Sample Information such as the Partition, Topic name, and recording time (timestamp).
When a Storage is imported into RnR Manager, the Sample data and recording information can be viewed using the Storage Editor.
# 2.2. Key Concepts
# 2.2.5 Time Ranges
Time Ranges can be used to limit the selection of data in a replay session. Users can select sample data based on the recorded timestamps. A range is defined with a start and an end timestamp.
# 3
# Installation
# 3.1 Pre-requisites
Vortex OpenSplice RnR Manager requires Oracle Java of at least version 1.6. OpenJDK Java is not supported.
RnR Manager does not need Vortex OpenSplice to be installed on the same system in order to control the RnR service. However, certain features of RnR Manager require a local installation of Vortex OpenSplice in order to operate. This includes connecting to a locally running Vortex OpenSplice domain using Domain URI, or Domain ID, and the storage Import/Export functions.
(Please refer to the Vortex OpenSplice Getting Started Guide for full details of how to install Vortex OpenSplice.)
Other information regarding recent changes to RnR Manager, or known issues are given in the Release Notes included with the distribution.
# 3.2 Supported Platforms
The RnR Manager will run on the Windows and Linux operating systems.
# 3.3 General Installation Instructions
To install the Vortex OpenSplice RnR Manager, start the installer and follow the on-screen instructions.
# 3.3.1 Installation on Unix and Linux
# Unix
# Linux
On Unix-based platforms (including Linux), first ensure that execute permission is enabled, then run the installer from the command line:
```txt
% VortexOpenSpliceRNRManager-<version>-<platform>-installer.bin
```
where <version> is the release version number and <platform> is the build for your platform.
# 3.3.2 Installation on Windows
# Windows
On Windows-based platforms, start the installer by double-clicking on its filename in Windows Explorer:
```txt
VortexOpenSpliceRNRManager-<version>-windows-installer.exe
```
where <version> is the release version number.
# 3.3.3 Installing the license file
Please refer to the Vortex OpenSplice Getting Started Guide for full details of how Vortex OpenSplice is licensed.
ADLINK supplies a license file for the RnR Manager product. This file is not included in the software distribution.
During the installation, you have the option of specifying the license file.
Installing a License file
If you did not specify a license file during the installation, you will see a licensing error on startup.
License file error
Click the Manage Licenses button and then Import License File. Click the button Restart Workbench after importing the license file.
# 4
# Using the Record and Replay Manager
RnR Manager does not need to be installed on a system with Vortex OpenSplice; it just needs to connect to a computer running Vortex OpenSplice with RnR Services configured.
# 4.1 RnR Manager Overview
# 4.1.1 Starting RnR Manager
RnR Manager is started by executing the startRnRManager script, located in the eclipse directory of the RnR Manager install directory. The script’s purpose is to ensure the proper setting of the Vortex OpenSplice environment variables prior to application launch.
The script allows for command line options to be passed to the application. Any command line options accepted by an Eclipse application are also accepted by RnR Manager. A particularly useful option is -data <directory>, which allows a user to specify a custom directory use as the RnR Manager workspace, in case the default directory is shared or write protected.
Example of starting RnR Manager with a non default workspace location:
```txt
<path-to-RnRManager>/startRnRManager.sh -data /home/user/rnrworkspace
```
```batch
<path-to-RnRManager>\startRnRManager.bat -data C:\Users\user\rnrworkspace
```
Path arguments to the start script must be absolute paths.
# 4.1.2 Views
The RnR Manager supports various views to monitor the state of a connected domain. It also provides two editors.
These views and editors provide users with the ability to manage OSPL record and replay functionality. Additionally, record and replay data can be queried, and edited.
The views are:
• Domain Browser
• Service Status
• Storage Status
• Scenario Status
• Imported Storages
The editors are:
• Scenario Editor
• Storage Editor
Each view and editor has a detailed section to describe its features and intended usage.
RnR Manager Overview
# 4.1.3 Preferences
RnR Manager preferences can be set using the main Window/Preferences menu.
# OpenSplice
This preference page enables you to set the OSPL\_HOME path for the RnR Manager if one is not set for the environment.
RnR Manager must be restarted for this preference to come into effect.
OpenSplice Preferences page
# 4.1. RnR Manager Overview
# Partition/Topic Filters
The Partition/Topic Filters page enables you to specify which partitions and topics you would like to filter out in the general UI display. For example, any topics that are filtered out would not be seen in the in dropdowns used to list topics or in the Topics view.
Partition/Topic Filters Preferences page
# Partition/Topic Strings
The Partition/Topic Strings page enables you to specify partition and topic strings that are displayed in the general UI. For example, any topic strings that are added here are displayed in drop-down topic lists.
Partition/Topic Strings
# 4.1.4 Help
Various help actions are available from the main Help menu. These include actions for managing licenses, checking for updates, and product About... information.
Help menu
# 4.2 Domain Browser
The Domain Browser is used to define and connect to a domain. It also provides information about domain nodes, and the services the nodes support.
# Domain Browser
# 4.2.1 Defining a domain
To define an OSPL domain, click on the button in the top right corner of the Domain Browser.
Add Domain button
The RnR Wizard dialog will open. Multiple domain connection options are provided:
• A local domain can be connected to using an xml file or by specifying a domain id.
• A remote domain can be connected to using the node URL.
RnR Domain Wizard
# 4.2.2 Domain Connect
Once a domain has been defined, an entry will appear in the Domain Browser.
To connect, double-click on the entry, or right-click to display the domain menu and choose Connect.
# Connect to Domain
# 4.2. Domain Browser
When Connect is clicked, an attempt is made to connect to the RnR Services of the selected domain. If successful, the domain icon will change to $\scriptstyle { \frac { 1 } { 5 } } =$ and you will be able to expand the domain to browse the nodes.
RnR Manager needs to be connected to the RnR Services of a domain in order to manage the recording and/or replaying of sample data.
RnR Manager can only connect to one domain at a time.
# 4.2.3 Domain Disconnect and Delete
To disconnect or delete a domain, right-click on the domain to display the Domain menu.
# 4.3 Service Status
The service status view lists the current state of the OSPL RnR services available to the currently connected domain.
The list can be sorted by Key or State by clicking on the column header.
Service Status view
# 4.4 Storage Status
The storage status view lists the current state of the OSPL RnR storages available to the currently-connected domain.
The list can be sorted by Key or State by clicking on the column header.
Storage Status view
# 4.4.1 Creating a new storage
To create a new storage, click on the Add new storage button in the top right corner of the view to open the Create Storage dialog.
Add new storage button
Create Storage dialog
A wizard runs, with the input fields required for creating and configuring a new RnR storage.
The RnR Service ID field specifies for which service the storage will be created.
The Storage name field specifies what name the RnR service will recognize the storage by.
(See also Storage Attributes below.)
Clicking on Finish will create the storage. The Storage status view should be updated with a new entry for the newly-created storage.
# Storage Attributes
When creating new storages or reconfiguring existing storages, such as when using the Create Storage wizard, the following attributes can be set:
File name - The file name and path on the RnR service’s local filesystem in which it will keep the storage data. Relative paths are relative to the RnR service’s process working directory. File names have no rules or restrictions for file extensions; file names can have any extension, or no extension if required.
Storage type - The encoding format for the storage. The file formats available are CDR (binary) and XML. The CDR format is more efficient (compact) than XML.
Max file size - The maximum size per storage file. When approaching the maximum size while recording, a new storage file is automatically created with a sequence number appended to the filename. The active file is also switched transparently while replaying from a storage that contains multiple data files (eg. if file name is "file", the name sequence is file, file0, file1, etc.).
# 4.4. Storage Status
Valid max size is any positive integer in denominations of bytes, kilobytes, megabytes, or gigabytes, up to a maximum value of $2 ^ { \sim } 6 4 \mathrm { ~ ~ - ~ } 1$ total bytes. Leaving the field empty, or inputting the value 0, is considered to be unlimited file size.
# 4.5 Scenario Status
Record and Replay is based on Scenarios. Scenarios are used to logically discriminate between different recording and replaying command sequences. A scenario is an instance of the scenario topic, a group of commands sharing the same scenarioName.
The Scenario status view lists the current state of the OSPL RnR scenarios available to the currently-connected domain.
The list can be sorted by Key or State by clicking on the column header.
Scenario Status view
# 4.5.1 Open Scenario Editor
To open an empty scenario editor, click on the Create scenario button in top right corner of the scenario status view.
Please refer to Scenario Editors for more information on the Scenario Editor.
Create scenario button
# 4.5.2 Starting Scenario(s)
To start a scenario or set of scenarios, click on the Start scenario(s) button to open the Start Scenario(s) dialog.
Start scenario button
The wildcard character ‘\*’ (asterisk) is supported.
Start Scenario(s) dialog
A start scenario command is executed using the parameters specified in the dialog.
# 4.5.3 Stopping Scenario(s)
To stop a scenario or set of scenarios, click on the Stop scenario(s) button to open the Stop Scenario(s) dialog.
Stop scenario button
The wildcard character ‘\*’ (asterisk) is supported.
Stop Scenario(s) dialog
A stop scenario command is executed using the parameters specified in the dialog.
# 4.5.4 Scenario Menu
Actions are available for a scenario with a specific scenario name and rnrID.
To access the scenario menu, right-click on a scenario name in the scenario status table.
# Scenario Menu
The scenario menu has the following options:
Open – Opens a scenario editor on the selected scenario and RnR service. Please refer to Scenario Editors for more information on the Scenario Editor.
Start – Start the selected scenario. This menu item is disabled if the scenario is already in the RUNNING state.
Stop – Stop the selected scenario. This menu item is disabled if the scenario is not in the RUNNING state.
# 4.6 Topics – One Click Record
The Topics view displays all of the DDS system topics that are available for recording. This view enables the user to start recording quickly using the Record Topic(s) dialog. Default parameters for the recording are provided for the selected topics.
To verify the status of the recording, the storage and scenario views can be viewed. The scenario editor can also be opened for the scenario.
The Topics list
# 4.6.1 To Record a Topic
Step 1
Select one or more topics to record in the topic list.
Step 2
Right-click and choose Record... to open the Record Topic(s) dialog.
Topics selected for recording
# Step 3
Modify the default parameters if required and click on OK.
Record Topic(s) dialog parameters
# 4.6.2 The Record Topic(s) Dialog
Default parameters are provided in the dialog in order to provide ‘one click’ functionality. These default parameters can be edited if required.
# Partition/Topic pairs
The partition/topic pairs listed in the dialog reflect the selection in the Topics view when the dialog is opened.
The partitions can be modified by selecting from a drop-down list. The topics are not editable.
Record Topic(s) dialog Partition parameter
The fields are:
RNR Service ID – Specify the RNR Service ID parameter.
Scenario Name – Specify the scenario name. By default if one topic is chosen, a name that reflects the topic is used. Otherwise a generic record name is provided.
The currently-known scenarios in the DDS system are checked, and a scenario name is provided where no current scenarios of that name are known.
Storage Name – A default storage name is provided that matches the scenario name. If that storage is already known to the DDS system, a warning message is provided at the top of the dialog.
The storage name can be modified to be any string; a drop-down list is provided to allow for the selection of existing storages.
Truncate existing storage – If this option is checked, a truncate command will be added for the specified storage. Otherwise, no truncate command is submitted.
Create new storage – If this option is checked, the storage specified by the Storage name field will be created/configured with the specified storage attributes. See Storage Attributes for more information.
# 4.7 Scenario Editors
The actions of a Record and Replay service are organized in scenarios.
# 4.7. Scenario Editors
A scenario is an instance of the scenario topic, a group of commands sharing the same scenarioName. Each service subscribes to the command topic and uses a content filter to only process commands with an rnrId matching the service name (or ‘\*’).
It is possible to create an intricate nesting of scenarios by defining a scenario that includes control commands targeting other scenarios.
RnR Manager has two editors related to scenarios. These editors are used to view and edit the commands of a scenario.
Scenario Editor – Enables viewing, adding, and editing scenarios in the DDS system.
Scenario File Editor – Enables viewing and editing of scenario data that is persisted using an xml file. The scenarios are saved as xml, and can be loaded into the DDS system as required.
# 4.7.1 Overview of the Scenario Editor
The scenario editor is used to view and edit the commands of a scenario within the DDS system.
The scenario editor can be opened from the Scenario Status view by any of the following actions:
• double-clicking on a selected scenario in the table
• right-clicking on a selected scenario in the table and then choosing Open
• clicking on the Create Scenario button
The Scenario Editor
Scenario Editor elements:
Start and Stop buttons
The Start and Stop buttons, when clicked, submit the Start and Stop commands for the specified scenario and RnR service ID. These commands are published with a durability setting of VOLATILE.
Scenario name and RnR service ID
A new scenario name can be entered, or an existing scenario can be selected from the drop-down list.
Scenarios with the same scenario name can exist on multiple rnr services. The RnR service ID is also specified to identify the appropriate scenario. The wildcard character ‘\*’ (asterisk) can be used to denote all rnr services.
Scenario Commands
The scenario commands table displays all commands for a scenario with the specified RnR service ID.
# 4.7. Scenario Editors
# Command Parameters
The command parameters section displays the values associated with the selected command in the scenario commands table.
# 4.7.2 Overview of the Scenario File Editor
The scenario file editor can be used to edit the commands of a scenario and save them to an xml file. This xml file can later be loaded and submitted to a DDS scenario.
The scenario file editor can be opened from the Workspaces view by any of the following actions:
• double-clicking on a scenario file (under the Saved Scenarios folder)
• right-clicking on a selected scenario file and then choosing Open
Workspace Saved Scenarios
The Scenario File Editor
Scenario File Editor elements:
Save and Save As... buttons
The Save button saves the current xml file.
The Save As... button saves the scenario to a new file and opens a new scenario file editor.
Scenario name and RnR service ID
# 4.7. Scenario Editors
A new scenario name can be entered, or an existing scenario can be selected from the drop-down list.
Scenarios with the same scenario name can exist on multiple rnr services. The RnR service ID is also specified to identify the appropriate scenario. The wildcard character ‘\*’ (asterisk) can be used to denote all rnr services.
# Scenario Commands
The scenario commands table displays all commands for a scenario with the specified RnR service ID.
# Command Parameters
The command parameters section displays the values associated with the selected command in the scenario commands table.
# 4.7.3 Re-sizing the Editors
# Full View
In order to maximize the view of an editor, double-click on the editor tab.
Scenario Editor tab
To restore the regular view, click on the ‘restore’ button, or double-click again on the editor tab.
Resizing an Editor
# Resize Editor groups
The widths of the Scenario Commands and Command Parameters groups can be changed by dragging the border with the mouse.
# Resizing Editor groups
# 4.7. Scenario Editors
# 4.7.4 Scenario Editor Features
A Scenario Editor
The scenario editor displays the current state and the existing commands of a scenario in the DDS system.
• Existing commands for a specific scenario are displayed and are not editable.
• New commands can be added and submitted.
The functionality provided by the editor changes depending on the state of the scenario.
The state of a scenario can also be determined by viewing the scenario in the Scenario Status view.
# Running vs. Stopped Scenarios
# For RUNNING scenarios:
The Start button is disabled, the Stop button is enabled.
The Submit button is enabled.
# 4.7. Scenario Editors
Previously-submitted commands are displayed in the scenario commands table, but are ‘view only’. A visual indicator of this is that the font color is light gray. These commands can not be removed or edited.
Editable and non-editable commands
# For STOPPED scenarios:
The Start button is enabled, the Stop button is disabled.
The Submit button is disabled, as it is not necessary. All commands are submitted if the Start button is clicked.
Previously-submitted commands displayed in the scenario commands table that were uneditable while the scenario was in the RUNNING state become editable again when in the STOPPED state.
# Adding new commands
To add a new command, click on the Add button in the Scenario Commands section.
Specify the appropriate parameters for this new command in the Command Parameters section.
• If a scenario is already in the RUNNING state, click on the Submit button to submit the command or commands.
• If a scenario is in the STOPPED state, click on the Start button at the top of the editor to submit all the new commands and start the scenario.
A Running Scenario
# Existing commands
Once a command has been submitted for a scenario, it cannot be deleted or edited.
# 4.7. Scenario Editors
# Removing commands
The Remove button is only enabled if a command is editable.
Only newly-added commands are editable.
# Ordering commands
The Up and Down buttons allow for the commands to be re-ordered, if the selected command is editable.
Alternatively, the editable selected command can be moved by dragging and dropping it in the commands table.
Only newly-added commands are editable in running Scenarios. If a scenario is stopped, then all commands can be re-ordered.
# Duplicating commands
Scenario commands can be duplicated using Copy and Paste buttons available by right-clicking them to bring up the context menu.
Users can copy any command, which will copy all of the settings included in that command and place it on RnRManager’s clipboard.
Users can only paste a copied command where the “Paste” context menu entry is enabled. Pasting a command will insert it after a selected command, however users cannot insert commands after already submitted commands in a running scenario; they will have to stop the scenario to do that similar to the re-ordering of the commands in the previous section.
To paste a command:
1. Select the command after which you want to insert it
2. Right click on that command
3. Press the “Paste” button
All scenario commands can be duplicated, whether they have been submitted or not in both Live and Offline mode in the Scenario Editor.
# Validation
Commands that have invalid parameters are highlighted with red text in the scenario commands table. Individual invalid command parameters also have their labels highlighted with red text.
If the command is edited to correct the parameters, the entry in the scenario commands table will no longer be highlighted with red.
The Submit and Start buttons will do nothing if there are validation errors.
# Invalid command parameters
# Save As...
The scenario editor has a Save As... button in the top-right corner.
Scenario Editor Save As... button
The Save As... functionality enables the saving of a scenario’s commands and command parameters as an xml file that is not known to the DDS system.
Please refer to the next section, Scenario File Editor Features, for more information on saving scenarios to files.
# 4.7.5 Scenario File Editor Features
The Scenario File Editor
# 4.7. Scenario Editors
# Creating New Files
# Scenario Editor Save As
A new scenario file can be created by clicking on the Save As... button in the top right corner of the scenario editor. This will save the commands specified in the scenario editor to an xml file.
This allows for the saving of a specific DDS system scenario to be loaded at a later date.
# New Scenario File
A new file can be created by right-clicking on a folder under the Saved Scenarios directory structure in the Workspace view and choosing New Scenario File....
New Scenario File
# Editing Commands
• To add a new command, click on the Add button in the Scenario Commands section.
Specify the appropriate parameters for this new command in the Command Parameters section.
• To remove a command, click on the Remove button in the Scenario Commands section.
# Load Scenario
A scenario file can be quickly loaded and submitted into the DDS system.
# Step 1
Select the xml file, right-click and choose Load Scenario.
Load Scenario
# 4.7. Scenario Editors
# Step 2
Specify merge options in the Load Scenario wizard.
Load Scenario wizard
If a senario with the same name already exists, the wizard offers these merge options:
Overwrite existing scenario – The existing scenario with the same name will be stopped (if not already stopped) and disposed.
Rename scenario in file – The scenario name in the file will be changed, and that scenario name will be loaded.
Automatically create referenced storages – Create any storages referenced in the file if they do not already exist in the DDS system.
A new scenario editor opens and the commands from the file are displayed.
# Step 3
Click on Play to submit the scenario commands to the DDS system.
# Validation
Commands that have invalid parameters are highlighted with red text in the scenario commands table. Individual invalid command parameters also have their labels highlighted with red text.
# 4.7. Scenario Editors
If the command is edited to correct the parameters, the entry in the scenario commands table will no longer be highlighted with red.
A scenario file can be saved with invalid parameters.
# 4.7.6 Command Parameters
To view or edit the command parameters of a scenario command, choose the command in the Scenario Commands table. The values associated with that command will populate the scenario editor’s Command Parameters section. If the command is editable, the parameters can be modified.
# Common Parameters
Various command types are supported. To specify the command type, use the dropdown box entitled Kind.
The RnR service ID is also a common parameter for all command kinds.
# Kind Parameters
The Kind Parameters section is where all the command kind-specific parameters are edited or viewed.
The command kinds supported are:
Add Record
Add Replay
Remove Record
Remove Replay
Set Replay Speed
Truncate
Start
Suspend
Config
# Add Record
The add record command is used to specify an interest to record data to a storage.
Add Record parameters
The parameters are:
Storage name – The name of the storage in which the data is to be stored. If the storage cannot be resolved, the command is ignored. To assist you, a dropdown list of recognized storages is provided.
Partition/Topic Sets – One or more partition/topic sets can be added to define the record interest.
# 4.7. Scenario Editors
Wildcards are supported: ‘?’ will match a single character and ‘\*’ will match any number of characters. If expressions (partially) overlap, data will only be recorded once.
# Add Replay
The add replay command is used to specify an interest to replay data from a storage.
Add Replay parameters
Add Replay time ranges
Add Replay QoS transformations
The parameters are:
Storage name – The name of the storage from which the data will be replayed. If the storage cannot be resolved the command is ignored.
Use original timestamps – With the default value of true, when a sample is recorded, its original write and allocation timestamps are preserved. When this sample is replayed, it will be delivered to readers with these original timestamps. Depending on resource limits and QoS settings, readers may discard the replayed data if data with more recent timestamps is available. By setting useOriginalTimestamps to false, the timestamps will be updated with the current time upon replay.
Skip to first sample – By default this value is false and when a sample matches interest expressions but doesn’t match any of the supplied time-ranges, the Record and Replay service tries to mimic original timing behaviour by sleeping until the next sample is evaluated based on record timestamps. Sometimes this is not the required behavior and the service should simply skip all non-matching samples and start replaying im-
# 4.7. Scenario Editors
mediately the first sample that matches an interest expression and time-range. This behaviour can be enabled by setting skipToFirstSample to true.
Partition/Topic Sets – One or more partition/topic sets can be added to define the replay interest.
Wildcards are supported: ‘?’ will match a single character and ‘\*’ will match any number of characters. If expressions (partially) overlap, data will only be published into DDS once.
Time Ranges – Specifying time ranges is optional.
Time ranges are used in combination with partition/topic sets to select a subset of data available in a storage for replay. Each time range is applied to each partition/topic set. A sample read from a storage is only replayed if its partition/topic can be matched against the partition/topic sets and its record-time can be matched against the time-ranges. The time ranges are optional; when omitted, a sample is replayed when a partition/topic set matches.
QoS Transformations - Specifying QoS transformations is optional.
A series of transformations to apply to each sample’s QoS upon replay. Transformations are only applied for replay samples that have matched the partition/topic set AND the time ranges (if specified). The supported transformations types and their valid values are described in the tables below.