Professional Documents
Culture Documents
September 2012
www.bmc.com
Telephone
Fax
Fax
If you have comments or suggestions about this documentation, contact Information Development by email at
doc_feedback@bmc.com.
Copyright 2012 BMC Software, Inc.
BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent
and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and
logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the
property of their respective owners.
IBM, DB2, and AIX are registered trademarks of International Business Machines Corporation in the United States, other countries, or
both.
Linux is the registered trademark of Linus Torvalds.
UNIX is the registered trademark of The Open Group in the US and other countries.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is
subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted
rights notices included in this documentation.
Customer Support
You can obtain technical support by using the Support page on the BMC Software website or by contacting Customer
Support by telephone or email. To expedite your inquiry, please see Before Contacting BMC Software.
Support Website
You can obtain technical support from BMC Software 24 hours a day, 7 days a week at
http://www.bmc.com/support_home. From this website, you can
Read overviews about support services and programs that BMC Software offers.
Find the most current information about BMC Software products.
Search a database for problems similar to yours and possible solutions.
Order or download product documentation.
Report a problem or ask a question.
Subscribe to receive email notices when new product versions are released.
Find worldwide BMC Software support center locations and contact information, including email addresses, fax
numbers, and telephone numbers.
Product information
Product name
Product version (release number)
License number and password (trial or permanent)
Machine type
Operating system type, version, and service pack
System hardware configuration
Serial numbers
Related software (database, application, and communication) including type, version, and service pack or
maintenance level
Messages received (and the time and date that you received them)
White Paper
This white paper explains how to use BIRTTM reporting tools with BMC Remedy
Action Request System Web reports. BIRT is an open source, Eclipse-based
reporting system.
Using Web reports and the BIRT Report Designer, you can:
Create reports based on BMC Remedy AR System data in the BIRT Report
Designer, and then deploy those reports to the AR System server using the
Report form.
Modify out-of-the-box Web reports in the BIRT Report Designer, and deploy
those reports to the AR System server using the Report form.
IMPORTANT
This white paper is intended for administrators with expertise using BMC Remedy
AR System Web reports and the BIRT Report Designer.
This white paper is only intended to document what is specific or different to
modify reports for BMC Remedy AR System.
For information and tutorials about using the BIRT Report Designer, choose Help
> Help Contents in the BIRT Report Designer. For additional information about
the BIRT Report Designer, see http://www.eclipse.org/birt.
For information about Web reports, see the BMC Remedy Mid Tier Guide.
This white paper guides you through the following process:
Step 1 Install the BIRT Report Designer to work with Web reports
Step 2 Enable BIRT to access your BMC Remedy AR System data by setting resource and
White Paper
Installing the BIRT Report Designer to work with AR System Web reports
(page 6)
Enabling BIRT to access your BMC Remedy AR System data by setting BIRT
preferences (page 7)
Creating a new report with the BIRT Report Designer (page 10)
Deploying BIRT reports to the AR System server using the Report form
(page 23)
Examples for modifying reports with the BIRT Report Designer (page 27)
NOTE
For information about system requirements for the BIRT Report Designer, see the
Eclipse documentation.
NOTE
The BIRT Report Designer is a 32-bit application, and requires a 32-bit Java
installation.
2 Extract the BIRT Report Designer zip file to a destination directory
(BIRTInstallDir).
3 To open the BIRT Report Designer application, click the BIRT.exe executable file.
The BIRT Report Designer application opens. Now, proceed to Enabling BIRT to
access your BMC Remedy AR System data by setting BIRT preferences on page 7.
your browser:
2 In the Type field, select BIRT Library, and then click Search.
Enabling BIRT to access your BMC Remedy AR System data by setting BIRT preferences W 7
White Paper
directory.
directory.
example:
BIRTInstallDir/Library/Resources
the Resources directory into the Resources folder field, and then click OK.
Figure 1-3: Resource panel for Preferences in the BIRT Report Designer
path.
Enabling BIRT to access your BMC Remedy AR System data by setting BIRT preferences W 9
White Paper
18 In the Preferences box, choose Report Design > Templates, and copy the path for
the Templates directory into the Template folder field, and then click OK.
Figure 1-4: Template panel for Preferences in the BIRT Report Designer
Create a new report file in the BIRT Report Designer (page 11)
click Finish.
The new report appears in the Layout editor pane of the BIRT Report Designer.
Figure 1-5: New report in the BIRT Report Designer
White Paper
NOTE
If the Data Explorer tab is not open, choose Window > Show View > Data
Explorer.
2 In the New Data Source box, make sure Create from a data source type in the
follow list (default) and BMC Remedy AR System ODA Data Source (default)
are selected, and then click Next.
Figure 1-7: New Data Source box
NOTE
If BMC Remedy AR System ODA Data Source does not appear as a selection in
the New Data Source box, make sure the correct BMC Remedy AR System plugin files were copied to the BIRT install directory. For more information, see To
copy BMC Remedy AR System plug-ins for use with BIRT on page 7.
3 In the New BMC Remedy AR System Designtime Data Source Profile box, enter
the User Name and Server for the AR System server data source.
Figure 1-8: New BMC Remedy AR System Designtime Data Source Profile
source information, and then test the connection again until you are successful.
NOTE
You must create a BIRT data source before you build a data set. For details, see To
enable data access for a BIRT report by creating a data source on page 11.
White Paper
1 In the BIRT Report Designer, go to the Data Explorer tab, right-click Data Sets, and
2 Configure the New Data Set box by doing the following tasks:
a Enter the Data Set Name. For example, Incident Data Set.
b Under the Data Source node, select the data source, and then click Next. For
b Click Add. The Available Fields box displays all fields in the selected form.
White Paper
c Select the fields you want to include in the report, and then click OK. You can
d In the Qualification field, enter the criteria to be used for the query, click Verify,
and then click Finish. Enter the qualification using the format 'field' operator
For example, 'Status' !="Closed" for the incidents that are not
closed.
"Parameter".
e Click Finish.
NOTE
BMC recommends using query for a data set instead of filters. Data set filters are
applied to the entire result set, and can impair performance. Use the qualification
in the query configuration to filter data.
4 If you want to change a column label in a report (for example, change the Short
c Click OK.
NOTE
For a description of the parameters that can be configured in the Data Set editor,
see the BIRT online help.
The data that fills in the criteria of the data set appears in the right pane of the Edit
Data Set box.
Figure 1-13: Preview Results in Edit Data Set
White Paper
2 Save the new BIRT report by choosing File > Save As, and then enter a meaningful
3 Click Finish.
NOTE
To deploy the newly created BIRT report to the AR System server using the Report
form, see To import the .rptdesign file from the BIRT Report Designer to the
Report form on page 21 and Deploying BIRT reports to the AR System server
using the Report form on page 23.
IMPORTANT
Before modifying an out-of-the-box Web report with BIRT, BMC recommends
saving a copy of the report definition file (.rptdesign file) and its corresponding
record in the Report form.
To make sure that future upgrades do not overwrite your modified Web report, set
Status to Pending or Inactive.
You can also import your original exported Web report (.rptdesign file) to a
different AR System server. For details, see Importing a Web report to a different
AR System server on page 22.
2 Search for an out-of-the-box Web report that you want to edit, and select the report
3 In the Instance ID field, copy the Instance ID value of the report you want to edit.
4 Open the Report Definition form, paste the Instance ID you copied in the previous
step from the Report form into the Report Definition GUID field, and then click
Search.
5 In the search result, right-click the attached .rptdesign file, and then click Save.
6 Save the .rptdesign file to a folder where you store reports.
White Paper
Figure 1-15: Saving the report file in the Report Definition form
2 Edit the report using the BIRT Report Designer, and then Save the edited file.
NOTE
For details about modifying reports with the BIRT Report Designer, such as adding
a row or column, see the BIRT Report Designer help.
Modifying reports with BIRT Report Designer is discussed further in Examples
for modifying reports with the BIRT Report Designer on page 27.
2 In the Report Definition File area, right-click the .rptdesign file, and click Add.
Figure 1-16: Adding a file in the Report form
4 In the Add Attachment window, click Choose File, then browse and select the
.rptdesign
file you edited in the BIRT Report Designer, and click OK.
White Paper
a When you search for an out-of-the-box report in the Report form, select the Print
Incident report.
NOTE
BMC recommends the process in this section instead of the one detailed in
Modifying an out-of-the-box Web report with the BIRT Report Designer on
page 18.
file.
3 Import the .arx file to the target AR System server using the BMC Remedy Data
Import Tool.
To make sure that duplicate report entries are not created in the target AR System,
import the report file using the following fields as key fields: Report Set Name,
Locale, and Report Type. This is a concern when a report has been modified and
a fixed report is being moved.
Configuring how the report is filtered by the Category menu in the Report
Console
Before you start, determine where in the Category menu hierarchy you want the
report to appear. As shown in Figure 1-19, this affects how you complete the
Category 1 (for example, Incident), Category 2 (for example, Open Incidents), and
Category 3 (for example, Count by Assignee Group) fields in step 3 on page 24.
You can complete up to three Category fields, or you can create your own
categories, using the Category fields.
Figure 1-19: Category menu in the Report Console
Deploying BIRT reports to the AR System server using the Report form W 23
White Paper
2 In the Report form, click New Request to create a record for the report.
3 Complete the required fields of the form and the Category fields. Enter unique,
meaningful names for the Report Name and Report Set Name.
4 Attach the report definition file for the report to the request by doing the following:
a Click Add.
b Attach the .rptdesign file for the report.
c Click OK.
Figure 1-21: Attaching the .rptdesign file to a new request in Report form
7 To open the Report Definition form, type the following URL into your browser:
http://midTierServer/arsys/forms/ARSystemServer/Report Definition
8 In the Report Definition form, paste the Instance ID you copied for the report in the
Figure 1-23: Report Definition GUID field in the Report Definition form
9 Click Search. The search results show the report design file for the report you are
Deploying BIRT reports to the AR System server using the Report form W 25
White Paper
NOTE
The procedures in this section are also discussed in the BIRT Report Designer
online help.
This section discusses the following topics:
Using a stacked bar chart to compare different series of results (page 60)
and then selecting the file. The report opens in the Layout tab of the layout editor.
2 In the Data Explorer tab, right-click a data set under the Data Sets node, and drag
White Paper
Figure 1-27: Data set element dragged into layout editor in the BIRT Report Designer
Data set in Data Explorer tab
After you drop the data set into the layout editor, the table is automatically created
with the fields you selected for the data set.
Figure 1-28: Table for an unformatted report
3 In the bottom left corner of the table, click the Table icon. The icons for other parts
4 Right-click the icon of the report element to which you want to apply a style, then
choose Style > Apply Style, and select a style appropriate for the report element.
For example, apply the bmcReportTheme:TableHeader theme to the Table-Header.
Figure 1-30: Selecting a style
White Paper
Edit.
tab and double-click a data set under the Data Sets node.
White Paper
4 In the Available Fields box, select the fields you want to sort by in the report, and
then click OK. For example, select the Status and Assignee Groups fields.
5 Preview the report to make sure the report is sorted by the parameter you added
If the report is not sorted as expected, review step 2 through step 4. In the
following figure, the report is sorted by the Status parameter.
Figure 1-36: Example: report sorted by a Status parameter
click the table header row, and select Insert Group in the submenu.
Figure 1-37: Layout editor
want to group the results, and then click OK. In Figure 1-38, the Status parameter
is selected in the Group On list so that the results are grouped by status.
3 Preview the report to make sure the results are grouped by the parameter you
configured in the New Group box. To preview the report (Save, Run, and Close),
repeat the procedures in step 5 on page 32. If the report is not grouped as expected,
review step 2.
In Figure 1-39, the report is grouped and sorted by the Status parameter. The first
Assigned row has no data, then the next Assigned rows contain records. Then the
first In Progress row has no data, then the following In Progress rows contain
records.
Figure 1-39: Report sorted by a parameter
White Paper
4 To apply a style to the group header, go back to the report file in the Layout tab,
2 In the Aggregation Builder box, configure a report row by doing the following
tasks:
White Paper
3 Preview the report (Save, Run, Close). To preview the report, repeat the
This report groups results by the parameter you configured in the New Group box
in, and displays the number of incidents in the Table Group Header row for
incidents with Assigned and In Progress.
Figure 1-44: Report displaying number of incidents and sorted by group
To add a column
1 In the BIRT Report Designer, go to the Layout pane of a report.
2 Click a column above its table header to select the entire column in a table.
Figure 1-45: Highlighting a column in the Layout pane
3 Right-click in the selected column and choose Insert > Column to the Right (or
Left).
4 Go to Data Explorer tab and drag a data set into the new column (for example, Data
Explorer tab > Data Sets > HPD_Help_Desk > Incident Number).
To add a parameter
1 In the BIRT Report Designer, go to the Outline tab and right-click Report
Parameters.
White Paper
Explorer tab, right-click the appropriate data set, click Edit, click Parameters, and
click New.
10 In the New Parameter box, configure the new parameter by doing the following
tasks:
a In the Name field, type the name of the new parameter in the data set.
NOTE
Select one of the following two options as the Default Value field (see step c on
page 39) can only be edited if you do not edit the Linked to Report Parameter field.
b In the Linked To Report Parameter field, select the name of the new parameter
c In the Default Value field, edit the qualification query of the data set based on
the report parameter that you linked to in step b on page 38. For example, enter
the following in the Expression Builder:
'License Type' = [param:dsLicenseType]
where dsLicenseType is the data set parameter which refers to the report
parameter.
11 Preview the report (Save, Run, Close). To preview the report, repeat the
The Parameter box of the report appears and specifies a fixed License type
parameter. The report shows People records having a fixed License type.
White Paper
want to edit, and save its .rptdesign file to a folder where you store reports. For
details, see To export a .rptdesign file from the Report form to the BIRT Report
Designer on page 18.
a In the Report form, search for a report with the words Date and Range in its
b Select a report. For example, the Expiring Contracts by Date Range report.
2 In the BIRT Report Designer, choose File > Open File, and open the .rptdesign file
4 To edit a report parameter, right-click the report parameter you want to edit, and
NOTE
For details on editing parameters, see the BIRT Report Designer online help.
For example, if you want to edit the Start Date field, right-click Start Date.
5 If you want to see how a parameter is filtered for a data set, go to the Data Explorer
tab, right-click the data set you want to examine, click Edit, then click Filters.
White Paper
NOTE
For details on editing a filter condition, see the BIRT Report Designer online help.
If a customer listing provides a customer ID, that customer ID can be input into
a subreport that displays details about each customer. An ID value is often the
common data between two data sets.
If a parent report displays only the amount spent (or other customer data), a
subreport can provide customer details (such as address). A subreport can show
a combined parent report and subreport.
Testing each subreport before building the next subreport can help minimize
difficulties that can arise with subreports.
NOTE
The example in this section provides high-level instructions. Subreports are
discussed in detail in the BIRT Report Designer online help.
To create a subreport
1 Design the structure of a report and its subreports. This includes details of required
data sets and how they are related, and can be a simple relationship diagram of
forms.
2 Create a data source and a required number of data sets. For an example, consider
a parent "People" report that can have an added subreport, which shows roles
attached to a particular people record.
The relationship structure is: CTM:People (Person ID) >
CTM:SupportGroupFuncRoleLookUp (Person ID)
This structure has two data sets that are required to develop the subreport. The two
required data sets are CTM:People and CTM:SupportGroupFuncRoleLookUp.
3 Create the required data sets as follows:
a Create a data set for the parent record (CTM:People).
b Create a data set for the child records (CTM:SupportGroupFuncRoleLookUp).
c In the Parameter tab of data set creation for child record, create a parameter for
the parent key based on which will pull child records. For example, the key will
be Person ID. Do not link the parameter to any report parameter.
4 Click Query and modify the query as follows to pull child records having a key
5 Insert a second table element inside the new detail row of table. The child table
parameter.
White Paper
10 Preview the report (Save, Run, Close). To preview the report, repeat the
NOTE
Adding interactive features, such as hyperlinks, to charts is discussed in detail in
the BIRT Report Designer online help.
Drill down reports are summary reports which can be drilled through to get
related detail data in other reports at a granular level. The first report presented in
a series of drill down reports provides only required or necessary data, and then
the user decides whether they want further details. By adding hyperlinks, you
make drill down reports interactive for your user.
For example, a report first might show only a pie chart, which summarizes the
report results. When a user clicks a slice of the pie chart, a detailed report opens for
that particular slice of data.
The following scenario looks at the report development of the All incidents by
Status and assigned Group drill down report in ITSM.
For example, the example report has a high number of incidents based on their
status. The incidents have a particular status and are assigned to groups. There are
also records for the incidents. A particular record in an incident form can provide
details of that incident. Therefore, the design of this drill down report needs the
following levels:
Figure 1-57: Drill down report design example
In this example:
- A pie chart shows Incident Count categories based on Status
White Paper
- A bar chart shows the Incident Count by Assigned Group for the Status slice
selected in the pie chart
- A detailed incident report based on the Assigned Group bar selected in the bar
chart
2 Create a data source and data set required for a report (for example, HPD: Help
Desk).
6 Insert groups in the table by right-clicking in the detail row of the table and
selecting Insert Group. Insert the first group based on Status, and the second
group based on Assigned Group.
7 Insert a chart in the table by right-clicking in a table header and choose Insert >
Chart. Insert a pie chart showing the number of Incidents categorized based on
Incident Status.
Figure 1-58: Drill down report pie chart example
8 In the Status group header (header of first group) of the table, insert a bar chart,
which will show the number of Incidents categorized based on Assigned Group.
9 In the second group header, choose Insert > Grid to display details of Incident
10 In the first group header, right-click and select Properties, select Bookmark in the
row["Status"]
White Paper
This starts the process of adding drill down functionality by hyperlinking to the
table. When clicking on a particular slice of the Status pie chart, the bar chart
should appear and show details based on the Assigned Group of that Status.
11 To set the bookmark with a hyperlink to the pie chart, right-click the pie chart
created in step 7 on page 46, and choose Format Chart > Series > Value Series >
Interactivity, then click Add in the Series Interactivity box.
Figure 1-62: Editing the pie chart
Value series
Interactivity
12 In the Hyperlink Editor box, type the name of the hyperlink in the Name field, and
13 In the Hyperlink Options box, select Internal Bookmark, and then select the
This adds the functionality for clicking a particular slice of a pie chart, then
navigating to a bar chart that shows the incident count of a selected Status based
on the Assigned Group.
14 Create a hyperlink for a bar chart by repeating the process from step 10 on page 47
OK. This new parameter will be used in script to fetch the mid tier URL.
White Paper
2 Select a data set. In this example, select the HPD:Help Desk data set.
3 Go to the Script tab of the report, and select the BeforeOpen event in the Script list.
The script fetches the MidTier URL at runtime and sets it to the hidden parameter
created in step 1 on page 49.
Figure 1-65: Script tab of the report
4 Go to Layout tab of the report, and select Incident Number, which was inserted in
6 In the Hyperlink Options box, select URL as the hyperlink type, and enter the
following value:
White Paper
<Field Name>.OBJECT
<Field Name>.VALUE
<Field Name>.TYPE
OBJECT is of type String and has currency value as well as currency type.
tab and double-click a data set under the Data Sets node.
3 Click New.
4 In the Column Name field, type a name for the computed column.
5 In the Data Type field, select Decimal.
6 In the Expression field, type the expression. For example:
if (row["Associated Cost.OBJECT"].toFunctionalValue(params["Currency
Type"].value)
The function on the currency field object named toFunctionalValue requires input
as the expected currency type, which is obtained from the user parameter. The
function returns Decimal currency value converted to a given currency type.
7 Click OK, then click Preview Results.
Preview Results in Figure 1-70 shows the currency field converted into the
.OBJECT, .VALUE, and .TYPE columns.
White Paper
Using subreports if using the BIRT Report Designer. See Using subreports to
link reports together on page 42.
Creating a join form to create a Web report. See the BMC Remedy Mid Tier Guide.
This report starts with the Assigned Groups field in the left column. You can merge
table group header cells and add a label to the left of the data set field as shown.
Figure 1-71: Viewing the report in the Layout tab
3 In the Layout pane, add a column for the Incident Number to the right of the
Assignee column. For details on adding a column, see Adding a column to report
results on page 36.
Figure 1-73: Adding a second column
White Paper
4 Add another column for the Submit Date to the right of the Incident Number
column.
The report shows columns for the Assigned Groups, Incident Number, and Submit
Date.
Figure 1-74: Report preview after adding two columns
6 In the Layout pane, right-click in the Table Group Header row, and choose Insert
7 In the New Group box, select Status in the Group On list, then click OK. The
8 Right-click the Status group, and select a Group Header style for it.
Figure 1-77: Selecting a style for the Status group
9 Apply a style to the other group headers and other rows in the table.
10 For formatting, merge the Status table group header cells and add a label to the left
Figure 1-78: Merging and labelling the Status table group header
11 Right-click in the Status group header row, and choose Insert > Grid.
12 In the Insert Grid box, set the grid size as 2 columns and 1 row.
White Paper
The report shows the results grouped by their Assigned Group (for example, A
Test Support, ABC Group) and then grouped by their Status (for example,
Assigned and In Progress).
Figure 1-80: Report preview showing grouping by Assigned Group and then Status
To take the grouping to another level, this example now adds the Assignee group
within the Assigned Group group.
14 Right-click in the Status table group header, and choose Insert Group > Above.
15 In the New Group box, set the grid size as 2 columns and 1 row
16 New Group box, select Assignee in the Group On list, then click OK. The
17 For formatting, merge the Assigned table group header cells and add a label to the
Figure 1-82: Merging and labelling the Assigned table group header
18 Right-click in the Assigned group header row, and choose Insert > Grid.
19 In the Insert Grid box, set the grid size as 2 columns and 1 row.
20 Save and run the report to preview it.
The report shows the results grouped by their Assigned Group (for example, A
SupGrp), then grouped by Assignee (for example, A1 User), and then grouped by
their Status (for example, Assigned and In Progress).
White Paper
Figure 1-83: Report preview showing grouping by Assigned Group, then grouped by
Assignee, and then Status
help.
2 Configure the data set for the report by adding the Status, Assignee Groups,
3 In the Layout pane, right-click in the report layout and choose Insert > Chart.
4 On the Select Chart Type tab of the New Chart box, select Bar as the Chart type,
b Under In the Value (Y) Series, configure at least two series of data for Status
White Paper
c Under In the Value (X) Series, configure a series of data for Assignee Groups
6 Preview the report (Save, Run, Close). To preview the report, repeat the
If the bar chart needs adjustment, click the Binding tab in the Property Editor for
the chart and review the data binding settings.
*271662*
*271662*
*271662*
*271662*
*271662*