Professional Documents
Culture Documents
Configuration Guide
300-005-564
A01
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Contents
Preface ......................................................................................................................... 5
Chapter 1
Overview
Overview..................................................................................................................
Architecture of EMC Smarts Service Assurance Manager with the
dashboard..............................................................................................................
Software requirements ...........................................................................................
Client requirements..........................................................................................
Server requirements .........................................................................................
Chapter 2
12
13
15
15
15
18
19
19
21
30
31
31
31
32
34
34
35
37
45
46
48
48
Chapter 3
Index .......................................................................................................................... 59
Preface
As part of an effort to improve and enhance the performance and capabilities of its product
lines, EMC periodically releases revisions of its hardware and software. Therefore, some
functions described in this document may not be supported by all versions of the software or
hardware currently in use. For the most up-to-date information on product features, refer to
your product release notes.
If a product does not function properly or does not function as described in this document,
please contact your EMC representative.
The EMC Smarts Business Dashboard is a Web-based interface that enables
customers, operators, and administrators to access information about the status of
their managed infrastructure from any standard browser, from any location. This
document describes how to configure the EMC Smarts Business Dashboard.
Configuration tasks include configuring Tomcat Servlet Engine, saving views in the
Global Console as viewlets, writing HTML, and configuring the interaction and
operation of dashboard viewlets.
Audience
Preface
The EMC Smarts Service Assurance Management Suite includes the following
products:
Global Console
Business Dashboard
Related
documentation
The following documents are relevant to users of the EMC Smarts Service Assurance
Management Suite:
Preface
Refer to the EMC Smarts Documentation Catalog for documentation resources provided
with other EMC Smarts product suites.
Suggestions for
searching PDF files
You may search across multiple PDF files using the Adobe Acrobat Reader software.
1. If the documentation is not accessible to all users of the EMC Smarts product
suite, copy the contents of the BASEDIR/smarts/doc/pdf directory to a central
location, such as a shared drive on your LAN, that operators and others may
view.
2. To search throughout the documentation library, open the Acrobat Reader
software.
1. Choose Edit > Search, and enter a word or phrase.
2. In the Where would you like to search option, select All PDF Documents in
and type the pathname of the location where the PDF documents reside.
If you have more than one EMC Smarts product suite installed, you can set up
cross-product document searches by copying files from the
BASEDIR/smarts/doc/pdf directory for each product suite into this common
documentation directory path.
Conventions used in
this document
IMPORTANT
An important notice contains information essential to the operation of the
software.
CAUTION
A caution contains information essential to avoid data loss or damage to the system
or equipment. The caution may apply to hardware or software.
Preface
Typographical conventions
EMC uses the following conventions in this guide:
Normal font
In running text:
Interface elements (for example, button names, dialog box names) outside of
procedures
Items that the user selects outside of procedures
Java classes and interface names
Names of resources, attributes, pools, Boolean expressions, buttons, DQL
statements, keywords, clauses, environment variables, filenames, functions, menu
names, utilities
Pathnames, URLs, filenames, directory names, computer names, links, groups,
service keys, file systems, environment variables (for example, command line and
text), notifications
Bold
In procedures:
Names of dialog boxes, buttons, icons, menus, fields, and maps
Selections from the user interface, including menu items, and field entries
Key names
Window names
Code examples
Commands
User interface tabs
Italic
Used for:
Full publications titles referenced in text
In procedures:
Directory paths
Filenames
Scripts
Important/unique words
URLs
Utilities
Variables
Courier
Used for:
System output
User entry
<>
Angle brackets used to enclose parameter or variable values supplied by the user.
[]
Vertical bar used to indicate alternate selections. The bar means or.
{}
Braces used to indicate content that you must specify (that is, x or y or z).
...
Used to indicate a command is wrapped over one or more lines. The command must
be typed as one line.
Pathname conventions
Directory pathnames are shown with forward slashes (/). Users of the Windows
operating systems should substitute back slashes (\) for forward slashes.
Graphical conventions
If there are figures illustrating consoles in this document, they represent the consoles
as they appear in Windows. Under UNIX, the consoles appear with slight differences.
For example, in views that display items in a tree hierarchy such as the Topology
Browser, a plus sign appears for Windows and an open circle displays for UNIX.
8
Preface
Smarts Manager
Unless otherwise specified, the term Smarts Manager is used to refer to EMC Smarts
programs such as Domain Managers, Global Managers, and adapters.
Where to get help
Preface
10
1
Overview
Overview ......................................................................................................................... 12
Architecture of EMC Smarts Service Assurance Manager with the dashboard ... 13
Software requirements................................................................................................... 15
Overview
11
Overview
Overview
The EMC Smarts Business Dashboard displays the results of EMC Smarts analysis
in a flexible, Web-based user interface. The EMC Smarts Business Dashboard
provides the views from the Global Console as individual components called
dashboard viewlets. A dashboard viewlet is implemented as a Java applet.
You can configure the display and contents of dashboard viewlets to customize the
presentation of EMC Smarts analysis, enabling you to deliver role-based views of the
managed topology across all layers of your IT environment.
Business managers can view status summaries for systems and business
processes
Operations staff can view real-time operational status of monitored elements and
services
Users can drill down to see the health and status of related infrastructure,
applications, and business services
Installing the EMC Smarts Business Dashboard provides all of the components
necessary to create, configure, and display dashboard viewlets. Also included is a set
of ready-to-use viewlets, described in Examples of Dashboard viewlets on page 49.
In addition, an installation of the EMC Smarts Business Dashboard includes the Web
Console, which displays the Global Console within a Web browser. The Web Console
provides the same functions and features as the Global Console.
12
Overview
Dashboard viewlets can be displayed in any supported Web browser from any
location. The Web clients do not require an installation of EMC Smarts software.
Dashboard viewlets can be embedded into a Web Portal, combining EMC Smarts
analysis with information from other sources.
Figure 1 illustrates how the EMC Smarts Business Dashboard integrates with
EMC Smarts Service Assurance Manager.
Browser Clients
Host
Host
InCharge Broker
Service Assurance
Manager
(Global Manager)
Host
Jakarta Tomcat
Servlet Engine
Host
InCharge Manager
InCharge Manager
Legend
Communication with InCharge Broker
Flow of Topology and Events
Initial loading of Viewlets and HTML
Figure 1
13
Overview
The following components, illustrated in Figure 1, are related to the EMC Smarts
Business Dashboard.
14
Tomcat Servlet Engine serves the JAR files that compose dashboard viewlets and
the map layout servlet. The servlet engine is installed as a service with the EMC
Smarts Business Dashboard. If you are already running a Web server, you can use
it to serve the necessary files to display dashboard viewlets.
Overview
Software requirements
EMC Smarts Business Dashboard includes the necessary files and software for
serving the files to display dashboard viewlets and the Web Console.
Client requirements
Users who display dashboard viewlets in a Web browser, or wish to use the Web
Console, require the following software.
Java 2 Platform Standard Edition 5.0 which includes the 1.5.x Web browser
plug-in
Server requirements
An installation of the EMC Smarts Business Dashboard includes the Tomcat Servlet
Engine, which is necessary to serve the JAR files and map layout servlet. The servlet
engine is installed as the EMC Smarts Servlet Engine service on the system where you
install the EMC Smarts Business Dashboard.
If you wish to serve dashboard viewlets from a different Web server, you must install
the EMC Smarts Business Dashboard to obtain the necessary files, which are
described in Deploying viewlets on page 21.
Software requirements
15
Overview
16
2
Configuring the
EMC Smarts Business
Dashboard
Overview ......................................................................................................................... 18
Serving Dashboard viewlets......................................................................................... 19
About user profiles and user accounts........................................................................ 30
About Dashboard viewlets ........................................................................................... 31
HTML syntax for viewlets ............................................................................................ 34
URL-addressable viewlets ............................................................................................ 46
About the Web Console................................................................................................. 48
17
Overview
The configuration tasks for EMC Smarts Business Dashboard depend on how you
intend to deploy it. A simple deployment could use the sample viewlets as an EMC
Smarts Business Dashboard to display information from a Global Manager. A more
complicated deployment could involve creating new HTML pages to display
Dashboard viewlets, configuring the display of viewlets, creating an on-demand URL
addressable viewlet, or integrating a viewlet with a portal.
The configuration steps necessary to provide these deployments are described in this
chapter and involve one or more of the following tasks:
18
Description
/conf
/webapps
Note: The program used to invoke the Tomcat Servlet Engine is the sm_tomcat program. The
sm_tomcat program is used by EMC Smarts to set the proper environment for software
running from an EMC Smarts installation.
19
For more information about services, see the EMC Smarts System Administration Guide.
Verify that Tomcat is running
After the SMARTS Servlet Engine service is installed and started, you can verify
whether Tomcat is running by opening the following URL in a web browser:
http://<tomcat_host>:<port>, where <tomcat_host> is the system where the EMC
Smarts Business Dashboard is installed and <port> is the TCP port the Tomcat Servlet
Engine is listening on.
You can also access the Tomcat Servlet Engine documentation from the following
URL: http://<tomcat_host>:<port>/tomcat-docs.
Changing the port number of Tomcat
For most installations, Tomcat should not require any additional configuration. In
some cases, however, it may be necessary to change the port number on which the
Tomcat Servlet Engine is running.
The configuration of Tomcat is determined by the server.xml file located in the
BASEDIR/smarts/tomcat/conf directory. By default, Tomcat is configured to use
TCP port 8080. If this port is already in use on the system where the EMC Smarts
Business Dashboard is installed, you can configure Tomcat to use another port.
To change the port number, find the following line in server.xml:
<Connector port="8080"
Change the port number to a suitable number. If Tomcat is currently running, you
will need to restart it.
For more information regarding Tomcat Servlet Engine, see
http://tomcat.apache.org.
Increasing the heap space for the Java Plug-in
If the Web Console or viewlets run out of memory, adjust the maximum amount of
heap space that the Java Plug-in uses for dynamic memory allocation. By specifying
-Xmx256M as a runtime parameter, for example, you can increase the heap space
allocation to 256 MB. The number can be set larger or smaller than 256 MB,
depending on the resources available on the client machine running the web browser.
To increase the heap space for the Java Plug-in:
1. Launch the Java Plugin Control Panel. The Sun website provides instructions
(http://java.sun.com)
2. In the Java Plug-in Control Panel, click the Advanced tab.
20
3. In the Advanced tab page, below the line Java Runtime Parameters, type the
maximum heap-space runtime parameter (-Xmx) and a value for the parameter.
For example: -Xmx256M.
4. Save your entry and close the Java Plug-in Control Panel.
5. Terminate and restart any web browser running on the host machine.
Deploying viewlets
Directories under BASEDIR/smarts/tomcat/webapps contain the web applications
served by the Tomcat Servlet Engine. For example, the sample Dashboard viewlets
included with EMC Smarts Business Dashboard are installed to the
BASEDIR/smarts/tomcat/webapps/templates directory. Each directory under
/webapps must contain the JAR, HTML, and configuration files necessary for the
web application to run.
You can choose one of the following methods to deploy Dashboard viewlets:
Table 2
Create your own viewlets directory under /webapps. You must ensure that the
new directory contains the files and directories listed in Table 2, which can be
copied from the templates directory. After you create the new directory and add
the necessary files, you need to restart the SMARTS Servlet Engine service.
Description
HTML files
jcommon-0.7.0.jar
jfreechart-0.9.3.jar
masterpiece.jar
tsgdtj50.jar
tsgetj50.jar
tsglt50.jar
tsgltc50.jar
tsgmtj50.jar
21
Table 2
Description
dashboard.properties
viewlet.properties
WEB-INF
22
Files needed
Windows
mfc42.dll
tsj6ag50.dll
tsj6bl50.dll
tsj6cd50.dll
tsj6cl50.dll
tsj6dg50.dll
tsj6hl50.dll
tsj6ja50.dll
tsj6jx50.dll
tsj6mg50.dll
tsj6nl50.dll
tsj6ol50.dll
tsj6sl50.dll
tsj6tl50.dll
tsj6ut50.dll
tsjj6ag50.dll
tsjj6cl50.dll
tsjj6dg50.dll
tsjj6hl50.dll
tsjj6mg50.dll
tsjj6ol50.dll
tsjj6sl50.dll
tsjj6tl50.dll
tsjj6ut50.dll
Solaris/Linux
libagraphj.so
libblayj.so
libclayj.so
libclidemoj.so
libdgraphj.so
libhlayj.so
libjagraphj.so
libjclayj.so
libjdgraphj.so
libjhlayj.so
libjmgraphj.so
libjolayj.so
libjslayj.so
libjtlayj.so
libjutilsj.so
libmgraphj.so
libnlayj.so
libolayj.so
libslayj.so
libtlayj.so
libtsgltextj.so
libtsgltj.so
libutilsj.so
HP-UX
libagraphj.sl
libblayj.sl
libclayj.sl
libclidemoj.sl
libdgraphj.sl
libhlayj.sl
libjagraphj.sl
libjclayj.sl
libjdgraphj.sl
libjhlayj.sl
libjmgraphj.sl
libjolayj.sl
libjslayj.sl
libjtlayj.sl
libjutilsj.sl
libmgraphj.sl
libnlayj.sl
libolayj.sl
libslayj.sl
libtlayj.sl
libtsgltextj.sl
libtsgltj.sl
libutilsj.sl
Figure 2 illustrates the flow of information when using a web server other than the
SMARTS Servlet Engine to serve viewlets.
23
Browser Clients
Host
Host
InCharge Broker
Service Assurance
Manager
(Global Manager)
Host
Web Server
Host
Legend
Communication with InCharge Broker
Flow of Topology and Events
Initial loading of Viewlets and HTML
Figure 2
To deploy the Dashboard viewlets with another web server (for example, a future
version of Tomcat 5.5.x), perform the following steps. (Version numbers and directory
paths in these steps are for example only.)
1. Install Tomcat 5.5.x.
2. Set JAVA_HOME. For example, JAVA_HOME=C:\Program
Files\JAVA\j2sdk1.5_06. Add the line to the catalina.bat file in
C:\tomcat-5.5.x\bin.
3. Copy BASEDIR\smarts\tomcat\webapps\tss, \webapps\webconsole, and
\webapps\templates to the new directory. For example, to
C:\tomcat-5.5.x\webapps.
4. Create a "lib" folder under C:\tomcat-5.5.x\webapps\tss\WEB-INF and copy the
JAR files from BASEDIR\smarts\tomcat\webapps\webconsole to this new
folder. You need only copy the JAR files that begins with tsg.
5. Make sure that BASEDIR\smarts\lib is in the system path (used in the PATH
environment variable for Windows and in the library path for UNIX installs)
when Tomcat is started. This directory includes libraries that the servlet needs.
Note: This only works if the web server is on the same host as the Dashboard or
Global Console. If they are not, you must copy libraries from the
BASEDIR\smarts\lib of the Dashboard or Global Console to the machine where
the server is installed. These files are listed in Table 3.
24
6. Start the Tomcat engine using your standard web server startup command:
..\tomcat-5.5.x\bin\startup.bat
Value
com.smarts.proxyHost
com.smarts.proxyPort
com.smarts.proxyAuthString
com.smarts.proxyAdditionalHeaders
25
4. Modify the proxy connection settings in Internet Explorer. (This step is not
applicable for the Global Console.)
Open Internet Explorer and select Tools > Internet Options.
In the Internet Options dialog, select Connections.
In the Connection tab, click the LAN Settings button.
In the Local Area Network (LAN) Settings dialog, in the Proxy server section,
select the checkbox for Use a proxy server for your LAN, and specify an IP
address for the proxy server and port number. Click OK to save your changes.
Click OK in the Internet Properties dialog.
Note: If you are using Java Web Start, it has a similar dialog in which you can specify the
address for the proxy server and the port number.
26
The variables are set in the runcmd_env.sh file, which is located in the
BASEDIR/smarts/local/conf directory. The variables may be set to 0 (unencrypted
connection), 1 (encrypted connection), or 1,0 (both encrypted and unencrypted
connections).
The default setting is to use both encrypted and unencrypted connections which
means that the Dashboard viewlets and the Global Manager automatically negotiate
the connection to the highest level of encryption possible.
Encryption can be controlled by setting similar variables in the HTML code that
displays the Dashboard viewlet, see Specifying viewlet parameters in HTML on
page 35, or in a properties file as described in Using a properties file to specify
viewlet parameters on page 36.
For these two methods, the following variables are used:
See the EMC Smarts System Administration Guide for detailed information about
encrypted connections.
Using SSL (https://)
If your deployment requires the use of SSL (Secure Socket Layer), you need to
perform the following steps before you launch the Dashboard with the https protocol.
(See the ssl-howto.html document in the BASEDIR/smarts/tomcat/webapps
directory on your system for detailed information. Or, access the document from the
web site: http://tomcat.apache.org/tomcat-5.5-doc/ssl-howto.html.
1. Prepare a "self-signed" certificate.
If you do not purchase a Certificate from a Certificate Authority, you can generate
a Certificate.
For example:
java1.5_HOME> /bin/keytool.exe -genkey -alias tomcat -keyalg RSA keystore testKeystore
Enter keystore password: changeit
What is your first and last name?
[Unknown]: User Name
What is the name of your organizational unit?
[Unknown]: Engineering
What is the name of your organization?
[Unknown]: Emc Smarts
What is the name of your City or Locality?
[Unknown]: White Plains
What is the name of your State or Province?
[Unknown]: NY
What is the two-letter country code for this unit?
[Unknown]: US
Is CN=User Name, OU=Engineering, O=Emc Smarts, L=White Plains,
ST=NY, C=US correct?
[no]: yes
Enter key password for <tomcat>
(RETURN if same as keystore password):<Return>
At this point you have a Certificate in a keystore file called testKeystore. Move the
file into the Tomcat home directory (for Business Dashboard 7.0 on Windows, for
example, it is: C:\InCharge7\SAM\smarts\tomcat\).
27
2. Configure Tomcat.
a. In the Tomcat home directory, back up the conf/server.xml file. Then, edit the
file.
b. Find the SSL connector element which is commented out (<!-- commented out
text -->):
<-- Define an SSL HTTP/1.1 Connector on port 8443
-->
<!-<Connector port="8443"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" disableUploadTimeout="true"
acceptCount="100" debug="0" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS" />
-->
c. Uncomment the lines and edit them to include the keystore file that you
created. The preceding will look like this:
<!-- Define an SSL HTTP/1.1 Connector on port 8443
-->
<Connector port="8443"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" disableUploadTimeout="true"
keystoreFile="C:\InCharge7\SAM\smarts\tomcat\testKeystore"
keystorePass="changeit"
acceptCount="100" debug="0" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS" />
d. Then comment out the non-SSL connector used for http, to look like this:
<!-- Define a non-SSL HTTP/1.1 Connector on the
port specified during installation -->
<!-<Connector port="8080"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" redirectPort="8443"
acceptCount="100"
debug="0" connectionTimeout="20000"
disableUploadTimeout="true" />
-->
with
https://localhost:8443/
28
5. Launch the Dashboard the following URL in the browser's Address field:
https://localhost:8443/templates
The system displays a Security Alert window that provides information about the
Certificate being used. On accepting it, a Directory Listing for templates is displayed,
as in the case of the non-SSL Dashboard.
29
Dashboard viewlets saved to a users directory are only accessible to that user.
The name of a users directory is the same as the user name.
Dashboard viewlets saved to a user profile directory are accessible by any user
associated with that user profile. The name of the user profile directory is the
same as the user profile name.
You must create the user profiles and user accounts before you can save a viewlet to a
users directory or a user profile.
30
Create an HTML page that includes one or more viewlets to provide a customized
display of EMC Smarts analysis. Because this view is displayed in a web browser,
it is accessible from any host with a web browser.
Embed a viewlet within a web portal application to combine the information from
the Global Manager within an existing information view.
The configuration tasks that must be completed to provide any of the above
Dashboard viewlets are similar. After you create a viewlet for a web page, for
example, you could also embed that same viewlet within a portal. This enables you to
re-use viewlets, assigning them as necessary according the users role or
informational requirements.
You can also use the Dashboard viewlets located in the
BASEDIR/smarts/tomcat/webapps/templates directory. The HTML code for each
viewlet has been converted to HTML that displays properly in both Netscape and
Internet Explorer. For more information about the sample viewlets, see Examples of
Dashboard viewlets on page 49. The HTML converter used to create
browser-specific HTML is installed as part of Java 2 Platform Standard Edition 5.0.
Notification Log
Status Table
Summary View
Containment
Notification Properties
You can display these console elements as viewlets by specifying their parameter
name and any configuration parameters in the HTML code. For more information
regarding the HTML syntax for viewlets, see HTML syntax for viewlets on page 34.
Notification Log
Status Tables
Summary Views
31
5. Specify a name for the viewlet. The file naming convention for saved viewlets is
as follows:
<user_specifed_name><viewlet_type>.icsvm
Displaying maps
Map viewlets are not the same as the Maps displayed in a Global Console. Map
viewlets do not display a topology tree from which an element can be selected. Use
one of the following methods to display elements in a Map viewlet:
32
Enable context sharing for the Map viewlet, as described in Context sharing for
viewlets on page 37
Save a map, as described below, and display the map by specifying its focus.
Saving maps
The purpose of saving a map is to customize the default map that is displayed for a
specific element. A saved map is associated with the element that is the focus of the
map. When the focus element is selected to display in a map, the saved map is
displayed for users with access to the saved map.
A saved map can include the following information:
Node positions
Filtered classes
User-defined backgrounds
To save a map, in the Map Console, select Map > Save Map. Click OK to acknowledge
the pop-up message which displays the location of the saved map. The map is saved
to the users directory under BASEDIR/smarts/local/consoles/ on the host where
the Global Manager is running. The file extension for a saved map is .icsvm.
To make a saved map available to other users, you must copy the map file to the
shared location BASEDIR/smarts/local/consoles.
For information about saved maps, see the EMC Smarts Service Assurance Manager
Operators Guide.
Displaying a saved map
To display a saved map, you must specify the topological instance that was the focus
when the map was saved. Unlike a saved viewlet, it is not necessary to specify the
name of the saved map. The parameters for specifying the instance to display in a
Map viewlet are described in Properties for map viewlets on page 42.
33
34
Table 5
Description
<APPLET> ...
... </APPLET>
code
archive
Parameter that lists the JAR files necessary to display the viewlet. All
of the JAR files are necessary for each viewlet.
jcommon-0.7.0.jar
jfreechart-0.9.3.jar
masterpiece.jar
tsgdtj50.jar
tsgetj50.jar
tsglt50.jar
tsgltc50.jar
tsgmtj50.jar
35
ARCHIVE="masterpiece.jar,jcommon-0.7.0.jar,\
jfreechart-0.9.3.jar,tsgdtj50.jar,tsgetj50.jar,\
tsglt50.jar,tsgltc50.jar,tsgmtj50.jar">
<PARAM NAME="com.smarts.context.collectionEntity"\
VALUE="true">
</APPLET>
The parameters to specify a properties file for the viewlet are nested inside the
<APPLET> tags and have the following syntax:
<param name=name value=value>
"value" indicates the name of the file containing the properties. You can use any name
for a properties file.
In the following example, the HTML for a Notification Log viewlet references a
properties file named dashboard.properties.
<APPLET TYPE="applet"
CODE="com.smarts.webapps.SmWebNotificationsApp.class"
WIDTH=100% HEIGHT=100%
ARCHIVE="masterpiece.jar,jcommon-0.7.0.jar,\
jfreechart-0.9.3.jar,tsgdtj50.jar,tsgetj50.jar,\
tsglt50.jar,tsgltc50.jar,tsgmtj50.jar">
<PARAM NAME="com.smarts.propertiesFile" \
VALUE ="dashboard.properties">
</APPLET>
The dashboard properties file may specify any of the properties described in
Additional viewlet properties on page 37 or in Encrypted connections on
page 26. The properties are assigned using the following syntax:
parameter_name=value
Quotes around the value are optional unless you need to have leading or trailing
spaces as part of the value.
The following properties file example sets the location of the EMC Smarts Broker and
the name of the Global Manager:
smarts.remote.broker=host1.smarts.com:426
com.smarts.autoAttachDM=INCHARGE-SA
36
As a result, when a user opens the web page that displays the viewlet, the Attach
dialog includes the information about the Broker and Global Manager. The user
simply provides a user name and password to connect.
Description
com.smarts.savedView
Description
com.smarts.context.notification
com.smarts.context.instance
37
Table 7
Description
com.smarts.context.summary
com.smarts.context.collectionEntity
com.smarts.launch.globalMgr
Note: Notification Properties viewlets always listen for notification context and Containment
viewlets always listen for notification and instance context.
Edit two parameters in the dashboard.properties file (or in the viewlet HTML
files).
Configure the Dashboard credentials identifier (ID). This ID specifies the location
of the EMC Smarts Broker, the name of the Global Manager, a user name, and a
password.
WARNING
The EMC Office of Product Security deems the use of this feature (Automatic attach
by storing credentials on disk) as an unsecure mode of operation. Storing credentials
on disk amounts to no user authentication. As such, EMC Corporation discourages
the use of this feature.
Configure Dashboard viewlets to automatically attach to the Global Manager
The configuration of a Dashboard viewlet to automatically attach to a server involves
defining two properties in the dashboard.properties file. Alternatively, the
parameters can be defined in the HTML files used to launch the viewlets. If the
properties are defined in the HTML files, they must be defined identically in all the
viewlet HTML files.
38
Description
com.smarts.viewlet.authhttp
com.smarts.attach.alias
2. The Dashboard viewlet authenticator login screen displays. Enter a user name
and password that will be used in the future to access the Dashboard credential
tool (for example, admin, 12345). Click Submit. A message indicating a successful
login appears.
39
Note: This step assigns values to two parameters that control access to the tool:
configuration.admin.user and configuration.admin.password. Use this user name and
password whenever you need to access this tool to edit Dashboard credential IDs.
Description
connection_alias1
com.smarts.userid
com.smarts.password
Password.
smarts.remote.broker
com.smarts.autoAttachDM
com.smarts.clientips
4. Copy the text beginning with the line, #[connection_alias1], and paste it at the end
of the file. Uncomment and edit the parameters in these lines in order to create the
credentials ID for the autoAttach feature. For example,
[GUI_ID]
com.smarts.userid=oper
com.smarts.password=oper
smarts.remote.broker=qa-fancy:426
com.smarts.autoAttachDM=INCHARGE-SA
com.smarts.clientips=10.239.*;10.7.2.[1-9];10.7.2.11;127.0.0.1
# end of entry GUI_ID
40
CAUTION
Observe the data entry syntax shown above. You must uncomment the lines
(remove the # character) needed to support each credentials ID. The ID must
appear in braces on the first line followed by each parameter on subsequent lines.
The userid and password must be associated with a valid user profile. And the last
line requires that one of the comment (#) characters be removed leaving a single #
character preceding the "end of entry <ID>" string of text.
5. Click Save. The Show Configuration screen displays and the user name and
password are scrambled (see example below).
# start of entry GUI_ID
[GUI_ID]
# The following fields CAN NOT be modified manually
com.smarts.userid=5f2c442449242f41
com.smarts.password=5f2c642e4d392041
# end of fields CAN NOT be modified manually
smarts.remote.broker=qa-fancy:426
com.smarts.autoAttachDM=INCHARGE-SA
com.smarts.clientips=10.239.*;10.7.2.[1-9];10.7.2.11;127.0.0.1
# end of entry GUI_ID
41
Once the viewletauth.conf file is opened, locate the following lines located near the
beginning of the file:
# Automatically generated configuration file
# admin credential: DO NOT EDIT 2 fields below
configuration.admin.user=5f24442449242f292d5e572150283341
configuration.admin.password=5f2041214a2a2432315f5641264e4545
2. Execute the following command replacing the encoded string value with the
encrypted (encoded) configuration.admin.user text string value:
java -cp TOMCAT_INSTALL/webapps/SMViewletAuth/WEB-INF/classes
com.smarts.viewletauth.util.SMObfuscatorFactory -s encoded_string
42
Description
com.smarts.launch.class
com.smarts.launch.instance
com.smarts.launch.mapType
Table 10
Description
com.smarts.map.passive
com.smarts.launch.mapHops
com.smarts.fitInWindow
com.smarts.map.showAllBusiness
In order for client tools to be invoked, the tool scripts must be placed in a directory
accessible from the client machine (where the web browser is running). In an
environment where Dashboard users share a network drive, the client tools can be
placed in a directory on the network drive, thus avoiding the need to copy the tools
onto each client machine.
43
To enable access to the client tools from the Business Dashboard, add the parameters
described in Table 11 to the appropriate properties file, for example,
dashboard.properties..
Table 11
Description
com.smarts.clientToolsInApplet=true
When set to true, client tools are enabled in the Web Console or
Business Dashboard.
If this parameter is specified, and the
com.smarts.webconsole.sitemod parameter (see below) is not
specified, the Dashboard client tool function gets the client tools
from the /actions/client directory in the web browsers default
directory. (For IE, this may be Documents and Settings\Desktop.
For Firefox, the Firefox installation base directory.) You must put a
copy of the tool in this /actions/client path.
com.smarts.webconsole.sitemod
Example
Here is an example showing how to configure a tool named myClientTool.cmd where
com.smarts.webconsole.sitemod=Z:/toolsdir. The two parameters would be set as
follows:
com.smarts.clientToolsInapplet=true
com.smarts.webconsole.sitemod=Z:/toolsdir
The client tool must be placed in the /actions/client folder under Z:/toolsdir as
shown below.
Z:/toolsdir/actions/client/myClientTool.cmd
44
Note: To apply this option only to the Java Web Start, add the following property to the
globalConsoleApp.jnlp file:
<property name="com.smarts.user.display" value="{IP}:0.0"/>.
2. For the command line console (sm_gui), add the following command line option:
-D com.smarts.user.display={IP}:0.0
If the entry is not added to the logs, the configuration is not accurate.
45
URL-addressable viewlets
A URL-addressable viewlet is a viewlet that is displayed when a web client loads a
particular URL. This enables you to dynamically generate a URL to display Map,
Notification Properties, and Containment viewlets from within the context of another
application. Using the viewlet parameters described in Additional viewlet
properties on page 37, you can configure a URL-addressable viewlet.
To specify viewlet parameters directly in a URL, use the following syntax:
http://URL?class=viewlet¶meter_name=value[&...]
Note: The [&...] indicates you can add as many parameters and values as needed. Each
parameter and value must be separated with an ampersand.
Table 12 lists values used with the class parameter typically used with
URL-addressable viewlets and Table 13 describes the separators used.
Table 12
Table 13
Dashboard viewlets
class
Description
Separates the file name of the HTML page specifying the JAR files from
the parameter/value pairs.
&
46
When necessary, use the dmctl utility to list the notifications in the Global Manager
and select the one that you want to use for the viewlet:
./dmctl -s INCHARGE-SA getInstances ICS_Notification
URL-addressable viewlets
47
When attached, the Web Console displays inside the web browser window. If the user
opens additional consoles using the File > Open menu options, each new console is
displayed in its own window. When the user exits the web browser, all Web Console
windows are closed, as is the connection to the Global Manager.
Using Java Web Start
You can also use Java Web Start for caching the applet locally for improved
performance; the necessary applet files are not reloaded each time the applet is
launched. To do so, point your browser at the following URL:
http://<tomcat_host>:8080/webconsole/globalConsoleCached.html
When you launch the cached applet, you are prompted to optionally add a Java Web
Start icon on your desktop and a link in your Start menu.
If Java Web Start is not installed, you are prompted to use an automatic installer or
directed to a Sun Microsystems web page, depending upon your operating system or
browser.
48
3
Examples of
Dashboard viewlets
This chapter describes the Dashboard viewlet and HTML code samples included
with the EMC Smarts Business Dashboard and contains the following information:
Note: The sample viewlets and their Web pages are installed to the
BASEDIR/smarts/tomcat/webapps/templates directory. Online information regarding the
sample viewlets is available from
http://<tomcat_host>:<port>/templates/DashboardIndex.html
49
Sample 1
You can view the first sample by opening sample1.html in your Web browser. This
sample includes the viewlets described in Table 14. The layout of this sample includes
50
a Notification Log in the top frame row and a Summary and Status Table in the
bottom frame row.
Table 14
Viewlets of Sample1.html
Frame page
Viewlet pages
Viewlet
Additional parameters
sample1.html
NotificationsApp1.html
Notification Log
SummaryApp1.html
Summary View
StatusTableAppAll.html
Status Table
Sample 2
You can view the second sample by opening sample2.html in your Web browser. This
sample includes the viewlets described in Table 15. The layout of this sample includes
51
a Status Table and Map in the top frame row and a Notification Log in the bottom
frame row.
Table 15
Viewlets of Sample2.html
Frame page
Viewlet pages
Viewlet
Additional parameters
sample2.html
StatusTableAppAll.html
Status Table
MapApp2a.html
Map
NotificationsApp2a.html
Notification Log
Sample 3
You can view the third sample by opening sample3.html in your Web browser. This
sample includes the viewlets described in Table 16. The layout of this sample includes
52
a Map in the top frame row and a Notifications Log and Containment viewlet in the
bottom frame row.
Table 16
Viewlets of Sample3.html
Frame page
Viewlet pages
Viewlet
Additional parameters
sample3.html
MapApp3a.html
Map
NotificationsAppAll.html
Notification Log
ContainmentAppAll.html
Containment
53
Sample 4
You can view the fourth sample by opening sample4.html in your Web browser. This
sample includes the viewlets described in Table 17. The layout of this sample includes
a Notifications Log in the top frame row, a Summary and Notification Properties
viewlets in the middle frame row, and a Map in the bottom frame row.
Table 17
54
Viewlets in sample4.html
Frame page
Viewlet pages
Viewlet
Additional parameters
sample4.html
NotifcationsApp4.html
Notification Log
SummaryAppAll.html
Summary
NotificationPropertiesAppAll.html
Notification
Properties
MapApp4a.html
Map
Sample 5
You can view the fifth sample by opening sample5.html in your Web browser. This
sample includes the viewlets described in Table 18. The layout of this sample includes
a Notification Log in the top frame row, a Summary and a Map in the middle frame
row, and a second Notification Log in the bottom frame row.
Table 18
Viewlets in Sample5.html
Frame page
Viewlet pages
Viewlet
Additional parameters
sample5.html
NotificationsAppAll.html
Notification Log
SummaryAppAll.html
Summary
MapApp5a.html
Map
NotificationsApp5.html
Notification Log
55
Sample 6
You can view the sixth sample by opening sample6.html in your Web browser. This
sample includes the viewlets described in Table 19. The layout of this sample includes
a Status Table and Summary in the first row, a Notification Log in the second row, and
a second Summary in the bottom row.
One notable difference between this sample and the previous samples is that
sample6.html uses HTML TABLE tags in conjunction with IFRAME tags to position
viewlets. An advantage of IFRAME tags is that the viewlets within the tags remain at
their specified size. As the Web browser window is resized, the viewlets within the
table do not resize. When the browser window is made smaller than the specified size
of a viewlet, scroll bars are displayed within the IFRAME.
Table 19
56
Viewlets of Sample6.html
IFrame page
Viewlet pages
Viewlet
Additional parameters
sample6.html
StatusTableAppAll.html
Status Table
SummaryApp6.html
Summary
NotificationsApp6.html
Notification Log
SummaryAppAll.html
Summary Log
57
58
Index
Dashboard Viewlets
JAR files 21
dashboard.properties
com.smarts.propertiesFile 36
dmctl utility 47
B
Business Services Map viewlet 42
C
Client tools 43
Collection entities
Context sharing 38
com.smarts.autoAttachDM 39
com.smarts.context.collectionEntity 38
com.smarts.context.instance 37
com.smarts.context.notification 37
com.smarts.context.summary 38
com.smarts.launch.class 42
com.smarts.launch.globalMgr 38
com.smarts.launch.instance 42
com.smarts.launch.mapType 42
com.smarts.map.passive 43
com.smarts.propertiesFile 36
com.smarts.savedView 37, 44
com.smarts.viewletProperties 36
com.smarts.webapps.SmWebContainmentApp 35
com.smarts.webapps.SmWebGridApp 35
com.smarts.webapps.SmWebMapApp 35
com.smarts.webapps.SmWebNotificationPropertiesApp
35
com.smarts.webapps.SmWebNotificationsApp 35
com.smarts.webapps.SmWebSummaryApp 35
Containment viewlet 31
com.smarts.webapps.SmWebContainmentApp 35
Context sharing 38
Context sharing
Collection entities 38
Containment viewlet 38
Instance 37
Notification Properties viewlet 38
Notifications 37
Summary View viewlet 38
F
Firewall 25
G
Global Console
Saving maps 33
Saving view as viewlet 31
Global Manager 14, 38
H
HTML code
Viewlet 35
I
Instance context sharing 37
IP Connectivity map viewlet 42
J
JAR files
jcommon-0.7.0.jar 21
jfreechart-0.9.3.jar 21
masterpiece.jar 21
tsgdtj50.jar 21
tsgetj50.jar 21
tsglt50.jar 21
tsgltc50.jar 21
tsgmtj50.jar 21
59
Index
jcommon-0.7.0.jar 21
jfreechart-0.9.3.jar 21
JRE requirements 15
M
Map
com.smarts.webapps.SmWebMapApp 35
Layout servlet 19
Saving 33
Viewlet 32
Map viewlet
Applications 42
Business Services Map 42
IP Connectivity 42
Membership 42
Physical Connectivity 42
VLAN Connectivity 42
masterpiece.jar 21
Membership map viewlet 42
N
Naming convention for saved viewlets 32
Notification Log viewlet 31
com.smarts.webapps.SmWebNotificationsApp 35
Notification Properties viewlet 31
com.smarts.webapps.SmWebNotificationPropertiesA
pp 35
Context sharing 38
Notifications
Context sharing 37
P
Parameter
com.smarts.autoAttachDM 39
com.smarts.context.collectionEntity 38
com.smarts.context.instance 37
com.smarts.context.notification 37
com.smarts.context.summary 38
com.smarts.launch.class 42
com.smarts.launch.globalMgr 38
com.smarts.launch.instance 42
com.smarts.launch.mapType 42
com.smarts.map.passive 43
com.smarts.propertiesFile 36
com.smarts.savedView 37, 44
com.smarts.viewletProperties 36
Password,scramble in viewlet 38
Physical Connectivity map viewlet 42
Properties file
com.smarts.propertiesFile 36
com.smarts.viewletProperties 36
dashboard.properties 22
viewlet.properties 22
Proxy server 25
S
Saving map 33
Server, proxy 25
60
Service
see SMARTS Servlet Engine
Service Assurance
Global Manager 14
Servlet
Engine 14
Map layout 19
sm_service 20
sm_tomcat 19
SMARTS Servlet Engine
Service 15, 19
sm_tomcat 19
Starting and stopping 20
Status Table viewlet 31
com.smarts.webapps.SmWebGridApp 35
Summary View viewlet 31
com.smarts.webapps.SmWebSummaryApp 35
Context sharing 38
Syntax of viewlet properties 35
U
URL-addressable viewlet 57
User profile 30
V
View
Saving as viewlet 31
Viewlet
com.smarts.savedView 37, 44
com.smarts.webapps.SmWebContainmentApp 35
com.smarts.webapps.SmWebGridApp 35
com.smarts.webapps.SmWebMapApp 35
com.smarts.webapps.SmWebNotificationPropertiesA
pp 35
com.smarts.webapps.SmWebNotificationsApp 35
com.smarts.webapps.SmWebSummaryApp 35
Containment 31
HTML code 35
JAR files 35
Maps 32
Naming convention 32
Notification Log 31
Notification Properties 31
Properties file 36
Samples 50
Saved to user 30
Saved to user profile 30
Index
Status Table 31
Summary View 31
URL addressable 57
Viewlet properties
Syntax 35
viewlet.properties 22
com.smarts.viewletProperties 36
Viewlets
Automatic attach 38
Viewlets, automatic attach 38
VLAN Connectivity Map viewlet 42
W
WEB-INF 22
61
Index
62