rtview core® user’s guidesldownloads.sl.com/docs/rtview_userguide_7.1.pdf · rtview core®...
TRANSCRIPT
-
RTView Core® User’s Guide
Version 7.1
-
RTView Core®
Copyright © 1998-2018. All rights reserved. No part of this manual may be reproduced, in any form or by any means, without written permission from Sherrill-Lubinski Corporation. All trademarks and registered trademarks mentioned in this document are property of their respective companies.LIMITATIONS ON USE Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in the Technical Data - Commercial Items clause at DFARS 252.227-7015, the Rights in Data - General clause at FAR 52.227-14, and any other applicable provisions of the DFARS, FAR, or the NASA FAR supplement.SL, SL-GMS, GMS, RTView, RTView Core, RTView Enterprise Monitor, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2018 Sherrill-Lubinski Corporation. All Rights Reserved.JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only. No part of this manual may be reproduced, in any form or by any means, without written permission from Sherrill-Lubinski Corporation.All trademarks and registered trademarks mentioned in this document are property of their respective companies.
SL Corporation240 Tamal Vista Blvd.Corte Madera, CA 94925 USA
Phone: 415.927.8400Fax: 415.927.8401Web: http://www.sl.com
-
Preface ................................................................................................................. 1
About This Guide ........................................................................................... 1Document Conventions ...................................................................... 1
Additional Resources ...................................................................................... 2Release Notes ................................................................................... 2Documentation and Support Knowledge Base ........................................ 2
Contacting SL................................................................................................ 2Internet ........................................................................................... 2Technical Support.............................................................................. 2
Chapter 1 - Getting Started................................................................................... 3
Overview ...................................................................................................... 3Product Overview...................................................................................... 3Examples................................................................................................. 3Demos .................................................................................................... 3Shortcuts (Available for use on Windows Platforms Only) ............................... 4
Chapter 2 - Setup and Registration ....................................................................... 5
Installation ................................................................................................... 5UNIX or Windows...................................................................................... 5
Setup........................................................................................................... 5Setup Environment ................................................................................... 6Set RTV_HOME Locally or Globally............................................................... 6
Locally ............................................................................................. 6Globally ........................................................................................... 6
Include lanscan in PATH Environment Variable (HP users only) ........................ 7RTV_USERPATH ........................................................................................ 7RTV_JAVAOPTS......................................................................................... 7Demo Server, Data Server, Display Server and JSP Example ........................... 8
Registration .................................................................................................. 9Application Registration ............................................................................. 9Registration Dialog.................................................................................... 9
Chapter 3 - System Requirements....................................................................... 11
Chapter 4 - RTView Upgrades ............................................................................. 13
Upgrading to 6.1.0....................................................................................... 13Alert Persistence..................................................................................... 13
Upgrading to 6.0.1....................................................................................... 13Alerts / Self Service Alerts ....................................................................... 13Alert Persistence..................................................................................... 14CMDB.................................................................................................... 14
Upgrading from 5.9.1 to 6.0.0 ....................................................................... 14
RTView Core® User’s Guide iii
-
Alert Persistence..................................................................................... 14Cache Data Source.................................................................................. 14
Upgrading from 5.9.0 to 6.0.0 ....................................................................... 15Self Service Alerts................................................................................... 15Self Service Alerts Demo.......................................................................... 15
Chapter 5 - Product Overview ............................................................................. 17Display Builder ....................................................................................... 17Deployment ........................................................................................... 18Data Server ........................................................................................... 18Historian................................................................................................ 18Alerts .................................................................................................... 18Customization ........................................................................................ 18
Chapter 6 - Role-based Security.......................................................................... 21
Login ......................................................................................................... 21Set up Login .......................................................................................... 22
Enable Login................................................................................... 22Set up Roles........................................................................................... 22Roles and Displays .................................................................................. 23
Configuration .............................................................................................. 23User Definitions ...................................................................................... 23
Defining Users in an XML File ............................................................ 23Role Definitions ...................................................................................... 24
Defining Roles in an XML File ............................................................ 25
Chapter 7 - Building Displays .............................................................................. 27
Builder Options............................................................................................ 29General Tab............................................................................................ 29Grid Tab ................................................................................................ 31
Running the Display Builder .......................................................................... 32RTV_JAVAOPTS....................................................................................... 32
Using the Object Palette ............................................................................... 32Add/Edit Objects..................................................................................... 32
Adding an Object............................................................................. 32Connecting Objects (applies to Links only) .......................................... 34Working with Objects ....................................................................... 34
Object Properties .................................................................................... 36Editing Property Values .................................................................... 37Copying Property Values................................................................... 38Column Format Properties ................................................................ 38Image Property ............................................................................... 39Creating a Custom Image Library ...................................................... 39webLabelFlag .................................................................................. 40
Object Descriptions ................................................................................. 41
iv RTView Core® User’s Guide
-
Object Palette ................................................................................. 41Composite Object ............................................................................ 44Control Objects ............................................................................... 50Fx Graphs ...................................................................................... 92Graph Objects................................................................................ 136Indicator Objects............................................................................ 252Labels Objects ............................................................................... 283Meter Objects ................................................................................ 314Link Objects .................................................................................. 319Scale Objects................................................................................. 327Table Objects................................................................................. 365
Style Sheets .............................................................................................. 409Creating Style Sheets ............................................................................. 410
Style Class Names .......................................................................... 411Style Groups.................................................................................. 412Object Properties............................................................................ 413
Application Options Style Sheets .............................................................. 415Display-Specific Style Sheets................................................................... 416Built-In Style Sheets .............................................................................. 417
Drill Down Displays ..................................................................................... 418Drill Down Targets.................................................................................. 418Drill Down Properties.............................................................................. 418Drill Down Column Substitutions Dialog .................................................... 421
Substitutions.............................................................................................. 422Linking Substitutions with Variables.......................................................... 422Drill Down Substitutions.......................................................................... 423
Attach to Data............................................................................................ 424Substitutions......................................................................................... 425Row Filtering ......................................................................................... 425
Define/Execute Command............................................................................ 426Commands ........................................................................................... 426
Define Command............................................................................ 426Execute Command.......................................................................... 426Command Confirmation................................................................... 427Close Window Command ................................................................. 427
Threshold Commands ............................................................................. 427Define Threshold Command ............................................................. 429Execute Threshold Command ........................................................... 429
Open/Close Display Commands................................................................ 429Define Open/Close Display Command................................................ 429Execute Open/Close Display Command.............................................. 429
Multiple Commands................................................................................ 430Define Multiple Commands .............................................................. 430Execute Multiple Commands ............................................................ 430
Command Failure................................................................................... 430Define System Command........................................................................ 431
RTView Core® User’s Guide v
-
Command Types ............................................................................ 431Execute Commands on a Data Server................................................ 434Substitutions ................................................................................. 435Special Values ............................................................................... 435
File Options................................................................................................ 436Working with Files.................................................................................. 436
Creating a New Display (.rtv) File ..................................................... 436Opening a Display (.rtv) File ............................................................ 436Saving a Display (.rtv) File .............................................................. 436Printing a Display (.rtv) File ............................................................. 436
Background Properties................................................................................. 437
View Options.............................................................................................. 441
Multiple Display Panels ................................................................................ 441Configuring Multiple Display Panels........................................................... 441
Display Viewer Application ............................................................... 441Display Server ............................................................................... 441
PANELS.ini ............................................................................................ 442Example 1 ..................................................................................... 445Example 2 ..................................................................................... 445Synchronizing Drill-down and Navigation Controls............................... 446
Style Sheets.......................................................................................... 446Navigation Tree Definition File.................................................................. 449Tab Definition File .................................................................................. 450Viewing Multiple Display Panels................................................................ 451
Display Viewer Application ............................................................... 451Display Server ............................................................................... 451
Include Display Files.................................................................................... 452Functions.............................................................................................. 452Variables .............................................................................................. 453Objects ................................................................................................ 453
Chapter 8 - Functions......................................................................................... 455
Add/Edit Functions...................................................................................... 455Adding Functions ................................................................................... 455Editing Functions ................................................................................... 457Function Types ...................................................................................... 458
Scalar Functions............................................................................. 458Tabular Functions ........................................................................... 473
Attach to Function Data ............................................................................... 500Validation Colors.................................................................................... 502Substitutions......................................................................................... 502Select Columns...................................................................................... 502
Global Functions and Variables ..................................................................... 503Creating a Global Definition File ............................................................... 504
Creating a Reusable Global Definition File .......................................... 504
vi RTView Core® User’s Guide
-
Adding a Global Definition File to Application Options........................... 504Viewing Global Data........................................................................ 505
Chapter 9 - Variables ......................................................................................... 507
Add/Edit Variables....................................................................................... 507Linking Substitutions with Variables.......................................................... 507
Attach to Variable Data................................................................................ 508Validation Colors.................................................................................... 509
Global Functions and Variables ..................................................................... 510Creating a Global Definition File ............................................................... 510
Creating a Reusable Global Definition File .......................................... 511Adding a Global Definition File to Application Options .................................. 511Viewing Global Data ............................................................................... 511
Chapter 10 - RTView Data Sources..................................................................... 513
IBM WebSphere MQ Data Source .................................................................. 515System Requirements and Setup - IBMMQ............................................... 515
System Requirements ..................................................................... 515Setup ........................................................................................... 515
Attach to IBMMQ Data ............................................................................ 516Validation Colors ............................................................................ 518Substitutions ................................................................................. 519Select Object Name(s) .................................................................... 519Select Columns .............................................................................. 520
Application Options - IBMMQ ................................................................... 520IBMMQ Connections Tab.................................................................. 520IBMMQ Options Tab ........................................................................ 523
RTView Deployment - IBMMQ .................................................................. 523System Requirements and Setup ...................................................... 523Data Source Configuration File ......................................................... 523
Command Line Options - IBMMQ.............................................................. 524IBMMQ Custom Handler .......................................................................... 524
Example - Set username / password in MQ Data Source ...................... 525Using SSL for MQ connections .......................................................... 526
JMS Data Source ........................................................................................ 528JMS System Requirements and Setup ....................................................... 529
System Requirements ..................................................................... 529Setup ........................................................................................... 529
Attach to JMS Data ................................................................................ 529Validation Colors ............................................................................ 532Substitutions ................................................................................. 533Special Values................................................................................ 533Select Message Fields (Tables Only).................................................. 533Create JMS Message Alias................................................................ 534
Define JMS Command Window................................................................. 538
RTView Core® User’s Guide vii
-
Substitutions ................................................................................. 540Special Values................................................................................ 540
JMS Data Source Substitutions ................................................................ 541Application Options -- JMS ...................................................................... 541
JMS Options Tab ............................................................................ 542JMS Messages Tab.......................................................................... 542JMS Connections Tab ...................................................................... 543JMS JNDI Connections Tab............................................................... 546
JMS Handler.......................................................................................... 548RTView Deployment - JMS....................................................................... 550
System Requirements and Setup ...................................................... 550Data Source Configuration File ......................................................... 550Setup Client................................................................................... 550
JMS Demos ........................................................................................... 550Before You Begin............................................................................ 551Data Source Demo ......................................................................... 551
Quick Start Tutorial: JMS ........................................................................ 551Get Started ................................................................................... 552Create a Display............................................................................. 553
JMS Data Simulator................................................................................ 556Running the Simulator .................................................................... 557
JMS Data Source Command Line Options .................................................. 562
JMX Data Source ........................................................................................ 563System Requirements and Setup - JMX..................................................... 564
System Requirements ..................................................................... 564Setup ........................................................................................... 564
Attach to JMX Data ................................................................................ 565Validation Colors ............................................................................ 567Substitutions ................................................................................. 567RTViewDs...................................................................................... 568Special Values................................................................................ 568Select Multiple Attributes/Operations or Attribute Fields (Tables Only) ... 569
Define JMX Command............................................................................. 570Substitutions ................................................................................. 572Special Values................................................................................ 572
Substitutions - JMX ................................................................................ 572Application Options - JMX........................................................................ 573
JMX Administration Tab ................................................................... 573JMX Connections Tab ...................................................................... 575JMX Connection Groups Tab............................................................. 577Connecting to Multiple Secure Servers............................................... 577
RTView Deployment - JMX....................................................................... 582System Requirements and Setup ...................................................... 582Data Source Configuration File ......................................................... 582
Demos - JMX......................................................................................... 583Before You Begin............................................................................ 583Data Source Demo ......................................................................... 583
viii RTView Core® User’s Guide
-
JMX Monitor Demo.......................................................................... 584Quick Start Tutorial: JMX ........................................................................ 584
Get Started ................................................................................... 584Create A Display............................................................................. 585
Sample JMX Application .......................................................................... 589JMX Data Source Command Line Options .................................................. 591
Command Line Arguments............................................................... 591
Apache log4j Data Source ............................................................................ 594System Requirements - Apache log4j........................................................ 595Setup - Apache log4j.............................................................................. 595Attach to Log4j Data .............................................................................. 595
Validation Colors ............................................................................ 597Substitutions ................................................................................. 598Select Column(s)............................................................................ 598
Application Options - Apache Log4j .......................................................... 599LOG4J Connections Tab................................................................... 599LOG4J Options Tab ......................................................................... 600
Deployment - Apache Log4j .................................................................... 601System Requirements and Setup ...................................................... 601Data Source Configuration File ......................................................... 601
Round Robin Database Data Source............................................................... 601Round Robin Database (RRD) Requirements and Setup ............................... 602
System Requirements ..................................................................... 602Attach to RRD Data ................................................................................ 602
Substitutions ................................................................................. 605Select Table Columns...................................................................... 605
Application Options - Round Robin Database.............................................. 606RTView Deployment - RRD ...................................................................... 607
System Requirements and Setup ...................................................... 607Data Source Configuration File ......................................................... 607
Round Robin Database Demos ................................................................. 607Before You Begin............................................................................ 607Data Source Demo ......................................................................... 607
RRD Data Source Command Line Options.................................................. 608
RTVAgent Data Source ................................................................................ 609System Requirements and Setup - RTVAgent ............................................. 609
System Requirements ..................................................................... 609Setup ........................................................................................... 609
Attach to RTVAgent Data......................................................................... 609Validation Colors ............................................................................ 612Substitutions ................................................................................. 612RTViewDs...................................................................................... 612Select Table Columns...................................................................... 613
Application Options - RTVAgent................................................................ 614RTVAgent Options Tab .................................................................... 614
RTView Deployment - RTVAgent............................................................... 615
RTView Core® User’s Guide ix
-
System Requirements and Setup ...................................................... 615Data Source Configuration File ......................................................... 615
Command Line Options - RTVAgent .......................................................... 615
RTV HTTP Data Source ................................................................................ 616System Requirements and Setup - RTV HTTP ............................................. 617
System Requirements ..................................................................... 617Setup ........................................................................................... 617
Attach to RTVHttp Data........................................................................... 617Validation Colors ............................................................................ 619Substitutions ................................................................................. 619Select Table Columns...................................................................... 619
Application Options - RTV HTTP................................................................ 620RTVHttp Handlers Tab ..................................................................... 621RTVHttp Options Tab....................................................................... 623
RTView Deployment - RTV HTTP............................................................... 623System Requirements and Setup ...................................................... 624Data Source Configuration File ......................................................... 624
Command Line Options - RTV HTTP .......................................................... 624
RTV HTTP Rest Data Source.......................................................................... 625System Requirements and Setup - RTV HTTP REST..................................... 625
System Requirements ..................................................................... 625Setup ........................................................................................... 625
Attach to RTVHttpRest Data..................................................................... 625Validation Colors ............................................................................ 628Substitutions ................................................................................. 628Select Table Columns...................................................................... 628
Application Options - RTV HTTP REST ....................................................... 630RTVHttpRest Options Tab ................................................................ 630
RTView Deployment - RtvHttpRest............................................................ 631System Requirements and Setup ...................................................... 631Data Source Configuration File ......................................................... 631
Command Line Options - RtvHttpRest ....................................................... 631
RTVPipe Data Source................................................................................... 632System Requirements and Setup - RTVPipe ............................................... 632
System Requirements ..................................................................... 632Setup ........................................................................................... 632
Attach to RTVPipe Data........................................................................... 632Validation Colors ............................................................................ 635Substitutions ................................................................................. 636RTViewDs...................................................................................... 636Select Table Columns...................................................................... 636
Application Options - RTVPipe .................................................................. 638RTVPipe Handlers Tab ..................................................................... 638
RTView Deployment - RTVPipe ................................................................. 639Data Source Configuration File ......................................................... 639
Command Line Options - RTVPipe ............................................................ 639
x RTView Core® User’s Guide
-
SNMP Data Source ...................................................................................... 640System Requirements and Setup - SNMP .................................................. 640
System Requirements ..................................................................... 640Setup ........................................................................................... 640
Attach to SNMP Data .............................................................................. 640Validation Colors ............................................................................ 642Substitutions ................................................................................. 643RTViewDs...................................................................................... 643
Application Options - SNMP ..................................................................... 644SNMP Connections Tab.................................................................... 644SNMP Options Tab .......................................................................... 645
RTView Deployment - SNMP .................................................................... 646Data Source Configuration File ......................................................... 646
Command Line Options - SNMP................................................................ 646
Splunk Data Source .................................................................................... 647Splunk System Requirements .................................................................. 647Attach to Splunk Data ............................................................................ 647
Validation Colors ............................................................................ 651Substitutions ................................................................................. 651Select Server Column(s) and Select Column(s)................................... 652
Application Options - Splunk.................................................................... 653Splunk Connections Tab .................................................................. 653Splunk Options Tab ........................................................................ 654
RTView Deployment - Splunk................................................................... 655System Requirements and Setup ...................................................... 655Data Source Configuration File ......................................................... 655Rich Client Browser Deployment Setup for Direct Data Connection ........ 655
SQL Data Source ........................................................................................ 655SQL System Requirements and Setup ....................................................... 656
System Requirements ..................................................................... 656Setup ........................................................................................... 656
Attach to SQL Data ................................................................................ 656Specifying a Timeout or ID For a Query ............................................. 659SQL Scheduler ............................................................................... 660Validation Colors ............................................................................ 661Substitutions ................................................................................. 662RTViewDs...................................................................................... 662Select Table Columns...................................................................... 664
Define SQL Command ............................................................................ 665Validation Colors ............................................................................ 667Substitutions ................................................................................. 668Special Values................................................................................ 668
Application Options - SQL ....................................................................... 669SQL Tab........................................................................................ 669Database Repository ....................................................................... 672Excluding Tables From The Attach To SQL Data Dialog......................... 673
RTView Core® User’s Guide xi
-
RTView Deployment - SQL ...................................................................... 673System Requirements and Setup ...................................................... 673Data Source Configuration File ......................................................... 673
SQL Demos........................................................................................... 673Before You Begin............................................................................ 673Data Source Demo ......................................................................... 674ElectroSphere Demo ....................................................................... 674
Quick Start Tutorial - SQL ....................................................................... 675Get Started ................................................................................... 675Create a Display............................................................................. 676
SQL Database Connection Setup .............................................................. 679Direct JDBC Connection................................................................... 679Database Repository File ................................................................. 679Excluding Tables From The Attach To SQL Data Dialog......................... 680
SQL Data Source - Command Line Options ................................................ 681
StreamBase Data Source ............................................................................. 683StreamBase System Requirements and Setup............................................ 684
System Requirements ..................................................................... 684Setup ........................................................................................... 684
Attach to StreamBase Data ..................................................................... 684Substitutions ................................................................................. 686RTViewDs...................................................................................... 687Select Columns Fields (Tables Only).................................................. 689
Define StreamBase Command ................................................................. 690Substitutions ................................................................................. 692Special Values................................................................................ 692
Application Options - Streambase............................................................. 693StreamBase Connections Tab ........................................................... 693StreamBase Streams Tab ................................................................ 694StreamBase History Streams Tab ..................................................... 695StreamBase Administration Tab........................................................ 696
RTView Deployment - StreamBase ........................................................... 697System Requirements and Setup ...................................................... 697Data Source Configuration File ......................................................... 697
StreamBase Demos................................................................................ 697Before You Begin............................................................................ 697Data Source Demo ......................................................................... 698
StreamBase Data Source Command Line Options ....................................... 699
TIBCO EMS Administration Data Source ......................................................... 700TIBCO EMS Administration System Requirements and Setup........................ 701
System Requirements ..................................................................... 701Setup ........................................................................................... 701
Attach to TIBCO EMS Administration Data ................................................. 701Substitutions ................................................................................. 704Select Table Columns...................................................................... 704TIBCO EMS Metrics ......................................................................... 705
xii RTView Core® User’s Guide
-
Define TIBCO EMS Administration Command ............................................. 706Command Format........................................................................... 707Substitutions ................................................................................. 709Special Values................................................................................ 709
Application Options - TIBCO EMS ............................................................. 709TIBCO EMS Administration Tab......................................................... 710TIBCO EMS Servers Tab .................................................................. 711TIBCO EMS Administration SSL Parameters........................................ 713
RTView Deployment - TIBCO EMS Administration ....................................... 714System Requirements and Setup ...................................................... 714Data Source Configuration File ......................................................... 714
TIBCO EMS Administration Data Source Command Line Options ................... 715
TIBCO Hawk Data Source............................................................................. 716TIBCO Hawk - System Requirements and Setup ......................................... 717
System Requirements ..................................................................... 717Setup ........................................................................................... 717
Attach to TIBCO Hawk Data..................................................................... 717Validation Colors ............................................................................ 720Substitutions ................................................................................. 720Special Values................................................................................ 720RTViewDs...................................................................................... 722Select Columns .............................................................................. 725
Define TIBCO Hawk Command................................................................. 726Validation Colors ............................................................................ 728Substitutions ................................................................................. 729Special Values................................................................................ 729
TIBCO Hawk Data Source Substitutions..................................................... 731Application Options - TIBCO Hawk............................................................ 731
TIBCO Hawk Communication Tab...................................................... 731TIBCO Hawk Methods and Alerts Tab................................................. 734TIBCO Hawk Agent and Microagent Groups Tab .................................. 737TIBCO Hawk SSL Parameters ........................................................... 739
RTView Deployment - TIBCO Hawk........................................................... 740System Requirements and Setup ...................................................... 740Data Source Configuration File ......................................................... 740
TIBCO Hawk Demos ............................................................................... 740Before You Begin............................................................................ 741Data Source Demo ......................................................................... 741TIBCO Hawk Monitor Demo.............................................................. 741GI Demo ....................................................................................... 742
Quick Start Tutorial - TIBCO Hawk............................................................ 742Get Started ................................................................................... 743Create a Display............................................................................. 743
Sample TIBCO Hawk Microagent .............................................................. 746Running Hawk Spot ........................................................................ 747Method Repository.......................................................................... 747
TIBCO Hawk - Command Line Options ...................................................... 749
RTView Core® User’s Guide xiii
-
Communicating with TIBCO Hawk ............................................................ 751Running the TIBCO Rendezvous Agent Process ................................... 752Configuring the TIBCO Rendezvous Agent Process .............................. 753
TIBCO Rendezvous Data Source.................................................................... 754TIBCO Rendezvous System Requirements and Setup .................................. 755
System Requirements ..................................................................... 755Setup ........................................................................................... 755
Attach to TIBCO Rendezvous Data............................................................ 755Validation Colors ............................................................................ 758Substitutions ................................................................................. 758Special Values................................................................................ 758TIBCO Rendezvous RTViewDs Fields.................................................. 758Create TIBCO Rendezvous Message Alias ........................................... 761
Define TIBCO Rendezvous Command........................................................ 764Validation Colors ............................................................................ 766Substitutions ................................................................................. 767Special Values................................................................................ 767
TIBCO Rendezvous Data Source Substitutions............................................ 767Application Options - TIBCO Rendezvous................................................... 767
TIBCO Rendezvous Communication Tab............................................. 768TIBCO Rendezvous Monitoring Tab.................................................... 769TIBCO Rendezvous Messages Tab ..................................................... 770TIBCO Rendezvous Cache Tab.......................................................... 772
RTView Deployment - TIBCO Rendezvous.................................................. 773System Requirements and Setup ...................................................... 773Data Source Configuration File ......................................................... 773
TIBCO Rendezvous Demos ...................................................................... 773Before You Begin............................................................................ 773Data Source Demo ......................................................................... 774TIBCO Rendezvous Monitor Demo..................................................... 774
Quick Start Tutorial: TIBCO Rendezvous.................................................... 775Get Started ................................................................................... 775Create a Display............................................................................. 776
TIBCO Rendezvous Data Simulator ........................................................... 779Running the Simulator .................................................................... 780Message Repository ........................................................................ 781
TIBCO Rendezvous Data Source Command Line Options.............................. 782Communicating with TIBCO Rendezvous ................................................... 784
Running the TIBCO Rendezvous Agent Process ................................... 784Configuring the TIBCO Rendezvous Agent Process .............................. 785
XML Data Source ........................................................................................ 786XML System Requirements and Setup....................................................... 787
System Requirements ..................................................................... 787Setup ........................................................................................... 787
Attach to XML Data ................................................................................ 787Validation Colors ............................................................................ 789
xiv RTView Core® User’s Guide
-
Substitutions ................................................................................. 789RTViewDs...................................................................................... 789Select Table Columns...................................................................... 793
XML Data Source Substitutions ................................................................ 794Application Options - XML ....................................................................... 794
XML Tab........................................................................................ 794RTView Deployment - XML ...................................................................... 796
System Requirements and Setup ...................................................... 796Data Source Configuration File ......................................................... 796Setup Client................................................................................... 796
XML Demos........................................................................................... 797Before You Begin............................................................................ 797Data Source Demo ......................................................................... 797Features Demo .............................................................................. 798Geothermal Demo .......................................................................... 798
Creating XML Sources............................................................................. 799Creating and Formatting XML Data ................................................... 799Data Elements: Scalar and Tabular ................................................... 800Supported Tags and Attributes ......................................................... 801Data Simulator............................................................................... 803
XML Data Source Command Line Options .................................................. 806
Chapter 11 - Application Options ....................................................................... 807
Overview ................................................................................................... 807Setting Options in the Display Builder ....................................................... 808Setting Options via Configuration Utility .................................................... 808
Application Options Dialog............................................................................ 808General Tab........................................................................................... 810Security Tab.......................................................................................... 812Substitutions Tab ................................................................................... 813Data Server Tab..................................................................................... 814Heartbeat Tab ....................................................................................... 817
Substitutions ................................................................................. 818Date Formats Tab................................................................................... 818Globals Tab ........................................................................................... 819Custom Colors Tab ................................................................................. 820
Limitations .................................................................................... 821Style Sheet Tab ..................................................................................... 821
Chapter 12 - Deployment ................................................................................... 823
Overview ................................................................................................... 823Deployment Options............................................................................... 823Application Deployment .......................................................................... 824Browser Deployment .............................................................................. 825
Choosing The Right Deployment ....................................................... 825
Deployment Wizard..................................................................................... 827
RTView Core® User’s Guide xv
-
Setting up your Project for the Deployment Wizard..................................... 827Running the Deployment Wizard .............................................................. 828
Command Line Options ................................................................... 829Building Deployments............................................................................. 829Upgrading Deployments.......................................................................... 829
Data Server ............................................................................................... 829Data Access .......................................................................................... 830Data Centralization ................................................................................ 830Data Reduction/Aggregation.................................................................... 830Scalability ............................................................................................. 831High Availability..................................................................................... 831Security................................................................................................ 832
Access List Process Flow.................................................................. 832Specifying Client Lists ..................................................................... 833Graylist and SSL Certificates ............................................................ 834SSL Encryption Without Certificates .................................................. 836Troubleshooting Client Connection Requests....................................... 837
Running the Data Server......................................................................... 837Run the Data Server: Windows or UNIX............................................. 838Configuration Tab........................................................................... 838Console Tab................................................................................... 841Clients Tab .................................................................................... 841Server Group Tab ........................................................................... 842
Managing the Data Server Using JMX........................................................ 843RTViewDataServer:name=Manager................................................... 844RTView:name=Troubleshooting ........................................................ 845Running as a Windows Service ......................................................... 846
Data Servlet.......................................................................................... 851Install Data Servlet......................................................................... 851Data Servlet Options....................................................................... 851
High Availability Configurations..................................................................... 852High Availability Historian........................................................................ 852High Availability Deployments.................................................................. 852
Display Viewer Application ............................................................... 853AJAX/Flex Thin Client ...................................................................... 855
Application Deployment ............................................................................... 860Served Data Versus Direct Data Connection............................................... 860
Application with Served Data ........................................................... 861Application with Direct Data Connection............................................. 862
Application with Served Data - Manual Deployment Process ......................... 862Process Summary........................................................................... 862Application with Served Data - Manual Setup ..................................... 863
Application with Direct Data Connection - Manual Deployment Process .......... 870Process Summary........................................................................... 870Application with Direct Data Connection - Manual Setup....................... 870
Display Viewer Application ...................................................................... 872System Requirements ..................................................................... 872
xvi RTView Core® User’s Guide
-
Configuration ................................................................................. 872RTV_JAVAOPTS .............................................................................. 873Start the Display Viewer Application.................................................. 873View Options ................................................................................. 873
Browser Deployment ................................................................................... 873Thin Client Browser Deployment ....................................................... 873Served Data Versus Direct Data Connection ....................................... 874Pros and Cons................................................................................ 875Thin Client Browser with Served Data................................................ 875Thin Client Browser with Direct Data Connection................................. 876Thin Client Browser with Served Data - Manual Deployment Process...... 877Thin Client Browser with Served Data - Manual Setup.......................... 878Thin Client Browser with Direct Data - Manual Deployment Process ....... 887Thin Client Browser with Direct Data - Manual Setup ........................... 887Display Server ............................................................................... 892
Chapter 13 - Reporting ...................................................................................... 919
Overview ................................................................................................... 919
On Demand Reporting ................................................................................. 919Generating Reports with the Display Builder .............................................. 920Generating Reports with the Display Viewer............................................... 920Generating Reports with the Thin Client Browser ........................................ 920Localizing Reports .................................................................................. 920
Automatic Report Generation........................................................................ 922Starting Automatic Report Generation....................................................... 922Customizing a Report ............................................................................. 922
Chapter 14 - Alerts ............................................................................................ 927
Overview ................................................................................................... 927Adding Alerts ........................................................................................ 928Alert Definition Files ............................................................................... 929
Creating a Reusable Alert Definition File ............................................ 929Scheduling Alerts ................................................................................... 929
Applying Schedules to Alerts ............................................................ 930Monitoring Scheduling Events........................................................... 931
Running the Alert Engine ........................................................................ 931Alert Behavior ....................................................................................... 932
Alert Execution............................................................................... 932Cleared Alerts ................................................................................ 932Viewing Alerts................................................................................ 932Managing Alerts ............................................................................. 937
Alert Types: Limits, Discrete, Multi State, and Event ........................................ 937Limits Alerts.......................................................................................... 938
Threshold Values............................................................................ 938Alert Text Values ............................................................................ 940
RTView Core® User’s Guide xvii
-
Alert Command Text Values ............................................................. 941Limits Alert Properties ..................................................................... 942
Discrete Alerts....................................................................................... 948Threshold Values............................................................................ 948Alert Text Values ............................................................................ 950Alert Command Text Values ............................................................. 951Discrete Alert Properties.................................................................. 952
Multi State Alerts ................................................................................... 958Event Alerts .......................................................................................... 972
Attach to Alert Data .................................................................................... 979Attach to Alert Data Dialog...................................................................... 980Substitutions......................................................................................... 983Select Table Columns ............................................................................. 983
Define Alert Command ................................................................................ 984Define Alert Command Dialog .................................................................. 984Command Types .................................................................................... 985Substitutions......................................................................................... 988Special Values ....................................................................................... 988
Application Options - Alerts .......................................................................... 989Overview .............................................................................................. 989Alerts Tab ............................................................................................. 990Alert Definitions Tab ............................................................................... 992Self Service Alerts Tab ............................................................................ 994Custom Alert Fields Tab .......................................................................... 995Alert Persistence Tab .............................................................................. 997Global Notifications Tab........................................................................... 999
Self Service Alerts..................................................................................... 1000Overview ............................................................................................ 1000Alert Settings Table .............................................................................. 1001Self Service Audit Table ........................................................................ 1002Alert Construction Limitations ................................................................ 1003Self Service Alert Demo ........................................................................ 1003
Running the Demo........................................................................ 1003Alert Detail Table.......................................................................... 1004Alert Administration ...................................................................... 1008Tabular Alert Administration........................................................... 1010Administration Audit ..................................................................... 1011Alert Action Audit Trail .................................................................. 1012Modify the Stand-Alone Demo ........................................................ 1012Customization Options .................................................................. 1013Integrate the Demo into an RTView Application ................................ 1015
Alert Persistence....................................................................................... 1016Overview ............................................................................................ 1017Database Configuration ........................................................................ 1018Alert Engine Configuration..................................................................... 1018Alert Persistence Requirements and Limitations........................................ 1019
xviii RTView Core® User’s Guide
-
Requirements .............................................................................. 1019Limitations .................................................................................. 1019
Audit Alert Action...................................................................................... 1020Overview ............................................................................................ 1020Alert Action Audit Database................................................................... 1021Alert Action Audit Table......................................................................... 1021
Chapter 15 - Caches......................................................................................... 1023
Overview ................................................................................................. 1023Extend with SQL .................................................................................. 1024Data Compaction ................................................................................. 1024Adding Caches..................................................................................... 1024
Cache Definition Files.................................................................... 1025Viewing Caches ............................................................................ 1025
Table Cache ........................................................................................ 1025Cache Properties .......................................................................... 1026Cache Current Table Properties ...................................................... 1027Cache History Table Properties ....................................................... 1029Data Properties ............................................................................ 1031Data Compaction: Primary (in-memory) Properties ........................... 1032Data Compaction: Secondary (Historian) Properties .......................... 1034Historian Properties ...................................................................... 1034Object Properties.......................................................................... 1035
Double Cache ...................................................................................... 1036Cache Properties .......................................................................... 1036Cache History Table Properties ....................................................... 1036Data Properties ............................................................................ 1037Historian Properties ...................................................................... 1037Object Properties.......................................................................... 1038
Attach to Cache Data ................................................................................ 1038Attach To Cache Data - Filter Modes ....................................................... 1039
Filter Rows Off ............................................................................. 1039Filter Rows: Basic ......................................................................... 1041Filter Rows: Advanced................................................................... 1044Validation Colors .......................................................................... 1046Substitutions ............................................................................... 1047RTViewDs.................................................................................... 1047Select Table Columns.................................................................... 1049
Define Cache Command............................................................................. 1050Substitutions....................................................................................... 1051Special Values ..................................................................................... 1051
Application Options -- Caches ..................................................................... 1052
Chapter 16 - CMDB........................................................................................... 1055
Overview ................................................................................................. 1055
RTView Core® User’s Guide xix
-
What is a CMDB? ................................................................................. 1055How is a CMDB used? ........................................................................... 1056
Why would I want to use a CMDB with my RTView solution?............... 1056Configuration Requirements .................................................................. 1057Deployment ........................................................................................ 1057
Centralized Connection Repository .................................................. 1057Service and Component Centric View of Data for Display Construction . 1058
CMDB Configuration .................................................................................. 1059Overview ............................................................................................ 1059Creating CMDB Caches ......................................................................... 1061CMDB Configuration Tables.................................................................... 1062
Metric Source Table ...................................................................... 1063CMDB - Metric Source Table - Connection Information ....................... 1064Container Table............................................................................ 1073Metric Source Type Table............................................................... 1074Permission Table .......................................................................... 1074Relationship Table ........................................................................ 1075
Application Options - CMDB................................................................... 1076CMDB Tables Tab ......................................................................... 1076RTView Server CMDB Settings Tab.................................................. 1078
Deploying CMDB Caches ....................................................................... 1078Steps for Deploying Caches ........................................................... 1079
Creating Composites ............................................................................ 1080
Attach to CMDB Data................................................................................. 1081Validation Colors.................................................................................. 1083Substitutions....................................................................................... 1084Select Columns.................................................................................... 1084
RTView Deployment - CMDB....................................................................... 1085Deploy CMDB Caches ........................................................................... 1085Configuration Files ............................................................................... 1085
Troubleshooting - CMDB............................................................................. 1086Display Builder .................................................................................... 1086Display Builder\Display Viewer\Display Server ......................................... 1087Data Server ........................................................................................ 1088
Command Line Options - CMDB .................................................................. 1088
Chapter 17 - Historian ..................................................................................... 1091
Overview ................................................................................................. 1091Use Cases for Historical Data................................................................. 1091
Configuring the Historian ........................................................................... 1092Data Configuration File Options ...................................................... 1092Display Files ................................................................................ 1093Cache Definition Files.................................................................... 1093
Basic Steps To Configure the Historian .................................................... 1093Display File Configuration...................................................................... 1094
xx RTView Core® User’s Guide
-
Numeric Data Table ...................................................................... 1095String Data Table ......................................................................... 1096
Cache Definition File Configuration ......................................................... 1097Database Connection Configuration ........................................................ 1098
Direct JDBC Connection................................................................. 1098Historian Application Configuration ......................................................... 1099Configuring Failover on the Historian ...................................................... 1103
High Availability Historians............................................................. 1103
Starting the Historian ................................................................................ 1105Rebuilding Historian Tables ............................................................ 1105
The Historian Application ...................................................................... 1106
Building a Display Using History Data .......................................................... 1109Enable valueHistoryFlag........................................................................ 1110Creating a SQL Data Attachment............................................................ 1110Extend with SQL .................................................................................. 1110
Managing the Historian Using JMX............................................................... 1111
Advanced Historian ................................................................................... 1112Data Aggregation................................................................................. 1112
Single Versus Multiple Tables ......................................................... 1113Configuring Data Aggregation ........................................................ 1114
Table Displacement .............................................................................. 1119Configuring Table Displacement...................................................... 1120Add a Display (.rtv) File to the Historian Application .......................... 1122
Advanced Historian - Cache Properties.................................................... 1124Compaction GroupBy Columns ....................................................... 1124Compaction Rules......................................................................... 1125
Chapter 18 - Optimizing Performance .............................................................. 1127
Overview - Display Sharing ........................................................................ 1127How It Works ...................................................................................... 1127Configuring Display Sharing .................................................................. 1128Monitoring Display Sharing.................................................................... 1129Thin Client .......................................................................................... 1130Limitations.......................................................................................... 1130
Chapter 19 - Troubleshooting & Monitoring ..................................................... 1131
Overview ................................................................................................. 1131Troubleshooting Tools ........................................................................... 1131Troubleshooting Steps .......................................................................... 1132
RTView Monitor ........................................................................................ 1133Configuring the RTView Monitor ............................................................. 1134
Basic Steps To Configure the RTView Monitor ................................... 1134Starting the RTView Monitor .................................................................. 1138Verifying Your Setup............................................................................. 1139Using RTView Monitor ........................................................................... 1140
RTView Core® User’s Guide xxi
-
JVM Details.................................................................................. 1143App Details.................................................................................. 1145RTView Details ............................................................................. 1150
Java Tools................................................................................................ 1151Check CPU and Memory Usage .............................................................. 1151
JConsole ..................................................................................... 1151Jmap Utility ................................................................................. 1153
Check Application and CPU Bottlenecks ................................................... 1154Thread Dumps ............................................................................. 1154Obtaining the RTView PID.............................................................. 1155
Log Files.................................................................................................. 1155RTView Log Files.................................................................................. 1156
Obtaining Log Files ....................................................................... 1156Formatting Log Files ..................................................................... 1157Rolling Log Files ........................................................................... 1160Windows Service Viewer................................................................ 1160Using JMX Access to Log Trace Levels ............................................. 1160
Tomcat Log Files .................................................................................. 1165Display Server ............................................................................. 1165Data Server ................................................................................. 1165Tomcat and Linux......................................................................... 1165Tomcat and Windows ....................