RTI Spreadsheet Add-in for Microsoft
Contents
1. Host IP Creation timestamp Deletion timestamp Participant name Prod uct version RTPS version e Advanced includes all basic information plus e Publications builtin topic reliability durability partition ownership ownership strength liveliness liveliness lease duration deadline 2 19 soisbg oul Buluipe z Chapter 2 2 20 e Subscriptions builtin topic reliability durability partition ownership liveliness liveliness lease dura tion deadline contentfilter Participants builtin topic RTPS vendor id User data Property QoS DDS Builtin endpoints Default unicast locators e Full includes all advanced information plus Location e Publications builtin topic durability_service latency budget lifespan destination order presenta tion user data topic data group data property gos unicast locators product version rtps protocol version rtps vendor id disable positive acks Subscriptions builtin topic time based filter latency budget destination order presentation user data topic data group data property gos unicast locators multicast_locators product_version rtps_protocol_version rtps_vendor_id disable_positive_acks Participants builtin topic same information as advanced Refer to the online RTI Data Distribution Service documentation regarding builtin topic data type for details of the meaning of these fields Choose where the instances will be popul2. 3 3 UOIDINBHUOD E Chapter 3 Each of the configuration methods is intended to be used in a different way as described in Table 3 2 Table 3 3 on page 3 5 summarizes how to define each parameter using the three meth ods Figure 3 2 on page 3 8 shows an auto generated configuration sheet Table 32 Configuration Methods Method Typical Use Configuration file Default configuration Applies every time Excel is started unless you open a workbook with configuration cells In that case the parameters present on the sheet will override those in the configuration file Use the configuration file method for blank workbooks for testing or for saved workbooks that do not require a specific configuration See the sample file in Figure 3 1 Once Excel is started changes in the configuration file have no effect If you want the changes in the configuration file to take effect close Excel and restart it Cells in a configuration worksheet Configuration for a saved workbook This method allows you to deploy a workbook as if it was an application and to save the configuration you need for the application to work prop erly To create a configuration worksheet based on the current configuration select the Cre ate Configuration Sheet button in the RTI Config dialog See Figure 3 2 on page 3 8 If an RTI Data Distribution Service based application has not been started values specified in the configuration wor
3. iso lated from other domains This value must match the domain ID of the application that you want to communicate with This is an integer value 0 or higher The default is 0 Each Excel instance can only belong to one domain If you want to use multiple domains refer to Section 3 3 Peer Hosts Peer descriptors of potential participants that you want the add in to try to communi cate with For example shmem udpv4 239 255 0 1 udpv4 127 0 0 1 5 udpv4 fo00 See the RTI Data Distribution Service online documentation or User s Manual for details on formatting peer descriptors 3 1 UOIDINBHUOD E Chapter 3 Table 3 1 Configuration Parameters Parameter Description QoS library and profile The QoS library and profile that sets the Quality of Service policies for all the DDS enti ties created by the add in A QoS library and profile are written in XML format QoS can be specified per entity kind or even based on topic name The XML file containing the QoS library and profile must exist either in lt My Documents gt RTI Spreadsheet Add in for Microsoft Excel lt version gt EXCEL_QOS_PROFILES xml or in the file that is specified in the NDDS_QOS_PROFILES environment variable unless a non default location is speci fied in the registry setting see Appendix C for details To open the QoS file under My Documents select the RTI Config button in the RTI Spreadsheet Add in toolbar and t
4. This command is only enabled after RTI Data Distribution Service has been started RTI Add Publication L Opens a dialog for creating a publication table to publish samples of a specific topic See Section 2 5 for details This command is only enabled after RTI Data Distribution Service has been started RTI Publish Now l Publishes samples in all publication tables now if necessary By default only changed samples will be published However you can configure the add in so that all samples are published regardless of whether they have been changed or not See Section 2 5 for details This command is only enabled after RTI Data Distribution Service has been started RTI Update Now L Checks subscriptions to see if they need to be refreshed with new data By default all subscriptions will be refreshed periodically and automatically if new data is available However you can use this button to force immediate refresh of new data It is also possible to create special subscriptions that will not be automatically updated and can only be updated manually This button can be used to refresh all special subscriptions that require manual update See Section 2 3 for details By default this button refreshes all subscriptions in all worksheets in the current Excel instance However you can also configure the add in so that this button will only update all the regular automatic update subscriptions in all work sheets plus the manual upda
5. and charts aren t part of a static report they operate on live data that is continually updated in real time You can even republish the results of your analysis as it changes making it instantly available to team members and other applications There are no custom appli cations to deploy administer or be trained on all of this happens within the Microsoft Excel application that you know and use already With RTI Spreadsheet Add in for Microsoft Excel application developers can truly enable data centric design and focus on putting the data on the network leaving the visualiza tion aspect to the data consumers Dashboards can be created at deployment time and customized according to the needs of the data consumer UWIOSIEM L Chapter 1 1 1 By leveraging a well known and widely used technology such as Excel you can build alerts correlate multiple streams of real time data process and analyze high volume event streams to uncover opportunities and threats as they happen not after the fact You can easily validate cleanse and enrich real time data and inject data back into the network since RTI Spreadsheet Add in for Microsoft Excel can work both as a subscriber and a publisher Wizards make it simple to create publications and subscriptions using a point and click interface Key Benefits of RTI Spreadsheet Add in for Microsoft Excel Allows spreadsheets to participate seamlessly as peers on a DDS real time soft
6. timer started See Section 3 2 DDS DDSConfig startup AutoStartDDS lt yes no gt RTIDDS_CONFIG_AUTOSTARTDDS N A no UONDINBHUOD Chapter 3 Table 33 Configuration Parameters Configuration Method Default Parameter File Cells in a Configuration Worksheet Dialog Logging Verbosity lt n gt n 0 4 RTIDDS_CONFIG_VERBOSITY N A 3 Verbosity 0 No messages 3 Like 2 plus information about DDS entities 1 Errors 4 Debugging messages 2 Errors and warnings Over fossiel write log 5 EE DEL RTIDDS_CONFIG_LOGFILE N A yes file verwriteLogfile lt yes no lt My Docu ments gt RTI Spreadsheet Add in for Microsoft Excel Logging lt ver Log file LogFile lt full path of log RTIDDS_CONFIG_OVERWRITELOG N A sion gt RTIEx file gt celAddin log unless speci fied in a regis try setting See Appendix C for details ContentFilteredTopics Type lt i gt lt type name gt RTIDDS_CONTENTFILTER_TYPE lt i gt Content Topic lt i gt lt topic name gt RTIDDS_CONTENTFILTER_TOPIC lt i gt N A None filters Filter lt i gt RTIDDS_CONTENTFILTER_FILTER lt i gt lt filter expression gt lt i gt starts at 1 and goes up incrementally a The Default column shows the default value that is used if it is not specified by any of the three configuration meth ods b To make changes in the configuration file use this format Cat
7. ware bus along with applications written in C C Java NET and Ada Com plex Event Processing CEP engines databases and mobile and embedded devices l Supports data injection write back l Provides low latency real time analytics and data visualization H Allows introspection status and health monitoring of RTI Data Distribution Ser vice applications l Self contained within an Excel Add in requires no separate service or gateway or custom integration code Available Documentation RTI Spreadsheet Add in for Microsoft Excel documentation includes L Getting Started Guide RTI_Spreadsheet_Addin_GettingStarted pdf High lights the benefits of RTI Spreadsheet Add in for Microsoft Excel and provides installa tion instructions It also walks you through a short demonstration and a tutorial so you can quickly see the benefits of using RTI Spreadsheet Add in for Microsoft Excel L Release Notes RTI_Spreadsheet_Addin_ReleaseNotes pdf Describes system requirements and compatibility as well as any version specific changes and known issues l Users Manual RTI_Spreadsheet_Addin_UsersManual pdf Describes how to configure RTI Spreadsheet Add in for Microsoft Excel and provides details on each feature Chapter 2 Learning the Basics If RTI Spreadsheet Add in for Microsoft Excel has been set up correctly for the current user it will load automatically when Excel starts up and you will see a brief message about the
8. add in will access these files in the user s profile under My Docu ments RTI Spreadsheet Add in for Microsoft Excel lt version gt However it is possible to change the default location of these files by changing the reg istry settings This can be useful if you want to make sure everyone uses the same con figuration Table C 1 summarizes the default filename in the user s profile and the corresponding registry setting that can be used to change the default location Table C 1 Default Filenames and Registry Settings Default filename under String value under Registry key File My Documents RTI Spreadsheet Add in Software RTI ExcelPlugin for Microsoft Excel lt version gt to overwrite default file location Configuration aaa file RTIExcelAddin ini IniFile a Profiles X CEL_QOS_PROFILES xml QosProfiles Log file RTIExcelAddin log LogFile sbuas Aysibey gt a The registry key contains string values that contain the full path of each file including file name The registry keys C 2 can be specified either in HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER the former has higher prece dence If the registry key for the QoS Profile file is not specified other than just reading the QoS profiles and libraries in the file under the user s profile default location we also look for the file specified in the NDDS_QOS_PROFILES envi ronment variable If the registry key for the QoS profile is specified on
9. ed 4 2 4 3 Using VBAPUNCHORSE fetes ese ee Ge ee vee e AB ee eek Aone Belen gele de dee Deens de 4 3 A Subscribing to Data with the Real Time Data RTD Function B DDS Entity Creation and Destruction C Controlling File Locations with Registry Settings Chapter 1 Welcome to RTI Spreadsheet Add in for Microsoft Excel Welcome to RTI Spreadsheet Add in for Microsoft Excel This revolutionary component of RTI Data Distribution Service allows you to rapidly analyze visualize and respond to your real time data transforming information into intelligent action and ultimately business value This powerful tool leverages ubiquitous Microsoft Excel technology to radically increase the productivity of both analysts and decision makers by decreasing the amount of time and effort that stand between the arrival of information and the actions taken in response to that information Traditionally data analysis involves recording the data post processing it perhaps with hand coded programs and creating static summaries and reports by hand Only then can the data be visualized understood and acted upon Not only is this process slow and expensive the information may be obsolete by the time the report is ready To get real time data visualization and analysis you have to invest in expensive custom tool ing often an impractical option at the user or the operator level RTI Spreadsheet Add in for Microsoft Excel is different Your queries formulas
10. file yes no 16 17 Type Topic Filter expression 18 Content filter 1 NN EN N 19 Content filter 2 NN EEN e 20 Content filter sa NN NN N a SA III 3 2 Changing the Data Refresh Frequency Throttle Interval and Auto publish Rate 3 2 1 Update Frequency for Subscribing Cells In general a DDS subscription that is created behind the scenes will continuously receive all samples from RTI Data Distribution Service However the refresh frequency of the subscribing cell in the spreadsheet is limited by the throttle interval If the data is received at a higher faster rate than is defined by this interval some of the received samples may not be displayed or may be displayed at a later time The throttle interval value must be greater than or equals to the RTDThrottleInterval value set in the registry see Section 2 3 in the Getting Started Guide Otherwise the add in will automatically set the Throttle Interval equal to RTDThrottleInterval 3 8 3 2 Changing the Data Refresh Frequency Throttle Interval and Auto publish Rate 3 2 2 The amount of time between updating subscribing cell values is max Excel s RTDThrottleInterval RTI Spreadsheet Add in s throttle interval time since data was last received Tip If you have a high rate of incoming data and a large number of subscription cells you may need a higher interval a lower refresh rate to prevent Excel from slowing down excessively To d
11. messages received in the topic Note the count of messages could be individual samples or batches By default none of the special fields are selected Each selected field will appear in a column in the worksheet If your data type has more than 256 fields you will not be able to select all of them This limit is imposed by Excel which has a maximum table size of 65 536 rows by 256 col umns The starting location of the table may also limit how many fields you can select see the Location section below Optional Display Filters This is only a display filter all the samples for the topic are still received but only the filtered instances are displayed If you want to receive fewer samples per topic based on a filter you will need to use the DDS content filtered topic instead see Chapter 3 for details on content filtered topics Filter expressions are defined by Microsoft NET Framework regular expressions and can be specified for each key field of the Topic s data type See Filter Expres sion Details Section 2 3 1 To match all values for a key field leave the filter blank default behavior or specify this is the regular expression string for wildcard matching You can also modify the filter after the table has been created by selecting the cell in the table header that contains the filter expression such as cell A2 in the exam ple on page 2 8 For filtering to occur properly the filtered key field must be
12. on the level of detail selected increase over time gsnew Deleted entities ed appear in red To remove a builtin topic monitor table Delete the worksheet or the whole builtin topic monitor table If you want to keep the existing cells for information on entities that are already discovered but not receive any new entities discovery information delete the header cell this will stop the table from being updated If you see a red row This means we have detected that the entity has been deleted by the remote application or the discovery information for that entity has not be updated according to the contract and therefore the entity is no longer consider to be alive 2 21 SOISDg oul Buluipe z Chapter 2 2 22 Chapter 3 Configuring RTI Spreadsheet Add in This chapter describes LI Configuration Parameters Section 3 1 I Changing the Data Refresh Frequency Throttle Interval and Auto publish Rate Section 3 2 m Using Different Domains at the Same Time Section 3 3 3 1 Configuration Parameters RTI Spreadsheet Add in for Microsoft Excel has several configuration parameters as described in Table 3 1 They apply to all open workbooks that use the add in Table 3 1 Configuration Parameters Parameter Description Domain ID Identifies the DDS domain to which the instance of RTI Spreadsheet Add in for Microsoft Excel belongs Each DDS domain represents a separate data communication plane
13. one time actions These buttons do not open an associated dialog box This chapter describes how to use macro functions written in Visual Basic for Applica tions VBA to perform the same actions as these buttons YZ RTI Publish Now Y RTI Update Now b Start RTI Service ia Stop RTI Service Enabling Visual Basic Support A sample Visual Basic script is shipped with the RTI Add in installation You can find it in this file lt installation directory gt RTI Spreadsheet Add in for Microsoft Excel lt version gt lib DDS2ExcelModule bas To use the provided VBA functions in Excel 1 Open Visual Basic Editor If you are using Excel 2003 Select Tools Macro Visual Basic Editor from the menu to bring up the Visual Basic Editor 4 1 suolpolddy 10 DISD JONSIA 7 Chapter 4 4 2 Table 4 1 4 2 If you are using Excel 2007 Under the Developer tab in Excel click Visual Basic If you don t see the Developer tab right click on the Quick Access Toolbar in Excel to open the customize window select Popular on the left then select the Show Developer tab in the Ribbon checkbox and click OK 2 Select Tools References in the Visual Basic menu to open the VBA Project Ref erences dialog Make sure the checkbox for DDS2Excel is selected Click OK 3 In the Project window in Visual Basic on the top left right click VBAProject and select Import File from the pop up menu to import the sample Visual Basic scrip
14. selected for display See the Fields section above for how to select a field for display 2 3 Monitoring Topics Location Choose where the instances will be populated in the currently selected cell or a new worksheet By default the new worksheet option is selected Keep in mind that each time a new instance is received a new row or rows will be added at the bottom of the topic monitor table Therefore the height of the table may grow over time Like all tables created by the add in no new rows or columns are inserted into the worksheet Instead the content of the existing cells are overwritten with the top left corner of the table be at the current cell if the Current cell option is selected Excel s maximum table size noted in the Location section above may restrict where you can start the topic monitor table For instance you cannot select a cell in the 255th column and put a table wider than 1 column there Max History Depth J The indicates the number of historical values to be displayed for each instance It cannot be larger than the depth field in the DataReader s History QoS as speci fied in the current QoS profile see Chapter 3 for how to select a QoS profile Default value of Max history depth is 1 Two QoS profiles are provided with RTI Spreadsheet Add in for Microsoft Excel DefaultProfile with depth 4 and NoHistoryProfile with depth 1 By default DefaultProfile is used and there
15. the first sample is published There is only one Publisher per DomainParticipant B 1 UONSNIISEd puo UONDE1D 4u3 g This Entity Is Created Is Destroyed J If there is no active topic monitor for Topic T when the last RTD function for Topic T is When any of these occur deleted LIA topic monitor for Topic T is created H If there is no RTD function for Topic T GE EE er wad when the last topic monitor for Topic T is DataReader p in sa opic is entered deleted for Topic T J RTI Data Distribution Service starts and I When the DomainParticipant is deleted there are one OLOTE topic monitors sub which can happen either when RTI Data scriptions or RTD functions for Topic T Distribution Service is stopped or when Excel There is at most one DataReader per Topic is closed Note Each cell created by a topic monitor or subscription is an RTD function st before a sample of Topic T is first DataWriter ee ea P P When the Publisher and DomainParticipant for Topic T are deleted There is at most one DataWriter per Topic Appendix C Controlling File Locations with Registry Settings When RTI Spreadsheet Add in for Microsoft Excel is first loaded as Excel starts up there are three files that the add in will be accessing LJ The add in configuration file I The file s containing QoS libraries and profiles L The log file for recording add in specific information By default the
16. 000 force gar arbage Config bage collection 8 RTIDDS CONFIG FORCED GC RATE N A after every collect ForcedGCRate lt n gt 1000 refresh of rate data Manual update Config RTIDDS_CONFIG_MANUAL_UPDATE OP RTI Data Dis no manual applies to ManualUpdateCurrentSheet CURRENT SHEET tribution Service update applies current lt yes no gt 7 z before changing to all sheets sheet only Publish Config Stop RTI Data Dis no publish changed 6 i RTDDS_CONFIG_ALWAYSPUBLISH tribution Service changed data AlwaysPublish lt yes no gt data only before changing only Stop RTI Data Dis Domai DDS Config RTIDDS_CONFIG_DOMAINID tribution Service 0 ID DomainId lt n gt before changing DDSConfig Stop RTI Data Dis None uses Peer hosts PeerHost RTIDDS_CONFIG_PEERHOSTS tribution Service default DDS lt peerl gt lt peer2 gt before changing QoS Stop RTI Data Dis None uses od oe TN RTIDDS CONFIG OOSLIBRARY tribution Service default DDS ry s y j before changing QoS 4 Stop RTI Data Dis None uses QoS DDSConfig RTIDDS_CONFIG_QOSPROFILE tribution Service default DDS Profile QosProfile lt name gt before changing QoS Throttle DDSConfig RTIDDS_CONFIG_ de iai interval ThrottleInterval lt ms gt THROTTLEINTERVAL er Section 3 2 Can be changed Auto DDSConfig RTIDDS_CONFIG_ pears eae publish a ieee publish timer has 0 Off A AutoPublishTimer lt ms gt AUTOPUBLISHTIMER
17. RIT Spreadsheet Add in for Microsoft Excel for RTI Data Distribution Service User s Manual Version 1 1 RTD 2010 Real Time Innovations Inc All rights reserved Printed in U S A First printing RTI i Trademarks Real Time Innovations and RTI are 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 Technical Support Real Time Innovations Inc 385 Moffett Park Drive Sunnyvale CA 94089 Phone 408 990 7444 Email support rti com Website http www rti com support Contents 1 Welcome to RTI Spreadsheet Add in for Microsoft Excel 1 1 Available DocumentaHON sesse see ee ee ee ee Re ee ee Re ee ee ee ee ee Re ee ee ee ee ee ee Re ee Ge 1 2 2 Learning the Basics 2 1 The RTT Spreadsheet Add in Toolbaf is esse sersut reiesit ge ve se RE gee oe Gee ee se EED 2 1 2 2 Starting RTI Data Distribution Service esse cece gee ee He He ee He He He ee Ee eke He gegee 2 3 2 3 M
18. To support these needs RTI Data Distribution Service provides built in Topics that you can use to access this discovery information 2 6 Monitoring Built in Topics You can use a built in topic monitor to display built in topics for dis covered publications subscriptions and par ticipants Note Only remote entities appear in builtin topics Entities created by the same DDS participant in this case the RTI Spreadsheet Add in for application will not appear in the builtin topic From the RII Spread Microsoft Excel F Create a domain monitor Publications Lv Publications Subscriptions p Level of detail Participants Location Builtin topic Basic Current cell Advanced New worksheet 5 Full a Create builtin monitor Cancel sheet Add in toolbar select e RTI Monitor Domain then select one of the builtin topics publications subscriptions or participants from the drop down list box Builtin topic H DDS support three builtin topics that provide discovery information of different entity kinds Publications Subscriptions and Participants Level of detail The level of detail basic advanced or full controls how much data how many columns will be shown in the builtin topic monitor table e Basic e Publications Subscriptions builtin topic Host IP Creation timestamp Deletion timestamp Entity kind Topic Type e Participants builtin topic
19. add in being initialized in the status bar at the bottom of the Excel window If you don t see that message or if there is an error refer to Chapter 2 in the Getting Started Guide for details on how to set it up 2 1 The RTI Spreadsheet Add in Toolbar The RTI Spreadsheet Add in toolbar is your starting point for all of the add in s func tionality To see the RTI Spreadsheet Add In toolbar in Excel 2007 select the Add Ins tab on the Ribbon Or if you are using Excel 2003 right click any Excel toolbar and choose RTI Spreadsheet Add in for Microsoft Excel OS a a a gt Home Insert Page Layout Formulas Data Review View Add Ins Q RTI Config amp RTI Add Publication ga RTI Monitor Domain 3 RTI Monitor Topic RTI Publish Now b Start RTI Service amp d RTI Add Subscription DQ RTI Update Now Off Toolbar Commands The commands in the toolbar are summarized below RTI Config L Opens a dialog for setting configuration parameters See Chapter 3 for details RTI Monitor Topic l Opens a dialog for creating a subscription table to monitor all instances or a sub set of the instances of a specific topic See Section 2 3 for details 2 1 soisbg oul Buluipe z Chapter 2 2 2 This command is only enabled after RTI Data Distribution Service has been started RTI Add Subscription I Opens a dialog for creating a subscription row to monitor one single instance of a specific topic See Section 2 4 for details
20. an add in configuration parameter so that clicking on the RTI Update Now button will update all automatic update subscriptions in all work sheets plus the manual update subscriptions in the current worksheet only See Chapter 3 for details When you click Create topic monitor the add in creates a topic monitor table either in the currently selected cell or in a new worksheet depending on your Location option For example Cell A2 is a Filter M indicates a manual update subscription s amp SUBSCRIPTION M Topic Square Type ShapeType Three rows of table header gt 2 color x y shapesize Number of rows in table number of instances received 141 160 max history depth Samples 125 141 30 for the same instance will be grouped together with the MA SSS latest sample for that instance shown first The number of rows may increase over time as new instances are received Each selected field in the data type appears in its own column Darker colored column headers indicate key fields Deleted instances appear in red When is the table refreshed I If the topic monitor table is created without the Manual update option data in the topic monitor table is refreshed periodically if new samples are received and the periodic check interval is limited by the throttle interval settings See Chapter 3 for details If the topic monitor is created with the Manual update option data in the topic monito
21. at the RTD function is case sensitive for example color PURPLE is differ ent than color Purple Do not use quotation marks within the expression The optional MANUAL parameter in the RTD function can be used to indicate that the cell will be updated manually only when the RTI Update Now button is pressed instead of periodically being refreshed with new data The lt sheet_name gt followed by the optional MANUAL parameter in the RTD function is filled in automatically with the name of the worksheet in which the cell resides either when RTI Data Distribution Ser vice is first started or when the RTD function is created by the subscription The sheet name information is used if the RTI Update Now button is configured to refresh man ual update subscriptions in the current sheet only If you copy a manual update cell from one sheet to another the RTD function will contain the wrong sheet name unless you manually modify the RTD function or you restart RTI Data Distribution Service See Chapter 3 for information on manual update subscriptions You can use references to a cell containing the RTD function just like any other cell for charts other formulas etc B2 vi fe RTD dds2excel connect TYPE ShapeType TOPIC Sguare FIELD KEY color PURPLE a c 1 Value Formula ix 118 RTD dds2excel connect TYPE ShapeType TOPIC Square FIELD x KEY color PURPLE 3 y 188 RTD dds2excel co
22. ated in the currently selected cell or a new worksheet By default the new worksheet option is selected LJ Keep in mind that each time a new entity is discovered a new row will be added at the bottom of the builtin topic monitor table Therefore the height of the table may grow over time Like all tables created by the add in no new rows or columns are inserted into the worksheet Instead the content of the existing cells are overwritten with the top left corner of the table at the current cell if the Current cell option is selected 2 6 Monitoring Built in Topics L Excel limits the table size to 65 536 rows by 256 columns This limit may restrict where you can start the builtin topic monitor table For instance you cannot select a cell in the 255th column and put a builtin topic monitor table there to show Full details When you click g Create builtin monitor the add in creates a builtin topic monitor table either in the currently selected cell or in a new worksheet depending on your Location option For example A B G D E F Two rows of 1 SUBSCRIPTION Topic PUBLICATION Type BUILTIN table header 2 Type One row for 3 192 168 2 3 9 10 2009 9 33 16 95 AM writer with key Square ShapeType each entity 4 192 168 2 3 9 10 2009 9 33 26 73 AM writer with key Circle ShapeType Em SO 5 192 168 2 3 9 10 2009 9 34 12 92 AM 9 10 2009 10 53 30 27 AM writer with key Square ShapeType Ley Number of columns depends
23. conditions are true gt 20080101 AND lt 20090101 OR 20100315 Matches any values where the first and second expres sions both evaluate to true or the third expression evalu ates to true Note the grouping of expressions 2 4 Subscribing to Data 2 4 L Without a filter expression for any key field the topic monitor table subscribes to all data for the Topic This is equivalent to a wildcard expression that matches everything l Spaces and commas are not allowed in the regular expression after the compara tors If you want to include a space in your regular expression after the or comparators use W to match any single non word character For example the following matches any value that has good match in the field requiring a space between the words good and match good wmatch I Whitespace is required around the logical operators AND OR XOR Any whitespace around the comparators or logical operators will not be treated as part of the expression The expression ends when whitespace is encountered see the examples in Table 2 3 Filters are always evaluated from left to right Parentheses are not supported L Docs for the Regular expression class can be found at the following Microsoft web site http msdn microsoft com en us library hs600312 aspx For additional information about regular expressions the following web site may be useful http www regular expre
24. d for the instance and the periodic check interval is limited by the throttle interval settings See Chapter 3 for details H If the subscription is created with the Manual Update option selected data in the subscription is only refreshed when you click the RTI Update Now button in the RTI Spreadsheet Add in toolbar if you have configured the RTI Update Now 2 5 Publishing Data 2 5 2 5 1 button to only update manual update subscriptions in current worksheet then the subscription will be refreshed only if it is in the current worksheet when the button is pressed See the Manual Update section above To delete a subscription Each cell of the subscription can be deleted individually If you want to know when the actual DDS reader that subscribes to the instance of the topic is created deleted behind the scenes see Appendix B Publishing Data The previous two sections describe how to subscribe to data this section describes how to publish data from an Excel worksheet There are three steps 1 Creating a Publication Table Section 2 5 1 2 Filling in the Data to be Published Section 2 5 2 3 Publishing the Data Section 2 5 3 Creating a Publication Table To begin select a cell or a range of cells in the worksheet where you want the publica tion to be Then from the RTI Spreadsheet Add in toolbar select n RTI Add Publication Click a topic from the list on the left then select the fields that you wan
25. dcards and regular expressions are not permitted History position The history position of a subscription is the age of the sample you want to get from the reader queue History position 0 will give you the most recent sample 1 will give you the next most recent one up to N history depth 1 for the oldest one The default value for history position is 0 The history position value is limited by the depth field in the DataReader s His tory QoS as specified in the current QoS profile see Chapter 3 on how to select a QoS profile e Two QoS profiles are provided with RTI Spreadsheet Add in for Microsoft Excel DefaultProfile with depth 4 and NoHistoryProfile with depth 1 By default DefaultProfile is used and therefore History position is limited to a value of 3 Manual Update E By default this checkbox is not checked and the subscription is automatically refreshed on a periodic basis if new data is available See Chapter 3 for how to control the periodic refresh rate Check the Manual update checkbox if you want to manually update the sub scription in a controlled manner instead A manual update subscription is only updated when you click the RTI Update Now button in the RTI Spreadsheet 2 13 soisbg oul Buluipe z Chapter 2 2 14 Add in toolbar The cells in a manual update subscription will contain an RTD function with the MANUAL lt sheetname gt parameter See Appendix A for details on t
26. egory Parameter value c These cell names appear in the worksheet automatically when you click Create Configuration Sheet from the RTI Config dialog d The default value of the QoS library in the shipped configuration file is DefaultLibrary e The default value of the QoS profile in the shipped configuration file is DefaultProfile 3 6 3 1 Configuration Parameters Figure 3 1 Sample configuration file Config ForcedGCRate 1000 ManualUpdateCurrentSheet no AlwaysPublish no DDSConfig DomainId 54 PeerHost shmem udpv4 239 255 0 1 udpv4 127 0 0 1 5 udpv4 fo0o QosLibrary MyQosLib QosProfile MyQosProfile ThrottleInterval 100 AutoPublishTimer 0 AutoStartDDS no Logging Verbosity 3 OverwriteLogfile yes LogFile c RTIExcelAddin log ContentFilteredTopics Typel ShapeType Topicl Square Filterl x gt 100 Type2 ShapeType Topic2 Circle Filter2 y lt 100 3 7 UOIDINBHUOD E Chapter 3 Figure 3 2 Generated Configuration Worksheet A B cC D 1 RTI Spreadsheet Add in for Microsoft Excel 1 0 5 CONFIGURATION 2 3 domain 1 oo 4 ef ExcelQosLib 5 EE DefauttProfile i List of comma separated discovery peers 7 7 Throttle interval ms 1 00 8 Auto publish timer ms 0 off en 9 Auto start DDS yes no 10 Forced GC Rate 11 Verbosity 0 1 2 3 4 s Mlanual Update Current Sheet Only yes no 13 Publish all even if no changes yes no 14 Log file 15 Overwrite log
27. fore Max history depth is limited to a value of 4 Setting a high value for the Max history depth can cause Excel to slow down quite a bit especially if you are displaying a lot of fields from the data type and instances are published at a high rate If you set Max history depth greater than 1 some rows in the Topic Monitor table may show values of DATA N A That means not enough samples have been received yet to fill up all the historical values for that instance Manual Update l By default this checkbox is not checked and the subscription table is refreshed automatically on a periodic basis if new data or new instances are available See Changing the Data Refresh Frequency Throttle Interval and Auto publish Rate Section 3 2 Check the Manual update checkbox if you want to manually update the sub scription table on a controlled manner instead A manually updated subscription table will only be updated when you click the RTI Update Now button A manu 2 7 SOISDg oul Buluipe z Chapter 2 ally updated subscription table will be marked as M in the table header cell A1 in the following screenshot and the cell s RTD function will contain the MAN UAL lt sheetname gt parameter See Appendix A for details on the RTD func tion By default clicking the RTI Update Now button will update all subscriptions in all spreadsheets of the current Excel instance However you can modify the behavior through
28. he RTD function By default clicking the RTI Update Now button will update all subscriptions in all spreadsheets of the current Excel instance However you can modify the behavior through the add in configuration parameter so that clicking on the RTI Update Now button will update all automatic update subscriptions in all work sheets plus the manual update subscriptions in the current worksheet only See Chapter 3 for details When you click amp Create subscription the add in creates a subscription in the work sheet starting in the currently selected cell RTD function Al yO fe RTD dds2excel connect TYPE ShapeType TOPIC Square FIELD x KEY color RED B C D E F G H l 2124 104 30 N EE EEr x y shape size There is a cell for each field selected in the Create Subscription dialog and an RTD func tion for each cell see Appendix A for details on the RTD function Notice that no table header is created and it is always a single row only Notice that the subscription is created by overwriting existing cells in the worksheet no new row is inserted into the worksheet If the cells in the subscription row are showing DATA N A that means no data has been received for the instance that you have subscribed to When is a subscription refreshed If the subscription is created without the Manual Update option selected data in the subscription is periodically checked for update if a new sample is receive
29. heet QoS profile Default Profile rele eS HEI ae Using Different Domains at the Same Time You can work with different configurations and therefore different domain IDs at the same time by using different Excel instances Each Excel instance is a separate process that can manage one or more workbooks Every workbook in the same Excel instance will have the same configuration If you open a workbook from Windows Explorer and there is an Excel instance already running the workbook will be attached to that Excel instance Therefore if you want a workbook to use a different configuration open a new Excel instance run Excel exe again and then open the workbook in the new Excel instance 3 3 Using Different Domains at the Same Time Figure 3 4 shows two Excel instances working in different domains The one on the left has two open workbooks Figure 3 4 Multiple Instances in Different Domains QB RT Contig RTI Add Publication Running on domain 54 fi RTI Monitor Topic FT Publish Now i RTI Monitor Topic 2 RTI Publish Now oo RTI Add Subscription e FETA SA AE hon BRT Monitor Domain 1 SUBSCRIPTION Topic Square Type ShapeType square Type ShapeType 3 1 Chapter 3 3 12 Chapter 4 Visual Basic for Applications VBA 4 1 Functions for RTI Spreadsheet Add in Some of the buttons in the RTI Spreadsheet Add in toolbar perform
30. hen click Open QoS File The XML file is read only when Excel starts If you have made changes to the file after Excel has started you will need to close and restart Excel for the changes to take effect See the RTI Data Distribution Service LIser s Manual for details regarding QoS library and profile formats Throttle interval How long to wait before refreshing the received real time data for all automatic update subscriptions This is both a the minimum time between cell updates and b the maxi mum time after data is first received before the cell is updated This value must be greater than or equals to the RTDThrottleInterval value as set in the registry See Section 2 3 in the Getting Started Guide for details Auto publish timer How often to automatically publish data from a publication This value must be greater than or equals to the RTDThrottleInterval value as set in the registry See Section 2 3 in the Getting Started Guide for details The auto publish timer is stopped automatically every time RTI Data Distribution Service is stopped If you restart RTI Data Distribution Service you may need to restart the auto publish timer DDS startup policy Behavior at start up whether or not RTI Data Distribution Service should be started if it is not already running when a workbook with a DDS configuration worksheet is loaded Starting RTI Data Distribution Service creates a DomainParticipant starts discovery of type
31. in the domain you selected in the RTI Config dialog Fields L Use the checkboxes under Fields to select which fields in the topic s data type you want to monitor By default no fields in the data type are selected L The Special fields correspond to fields in the DDS Sample Info data structure which provides meta information about data that is received The source_timestamp is the time the sample was sent the reception_timestamp is when it was received You can use these fields to see when a sample was sent 2 12 2 4 Subscribing to Data or received The reception_sequence_number is the counter of messages received in the topic Note the count of messages could be individual samples or batches By default none of the special fields are selected l Each selected field will appear in a column in the worksheet If your data type has more than 256 fields you will not be able to select all of them This limit is imposed by Excel which has a maximum table size of 65 536 rows by 256 col umns Excel s maximum table size noted above may restrict where you can start the subscription For instance you cannot select a cell in the 255th column and put a subscription wider than 1 column there Key values If the topic s data type has a key you must specify value s for the key this is how you specify which instance of the topic you want to subscribe to l Exact values must be entered Strings are case sensitive Wil
32. ksheet are loaded when the configuration worksheet is opened The loaded values will be used for all workbooks in this Excel instance If an RTI Data Distribution Service based application is already started opening the configuration worksheet has no effect Once the configuration worksheet is opened changes in the configuration worksheet have no effect If you want the changes in the configuration worksheet to take effect stop RTI Data Distribution Service close the configuration worksheet and open the configuration worksheet again to reload the values Configuration dialog Use this dialog to change the configuration at run time This configuration is not persistent and not all values can be changed at run time The RTI Config dialog can be used to change some parameters at run time Some parameter changes require that RTI Data Distribution Service is not running while others can be changed any time and will take effect right away Only fields that you are allowed to change depending on whether RTI Data Distribution Ser vice is running or not will be enabled in the dialog If a parameter is not available in the RTI Config dialog it means it cannot be changed at run time See Figure 3 3 on page 3 10 3 1 Configuration Parameters Table 3 3 Configuration Parameters Configuration Method Default Parameter File Cells in a Configuration Worksheet Dialog Forced 1
33. l Basic Functions in the shipped DDS2ExcelModule Function Typical Use PublishNowDDS Checks all DDS publications to see if data needs to be published The behavior of this function depends on whether the add in is configured to publish a sample only if it has changed since the last time it was published or configured to publish the sample regardless of whether it has changed or not See Chapter 3 for details The behavior of this function is the same as the RTI Publish Now button in the RTI Spreadsheet Add in toolbar UpdateCurrentSheet NowDDS Checks all DDS automatic update subscriptions for updates For manual update subscriptions only those in the current worksheet will be checked GroupUpdate NowDDS group As String Checks all DDS automatic update subscriptions for updates For manual update subscriptions only those whose worksheet name matches the one specified by the parameter of this function will be checked If an empty string is specified this function will update all subscriptions in all worksheets Using VBA Functions The add in VBA functions are like any other VBA functions You can call the functions directly in any Excel cell by entering the formula DDS2ExcelModule lt function_name gt in any cell the function is called when the formula is executed You can also call these functions from any other Excel VBA script or create GUI buttons and call the VBA fu
34. lications m the same domain If RII Data Distribution Service is started correctly the domain ID will appear in the lower right corner of the RTI Spreadsheet Add in toolbar The other toolbar commands also become enabled RTI Data Distribution Service is running on domain 0 Home Insert Page Layout Formulas Data Revj View Add Ins RT Contig D RTI Add Publication 2 RTI Monitor Domain G RTI Monitor Topic 2 RTI Publish Now RTI Service S RTI Add Subscription a RTI Update Now Toolbar Commands 2 3 soisbg oul Buluipe z Chapter 2 2 3 2 4 The license file is checked when RTI Data Distribution Service is started You may see a window appear with information about the license file you can close this window If you get a license error instead the add in will not be functional For more information on the license file see Section 2 2 in the Getting Started Guide Note Starting RTI Data Distribution Service creates DDS entities and generates network traffic For information on when these DDS entities are created and destroyed please see Appendix B Once RTI Data Distribution Service is started you re ready to publish or subscribe to data See these sections for details LI Monitoring Topics Section 2 3 HI Subscribing to Data Section 2 4 HI Publishing Data Section 2 5 LJ Monitoring Built in Topics Section 2 6 Monitoring Topics The RTI Topic Monitor feature subscribes to a specific to
35. ly the file specified in the registry key will be read the NDDS_QOS_PROFILES environment variable will have no effect To modify add the registry go to the Windows Start menu and select Accessories Run Type regedit This will open the registry editor where you can add modify a registry key and the string value within a registry key When Excel starts up and RTI Spreadsheet Add in for Microsoft Excel is loaded the add in first looks for the registry keys under HKEY_LOCAL_MACHINE If the registry key for the file is not found it will then look under HKEY_CURRENT_USER If the registry key for the file is still not found the default location under the user s profile is assumed The three files can be specified independently in the registry By default the installer for RTI Spreadsheet Add in for Microsoft Excel does not write any of these values in the registry Therefore the files are loaded from the user s profile by default
36. nction in the button click event 4 3 suolpolddy 10 DISD JONSIA 7 Chapter 4 4 4 Appendix A Subscribing to Data with the Real Time Data RTD Function The most basic and flexible way to subscribe to data for a cell is to use the RTD function in Excel RTD lt ProgID gt lt server gt lt paraml gt lt param2 gt The RTD function is the building block for most of the features in RTI Spreadsheet Add in for Microsoft Excel It is used as follows RTD DDS2Excel Connect TYPE lt type_name gt TOPIC lt topic_name gt FTELD lt field_namel gt KEY lt field_name2 gt lt value2 gt KEY lt field_name3 gt lt value3 gt J MANUAL ssheet name The first parameter is the program ID of RTI Spreadsheet Add in for Microsoft Excel DDS2Excel Connect The second parameter is blank RTD uses this as the name of the server where the add in should be run Since we want to run locally we leave it blank The remaining parameters combine to define a piece of real time data There may be up to 38 of these parameters A 1 GLa uIM DIDA o4 Buiquosqns y A 2 For example RTD DDS2Excel Connect TYPE ShapeType TOPIC Square EIE IDEE KEY color PURPLE The above function will subscribe to instances of the topic Square of type ShapeType whose key field color is PURPLE this cell will show the value of the field x Be aware th
37. nnect TYPE ShapeType TOPIC Square FIELD y KEY color PURPLE 4 xty 306 B3 B2 5 2x 236 2 B2 6 4 200 8 180 9 10 160 11 140 12 120 13 100 i 14 80 E 60 16 40 4 17 18 20 19 Or 20 1 2 21 Appendix B DDS Entity Creation and Destruction The following table explains when RTI Spreadsheet Add in for Microsoft Excel creates and destroys the DDS entities it uses All entities are created with the QoS values as specified in the RTIDDS_CONFIG_QOSLIBRARY and RTIDDS_CONFIG_QOSPROFILE configuration parameters The QoS library and profile are either in My Documents RTI Spreadsheet Add in for Microsoft Excel lt version gt EXCEL_QOS_PROFILES xml or in a file that is specified in the NDDS_QOS_PROFILES environment variable unless the location of the XML file is hard coded in the registry setting See Appendix C for details This Entity Is Created Is Destroyed When the RTI Data Distribution Service based application EE This can happen ea ars When the RTI Data Distribution Service based Domain m ae Nee RE Ki application stops This can happen two ways Participant p L When Excel is closed option is enabled I When you start RTI Data Distribution Ser d When you stop RTI Data Distribution Service vice Subscriber There is only one Subscriber per When the DomainParticipant is created DomainParticipant Publisher When the DomainParticipant is deleted Just before
38. om the table I To manually publish the data one time select Y RTI Publish Now from the RTI Spreadsheet Add in toolbar 2 17 soisbg oul Buluipe z Chapter 2 2 6 2 18 To automatically publish the data at a constant rate set a timer a From the RTI Spreadsheet Add in toolbar select RTI Config b Set the Auto publish timer in milliseconds as desired Note The interval must be greater than or equal to the RTDThrottleInterval value set in the registry see Section 2 3 in the Getting Started Guide Other wise the add in will automatically set the auto publish timer equal to RTDThrottleInterval c Press Start and Close By default a sample is published only if any cell in the row for that sample has changed since the last time it was published However you can change this behavior by chang ing the add in configuration parameter so that filled in samples are published regard less of whether the sample has changed since the last time it was published See Chapter 3 for details Hint If you want to verify that the data was published you can use a topic monitor see Section 2 3 Monitoring Built in Topics RTI Data Distribution Service must discover and keep track of remote entities such as new participants publications or subscriptions in the domain This information may also be important to the application itself which may want to react to this discovery information or else access it on demand
39. on supported within the full NET regular expression syntax The other comparators can only be followed by an actual string or numerical value See the examples in Table 2 3 You can combine filters for the same key field using the logical operators in Table 2 2 2 9 soisbg oul Buluipe z Chapter 2 Table 2 2 Table 2 3 Filter Logical Operators Operator Behavior AND True if and only if both expressions are true OR True if one or both expressions are true XOR True if exactly one of the expressions is true Example Filter Expressions Filter Expression Explanation Matches all IB Example matches IBM IB IBB IBBBBBM IBMCALL20090310 The above list is not the entire universe of matches for the filter expression simply an example subset 1B Matches any value that does not match the previous expression above examples lt 20090101 Based on the field type matches values if the compare is less than 20090101 If the field is a numeric field e g long double the comparison is numeric if the field is a string field the comparison is alphabetic gt 20080101 Based on the field type matches values if the compare is greater than 20080101 If the field is a numeric field e g long double the comparison is numeric if the field is a string field the comparison is alphabetic gt 20080101 AND lt 20090101 Matches any values where both
40. onitoring TOpies RE N EE EE EE EE EE 2 4 2 3 1 Filter Expression Details iese ves se SESSE GESE Ee Se INGE GEGE saara 2 9 24 Subseribing to Data sers see seges ere Sk es ge kurek ver k oe arikan ees sia aiD 2 11 2 2 Publishing Data eeste ee Re ee ge ER ge ee ee ee vd eg keen 2 15 25 1 Creating a Publication Table uses Vee SE Se ER Ede EE SE REEN EE eN Ek Gee BE GEK De Ee eg 2 15 2 5 2 Filling in the Data to be Published esse see ee ee ee Re Ge RR Ee Ge Ge GR RR Re He ee He gee 2 17 2 0 9 Publishing the Data EE EE EE ND 2 17 2 6 Monitoring Built in Topics eee sesse ee ee eek GE ER SR SR GER ER ER ARE Ee ER Se Be GEK ER ER REKE e SR ee Re ek ee GER ee ee ee 2 18 3 Configuring RTI Spreadsheet Add in 3 1 Configuration Parameters Mee eers ee n ee ee Eg Ee bek RE ek Ee ee bee Ee 3 1 3 2 Changing the Data Refresh Frequency Throttle Interval and Auto publish Rate 3 8 32 1 Update Frequency for Subscribing Cells ccs gee Ee gee ee He gegee eg ee Ee 3 8 8 2 2 Auto Publish EreguenEy iese EE ge ge See Ee EE Eve gese ee ees Ben Geek ee Vee 3 9 3 3 Using Different Domains at the Same Time sesse se ek ek eke eek eke ek ee eek ek ek ek ee 3 10 4 Visual Basic for Applications VBA Functions for RTI Spreadsheet Add in 4 1 Enabling Visual Basic Support sescccsssessscscsscasssceesscucosercsssassscvesecasssarssersessatenncvscvanetadsssectsnses 4 1 4 2 oupported VBA FUNCHONS s sr se gese see eo ge n ee eg ee eed kies sn ee dee Ger ae Ee
41. pic You can subscribe to all instances of a topic or a subset of instances by filtering based on key fields Instances are displayed in separate rows in a worksheet When new instances are discovered new rows are automatically added to the worksheet From the RTI Spreadsheet Add in toolbar select Go RTI Monitor Topic then click one of the Available Topics 2 3 Monitoring Topics For example Fields in the selected topic s data type Available topics Optional filters specifying which instances of the topic you want to monitor Available for key fields only Where to start the topic monitor table Controls whether the topic monitor table How many historical values will get updates automatically or manually to display for each instance 2 5 Chapter 2 2 6 Available Topics These are the topics that have been discovered in the domain you selected in the RTI Config dialog L Use the checkboxes under Fields to select which fields in the topic s data type you want to monitor By default all the fields in the data type are selected The Special fields correspond to fields in the DDS Sample Info data structure which provides meta information about data that is received The source_timestamp is the time the sample was sent the reception_timestamp is when it was received You can use these fields to see when a sample was sent or received The reception_sequence_number is the counter of
42. r table is only refreshed if you click the RTI Update Now button in the RTT Spreadsheet Add in toolbar if you have configured the RTI Update Now 2 8 2 3 Monitoring Topics 2 3 1 Table 2 1 button to only update manual update subscriptions in current worksheet then the topic monitor table will be refreshed only if it is in the current worksheet when the button is pressed See the Manual Update section above To remove a topic monitor table Delete the worksheet or the whole topic monitor table If you want to keep the existing cells to keep getting updates for existing instances but not receive any new instances delete the header cell such as cell A1 in the above screen shot If you see a red row This means the instance has been deleted by the publisher or the instance has not be updated according to the contract and therefore is considered not alive refer to the RTI Data Distribution Service User s Manual regarding not alive instances If you want to know when the actual DDS reader that subscribes to the topic is created deleted behind the scenes see Appendix B Filter Expression Details A filter expression must begin with one of the operators in Table 2 1 Filter Comparator Operators Operator Behavior Equals Is Not egual Less than Greater than lt Less than or equal to gt Greater than or equal to The and comparators are followed by an expressi
43. s and topics and starts any defined subscriptions or publications This will generate network traffic For information on when these DDS entities are created and destroyed please see Appendix B Forced garbage collect rate This is an advanced feature Typically memory that is no longer in use will be freed up automatically by the add in when there is a need In some special cases if data is updated at very high rate or if there is still available memory in your system the add in may not free unused memory as fast as you may want it to This parameter allows you to control how fast the unused memory should be freed up 3 1 Configuration Parameters Table 3 1 Configuration Parameters Parameter Description Manual update applies to cur rent sheet only Controls if the RTI Update Now button will update a all manual update subscriptions or b only the manual update subscriptions in the current worksheet All automatic update subscriptions will be updated regardless Controls if both the Auto publish timer and the RTI Publish Now button will publish oe samples only if they have been changed since the last time they were published or will omy publish regardless of whether the sample has changed or not Verbosity Level of logging See Table 3 3 Overwrite log file Specifies if the log file should be overwritten every time Excel starts Log file Full path for the location of
44. ssions info dotnet html I If you provide a filter expression for a key field that key field must be selected for display If the filtered field is not displayed the filter for the key field will not be applied See the Fields section in Monitoring Topics Section 2 3 for how to select a field for display Subscribing to Data Section 2 3 showed you how to subscribe to data for multiple instances of a topic If you only want to subscribe to one specific instance of a topic use the RTI Add Subscription feature The main difference in these two features is that a topic monitor table may grow over time as new instances are discovered A subscription is always a single row and does not grow because it is only subscribing to one specific instance First select a cell in the worksheet where you want the subscription to begin Then from the RTI Spreadsheet Add in toolbar select f RTI Add Subscription soisbg oul Buluipe z Chapter 2 Click one of the Available Topics then select the fields you want to display E Create subscription G z Fields in the mde SEDES P p 7 opic s data Available ee type topics Circle E iF M i E LE Use 0 to see the most recent sample Controls whether the subscription will get updates automatically or manually Desired value for key field Available Topics These are the topics that have been discovered
45. t from lt installation directory gt RTI Spreadsheet Add in for Microsoft Excel lt version gt lib DDS2ExcelModule bas 4 The DDS2ExcelModule should now be added to the VBAProject You can close the Visual Basic Editor The VBA functions in the module imported from RTI Spreadsheet Add in for Microsoft Excel are now ready to be used Supported VBA Functions Table 4 1 summarizes all of the supported VBA functions in the DDS2ExcelModule provided by the add in Supported Visual Basic Functions in the shipped DDS2ExcelModule Function Typical Use Starts RTI Data Distribution Service just like the behavior of the Start RTI StartDDS Service button in the RTI Spreadsheet Add in toolbar See Section 2 1 for details Stops RTI Data Distribution Service just like the behavior of the Stop RTI StopDDS Service button in the RTI Spreadsheet Add in toolbar See Section 2 1 for details Checks all DDS automatic update subscriptions to see if they need to be refreshed with new data The behavior of this function on manual update subscriptions depends on whether the add in is configured to update all UpdateNowDDS manual update subscriptions or configured to update only the manual subscriptions in the current worksheet See Chapter 3 for details The behavior of this function is the same as the RTI Update Now button in the RTI Spreadsheet Add in toolbar 4 3 Using VBA Functions Table 4 1 4 3 Supported Visua
46. t to fill in Unse lected fields will still be published but will be set to their default values numerical fields will be set to 0 strings will be empty By default all fields in the data type are selected 2 15 soisbg oul Buluipe z Chapter 2 r Create a publication tbe i x Choose topic and fields Available topics Fields V color TK_STRING key Vlx TK_LONG cE Shape Type Circle When you click N Create publication the add in creates a publication table at the selected cell s in the worksheet Kor example 1 PUBLICATION Topic Square Type ShapeType The table contains a three rows of table 2 ORAA S header Each row holds the data for one sample Each selected field in the data type appears in its own column Darker colored column headers indicate key fields The publication table is a range of cells that represent a topic each row will be a sam ple with a column for each field that you want to fill in 2 5 Publishing Data 2 5 2 2 5 3 To Control the Publication Table Size The number of rows in the table depends on what is selected on the worksheet when you first click n Create publication LI If only one cell is selected the default case a table with a height of seven is cre ated allowing you to enter four samples If two or three rows are selected a table with a height of four will be created allowing you to en
47. te subscriptions in the current worksheet only See Section 3 1 for details This command is only enabled after RTI Data Distribution Service has been started 2 2 Starting RTI Data Distribution Service 2 2 RTI Monitor Domain l Opens a dialog for creating a table to monitor one kind of discovered entities See Section 2 6 for details This command is only enabled after RTI Data Distribution Service has been started Start Stop RTI Service LJ Starts stops RTI Data Distribution Service Other than RT Config none of the other commands in the toolbar are enabled until RTI Data Distribution Service has been started See Section 2 2 for details Starting RTI Data Distribution Service The add in is not functional until you start RTI Data Distribution Service Before starting RTI Data Distribution Service make sure you know the domain ID of the application you want to communicate with RTI Spreadsheet Add in for Microsoft Excel must use the same domain ID it uses domain ID 0 by default If you need to use a domain ID other than 0 select RT Config and change the domain ID in that dialog For a com plete description of the RTI Config dialog see Chapter 3 Configuring RTI Spreadsheet Add in Once the add in is set up to use the correct domain ID simply click Start RTI Service from the RTI Spreadsheet Add in toolbar or Start RTI Data Distribution Service in the RTI Config dialog to start discovering other DDS app
48. ter one sample If four or more rows are selected the table height will match the rows that you have selected The number of columns in the table depends on the number of fields you select for the topic If your data type has more than 256 fields you will not be able to select all of them This limit is imposed by Excel which has a maximum table size of 65 536 rows by 256 columns This limit may restrict where you can start the publication For instance you cannot select a cell in the 255th column and put a publication wider than 1 column there The table size is fixed once the publication is created and it will not change over time Like all tables created by the add in no new rows or columns are inserted into the worksheet Instead the content of the existing cells are overwritten with the top left corner of the table at the current cell To remove a publication table Delete the worksheet or the whole table If you want to know when the actual DDS writer that publishes the topic is created deleted behind the scenes see Appendix B Filling in the Data to be Published Once you have the table you can fill in the cells as desired either by explicitly entering values in the cells or by entering valid Excel formulas You can even use references to subscriber cells elsewhere in the Excel workbook If you leave a sample row unfilled that sample will not be published Publishing the Data There are two ways to publish data fr
49. the file for logging information for the add in Content filters Defines filters for given topics based on the content of the sample of the given data type These filters if any apply to any subscription of the specified topic name For example Typel ShapeType Topicl Square Filter1 x gt 100 See the RTI Data Distribution Service User s Manual regarding content filter expression syntax There are up to three ways to set these parameters L From a configuration file The configuration file follows the usual Microsoft Windows ini file syntax The file is read when Excel starts This file is located in lt My Documents gt RTI Spreadsheet Add in for Microsoft Excel lt version gt RTIExcelAddin ini unless a non default location is specified in the registry setting see Appendix C for details To open this file select RT Config in the RTI Spreadsheet Add in toolbar then click Open Contiguration File L From special cells in a saved workbook Configuration parameters can be speci fied in an Excel worksheet You can automatically create a worksheet with all the configuration cells based on the current configuration To do so select RTI Config in the RTI Spreadsheet Add in toolbar and then click Create Contiguration Sheet L From the configuration dialog To open this dialog select RTI Config in the RTI Spreadsheet Add in toolbar Note Not all parameters can be changed in the dia log
50. ynamically change the Throttle Interval select RTI Config from the RTI Spread sheet Add in toolbar Auto Publish Frequency If the auto publisher timer is on the auto publish timer interval controls how often data is automatically published If you are changing the value of the data faster than the auto publish timer only some of the samples will be published and samples may be published at a later time than when you changed it The auto publish interval must be greater than or equal to the RTDThrottleInterval value set in the registry see Section 2 3 in the Getting Started Guide Otherwise the add in will automatically set the auto publish timer equal to RTDThrottleInterval The amount of time between publishing cell values is max Excel s RTDThrottleInterval RTI Spreadsheet Add in s auto publish timer interval time since the cell was last changed or published depending on the Publish changed data only setting You can dynamically change the auto publish timer by selecting RTI Config from the RTI Spreadsheet Add in toolbar 3 9 UOIDINBHUOD E Chapter 3 Figure 3 3 Configuration Dialog Throttle interval Auto publish Open configuration file timer interval a publish timer 3 3 3 10 RTI Configuration Domain ID fo Peer hosts Open QoS file QoS library ExcelQosLib Stop RTI Data Distribution Service Hab Throttle interval Interval ms 200 E Create configuration s
Download Pdf Manuals
Related Search