Home

User`s Manual - Community RTI Connext Users

1. LOOP Replay of the selected section begins automatically and is restarted immediately after the last data sample of the entity has been replayed For example replay topics with start mode LOOP will each restart as soon as each topic has completing its replay while a session with start mode LOOP will restart only when all of its topics have completed replay Note Currently this mode is operational only for session and replay topic enti ties Apjd 6BuunByuod G Configuring the Replay Tool Table 5 9 Start Mode Values Enumeration Value Description MATCHED CURRENTLY NOT SUPPORTED Replay begins after each child DataWriter has detected at least one matched reader Table 5 10 Time Mode Values Enumeration Value Description ABSOLUTE The start time and stop time values are in absolute timestamps and will be used without modification SERVICE RELATIVE The start_time and stop time values are relative to the replay service s index time i e the index time of the replay service will be added to the start time and stop time values if specified DATABASE RELATIVE The start time and stop time values are relative to the replay database s index time i e the index time of the replay database will be added to the start time and stop time values if specified TOPIC RELATIVE CURRENTLY NOT SUPPORTED The start time and stop time values are relati
2. Apjd 6BuunByuod S Configuring the Replay Tool Table 5 11 Remote Administration Properties Property Syntax Description Configures the QoS for the DataWriter created by the Replay tool s Remote Access module Defaults See the RTI Core Libraries and Utilities online HTML documentation on DataWriters datawriter qos datawriter qos DDS DataWriterQos datawriter gos Specifies in seconds and nanoseconds the period between each status message sent by the Replay Ser vice to the Replay Shell status period When this value is set to zero the default no status status period DDS Duration message is sent status period Applications that want to periodically poll the status of the Replay service they administer should provide a value for this property Default 0 no status is sent 5 9 Type Configuration The type config element allows you to pass type configuration information to the Replay tools in the form of XML type configuration files Table 5 12 describes the Type Configuration properties All Type Config properties are optional Table 5 12 Type Configuration Properties Property Syntax Description xml The XML type configuration for this xml XML Type Configuration Properties domain group See Table 5 13 Type lt xml gt Properties Type Configuration Table 5 13 Type Properties Property Syntax Descr
3. 3 Press Play Dl to begin replaying the data 2 9 Using Recording Console The display will show you the elapsed time since the start of the replay Elapsed time lider controls replay speed Replay rate For example x original rate x2 twice the original rate Changing the Replay Rate The vertical slider on the right controls the replay speed up for faster center for original speed lower for slower To return to the original replay rate press Play Dl You can specify a default replay rate in the Playback configuration panel Select a speed from the drop down list or type in your own value To automatically repeat the replay in a continuous loop select the Auto repeat check box 2 10 Viewing Recorded Topics 2 5 Restricting the Time Range to be Replayed You can limit the start and end time for replaying data by dragging the gray bars seen below Drag these gray bars inward to restrict the time range for replaying data Note This feature cannot be used when using a configuration file Viewing Recorded Topics While recording or when you have loaded a pre recorded file you can use the Recorded Topics panel to see the topics that have been recorded For each topic the table shows the topic name and when the recording is not in progress the first and last recorded samples of that topic If playback is configured through Recording Console the topic table enables y
4. T and F entries represent enabled started pending paused and completed The d s are decimal numbers for how many child topics are owned by the entity and how many active child topics are owned by the entity rate Changes the replay rate of an entity The rate is a multiplier from 0 1 to 4 billion It replays at the speed of the multi plier 2 2x 0 5 1 2x etc Default 1 Using the Replay Shell Table 6 3 Replay Shell s Commands Command Description resume Resume replay of an entity start Starts replay of an entity step Replays a single sample from the entity stop Stops replay of an entity The Replay Shell commands use this format command replay service entity value where command is one of the supported commands see Table 6 3 L replay service is the name given to the Replay service by one of the following in descending order of precedence The value specified with the appName command line option used when starting the Replay tool highest precedence e The value for the replay service administration name element see page 5 13 The value for the replay service name attribute lowest precedence see Section 5 3 entity is any one of the service entities expressed in this hierarchical form database name session name topic name Note In this release not all commands are sup
5. Record tool will create a new file set each time it is started status When the Record tool is configured with remote access enabled it will periodically send its current status The Record Shell stores the most recent status The current status is dis played with the status command RTI Record Shell gt status The output is similar to the following Version 1 4 2 v20080528205153 Timestamp Mon Apr 28 20 02 48 2008 1182222168 58877000 State uvae ecc oes S STOPPED Config file simple config xml Database file simple config dat 34 3 Received bytes 86653952 Saved bytes 2127872 2 10 11 5922 V ejouJey OL Accessing the Record Tool from a Remote Location L Version The Record tool s version L Timestamp The timestamp of the Record tool when status message was sent Ll State The Record tool s state The following states are possible e IDLE e RECORDING e STOPPED the Record tool has been stopped and is not recording any user data e RECONFIGURE e SHUTDOWN e RESTART e DOWNLOAD the Record tool is downloading a new configuration L Config file The name of the file from which the Record tool read its configura tion If the configuration was received with configure localfile this field is not available L Database file The file segment currently being written to LJ Received bytes Total amount of data that has been written to file L Saved bytes
6. every sample is stored alongside all its sample information If this property is set to FALSE the sample is stored in a serialized way with no sample information attached to it Setting this to FALSE not the default saves storage space When set to FALSE less columns are created in the SQLite database The columns in this database are often filled with repetitive data So this option can save space and execution time when these requirements are critical Default value True shared_table lt shared_table gt DDS_Boolean lt shared_table gt Required Specifies whether the tables of recorded data are shared or exclusive The Record tool stores Topic data in tables those tables can be Shared or Exclusive An Exclusive table means that each Topic recorded in a RecordGroup is stored in its own table The name of the table follows the convention TopicName RecordGroupName DomainName The separator can be changed with the path_ separator database property Thus two topics with the same name but from two different TopicGroups are stored in separate tables A shared table means that Topics with the same name are stored in the same table regardless of where it was recorded from In this case the table has an additional column table prefix which stores the table prefix in the form RecordGroupName DomainName Default False exclusive topics topics POSIX fn expressions topics R
7. for both Recording Console and the Replay tool They can only replay data from one file at a time A fileset is a named collection of file segments which belong to the same recording ses sion Each of these file segments contains discovery and user data and the format is determined by SQLite Domain Properties 3 5 The Record tool uses a fixed file naming scheme name set number segment number Where L name is the base filename for the fileset specified in the configuration file with the name property I set number is an integer identifying the fileset specified in configuration file with the lt set number gt property L segment number is an integer identifying the file segment within the fileset The first segment number to use and the maximum number of segments are speci fied in the configuration file with the segment number and max file segments properties respectively For example mydata 5 3 means this file belongs to fileset 5 and is the 3rd segment in that fileset The maximum size of a file segment whether to overwrite existing files and whether to overwrite the oldest file can all be set in the configuration file Domain Properties Table 3 4 describes the Domain properties All Domain properties are optional Domain properties must be specified inside domain name String gt and lt domain gt tags If you want to use a RecordGroup Section 3 7 you must assign a domain name w
8. gt Store sequence of octet in a single column The default true saves the most space While it is possible to store individual elements in separate columns it is not recommended as the number of columns stored can become very large Default true datareader _qos field_expr lt datareader_qos gt DDS_DataReaderQos datareader qos field expr POSIX fn expressions lt field_expr gt Specifies the QoS settings for all DataReaders created for this TopicGroup A DataReader is created for each discovered Topic that matches topic_expr All the DataReaders for the TopicGroup will use the same set of QoS policies You can specify all of the QoS policies with the datareader qos property See the RTI Core Libraries and Utilities User s Manual for more informa tion See the chapter on Configuring QoS with XML See the RTI Core Libraries and Utilities User s Manual for details See the chapter on Configuring QoS with XML Required A list of comma separated POSIX expressions that specify which fields in the Topics to record The Topics are specified with topics see Table 3 6 This parameter is ignored when recording serialized data Buipio2ey BuunByuo Configuring the Record Tool Table 3 5 TopicGroup Properties Property Syntax Description include_meta _columns lt include_meta_columns gt DDS_Boolean lt include_meta_columns gt In the database
9. gt lt max_file_segments gt 4 lt max_file_segments gt lt overwrite gt yes lt overwrite gt In this case the Record tool will delete test_0_0 test_0_1 and test_0_2 before starting to record to test 0 0 Default False Specifies the path separator character that the Record tool will use when creating table and column names For instance table names follows the Topic Name RecordGroupName DomainName convention and fields in Topics uses to navigate hierarchical types such as path_ lt path_separator gt agb c separator m 7 ee eee is used as the default path separator instead of the more conventional because does not require quotes when used in SQLite SQL statements For example to use as the path separator path separator _ path separator Note this property cannot be empty Specifies whether or not the Record tool should overwrite existing file segments in the fileset once the file size limit rollover max file size has been reached for the last file segment rollover DDS Boolean True the Record tool overwrites existing file segments as lt rollover gt needed starting with the first one False the Record tool stops recording data Default False 3 9 Buipio2ey 6HuunByuod Configuring the Record Tool Table 3 3 Database Properties Property Syntax Description self contained self contained DDS Boolean self contained Specifies whether to repli
10. gt RTIDDS_DESERIALIZEMODE_ALWAYS lt deserialize_mode gt lt domain gt lt Create a TopicGroup A TopicGroup is a collection of Topics whose names match the topic_expr The field_expr specifies which fields in the Topics to record Note that a TopicGroup is not bound to a particular domain yet In this example the TopicGroup All means all fields in all Topics gt topic group name All topics topic expr topic expr lt topics gt lt field_expr gt lt field_expr gt lt topic_group gt lt Create a RecordGroup A RecordGroup controls which TopicGroups are recorded for a set of domains Each recorded Topic is stored in a table with the format record_group domain Topic In this example we want to record data from topics in TopicGroup All from domain0 gt record group name RecordAll lt specify which domains to record from gt domain ref element domainO0 element domain ref lt specify which topics to record gt topic ref element All element topic ref record group recorder dds 3 3 Buipio2ey Buun amp yuo Configuring the Record Tool Example configuration files are provided in the examples record directory simple config xml With this configuration the Record tool will record all fields from all topics in a specified domain domain ID 0 L advanced config xml With this configuration the Record
11. of the configuration file Example files are provided in the installation directory gt examples directory 1 On Windows systems from the Start menu select Accessories Command Prompt 4 1 1 p109 ILY Buisn p Using the Record Tool Table 4 1 4 2 Record Tool s Command Line Options Command line Option Description appName lt name gt Assigns an application name to the DomainParticipants created by the Record tool If not specified the same name used in cfgName will be used cfgFile lt file gt Required Specifies the XML configuration file path and filename In addition to the file provided using this command line option the Record tool can load other XML files see Section 3 1 cfgName lt name gt Required This name is used to find the matching lt recorder gt tag in the configuration file Names the fileset to use for storing recorded data ee Default rtirecord dat help Prints version information and list of command line options Specifies the license file path and filename Only applicable to licensed ver licenseFile sions of the Record tool lt file gt If not specified the Record tool looks for the license as described in Section 2 3 in the Getting Started Guide listCfgs Lists the available configuration profiles Specifies what type of logging information should be printed 0 silent Core Libraries and the Record tool 1 errors Co
12. or deserialized format The SampleInfo information as described in the Connext documentation Topic data If the topic data is saved in serialized form a special table is used with the fol lowing columns serialized sample raw data serialized length length of the raw data serialized endian 1 little endian 0 big endian 7 3 o Loa pepiooey BuiMelA Z Viewing Recorded Data with SQLite 7 1 3 Other Tables You will notice that the Record tool creates two additional tables RTILog and RTIVer sion You do not need to use these tables they are for internal use by the Record tool 7 4 Chapter 8 Exporting Recorded Data Recording Service includes a conversion utility that enables serialized or deserialized data recorded with the Record tool to be exported to CSV HTML SQL or XML formats The utility merges the data from all the segments in a fileset It converts recorded data either serialized or deserialized into one of the available formats The output data is deserialized The executable rtirecconv is located in lt install dir gt bin lt architecture gt The script to launch the Convert tool is in lt install dir gt scripts rtirecconv To see a list of available options enter rtirecconv help You will see the following rtirecconv options fileset filename Options help Print out this text version Print out the version verbosity 0 6 verbosity from 0 to 6 fo
13. string max string Integer max string The default values to use when there are unbounded strings in a type max sequence max sequence Integer max sequence The default values to use when there are unbounded sequences in a type path path element Path lt element gt lt path gt A list of the paths to be used when searching for XML type configuration paths The element tag can be repeated 3 22 Domain Type Configuration Table 3 13 XML Properties Property Syntax Description A list of file groups associ ated with this domain group siile group A file group is parsed into a Sea ene single Document Object file_group File Group Properties lt element gt lt file_group gt Module The element tag can be repeated See Table 3 14 File Group Properties Table 3 14 File Group Properties Property Syntax Description register_top_level lt register_top_level gt Boolean lt register_top_level gt Whether or not to register the top level types with their canonical names This over rides the parent max_string lt max_string gt Integer lt max_string gt The default values to use when there are unbounded strings in a type This over rides the parent max_sequence max sequence Integer max sequence The default values to use when there are unbounded seque
14. the Record Tool ieeeitsesetsesatthiccecsdsevteceetistcacavsdtatvenuiel a Ra into 4 1 Stopping the Record Tool i termi eee ei aa 4 2 5 Configuring the Replay Tool 5 1 52 53 5 4 5 5 5 6 5 7 5 8 5 9 How to Load Replay s XML Configuration File sess 5 1 General Format 1 tees ee ees ten ek le 5 2 General Properties for Replay sese nene nennen 5 4 Database Input File Properties sese eee nennen 5 5 5 4 1 Enabling Monitoring Library with Replay sssssseeeeee 5 6 Session PIOPCEHES s 5 5 de eto decer ire deii toc rit e be LA Pe RiR EDE eben 5 7 Replay Topic Properties 2 ete t e tetro re tine ails retos 5 8 Time Coritrol Properties eee eee ei ede etes 5 9 Remote Administration Properties sese eee eene eene 5 12 Type Configuratiori nr a t ee tere ee aee ent etre oen te 5 14 Using the Replay Tool 6 1 6 2 6 3 6 4 6 5 Recording Data for Replay icis iana aaa a des 6 1 Starting the Replay Tool ete ne eet ire hetero ete E 6 1 Stopping the Replay Tool see eee eene nennen 6 2 Using the Replay Shell sees E E nennen 6 3 Performance and Indexing nee eee etate diee A RH 6 6 Viewing Recorded Data with SQLite 7 1 Format of the Recorded Datace nenene nae eoki e e e e a nnne tne 7 2 71 DBiscovery Di e EA duas E IO on E EE 7 2 Z2 User Data 5 inci teet nE sates awash a a a a Eas tho
15. tool will record e The x and y fields from all Topics named Square in domains 0 and 1 The color field from all Topics in domains 0 and 1 LJ remote shell xml This configuration file provides a configuration that can be used with the tutorial found in the Recording Service Getting Started Guide to learn about how to modify the Record tool while it is running 3 2 1 Configuration File Syntax Recording Service follows the same XML syntax rules as Connext Please see the RTI Core Libraries and Utilities User s Manual for details 3 2 2 Supported Data Types As you will see in the following sections each property that can appear in the configu ration file uses a specific data type The Record tool converts between the value string in the XML file and the specified type Table 3 1 lists the supported types and the map pings used by the Record tool Table 3 1 Property Value Data Types Type Format Notes char and octet compact form sequences and arrays yes 1 true on TRUE no 0 false off FALSE DDS Boolean These values are not case sensitive Enum values are not case sensitive Legal values are those listed for the property in the online HTML documentation for the RTI Core Libraries and Utilities C API DDS Enum A string 3 4 General Format Table 3 1 Property Value Data Types Type Format Notes DDS_Long 2147483648 2147483647 0x80000000 0x7ffff
16. use a configuration file called myconfig xml which is local to the Record Shell RTI Record Shell stop RTI Record Shell configure myrecord localfile myconfig xml The Record Shell will read the contents of myconfig xml and send it to the Record tool which will search for a tag record name myrecord gt If auto start see Table 3 2 General Properties is true the default case it is not necessary to run the start command to start the Record tool If auto start is false in the new configuration then issue the start command in the Record Shell to start recording RTI Record Shell start 10 9 sseooy ejouJey OL Accessing the Record Tool from a Remote Location 10 4 1 3 10 4 1 4 10 4 1 5 10 4 1 6 10 10 L remotefile filename To configure the Record tool with the contents of a file that is local to the Record tool use the remotefile filename option For example assume that you want reconfigure the Record tool with a file called remotemyconfig xml which resides on the same file system as the Record tool RTI Record Shell stop RTI Record Shell configure myrecord remotefile remotemyconfig xml The Record tool will read the contents of remotemyconfig xml and reconfigure with the contents of the tag record name myrecord Depending on the con figuration file it may be necessary to start it RTI Record Shell start delete This command deletes entities from the Recor
17. used from the external file These configuration elements from the file are retained will be used L lt dds gt lt recorder gt The name attribute will be used for the launched service L lt dds gt lt recorder gt lt remote_access gt lt remote_access_domain gt This will be used for the administration domain ID 1 dds recorder Many of the settings from this element are retained except as noted below e remote access The Domain ID is retained All other settings are replaced so that they are compatible with Recording Console s settings e recorder database This is replaced with the database file specified in Recording Console Note To return to using the default QoS settings press ZS on the far right Load recordng cc e file Return to CiProgram Files x amp B JRTIIRTI Recording Service 4 examplestrecorajsimple_conigxm Q B default ig conicuration example z Configuring Replay from an External File To use an external configuration file for replay 1 Press n to open the Recording and Playback Configuration panels 2 5 ojoq BulApjdey Zz Using Recording Console 2 In the Playback Configuration panel press to open the Configuration by File panels First selecta Load play fi i om the file e CiPregram Files KEA THATI Recording Service 4 Shexamplestreplay simple_ contig Qn a Then select a Profile 3 Press the Open Folder button to select a configuration file for re
18. FILES xml This file contains the Connext default QoS values it is loaded automatically if it exists First to be loaded T File in NDDS QOS PROFILES The files or XML strings separated by semicolons referenced in this environ ment variable are loaded automatically L working directory gt USER_QOS_PROFILES xml This file is loaded automatically if it exists If the USER_QOS_PROFILES file is found and there is a default profile specified in it this default profile is automat ically applied to the QoS settings of the Recording Service entities 1 x stands for the version letter of the current release 3 1 Buipio ey BuunByuo Configuring the Record Tool The next locations are specific to Recording Service M lt rtirecord executable location gt resource xml RII RECORDING SERVICE xml This file contains the default configuration for the Record tool it is loaded if it exists RTI RECORDING SERVICE xml defines a configuration that records all topics on domain 0 I working directory USER RECORDING SERVICE xml This file is loaded automatically if it exists 1 File specified with the command line option cfgFile see Table 4 1 on page 4 2 I File specified using the remote command configure The configure command see Table 4 1 on page 4 2 allows loading of an XML file remotely The file loaded using this command replaces the file loaded using the cfgFile command line option La
19. File lt file gt Name of output file cannot be used with file prefix typeConfig file cfgName Name and configuration of the XML type configuration file For example assume that recorded data is stored in a file named mydata dat 0 The command to convert the recorded data into XML format is rtirecconv mydata dat 0 An output file called mydata dat 0 xml will be created To convert to an HTML table instead the command is rtirecconv format html mdata dat 0 This will create an output file called mydata dat 0 html Note The Convert tool cannot process partially recorded deserialized data If you want to record only a subset of the fields in the data structure you should record in serialized format For deserialized recorded data it is better to use sqlite to output the data instead of rtirecconv Chapter9 Example Configuration Files 9 1 This chapter shows how to configure the Record tool for a variety of situations L1 How to Record All Topics in a Single Domain Section 9 1 How To Record a Subset of Data from Multiple Domains Section 9 2 I How To Record Data to Multiple Files Section 9 3 LJ How To Record Serialized Data Section 9 4 LJ How To Record Using Best Effort Reliability Section 9 5 LJ How To Enable Remote Access Section 9 6 How to Record All Topics in a Single Domain Scenario You have a system with several nodes using domain ID 54 You want all the data in this system to be recorded t
20. Properties Property Syntax Description time control i A Specifies time configuration properties to be time control Time Control Properties z applied to the Session time control input Required Configures the topics that are to be input Input Properties replayed from the database See Table 5 6 Input lt input gt Properties lt output gt Configures the attributes to be used in writing the output Output Properties replayed topics See Table 5 7 Output Proper lt output gt ties Table 5 6 Input Properties Property Syntax Description lt topic_name gt Required Specifies the name of the topic_name that topic_name String was specified in the Record tool s configuration file or lt topic_name gt a regular or wildcard expression Specifies the name of the type_code to be used in lt type_name gt D s p I pum writing matching topics This parameter will default ype to if not specified Replay will search for a match type name NE ing type name only within matching topic records Time Control Properties Table 5 6 Input Properties Property Syntax Description record_group_name String lt record_group_name gt lt record_group_name gt Required Specifies the name of the record_group that was specified in the Record tool s configuration file or a regular or wildcard expression
21. RIT Recording Service User s Manual Version 4 5 f t Your systems Working as one 2007 2012 Real Time Innovations Inc All rights reserved Printed in U S A First printing March 2012 Trademarks Real Time Innovations RTI and Connext are trademarks or registered trademarks of Real Time Innovations Inc All other trademarks used in this document are the property of their respective owners Copy and Use Restrictions No part of this publication may be reproduced stored in a retrieval system or transmitted in any form including electronic mechanical photocopy and facsimile without the prior written permission of Real Time Innovations Inc The software described in this document is furnished under and subject to the RTI software license agreement The software may be used or copied only under the terms of the license agreement Third Party Copyright Notices Portions of this product include software derived from Fnmatch c 1989 1993 1994 The Regents of the University of California All rights reserved The Regents and contributors provide this software as is without warranty Technical Support Real Time Innovations Inc 232 E Java Drive Sunnyvale CA 94089 Phone 408 990 7444 Email support rti com Website http www rti com support Contents 1 Welcome to RTI Recording Service 2 Using Recording Console 2 1 2 2 2 3 2 4 2 5 2 6 Starting and Stopping the Console 2 1 Con
22. Recording Console to use when recording or replaying the data There are two ways to configure Recording Console by using its Configuration panels shown below or by using settings from external configurations files see Section 2 2 1 2 3 ood BulApjdey z Using Recording Console 2 2 1 Configuring from an External File If you have a use case which is not covered by the default configuration generated by Recording Console you can use an external configuration file as the basis of the settings to record or replay Recording Console can load any configuration file which is supported by the Record or Replay tools These files are described in Chapter 3 Configuring the Record Tool and Chapter 5 Configuring the Replay Tool 2 2 1 1 Configuring Recording from an External File To use an external configuration file for recording 1 Press oy to open the Recording and Playback Configuration panels Configure by file 2 In the Recording Configuration panel press to open the Configuration by File panels First select a File j configurations from the file Please open a recording contigurations fffej Select a rec Then select a Profile 3 Press the Open Folder button to select a configuration file for recording 4 Select a QoS profile from the drop down listbox 2 4 Configuring Recording Console 2 2 1 2 It is important to understand which parts of the configuration settings are
23. Total number of data that has is currently saved to file Note that if the rollover property is true then Saved bytes may be less than Received bytes 10 4 1 12 stop 10 4 2 10 12 This command stops the Record tool from recording user data RTI Record Shell stop Running Multiple Record Tools in the Same Domain The Record Shell can only keep track of one instance of the Record tool To control multi ple copies of the Record tool in the same domain with the Record Shell run each Record tool instance in a separate partition For the first instance of the Record tool change the configuration file as follows remote access enabled true lt enabled gt domain domain0 lt domain gt gubscriber qos partition lt name gt lt element gt RecordA lt element gt Using the Example Remote Access Application Record Shell lt name gt lt partition gt lt subscriber_qos gt lt publisher_qos gt lt partition gt lt name gt lt element gt RecordA lt element gt lt name gt lt partition gt lt publisher_qos gt lt remote_access gt For the second instance of the Record tool change the configuration file as follows lt remote_access gt lt enabled gt true lt enabled gt domain domain0O lt domain gt gubscriber qos partition lt name gt lt element gt RecordB lt element gt lt name gt lt partition gt lt subscriber_qos gt publisher qos pa
24. able remote access in a particular partition noUdpv4 Disables the UPDv4 transport updv6 Enables the UDPv6 transport noShmem Disables the shared memory transport noMulticast Disables multicast The verbosity is a bit map that specifies what type of logging infor mation should be printed The verbosity may be 0 No messages verbosity mask 1 Exceptions default 2 Warnings 4 Information 7 All types help Prints version information and a list of options 10 7 5922 V ejouJey OL Accessing the Record Tool from a Remote Location 10 4 1 Record Shell s Commands LI add Section 10 4 1 1 I configure Section 10 4 1 2 LI delete Section 10 4 1 3 LI exit Section 10 4 1 4 LJ info Section 10 4 1 5 LJ model Section 10 4 1 6 1 pause Section 10 4 1 7 LJ resume Section 10 4 1 8 LJ shutdown Section 10 4 1 9 J start Section 10 4 1 10 LJ status Section 10 4 1 11 LI stop Section 10 4 1 12 Several of the commands accept a model argument A model is an XML representa tion of two aspects of the Record tool 1 The configuration model the XML configuration similar to the XML configura tion file used to configure the Record tool 1 The run time model an XML description of the entities that have been created based on the configuration The format of this XML is the same as the configuration format for the Record tool see Ch
25. abled srvName name Specifies a name that will be used to identify the service verbosity value Specifies what type of logging information should be printed Silent Exceptions both Connext and the Replay tool Warnings the Replay tool only Information the Replay tool only Warnings both Connext and the Replay tool Tracing the Replay tool only Tracing both Connext and the Replay tool Default 1 gv gra Urdu Using the Replay Shell Table 6 1 Replay Tool s Command line Options Command line Option Description version Prints the Replay tool s version 6 4 Using the Replay Shell The Replay Shell is a Connext application that can remotely control the Replay tool To start the Replay Shell Open a command prompt and change to the lt install dir gt scripts directory Then enter install dir scripts rtireplaysh options Table 6 2 lists the command line options you can use when starting the Replay Shell Once it is started you can use the commands in Table 6 3 Table 6 2 Replay Shell s Command Line Options Command line Option Description cmdFile file A file that contains commands to be run domainId integer Specifies the domain ID an integer between 0 and 232 Default 0 help Prints version information and a list of options 1 On Windows systems from the Sta
26. ample was received l The BuiltinTopicData The SampleInfo information as described in the Connext documentation Note When using self contained database files the locator filter column of the Publi cation Built in Topic Data will not be replicated The Subscription Built in Topic Data will also not be replicated This is done to minimize the overhead of replication when opening a new database file Format of the Recorded Data 7 1 2 User Data L Deserialized Data When the Record tool stores data in deserialized form it creates a mapping from a Topic to a table Each individual scalar is stored in a column named with the fully qualified name For example the following will create a column bar x struct Bar js long x struct Foo 1 Bar bar L Topic Data The Record tool creates a table called TopicName RecordGroupName Domain Name for each recorded topic unless the shared table property is true The Record tool stores topic data as specified in the subscription properties For each topic the Record tool also stores the following in this order A timestamp in microseconds since Jan 1st 1970 Note that the column name is timestamp with 3 underscores This is the time that the data was committed to the database The domain ID from which the sample was received Table prefix RecordGroupName DomainName only if shared table is specified Whether the data is stored in serialized
27. apter 3 Configuring the Record Tool The top level tag must be lt dds gt followed by recorder Some examples for model are dds recorder record group name RecordAll record group recorder dds dds recorder topic group name RTI Shapes Demo gt topics topic expr Square topic expr Using the Example Remote Access Application Record Shell 10 4 1 1 10 4 1 2 topics field expr color field expr topic group recorder lt dds gt add This command adds entities to the Record tool The add command has the following format add model configure The Record tool can be reconfigured remotely with the configure command There are two ways to reconfigure the Record tool using a local file or a remote file Note that the Record tool must be stopped before it can be reconfigured When the Record tool is reconfigured it will shut down completely The Record Shell will lose its connection with the Record tool until the Record tool re establishes remote access If remote access is not enabled in the new configuration Record Shell will not reconnect to the Record tool The configure command has the following format configure cfg name localfile remotefile file The configuration name cfg name is used to find the matching recorder tag to load LI localfile filename Example Assume that you want to the Record tool to
28. auto auto detect reliability If set to true use the same reliability as the Publisher of detect DDS Boolean the matched Topic reliability auto detect reliability Default false Store array of char in a single column The default 7 true saves the most space While it is possible to store t lt compact char array individual elements in separate columns it is not compact_ DDS_Boolean char_array recommended as the number of columns stored can compact char array become very large Default true 3 14 TopicGroup Properties Table 3 5 TopicGroup Properties octet_array lt compact_octet_array gt Property Syntax Description Store array of octet in a single column The default true saves the most space While it is possible to store compact octet array tae Pos individual elements in separate columns it is not compact_ DDS_Boolean P recommended as the number of columns stored can become very large Default true compact_ char_ sequence lt compact_char_sequence gt DDS_Boolean lt compact_char_sequence gt Store sequence of char in a single column The default true saves the most space While it is possible to store individual elements in separate columns it is not recommended as the number of columns stored can become very large Default true compact_ octet_ sequence lt compact_octet_sequence gt DDS_Boolean lt compact_octet_sequence
29. ay tool s ability to store indexes is controlled by the lt readonly gt parameter under replay database see Database Input File Properties Section 5 4 The default value for lt readonly gt is false this allows the Replay tool to write the table indices to the database If you change lt readonly gt to true the Replay tool will display a message during initialization for each table opened stating that it was unable to store the table index In summary the replay performance of the Replay tool is not affected by the lt readonly gt parameter The Replay tool will use the fastest means of retrieving samples in either case But setting the lt readonly gt option to false the default may help improve initialization performance Chapter 7 Viewing Recorded Data with SQLite The Record tool stores data in a SQL database This chapter describes how the data is stored and how to view the data with the provided SQL command line tool sqlite3 Important For information on SOL commands please visit www sglite org To open a recorded file start sqlite3 For example cd rtirecord 4 5 x ndds 4 5y bin architecture sqlite3 recorded file gt Then you can list all the available topics by entering sqlite gt tables This will list the tables one per topic in the database file For example Circle MyGroup MyDomain DCPSParticipant DCPSPublication DCPSSubscription RTILog RTIVersion Square RecordAl1 MyDomain Squa
30. bscriber qos property so it will use default Sub scriber QoS settings record group name RecordAl1 gt topic ref element AllTopics lt element gt topic ref domain ref element MyDomain lt element gt domain ref record group Note A RecordGroup can refer to multiple domains and multiple TopicGroups How ever a RecordGroup will only record one of each matching Topic from a Domain If multiple matches occur only the first one will be recorded If you need to record the same Topic from the same domain using different QoS policies you should use different TopicGroups and RecordGroups Remote Access Properties As you will see in Chapter 10 Accessing the Record Tool from a Remote Location you can create a Connext application that can remotely control the Record tool By default Remote Access is turned off in the Record tool for security reasons Buipio2ey BuunByuo Configuring the Record Tool The Remote Access section of the configuration file is used to enable Remote Access and configure its behavior A Remote Access section is not required in the configuration file The remote application can send commands to the Record tool that will l Start stop recording L Shutdown the Record tool L Reconfigure the Record tool Table 3 8 describes the Remote Access properties All Remote Access properties must be specified inside lt remote_access gt and lt remote_access gt ta
31. cate the necessary discovery infor mation for conversion to other formats If set to TRUE the Participant and Publication tables will be replicated when a new database file is opened Default False Example self contained TRUE self contained Note When using self contained database files the locator filter column of the Publication Built in Topic Data will not be replicated The Subscription Built in Topic Data will also not be replicated This is done to minimize the over head of replication when opening a new database file segment number segment number DDS Long segment number Specifies the first segment to use in the fileset If the segment number is gt 0 that is the first segment num ber in the fileset Default 1 The next available segment number will be used starting at 0 Note the set number is determined first then the segment number set number set number DDS Long set number Specifies the set number to use in the fileset If the set number is gt 0 that specific fileset number is used In this case the lt overwrite gt property takes effect Default 1 The next available set number will be used start ing at 0 The Record tool stores data in a set of SOL database files Note however that you do not need to install any database software to use the Record tool Note Replaving data from a set of files is not supported This holds true
32. ction only applies if you want to use RTI Monitoring Library a separate RTI Con next component that enables Connext applications to provide monitoring data The mon itoring data can be visualized with RTI Monitor a separate GUI application that can run on the same host as Monitoring Library or on a different host Recording Service is stati cally linked to Monitoring Library you do not have to install it separately To enable monitoring in the Replay tool use the same approach described in Enabling Monitoring Library Section 3 5 1 In the replay database section include the rti monitor library property with the value rtimonitoring For example participant domain id 0 domain id participant qos lt property gt lt value gt Session Properties lt element gt name rti monitor library name lt value gt rtimonitoring lt value gt lt propagate gt false lt propagate gt lt element gt lt value gt lt property gt participant qos participant 5 5 Session Properties Table 5 4 describes the Session s properties All session properties are optional except replay topic These properties must be specified inside session namez String and session tags where String is the name to be assigned to the session entity when it is created This name will be used during remote administration Table 5 4 Session Properties Property Syntax Description p
33. d tool The delete command has the following format delete model exit This command exits the Record Shell RTI Record Shell exit info This command shows you which Record tool session the Record Shell is connected to The output looks similar to this STATE Connected to 0a0a64fe 0065bbe00 GUID 0a0a64fe 006bbb00 L STATE Which DomainParticipant the Record tool is connected to HOSTID APPID GUID The GUID of the Record Shell itself model This command prints the current model of the Record tool RTI Record Shell gt model Using the Example Remote Access Application Record Shell 10 4 1 7 10 4 1 8 10 4 1 9 10 4 1 10 10 4 1 11 pause This command pauses the recording of entities in the Record tool The pause command has the following format pause lt model gt resume This command resumes the recording of already paused entities in the Record tool The resume command has the following format resume lt model gt shutdown This command causes the Record tool to shut down and terminate This command can only be issued when the Record tool has been stopped start The start command is used to start the Record tool Note that this command only works after stopping the Record tool first since the tool is started when it is launched When the start command is given the Record tool will shut down completely delete all state and objects and start from scratch By default the
34. ding Instructs the Record tool to reconfigure according to the contents of the message Stop the Record tool before sending this message RECORDER CONFIGURE If the Record tool has already been stopped it will read the new configu ration and restart It will not automatically start recording unless From auto start see Table 3 2 General Properties is true the default case Your Connext If the Record tool has not already been stopped an error is returned Remote RECORDER Control SHUTDOWN Instructs the Record tool to shutdown and exit Application iti PP RECORDER ADD Instructs the Record tool to add entities based on the contents of the mes To sage The Record tool RECORDER DELETE Instructs the Record tool to delete entities based on the contents of the message RECORDER PAUSE Instructs the Record tool to pause entities based on the contents of the message RECORDER RESUME Instructs the Record tool to resume recording of previously paused enti ties based on the contents of the message 1 a RECORDER PING Instructs the Record tool to send the recording model to the Remote Control application To RECORDER INFO When the Record tool publishes statistics it periodically sends out this Your Connext message type Remote Control Application RECORDER RESPONSE Indicates that this message is a response to a command From The Record tool a The recording model is an XML representation of two aspects of the Reco
35. domain_name lt domain_name gt String lt domain_name gt Required Specifies the name of the domain_name that was specified in the Record tool s configuration file or a regular or wildcard expression Table 5 7 Output Properties Property Syntax Description topic_name lt topic_name gt String lt topic_name gt Specifies the name to be assigned to the topic when creating a DataWriter to write the data to be replayed type_name datawriter_qos lt topic_name gt String lt topic_name gt datawriter qos DDS_DataWriterQos lt datawriter_qos gt Specifies the name to be assigned to the type when creating a DataWriter to write the data to be replayed Specifies the QoS settings for all DataWriters created for this Replay_Topic A DataWriter is created for each Topic that matches the topic_expr All the DataWriters for the Replay_Topic will use the same set of QoS policies You can specify all of the QoS policies with this datawriter qos prop erty See the RTI Core Libraries and Utilities User s Manual s chapter on Configuring QoS with XML topic qos topic gos DDS TopicQos topic qos Specifies the QoS settings to be applied to the topic when cre ating a DataWriter to write the data to be replayed 5 7 Time Control Properties The time control element can be applied to any of Replay s major entities replay service re
36. donly gt See Performance and Indexing Section 6 5 session Required The configuration properties that describe how to Session replay the information in a session This element can be Properties repeated lt session gt See Table 5 4 Session Properties Ap dey BuunByuo G Configuring the Replay Tool Table 5 2 Replay Database Properties Property Syntax Description lt time_control gt dine control Time Con trol The time configuration properties to be applied to the replay Properties database lt time_control gt Optional XML type configuration for this replay_database This lt type_config gt option is useful when type codes have not been recorded in the type_config XML Properties database or when specifying types that are too large to be type config recorded in the database See Table 5 13 Type Properties Table 5 3 Participant Properties Property Syntax Description domain id domain id DDS Long Sets the domain ID Default 0 domain id Configures the DomainParticipant s QoS policies See the RTI Core Libraries and Utilities User s Man ual s chapter on Configuring QoS with XML Defaults See the RTI Core Libraries and Utilities online HTML documentation on DomainPartici pants participant qos participant qos DDS QosPolicy participant qos 5 4 1 Enabling Monitoring Library with Replay This se
37. econd Specifies how many file segments may be created Each time the max_file_size limit is reached for a file max file segments segment a new file is created if this number of segments has max file DDS Long not been exceeded segments lt max_file_segments gt Default 1 Example lt max_file_segments gt 100 lt max_file_segments gt Specifies the maximum size for a file segment The Record tool records data to one or more files This prop erty specifies the maximum file size This is not an absolute lt max file sizes value but a threshold value As soon as the threshold is max_file_ Fi ie Bia exceeded no more data is written to file size Default 2 GB Maximum imposed by the operating system Example max file size 1 GB lt max_file_size gt Database Output File Properties Table 3 3 Database Properties Property Syntax Description Specifies whether or not the Record tool should delete all existing file segments in the fileset before it starts recording This is useful if you want to reuse a data file name between recording sessions but do not want to keep any old data True if the file segments already exist they are deleted oth erwise the file segments are created as needed zoverwrites False if the file segments already exist the Record tool exits overwrite DDS Boolean otherwise the file segments are created as needed overwrite Example lt name gt test lt name
38. eliability while others use strict reliability You want to minimize the impact that the Record tool has on the system Configuration File lt dds gt recorder name scenario5 gt lt topic_group name Sensor gt lt topics gt lt topic_expr gt Sensor lt topic_expr gt lt topics gt lt field_expr gt value lt field_expr gt lt datareader_qos gt lt reliability gt kind BEST EFFORT RELIABILITY QOS lt kind gt reliability datareader qos topic group lt recorder gt lt dds gt Expected Outcome The Record tool will use DataReaders with best effort Reliability to record all data suoyoinByuoD ejduupxa 6 Example Configuration Files 9 6 How To Enable Remote Access Scenario The Record tool is part of a larger system that must reach a steady state before it starts recording The Record tool should use domain ID 54 and partition rti for communica tion with the controller Configuration File dds recorder name scenario6 remote access enabled yes lt enabled gt publish status period 10 publish status period remote access domain domain54 remote access domain gubscriber qos partition name element rti lt element gt lt name gt lt partition gt lt subscriber_qos gt lt remote_access gt lt domain name domain54 gt lt domain_id gt 54 lt domain_id gt lt domain gt lt reco
39. equired Specifies a topic expression and any exemptions to that expression See Table 3 6 TopicGroup Properties Table 3 6 Topics Properties Property Syntax Description exemption Specifies a comma separated list of expressions that exemption POSIX fn expressions should not be recorded lt exemption gt Default nothing is exempt Required A comma separated list of POSIX expressions that lt topic_expr gt specify the names of Topics to be included in the Top topic_expr POSIX fn expression icGroup lt topic_expr gt The syntax and semantics are the same as for Partition matching Default null TopicGroup properties must be specified inside topic group namez String and lt topic_group gt tags For example the following creates a TopicGroup called AllTopics which will include all discovered Topics From those Topics all fields will be recorded This example does not specify the optional datareader qos property so it will use default DataReader QoS set tings topic group name AllTopics gt topics topic expr lt topic_expr gt topics field expr lt field_expr gt topic group This next example creates a TopicGroup called ColorsOfSquares that will only include Topics named Square For the recorded Topics only the color field will be recorded The DataReaders for the matching Topics will have default QoS settings except that the Reliability QoS
40. ext default QoS values it is loaded automatically if it exists First to be loaded LJ File in NDDS QOS PROFILES The files or XML strings separated by semicolons referenced in this environ ment variable are loaded automatically L working directory gt USER_QOS_PROFILES xml This file is loaded automatically if it exists If the USER QOS PROFILES file is found and there is a default profile specified in it this default profile is automat ically applied to the QoS settings of the Recording Service entities 1 x stands for the version letter of the current release 5 1 Ap dey BuunByuo G Configuring the Replay Tool 5 2 5 2 The next locations are specific to Replay L lt rtiReplay executable location gt resource xml RTI_REPLAY_SERVICE xml This file contains the default configuration for the Replay tool it is loaded if it exists RTI REPLAY SERVICE xml defines a configuration that replays all top ics on domain 0 working directory gt USER_REPLAY_SERVICE xml This file is loaded automatically if it exists IJ The file specified with the command line option cfgFile see Table 6 1 on page 6 2 You may use a combination of the above approaches General Format The Replay configuration file uses XML format The main sections use the following top level tags Top level Tag Reference Section replay service General Properties for Replay Section 5 3 repla
41. fff A 32 bit signed integer You may include the following unit designations KB 2 10 kB 10 3 MB 10 6 GB 1049 KiB 2410 MiB 2420 GiB 2430 For example 100 kB is a legal value meaning 100 000 DDS_UnsignedLong 0 4294967296 O Oxffffffff A 32 bit unsigned integer You may include the following unit designations KB 2410 kB 1043 MB 106 GB 1049 KiB 2410 MiB 2420 GiB 2430 For example 100 kB is a legal value meaning 100 000 3 5 Buipio2ey 6HurnByuod Configuring the Record Tool Table 3 1 Property Value Data Types Type Format Notes DDS_QosPolicy See the RTI Core Librar ies and Utilities online HTML C API documen tation for the structure of each QoS policy and the RTI Core Libraries and Util ities User s Manual s chap ter on Configuring QoS with XML Each field in each QoS policy structure has a correspond ing tag The tag is the same as the field name in the RTI Core Libraries and Utilities C API For enumerations the legal constants are those defined for the Connext C_API For example gubscriber qos presentation access scope DDS TOPIC PRESENTATION QOS access scope lt presentation gt lt partition gt lt name gt lt element gt rti lt element gt lt name gt lt partition gt lt subscriber_qos gt The above configuration will set a the Presen
42. figuring Recording Console seen nennen 2 2 22 1 Configuring from an External File sse 2 4 Recording Data etre noiri eee eie rene e rea ee b pee an 2 7 23 1 Troubleshooting Recording Problems sse 2 8 Replaying Dat c acit ee reete t deed nea eee tib n dace di pep aaa 2 9 Viewing Recorded IOpies nete ete eeepc e epi eg eene nie 2 11 Scheduling Recording and Replay Tasks sse 2 13 3 Configuring the Record Tool 3 1 32 3 3 3 4 3 5 3 6 3 7 3 8 3 9 How to Load the XML Configuration sse 3 1 General Format 2 ARR eb eae RE AT 3 2 3 2 1 Configuration File Syntax sssssseeeeeee eene eee e enne 3 4 3 22 Supported Data Types ice eunt cenineit nite dati iir te ea eet e aiaa 3 4 General Properties for the Record Tool 3 7 Database Output File Properties sssssssssseeeeeeenenenenhnne eee 3 7 Domaiti Properties sioe d eter bipes undi ra o P ri re vd 3 11 3 5 1 Enabling Monitoring Library sese eee eee eee 3 13 3 52 Recording Large User Data Types sess eene 3 13 TopicGroup Properties sssssseeeeeneneeenenne nennen n nen nennen 3 14 R cordGroup Properties nennen dee ge eret tr edet eee deo 3 18 Remote Access Properties sssi tian be eat ee a e eee ridus 3 19 Domain Type Configuration sse eee nennen ennt nnne 3 21 4 Using the Record Tool 4 1 4 2 Starting
43. for Replay Table 5 1 describes optional properties that control the Replay tool s main module All replay service properties are optional except replay database These properties must be specified inside replay service name String gt and replay service tags where String is the name to be assigned to the service entity when it is created This name will be used during remote administration unless it is overridden by the administration name element Table 5 1 Replay Service Properties lt administration gt Property Syntax Description Configures the DomainParticipant that can be used to lt administration gt remotely control Replay via the rtireplaysh utility Remote See Remote Administration Properties Section 5 8 administration Administration The Remote Administration Properties must specify a Properties domain_id You may also specify a name participant_qos publisher qos subscriber qos datareader qos and datawriter qos auto exit auto exit DDS Boolean auto exit Controls whether or not the Replay tool should terminate when all the available data specified in the initial configura tion has been replayed Default False Database Input File Properties Table 5 1 Replay Service Properties Property Syntax Description replay_database lt replay_database gt Replay Database Properties lt replay_database gt Required S
44. gs All remote access proper ties are optional unless otherwise noted Table 3 8 Remote Access Properties Property Syntax Description Specifies if the Record tool will accept com accept E ee ere mands that have been broadcast to any Record i tool or only accept commands addressed spe broadcast_ DDS BOOL ean cifically to it See Chapter 10 Accessing the commands lt accept_broadcast_commands gt Record Tool from a Remote Location Default true Enables or disables remote access to the Record lt enabled gt tool from another application See Chapter 10 enabled DDS_Boolean Accessing the Record Tool from a Remote lt enabled gt Location Default false remote access disabled datareader_qos lt datareader_qos gt DDS_DataReaderQos lt datareader_qos gt Configures the QoS for the DataReader created by the Record tool s Remote Access module Default default DataReader QoS settings datawriter_qos lt datawriter_qos gt DDS_DataWriterQos lt datawriter_qos gt Configures the QoS for the DataWriter created by the Record tool s Remote Access module Default default DataWriter QoS settings publish_status_ period lt publish_status_period gt DDS_Long lt publish_status_period gt Specifies in seconds the period between each status message sent by the Record tool Default 1 Minimum value 1 publisher qos publisher qos DDS PublisherQos publishe
45. he configuration If the configuration spans multiple samples then only the last one should have this set to TRUE K msg gt msg _u config final_config DDS_BOOLEAN_TRUE Tell the Record Tool that the filename to read from follows in the config_from_string text string wp msg msg u config config from file DDS BOOLEAN TRUE copy the name of file that the Record tool shall read from strncpy msg msg u config config from string filename 512 copy the configuration name of the recorder tag to load strncpy msg msg u config config name cfgname 512 Send the configuration message to the Record tool dds writer has been created elsewhere X retcode RTIRemoteCtxMsgDataWriter write dds writer msg amp DDS HANDLE NIL check for errors here while no response retcode RTIRemoteCtxMsgDataWriter read next sample dds reader msg amp info amp DDS HANDLE NIL if retcode DDS RETCODE NO DATA response received sleep 1 10 5 ssedoy ejouJey OL Accessing the Record Tool from a Remote Location Table 10 1 Messages Types Exchanged Between Record Tool and Remote Access Application Message Type add prefix RTI_LREMOTECTX_ Direction MSG Description RECORDER START Instructs the Record tool to start recording RECORDER STOP Instructs the Record tool to stop recor
46. his is useful if you want to start the Record tool in stand by mode then you can use remote access see Section 3 8 to switch to a different configuration file one that does have a RecordGroup and start recording Table 3 7 describes the RecordGroup properties The following properties are required LI domain ref LI topic ref RecordGroup properties must be specified inside record group name String and record group tags The name that you assign String will be used in the table name s in the database output file s Remote Access Properties Table 3 7 RecordGroup Properties Property Syntax Description lt domain_ref gt Required domain ref StringSequence Specifies a sequence of references to domains domain ref Default null topic ref Required topic ref StringSequence Specifies a sequence of references to TopicGroups topic ref Default null Configures the Subscriber used by the RecordGroup subscriber gos Default default Subscriber QoS setti subscriber_qos DDS_SubscriberQos ETa at CETAN nen ar Sep ener subscriber qos See the RTI Core Libraries and Utilities User s Manual for details See the chapter on Configuring QoS with XML 3 8 For example the following creates a RecordGroup called RecordAIl which will include all members of TopicGroup All that are discovered on Domain MyDomain This exam ple does not specify the optional su
47. iption register_top_level lt register_top_level gt Boolean lt register_top_level gt Whether or not to register the top level types with their canonical names max_string lt max_string gt Integer lt max_string gt The default values to use when there are unbounded strings in a type max_sequence max sequence Integer max sequence The default values to use when there are unbounded sequences in a type path element A list of the paths to be used when searching for path Path XML type configuration paths The element tag can element be repeated path tile groups A list of file groups associated with this domain selenernit gt group A file group is parsed into a single Docu file_group File anes ment Object Module The element tag can be Properties repeated lt element gt lt file_group gt See Table 5 14 XML Type Properties Table 5 14 XML Type Properties Property Syntax Description register top level register top level Boolean register top level Whether or not to register the top level types with their canonical names This overrides the parent max string max string Integer max string The default values to use when there are unbounded strings in a type This overrides the parent max sequence max sequence Integer max sequence The default values to use when there are unb
48. is limited to milliseconds Default Infinity start offset start offset DDS Duration start offset The time to offset the selected entity s starting time from its par ent entity This value is used for synchronizing data that is replayed from different sources When applied to the replay service Replay will delay for the number of seconds specified between the creation of the entities and the start of replay To allow for discovery for example When applied to a replay database this time is the amount of offset between the index time of the replay service and the index time of the database When applied to a replay database this time allows an additional DDS Boolean element auto offset which if set TRUE directs Replay to automatically calculate the offset between the index time of the replay database and the index time of the replay service This value should not be applied to lt ses sion or replay topic Default 0 Table 5 9 Start Mode Values Enumeration Value Description AUTOMATIC Replay of the entity begins automatically For subordinate entities replay begins when parent replay starts MANUAL Replay of the entity begins when explicitly directed by remote administration When an entity is manually started all of its child entities with AUTOMATIC start mode will also be started at the same time and so forth continuing to the lowest child
49. istration and lt administration gt tags Table 5 11 Remote Administration Properties domain id Property Syntax Description lt name gt Assigns a name to the replay service You can use this name String name when sending commands via Replay Shell see lt name gt Section 6 4 lt domain_id gt domain_id DDS_Long Sets the domain ID Default 0 participant_qos participant qos DDS ParticipantQos participant qos Configures the QoS for the Participant created by the Replay tool s Remote Access module Defaults See the RTI Core Libraries and Utilities online HTML documentation on DomainParticipants publisher qos publisher gos DDS PublisherQos publisher qos Configures the QoS for the Publisher created by the Replay tool s Remote Access module Defaults See the RTI Core Libraries and Utilities online HTML documentation on Publishers subscriber qos subscriber qos DDS QosPolicy gubscriber qos Configures the QoS for the Subscriber created by the Replay tool s Remote Access module Defaults See the RTI Core Libraries and Utilities online HTML documentation on Subscribers datareader qos datareader gos DDS DataReaderQos datareader qos Configures the QoS for the DataReader created by the Replay tool s Remote Access module Defaults See the RTI Core Libraries and Utilities online HTML documentation on DataReaders
50. ith these tags even if you do not specify any domain properties because the domain name is needed in the RecordGroup s domain ref property You may specify more than one Domain Each one must have a unique name with its own domain name String gt and lt domain gt tags Note Transports are configured through the Property QoS under the participant_gos tag Buipio2ey BuunByuo Configuring the Record Tool Table 3 4 Domain Properties Property Syntax Description Determines how topic data is stored in a database serial ized or deserialized The following values are allowed J RTIDDS DESERIALIZEMODE AUTOMATIC deserialize data if possible otherwise store data in serialized format deserialize mode deserialize mode DDS Enum J RTIDDS DESERIALIZEMODE NEVER deserialize mode Do not deserialize the data store data in serialized format L RTIDDS DESERIALIZEMODE ALWAYS Only store data if it can be deserialized first Default RTIDDS DESERIALIZEMODE NEVER See Recording Large User Data Types Section 3 5 2 domain id domain id DDS Long domain id Sets the domain ID Default 0 Configures the DomainParticipant s QoS policies Default default DomainParticipant QoS settings See the RTI Core Libraries and Utilities User s Manual for details See the chapter on Configuring QoS with XML participant qos participant qos DDS QosPolicy participa
51. m each of these topics you only want to record the fields whose name includes value such as value_max value_min current_value Configuration File lt dds gt recorder name scenario2 record database database name mydomaindata database name max file size 1 GB max file size record database domain name mydomain54 gt domain id 54 domain id 9 2 How To Record a Subset of Data from Multiple Domains lt domain gt lt domain name mydomain98 gt lt domain_id gt 98 lt domain_id gt lt domain gt lt topic_group name Sensor gt lt topics gt lt topic_expr gt Sensor lt topic_expr gt lt topics gt lt field_expr gt value lt field_expr gt lt topic_group gt record group name sub0 gt domain ref element mydomain54 lt element gt lt domain_ref gt lt topic_ref gt lt element gt All lt element gt lt topic_ref gt lt record_group gt record group name sub1 gt domain ref element mydomain98 element domain ref topic ref lt element gt All lt element gt lt topic_ref gt lt record_group gt lt recorder gt lt dds gt Expected Outcome The expected outcome is a single file about 4 GB with all the data in a file called mydomaindata_0_0 By default the Record tool will store deserialized data so the file will have one column per field in the topic suoyoinbyuoD ejduupxa 6 E
52. nces in a type This overrides the parent file name file name element File Name lt element gt lt file_name gt A list of the files that contain XML type definitions The element tag can be repeated 3 23 Buipio2ey BuunByuo Configuring the Record Tool 3 24 Chapter 4 Using the Record Tool 4 1 Besides using Recording Console you can also record data by using the Record tool While the Console provides a simple graphical user interface GUI for using the Record tool you can also run it directly without using the Console You may find this method of recording useful when you want to tie its service into your own infrastructure or soft ware or if you need to use its more advanced features For instance perhaps you want to run them from your own script to record periodically or to process the recorded data automatically Starting the Record Tool Open a command prompt and change to the lt install dir gt scripts directory Then enter gt rtirecord cfgFile file cfgName configuration To see a list of available arguments enter rtirecord help To see which configurations are available use the listCfgs option rtirecord listCfgs To use your own configuration file rtirecord cfgFile config file xml cfgName my record cfg Table 4 1 describes the command line options and which ones are required Chapter 3 Configuring the Record Tool describes the contents
53. nt qos For example the following creates a Domain named mydomain using domain ID 68 The data will be recorded in serialized format The DomainParticipant will use default QoS settings except for the Discovery QoS policy s accept unknown peers field domain name mydomain gt domain id 68 domain id deserialize mode RTIDDS DESERIALZEMODE NEVER deserialize mode participant qos discovery accept unknown peers false accept unknown peers discovery participant qos lt domain gt Domain Properties 3 5 1 3 5 2 Enabling Monitoring Library This section only applies if you want to use RTI Monitoring Library a separate RTI Con next component that enables Connext applications to provide monitoring data The mon itoring data can be visualized with RTI Monitor a separate GUI application that can run on the same host as Monitoring Library or on a different host Recording Service is stati cally linked to Monitoring Library you do not have to install it separately To enable monitoring for the Record tool modify the participants QoS in the XML con figuration to include the rti monitor library property with a value of rtimonitoring For example domain name domain0 gt participant qos lt property gt lt value gt lt element gt lt name gt rti monitor library lt name gt lt value gt rtimonitoring lt value gt lt propagate gt false lt pr
54. o a single file called mydomaindata When the file is full record ing should stop The typecodes are available from the system Configuration File dds recorder name Scenariol gt record database database name mydomaindata database name max file size 1 GB max file size record database domain name mydomain gt domain id 54 domain id lt domain gt 9 1 suoyoinbyuoD ejduupxa 6 Example Configuration Files topic group name All topics topic expr lt topic_expr gt topics field expr lt field_expr gt topic group record group name sub0 gt domain ref element mydomain lt element gt domain ref topic ref element All lt element gt lt topic_ref gt lt record_group gt lt recorder gt lt dds gt Expected Outcome The expected outcome is a single file about 4 GB with all the data in a file called mydomaindata_0_0 By default the Record tool will store deserialized data so the file will have one column for each field in the topic 9 2 How To Record a Subset of Data from Multiple Domains Scenario You have a system with multiple domains including domain IDs 54 and 98 and hun dreds of topics whose names contain Sensor such as TemperatureSensor HeatSensor SensorTypes etc in addition to hundreds of other topics You only want to record the topics that start with Sensor and fro
55. ons and which ones are required 1 On Windows systems from the Start menu select Accessories Command Prompt 6 1 ood BulApjdey 9 Using the Replay Tool 6 3 Stopping the Replay Tool To stop the Replay tool use lt Control c gt Table 6 1 Replay Tool s Command line Options Command line Option Description appName lt name gt Specifies an application name which is used to identify the application for remote administration Default cfg Name cfgFile lt file gt Required Used to identify the XML configuration file cfgName lt name gt Required Identifies the configuration within the XML configuration file The Replay tool will load the lt replay_service gt with the same name as this value domainIdBase int Adds this value to the domain IDs in the configuration file Default 0 When used with XML Type Configuration this option instructs forceXmlTypes Replay to always use type code from the XML file even if an alternate is available from recorded data help Displays this information identifyExecution Appends the host name and process ID to the appName to help using unique names noAutoEnable Use this option if you plan to enable the Replay tool remotely remoteAdministrationDomainId int Enables remote administration and sets the domain ID for the communication Default remote administration is not en
56. opagate gt lt element gt lt value gt lt property gt lt participant_qos gt lt domain_id gt 0 lt domain_id gt lt domain gt See also Enabling Monitoring Library with Replay Section 5 4 1 Recording Large User Data Types When the Record tool records serialized user data each primitive type in the topic s data structure will have its own column in the table The maximum number of columns is approximately 1 950 Therefore if you have a data type that would require more than 1 950 columns you must set the deserialize_mode property to RTIDDS_DESERIALIZEMODE_NEVER Disregarding this limit will cause recording to fail Note Each primitive type is considered a column For example the following would require 3 000 columns long Array 3000 3 13 Buipio2ey BuunByuo Configuring the Record Tool As y 0 x a y 0 x b y 1 x a y 1 x b etc another example the following would require separate columns for struct X long a long b Y7 struct Y X X 1 struct Z Y y 10 j 3 6 TopicGroup Properties A TopicGroup is an optional logical collection of Topics If you are not going to have a RecordGroup in the configuration file you do not need a TopicGroup See Section 3 7 Table 3 5 describes the TopicGroup properties The following properties are required E field_expr LJ shared table LI topics Table 3 5 TopicGroup Properties Property Syntax Description
57. ormation the Record tool only oF O Ne tracing the Record tool only 6 tracing Core Libraries and the Record tool 3 4 Database Output File Properties Table 3 3 describes the Database properties All database properties are optional except database_name All database properties must be specified within lt record_database gt and lt record_database gt tags Table 3 3 Database Properties Property Syntax Description create_index lt create_index gt DDS_Boolean lt create_index gt Specifies whether or not the Record tool will index the data base on the reception_timestamp column to allow for effi cient replay Disable for maximum recording performance Default False 3 7 Buipio2ey BuunByuo Configuring the Record Tool Table 3 3 Database Properties Property Syntax Description database_name lt database_name gt String lt database_name gt Required The name of the fileset used to store recorded data The Record tool appends a set number and a segment num ber to the filename Default undefined Example lt database_name gt myfile lt database_name gt Specifies how often in seconds to flush data to disk lt max_file_size gt flush_ lt ilush period Note increasing this value causes the Record tool to use period DDS_Long additional memory lt f lush pertod gt Default 1 second Minimum 1 s
58. orner locate the file that you want to record into Note If you specify an existing file the file will be overwritten with new data New data is not appended to the end of the existing file contents 2 7 Using Recording Console 3 Press the Record button el to start recording File size grows as data is recorded Begin X time time Stop Pause 2 3 1 Troubleshooting Recording Problems Problem You pressed the Record button but the recording file size stays at zero Solution Make sure that IJ The Recording Domain ID matches the domain ID used by the source the appli cation from which you want to record data 1 Data is coming in from the source by using tools such as rtiddsspy provided with Connext in its scripts directory 1 You have access rights to create files in the directory where the recording file is to be created 2 8 Replaying Data 2 4 Replaying Data You can use the Console to replay data that was recorded using the Console or the Record tool You may replay data recorded with an older version of Recording Service To replay data 1 Make sure you have set the domain ID in the Playback Configuration panel see Section 2 2 2 Press the Open Folder button Goal in the upper right corner locate the file whose data is to be replayed then click Open When the file is loaded you will see the time of the original recording Original recording time and date
59. ou to select which topics to replay Searching for Topics To assist in selecting multiple topics use the search bar on the bottom of the topics panel You can narrow down the topics that are displayed based on a substring in the topic name Note The search bar does not support regular expressions When the desired group of topics is displayed you can use the select all unselect all buttons on the entire group Only the selected Topics will be replayed poq 6uiApideg z Using Recording Console Click here to open the Recorded Topics kecorged T First ded l Last ded Topics Panel p opic Irst recor sample ast recorded sample 08 17 24 PM EST Fri Mar 2 2012 08 21 56 PM EST Fri Mar 2 2012 Search for topics by name here To restore and see the list of all topics remove erase the search string from the search box Topic selection in the table is only available when the Console is in Ready mode not recording or replaying data and you have used the Playback Configuration panel not a configuration file Scheduling Recording and Replay Tasks 2 6 Scheduling Recording and Replay Tasks To schedule recording or replay 1 Press the Schedule button 2 Select the type of task record replay or stop current operation and the starting time and date 3 Enable the activity by selecting the Action checkbox on the left 4 Optionally select an ending time for the activity Activity Schedule Mus
60. ounded sequences in a type This overrides the parent file name file name element File Name lt element gt lt file_name gt A list of the files that contain XML type definitions The element tag can be repeated Apjdey 6BuunByuod G Configuring the Replay Tool 5 16 Chapter 6 Using the Replay Tool 6 1 6 2 Besides replaying data with Recording Console you can use the Replay tool directly You may find this method useful when you want to tie its service into your own infrastruc ture or software or if you need to use its more advanced features The Replay tool replays recorded data by publishing it just like the original Connext application did You can use the original domain ID QoS settings and data rate or make changes to test different scenarios Recording Data for Replay The Replay tool can replay information that has been stored in either serialized or deseri alized form If Replay is to be used to replay deserialized data ensure that all of the fields of the sample data are recorded as Replay is unable to replay partial data Note SQLite is unable to look at the individual fields in the sample data of files recorded in serialized mode Starting the Replay Tool Open a command prompt and change to the lt install dir gt scripts directory Then enter gt rtireplay cfgFile lt file gt cfgName lt configuration gt Table 6 1 describes the command line opti
61. pecifies configuration properties that describe how to replay the information from a database This ele ment can be repeated See Database Input File Properties Section 5 4 time_control lt time_control gt Time Control Properties lt time_control gt Specifies time configuration properties to be applied to the Replay tool as a whole See Time Control Properties Section 5 7 5 4 Database Input File Properties Table 5 2 describes the source of the data that Replay will replay All lt replay_database gt properties are optional except session These properties must be specified inside replay database name String gt and replay database tags where String is the name to be assigned to the database entity when it is created This name will be used during remote administration Table 5 2 Replay Database Properties Property Syntax Description fil ves logo dd Specifies the name of the fileset that contains the data to be please Stee replayed Default undefined lt filename gt Pees lt participant gt participant ean See Table 5 3 Participant Properties Properties lt participant gt Specifies if Replay should open the data file in read only mode lt readonly gt i true or read write mode false Setting this option to false is readonly DDS Boolean useful to enable indexing of older database files Default False lt rea
62. play 4 Select a QoS profile from the drop down listbox Here again only parts of the configuration file are retained while other settings are taken from Recording Console These configuration elements are retained L lt dds gt lt replay_service gt The name attribute will be used for the launched ser vice L lt dds gt lt replay_service gt lt administration gt lt domain_id gt This will be used for the administration domain ID The rest of the lt administration gt element is replaced to ensure run time compatibility with Recording Console L lt dds gt lt replay_service gt Many of the settings will be retained from this element except for e Only the first lt session gt from the first lt replay_database gt will be retained e The lt filename gt will be replaced with the file specified in Recording Console Note To return to using the default QoS settings press on the far right Return to default configuration o m 2 6 Recording Data 2 3 Recording Data To record data 1 Make sure you have set the domain ID in the Record Configuration panel see Section 2 2 2 Choose where to save the recorded data You can create a new file or choose an existing one e To create a new file Press the New Recording button D and specify a file name and location for the new recording Then click on Create File e To record over an existing file Press the Open Folder button in the upper right c
63. play database session and replay topic The index time of the replay service is the earliest index time of all of its compo nent replay database entities 5 9 Ap dey BuunByuo G Configuring the Replay Tool The index time of a lt replay_database gt is the earliest timestamp of the database taken from its creation log L The index time of a replay topic is the earliest timestamp of the topic taken from the first recorded sample of the topic All time control properties are optional The start_time and stop time values of a child entity are constrained by the start_time and stop time settings of its parent entities If a start time or stop time value is explic itly specified and constrained by one of its parent entities Replay will issue a warning that the value has been truncated The start mode of a child entity overrides the start mode setting of its parent entities The time mode value of a child entity cannot be applied to a parent entity e g TOPIC RELATIVE cannot be applied to the time control time mode element of a lt ses sion replay database or replay service Table 5 8 Time Control Properties Property Syntax Description Specifies the replay rate expressed as a multiple of the original rate at which the data was recorded Therefore 1 means the same as the original rate 2 means twice as fast etc Although this rate may be specified a
64. ported for all entity levels Please see the Recording Service Release Notes for details on which modes are currently sup ported The database name must match a name from a replay database tag in the configuration file that you specified when starting the Replay tool such as replay database name simple config Similarly if you specify a session name it must match a name from a session tag within the specified database such as session name A_Session gt If you specify a topic name it must match a name from a replay topic tag within the specified session such as replay topic name All_Topic gt 6 5 ood BulApjdey 9 Using the Replay Tool 6 5 6 6 If you do not specify an entity the command is applied to the replay service itself value depends on the command see Table 6 3 Not all commands require a value Performance and Indexing The Replay tool replays stored samples in the same order in which they were received using SQLite indexes to retrieve the samples in sorted order SOLite automatically builds indexes when opening an SQLite table for sorted access and for large tables the process of building the index may take some time To improve initialization performance the Replay tool attempts to create and store indexes rather than depend upon automatic indexing for the tables that it will be replaying this saves initialization time on subsequent replays The Repl
65. r qos Configures the QoS for the Publisher created by the Record tool s Remote Access module Default default Publisher QoS settings 3 20 Domain Type Configuration Table 3 8 Remote Access Properties Property Syntax Description remote access domain remote access domain String remote access domain Required if enabled is true Specifies which domain the Record tool will use to enable remote access Only one domain can be specified Note that this is a String not a Domain ID It is the same String used in the domain name String lt domain gt line Default false subscriber qos gubscriber qos DDS QosPolicy sgubscriber qos Configures the QoS for the Subscriber created by the Record tool s Remote Access module Default default Subscriber QoS settings 3 9 Domain Type Configuration The Domain Type Config allows you to pass type configuration information to the Record and Convert tools in the form of XML type configuration files Table 3 9 describes the Domain Type Config properties All Domain Type Config prop erties are optional Table 3 9 Record Type Configuration Properties Property Syntax Description domain type config Type configuration for spe cific domains domain type config Domain Type Config Properties See Table3 10 Domain domain type config Type Configuration P
66. rceXMLTypes Always use XML type definitions if available compact mode How to read octet char arrays and sequences Default auto auto Detect automatically how data is stored and compact do not compact each type of data accordingly yes Show the structures with compact data regardless of how they are stored no Do not compact the structures regardless of how they are stored tableExpr expr POSIX fn name expressions Can be repeated includeInfo Include the DDS SampleInfo structure for each sample includeDiscovery Include discovery traffic includeNonData Include non data samples decodeUnknown Try to decode samples from DDS DataWriters with no typecode format format Output format Default xml xml Output in XML format csv Output CSV format 8 1 ood pepiooeg Buiuodx3 g Exporting Recorded Data 8 2 html Output in HTML table format sql Output in SQL table format decodeChar lt format gt Decode char data in this format Default text hex Decode char data as hex text Decode char data as ASCII text decodeOctet lt format gt Decode octet data in this forma Default hex hex Decode octet data as hex text Decode octet data as ASCII text time lt format gt Format for timestamp epoch Show timestamp in microsec from January 1 1970 gmt Show timestamp in GMT filePrefix lt prefix gt Create one file per table called lt prefix gt _ lt Table gt output
67. rd tool 1 The configuration model the XML config uration similar to the XML configuration file used to configure the Record tool and 2 The run time model an XML description of the entities that have been created based on the configuration Note that only a a minimal model is returned the QoS are not returned 10 6 Using the Example Remote Access Application Record Shell 10 4 Using the Example Remote Access Application Record Shell The Record Shell is a Connext application that can remotely control start stop and recon figure the Record tool The Record Shell is not meant as a complete solution to remotely controlling the Record tool Its purpose is just to give you an idea of what can be done The Record Shell rtirecsh is in lt install directory gt bin lt architecture gt For example to start the Record Shell enter cd lt install directory gt scripts rtirecsh domain lt domain ID gt Table 10 2 lists the command line options you can use when starting the Record Shell Once it is running you can use the commands described in Record Shell s Commands Section 10 4 1 Table 10 2 Record Shell s Command Line Options Command line Option Description Required d i d in ID NC M ME Specifies the domain ID an integer between 0 and 99 Specifies an optional comma separated list of partition names This partition names option is necessary if the Record tool is configured to en
68. rder gt lt dds gt Expected Outcome The Record tool will communicate with a remote controller on domain ID 54 using parti tion rti Status information will be published every 10 seconds 9 6 Chapter 10 Accessing the Record Tool from a 10 1 Remote Location Perhaps you want to start stop the Record tool from another machine or even reconfig ure it to change what is being recorded You can create a Connext application that can remotely control the Record tool This chapter explains how To control the Record tool from a remote location 1 Configure the Record tool to allow remote access see Remote Access Properties Section 3 8 2 Create a Connext application using the provided rtirecord idl file You will use rtiddsgen to generate the basics and then add code to send your desired remote commands Overview If the Record tool is configured to allow remote access it creates a DataReader for a command Topic named RTI RECORDER CMD TOPIC and a DataWriter for sta tus Topic named RTI RECORDER STATUS TOPIC So the Record tool will write sta tus updates and read commands These topics types and names are specified in the IDL file resource idl rtirecord idl When the Record tool detects a remote DataReader and DataWriter of these special top ics from the same participant the Record tool will be in a connected state which means it will accept remote commands sseooy ejouJey OL Acce
69. re Libraries and the Record tool default 2 warnings the Record tool only 3 warnings Core Libraries and the Record tool verbosity 4 information the Record tool only 5 tracing the Record tool only 6 tracing Core Libraries and the Record tool This property can also be set in the configuration file However this com mand line option overrides the value specified in the configuration file Stopping the Record Tool To stop the Record tool Press Ctrl C The Record tool will close all files and perform a clean shutdown You can also start stop and even reconfigure the Record tool remotely see Chapter 10 Accessing the Record Tool from a Remote Location Chapter 5 Configuring the Replay Tool 5 1 When you start the Replay tool you must specify a configuration file in XML format In that file you can set properties that control the data source which topics to replay and attributes such as the replay speed This chapter describes how to write a configuration file How to Load Replay s XML Configuration File The Replay tool loads its XML configuration from multiple locations This section pres ents the various approaches listed in load order The first three locations only contain QoS Profiles and are inherited from Connext see Chapter 15 in the RTI Core Libraries and Utilities User s Manual 1 NDDSHOME resource qos_profiles_4 5x xml NDDS_QOS_PROFILES xml This file contains the Conn
70. re SRecordxySquaresinMyDomain MyDomain Triangle RecordAll MyDomain You can query the tables using standard SQL syntax For example assume that the Topic Circle was recorded in RecordGroup MyGroup in domain MyDomain In this case the Record tool creates a table called CirclebMyGroup MyDomain to store all data published on Topic Circle To list all data received on Topic Circle enter sqlite gt select from Circle MyGroup MyDomain 7 1 o Loa pepiooey BuiMelA Z Viewing Recorded Data with SQLite 7 1 7 2 Note For more example commands please see the Chapter 4 in the Getting Started Guide To exit sqlite3 enter sqlite gt exit Format of the Recorded Data Discovery Data The Record tool stores discovery related data in these tables L DCPSParticipant corresponds to the Participant Built in Topic DCPSPublication corresponds to the Publication Built in Topic L DCPSSubscription corresponds to the Subscription Built in Topic Please refer to the RTI Core Libraries and Utilities C API documentation for the fields in each of the corresponding builtin topics In the HTML documentation for the C API select Modules Domain Module Built in Topics The Record tool stores the following information in this order 1 A timestamp in microseconds since Jan 1st 1970 LJ State internal information can be ignored LI Type internal information can be ignored I The domain ID from which the s
71. roper ties Table 3 10 Domain Type Configuration Properties Property Syntax Description domain group domain group element element gt Domain Group Properties lt domain_group gt A list of type configuration elements The elements tag can be repeated See Table 3 11 Domain Group Type Configuration Properties 3 21 Buipio ey Buun amp yuo Configuring the Record Tool Table 3 11 Domain Group Type Configuration Properties Property Syntax Description domain_filter lt domain_filter gt lt element gt POSIX fn expression element domain filter A list of expressions for the domains for which these Domain Group Properties should apply The element tag can be repeated type_config lt type_config gt XML Properties lt type_config gt The type configuration for this Domain Group See Table 3 12 Type Config uration Properties Table 3 12 Type Configuration Properties Property Syntax Description xml xml XML Type Config Properties xml The XML type configuration for this domain group See Table 3 13 XML Proper ties Table 3 13 XML Properties Property Syntax Description register top level register top level Boolean register top level Whether or not to register the top level types with their canonical names max
72. rt menu select Accessories Command Prompt 6 3 ood 6uiApjdes 9 Using the Replay Tool Table 6 2 Replay Shell s Command Line Options Command line Option Description timeout lt seconds gt Maximum number of seconds to wait for a remote response Default 15 seconds verbosity lt value gt Specifies what type of logging information should be printed Silent Exceptions both Connext and the Replay tool Warnings the Replay tool only Information the Replay tool only Warnings both Connext and the Replay tool Tracing the Replay tool only Spa PYN RS Tracing both Connext and the Replay tool Default 1 Table 6 3 Replay Shell s Commands Command Description exit Exits the shell goto Repositions an entity to a specific point in the playback range relative to the entity s start and end times This command takes a timestamp argument which is a string of digits of the form SSSSSSSSSSUUUUUU The first ten digits specify seconds and the last six digits specify microseconds pause Pauses replay of an entity query Returns the status of an entity including f the entity is enabled started pending paused and completed The number of child topics owned by the entity The number of active child topics owned by the entity The format of this status is ccccc dd dd where each c is either T or F and dd is a decimal number The
73. rtition lt name gt lt element gt RecordB lt element gt lt name gt lt partition gt lt publisher_qos gt lt remote_access gt Then you can run the Record Shell for each partition rtirecsh partition RecordA rtirecsh partition RecordB 10 13 5922 V jow y OL Accessing the Record Tool from a Remote Location 10 14
74. s a real decimal number the Sedes internal resolution of the rate value is stored as a percentage with tate PEAL oe two decimal places The rate may also be configured with the spe Soria cial value AS FAST AS POSSIBLE which directs Replay to replay the data without any intervening time between samples The minimum value is 0 01 1 of the original rate Default 1 das mode idi ancien de Sets the starting mode of the entity as described in Table 5 9 Start Mode Values Default AUTOMATIC lt start_mode gt Zia eas Describes how the start_time and stop_time parameters should dmi mode Time dade be interpreted See Table 5 10 Time Mode Values Default x pi modes DATABASE RELATIVE except when applied to a n replay service entity whose default is SERVICE RELATIVE The time of the recorded data at which replay is to begin The lt start_time gt time is interpreted based on the setting of time mode start time DDS Duration j tart times Although expressed as sec and lt nanosec gt the internal resolu tion of Replay is limited to milliseconds Default 0 Time Control Properties Table 5 8 Time Control Properties Property Syntax Description The time of the recorded data at which replay is to stop The time stop time is interpreted based on the setting of time mode stop time DDS Duration Although expressed as sec and lt nanosec gt the internal resolu stop time tion of Replay
75. s contents You will learn the meaning of each line as you read the rest of this chapter dds replay service name default gt lt Optional remote administration configuration gt administration domain id 1 domain id administration time control gtart time 6 start time time control auto exit yes auto exit replay database name simple config filename replay database dat lt filename gt lt Optional ParticipantQos gt participant domain id 0 domain id lt participant gt session name simple session time control rate 2 rate time control lt Optional PublisherQos gt publisher qgos publisher qos replay topic name all_topics gt time control gtop time 26 stop time time control input lt Required Values gt lt topic_name gt lt topic_name gt lt type_name gt lt type_name gt 5 3 Apjdey 6HuunByuod G Configuring the Replay Tool lt record_group_name gt lt record_group_name gt lt domain_name gt lt domain_name gt lt input gt lt Optional Values for writing data gt lt output gt lt Optional DataWriterQos gt lt datawriter_qos gt lt datawriter_qos gt lt output gt lt replay_topic gt lt session gt lt replay_database gt lt replay_service gt lt dds gt 5 3 General Properties
76. s kind will be DDS RELIABLE RELIABILITY QOS topic group name ColorsOfSquares gt topics topic expr Square topic expr topics field expr color field expr datareader qos reliability kind DDS RELIABLE RELIABILITY QOS lt kind gt reliability datareader qos 3 17 Buipio2ey BuunByuo Configuring the Record Tool 3 7 3 18 lt topic_group gt The following example creates a TopicGroup called AllMinusCircleAndSquare that will include all Topics except Circle and Square For the recorded Topics all fields will be recorded topic group name AllMinusCircleAndSquare topics topic expr lt topic_expr gt exemption Circle Square lt exemption gt topics field expr lt field_expr gt topic group Note Topics are never removed from a TopicGroup The resources used to create DataReaders for discovered Topics are not released if when the Topics are deleted Note The Record tool will ignore Topics published with a type that conflicts with an already discovered type RecordGroup Properties A RecordGroup is a binding between a TopicGroup and a Domain It controls which TopicGroup members are recorded for each Domain Any Topic that is part of a Topic Group in the RecordGroup is recorded from the specified Domains RecordGroups are optional If you do not create one the Record tool will not record any data T
77. ssage is intended If accept broadcast commands is turned off this structure must match that of the Record tool If accept broadcast commands is turned on this structure can be a specific destination or all 0 s msg id A user specified integer that identifies a particular message exchange When the Record tool sends a response to a command it will include the same msg id that was received in the command msg A union of different message types The discriminator must be set to one of the message types listed in Table 10 1 The code fragment in Figure 10 4 shows how to set the message type in the remote access application Depending on the message type the correct union member must also be filled in For example Figure 10 5 shows how to construct a message to the Record tool to read a new configuration from a file In this example the new configuration is to be read from a file on the same file system as the Record tool Figure 10 4 Assigning a Message Type C Language 10 4 RTIRemoteCtxMsg msg msg RTIRemoteCtxMsgPlugin create sample msg msg d RTI REMOTECTX MSG RECORDER START Remote Control Messages Figure 10 5 Sending a Command to the Record Tool to Read a New Configuration File RTIRemoteCtxMsg msg DDS ReturnCode t retcode Struct DDS SampleInfo info msg RTIRemoteCtxMsgPlugin create sample msg msg d RTI REMOTECTX MSG RECORDER CONFIGURE This is the last part of t
78. ssing the Record Tool from a Remote Location Your remote access application will use the following constants L RTI REMOTECTX MSG TYPE Register a type of this name as seen in Figure 10 1 L RTI RECORDER CMD TOPIC Create a DataWriter with this Topic name as seen in Figure 10 2 J RTI RECORDER STATUS TOPIC Create a DataReader with this Topic name as seen in Figure 10 2 See Remote Control Messages Section 10 3 for more information Figure 10 1 Registering the Message Type RTIRemoteCtxMsgTypeSupport register type self dds participant RTI REMOTECTX MSG TYPE 10 2 Establishing a Connection with the Record Tool To establish a connection with the Record tool your remote access application needs 12 Topics one for commands one for status I 1 DataReader 1 1 DataWriter When creating the DataReader and DataWriter use the following QoS settings I history kind DDS KEEP ALL HISTORY QOS LJ reliability kind DDS RELIABLE RELIABILITY QOS Figure 10 2 shows how to create the Entities in your remote control application using the C API A general knowledge of Connext is assumed Establishing a Connection with the Record Tool Figure 10 2 Creating the Required Entities dds topic cmd DDS DomainParticipant create topic dds participant RTI RECO RTI REMOTECTX MSG TYPE amp NULL DDS STATUS MASK NONE dds topic status RDER CMD TOPIC tqos E DDS DomainParticipant crea
79. st to be loaded You may use a combination of the above approaches 3 2 General Format The configuration file uses XML format The main sections are 1 General Properties for the Record Tool Section 3 3 L Database Output File Properties Section 3 4 contained in the top level tag lt record_database gt LJ Domain Properties Section 3 5 contained in the top level tag domain name String Ll TopicGroup Properties Section 3 6 contained in the top level tag lt topic_group gt LJ RecordGroup Properties Section 3 7 contained in the top level tag lt record_group gt LJ Remote Access Properties Section 3 8 contained in the top level tag lt remote_access gt L Domain Type Configuration Section 3 9 contained in the top level tag lt domain_type_config gt 3 2 General Format Let s look at a very basic configuration just to get an idea of its contents You will learn the meaning of each line as you read the rest of this chapter lt dds gt lt This simple configuration records all topics from domain ID 0 gt recorder name example gt lt Specify where to store the recorded data gt lt record_database gt lt database_name gt simple_config dat lt database_name gt lt record_database gt lt Create a DomainParticipant in domain 0 with default QoS gt domain name domain0 gt lt domain_id gt 0 lt domain_id gt lt deserialize_mode
80. t 7 3 Tks Other lable8 2 ett teret an a e e a AN a 7 4 Exporting Recorded Data Example Configuration Files 9 1 9 2 9 3 9 4 9 5 9 6 How to Record All Topics in a Single Domain sse 9 1 How To Record a Subset of Data from Multiple Domains sss 9 2 How To Record Data to Multiple Files esses en 9 4 How To Record Serialized Data sse eere eren 9 4 How To Record Using Best Effort Reliability ssssssssseesenee 9 5 How To Enable Remote Access sees enne ener enne nnn 9 6 10 Accessing the Record Tool from a Remote Location TOL Overview in eene ete e t ete tte ee Mte eee d eea e eee Ege Te e Ee alae 10 1 10 2 Establishing a Connection with the Record Tool sees 10 2 10 3 Remote Control Messages 2 crede ter oerte theatro 10 4 10 4 Using the Example Remote Access Application Record Shell 10 7 10 4 1 Record Shell s Commands esses nennen ennt 10 8 10 4 2 Running Multiple Record Tools in the Same Domain vi Chapter 1 Welcome to RTI Recording Service RTI Recording Service includes Record an RTI Connext formerly RTI Data Distribution Service application that records both RTI Connext discovery and topic data All recorded data is stored in one or more SQL database files See Chapter 4 Using the Record Tool 2 Replay a tool tha
81. t be March 2012 March 2012 checked Sun Mon Tue Wed Thu Fri Tue Wed Thu Fri 26 27 28 29 2 3 26 27 28 29 2 4 gt S T7 8 9 10 4 5 6 8 9 10 11 12 13 314 15 16 17 11 12 13 15 16 17 18 19 20 21 22 23 24 18 19 20 22 23 24 25 26 27 28 29 30 31 25 26 27 29 30 31 2 3 4 5 6 7 1 2 3 5 6 7 Important Notes 1 Be sure to enable the activity by selecting the Action checkbox on the left l Recording Console s window must remain active for the scheduled operation to run You may minimize the window but closing it will cancel the activity 1 When selecting a file in which to record be aware that any data already in the file will be erased 2 13 ojoq BulApjdey Zz Using Recording Console 2 14 Chapter 3 Configuring the Record Tool 3 1 When you start the Record tool you may specify a configuration file in XML format it is not required In that file you can set properties that control what to record how to record and where to save the recorded data This chapter describes how to write a con figuration file How to Load the XML Configuration The Record tool loads its XML configuration from multiple locations This section pres ents the various approaches listed in load order The first three locations only contain QoS Profiles and are inherited from Connext see Chapter 15 in the RTI Core Libraries and Utilities User s Manual I NDDSHOME resource qos_profiles_4 5x xml NDDS_QOS_PRO
82. t can play back the recorded data You even have the option of replaying the data with different data rates or QoS settings See Chapter 6 Using the Replay Tool 1 Recording Console a simple graphical user interface GUI for using the Record and Replay tools This interface significantly reduces Recording Service configura tion time and complexity and does not require any programming The Recording Console makes it easy to use Recording Service for testing algorithms and other processing logic against pre recorded test data conducting regression testing from golden data inputs or recording live data from the field for post mission analysis See Chapter 2 Using Recording Console L Convert a utility that enables serialized or deserialized data recorded with Record to be exported to CSV HTML SQL or XML formats see Chapter 7 View ing Recorded Data with SQLite LI A SQL command line tool sqlite3 which provides another way to view the data files Recording Features 1 Records data from applications in multiple domains 1 Records entire Topics or specific Topic fields based on POSIX file name match ing expressions 1 Records all data types except bit fields QWOIIOM L Welcome to RTI Recording Service LJ Records to multiple files with configurable file size limits Optionally overwrites the oldest file when the maximum number of files has been reached 1 Records the DDS Samplelnfo structure and a times
83. tamp for both discovery data and user data I Records using either Best Effort or Reliable communications I Optionally records data from only specified partitions 1 Supports remote operation Replay Features I Publishes data samples that were recorded in serialized format L Highly configurable you can Choose which serialized topics to replay Set the replay rate faster or slower or use the original rate Change the QoS of the publications Configure the QoS for the tool itself Dynamically control the replay start stop pause and single step through the data samples This document assumes you have a basic understanding of DDS terms such as Domain Participants Publishers DataWriters Topics and Quality of Service QoS policies For an overview of DDS terms please see the RTI Core Libraries and Utilities User s Manual Chapter 2 Using Recording Console 2 1 This chapter describes how to use Recording Console which provides an easy way to record and replay data Starting and Stopping the Console Recording Console s executable is in install directory gt console A script to run the exe cutable is in install directory gt scripts On Linux systems 1 Open a command prompt and change to the install directory gt scripts direc tory 2 Start the Console by entering gt rtirecordingconsole 3 Set a Domain ID as described in Section 2 2 On Windows systems 1 From the Start menu naviga
84. tation QoS policy s access_scope field to DDS TOPIC PRESENTATION QOS and b the Partition QoS policy s name field to rti name is a sequence of strings which requires using the element tag also described in this table You may include the following unit designations kB 10 3 MB 10 6 GB 10 9 KB 2 10 FileSize 64 bit integer TB 10 12 KiB 2 10 MiB 2 20 GiB 2 30 TiB 2 40 For example 100 kB is a legal value meaning 100 000 String UTF 8 character string All leading and trailing spaces are ignored between two tags General Properties for the Record Tool 3 3 General Properties for the Record Tool Table 3 2 describes optional properties that control the Record tool s main module Table 3 2 General Properties Property Syntax Description zak PEETS Whether or not the Record tool should start recording data when it is RENTUR started This option is mostly useful if the Record tool is usually controlled auto start DDS Boolean remotely szauto start Default True The verbosity is a bit map that specifies what type of logging information should be printed The verbosity may be 0 silent Core Libraries and the Record tool n o dd errors Core Libraries and the Record tool default verbosity DDs Long lt verbosity gt warnings the Record tool only warnings Core Libraries and the Record tool inf
85. te to RTI Recording Service version and select Recording Console 2 Set a Domain ID as described in Section 2 2 2 1 ojoq BulApjdey Zz Using Recording Console igure 2 1 Console at Startup Recording File Management Display area Configure View Topics Schedule Controls Start here to set a see Table 2 1 Domain ID Table 2 Console s Controls View Information Single Step Record Stop Pause Press Play Pause first Fast Forward 2 2 Configuring Recording Console Before you can use Recording Console to record or replay data you must specify a domain ID in the Configuration panels To record data specify the domain in which the data you want to record is being published I To replay data specify the domain that you want to publish the previously recorded data into 2 2 Configuring Recording Console Click here to open the Configuration Panels By default Recording Console records and replays data using the default DomainPartici pant QoS settings described in the Connext documentation If your Connext applications use default DomainParticipant QoS settings including transport settings you can record and replay data out of the box with no QoS changes However if your system uses any DomainParticipant QoS settings that would be incom patible with the default settings you need to write a configuration file that can be loaded by
86. te topic dds participant RTI RECO RTI REMOTECTX MSG TYPE amp RDER STATUS TOPIC Cqos NULL DDS STATUS MASK NONE E rqos reliability kind DDS RELIABLE RELIABILITY QOS rqos history kind DDS KEEP ALL HISTORY QOS dds reader RTIRemoteCtxMsgDataReader DDS Subscriber create datareader dds subscriber DDS Topic as topicdescription dds topic status NONE DDS STATUS MASK NONI amp rqos Lj wqos reliability kind DDS RELIABLE RELIABILITY QOS wqos history kind DDS KEEP ALL HISTORY QOS dds writer RTIRemoteCtxMsgDataWriter DDS Publisher create datawriter dds publisher dds topic cmd amp wqos a NULL DDS STATUS MASK NONI E 10 3 5922 V ejouJey OL Accessing the Record Tool from a Remote Location 10 3 Figure 10 3 Remote Control Messages The Record tool exchanges messages with your remote access application by publishing and subscribing to two special remote access topics Both topics use the same message format shown in Figure 10 3 Top Level Structure for Remote Control Messages struct RTIRemoteCtxMsg long destination_mask RTIRemoteCtxAddress destination long msg_id RTIRemoteCtxMsgUnion msg 3 For complete details see the IDL file rtirecord idl in the examples directory destination mask A field used by other RTI tools can be ignored destination The Record tool application for which the me
87. ublisher qos DDS QosPolicy publisher qos publisher qos Configures the Publisher s QoS policies See the RTT Core Libraries and Utilities User s Manual s chapter on Configuring QoS with XML Defaults See the RTI Core Libraries and Utilities online HTML documentation on Publishers thread Thread Properties thread thread Configures the properties for the execution thread time control Time Control Properties time control time control Configures the time control properties to be applied to the Session replay topic Replay Topic Properties replay topic replay topic Required The configuration properties that describes the topics to be replayed and the associ ated DataWriter configuration This element can be repeated See Table 5 5 Replay Topic Properties Ap dey 6BuunByuod S Configuring the Replay Tool 5 6 Replay Topic Properties Table 5 5 describes the Topics properties All lt replay_topic gt properties are optional except input These properties must be specified within replay topic namez String and replay topic tags where String is the name to be assigned to the replay topic entity when it is created This name will be used during remote administration All input properties Table 5 6 are required except for type name which is optional All output properties Table 5 7 are optional Table 5 5 Replay Topic
88. ve to the earliest timestamp of the topic ie the index time of the topic will be added to the start time and stop time values if specified 5 8 Remote Administration Properties The Replay tool can be controlled remotely by either the rtireplaysh utility or by a Con next application that reads and writes the remote administration topic For security reasons Remote Administration is turned off in the Replay tool by default The Remote Administration section of the configuration file is used to enable Remote Administration and configure its behavior This section is not required in the configura tion file The rtireplaysh utility or a remote application can send commands to the Replay tool to LI Start stop pause resume step the Replay tool or any of its individual entities L Change the speed of replay of the Replay tool or any of its individual entities I Query the status of the Replay tool or any of its individual entities 5 12 Remote Administration Properties 1 Reposition the Replay tool or any of its entities to any point in the replay range specified for playback Using the Replay Shell Section 6 4 describes the command format and individual com mands available in rtireplaysh Replay s remote administration utility Table 5 11 describes the Remote Administration properties All remote administration properties are optional All Remote Administration properties must be specified inside admin
89. xample Configuration Files 9 3 9 4 9 4 How To Record Data to Multiple Files Scenario The Record tool is recording data on a system that supports files up to 4 GB in size How ever you want to record more than 4 GB of data Configuration File lt dds gt recorder name scenario3 gt lt record_database gt lt database_name gt mydomaindata lt database_name gt lt max_file_size gt 2000 kB lt max_file_size gt lt max_file_segments gt 1000 lt max_file_segments gt lt rollover gt yes lt rollover gt lt record_database gt lt recorder gt lt dds gt Expected Outcome Up to 1 000 files will be created if necessary named mydomaindata_0_0 mydomaindata_0_1 etc up to mydomaindata_0_999 How To Record Serialized Data Scenario Due to space limitations and speed you want to store serialized data Configuration File lt dds gt recorder name scenario4 domain name mydomain gt domain id 98 domain id deserialize mode RTIDDS DESERIALZEMODE NEVER deserialize mode lt domain gt How To Record Using Best Effort Reliability lt recorder gt lt dds gt Expected Outcome All samples will be stored in a single column along with SampleInfo and other meta data 9 5 How To Record Using Best Effort Reliability Scenario You have a system with multiple DataWriters of the same topic Some of these use best effort r
90. y database Database Input File Properties Section 5 4 session Session Properties Section 5 5 replay topic Replay Topic Properties Section 5 6 time control Time Control Properties Section 5 7 administration Remote Administration Properties Section 5 8 type config Type Configuration Section 5 9 The XML configuration file used by Replay has a simple hierarchical format The replay service is configured to replay data contained in one or more replay database Each replay database is associated with a DomainParticipant and must contain one or more session Each session is associated with a Publisher and corresponds to a unique execution thread Each session contains one or more replay topic each of which is asso ciated with a DataWriter and contains a filter expression that specifies what information contained in the data base should be replayed Each of the four major levels replay service replay database session and replay topic may contain a General Format time_control element that allows control over such features as the rate of replay how much of the available data to be replayed and for coordination Much of Replay s configuration has been designed to be compatible with the Record tool so familiarity with the Record tool s concepts and configuration will be helpful See Chapter 3 Configuring the Record Tool Let s look at a very basic configuration just to get an idea of it

User`s Manual - Community RTI Connext Users

Contents

Download Pdf Manuals

Related Search

Related Contents