rtview core® user’s guidesldownloads.sl.com/docs/rtview_userguide_6.9.pdf · 2017-01-11 · iv...

RTView Core® User’s Guide

Version 6.9

RTView Core®

Copyright © 1998-2017. 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-2017 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 ............................................................................ 45Control Objects ............................................................................... 51Fx Graphs ...................................................................................... 93Graph Objects................................................................................ 135Indicator Objects............................................................................ 251Labels Objects ............................................................................... 282Meter Objects ................................................................................ 313Link Objects .................................................................................. 318Scale Objects................................................................................. 326Table Objects................................................................................. 364

Style Sheets .............................................................................................. 408Creating Style Sheets ............................................................................. 409

Style Class Names .......................................................................... 410Style Groups.................................................................................. 411Object Properties............................................................................ 412

Application Options Style Sheets .............................................................. 414Display-Specific Style Sheets................................................................... 415Built-In Style Sheets .............................................................................. 416

Drill Down Displays ..................................................................................... 417Drill Down Targets.................................................................................. 417Drill Down Properties.............................................................................. 417Drill Down Column Substitutions Dialog .................................................... 420

Substitutions.............................................................................................. 421Linking Substitutions with Variables.......................................................... 421Drill Down Substitutions.......................................................................... 422

Attach to Data............................................................................................ 423Substitutions......................................................................................... 424Row Filtering ......................................................................................... 424

Define/Execute Command............................................................................ 425Commands ........................................................................................... 425

Define Command............................................................................ 425Execute Command.......................................................................... 425Command Confirmation................................................................... 426Close Window Command ................................................................. 426

Threshold Commands ............................................................................. 426Define Threshold Command ............................................................. 427Execute Threshold Command ........................................................... 427

Open/Close Display Commands................................................................ 427Define Open/Close Display Command................................................ 427Execute Open/Close Display Command.............................................. 427

Multiple Commands................................................................................ 428Define Multiple Commands .............................................................. 428Execute Multiple Commands ............................................................ 428

Command Failure................................................................................... 428Define System Command........................................................................ 429

RTView Core® User’s Guide v

Command Types ............................................................................ 429Execute Commands on a Data Server................................................ 432Substitutions ................................................................................. 433Special Values ............................................................................... 433

File Options................................................................................................ 433Working with Files.................................................................................. 433

Creating a New Display (.rtv) File ..................................................... 433Opening a Display (.rtv) File ............................................................ 434Saving a Display (.rtv) File .............................................................. 434Printing a Display (.rtv) File ............................................................. 434

Background Properties................................................................................. 435

View Options.............................................................................................. 439

Multiple Display Panels ................................................................................ 439Configuring Multiple Display Panels........................................................... 439

Display Viewer Application ............................................................... 439Display Server ............................................................................... 439

PANELS.ini ............................................................................................ 440Example 1 ..................................................................................... 443Example 2 ..................................................................................... 443Synchronizing Drill-down and Navigation Controls............................... 444

Style Sheets.......................................................................................... 444Navigation Tree Definition File.................................................................. 447Tab Definition File .................................................................................. 448Viewing Multiple Display Panels................................................................ 449

Display Viewer Application ............................................................... 449Display Server ............................................................................... 449

Include Display Files.................................................................................... 450Functions.............................................................................................. 450Variables .............................................................................................. 451Objects ................................................................................................ 451

Chapter 8 - Functions......................................................................................... 453

Add/Edit Functions...................................................................................... 453Adding Functions ................................................................................... 453Editing Functions ................................................................................... 455Function Types ...................................................................................... 456

Scalar Functions............................................................................. 456Tabular Functions ........................................................................... 471

Attach to Function Data ............................................................................... 498Validation Colors.................................................................................... 500Substitutions......................................................................................... 500Select Columns...................................................................................... 500

Global Functions and Variables ..................................................................... 501Creating a Global Definition File ............................................................... 502

Creating a Reusable Global Definition File .......................................... 502

vi RTView Core® User’s Guide

Adding a Global Definition File to Application Options........................... 502Viewing Global Data........................................................................ 503

Chapter 9 - Variables ......................................................................................... 505

Add/Edit Variables....................................................................................... 505Linking Substitutions with Variables.......................................................... 505

Attach to Variable Data................................................................................ 506Validation Colors.................................................................................... 507

Global Functions and Variables ..................................................................... 508Creating a Global Definition File ............................................................... 508

Creating a Reusable Global Definition File .......................................... 509Adding a Global Definition File to Application Options .................................. 509Viewing Global Data ............................................................................... 509

Chapter 10 - RTView Data Sources..................................................................... 511

IBM WebSphere MQ Data Source .................................................................. 513System Requirements and Setup - IBMMQ............................................... 513

System Requirements ..................................................................... 513Setup ........................................................................................... 513

Attach to IBMMQ Data ............................................................................ 514Validation Colors ............................................................................ 516Substitutions ................................................................................. 517Select Object Name(s) .................................................................... 517Select Columns .............................................................................. 518

Application Options - IBMMQ ................................................................... 518IBMMQ Connections Tab.................................................................. 518IBMMQ Options Tab ........................................................................ 521

RTView Deployment - IBMMQ .................................................................. 521System Requirements and Setup ...................................................... 521Data Source Configuration File ......................................................... 521

Command Line Options - IBMMQ.............................................................. 522

JMS Data Source ........................................................................................ 522JMS System Requirements and Setup ....................................................... 523


Attach to JMS Data ................................................................................ 523Validation Colors ............................................................................ 526Substitutions ................................................................................. 527Special Values................................................................................ 527Select Message Fields (Tables Only).................................................. 527Create JMS Message Alias................................................................ 528

Define JMS Command Window................................................................. 532Substitutions ................................................................................. 534Special Values................................................................................ 534

JMS Data Source Substitutions ................................................................ 535

RTView Core® User’s Guide vii

Application Options -- JMS ...................................................................... 535JMS Options Tab ............................................................................ 536JMS Messages Tab.......................................................................... 536JMS Connections Tab ...................................................................... 537JMS JNDI Connections Tab............................................................... 540

JMS Handler.......................................................................................... 542RTView Deployment - JMS....................................................................... 544

System Requirements and Setup ...................................................... 544Data Source Configuration File ......................................................... 544Setup Client................................................................................... 544

JMS Demos ........................................................................................... 544Before You Begin............................................................................ 545Data Source Demo ......................................................................... 545

Quick Start Tutorial: JMS ........................................................................ 545Get Started ................................................................................... 546Create a Display............................................................................. 547

JMS Data Simulator................................................................................ 550Running the Simulator .................................................................... 551

JMS Data Source Command Line Options .................................................. 556

JMX Data Source ........................................................................................ 557System Requirements and Setup - JMX..................................................... 558


Attach to JMX Data ................................................................................ 559Validation Colors ............................................................................ 561Substitutions ................................................................................. 561RTViewDs...................................................................................... 562Special Values................................................................................ 562Select Multiple Attributes/Operations or Attribute Fields (Tables Only) ... 563

Define JMX Command............................................................................. 564Substitutions ................................................................................. 566Special Values................................................................................ 566

Substitutions - JMX ................................................................................ 566Application Options - JMX........................................................................ 567

JMX Administration Tab ................................................................... 567JMX Connections Tab ...................................................................... 569JMX Connection Groups Tab............................................................. 571Connecting to Multiple Secure Servers............................................... 571

RTView Deployment - JMX....................................................................... 576System Requirements and Setup ...................................................... 576Data Source Configuration File ......................................................... 576

Demos - JMX......................................................................................... 577Before You Begin............................................................................ 577Data Source Demo ......................................................................... 577JMX Monitor Demo.......................................................................... 578

Quick Start Tutorial: JMX ........................................................................ 578Get Started ................................................................................... 578

viii RTView Core® User’s Guide

Create A Display............................................................................. 579Sample JMX Application .......................................................................... 583JMX Data Source Command Line Options .................................................. 585

Command Line Arguments............................................................... 585

Apache log4j Data Source ............................................................................ 588System Requirements - Apache log4j........................................................ 589Setup - Apache log4j.............................................................................. 589Attach to Log4j Data .............................................................................. 589

Validation Colors ............................................................................ 591Substitutions ................................................................................. 592Select Column(s)............................................................................ 592

Application Options - Apache Log4j .......................................................... 593LOG4J Connections Tab................................................................... 593LOG4J Options Tab ......................................................................... 594

Deployment - Apache Log4j .................................................................... 595System Requirements and Setup ...................................................... 595Data Source Configuration File ......................................................... 595

OLAP Data Source....................................................................................... 595OLAP System Requirements and Setup ..................................................... 596


Attach to OLAP Data............................................................................... 596Validation Colors ............................................................................ 599Substitutions ................................................................................. 599Selecting Column, Row, and Slicer Dimensions ................................... 599Sample Databases.......................................................................... 600

Application Options - OLAP...................................................................... 600OLAP Tab ...................................................................................... 601Sample Databases.......................................................................... 603

RTView Deployment - OLAP..................................................................... 603System Requirements and Setup ...................................................... 603Data Source Configuration File ......................................................... 603

OLAP Demos ......................................................................................... 604Before You Begin............................................................................ 604Data Source Demo ......................................................................... 604

Quick Start: OLAP Data .......................................................................... 605Import an OLAP Database................................................................ 605Add an OLAP Database.................................................................... 605Attach to OLAP Data ....................................................................... 608Set a Drill Down Target on a Table Object.......................................... 609

OLAP Database Connection Setup ............................................................ 610Sample Databases.......................................................................... 610

OLAP Data Source Command Line Options................................................. 612

Round Robin Database Data Source............................................................... 613Round Robin Database (RRD) Requirements and Setup ............................... 614

System Requirements ..................................................................... 614

RTView Core® User’s Guide ix

Attach to RRD Data ................................................................................ 614Substitutions ................................................................................. 617Select Table Columns...................................................................... 617

Application Options - Round Robin Database.............................................. 618RTView Deployment - RRD ...................................................................... 619

System Requirements and Setup ...................................................... 619Data Source Configuration File ......................................................... 619

Round Robin Database Demos ................................................................. 619Before You Begin............................................................................ 619Data Source Demo ......................................................................... 619

RRD Data Source Command Line Options.................................................. 620

RTVAgent Data Source ................................................................................ 621System Requirements and Setup - RTVAgent ............................................. 621


Attach to RTVAgent Data......................................................................... 621Validation Colors ............................................................................ 624Substitutions ................................................................................. 624RTViewDs...................................................................................... 624Select Table Columns...................................................................... 625

Application Options - RTVAgent................................................................ 626RTVAgent Options Tab .................................................................... 626

RTView Deployment - RTVAgent............................................................... 627System Requirements and Setup ...................................................... 627Data Source Configuration File ......................................................... 627

Command Line Options - RTVAgent .......................................................... 627

RTV HTTP Data Source ................................................................................ 628System Requirements and Setup - RTV HTTP ............................................. 629


Attach to RTVHttp Data........................................................................... 629Validation Colors ............................................................................ 631Substitutions ................................................................................. 631Select Table Columns...................................................................... 631

Application Options - RTV HTTP................................................................ 632RTVHttp Handlers Tab ..................................................................... 633RTVHttp Options Tab....................................................................... 635

RTView Deployment - RTV HTTP............................................................... 635System Requirements and Setup ...................................................... 636Data Source Configuration File ......................................................... 636

Command Line Options - RTV HTTP .......................................................... 636

RTV HTTP Rest Data Source.......................................................................... 637System Requirements and Setup - RTV HTTP REST..................................... 637


Attach to RTVHttpRest Data..................................................................... 637

x RTView Core® User’s Guide

Validation Colors ............................................................................ 640Substitutions ................................................................................. 640Select Table Columns...................................................................... 640

Application Options - RTV HTTP REST ....................................................... 642RTVHttpRest Options Tab ................................................................ 642

RTView Deployment - RtvHttpRest............................................................ 643System Requirements and Setup ...................................................... 643Data Source Configuration File ......................................................... 643

Command Line Options - RtvHttpRest ....................................................... 643

RTVPipe Data Source................................................................................... 644System Requirements and Setup - RTVPipe ............................................... 644


Attach to RTVPipe Data........................................................................... 644Validation Colors ............................................................................ 647Substitutions ................................................................................. 648RTViewDs...................................................................................... 648Select Table Columns...................................................................... 648

Application Options - RTVPipe .................................................................. 650RTVPipe Handlers Tab ..................................................................... 650

RTView Deployment - RTVPipe ................................................................. 651Data Source Configuration File ......................................................... 651

Command Line Options - RTVPipe ............................................................ 651

SNMP Data Source ...................................................................................... 652System Requirements and Setup - SNMP .................................................. 652


Attach to SNMP Data .............................................................................. 652Validation Colors ............................................................................ 654Substitutions ................................................................................. 655RTViewDs...................................................................................... 655

Application Options - SNMP ..................................................................... 656SNMP Connections Tab.................................................................... 656SNMP Options Tab .......................................................................... 657

RTView Deployment - SNMP .................................................................... 658Data Source Configuration File ......................................................... 658

Command Line Options - SNMP................................................................ 658

Splunk Data Source .................................................................................... 659Splunk System Requirements .................................................................. 659Attach to Splunk Data ............................................................................ 659

Validation Colors ............................................................................ 663Substitutions ................................................................................. 663Select Server Column(s) and Select Column(s)................................... 664

Application Options - Splunk.................................................................... 665Splunk Connections Tab .................................................................. 665Splunk Options Tab ........................................................................ 666

RTView Core® User’s Guide xi

RTView Deployment - Splunk................................................................... 667System Requirements and Setup ...................................................... 667Data Source Configuration File ......................................................... 667Rich Client Browser Deployment Setup for Direct Data Connection ........ 667

SQL Data Source ........................................................................................ 667SQL System Requirements and Setup ....................................................... 668


Attach to SQL Data ................................................................................ 668Specifying a Timeout or ID For a Query ............................................. 671SQL Scheduler ............................................................................... 672Validation Colors ............................................................................ 675Substitutions ................................................................................. 676RTViewDs...................................................................................... 676Select Table Columns...................................................................... 678

Define SQL Command ............................................................................ 679Validation Colors ............................................................................ 681Substitutions ................................................................................. 682Special Values................................................................................ 682

Application Options - SQL ....................................................................... 683SQL Tab........................................................................................ 683Database Repository ....................................................................... 686Excluding Tables From The Attach To SQL Data Dialog......................... 687

RTView Deployment - SQL ...................................................................... 687System Requirements and Setup ...................................................... 687Data Source Configuration File ......................................................... 687

SQL Demos........................................................................................... 687Before You Begin............................................................................ 687Data Source Demo ......................................................................... 688ElectroSphere Demo ....................................................................... 688

Quick Start Tutorial - SQL ....................................................................... 689Get Started ................................................................................... 689Create a Display............................................................................. 690

SQL Database Connection Setup .............................................................. 693Direct JDBC Connection................................................................... 693Database Repository File ................................................................. 693Excluding Tables From The Attach To SQL Data Dialog......................... 694

SQL Data Source - Command Line Options ................................................ 695

StreamBase Data Source ............................................................................. 697StreamBase System Requirements and Setup............................................ 698


Attach to StreamBase Data ..................................................................... 698Substitutions ................................................................................. 700RTViewDs...................................................................................... 701Select Columns Fields (Tables Only).................................................. 703

xii RTView Core® User’s Guide

Define StreamBase Command ................................................................. 704Substitutions ................................................................................. 706Special Values................................................................................ 706

Application Options - Streambase............................................................. 707StreamBase Connections Tab ........................................................... 707StreamBase Streams Tab ................................................................ 708StreamBase History Streams Tab ..................................................... 709StreamBase Administration Tab........................................................ 710

RTView Deployment - StreamBase ........................................................... 711System Requirements and Setup ...................................................... 711Data Source Configuration File ......................................................... 711

StreamBase Demos................................................................................ 711Before You Begin............................................................................ 711Data Source Demo ......................................................................... 712

StreamBase Data Source Command Line Options ....................................... 713

TIBCO EMS Administration Data Source ......................................................... 714TIBCO EMS Administration System Requirements and Setup........................ 715


Attach to TIBCO EMS Administration Data ................................................. 715Substitutions ................................................................................. 718Select Table Columns...................................................................... 718TIBCO EMS Metrics ......................................................................... 719

Define TIBCO EMS Administration Command ............................................. 720Command Format........................................................................... 721Substitutions ................................................................................. 723Special Values................................................................................ 723

Application Options - TIBCO EMS ............................................................. 723TIBCO EMS Administration Tab......................................................... 724TIBCO EMS Servers Tab .................................................................. 725TIBCO EMS Administration SSL Parameters........................................ 727

RTView Deployment - TIBCO EMS Administration ....................................... 728System Requirements and Setup ...................................................... 728Data Source Configuration File ......................................................... 728

TIBCO EMS Administration Data Source Command Line Options ................... 729

TIBCO Hawk Data Source............................................................................. 730TIBCO Hawk - System Requirements and Setup ......................................... 731


Attach to TIBCO Hawk Data..................................................................... 731Validation Colors ............................................................................ 734Substitutions ................................................................................. 734Special Values................................................................................ 734RTViewDs...................................................................................... 736Select Columns .............................................................................. 739

Define TIBCO Hawk Command................................................................. 740

RTView Core® User’s Guide xiii

Validation Colors ............................................................................ 742Substitutions ................................................................................. 743Special Values................................................................................ 743

TIBCO Hawk Data Source Substitutions..................................................... 745Application Options - TIBCO Hawk............................................................ 745

TIBCO Hawk Communication Tab...................................................... 745TIBCO Hawk Methods and Alerts Tab................................................. 748TIBCO Hawk Agent and Microagent Groups Tab .................................. 751TIBCO Hawk SSL Parameters ........................................................... 753

RTView Deployment - TIBCO Hawk........................................................... 754System Requirements and Setup ...................................................... 754Data Source Configuration File ......................................................... 754

TIBCO Hawk Demos ............................................................................... 754Before You Begin............................................................................ 755Data Source Demo ......................................................................... 755TIBCO Hawk Monitor Demo.............................................................. 755GI Demo ....................................................................................... 756

Quick Start Tutorial - TIBCO Hawk............................................................ 756Get Started ................................................................................... 757Create a Display............................................................................. 757

Sample TIBCO Hawk Microagent .............................................................. 760Running Hawk Spot ........................................................................ 761Method Repository.......................................................................... 761

TIBCO Hawk - Command Line Options ...................................................... 763Communicating with TIBCO Hawk ............................................................ 765

Running the TIBCO Rendezvous Agent Process ................................... 766Configuring the TIBCO Rendezvous Agent Process .............................. 767

TIBCO Rendezvous Data Source.................................................................... 768TIBCO Rendezvous System Requirements and Setup .................................. 769


Attach to TIBCO Rendezvous Data............................................................ 769Validation Colors ............................................................................ 772Substitutions ................................................................................. 772Special Values................................................................................ 772TIBCO Rendezvous RTViewDs Fields.................................................. 772Create TIBCO Rendezvous Message Alias ........................................... 775

Define TIBCO Rendezvous Command........................................................ 778Validation Colors ............................................................................ 780Substitutions ................................................................................. 781Special Values................................................................................ 781

TIBCO Rendezvous Data Source Substitutions............................................ 781Application Options - TIBCO Rendezvous................................................... 781

TIBCO Rendezvous Communication Tab............................................. 782TIBCO Rendezvous Monitoring Tab.................................................... 783TIBCO Rendezvous Messages Tab ..................................................... 784TIBCO Rendezvous Cache Tab.......................................................... 786

xiv RTView Core® User’s Guide

RTView Deployment - TIBCO Rendezvous.................................................. 787System Requirements and Setup ...................................................... 787Data Source Configuration File ......................................................... 787

TIBCO Rendezvous Demos ...................................................................... 787Before You Begin............................................................................ 787Data Source Demo ......................................................................... 788TIBCO Rendezvous Monitor Demo..................................................... 788

Quick Start Tutorial: TIBCO Rendezvous.................................................... 789Get Started ................................................................................... 789Create a Display............................................................................. 790

TIBCO Rendezvous Data Simulator ........................................................... 793Running the Simulator .................................................................... 794Message Repository ........................................................................ 795

TIBCO Rendezvous Data Source Command Line Options.............................. 796Communicating with TIBCO Rendezvous ................................................... 798

Running the TIBCO Rendezvous Agent Process ................................... 798Configuring the TIBCO Rendezvous Agent Process .............................. 799

WMI Data Source........................................................................................ 800WMI System Requirements and Setup ...................................................... 801

System Requirements ..................................................................... 801Setup ........................................................................................... 801Troubleshooting ............................................................................. 801

Attach to WMI Data................................................................................ 801Validation Colors ............................................................................ 804Substitutions ................................................................................. 804Select Column(s)............................................................................ 804WQL Query Statements ................................................................... 805

Application Options - WMI....................................................................... 805WMI Connections Tab ..................................................................... 806WMI Options Tab............................................................................ 808

RTView Deployment - WMI...................................................................... 808System Requirements and Setup ...................................................... 808Data Source Configuration File ......................................................... 808

XML Data Source ........................................................................................ 809XML System Requirements and Setup....................................................... 809


Attach to XML Data ................................................................................ 810Validation Colors ............................................................................ 811Substitutions ................................................................................. 812RTViewDs...................................................................................... 812Select Table Columns...................................................................... 815

XML Data Source Substitutions ................................................................ 816Application Options - XML ....................................................................... 817

XML Tab........................................................................................ 817RTView Deployment - XML ...................................................................... 819

System Requirements and Setup ...................................................... 819

RTView Core® User’s Guide xv

Data Source Configuration File ......................................................... 819Setup Client................................................................................... 819

XML Demos........................................................................................... 819Before You Begin............................................................................ 819Data Source Demo ......................................................................... 820Features Demo .............................................................................. 820Geothermal Demo .......................................................................... 821

Creating XML Sources............................................................................. 822Creating and Formatting XML Data ................................................... 822Data Elements: Scalar and Tabular ................................................... 822Supported Tags and Attributes ......................................................... 824Data Simulator............................................................................... 826

XML Data Source Command Line Options .................................................. 828

Chapter 11 - Application Options ....................................................................... 831

Overview ................................................................................................... 831Setting Options in the Display Builder ....................................................... 832Setting Options via Configuration Utility .................................................... 832

Application Options Dialog............................................................................ 832General Tab........................................................................................... 834Security Tab.......................................................................................... 836Substitutions Tab ................................................................................... 837Data Server Tab..................................................................................... 838Heartbeat Tab ....................................................................................... 841

Substitutions ................................................................................. 842Date Formats Tab................................................................................... 842Globals Tab ........................................................................................... 843Custom Colors Tab ................................................................................. 844

Limitations .................................................................................... 845Style Sheet Tab ..................................................................................... 845

Chapter 12 - Deployment ................................................................................... 847

Overview ................................................................................................... 847Deployment Options............................................................................... 847Application Deployment .......................................................................... 848Browser Deployment .............................................................................. 849

Choosing The Right Deployment ....................................................... 849

Deployment Wizard..................................................................................... 851Setting up your Project for the Deployment Wizard..................................... 851Running the Deployment Wizard .............................................................. 852

Command Line Options ................................................................... 853Building Deployments............................................................................. 853Upgrading Deployments.......................................................................... 853

Data Server ............................................................................................... 853Data Access .......................................................................................... 854Data Centralization ................................................................................ 854

xvi RTView Core® User’s Guide

Data Reduction/Aggregation.................................................................... 854Scalability ............................................................................................. 855High Availability..................................................................................... 855Security................................................................................................ 856

Access List Process Flow.................................................................. 856Specifying Client Lists ..................................................................... 857Graylist and SSL Certificates ............................................................ 858SSL Encryption Without Certificates .................................................. 860Troubleshooting Client Connection Requests....................................... 861

Running the Data Server......................................................................... 861Run the Data Server: Windows or UNIX............................................. 862Configuration Tab........................................................................... 862Console Tab................................................................................... 865Clients Tab .................................................................................... 865Server Group Tab ........................................................................... 866

Managing the Data Server Using JMX........................................................ 867RTViewDataServer:name=Manager................................................... 868RTView:name=Troubleshooting ........................................................ 869Running as a Windows Service ......................................................... 870

Data Servlet.......................................................................................... 875Install Data Servlet......................................................................... 875Data Servlet Options....................................................................... 875

High Availability Configurations..................................................................... 876High Availability Historian........................................................................ 876High Availability Deployments.................................................................. 876

Display Viewer Application ............................................................... 877AJAX/Flex Thin Client ...................................................................... 879

Application Deployment ............................................................................... 884Served Data Versus Direct Data Connection............................................... 884

Application with Served Data ........................................................... 885Application with Direct Data Connection............................................. 886

Application with Served Data - Manual Deployment Process ......................... 886Process Summary........................................................................... 886Application with Served Data - Manual Setup ..................................... 887

Application with Direct Data Connection - Manual Deployment Process .......... 894Process Summary........................................................................... 894Application with Direct Data Connection - Manual Setup....................... 894

Display Viewer Application ...................................................................... 896System Requirements ..................................................................... 896Configuration ................................................................................. 896RTV_JAVAOPTS .............................................................................. 897Start the Display Viewer Application.................................................. 897View Options ................................................................................. 897

Browser Deployment ................................................................................... 897Thin Client Browser Deployment ....................................................... 897Served Data Versus Direct Data Connection ....................................... 898

RTView Core® User’s Guide xvii

Pros and Cons................................................................................ 899Thin Client Browser with Served Data................................................ 899Thin Client Browser with Direct Data Connection................................. 900Thin Client Browser with Served Data - Manual Deployment Process...... 901Thin Client Browser with Served Data - Manual Setup.......................... 902Thin Client Browser with Direct Data - Manual Deployment Process ....... 911Thin Client Browser with Direct Data - Manual Setup ........................... 911Display Server ............................................................................... 916

Chapter 13 - Reporting ...................................................................................... 941

Overview ................................................................................................... 941

On Demand Reporting ................................................................................. 941Generating Reports with the Display Builder .............................................. 942Generating Reports with the Display Viewer............................................... 942Generating Reports with the Thin Client Browser ........................................ 942Localizing Reports .................................................................................. 942

Automatic Report Generation........................................................................ 944Starting Automatic Report Generation....................................................... 944Customizing a Report ............................................................................. 944

Chapter 14 - Alerts ............................................................................................ 949

Overview ................................................................................................... 949Adding Alerts ........................................................................................ 950Alert Definition Files ............................................................................... 951

Creating a Reusable Alert Definition File ............................................ 951Running the Alert Engine ........................................................................ 951Alert Behavior ....................................................................................... 952

Alert Execution............................................................................... 952Cleared Alerts ................................................................................ 952Viewing Alerts................................................................................ 952Managing Alerts ............................................................................. 957

Alert Types: Limits, Discrete, Multi State, and Event ........................................ 957Limits Alerts.......................................................................................... 957

Threshold Values............................................................................ 957Alert Text Values ............................................................................ 959Alert Command Text Values ............................................................. 960Limits Alert Properties ..................................................................... 961

Discrete Alerts....................................................................................... 968Threshold Values............................................................................ 968Alert Text Values ............................................................................ 970Alert Command Text Values ............................................................. 971Discrete Alert Properties.................................................................. 972

Multi State Alerts ................................................................................... 978Event Alerts .......................................................................................... 992

Attach to Alert Data .................................................................................... 999

xviii RTView Core® User’s Guide

Attach to Alert Data Dialog.................................................................... 1000Substitutions....................................................................................... 1002Select Table Columns ........................................................................... 1003

Define Alert Command .............................................................................. 1003Define Alert Command Dialog ................................................................ 1004Command Types .................................................................................. 1005Substitutions....................................................................................... 1008Special Values ..................................................................................... 1008

Application Options - Alerts ........................................................................ 1009Overview ............................................................................................ 1009Alerts Tab ........................................................................................... 1009Alert Definitions Tab ............................................................................. 1012Self Service Alerts Tab .......................................................................... 1013Custom Alert Fields Tab ........................................................................ 1014Alert Persistence Tab ............................................................................ 1017

Self Service Alerts..................................................................................... 1018Overview ............................................................................................ 1018Alert Settings Table .............................................................................. 1019Self Service Audit Table ........................................................................ 1020Alert Construction Limitations ................................................................ 1021Self Service Alert Demo ........................................................................ 1021

Running the Demo........................................................................ 1021Alert Detail Table.......................................................................... 1022Alert Administration ...................................................................... 1026Tabular Alert Administration........................................................... 1028Administration Audit ..................................................................... 1029Alert Action Audit Trail .................................................................. 1030Modify the Stand-Alone Demo ........................................................ 1030Customization Options .................................................................. 1031Integrate the Demo into an RTView Application ................................ 1033

Alert Persistence....................................................................................... 1034Overview ............................................................................................ 1035Database Configuration ........................................................................ 1036Alert Engine Configuration..................................................................... 1036Alert Persistence Requirements and Limitations........................................ 1037

Requirements .............................................................................. 1037Limitations .................................................................................. 1037

Audit Alert Action...................................................................................... 1038Overview ............................................................................................ 1038Alert Action Audit Database................................................................... 1039Alert Action Audit Table......................................................................... 1039

Chapter 15 - Caches......................................................................................... 1041

Overview ................................................................................................. 1041Extend with SQL .................................................................................. 1042Data Compaction ................................................................................. 1042

RTView Core® User’s Guide xix

Adding Caches..................................................................................... 1042Cache Definition Files.................................................................... 1043Viewing Caches ............................................................................ 1043

Table Cache ........................................................................................ 1043Cache Properties .......................................................................... 1044Cache Current Table Properties ...................................................... 1045Cache History Table Properties ....................................................... 1047Data Properties ............................................................................ 1049Data Compaction: Primary (in-memory) Properties ........................... 1050Data Compaction: Secondary (Historian) Properties .......................... 1052Historian Properties ...................................................................... 1052Object Properties.......................................................................... 1053

Double Cache ...................................................................................... 1054Cache Properties .......................................................................... 1054Cache History Table Properties ....................................................... 1054Data Properties ............................................................................ 1055Historian Properties ...................................................................... 1055Object Properties.......................................................................... 1056

Attach to Cache Data ................................................................................ 1056Attach To Cache Data - Filter Modes ....................................................... 1057

Filter Rows Off ............................................................................. 1057Filter Rows: Basic ......................................................................... 1059Filter Rows: Advanced................................................................... 1062Validation Colors .......................................................................... 1064Substitutions ............................................................................... 1065RTViewDs.................................................................................... 1065Select Table Columns.................................................................... 1067

Define Cache Command............................................................................. 1068Substitutions....................................................................................... 1069Special Values ..................................................................................... 1069

Application Options -- Caches ..................................................................... 1070

Chapter 16 - CMDB........................................................................................... 1073

Overview ................................................................................................. 1073What is a CMDB? ................................................................................. 1073How is a CMDB used? ........................................................................... 1074

Why would I want to use a CMDB with my RTView solution?............... 1074Configuration Requirements .................................................................. 1075Deployment ........................................................................................ 1075

Centralized Connection Repository .................................................. 1075Service and Component Centric View of Data for Display Construction . 1076

CMDB Configuration .................................................................................. 1077Overview ............................................................................................ 1077Creating CMDB Caches ......................................................................... 1079CMDB Configuration Tables.................................................................... 1080

xx RTView Core® User’s Guide

Metric Source Table ...................................................................... 1081CMDB - Metric Source Table - Connection Information ....................... 1082Container Table............................................................................ 1091Metric Source Type Table............................................................... 1092Permission Table .......................................................................... 1092Relationship Table ........................................................................ 1093

Application Options - CMDB................................................................... 1094CMDB Tables Tab ......................................................................... 1094RTView Server CMDB Settings Tab.................................................. 1096

Deploying CMDB Caches ....................................................................... 1096Steps for Deploying Caches ........................................................... 1097

Creating Composites ............................................................................ 1098

Attach to CMDB Data................................................................................. 1099Validation Colors.................................................................................. 1101Substitutions....................................................................................... 1102Select Columns.................................................................................... 1102

RTView Deployment - CMDB....................................................................... 1103Deploy CMDB Caches ........................................................................... 1103Configuration Files ............................................................................... 1103

Troubleshooting - CMDB............................................................................. 1104Display Builder .................................................................................... 1104Display Builder\Display Viewer\Display Server ......................................... 1105Data Server ........................................................................................ 1106

Command Line Options - CMDB .................................................................. 1106

Chapter 17 - Historian ..................................................................................... 1109

Overview ................................................................................................. 1109Use Cases for Historical Data................................................................. 1109

Configuring the Historian ........................................................................... 1110Data Configuration File Options ...................................................... 1110Display Files ................................................................................ 1111Cache Definition Files.................................................................... 1111

Basic Steps To Configure the Historian .................................................... 1111Display File Configuration...................................................................... 1112

Numeric Data Table ...................................................................... 1113String Data Table ......................................................................... 1114

Cache Definition File Configuration ......................................................... 1115Database Connection Configuration ........................................................ 1116

Direct JDBC Connection................................................................. 1116Historian Application Configuration ......................................................... 1117Configuring Failover on the Historian ...................................................... 1121

High Availability Historians............................................................. 1121

Starting the Historian ................................................................................ 1123Rebuilding Historian Tables ............................................................ 1123

The Historian Application ...................................................................... 1124

RTView Core® User’s Guide xxi

Building a Display Using History Data .......................................................... 1127Enable valueHistoryFlag........................................................................ 1128Creating a SQL Data Attachment............................................................ 1128Extend with SQL .................................................................................. 1128

Managing the Historian Using JMX............................................................... 1129

Advanced Historian ................................................................................... 1130Data Aggregation................................................................................. 1130

Single Versus Multiple Tables ......................................................... 1131Configuring Data Aggregation ........................................................ 1132

Table Displacement .............................................................................. 1137Configuring Table Displacement...................................................... 1138Add a Display (.rtv) File to the Historian Application .......................... 1140

Advanced Historian - Cache Properties.................................................... 1142Compaction GroupBy Columns ....................................................... 1142Compaction Rules......................................................................... 1143

Chapter 18 - Optimizing Performance .............................................................. 1145

Overview - Display Sharing ........................................................................ 1145How It Works ...................................................................................... 1145Configuring Display Sharing .................................................................. 1146Monitoring Display Sharing.................................................................... 11

rtview core® user’s guidesldownloads.sl.com/docs/rtview_userguide_6.9.pdf · 2017-01-11 · iv...

Documents