Home

RTI Spreadsheet Add-in for Microsoft

1. Configuration Method Default Parameter File Cells in a Configuration Worksheet Dialog Forced 1000 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 eer i EL dateCurrentSheet RTIDDS CONFIG MANUAL UPDATE Stop Connext No ea applies to ManualUpdateCurrentSheet CURRENT SHEET before changing update applies current lt yes no gt to all sheets sheet only Publish No publish changed Confiel RTDDS_CONFIG_ALWAYSPUBLISH Stop Connext changed data AlwaysPublish lt yes no gt before changing data only only Domain DDSConfig RTIDDS CONFIG DOMAINID Stop Connext 0 ID DomainId lt n gt before changing DDSConfig Ston re None uses Peer hosts PeerHost RTIDDS_CONFIG_PEERHOSTS P default DDS before changing lt peerl gt lt peer2 gt QoS None uses a Deens RTIDDS_CONFIG_QOSLIBRARY Stop Connext default DDS Library OoSLibrary lt name gt before changing Oos QoS DDSConfig Stop Connext None uses RTIDDS_CONFIG_QOSPROFILE default DDS Profile QosProfile lt name gt before changing OoS e Throttle DDSConfig RTIDDS_CONFIG_ ee ea ii interval ThrottleInterval lt ms gt THROTTLEINTERVAL ME gi Section 3 2 Can be changed e p DDSConfig RTIDDS_CONFIG_ ad eend ke pubisa AutoPublishTimer lt ms gt AUTOPUBLISHTIMER eee aaa timer started See Section 3 2 DDS DDSConfig
2. 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 UONDINBHUOD e Configuring the Spreadsheet Add in 3 12 Chapter 4 Visual Basic for Applications VBA 4 1 Functions for the Spreadsheet Add in Some of the buttons in the Spreadsheet Add in toolbar perform 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 4 RTI Publish Now p Start RTI Add in i E RTI Update Now Stop RTI Add in Enabling Visual Basic Support A sample Visual Basic script is provided 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 ha
3. SOLID_FILL TRANSPARENT_FILL HORIZONTAL HATCH FILL VERTICAL HATCH FILL struct ShapeType string lt 128 gt color key long x long y long shapesize struct ShapeTypeExtended ShapeType ShapeFillKind fillKind float angle Ji The following function will subscribe to instances of the topic Square of type Sha peType whose key field color is PURPLE This cell will show the value of the field x RTD dds2excel connect TYPE ShapeType TOPIC Square TYPENAME ShapeTypeExtended FTELD x KEY color PURPLE Be aware that 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 Connext 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 manual update subscrip tions in the current sheet only If you copy a manual update cell from one sheet to another the RTD function will contain the wrong she
4. RTD dds2excel connect TYPE ShapeType TOPIC Square FIELD x KEY color RED B C D E F G H l 2121 104 30 ar AT AT A 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 No table header is created and there is always just a single row Notice that the subscription is created by overwriting existing cells in the worksheet no new row is inserted into the worksheet 2 13 SOISDg oul Buluipe z Learning the Basics 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 received 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 Spreadsheet Add in toolbar if you have configured the RTI Update Now button to only update manual update subscriptions in current worksheet then the sub scription will be refreshed only if it is in the current worksheet when the button is pressed See the Manual Up
5. Table 3 1 Configuration Parameters Parameter Description Domain ID Identifies the domain to which the instance of Spreadsheet Add in for Microsoft Excel belongs Each domain represents a separate data communication plane isolated 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 f00 See the RTI Core Libraries and Utilities User s Manual or API Reference HTML documenta tion for details on formatting peer descriptors 3 1 UONDINBHUOD e Configuring the Spreadsheet Add in Table 3 1 Configuration Parameters Parameter Description Sets the Quality of Service QoS policies for all the entities 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 S lib d NDDS_QOS_PROFILES environmen
6. RT Config b Set the Auto publish timer in milliseconds as desired Monitoring Built in Topics 2 6 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 The add in 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 To support these needs the add in provides built in Topics that you can use to access this discovery information ti Create a domain monito topics for discovered publica re Builtintopic ZME tions subscriptions and par OE dis Publications ticipants A Subscriptions Lev
7. base type see Integration with Extensible Types Section 2 7 You can only select one type at a time When you click Create publication the add in creates a publication table at selected cell s in the worksheet For example 1 PUBLICATION Topic Square Type ShapeType The table contains three rows of table 2 ERA AES ed 3 x ily shapesie data for one sample 4 mn i o Each row holds the 5 MEE NEE FEE 6 HENNE EE ee 7 Oooo oo eee 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 s ple with a column for each field that you want to fill in To Control the Publication Table Size the am The number of rows in the table depends on what is selected on the worksheet when you first click Create publication 2 15 soispg oul Buluipe z Learning the Basics 2 5 2 2 5 3 2 16 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 enter 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 mor
8. is deleted Publisher Just before the first sample is published There is only one Publisher per DomainParticipant B 1 UONSNIISEd pup UONDE1D Anu3 g This Entity Is Created Is Destroyed LJ 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 HA topic monitor for Topic T is created LJ If there is no RTD function for Topic T I An RTD function for Topic T is entered when the last topic monitor for Topic T is DataReader deleted for Topic T J Connext starts and there are one or more topic monitors subscriptions or RTD m When the DomainParticipant is deleted functions for Topic T which can happen either when Connext is There is at most one DataReader per Topic soppe or when Excel 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 a ed P P i When the Publisher and DomainParticipant for Topic T i are deleted There is at most one DataWriter per Topic Appendix C Controlling File Locations with Registry Settings When 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
9. startup AutoStarfDDS lt yes no gt RTIDDS_CONFIG_AUTOSTARTDDS N A No UONDINBHUOD Configuring the Spreadsheet Add in Table 3 3 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 Entities 1 Errors 4 Debugging messages 2 Errors and warnings Over fesse write log 5 ak ee RTIDDS_CONFIG_LOGFILE N A yes file verwriteLogfile lt yes no gt lt My Docu ments gt RTI Spreadsheet Add in for Microsoft Excel Logging lt version gt RTI Log file LogFile lt full path of log RTIDDS_CONFIG_OVERWRITELOG N A ExcelAd file gt din log unless specified in a registry set ting 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 methods b To make changes in the configuration file use this format Category Parameter value c These cell na
10. the Cre ate Configuration Sheet button in the RTI Config dialog See Figure 3 2 on page 3 8 If a Connext application has not been started values specified in the configuration worksheet are loaded when the configuration worksheet is opened The loaded values will be used for all workbooks in this Excel instance If a Connext 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 Connext 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 the RTI 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 or not the RTI service is running will be enabled in the dialog If a parameter is not available in the RTI Config dia log it means it cannot be changed at run time See Figure 3 3 on page 3 10 Configuration Parameters Table 3 3 Configuration Parameters
11. 1 If 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 add in being initialized in the status bar at the bottom of the Excel window If you do not see that message or there is an error see Chapter 2 in the Getting Started Guide for details on how to set it up The Spreadsheet Add in Toolbar The Spreadsheet Add in toolbar is your starting point for all of the add in s functional ity To see the Spreadsheet Add In toolbar select the Add Ins tab on the Ribbon Or if you are using Excel 2003 right click any Excel toolbar and choose Spreadsheet Add in for Microsoft Excel sr 9 C n Home Insert Page Layout Formulas Data Review View Add Ins RT Config My RTI Add Publicatio gar TI Monitor Doma EE fer About 9 RTI Monitor Topic RTI Publish Now Start RTI Add in Ed RTI Add S criptic XRT date Now ff Toolbar Commands Custom Toolbars The commands in the toolbar are summarized below RTI Config L Opens a dialog for setting configuration parameters See Chapter 3 for details 2 1 SOISDg oul Buluipe z Learning the Basics 2 2 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 This command is only enabled after you have selected Start Add in RTI Add Sub
12. 4 nual Update Current Sheet Only yes no Changing the Data Refresh Frequency Throttle Interval and Auto publish Rate 3 2 3 2 1 3 2 2 Changing the Data Refresh Frequency Throttle Interval and Auto publish Rate Update Frequency for Subscribing Cells In general a subscription that is created behind the scenes will continuously receive all samples 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 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 dynamically 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
13. RIT Spreadsheet Add in for Microsoft Excel User s Manual Version 5 0 t f Your systems Working as one 2010 2012 Real Time Innovations Inc All rights reserved Printed in U S A First printing August 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 Technical Support Real Time Innovations Inc 232 E Java Drive Sunnyvale CA 94089 Phone 408 990 7444 Email support rti com Website https support rti com Contents 1 Welcome to Spreadsheet Add in for Microsoft Excel 1 1 Available Documentation nease ee ee ee ee ee ee ee ee be ee ee ee ee a ee ee ee ee ee be ee 1 2 2 Learning the Basics 2 1 The Spreadsheet Add in Toolbar ues ese ee ek ek ek eek ek GR Geek SR GR Re ek SR RR Se ek ekke ee 2 1 2 2 Starting the Add inus ris SE ib NE oe Een N ee ea ev ge PER eb oes A de aan Ee Sek Bee EER w
14. ability durability partition ownership ownership strength liveliness liveliness lease duration deadline Subscriptions builtin topic Reliability durability partition ownership liveliness liveliness lease duration 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 Publications builtin topic Durability_service latency_budget lifespan destination_order presenta tion user_data topic_data group_data property_qos 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 Monitoring Built in Topics multicast_locators product_version rtps_protocol_version rtps_vendor_id disable_positive_acks e Participants builtin topic Same information as advanced level 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 E 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 i
15. all the regular automatic update subscriptions in all work sheets plus the manual update subscriptions in the current worksheet only See Section 3 1 for details This command is only enabled after you have selected Start Add in Starting the Add in 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 you have selected Start Add in Start Stop RTI Add in LJ Starts stops the add in Other than amp RTI Config no other commands in the tool bar are enabled until the add in has been started See Section 2 2 for details Starting the Add in The add in is not functional until you start it Before starting the add in make sure you know the domain ID of the application you want to communicate with The add in must use the same domain ID as the application 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 complete description of the RTI Config dialog see Chapter 3 Configuring the Spreadsheet Add in Once the add in is set up to use the correct domain ID simply click gt Start RTI Add in from the Spreadsheet Add in toolbar or lo Start RTI Senice in the RTI Config dialog to start discovering other Connext applications m the same domain If the add in is started correctly the domain ID will appear in the lower righ
16. ant 2 3 2 3 Monitoring TOpics EE GE E E E EEN 2 4 2 3 1 Filter Expression Details s iss vas si ei ea yR a eRe 2 9 24 Subscribing to Data siccssccsastesssnesestesss Bee EER De Geb ek Ge Geb ey bye g Ges Eyes eisini ibian 2 11 2 5 Publishing Data ss es Re Es Ee cath seh EE ee RE EE ee N Ee EE Aes be Se 2 14 2 5 1 Creating a Publication Table ees ee ee ek Ge SR RR Ge Ge Ge RR Ge Ge AE Re He Gee He eek 2 14 2 5 2 Filling in the Data to be Published ese ee ee ek ekke SR Re Ge SR SR RR Ge RR Ge Ge Gee 2 16 2 9 5 Publishing the Data ass visser So et geseg De EE ees RA BEDE Deb REDE ee aS 2 16 2 6 Monitoring Built in TOPieS et ESE Sie REGSE see beg ese ve ities seke Ee ge gee gee e gee Geb Pg e cheats 2 17 2 7 Integration with Extensible TYPES ese sesse se se ee Ge Gee Re He He Ge AR Re He Bee He He Reeks 2 20 3 Configuring the Spreadsheet Add in 3 1 Configuration Paramet rs iss ese sessie se ore Piek ED fee se e e e E E e a 3 1 3 2 Changing the Data Refresh Frequency Throttle Interval and Auto publish Rate 3 9 3 2 1 Update Frequency for Subscribing Cells iii ese see se se se ee Gee Re He He ee He Heg eke 3 9 822 Auto Publish Frequent ys is ie verse es ese verge hie a lade SERE ee N ees eer eN DU 3 9 3 3 Using Different Domains at the Same Time uses sees se eek ee ge ee eN ee gee e eke eke 3 11 4 Visual Basic for Applications VBA Functions for the Spreadsheet Add in 4 1 Enabling Visual Basic Support cess
17. 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 3 9 UONDINBHUOD e Configuring the Spreadsheet Add in You can dynamically change the auto publish timer by selecting RTI config from the RTI Spreadsheet Add in toolbar Figure 3 3 Configuration Dialog rt Configuration Domain ID o Peer hosts QoS library ExcelQosLib Y QoS profile DefaultProfile C Stop RTI Service Throttle interval Throttle interval 7 Manual update applies to current sheet only Interval ms V Publish changed data only Auto publish Auto publish timer timer interval Interval ms E Open configuration file Ce 3 10 Using Different Domains at the Same Time 3 3
18. bar See Section 2 1 for details StopDDS Stops the add in just like the behavior of the Stop RTI Add in 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 2 Using VBA Functions Table 4 1 4 3 Supported Visual Basic Functions in the shipped DDS2ExcelModule Function Typical Use Checks all 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 config PublishNowDDS ured 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 Checks all DDS automatic update subscriptions for updates For manual NowDDS update subscriptions only those in the current worksheet will be checked Checks al
19. bes 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 l Not equal lt Less than gt Greater than lt Less than or equal to gt Greater than or equal to The and comparators are followed by an expression 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 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 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 goo
20. configuration sheet L From the configuration dialog To open this dialog select RT Config in the RTI Spreadsheet Add in toolbar Note Not all parameters can be changed in the dia log 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 3 3 UONDINBHUOD e Configuring the Spreadsheet Add in Figure 3 2 on page 3 8 shows an auto generated configuration sheet Table 3 2 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 ina 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
21. d wmatch 2 9 soisbg oul Buluipe z Learning the Basics Table 2 3 2 10 Example Filter Expressions Filter Expression Explanation st Matches all 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 IB Matches any value that does not match the previous expression 1 IB B above examples 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 compari son is alphabetic lt 20090101 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 com parison is alphabetic gt 20080101 gt 20080101 AND lt 20090101 Matches any values where both conditions are true Matches any values where the first and second expressions both evaluate to true or the third expression evaluates to true Note the grouping of expressions gt 20080101 AND lt 20090101 OR 20100315 L 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 i
22. date section above To delete a subscription Each cell of the subscription can be deleted individually If you want to know when the actual reader that subscribes to the instance of the topic is created deleted behind the scenes see Appendix B 2 5 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 2 5 1 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 Spreadsheet Add in toolbar select RTI Add Publication 2 14 Publishing Data Click a topic from the list on the p a ti Create aj reate a publication tabl left then select the fields that you want to fill in Unselected fields IE ST will still be published but will be 2 ops ie SIPA ShapeT set to their default values numer Orde EE et i f i Triangle Vx TK LONG ical fields will be set to 0 strings By oie will be empty By default all iv shapesize TK LONG fields in the data type are selected You may see more than one type with the same name In this case one type is the base type and oth ers are extended versions of the Create publication
23. e 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 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 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
24. e 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 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 from the table H To manually publish the data one time select RTI Publish Now from the Spread sheet Add in toolbar To automatically publish the data at a constant rate set a timer a From the Spreadsheet Add in toolbar select
25. e 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 an add in configuration parameter so that clicking on the RTI Update Now button will update all automatic update subscriptions in all work 2 7 SOISDg oul Buluipe z Learning the Basics 2 8 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 SUBSCRIPTION M Topic Square Type ShapeType color x y shapesize Three rows of table header Number of rows in table 160 number of instances received a max history depth Samples 125 141 for the same instance will be grouped together with the latest sample for that Each selected field in the data type appears in its instance shown first The own column Darker colored column headers number of rows may increase indicate key fields over time as new instances are receiv
26. ed Deleted instances appear in red When is the table refreshed L 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 I If the topic monitor is created with the Manual update option data in the topic monitor table is only refreshed if you click the RTI Update Now button in the Spreadsheet Add in toolbar if you have configured the RTI Update Now 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 Core Libraries and Utilities User s Manual regarding not alive instances Monitoring Topics 2 3 1 Table 2 1 Table 2 2 If you want to know when the actual reader that subscri
27. ed 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 seguence 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 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 You may see more than one type with the same name In this case one type is the base type and others are extended versions of the base type see Integration with Extensible Types Section 2 7 You can only select one type at a time 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 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 Fi
28. eive 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 soisbg oul Buluipe z Learning the Basics 2 7 2 20 Integration with Extensible Types Some of the add in s dialogs display 7 i i Choose topic and fields a list of available topics When you select a topic you will see its data Available topics Crane type and the fields within that data S94 Meld Shape Type Circle v color TK STRING key type Triangle V x TK_LONG Vly TK_LONG In the Fields section you may see V shapesize TK_LONG more than one type with the same med EN i is p i GZlangle IKEL OAT name This indicates that the applica tions you are communicating with EE Special fields are using the Extensible Types fea ture in Connext With this feature there may be more than one version of a data type a base type and one or more extended types What are Extensible Types Connext includes partial support for the Extensible and Dynamic Topic Types for DDS specification from the Object Management Group OMG With Extensible Types more than one version of the same type can be found in the DDS cloud This support all
29. eived 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 L 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 LL 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 Wildcards 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 H 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 2 12 Subscr
30. el of detail Participants Location Note Only remote entities Basic Current cell appear in builtin topics Advanced New worksheet Entities created by the same participant in this case the Spreadsheet Add in for Microsoft Excel application will not appear in the builtin topic You can use a built in topic monitor to display built in 5 Full g Create builtin monitor Cancel From the Spreadsheet Add in toolbar select 3 RTI Monitor Domain then select one of the builtin topics publications subscriptions or participants from the drop down list box 2 17 soisbg oul Buluipe7 z Learning the Basics 2 18 Builtin topic l There are three types of builtin topics that provide discovery information about three 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 See the Connext API Reference HTML documentation on builtin topic data for details of the meaning of these fields e Basic Publications Subscriptions builtin topic Host IP Creation timestamp Deletion timestamp Entity kind Topic Type Participants builtin topic Host IP Creation timestamp Deletion timestamp Participant name Prod uct version RTPS version e Advanced includes all basic information plus Publications builtin topic Reli
31. es ek ek ek eke eek eke ek SR SR GR Rek SR RR Ge Se SR RR Ge Ge SR ER Re Ge Gee 4 1 4 2 Supported VBA FuncHONS sisie ses isch ee te isch ge kase eke ke See ee sae ee oe oe beg Ge juste bebe koe ee Ge bee 4 2 4 3 Using VBA PUN Ct ONS oa kes tech Ere Sits Does Se Aes ee Hae Da esse de canes Dae de ee ASA 4 3 A Subscribing to Data with the Real Time Data RTD Function B Entity Creation and Destruction C Controlling File Locations with Registry Settings Chapter 1 Welcome to Spreadsheet Add in for Microsoft Excel Welcome to RTI Spreadsheet Add in for Microsoft Excel This revolutionary component of RTI Connext DDS and RTI Connext Messaging 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 tech nology 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 visuali
32. et name unless you manually modify the RTD function or you restart Connext 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 A 3 GLa WIM DIDA o Buiquosqns vy A 4 Appendix B Entity Creation and Destruction The following table explains when Spreadsheet Add in for Microsoft Excel creates and destroys the entities it uses All entities are created with the QoS values as specified in the RTIDDS CONFIG OOSLIBRARY 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 Connext application starts This can happen two ways When the Connext application stops This can Domain DO When Excel is started and a workbook is happen two ways Participant opened if the auto start DDS option is LJ When Excel is closed enabled L When you start Connext L When you stop Connext Subscriber There is only one Subscriber per When the DomainParticipant is created DomainParticipant When the DomainParticipant
33. han the other El ShapeType fillKind and angle this is the haia key A CX IKI extended version of ShapeType y TK LONG You can only select one of the dis shapesize ss played versions at a time See Important Note on page 2 20 2 If you choose the extended version and select Create subscrip tion the results will look like this SUBSCRIPTION Topic Square Type ShapeType color x y shapesize fillKind angle angle _ 0 0 BLUE 131 172 RED 91 146 30 2 3 4 5 Notice that the fillKind and angle for the blue square are set to default values That s because the blue square wasn t published with these fields since it was published with the base version of ShapeType However if you were to create a subscription using the base ver sion of ShapeType the extra fields for the red square fillKind and angle are ignored as seen to the right SUBSCRIPTION Topic Square Type ShapeType color x y shapesize shapesize BLUE 40 100 30 RED 150 207 30 OM POND In the following example we use Spreadsheet Add in to publish a red square using the extended version of ShapeType One instance of Shapes Demo is subscribing to squares and is configured to use the base version of ShapeType we ll call this the Base Sub scriber The other instance of Shapes Demo is subscribing to squares and is configured to use the extended version we ll call this the Extended Subscriber T
34. he following image shows that the Extended Subscriber gets all the information including fillKind and angle while the Base Subscriber ignores the extra fields Integration with Extensible Types 1 PUBLICATION Topic Square Type ShapeType 2 color x y shapesize fillKind angle EE BEE Base Subscriber Extended Subscriber File View Publish Subscribe Controls Help File View Publish Subscribe Controls Help Square Circle Triangle a Similarly when publishing the simple Shape type the ExtendedSubscriber will set default values for the missing fields resulting in both Shapes Demo instances drawing the same square the default FillKind is solid and the default rotation is no rotation PUBLICATION Topic Square Type ShapeType color x y shapesize x ly shapesize Base Subscriber Extended Subscriber a a 2 23 Learning the Basics 2 24 Chapter 3 Configuring the 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 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
35. ibing to Data e Two QoS profiles are provided with 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 H 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 Spreadsheet 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 the 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 Create subscription the add in creates a subscription in the worksheet starting in the currently selected cell RTD function Al vl fe
36. it simple to create publications and subscriptions using a point and click interface Key Benefits of Spreadsheet Add in for Microsoft Excel Allows spreadsheets to participate seamlessly as peers on a distributed network DataBus along with applications written in C C Java Net and Ada Com plex Event Processing CEP engines databases and mobile and embedded devices I Supports data injection write back I Provides low latency real time analytics and data visualization M Allows introspection status and health monitoring of Connext applications I Self contained within an Excel Add in requires no separate service or gateway or custom integration code 1 1 Available Documentation Spreadsheet Add in for Microsoft Excel documentation includes Getting Started Guide RTI_Spreadsheet_Addin_GettingStarted pdf High lights the benefits of Spreadsheet Add in for Microsoft Excel and provides installation instructions It also walks you through a short demonstration and a tutorial so you can quickly see the benefits of using 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 I Users Manual RTI_Spreadsheet_Addin_UsersManual pdf Describes how to configure Spreadsheet Add in for Microsoft Excel and provides details on each feature Chapter 2 Learning the Basics 2
37. l DDS automatic update subscriptions for updates For manual GroupUpdate update subscriptions only those whose worksheet name matches the one NowDDS specified by the parameter of this function will be checked If an empty group As String 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 function in the button click event 4 3 SUonD2Iddy 10 SISDg IPNSIA Y Visual Basic for Applications VBA Functions for the Spreadsheet Add in 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 Spreadsheet Add in for Microsoft Excel It is used as follows RTD dds2excel connect TYPE lt type_name gt TOPIC lt topic_name gt TYPENAME lt type_version_name gt FTELD lt field_namel gt KEY lt field_name2 gt lt value2 gt KEY lt field_name3 gt
38. lt value3 gt MANUAL lt sheet_name gt The first parameter is the program ID of 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 Notice that there is a TYPE parameter and a TYPENAME parameter The TYPENAME refers to the name for a specific type definition of a data type as defined using any of the type definition languages provided with Connext such as IDL or XML A 1 GLa UM DIDA o Buiquosqns vy A 2 For example suppose you have this type defined in IDL struct TypeNamel long aField Along with a second extended type struct TypeName2 TypeNamel double extendedField To subscribe to the first type use TYPE TypeNamel and TYPENAME IypeNamel To subscribe to the second type use TYPE IypeNamel and TYPENAME TypeName2 For more information see Integration with Extensible Types Section 2 7 As another example consider the RTI Shapes Demo application which can publish sub scribe to either ShapeType and ShapeTypeExtended In both cases the type registered with Connext is ShapeType but they are defined in IDL with different names like this enum ShapeFillKind
39. lter 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 selected for display See the Fields section above for how to select a field for display Location Choose where the instances will be populated in the currently selected cell or a 2 6 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 Monitoring Topics 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 l The indicates the nu
40. mber 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 Spreadsheet Add in for Microsoft Excel Default Profile with depth 4 and NoHistoryProfile with depth 1 By default DefaultProfile is used and therefore Max history depth is limited to 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 H 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 ally updated subscription tabl
41. mes 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 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 foo 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 UONDINBHUOD e Configuring the Spreadsheet Add in Figure 32 Generated Configuration Worksheet Domain ld Ole Rl ET ExcelQosLib Okt Id DefaultProfile List of comma separated discovery a Throttle interval ms Auto publish timer ms 0 off Auto start DDS yes no Forced GC Rate 100 Publish all even if no changes yes no Log file Overwrite log file yes no yes DynamicData max size serialized 4294967295 Filter expression Content filter 1 Content filter 2 Content filter 3 NN i N Content filter Ha NN N Verbosity 0 1 2 3
42. nces 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 Spreadsheet Add in toolbar select RTI Monitor Topic then select one of the Available Topics Monitoring Topics For example Fields in the selected topic s data type cti Create Choose topic and fields Available topics ShapeType color TK_STRING key X TK LONG Jy TK LONG shapesize TK LONG Special fields Optional filters specifying which instances of the topic you want to monitor Available for key fields only o E TK_STRING anere to place e new topic i 5 monitor table Max history depth How many historical values Controls whether the topic monitor table f to display for each instance will get updates automatically or manually Available Topics LI These are the topics that have been discovered in the domain you selected in the RTI Config dialog Fields LI 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 2 5 Learning the Basics The Special fields correspond to fields in the Sample Info data structure which provides meta information about data that is receiv
43. nserted 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 I 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 88 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 Two rows for the table header 2 Host IP Creation timestamp Type 3 192 168 1 138 3 1 2012 3 47 31 12 PM writer with key Square ShapeType One row for each 4 192 168 1 138 3 1 2012 3 47 42 27 PM writer with key Square ShapeType entity discovered 5 192 168 1 138 3 1 2012 5 06 40 66 PM 3 1 2012 5 50 58 36 PM writer with key Circle ShapeType so far The number 6 192 168 1138 df 3 1 2012 5 06 43 02 PM writer with key Triangle ShapeType of rows may increase over time oo ae Deleted ntities appear in red Number of columns depends on the level of detail selected 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 rec
44. ows sys tems to define data types in a more flexible way and to evolve data types over time with out giving up portability interoperability or the expressiveness of the DDS type system If you have the Connext Core Libraries and Utilities you can learn more in the Getting Started Guide Addendum for Extensible Types lt Connext installation directory gt ndds lt ver sion gt doc pdf RTI_CoreLibrariesAndUtilities_GettingStarted_ExtensibleTypesAddend um pdf The OMG specification is available here http www omg org spec DDS XTypes Important Note Once you are using one of the available versions of a type if you want to select a different version of the type you must first stop the Add in and delete the tables cells that are using the currently selected type To stop the Add in click the Stop RTI Add in or use the RTI Config dialog Let s consider an example using RTI Shapes Demo which is also used in the tutorial in the Getting Started Guide Shapes Demo can publish subscribe to either a simple base Shape type or an extended Shape type Both types have the same type name Sha 1 The dialogs for Add Subscription Add Publication and Monitor Topic list the available topics 2 Extensible types are only supported in Shapes Demo version 5 0 and higher Integration with Extensible Types peType The extended version includes the same data as the base type plus two more fields fillKind and angle Suppose you are r
45. s 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 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 Core Libraries and Utilities User s Manual regarding content filter expression syntax There are up to three ways to set these parameters 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 RTI Config in the RTI Spreadsheet Add in toolbar then click Open Configuration File 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 select 3 Create
46. s encountered see the examples in Table 2 3 Filters are always evaluated from left to right Parentheses are not supported 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 expressions info dotnet html H 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 Subscribing to Data applied See the Fields section in Monitoring Topics Section 2 3 for how to select a field for display 24 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 Spreadsheet Add in toolbar select d RTI Add Subscription Click one of the Available Topics then select the fields you want to display ms Fields in the Choose
47. scription I Opens a dialog for creating a subscription row to monitor one single instance of a specific topic See Section 2 4 for details This command is only enabled after you have selected Start Add in 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 you have selected Start Add in 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 you have selected Start Add in RTI Update Now I 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
48. t corner of the Spreadsheet Add in toolbar The other toolbar commands also become enabled Running on domain 0 Formulas Data Revew View Add Ins Acrobat E 2 About Home Inset Page Layout RM Config D RTI Add Publication Ge RTI Monitor Domayy amp RTI Monitor Topic ip RTI Publish Now Stop RTI Add i Ed RTI Add Subscription 4_ RTI Update Now nning on do Custom Toolbars Toolbar Commands When you start the add in it looks for the license file 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 2 3 soisbg oul Buluipe z Learning the Basics 2 3 2 4 Note When you start the add in it creates entities and generates network traffic For information on when these entities are created and destroyed please see Appendix B Once the add in is started you re ready to publish or subscribe to data See these sec tions for details LI Monitoring Topics Section 2 3 LI Subscribing to Data Section 2 4 I Publishing Data Section 2 5 LJ Monitoring Built in Topics Section 2 6 m Integration with Extensible Types Section 2 7 Monitoring Topics The RTI Topic Monitor feature subscribes to a specific topic You can subscribe to all instances of a topic or a subset of insta
49. t variable unless a non default location is speci Qo fi i TOYAN fied in the registry setting see Appendix C for details profile To open the QoS file under My Documents select the RTI Config button in the RTI Spreadsheet Add in toolbar and then 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 Core Libraries and Utilities LIser s Manual for details regarding OoS 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 the RTI service is stopped If you restart Connext you may need to restart the auto publish timer RTI Service startup policy Behavior at start up whether or not the RTI ser
50. the 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 aa RTIExcelAddin ini IniFile Pe Profiles CEL QOS_PROFILES xml QosProfiles Log file RTIExcelAddin log LogFile sBulyes Aysibey gt a The registry key contains string values that contain the full path of each file including file name The registry keys 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 only the file specified in th
51. topic and fields Seno Pi s Ava ilable Available topics Topics Circle lt El color TK_STRING key Triangle IV ly TK_LONG shapesize TK_LONG source_timestamp reception_timestamp reception_sequence_number Use 0 to see the most recent sample Enter key values History position Type Value 0 g TK_STRING slae _ Manual Update Controls whether the subscription will get updates automatically or manually Desired value for key field ke Create subscription Learning the Basics Available Topics These are the topics that have been discovered in the domain you selected in the RTI Config dialog Fields l You may see more than one type with the same name In this case one type is the base type and others are extended versions of the base type see Integration with Extensible Types Section 2 7 You can only select one type at a time LI 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 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 rec
52. unning one instance of Shapes Demo that is set up to publish blue squares with the base Shape type and a second instance of Shapes Demo that is set up to publish red squares with the extended Shape type The Shapes Demo windows might look like these RT EN a File View Publish Subscribe Controls Help Square Circle Triangle Square Circle Triangle Delete All Delete All Pause Publishing Pause Publishing Hide History Hide History Configuration ba Configuration SZ f Data Type ype Name Data Type vpe Color Partitions Read Take QoS Se Pub 5 Square Shape Extended b RED Default Ready on domain 0 E Ready on domain 0 As indicated in the Data Type column Shapes Demo on the left is publishing the base Shape type while the one of the right is publishing an extended version Note however that each instance of Shapes Demo is publishing a data type named ShapeType The Data Type column just helps you know which version is being used Learning the Basics 2 22 In the Add Subscription dialog if Choose topic and field you select Square on the left me under Topics you will see Sha Available topics Fields ed a ie ie SI ShapeType Fields color TK STRING key x TK_LONG If you expand both ShapeTypes Fly TK_LONG you will see that one of them has shapesize TK_LONG two more fields t
53. ve Microsoft Office 2003 In Excel select Tools Macro Visual Basic Edi tor from the menu to bring up the Visual Basic Editor If you have Microsoft Office 2007 or 2010 In Excel under the Developer tab click Visual Basic If you don t see the Developer tab right click in the ribbon select Customize the Ribbon select the Developer tab and click OK 2 Select Tools References in the Visual Basic menu to open the VBA Project Ref erences dialog Select the checkbox for DDS2Excel Click OK 4 1 SUonD2Iddy 10 SISDg IPNSIA Y Visual Basic for Applications VBA Functions for the Spreadsheet Add in 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 script 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 Spreadsheet Add in for Microsoft Excel are now ready to be used 4 2 Supported VBA Functions Table 4 1 summarizes the supported VBA functions in the DDS2ExcelModule Table 4 1 Supported Visual Basic Functions in the shipped DDS2ExcelModule Function Typical Use StartDDS Starts the add in just like the behavior of the Start RTI Add in button in the RTI Spreadsheet Add in tool
54. vice should be started if it is not already running when a workbook with a configuration worksheet is loaded Starting the RTI service creates a DomainParticipant starts discovery of types and top ics and starts any defined subscriptions or publications This will generate network traf fic For information on when these 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 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 Configuration Parameters Table 3 1 Configuration Parameters Parameter Description Controls if both the Auto publish timer and the RTI Publish Now button will publish Publish changed dataoni samples only if they have been changed since the last time they were published or will y publish regardless of whether the sample ha
55. zation and analysis you have to invest in expensive custom tool ing often an impractical option at the user or the operator level Spreadsheet Add in for Microsoft Excel is different Your queries formulas 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 applications to deploy administer or be trained on all of this happens within the Microsoft Excel appli cation that you know and use already With 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 visualization aspect to the data consumers Dashboards can be created at deployment time and cus tomized according to the needs of the data consumer QWOIIOM L Welcome to Spreadsheet Add in for Microsoft Excel 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 Spreadsheet Add in for Microsoft Excel can work both as a subscriber and a publisher Wizards make

RTI Spreadsheet Add-in for Microsoft

Contents

Download Pdf Manuals

Related Search

Related Contents