User’s Guide

Using Crystal Reports®

Templates With Citrix® Resource
Manager
For Citrix MetaFrame XP™e 1.0, Feature Release 2 / Service
Pack 2 for Microsoft Windows

Citrix Systems, Inc.

Information in this document is subject to change without notice. Companies, names, and data used in
examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or
transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express
written permission of Citrix Systems, Inc.
© 2002 Citrix Systems, Inc. All rights reserved.
Citrix, Independent Computing Architecture (ICA), MultiWin, DirectICA, SecureICA, Program
Neighborhood, MetaFrame, MetaFrame XP, WINFRAME, NFuse, and Resource Manager are registered
trademarks or trademarks of Citrix Systems, Inc. in the U.S.A. and other countries.
Microsoft, MS, Microsoft SQL Server, Windows, and Windows 2000 are either registered trademarks or
trademarks of Microsoft Corporation in the United States and/or other countries.
All other Trade Names referred to are the Servicemark, Trademark, or Registered Trademark of the
respective manufacturers.
Last Updated: May 23, 2002 (SH)
 Using the Crystal Reports Templates With Citrix Resource Manager 3

Contents
• “Introduction” provides you with an introduction to the Citrix Resource
Manager Crystal Reports templates.
• “What Reports Are Available” shows you what report templates are available
and the information presented in them.
• “Getting Started” provides you with step-by-step instructions for installing the
Crystal Reports files and setting up your summary database to use the
templates.
• “Setting Up a Template and Creating a Report” provides you with step-by-step
instructions for setting up a Crystal Reports template and creating a report.

Introduction
Citrix has supplied a number of report templates, specifically designed for the
Citrix Resource Manager summary database, for use with Seagate Crystal Reports
software.
Using Crystal Reports gives you a greater range of options for creating reports and
manipulating the information in them than the normal Resource Manager reporting
functions. You can use the templates as is, or modify them to customize or extend
your summary database reporting.
Creating reports from a database requires accessing the information tables of the
database using the database schema. Database schema is a description of a database
in the language of the DBMS. The Crystal Reports templates use the summary
database schema to retrieve information from it for the report. The summary
database schema is documented in Appendix B of your Citrix Resource Manager
Administrator’s Guide. You can use the database schema to enable third party
programs to extend database reporting or querying beyond that which is supplied
with Resource Manager.
4 Using the Crystal Reports Templates With Citrix Resource Manager
What Reports Are Available
There are 16 Crystal Reports templates. The following table lists each report and
describes what you can include in each report and what information is shown.
Report Template
AppServerUsage
(Application Server Information)
AppUserInfo
(Application User Information)
CpuTimeInfo
(Application Time Information)
CpuUsageAllServers
(CPU Information)
CpuUsageTopTenServers
(CPU Information (Top Ten
Servers))
CpuUse
(Application CPU Usage)
FavApps
(User Favorite Applications)
MemoryAllServers
(Memory Information)
MemoryTopTenServers
(Memory Information (Top Ten
Servers))
Description
This report shows details for a selected process, a graph showing the percentage
of use for the process on the top ten farm servers it has been most used on
(ordered by most popular server), and the number of times it was executed on
each server. You can also select an individual server and/or user to further refine
the report. The process details include type, version, and the number of times
executed. Clicking Order by Server Name(s) reproduces the graph, ordered by
server name.
This report shows details for a selected process, and lists the users who have run
the process and the number of times they have run it (ordered by the number of
times run). You can also select an individual server and/or user to further refine
the report. The process details include type, version, and the number of times
executed. Clicking Order by Users reproduces the list, alphabetically ordered by
domain/user name.
This report shows time information statistics and details for a selected process.
You can also select an individual server and/or user to further refine the report.
The time information includes time loaded, time active, the active/loaded time
ratio, the total times for the process being loaded and active, and the first and last
recorded uses. The process details include type, version, and the number of times
executed.
This report shows the average processor time and average CPU interrupt time (as
percentages) for each farm server and for the farm as a whole. It also displays the
sample count, and the start and end dates of the report. Clicking on a server
name displays statistics and graphs for processor time as a percentage, and
interrupt time as a percentage for that server.
This report shows the average processor time and average CPU interrupt time (as
percentages) for the top ten most used servers in the farm, ordered from highest
average processor time, and for those servers as a whole. It also displays the
sample count, and the start and end dates of the report. Clicking on a server
name displays statistics and graphs for processor time as a percentage, and
interrupt time as a percentage for that server.
This report shows CPU usage statistics and details for a selected process. You
can also select an individual server and/or user to further refine the report. The
process statistics include overall CPU utilization, CPU utilization in both kernel
and user modes for when the process is both loaded and active. The process
details include type, version, and the number of times executed.
This report shows process information and session information for a selected
user. You can also select an individual server and/or process to further refine the
report. For each process, the report shows the name, version, total time loaded,
total time active, the active time as a percentage, the last time used, and the
number of times executed. The session information includes the number of
sessions, the number of processes executed, and the first and last session dates.
This report shows the page file usage (as a percentage) of each farm server, in
order from highest to lowest, and for the farm as a whole. Clicking on a server
name displays statistics and graphs for page file usage.
This report shows the page file usage (as a percentage) of the top ten most used
servers in a farm, in order from highest to lowest, and for those servers as a
whole. Clicking on a server name displays statistics and graphs for page file
usage.
 Using the Crystal Reports Templates With Citrix Resource Manager 5

Report Template Description

MemUse This report shows memory usage statistics and details for a selected process. You
(Application Memory Usage) can also select an individual server and/or user to further refine the report. The
process information includes active, peak and nominal memory working sets,
peak paged pool and non-paged pool, peak page file usage, and page faults. The
process details include type, version, and the number of times executed.

MetricDetails This report shows a graph of farm-wide metrics for the server farm over a selected
(Metric Information) report period. The graph shows the values for farm-wide metrics and the time at
each point on the graph. Clicking a server name shows a report for that server.
Individual server reports contain graphs showing the values for all server metrics
and the time at each point on the graph. The details for each server metric are
listed in tables showing the object, counter, instance, time, and value.

MetricReport This report shows details and a graph for a selected metric, on a selected server.
(Metric Report Per Server) Statistics for the metric values are shown as well as the start and end times of the
report, and the number of metric samples counted during the report period.

ProcessHistory
(User Application History)
This report shows the session history and details for a selected user. You can also
select an individual server and/or process to further refine the report. The process
information includes the start and end times for each use, the server the process
was executed on, the process name, exit code, and the percentage of process
loaded time that it was active. The session information includes the number of
sessions, the number of times the selected process was run, and the first and last
session dates.

ServerUse This report shows the session details for a selected user and a graph of their top
(Server Usage History) ten most used servers as percentages. You can also select an individual server
and/or process to further refine the report. The session details include the total
number of sessions, the total number of processes executed, and the first and last
session dates.

SessionHistory
(User Session History)
This report shows the session history for a selected user. You can also select an
individual server and/or process to further refine the report. The session
information includes the total number of sessions, the total number of processes
executed, the first and last session dates, the start and end times and the duration
of each session, and the number of processes run for each session. Clicking
Process List for a session shows a Session Process List report that shows all the
processes running during the session and their start and end times.

SystemSummary This report shows a summary for a server over a selected time period. The report
(System Summary) includes users who have accessed the server, the number of processes they
used, and the memory and CPU usage of those processes. Clicking on a server
name shows a system summary for that server. This report shows the server
metrics being recorded including the object name, counter, and instance for each
metric, as well as statistics for the metric values.
6 Using the Crystal Reports Templates With Citrix Resource Manager

Getting Started
The following sections describe the system requirements you need to use the
Crystal Reports templates, how to install the necessary files, and example
procedures for setting up a template, and creating a report.

Software Requirements
You need to have the following software to use the Crystal Reports templates:
• Citrix MetaFrame XPe 1.0, Feature Release 2
• Seagate Crystal Reports Version 8.5 or later
• Microsoft SQL Server Version 7 or 2000
—Or—
• Oracle Database Version 7, 8i or 9i
Refer to your Citrix MetaFrame XP 1.0, Feature Release 2/Service Pack 2
Administrator’s Guide and your Citrix Resource Manager Administrator’s Guide
for details on how to set up Citrix MetaFrame, Resource Manager, and a summary
database (Microsoft SQL Server or Oracle).
Crystal Reports can be installed on any computer that can connect to the server that
contains the summary database.

Installing the Files

! To install the files required for using the Crystal Reports templates
1. Download and decompress the template files (*.rpt) and the
SDBReportViews.sql. file for the database type you are using (Microsoft SQL
Server or Oracle) from http//:www. citrix.com/download.
2. Save a copy of the template files. You will modify these files when you set up
the templates.
 Using the Crystal Reports Templates With Citrix Resource Manager 7

Setting Up the Summary Database to Use the Templates

Installing the Views Into the Database
You need to install the views into the database. Crystal Reports uses each view to
extract information from the database in order to produce meaningful reports.

Note You need to create a summary database and turn on the summary database
function in Resource Manager before installing the views.

! To install the views in Microsoft SQL Server

1. Open the SQL Query Analyzer. To do this, choose Start > Programs >
Microsoft SQL Server > Query Analyzer.
2. In the Connect to SQL Server dialog box, select the server that contains the
summary database from the SQL Server list, then connect to it using the same
user and password credentials that the Resource Manager Database Connection
Server uses to connect to the summary database.
3. In the SQL Query Analyzer window, from the File menu, click Open. Select the
“SDBReportViews.sql” file, then click OK.
4. Select the name of your summary database from the DB list.
5. Install the views into the summary database by clicking Execute from the
Query menu, or clicking .

! To install the views in Oracle

1. Open the SQL Plus window. To do this, choose Start > Programs > Oracle >
Application Development > SQL Plus.
2. In the Log On dialog box, enter the service name of the summary database and
log on to it using the same user and password credentials that the Resource
Manager Database Connection Server uses to connect to the summary database.
3. In the SQL Plus window, type @d\SDBReportViews.sql, where d is the full
path to the file, then press ENTER.
8 Using the Crystal Reports Templates With Citrix Resource Manager

Setting Up a Template and Creating a Report

The following procedures shows you how to set up a Crystal Reports template and
create a report using Crystal Reports Version 8.5.

Setting Up a Crystal Reports Template

The first procedure sets the location of the database that the template’s required
report views access to create the report. The second procedure sets the contents of
the various choices (report parameter fields) that you can make when creating a
report; for example, farm names, server names, users, processes and the like. You
need only to set up each template once.

! Setting the database location for the report views

1. In Crystal Reports, open a template, for example, “FavApps.rpt.”
2. Set the database that is to be used to create the report (the summary database).
From the Database menu, click Set Location.
3. In the Set Location dialog box, select the “vwFavApps” views listed under
Databases, then click Set Location.
4. In the Data Explorer dialog box, navigate to the “rmsummarydatabase” system
DSN and expand it. If prompted, enter the authentication credentials used to
create the system DSN.
5. Click on the [databasename.userID.]vwFavApps table, then click Set.

Note The chosen view will depend upon which report template you are using.
In reports where more than one view is listed, choose any one of them.

6. At the Propagate Set Location prompt, click Yes. This ensures that all views
required for the report refer to the same database location.
7. In the Set Location dialog box, click Done.
8. In the Propagate Set Location prompt, click Yes. This ensures that all views
required for any sub-reports refer to the same database location.
A. If the report contains sub-reports, right-click on the sub-report, then click
Edit Subreport.
B. Repeat steps 2 to 7 for each sub-report.
C. After you have finished editing a sub-report, click .
 Using the Crystal Reports Templates With Citrix Resource Manager 9

! Setting parameter fields for the report

The following procedure populates the variables in the Enter Parameter Values
dialog box fields with values that you can use to create reports.

Note The data contained in the report parameter fields should be updated when
there are further variables added to the farm that affect reports; for example,
additional farms, users, processes, or servers and so on.
When creating a report, you can manually enter the variables you want to report on
into the Enter Parameter Values dialog box fields, instead of using the available
options.

1. From the Insert menu, click Field Object.

2. In the Field Explorer dialog box, expand the Parameter Fields node.
3. For each parameter field, right-click it, then click Edit.

Note You do not need to edit parameter fields if there is a “?” in the name.

4. In the Edit Parameter Field dialog box, click Set default values.
5. Select a value you want to set as default, then click . You can click to
set all the available values as defaults.
6. Click OK twice, then click Close.
7. Save the template.

Creating a Report
Once you have set up a template, you need only specify parameter fields and
discrete values to generate further report previews using it.
1. Open a template file that you have set up.
2. Preview the report by clicking Refresh Report Data from the Report menu, or
by clicking .
3. In the Enter Parameter Values dialog box, under Parameter Fields, click each
parameter field you want to use in the report, then select an appropriate value
for each from the Discrete Value list, or manually enter them.
4. Click OK. Crystal Reports populates the report with information from the
summary database using the report parameter field values you have entered.