Professional Documents
Culture Documents
User Guide
Version 1.8
January 2017
RM-18-UG-02
Notices
Edition
Publication date: January 2017
Book number: RM-18-UG-02
Product version: Version 1.8
Copyright
© Rocket Software, Inc. or its affiliates 2008-2017. All Rights Reserved.
Trademarks
Rocket is a registered trademark of Rocket Software, Inc. For a list of Rocket registered trademarks go
to: www.rocketsoftware.com/about/legal. All other products or services mentioned in this document
may be covered by the trademarks, service marks, or product names of their respective owners.
Examples
This information might contain examples of data and reports. The examples include the names of
individuals, companies, brands, and products. All of these names are fictitious and any similarity to
the names and addresses used by an actual business enterprise is entirely coincidental.
License agreement
This software and the associated documentation are proprietary and confidential to Rocket Software,
Inc. or its affiliates, are furnished under license, and may be used and copied only in accordance with
the terms of such license.
Note: This product may contain encryption technology. Many countries prohibit or restrict the
use, import, or export of encryption technologies, and current use, import, and export regulations
should be followed when exporting this product.
2
Corporate information
Rocket Software, Inc. develops enterprise infrastructure products in four key areas: storage, networks,
and compliance; database servers and tools; business information and analytics; and application
development, integration, and modernization.
Website: www.rocketsoftware.com
Rocket Global Headquarters
77 4th Avenue, Suite 100
Waltham, MA 02451-1468
USA
To contact Rocket Software by telephone for any reason, including obtaining pre-sales information
and technical support, use one of the following telephone numbers.
3
iv
Table of Contents
Rocket Aldon Report Manager ..................................................................................... 1
Introduction to Report Manager .................................................................................... 1
Abbreviations............................................................................................................. 1
About Rocket Aldon...................................................................................................... 1
What's New in Version 1.8 ........................................................................................... 2
Technology .................................................................................................................. 2
vi
LM(i) Task Activity Time Log Report ........................................................................ 67
LM(i) Task Objects Report ....................................................................................... 69
LM(i) Task Summary Report.................................................................................... 70
LM(i) Release Reports ............................................................................................... 74
LM(i) Active Tasks Associated with Release Report ................................................ 74
LM(i) Release Summary Report .............................................................................. 75
LM(i) Activity Reports ................................................................................................. 80
About LM(i) Activity Reports .................................................................................... 80
LM(i) Activities by Object Report.............................................................................. 80
LM(i) Activities by Release Report ........................................................................... 82
LM(i) Activities by Task Report ................................................................................ 84
LM(i) Activities by Type Report ................................................................................ 85
LM(i) Activities by User Report ................................................................................ 87
LM(i) Activity Summary by Type Report................................................................... 89
LM(i) Activity Summary by User Report ................................................................... 90
LM(i) Promotion Activities for Environment by Object Report ................................... 92
LM(i) Promotion Activities for Environment by Task Report ..................................... 94
LM(i) Promotion and Checkout Activities by Object ................................................. 96
LM(i) Deployment Reports........................................................................................ 100
LM(i) Deployed Object History by Release Report ................................................. 100
LM(i) Deployment Sets by Release Report ............................................................ 102
LM(i) Permission Reports ......................................................................................... 105
LM(i) Permissions by Release Report.................................................................... 105
LM(i) Permissions by User Report ......................................................................... 107
vii
Pages to Print........................................................................................................ 116
Printing a Report on the BIRT Server .................................................................... 117
Report Navigation Bar ........................................................................................... 117
Appendix E - Accessing the LM Databases via Report Manager .............................. 119
Appendix F - Exporting from RM .............................................................................. 120
Exporting Report Data ........................................................................................... 120
Exporting the Data ................................................................................................ 122
Exporting a Report ................................................................................................ 122
Appendix G - Entering/Updating the RM License Information................................... 125
Entering License Information for the First Time ..................................................... 125
Updating License Information ................................................................................ 126
Appendix H - Known Issues ..................................................................................... 128
Browser Settings ................................................................................................... 128
Unpredictable Results Using the Microsoft PowerPoint Output Option .................. 128
Report Title Affects Export to Microsoft Excel ........................................................ 128
Appendix I - Licenses ............................................................................................... 129
Licenses ................................................................................................................ 129
License Agreement ............................................................................................... 129
Appendix J - Resources ........................................................................................... 130
RM ........................................................................................................................ 130
LM(e) .................................................................................................................... 130
LM(i) ...................................................................................................................... 130
Accessing Documentation on the Web Site ........................................................... 130
Adobe PDF ........................................................................................................... 130
BIRT Documentation ............................................................................................. 131
Tomcat Documentation ......................................................................................... 131
Appendix K - Customizing the Report Logo.............................................................. 132
viii
Report Manager User Guide Rocket Aldon Report Manager
Abbreviations
Throughout the remainder of this document, we will use short names to refer to the various Rocket
Aldon products, as described in the following table.
1
Getting Started with Report Manager Report Manager User Guide
For more information about us and our products, visit our web site at
http://www.rocketsoftware.com/product-families/rocket-aldon.
Technology
Report Manager is a web-based application that uses the following technologies:
A web browser (must be installed on your local PC). Currently supported browsers are:
o Microsoft Internet Explorer Version 9 or higher (in compatibility mode);
OR
o Mozilla Firefox Version 16.0 or higher;
OR
o Google Chrome Version 20.0 or higher.
Rocket Aldon Security Server (See Appendix E - Accessing the LM Databases via Report
Manager.)
Apache Tomcat web server for Windows.
Eclipse Business Information Reporting Tools (BIRT). (See Appendix B - BIRT Overview.)
Java Runtime Environment (JRE).
Java Database Connectivity (JDBC).
Server running Windows 2008 Server, 64-bit; or Windows 2012 Server, 64-bit.
Note: Apache Tomcat and Eclipse BIRT have the following requirements:
Must both be installed on the same computer, and that computer must be accessible to your
local PC via a TCP/IP network
Must both be accessible to the server that hosts LM(i) and LM(e).
Note: BIRT, Apache Tomcat, JRE, and JDBC are installed along with the Report Manager.
2
Report Manager User Guide Getting Started with Report Manager
RM allows users to produce reports containing detailed information about the status of parts or
objects that are under management by your Rocket Aldon products, and about the tasks associated
with the development of those items. Users can also produce reports that show the status of LM(i)
deployments and permissions.
Users access RM from a Web browser. From the browser window, users select a report to run,
identify the parameters necessary to generate the report, and indicate their preferences for the
resulting report output.
RM ships with a set of named, pre-defined report parameter sets for both LM(e) and LM(i). The
names of these parameter sets are the report names you see on the RM home page.
Except for the customizable reports, the layout of each report is fixed based on its pre-defined
report design file. Report design files are not visible on the RM home page. Read Available
Reports for more about report design files. Read About Custom Reports for more about customizing
eligible reports.
Report Input
When users run a report, they can request that all relevant data be included in the report, or they
can choose a subset of the available data by specifying a set of selection criteria. The selection
criteria consist of a range of possible values for each of several data elements in the report. Those
database records that meet all of the selection criteria are included in the report, while those that do
not are excluded.
Rocket Aldon designates the fields that are used as selection criteria for each report.
Users define report content by specifying values for each of three categories of report parameters:
1. Selection criteria parameters;
2. Date parameters (if they are present); and/or
3. Output control parameters.
Read About Report Parameters for more.
The size of your database - particularly the amount of activity information you have logged - can
affect the speed with which some reports return output. This is especially true of reports containing
activity-related information.
Report Output
A variety of output formats are available into which your reports can be rendered. Some of these
output formats are best for immediate viewing; other formats are better for embedding your reports
into other documents, presentations, or spreadsheets. The available report output formats and their
optimum use are:
For more about report output options, read Appendix C: Report Parameters Permissible Values.
3
Getting Started with Report Manager Report Manager User Guide
5
Getting Started with Report Manager Report Manager User Guide
If this instance of RM has a Permanent License in effect, the About Report Manager dialog appears
as shown below.
6
Report Manager User Guide Getting Started with Report Manager
When this occurs and you intend to continue using Report Manager, contact your Rocket Aldon
Account Manager to obtain a Permanent License.
On the above display, the text "License Validation Error" is a link. If you click on the link, the
following is displayed.
7
Getting Started with Report Manager Report Manager User Guide
Upon successful connection, the RM logo appears in the address line. If you are using the
Mozilla Firefox browser, the logo is also placed on each tab that is opened via RM.
The RM home page appears. (See RM Home Page.)
8
Report Manager User Guide Getting Started with Report Manager
The report category header for the "Reports" category. Note: If this instance of RM
is operating under a Test Drive Trial License, then the right end of the Report
2 category header will contain the text "License expires in NN days on DD-Mon-YY".
Otherwise, the right end of the header is blank. (See Report Manager Licensing.)
3 The open/close button for the report category. (See Report Categories.)
4 A report folder.
Buttons for customizing report columns. (Applies to eligible reports only - see
6 Customizing Report Content.)
9
Getting Started with Report Manager Report Manager User Guide
Customize Button
Clicking the Customize button for a report opens the Select Report Fields dialog, which is
used – for specific eligible reports – to include or remove columns of data in the report and to
supply a title for the custom report. For a list of reports that are eligible for customizing, read About
Custom Reports.
Run Button
The Run button is used to launch a report.
When the Run button for a report is green , a value has been entered or selected for all of the
report parameters that are relevant to the report type. The report is launched upon clicking the
green Run button or the report name.
When the Run button for a report is yellow , a value has not been entered or selected for
some or all of the report parameters that are relevant to the report type. If you click the yellow Run
button or the report name, the Report Parameters dialog is opened to give you the opportunity to
enter or select the missing parameters.
Options Button
Clicking the Options button opens the Report Parameters dialog, which is used to define the
subset of data to be included in the associated report.
Help Button
Clicking the Report Help button opens the on-line help topic for the associated report. The help
topic for each report describes the report content in detail.
Report Categories
A report category is a container that holds both reports and report folders. A report category can
either be "open" or "closed". An open report category is shown below.
To open a report category, click the "plus" button on the right side of the report category header.
10
Report Manager User Guide Using Rocket Aldon Report Manager
Report Folders
RM reports are stored in report folders. Report folders exist within a report category. A report folder
is a tree structure, similar to a file directory structure, and it can contain any number of reports and
sub-folders.
A report folder is identified by the presence of a folder icon located immediately to the left of the
folder name. There are two versions of the folder icon:
Indicates a report folder that is "closed", i.e., the contents are not shown.
Indicates a report folder that is "open". The included report folders and report, if
any, are shown indented below the folder name.
In addition to the folder icon indicating a folder, the folder name is shown in bold type.
To open a closed report folder, click once on the folder icon. To close an open report folder, click
once on the folder icon.
Running a Report
In this context, running a report means running a particular report with a particular set of report
parameters. When you run a report, depending on the value specified for the Output Type
parameter, the resulting report will either be displayed in your browser or produced in an external
file. (See Appendix D - Report Options.)
To run an RM report:
Launch Report Manager. (See Launching Report Manager.)
Expand the list of report folders on the Report Manager home page until the desired report
name is exposed. Choose one of these ways to run a report:
o When the Run button for the report is green , a value has been entered or selected
for all of the report parameters that are relevant to the report type. The report is
launched upon clicking the green Run button.
11
Using Rocket Aldon Report Manager Report Manager User Guide
o When the Run button for the report is yellow , values for some or all of the report's
relevant parameters are missing. If you click the yellow Run button or the report name,
the Report Parameters dialog opens so you can provide the missing parameter value(s).
o Click on the report name. The result depends on the color of the Run button (see
previous two bullet points).
After defining the new set of report parameters, you can:
o Run the report with the new parameter set by clicking the Run button on the Report
Parameters dialog; OR
o Save the new report parameters for the existing report; OR
o Define a new report parameter set by clicking the Save button on the Report Parameters
dialog.
After you run a report, return to the RM home page. Notice that the Report Parameters dialog
containing the parameter values you selected remains in focus. This feature allows you to see the
results of your choices before you decide whether to save the report parameter set.
Note: Even if you do not save the report parameter set, RM "remembers" the last set of report
parameter values used for each report for your entire Report Manager session. (An RM session is
everything that happens after you open RM in your browser, until you close the browser.) This way,
if you specify a particular set of parameters in a session, you can repeat that report at any time
during the session, with the same parameter set, by re-running the report.
Each time you run a report with the HTML output type, RM opens either a new browser window or a
new browser tab, depending on your browser's capabilities and settings. While the RM server is
collecting the data, a progress meter like this appears in the newly opened window:
When the server finishes collecting the data and formatting the report, the report itself appears in
the browser window.
Available Reports
RM ships reports for both the LM(e) and LM(i) products. The reports are organized in type
categories by product, as follows:
12
Report Manager User Guide Using Rocket Aldon Report Manager
1 - Supplemental reports are reports that are run from within other reports by clicking a link.
2 - Link(s) for this supplemental report appear in the LM(e) Release Summary report.
3 - Link(s) for this supplemental report appear in the LM(e) Activities by Release, Type and User
reports.
Note: In some versions of Internet Explorer, an ‘x’ appears on a parameter as you make your
parameter selections to indicate where the browser is focused. The ‘x’ does not indicate a problem.
14
Report Manager User Guide Using Rocket Aldon Report Manager
The selection criteria fields vary by report, and might include one or more of the following fields:
Group name
Application name
Release name
Version name
Task name
Environment abbreviation
User name
Activity type
Part name
Object name
Object type
Scope of authorities
For detailed information about valid values for these fields, including exceptions and rules, read
Appendix C - Report Parameters: Valid Values.
About cascading selection criteria parameter relationships
Certain selection criteria parameters have what we call a cascading relationship. When a cascading
relationship exists, your value selection for one parameter limits the value choices available for
another parameter. For LM(i) reports, the Group, Application, and Release parameters have a
cascading relationship. For LM(e) reports, it is the Group, Application, Release, and Version
parameters that cascade.
When necessary, the Report Parameters dialog prevents you from supplying a value for a
cascaded parameter until you have supplied values for all parameters higher in the relationship.
Using Wildcards
The % wildcard character can be used in any selection criteria parameter field. The % wildcard
character, when specified, represents any one or more contiguous characters. Some examples of
wildcard usage are:
A%C matches ABC, AXC, AXXC, AXXXXC, etc.
A%B%C matches any value whose first letter is A, last letter is C, and has the letter B
anywhere in between the first and last letters.
A% matches all values starting with the letter A
%A matches all values ending with the letter A
% matches all values (equivalent to *ALL)
About Validation of Selection Criteria Parameter Values
The values you enter or select for selection criteria parameters are applied using an SQL WHERE
clause. There is no validity checking for anything you type or choose in any of the combo or edit
boxes on the Report Parameters dialog. For example, if you supply a release name that does not
exist in the application(s) you specified, RM generates an empty report, rather than issuing an error
message. This also applies to parameters that you leave empty or supply a blank value.
15
Using Rocket Aldon Report Manager Report Manager User Guide
Date Parameters
OR
These fields appear only for specific reports. Use these options to limit the amount of information
selected for the reports (and thereby reduce the amount of time it takes to produce these reports).
Using these fields you can:
Limit activity information to within a specific date range; OR
Limit activity information to dates for some number of days up to and including the current
date.
Read Appendix C for detailed value requirements for the Date Range and Previous X Days fields.
16
Report Manager User Guide Using Rocket Aldon Report Manager
3. Expand the appropriate product and report folders until you locate the report you want.
4. Use one of these methods to open your chosen report's Report Parameters dialog:
a. Click the Options button near the right end of the line containing the report
name; OR
c. Click the report name when the associated Run button is yellow.
See Report Parameters Dialog.
17
Using Rocket Aldon Report Manager Report Manager User Guide
1. Supply a value for each selection criteria field in the top portion of the dialog. Starting with
the first field, do ONE of the following for each field, in order of appearance:
b. Type a generic value with a wildcard and press the Tab key; OR
d. Type one of the special values (such as *ALL or *NONE) allowed in the field and press
the Tab key.
2. For the reports that include a date parameter selection, select a date range or enter the
previous number of days.
To supply values for date parameters in the middle of the dialog, do ONE of the following:
a. To include activity for a contiguous set of days in a range, click the Date Range radio
button and select a From date and a To date. If you do not supply date information, the
beginning date is set to 1/1/2000 for LM(e) reports or 1/1/1990 for LM(i) reports. The
ending date is set to the current date. OR
b. To include activity for a number of days preceding and including today, click the
Previous X Days radio button and supply a number of days (up to 999). The default
number of days is 0, which resolves to the current date.
Click the arrow at the right side of the From or To fields to display a calendar control.
Clicking None clears the date field. If you then type the
beginning and ending dates, use the format YYYY-MM-
DD.
3. To supply output control parameters that determine how your report renders, do the
following:
18
Report Manager User Guide Using Rocket Aldon Report Manager
b. If you chose an output type of HTML, you can also fill or empty the toggle boxes to
include or exclude a navigation bar and a toolbar on your HTML report output. (A toggle
box looks like this when filled , and like this when empty .) The reporting tool
communicates your choices to the programs that process the HTML or PDF output.
c. If you choose an output type of PDF, you can also fill or empty a toggle box that controls
how your report pages flow in the resulting PDF.
d. If you choose the XLS output type, no additional output options apply.
4. When you have fully described the report content and output you want, and the dialog has
refreshed itself for the final time, then you can take ONE of the following actions:
c. Click the Cancel button, to exit without saving or running the report.
If you click Run, RM generates your report and renders it in the format you selected. (You are
prompted to supply a file name and storage location if you chose any output type other than HTML.)
If you click Save, the Save dialog appears so you can store a set of reusable report parameters.
(See Saving Report Parameter Sets.)
Customizing Reports
About Custom Reports
Customizable reports have a field set that can be broadened or narrowed from the default column
set, based on the user's needs and / or preference.
Once you customize a report, its maintenance becomes your responsibility. During version
upgrades, RM does not upgrade custom reports with new features; they remain at the version level
that was in place at creation time. They will still run, but will not have new features. To use the latest
report features in a custom report, customize the shipped version of the report in the new release,
and save it.
The report descriptions for eligible reports include a list of additional fields that are available when
customizing the report. These fields are in addition to the default field set that appears in the
shipped report.
The following reports are eligible for customizing, and have a corresponding Customize button on
the home page:
LM(e) reports:
o LM(e) Activities by Release
o LM(e) Activities by Type
o LM(e) Activities by User
19
Using Rocket Aldon Report Manager Report Manager User Guide
1. Navigate to the desired shipped report on the home page and click its Customize button.
20
Report Manager User Guide Using Rocket Aldon Report Manager
Note: This image is an example; the columns available for each eligible report vary. See your
chosen report's description for an explanation of the additional available fields that apply to that
report.
3. Supply a report title. The default title is the title of the report you are customizing.
Note: If you plan to export report data to Excel format, avoid using any special characters in
the report title. Both special characters and long report titles can interfere with the creation
of Excel sheet names during the export.
4. At first use, the field selection dialog shows the shipped report's default fields in the Selected
Columns pane on the right. (Once the report has been customized, the right pane shows
currently included fields.) The additional fields you can include appear in the Available
Columns pane on the left. Do ONE of the following:
a. To include an available field as a column in your report, select it in the left pane and use
the > button between the panes to move it to the right pane.
b. To exclude a field column that already appears, select it in the right pane and use the <
button between the panes to move it to the left pane.
Note: You can select and move multiple columns in either direction.
5. When you are satisfied with the field content, you can arrange the fields in the order in which
you want their respective columns to appear in the report, as follows:
a. To leave the field columns arranged in the order in which they currently appear, do
nothing and skip to the next step.
b. To reposition a field column toward the left side of the resulting report, select the field in
the right pane and click the Up button to move it, one position at a time, toward the top
of the Selected Columns list.
c. To reposition a field column toward the right side of the resulting report, select the field in
the right pane and click the Down button to move it, one position at a time, toward the
bottom of the Selected Columns list.
Note: You can select and move multiple columns in either direction.
6. When you are satisfied with the content and position of the report columns, click the Save
button to store your custom report. (See Saving Custom Reports for more information about
managing stored reports.)
21
Using Rocket Aldon Report Manager Report Manager User Guide
Available
Lists the additional fields you can include in this report.
columns
Selected
Lists the fields that are already included in this report.
columns
22
Report Manager User Guide Using Rocket Aldon Report Manager
If you remove all fields from the Selected Columns pane, a message appears at the top of the
dialog to remind you that the pane cannot be empty:
You must include at least one column on the report.
Saving Reports
About Saving Reports
This section explains everything you need to know about saving reports. You can save report
parameter sets and custom reports. You can organize your saved reports in two different kinds of
containers. These are:
Report categories; and
Report folders.
Refer to the Report Manager Home Page Legend to see how report categories and report folders
appear on the RM home page.
Refer to About the Report Storage Location for more information about the actual location where
RM stores report materials.
Important! Be aware that all RM users are also sharing the same "save space." This means
that all custom reports, report parameter sets, report categories, and report folders created by any
one user are accessible to all users. Likewise, any reports created by any individual user remain
intact only if no other user changes it.
Following are some sample scenarios for saving custom reports and report parameter sets.
Case 1 - Replacing existing report materials with revised materials
Initially, the Report Name field on the Save dialog defaults to the existing file name. Click the
Save button.
Because a report with this name already exists in this container, you are prompted to
overwrite the existing report:
Click Yes to overwrite the existing report; click No to return to the Save dialog so you can
change the name.
If you click Yes, the existing report is replaced with the new one, and the dialog where you
started reappears.
Overwrite with caution... A good rule of thumb is to avoid overwriting parameter sets
saved by others whenever possible. When in doubt, either save under a new name or save
in your own folder location.
Case 2 - Saving revised materials in the same report folder as the original materials
Initially, the Report Name field of the Save dialog contains the name of the existing report
that you began with, and the Save dialog is focused on the report folder or category where
that report resides.
Type a new name in the Report Name field.
23
Using Rocket Aldon Report Manager Report Manager User Guide
Supply a name for the new folder in the Folder Name field and click OK. The Save dialog
reappears, with the new folder available for selection as a storage location for your custom
report or parameter set.
On the Save dialog, double-click the newly created folder to open it.
Supply a name for the new report or parameter set in the Report Name field. (Because the
new report is in a different folder location than the original, you can use the original report
name if you prefer.)
Click the Save button.
The new report is created, and the dialog where you started reappears.
Case 5 - Saving new report materials in a new report folder in a new report category
On the Save dialog, use the Up One Folder button to navigate to the top of the report
folder structure. (The folder-level button turns gray when you reach the top to indicate that
you can go no further.)
Click the New Folder button to create a new report category. The New Folder dialog
appears.
(Even though you are using the New Folder dialog, you are creating a new report category,
because you are at the highest level in the report folder structure.)
24
Report Manager User Guide Using Rocket Aldon Report Manager
Supply a new category name in the Folder Name field, and click OK.
The new report category is created and the Save dialog reappears so you can open the new
category in preparation for creating a new folder for your new parameter set or custom
report.
Note: You can create up to 19 new report categories, in addition to the Reports category.
The report categories appear in ascending, alphabetical order.
Now create and open a folder in which to store your new parameter set or custom report,
using the procedure described in Case 4, beginning with the second bullet.
When the Save dialog reappears opened to your new folder, click the Save button. The new
report is saved in the new folder in your new category, and the dialog where you began
reappears.
Click the Save button at the bottom of the dialog. The Save dialog appears.
25
Using Rocket Aldon Report Manager Report Manager User Guide
On the Save dialog, navigate to and select the folder or category location where you want to
store the parameter set. (If you like, you can use the New Folder button to open the New
Folder dialog and create a new category or folder.)
Accept the default Report Name, or supply a name you prefer.
Click the Save button to store your new report parameter set in the location you have
identified.
Usage Notes
Important! This version of RM includes a set of pre-defined LM(e) and LM(i) report
definitions. (See Available Reports.) You cannot save parameter sets for any of the pre-
defined reports within their original containing folder. If you try, the following message
appears:
26
Report Manager User Guide Using Rocket Aldon Report Manager
By default, the Save dialog is oriented at same level in the report folder structure as the
report you are customizing.
On the Save dialog, use the folder buttons to navigate to and select the folder or category
location where you want to store your custom report. (If you want, use the New Folder
button to open the New Folder dialog, and create a new category or folder.)
Accept the default Report Name, or supply a name you prefer.
Notes:
o The default file name is constructed from the report title you supplied. Special
characters, ASCII control characters, and trailing periods or spaces are converted to
underscore characters in order to create a valid file name.
o You can never save over the shipped version of the report. A message appears with a
request for a different file name.
Click the Save button to store your new custom report in the location you have identified.
Usage Notes
Important! RM includes a set of pre-defined LM(e) and LM(i) reports and parameter sets.
(See Available Reports.) RM will not allow you to replace these default shipped reports
or parameter sets. If you try, the following message appears:
27
Using Rocket Aldon Report Manager Report Manager User Guide
Read About Saving Reports for more information about various possible save scenarios for
report parameter sets and custom reports.
To learn more about the report storage location, read About the Report Storage Location.
Save Dialog
Use the Save dialog to identify the location where you want to store a report parameter set or
custom report you have decided to save. You access the Save dialog in one of two ways:
By clicking the Save button on the Report Parameters dialog; OR
By clicking the Save button on the Customize Report Content dialog.
Save In: This informational field at the top of the dialog reflects the target storage location. Initially,
it defaults to the name of the folder where the original report resides. (The original report is the
report from which you launched the Save operation.) If the originating report is not stored in a report
folder, the Save In field contains the name of the report category where the report resides.
Report Name: Represents the file name of the new custom report or report parameter set.
For report parameter sets, this field defaults to the file name of the original report.
For custom reports, this field defaults to the report title you supplied on the Customize
Report Content dialog. (Any special characters are converted to underscore characters (_)
to make a valid file name.)
The navigation buttons in the upper right corner of the Save dialog behave as follows:
Back button (colored either gray or green). Initially, the Back button is
gray, indicating there is no history for this instance of the Save dialog. If you
make any navigation moves on the dialog, such as moving up one level,
creating a new folder, expanding an existing folder, and so on, then the
Back button color changes to green. When the Back button is green,
clicking it once returns you to the previous state of the Save dialog. When
there is no more navigation history for this instance of the dialog (that is,
you've backed up as far as possible), the Back button color reverts to gray.
Important! If you have used the Folder Level button to move to the highest
level of the category/folder structure (that is, the Next Level ), then using the
New Folder button at this level creates a new report category instead of a
report folder.
28
Report Manager User Guide Using Rocket Aldon Report Manager
Once you have created the new report category, you can create a new
folder in which to store your new report.
Folder level button. Click once to move to the next higher level in the
category/folder structure. The top-most level of the structure is the "Aldon
Report Manager Report Categories" level.
New folder button. Click once to access the New Folder dialog, which
allows you to create a new folder or report category.
The main body of the dialog lists all of the folders and reports that reside in the target
storage location. The entries in the list are marked with one of these icons:
Usage Notes
Clicking a report name in the dialog body sets the Report Name field to that value.
Single-clicking on a report folder entry has no immediate action.
Double-clicking on a report folder entry opens the folder to reveal its contents.
Folder name: Use this field to supply a name for the new folder.
Click OK to create your folder. The Save dialog reappears, showing the new folder so you can
select it if desired.
Click Cancel to return to the Save dialog without creating a folder or category.
Usage notes:
New folders are always stored inside the folder identified by the Save In field that appears at
the top of the Save dialog.
To nest folders from this dialog, click Cancel to return to the Save dialog. Then open the
folder where the new folder should reside, and click the New Folder button from there.
You can create up to 19 report categories in addition to the Reports category.
29
Using Rocket Aldon Report Manager Report Manager User Guide
o The contents of these category sub-folders appear in each expandable report category
on the RM home page.
o Each category folder contains report folders and report parameter set files. The structure
mirrors what you see on the RM home page.
o Only the Aldon Reports category folder contains the shipped report parameter sets,
organized by product and report type. (Through the RM user interface, you can create
your own custom folders, custom reports, and report parameter sets in this shipped
report category, but you cannot replace the shipped parameter sets.) Any other category
folders you see here are custom categories belonging to your RM users. These contain
any custom folders, custom reports, and custom report parameter sets that your users
have created.
o Report parameter sets are stored in a file whose name reflects the report name you see
on the RM home page. These files have an extension of .rptparam. Rocket Aldon
determines the names of the shipped report parameter sets. Users assign names of
their own choosing when they save report parameter sets. (Users are not allowed to
overwrite the shipped report parameter sets when creating their own sets.)
To delete a custom report or saved report parameter set, locate its .rptparam file, and delete
the file in the usual way.
To rename a custom report or saved report parameter set, rename its .rptparam file in the
usual way.
When deleting or renaming, always make sure you are not altering a shipped report or report
parameter set.
Important! When you rename a custom report or a report parameter set in this directory, its name
is changed in the list of reports on the RM home page. However, the title of the report in the
designated output format is not affected.
To delete a folder or category, locate the folder with the desired name and delete it in the
usual way. (Make sure you are not deleting a shipped folder or the Aldon Reports category
folder.)
To rename a folder or category, locate the folder of the same name and rename it. (Make
sure you are not renaming a shipped folder or the Aldon Reports category.)
Deleted and renamed folders and categories are reflected in the list of reports on the RM home
page.
31
LM(e) Report Samples Report Manager User Guide
From within this report, you can access these additional reports:
LM(e) Task Summary Report (by clicking a task name);
LM(i) Task Summary Report (by clicking a link in the Count column under LM(i) Releases);
LM(i) Task Objects Report (by clicking a link in the Objs column under LM(i) Releases).
An example of the LM(e) Task Assemblies Associated with Release Report follows.
Header Section
Application - The qualified name of the application selected, in the format Group
Name/Application Name.
Release - The qualified name of the release selected, in the format Release Name(Version)
Release Type.
32
Report Manager User Guide LM(e) Report Samples
Report parameters - The group, application, release, and version selection criteria used to
generate the report, as provided on the Report Parameters dialog.
Details Section
Created On - Identifies the date and time when the report was generated.
You can access the following reports from links within this report:
LM(i) Task Objects Report (if a task link exists)
LM(i) Task Activity Time Log Summary Report (if a task link and time data exist)
An example of the LM(e) Task Summary Report follows:
33
LM(e) Report Samples Report Manager User Guide
Header section
Ancestors - Identifies all the tasks from which the summarized task is descended. If the
assembly is not nested, this label does not appear.
Task - Identifies the specific task assembly that is summarized on this report page.
Task Description - Displays any descriptive text stored for the summarized task assembly.
34
Report Manager User Guide LM(e) Report Samples
Report parameters - Reflects the selection criteria choices used to generate this report, as
supplied on the Report Parameters dialog.
Details Section
This report section displays for you the information found in the task assembly properties settings,
and gives you an idea of the task scope by showing how many elements are associated with this
task.
Note: This report section is omitted if no LM(i) tasks are linked to this task assembly.
35
LM(e) Report Samples Report Manager User Guide
Properties This section describes an LM(i) task that has been deliberately
linked to the LM(e) task being summarized in this report. Much of
the information that appears in this section is similar to the
information for LM(e) tasks described in the Details section.
Additional fields are:
State - An indication of whether the status code reflects an
open or closed task.
Type - A code that helps further classify the nature of the
work to be done.
Status - A code that identifies the current disposition of the
task in the overall development workflow.
Priority - Identifies the level of importance assigned to the
task.
Manager - Identifies the person in charge of seeing that the
work is completed.
Keyword 1
Keyword 2
Keyword 3 - This line shows the contents of the three
keyword fields, if any. If these fields are blank, the line is
omitted.
Task statistics fields - These fields include information about
who entered the task and when; finish, closure, and re-open
dates; who requested the work and when; desired and
expected completion dates; and number of days open as of
the report date.
Hours If an LM(i) task link exists, this section contains information about
time logged against the LM(i) task associated with this LM(e) task
assembly. A link to the corresponding LM(i) Task Activity Time
Log Report also appears if data exists.
36
Report Manager User Guide LM(e) Report Samples
The LM(i) portion of this section is omitted if no LM(i) task link exists.
This section lists all LM(e) releases associated with the summarized task assembly, along with part
counts for each. Part counts are broken down by release and by release environment.
Notes:
If a release's total part count differs from the sum of its environment part counts, it is
because the total part count for the release includes parts that are associated with the
release, but not resident in any release environment.
The Allow Activity column applies only to LM(i) releases. If activity is allowed, then new
objects can be added to the linked LM(i) task and existing objects associated with the task
can be checked out. If activity is not allowed, then only promotion of LM(i) objects is
allowed.
If an LM(i) task link exists, then object counts for all applicable LM(i) releases also appear.
Each LM(i) release name links to its corresponding LM(i) Task Objects Report.
Footer Section
37
LM(e) Report Samples Report Manager User Guide
38
Report Manager User Guide LM(e) Report Samples
Header Section
Application - The qualified name of the application, in the format Group name/Application name.
Release - The qualified name of the release, in the format Release(Version) Type / (Level),
Type is either Base or Delta, and Level is a number that reflects the relationship of delta
releases to the base and to one another. (A base release is always level 0. Level information
does not appear for base releases.)
Description - The informational text associated with the release.
Promotion Path - A visual demonstration showing the flow of data between release
environments and across releases, consisting of:
The environment abbreviations of all of the environments on this release's promotion path,
listed in order from lowest to highest, separated by arrows.
o A right arrow indicates the direction of flow in a promotion action within this release.
o An up arrow, if there is one, indicates a promote-to-parent promotion flow - that is, flow
between two or more releases of the same application. The arrow is followed by the
qualified environment name of the parent release's production environment, in the format
Environment Abbreviation(Version). This is the target environment for a promote-to-
parent action. (The Promote to parent action can occur only if the current release is a
delta release.)
A diamond symbol between two environments in the promotion path — — means
that the originating environment does not allow promote-to-parent, even though the target
environment is on the logical promotion (and search) path.
The path color is meaningful:
39
LM(e) Report Samples Report Manager User Guide
Details Section
Properties table Summarizes key release characteristics. The left column of the
table describes key release rules in effect; the right column
describes rules in place for promoting when conflicts exist, and
the most recent change made that affects release contents.
Checkouts table The Checkouts table in the Details section presents checkout
statistics for the release. The left column of the table describes
key checkout-related rules in effect for the release; the right
column summarizes the current number of various kinds of
checkouts, and any existing or deleted acknowledgement
conditions.
Checkins and The Checkins and Promotions table in the Details section
Promotions presents information about release check-ins and promotions
table that have occurred to date. The left column of the table
describes key check-in and promotion rules that are in effect for
the release; the right column describes pending check-in or
promotion requests.
Task Summary The Task Summary table in the Details section provides
table information about the number of open and closed tasks
associated with the release.
40
Report Manager User Guide LM(e) Report Samples
Activity Log The Activity Log Summary table in the Details section describes
Summary table release activities.
Environments section
Properties The Properties table in the Environments section lists the release
table environments and presents key information about each. The first
environment row summarizes all individual developer environments that
contain checked out parts for the release. If this release is a delta release
that allows promote-to-parent activity, the last environment entry in the
table describes the release and version of the target promote-to-parent
environment.
The columns for displaying the key environment characteristics are:
Environment - Identifies the environment's name abbreviation and
location code, in the format environment abbreviation(location
code).
Type - Identifies the environment type.
Shadowed - If filled, indicates that the environment has a shadow
location defined.
Last Change - Identifies the date of the most recent activity that
changes the environment contents.
Parts - A number that indicates how many parts are resident in the
environment.
Note: The part counts include parts that are marked for delete.
Cnds - A list containing up to four single-character condition codes,
which indicate whether any Acknowledgement, Conflict, Failure, or
Request conditions currently apply to the environment.
Tasks - The number of tasks that have associated parts resident in
this environment, and for which all parts are resident in at least this
environment.
Important! If a task has parts in more than one environment, the
task is counted only once. The count appears for the environment
that is lowest in the promotion path among the environments
containing a part instance. For example, if a task has parts in the
Integration, QA and Production environments, the task is counted
only once and the count appears in the Integration environment
column.
41
LM(e) Report Samples Report Manager User Guide
Cross-release Notifications - Identifies any notification relationships for this release. The left
column lists releases that this LM(e) release notifies; the right column lists LM(e) releases that
notify this release, if any.
Associated LM(i) Release - If this LM(e) release is linked to an LM(i) release, the left column
describes the LM(i) release; the right column lists any additional LM(e) releases that are also
associated with that LM(i) release.
Footer Section
Report Parameters - Identifies the values used to generate this report, as supplied on the
Report Parameters dialog.
Created On - Identifies the date on which the report was generated.
Header Section
Application - The qualified application identifier, in the form Group name/Application name.
Release - The qualified release identifier, in the form Release name(Version) Attribute.
42
Report Manager User Guide LM(e) Report Samples
This section identifies all the folders where this application stores its user-defined Java classes and
packages for this release.
Footer Section
Report parameters - Identifies the values used to generate this report, as supplied on the Report
Parameters dialog.
Created On - Contains a time and date stamp that reflects when the report was generated.
43
LM(e) Report Samples Report Manager User Guide
The report presents details of the activity recorded for a part associated with a release. The
information is sorted by the timestamp.
Report Links
If this report's LM(e) release is associated with an LM(i) release, then you can run the LM(i) Activity
Summary by Release by clicking the link in the Report Links section. If no LM(i) release is related,
then this link does not appear.
An example of the LM(e) Activities by Part Report follows.
The following report sections appear for each group/application/release combination whose parts
meet the selection criteria on the Report Parameters dialog.
Header Section
Application - The qualified application name, in the format Group Name/Application Name.
Release - Identifies the release to which the information in the Details section applies.
Report parameters - The group, application, release, part, and date information supplied on the
Report Parameters dialog that was used to select the information presented in this report.
Details Section
This section contains one detail line for each activity record associated with the selected part.
Timestamp - Identifies the date and time when the activity occurred, expressed in UTC time.
Activity - A 3-character code indicating the type of activity. (Refer to the LM(e) documentation
for a complete description of activity codes.)
Status - A three-digit status code indicating the completion state. A blank status indicates
success; FLD indicates failure; and HLT indicates that the user ended the activity. Refer to the
LM(e) documentation for a complete description of the error codes. (See Appendix J -
Resources.)
Part name - Identifies the part's path designator and part name.
Release - Identifies the release that contains the selected part instance.
44
Report Manager User Guide LM(e) Report Samples
From - The abbreviation of the environment where the part instance resided when this activity
started. A plus sign prefix indicates a developer environment.
To - The abbreviation of the environment where part instance resided when this activity ended.
A plus sign prefix indicates a developer environment.
By User - The profile name of the user that initiated the activity.
Within this report, you can:
Hover the cursor over an activity code to see its text description.
Hover the cursor over a release to see its fully qualified release name.
Footer section
Created On - A date and time stamp that identifies when the report was created.
The report contains one line for each activity record that meets the selection criteria.
Header section
Application - The qualified name of the selected application, in the format Group
Name/Application Name
45
LM(e) Report Samples Report Manager User Guide
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Timestamp - Identifies the date and time when the activity occurred, expressed in UTC time.
Activity - A three-character code that identifies the type of processing that resulted in an activity
log entry. (Refer to the LM(e) documentation for a complete description of activity codes. See
Appendix J - Resources.)
Status - Indicates whether the activity completed normally (blank), failed (FLD), or was halted
by the user (HLT).
Part name - Identifies the part that was processed during the logged activity.
Release - Identifies the release name and version number associated with the logged activity.
From - Identifies the environment in which the part instance processed resided at the beginning
of the logged activity. A plus sign prefix indicates a developer environment.
If the activity applies to a release but not an environment (such as the Activate activity), this
column contains only the version, without an environment. When both the From and To
environments are controlled AND in the same release, only the From environment name
includes the version.
To - Identifies the environment in which the part instance processed resided when this activity
ended. A plus sign prefix indicates a developer environment.
By User - The user profile name of the person who initiated the logged activity.
Comment - If a comment exists, it appears unlabeled, beneath the Release.
While viewing this report, you can hover the cursor over these data elements to see expanded
information:
Timestamp (shows time to milliseconds);
Activity code (shows the activity code description);
Part name (shows the fully qualified part path and name);
Release (shows the fully qualified name, in the format Group/Application/Release(Ver)).
Click on a part name to open its LM(e) Activities by Part report.
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
46
Report Manager User Guide LM(e) Report Samples
Activity Code - Description - The activity code followed by text that explains what the code
means.
Status Code - Description - The status code, followed by text that explains what the code
means.
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Release - The name associated with the application objects as they stand at a specific point in
time.
Version - The number associated with this edition of the application release.
Group/Application - The application name, qualified by the name of the group to which it
belongs.
From Version - The edition of the application release that applied at the beginning of the activity.
From Release (Version) - A combination of the release name and version number that applied
at the beginning of the activity.
From Environment Abbreviation - The short name of the environment that applied at the
beginning of the activity.
To Environment Abbreviation - The short name of the environment that applied at the end of the
activity.
Qualified Part Name - The full name of the part, including the path to its location.
Footer Section
47
LM(e) Report Samples Report Manager User Guide
The report contains one line for each activity record that meets the selection criteria.
Header section
Application - The qualified name of the selected application, in the format Group
Name/Application Name
Release - Identifies the release associated with the selected activity log entry.
Activity - Identifies the activity code for the selected activity log entry.
Report parameters - Identifies the group, application, release, version, activity, and date values
used to generate this report, as supplied on the Report Parameters dialog.
Details section
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Timestamp - Identifies the date and time when the activity occurred, expressed in UTC time.
Activity - A three-character code that identifies the type of processing that resulted in an activity
log entry. (Refer to the LM(e) documentation for a complete description of activity codes. See
Appendix J - Resources.)
Status - Indicates whether the activity completed normally (blank), failed (FLD), or was halted
by the user (HLT).
Part name - Identifies the part that was processed during the logged activity.
Release - Identifies the release associated with the logged activity.
From - Identifies the environment in which the part instance processed resided at the beginning
of the logged activity. A plus sign prefix indicates a developer environment.
If the activity applies to a release but not an environment (such as the Activate activity), this
column contains only the version, without an environment. When both the From and To
environments are controlled AND in the same release, only the From environment name
includes the version.
48
Report Manager User Guide LM(e) Report Samples
To - Identifies the environment in which the part instance processed resided when this activity
ended. A plus sign prefix indicates a developer environment.
By User - The user profile name of the person who initiated the logged activity.
Comment - If a comment exists, it appears unlabeled, beneath the Release.
While viewing this report, you can hover the cursor over these data elements to see expanded
information:
Timestamp (shows time to milliseconds);
Activity code (shows the activity code description);
Part name (shows the part's fully qualified path and name);
Release (shows the fully qualified name, in the format Group/Application/Release(Ver)).
Click on a part name to open its LM(e) Activities by Part report.
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Activity Code - Description - Text that explains the activity code's meaning.
Status Code - Description - Text that explains the status code's meaning.
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Release - The name associated with the application objects as they stand at a specific point in
time.
Version - The number associated with this edition of the application release.
Group/Application - The application name, qualified by the name of the group to which it
belongs.
From Version - The edition of the application release that applied at the beginning of the activity.
From Release (Version) - A combination of the release name and version number that applied
at the beginning of the activity.
From Environment Abbreviation - The short name of the environment that applied at the
beginning of the activity.
To Environment Abbreviation - The short name of the environment that applied at the end of the
activity.
Qualified Part Name - The name of the part, qualified by its path location.
Footer Section
49
LM(e) Report Samples Report Manager User Guide
Linked Reports
The report contains one line for each activity record that meets the selection criteria.
Header Section
Application - The qualified name of the selected application, in the format Group
Name/Application Name
Release - Identifies the selected release.
User - Identifies the user whose activities appear in the report.
Report parameters - Identifies the group, application, release, version, user, and date values
used to generate this report, as supplied on the Report Parameters dialog.
Details Section
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Timestamp - Identifies the date and time when the activity occurred, expressed in UTC time.
50
Report Manager User Guide LM(e) Report Samples
Activity - A three-character code that identifies the type of processing that resulted in an activity
log entry. (Refer to the LM(e) documentation for a complete description of activity codes. See
Appendix J - Resources.)
Status - Indicates whether the activity completed normally (blank), failed (FLD), or was halted
by the user (HLT).
Part name - Identifies the part that was processed during the logged activity.
Release - Identifies the release associated with the logged activity.
From - Identifies the environment in which the part instance processed resided at the beginning
of the logged activity. A plus sign prefix indicates a developer environment.
If the activity applies to a release but not an environment (such as the Activate activity), this
column contains only the version, without an environment. When both the From and To
environments are controlled AND in the same release, only the From environment name
includes the version.
To - Identifies the environment in which the part instance processed resided when this activity
ended. A plus sign prefix indicates a developer environment.
By User - The user profile name of the person who initiated the logged activity.
Comment - If a comment exists, it appears unlabeled, beneath the Release.
While viewing this report, you can hover the cursor over these data elements to see expanded
information:
Timestamp (shows time to milliseconds);
Activity code (shows the activity code description);
Part name (shows the part's fully qualified path and name);
Release (shows the fully qualified name, in the format Group/Application/Release(Ver)).
Click on a part name to open its LM(e) Activities by Part report.
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Activity Code - Description - Text that explains the activity code's meaning.
Status Code - Description - Text that explains the status code's meaning.
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software elements you are managing.
Release - The name associated with the application elements as they stand at a specific point in
time.
Version - The number associated with this edition of the application release.
Group/Application - The application name, qualified by the name of the group to which it
belongs.
From Version - The edition of the application release that applied at the beginning of the activity.
From Release (Version) - A combination of the release name and version number that applied
at the beginning of the activity.
51
LM(e) Report Samples Report Manager User Guide
From Environment Abbreviation - The short name of the environment that applied at the
beginning of the activity.
To Environment Abbreviation - The short name of the environment that applied at the end of the
activity.
Qualified Part Name - The name of the part, qualified by its path location.
Footer Section
52
Report Manager User Guide LM(e) Report Samples
Header Section
Application - The qualified application name, in the form Group name/Application name.
Release - Identifies the fully qualified release name, in the form Release name(Version)
Release type.
Report Parameters - Identifies the information used to generate this report, as supplied on the
Report Parameters dialog.
53
LM(e) Report Samples Report Manager User Guide
Detail Section
Created On - A date and time stamp that indicates when the report was generated.
54
Report Manager User Guide LM(e) Report Samples
Header Section
User - The user profile name of the person whose activities are summarized on this page.
Application - The qualified application name, in the form Group name/Application name
Release - The qualified release identifier, in the form Release name(Version) Type
Report Parameters - Identifies the information used to generate this report, as supplied on the
Report Parameters dialog.
55
LM(e) Report Samples Report Manager User Guide
Detail Section
Created On - A date and time stamp that indicates when the report was generated.
56
Report Manager User Guide LM(e) Report Samples
IMP - Import
REP - Clone
PRP - Promote to Parent
Linked Reports
Within this report, you can access the LM(i) Promotion Activities for Environment by Object report
for a linked LM(i) release, if a link is present for a release that was selected for this report.
An example of the LM(e) Promotion Activities for Environment by Part Report follows.
Header Section
Application - Identifies the selected application, in the format Group name/Application name.
Report parameters - Identifies the group, application, release, part, promote-to environment,
and date range values used to generate this report, as supplied on the Report Parameters
dialog.
Details Section
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Part Name - Identifies the name of the part associated with the activity (fully qualified with its
location), and its part type.
Comment - Appears below the part name, and reflects the comment text associated with the
activity, if any.
Release - Identifies the release and version associated with the activity.
Timestamp - Identifies the date and time when the activity occurred, expressed in UTC time.
Activity - The code that identifies the activity.
Activity code - The text description that explains the activity code.
57
LM(e) Report Samples Report Manager User Guide
By User - Identifies the user profile name of the person who performed the activity.
From - Identifies the environment where the part instance resided at the beginning of the
activity. A plus sign prefix indicates a developer environment.
Status - Indicates whether the activity completed normally (blank), failed (FLD), or was halted
by the user (HLT).
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Activity Code - Description - Text that explains the activity code's meaning.
Status Code - Description - Text that explains the status code's meaning.
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Release - The name associated with the application objects as they stand at a specific point in
time.
Version - The number associated with this edition of the application release.
Group/Application - The application name, qualified by the name of the group to which it
belongs.
From Version - The edition of the application release that applied at the beginning of the activity.
From Release (Version) - A combination of the release name and version number that applied
at the beginning of the activity.
From Environment Abbreviation - The short name of the environment that applied at the
beginning of the activity.
To Environment Abbreviation - The short name of the environment that applied at the end of the
activity.
Part Name - The unqualified name of the part.
Footer Section
58
Report Manager User Guide LM(e) Report Samples
Header Section
Managing Product Instance - Identifies the instance of the product for which the report is being
generated (because Security Server can support multiple instances of LM(e)).
Report Parameters - Identifies the date range and release (expressed as
group/application/release) parameter values used to generate this report, as specified on the
Report Parameters dialog.
Details Section
Date/Time - This column indicates the date and time that each authority setting was changed.
Role - This column identifies the particular role for which a change in authority has been
recorded.
59
LM(e) Report Samples Report Manager User Guide
Authority Level - This column shows the level at which each role authority is set. The authority
level can be derived from the product instance, application, release, or environment level.
Authority Setting - This column lists the available action for which the authority value has been
changed.
Before - This column indicates, for each authority level and setting, the specific authority before
the change.
After - This column indicates, for each authority level and setting, the specific authority after the
change.
Footer Section
Created On - A date and time stamp that indicates when the report was generated.
Header Section
60
Report Manager User Guide LM(e) Report Samples
Managing Product Instance - Identifies the instance of the product for which the report is being
generated.
Application - Identifies the application associated with the release whose permissions are listed,
shown as group name/application name.
Release - Identifies the release associated with the listed permissions, shown as release
name(version).
Report Parameters - Identifies the group, application, and release parameter values used to
generate this report, as specified on the Report Parameters dialog.
Details Section
User - This column identifies the user whose permissions appear in the report. All permissions
appear across the row. User authorities can be set at the global, application, release, and
environment level. If authorities are set at the release level, they override application or global-
level settings. If authorities are set at the application level, they override global-level settings.
Product Instance /Group/App/Release (Version) Env- This column identifies the product
instance, group, application, release, version, and environment associated with the user and
role.
Role - This column indicates each user's assigned role for the associated permissions.
Permissions - Each column represents an LM(e) function with access that can be permitted or
refused for a user. The indicator box in the column is shaded if the user is permitted to perform
the associated function; it is white if the user cannot perform the associated function.
Note: Where there is no box, the authority is not appropriate for that managed object.
Footer Section
Created On - A date and time stamp that indicates when the report was generated.
61
LM(e) Report Samples Report Manager User Guide
Header Section
Managing Product Instance - Identifies the instance of the product for which the report is being
generated.
User - Identifies the user whose activities appear in the report.
Group/Application - Identifies the group and application associated with the user whose
permissions are listed.
Report Parameters - Identifies the user, group, application, and release/version parameter
values used to generate this report, as specified on the Report Parameters dialog.
Details Section
62
Report Manager User Guide LM(e) Report Samples
Product Instance /Group/App/Release (Version) Env - This column identifies the product
instance, group, application, release, version, and environment associated with the user and
role.
Role - This column indicates the role from which this user's authority settings are derived for a
product instance, group, application, release, or release environment.
Permissions - Each column represents an LM(e) function that can be permitted or refused for a
user. The indicator box in the column is shaded if the user is permitted to perform the
associated function; it is white if the user is not authorized to perform the associated function.
No box means the authority is not appropriate for that level of role definition.
Footer Section
Created On - A date and time stamp that indicates when the report was generated.
Header Section
Managing Product Instance - Identifies the instance of the product for which the report is being
generated.
Report Parameters - Identifies the date range and user parameter values used to generate this
report, as specified on the Report Parameters dialog.
63
LM(i) Report Samples Report Manager User Guide
Details Section
Date/Time - This column indicates the date and time that each authority setting was changed.
User- This column identifies the user whose activities appear in the report.
Authority Level - This column shows the level (product instance, group, application, release, or
environment level) at which each role change occurred.
Before - This column indicates, for each user, the specific role assignment before the change.
After - This column indicates, for each user, the specific role assignment after the change.
Footer Section
Created On - A date and time stamp that indicates when the report was generated.
64
Report Manager User Guide LM(i) Report Samples
.
Header Section
This section of the report shows the hours reported against this task arrayed by time activity code
within user.
65
LM(i) Report Samples Report Manager User Guide
User / Activity - Hours are reported for each user against a task by time activity code. This
section lists the activity by time activity code for each user. The user name is shown followed by
an indented list of the time activity codes. Uncredited Accrued hours are the hours entered as a
lump sum on the LM(i) Task Budget panel.
Hours - The total number of hours reported for this combination of task, user and time activity
code.
First Activity - The date that activity was first reported for this combination of task, user and time
activity code.
Last Activity - The last date for which activity was reported for this combination of task, user and
time activity code.
Max Est % Complete - Each time a user enters activity against a task, he either enters an
estimated percent complete for the task or asks LM(i) to calculate the percent complete based
upon the total number of hours reported for this task divided by the hours budgeted for the
task. The value is recorded in each time activity record. The Maximum Percent Complete value
is the largest of these estimated percent complete values over all of the time activity entries for
this combination of task, user and time activity code.
Last Est % Complete - See Max Est % Complete, above. The Last Estimated Percent Complete
is the value found in the most recent time activity entry. If the field displays in red, it indicates
that the most recent value is less than the Maximum Estimated Percent Complete value. This
occurs when a user enters an Estimated Percent Complete value that is less than the Maximum
Estimated Percent Complete value; it indicates that the task is taking longer than estimated.
User Link - Each user name shown in this section is a link. If you click on the link, the LM(i) Task
Activity Time Log Report is produced. (See LM(i) Task Activity Time Log Report).
Total Hours Reported by Activity Section
This section of the report shows the hours reported against this task arrayed by user within activity
code.
Activity / User - The time entry activity code and user for which time entry activity is being
reported for this task. Uncredited Accrued hours are the hours entered as a lump sum on the
LM(i) Task Budget panel.
Hours - The total number of hours reported for this combination of task, time entry activity code
and user.
66
Report Manager User Guide LM(i) Report Samples
First Activity - The date activity was first reported for this combination of task, activity code and
user.
Last Activity - The last date for which activity was reported for this combination of task, activity
code and user.
Max Est % Complete - Each time a user enters activity against a task, he either enters an
estimated percent complete for the task or asks LM(i) to calculate the percent complete based
upon the total number of hours reported divided by the hours budgeted for the task. The value is
recorded in each activity log record. The Maximum Percent Complete value is the largest of
these estimated percent complete values over all of the activity log entries for this combination
of task, user and activity code.
Last Est % Complete - See Max Est % Complete, above. The Last Estimated percent Complete
is the value found in the most recent activity log entry.
Activity Code Link - Each activity code in this section is a link. If you click on the link, the LM(i)
Task Activity Time Log Report is produced for this combination of task and activity code. (See
LM(i) Task Activity Time Log Report.)
Footer Section
Created On - A date and time stamp that identifies when the report was created.
Header Section
67
LM(i) Report Samples Report Manager User Guide
Start Date - The first date on which time activity was reported for this task
End Date - The last date on which time activity was reported for this task
Total Hours - The total hours reported for this task.
Log Entries - The total number of time activity entries for this task.
Unique Users - The total number of different users for which hours have been reported for this
task.
Unique Activities - The total number of different time activity codes used in reporting hours for
this task. (Note: In LM(i), time activity codes are user defined.)
Detail Section
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Date - The date the activity being reported occurred. Entries are sorted in descending date
order - that is, the most recent entry appears first.
User - The user for which the activity is reported.
Activity - The time activity code of the activity.
Hours - The number of hours reported in this time activity entry.
Estimated % Complete - Each time a user enters activity against a task, he either enters an
estimated per cent complete for the task or asks LM(i) to calculate the percent complete based
upon the total number of hours reported for this task divided by the hours budgeted for the
task. The value is recorded in each time activity record.
Comment - The comment entered by the user for this time activity entry.
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Task - The identifier of the task associated with the activity.
Recorded Date/Time - The date and time when the activity took place.
Recorded By - The developer that performed the activity.
Activity Text - Text that describes the activity performed.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
68
Report Manager User Guide LM(i) Report Samples
Header Section
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Name - Object name.
Type - Object type.
Attribute - Object attribute.
Release - The qualified release name, in the format application abbreviation/release
abbreviation.
ENV - Environment location codes of the environments where an instance of the object is
resident. If the environment location code is in lower case, it indicates that the instance of the
object in this environment is not associated with the current task. If the environment location
code is in upper case, the instance of the object in this environment is associated with the
current task.
Text - Object description.
69
LM(i) Report Samples Report Manager User Guide
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Task - The identifier of the task associated with the activity.
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Release - The name associated with the application objects as they stand at a specific point in
time.
Base Creation Date/Time - The date and time when the base application was created.
DVP - Identifies the location of the development environment.
ITG - Identifies the location of the integration environment.
QUA - Identifies the location of the test environment.
PDN - Identifies the location of the production environment.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
70
Report Manager User Guide LM(i) Report Samples
Header Section
71
LM(i) Report Samples Report Manager User Guide
Properties This section shows you information that helps you evaluate task progress
and expectations.
State - The current state of the task (Open, Closed, Finished).
Type - A code that identifies what kind of work the task represents - for
example, a bug fix versus an enhancement.
Status - The A code that reflects the progress of the work being done to
satisfy the task.
Priority - A code that reflects a relative level of importance for the task.
Manager - The person in charge of seeing that the task is completed. If no
manager is assigned, the word "none" appears.
LM(i) Object Count - The number of LM(i) objects on which work for this
task has been done.
Task Added by - The user name of the person who entered the task into
the system.
Task Added - The date on which the requesting user entered the task.
Task Closed - If the task is closed, the date it was closed. If there is no
closed date, the value is spaces and the Closed Date label is suppressed.
Task Finished - If the task is finished, the date it was finished. If there is
no finished date, the value is spaces and the Finished Date label is
suppressed.
Task Re-opened - If the task has been re-opened after being closed, the
date it was re-opened. If there is no re-opened date, the value is spaces
and the Re-Opened label is suppressed.
LM(i) Release Count - The number of LM(i) releases containing objects
that are associated with this task.
Requested By - A name provided by the user who entered the task. If no
name is stored in the task definition, the word "none" appears.
Department - The company department to which the requesting user
belongs.
Wanted - A date that reflects when the requesting user would like the work
to be completed.
Expected - A date that reflects when management projects the work will
be done.
Days Open - A number that reflects the length of time the task has been in
the system without being resolved.
72
Report Manager User Guide LM(i) Report Samples
Hours If hours have been reported against this task, this section contains a link
to the LM(i) Task Activity Log Summary Report for this task.
Budgeted - The number of hours budgeted for this task.
Accrued - The total number of hours reported for this task.
Variance from Budget - The variance from the budgeted hours. If the
value displays in red, it indicates that the budget has been exceeded. This
occurs if an estimated percent complete is entered (not calculated) that is
lower than the calculated accrued budget variance.
Projected - The projected number of hours required to complete the task.
The value displays in red if the projected number of remaining hours
exceeds the budget.
Percent Accrued - Equals (Accrued Hours/Budgeted Hours) X 100. The
value displays in red if the result is more than 100, i.e., the accrued hours
exceeds the budget.
Estimated % Complete - An estimate of the percentage of the task that is
complete. It can either be calculated or entered by the user.
This section of the report has an entry for each release that is associated with the current task.
LM(i) Release - The release name, in the format Group Name/Application Name/Release Name
of any releases that are associated with the current task. Each release name in the list is a link
to that release's LM(i) Task Objects Report.
Object Counts by Release and Environment - The following columns of the associated releases
table reflect how many objects are affected and how they are distributed across the different
operating environments. Each environment count is a link to that environment's LM(i) Task
Objects Report. The Release count is a link to that release's LM(i) Task Objects Report.
Release - The total number of release objects that are associated with the current task.
DVP - The number of release objects that are associated with the current task and are located
in a developer environment.
ITG - The number of release objects that are associated with the current task and are located in
the release's integration environment.
QUA - The number of release objects that are associated with the current task and are located
in the release's quality assurance environment.
PDN - The number of release objects that are associated with the current task and are located
in the release's production environment.
Allow Activity Yes/No - A shadow box that Indicates whether activity is allowed for this release.
A filled box means Yes; a hollow box means No.
73
LM(i) Report Samples Report Manager User Guide
Footer Section
Created On - Identifies the date and time when the report was generated.
Header Section
There is one row in this section for each active task that is currently associated with the release. An
active task is a task whose status is either "open" or "closed". Tasks with a status of "Finished" are
excluded.
Task - The task name of the associated task. If the folder adjacent to the task name is yellow,
the task is closed. If the folder is green, the task is open.
Type - The task type code assigned to the task.
Stat - The status code assigned to the task.
Prty - The priority of the associated task.
CM - If the letters CM appear in this column, then the task is associated with a Community
Manager issue.
74
Report Manager User Guide LM(i) Report Samples
DVP - The number of this release's objects that are associated with this task and are resident in
a development environment. The value is displayed in red and includes retired objects.
ITG - The number of this release's objects that are associated with this task and are resident in
the release's integration environment. The value is displayed in red and Includes retired objects.
QUA - The number of this release's objects that are associated with this task and are resident in
the release's quality assurance environment. The value is displayed in red and Includes retired
objects.
PDN - The number of this release's objects that are associated with this task and are resident in
the release's production environment. The value Includes retired objects.
Rel - The total number of this release's objects that are associated with this task.
Other Rel Count - The number of other releases that are also associated with this task.
Other Rel Obj - The number of objects associated with other releases that are associated with
this task.
Created - The date the current task was created.
Age - The age of this task in days.
Due Date - The due date of this task.
Days Till Due - The number of days until this task is due.
Est % Comp - The estimated percent completion for this task.
Task Link
Each task name in the report is a link to the LM(i) Task Summary Report for the selected task. (See
LM(i) Task Summary Report.)
If you position the mouse over the task name, the task description is displayed.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
75
LM(i) Report Samples Report Manager User Guide
Header Section
76
Report Manager User Guide LM(i) Report Samples
Release activated - If Yes, the release is activated. If No, the release is not activated. An
activated release is a release whose inventory of objects is ready to be used.
Allow changes to objects - If Yes, objects in this release may be checked out. If No, no check
outs are allowed.
Production libraries - The number of libraries defined for the production environment in this
release.
Release created - The date the release was created.
Last change date - The last date any object in the release was checked in or promoted.
Default OS target release - Defines the release of the IBM i Operating System to which
compiles/builds will be targeted. The value *APP means that the value for the release is taken
from the containing application.
Library group assignment - Defines the method by which library groups are assigned. The
possible values are:
*MAP - Use the same library group assignment as the parent release
*PROMPT - Library group assignment is manually assigned
*PROGRAM - The name of a library group assignment program
Promote with conflict to - The environment abbreviation of the highest environment on the
promotion path an object can be promoted to when there is a release conflict condition on the
object. The value *NONE means no promotes are allowed when there is a release conflict
condition on the object.
Details/Checkouts Section
Multiple checkouts allowed - If Yes, more than one developer may have an individual object in
this release checked out at the same time. If No, each object in the release may be checked out
by at most one user.
Emergency checkouts authorized - If any LM(i) user has authority to perform emergency check
outs, the field is marked Yes. Otherwise, the field is marked No.
Comment required to checkout - If Yes, when performing a check out operation, the user must
provide a comment to be associated with the check out. If No, a comment is not required.
Task required to checkout - If Yes, for this release, each time a check out is performed, the user
must provide the task name of a task to associate with the checked out objects. If No, no task
name is required.
77
LM(i) Report Samples Report Manager User Guide
Request required to checkout - If Yes, objects in this release may be checked out only if there is
a current request checkout pending for the objects. If No, no request checkout is required.
Acknowledgement conditions deleted - The total number of acknowledgement conditions that
have been deleted by any user since this release was created.
Total normal checkouts - The total number of objects in this release that are currently or have
been checked out via a normal checkout (as opposed to an emergency checkout)..
Checkout request pending - The total number of objects in this release for which a checkout
request is pending
Current multiple checkouts - The total number of objects in this release for which there is a
multiple checkout condition.
Acknowledgements not deleted - The total number of acknowledgement conditions that have
not been deleted.
Total emergency checkout - The total number of objects in this release that are currently or
have been checked out via an emergency checkout.
Details/Promotions Section
Comment required to promote - If Yes, when performing a promote operation, the user must
provide a comment to be associated with the promote operation. If No, a comment is not
required.
Request required to promote to PDN - If Yes, objects in this release can be promoted to the
production environment only if a request promote is pending for the objects. If No, no request is
required.
Request required to install live to PDN - If Yes, objects in this release can be "installed live" to
the production environment only if a request install live is pending for the objects. If No, no
request is required.
Promote requests pending - The total number of objects in this release for which a promote
request is pending.
Install live requests pending - The total number of objects in this release for which an install live
request is pending.
Details/Task Summary Section
The number of tasks associated with this release whose task status is, open, closed and finished
and the sum of the three values. If the task counts are non-zero, there is a link to the LM(i) Active
Tasks Associated with Release Report.
Environments & Applications/Environments Section
78
Report Manager User Guide LM(i) Report Samples
Environments - This section lists all of the environments currently defined for this release. For
each listed environment, the columns are:
Environment Abbreviation(Environment Location Code).
Verify Status - Applies only to non-developer environments. The status can be either
"Verified", "Not Verified" or "Clean". The field is blank for developer environments. If the
Verify Status is "Not Verified", the text displays in red.
Verify Date - Applies only to non-developer environments. If the Verify Status is "Verified",
the Verify Date is the date of the verification. The field is blank for developer environments.
Objects - The number of objects resident in this environment irrespective of task.
Conditions - The condition codes currently associated with this environment.
Last Change - The date of the last change of any object in this environment.
Tasks - The number of tasks currently associated with objects in this environment.
Important - If a task has objects in more than one environment, the task is counted only
once. The count appears for the environment that is lowest on the promotion path among
environments containing an instance of the object. For example, objects in a task are
resident in the Integration, QA, and Production environments. The task is counted only
once and that count is shown for the Integration environment because it is the lowest
environment on the promotion path containing an instance of the object.
For the following 6 fields, each has one of three possible values:
o Yes - Indicated by a solid gray square.
o No - Indicated by a white square with a gray border.
o Select - Indicated by a square that is half white and half gray. If a field is marked as
"Select", the user is asked to choose when the promote action is invoked. "Select" is
valid only for the "CD" column.
CP - Objects will be created in the environment upon promotion to the environment.
CD - Objects that are dependents of the objects being promoted to the environment will be
created as part of the promote operation.
AD - Objects being promoted to this environment will be auto-deployed.
RP - A request to promote is required for promoting to this environment.
RIL - A request is required for performing an install live from this environment.
IL - An install live action will be performed for objects promoted to this environment.
Environments & Applications/Shared Applications Section
This release uses applications - A list of the applications that this release uses. If sharing is not
in effect, "None" is displayed.
Parallel Environments - If any applications are identified in the "This release uses applications"
field, Yes or No is checked to indicate whether test environments are included in the library list.
Applications that use this release - A list of the applications that use this release. If sharing is
not in effect, "None" is displayed.
79
LM(i) Report Samples Report Manager User Guide
Parallel Environments - If any applications are identified in the "Applications that use this
release" field, Yes or No is checked to indicate that test environments are included in the library
list.
Report Footer Section
Report parameters selections - Lists the group, application and release specified in the report
parameter set for this report.
Created On - A time stamp reflecting the date and time this report was created.
80
Report Manager User Guide LM(i) Report Samples
Header Section
There is one detail line in this report for each activity record that meets the selection criteria.
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Timestamp - Date and time the activity occurred
Activity - A 3-character code indicating the type of activity. (Refer to the LM(i) documentation for
a complete description of activity codes.)
Error - A 2-digit error code for failed activities indicating the nature of the failure. A blank field
indicates a successful operation. Refer to the LM(i) documentation for a complete description of
the error codes. (See Appendix J - Resources.)
Object - Object name
Type - Object type
From Rel - The release name of the release the object was in at the beginning of this activity.
From Env - The environment abbreviation of the environment in which the object instance was
resident at the beginning of this activity. A plus sign preceding the environment abbreviation
indicates a developer environment.
81
LM(i) Report Samples Report Manager User Guide
To Env - The environment abbreviation of the environment in which the object instance was
resident at the conclusion of this activity. A plus sign preceding the environment abbreviation
indicates a developer environment.
User - The user name of the user that initiated the activity.
Version - The version number of the object instance at the conclusion of this activity.
Comment - The user-entered comment attached to this activity.
If you position the mouse over an activity code, a more complete activity code description appears.
If you position the mouse over an error code, a more complete description error code description
appears.
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Release - The name associated with the application objects as they stand at a specific point in
time.
Activity Description - Text that explains the nature of the activity performed.
Error Description - Text that explains the nature of the error.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
Header Section
82
Report Manager User Guide LM(i) Report Samples
There is one detail line in this report for each activity record that meets the selection criteria.
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Timestamp - Date and time the activity occurred
Activity - A 3-character code indicating the type of activity. (Refer to the LM(i) documentation for
a complete description of activity codes.)
Error - A 2-digit error code for failed activities indicating the nature of the failure. A blank field
indicates that the operation was successful. Refer to the LM(i) documentation for a complete
description of the error codes. (See Appendix J - Resources.)
Object - Object name
Type - Object type
From Rel - The release name of the release the object was in at the beginning of this activity.
From Env - The environment abbreviation of the environment in which the object instance was
resident at the beginning of this activity. A plus sign preceding the environment abbreviation
indicates a developer environment.
To Env - The environment abbreviation of the environment in which the object instance was
resident at the conclusion of this activity. A plus sign preceding the environment abbreviation
indicates a developer environment.
User - The user name of the user that initiated the activity.
Version - The version number of the object instance at the conclusion of this activity.
Comment - The user-entered comment attached to this activity.
If you position the mouse over an activity code, a description of the activity code is displayed.
If you position the mouse over an error code, a description of the error code is displayed.
If you click on an object name, the LM(i) Activities by Object report is displayed for the selected
object. (See LM(i) Activities by Object Report.)
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
83
LM(i) Report Samples Report Manager User Guide
Release - The name associated with the application objects as they stand at a specific point in
time.
Activity Description - Text that explains the activity code's meaning.
Error Description - Text that explains the meaning of the error code.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
Note: To conserve space, some of the detail records for this page of the report have been removed.
Header Section
Note: To conserve space, some of the detail records have been removed for the above image.
There is one detail line in this report for each activity record that meets the selection criteria.
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
84
Report Manager User Guide LM(i) Report Samples
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Task - The identifier of the task associated with the recorded activity.
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Release - The name associated with the application objects as they stand at a specific point in
time.
Activity Description - Text that explains the nature of the activity performed.
Error Description - Text that explains the nature of the error.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
85
LM(i) Report Samples Report Manager User Guide
Header Section
There is one detail line in this report for each activity record that meets the selection criteria.
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Timestamp - Date and time the activity occurred
Activity - A 3-character code indicating the type of activity. (Refer to the LM(i) documentation for
a complete description of activity codes.)
Error - A 2-digit error code for failed activities indicating the nature of the failure. A blank field
indicates that the operation was successful. Refer to the LM(i) documentation for a complete
description of the error codes. (See Appendix J - Resources.)
Object - Object name
Type - Object type
From Rel - The release name of the release the object was in at the beginning of this activity.
From Env - The environment abbreviation of the environment in which the object instance was
resident at the beginning of this activity. A plus sign preceding the environment abbreviation
indicates a developer environment.
To Env - The environment abbreviation of the environment in which the object instance was
resident at the conclusion of this activity. A plus sign preceding the environment abbreviation
indicates a developer environment.
User - The user name of the user that initiated the activity.
Version - The version number of the object instance at the conclusion of this activity.
86
Report Manager User Guide LM(i) Report Samples
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Release - The name associated with the application objects as they stand at a specific point in
time.
Activity Description - Text that explains the nature of the activity performed.
Error Description - Text that explains the nature of the error.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
Header Section
87
LM(i) Report Samples Report Manager User Guide
Detail Section
There is one detail line in this report for each activity record that meets the selection criteria.
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Timestamp - Date and time the activity occurred
Activity - A 3-character code indicating the type of activity. (Refer to the LM(i) documentation for
a complete description of activity codes.)
Error - A 2-digit error code for failed activities indicating the nature of the failure. A blank field
indicates that the operation was successful. Refer to the LM(i) documentation for a complete
description of the error codes. (See Appendix J - Resources.)
Object - Object name.
Type - Object type.
From Rel - The release name of the release the object was in at the beginning of this activity.
From Env - The environment abbreviation of the environment in which the object instance was
resident at the beginning of this activity. A plus sign preceding the environment abbreviation
indicates a developer environment.
To Env - The environment abbreviation of the environment in which the object instance was
resident at the conclusion of this activity. A plus sign preceding the environment abbreviation
indicates a developer environment.
User - The user name of the user that initiated the activity.
Version - The version number of the object instance at the conclusion of this activity.
Comment - The user-entered comment attached to this activity.
If you position the mouse over an activity code, a description of the activity code is displayed.
If you position the mouse over an error code, a description of the error code is displayed.
If you click on an object name, the LM(i) Activities by Object report is displayed for the selected
object. (See LM(i) Activities by Object Report.)
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Release - The name associated with the application objects as they stand at a specific point in
time.
Activity Description - Text that explains the nature of the activity performed.
Error Description - Text that explains the nature of the error.
88
Report Manager User Guide LM(i) Report Samples
Footer Section
Created On - A date and time stamp that identifies when the report was created.
Note: To conserve space, some of the detail records for this page of the report have been removed.
Header Section
89
LM(i) Report Samples Report Manager User Guide
Detail Section
Activity - A 3-character code that identifies the activity. If activity has been reported for this
activity code, the activity code is a link to the LM(i) Activities by Type Report for this activity
code. (See LM(i) Activities by Type Report.) For a complete description of the activity codes,
refer to the LM(i) documentation.
From - The environment abbreviation of the environment where the object instance resided prior
to the activity.
To - The environment abbreviation of the environment where the object instance resided
subsequent to the activity.
Description - A description of the activity code.
From - The earliest date for which activity was entered for this activity code.
Until - The latest date for which activity was entered for this activity code.
Count - The number of activity entries for this release and activity code. A value of zero
indicates that no activity has been reported for this release and activity code.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
90
Report Manager User Guide LM(i) Report Samples
Header Section
There is one entry in this report for each user that initiated activity for the releases identified by the
selection criteria.
User - The user name of the user initiating the activity. The user name is a link to the LM(i)
Activities by User Report for this release and user.
Description - The description of the user.
From - The earliest date for which activity was entered for this user.
Until - The latest date for which activity was entered for this user.
Count - The total number of activity entries for this user.
Footer Section
Created On - A date and time stamp that identifies when the report was created.
91
LM(i) Report Samples Report Manager User Guide
Header Section
Application - Identifies the selected application, in the format Group name/Application name.
Report parameters - Identifies the group, application, release, object, type, promote-to
environment, and date range values used to generate this report, as supplied on the Report
Parameters dialog.
92
Report Manager User Guide LM(i) Report Samples
Details Section
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Object Name - Identifies the name of the object that was processed.
Object Description - The object description appears immediately below the object name on the
description line. If the description is blank, the information does not appear. (If there are no
descriptions, the description line does not appear.)
Comment - Appears below the object description on the comment line, and reflects any
comment text associated with the activity. If no comment text exists, the comment line does not
appear.
Object Type - The IBM i type associated with the object that was processed.
Release - Identifies the release associated with the activity.
Timestamp - Identifies the date and time when the activity occurred.
Activity - The code used to identify the nature of the processing performed.
Activity Description - A text description associated with the activity code.
Task - Identifies the task associated with the object that was processed.
Task Description - The explanatory text associated with the task appears below the task name
on the description line. If the description is blank, the information does not appear. (If there are
no descriptions, the description line does not appear.)
User - Identifies the user profile of the person who performed the activity.
From Rel - Identifies the release associated with the object instance at the beginning of the
activity.
From Env - Identifies the environment in which the object instance processed resided at the
beginning of the activity. A plus sign prefix indicates a developer environment.
To Env - Identifies the environment in which the object instance processed was placed during
the activity. Appears in the uncustomized report output only the output type is Excel.
Version - Identifies the object version number of the processed object.
Error - A 2-digit error code for failed activities indicating the nature of the failure. A blank field
indicates that the operation was successful. Refer to the LM(i) documentation for a complete
description of the error codes. (See Appendix J - Resources.)
93
LM(i) Report Samples Report Manager User Guide
Hover the cursor over the Error column to see a complete description of the code shown, if any.
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Error Description - Text that explains the meaning of the error code.
Footer Section
94
Report Manager User Guide LM(i) Report Samples
Header Section
Application - Identifies the selected application, in the format Group name/Application name.
Report parameters - Identifies the group/application/release, task, promote-to environment, and
date range values used to generate this report, as supplied on the Report Parameters dialog.
Details Section
95
LM(i) Report Samples Report Manager User Guide
Task name and description - Each set of activities is delineated by the name and description of
the task under which the set of objects was processed. If you requested *ALL objects AND
some objects were processed without a task, (no task) appears instead of a task name.
Release - Identifies the release associated with the activity.
Comment - Any text comments the user entered when the activity was performed appear
immediately below the release.
Timestamp - Identifies the date and time when the activity occurred.
Activity - The code associated with the activity during which the task was processed.
Object name - Identifies the object that was processed during the activity.
Object type - The IBM i type associated with the processed object.
Description - Appears immediately below the Object Name, and reflects the text description
associated with the object.
User - Identifies the user profile of the person who ran the promotion.
From Rel - Identifies the release associated with the object instance at the beginning of the
promotion.
From Env - Identifies the environment in which the object instance processed resided at the
beginning of the activity. A plus sign prefix indicates a developer environment.
Version - Identifies the object version number associated with the processed object.
Error - A 2-digit error code for failed activities indicating the nature of the failure. A blank field
indicates that the operation was successful. Refer to the LM(i) documentation for a complete
description of the error codes. (See Appendix J - Resources.)
Hover the cursor over the Error column to see the a complete description of the code shown.
Footer Section
CHK Object checked CHK is the only activity used for this report that is
out associated with a DVP environment. It appears in the
output when your Activity selection is *ALL
(regardless of your environment selection), and when
your Environment selection is *ALL.
96
Report Manager User Guide LM(i) Report Samples
Instead of selecting a single activity code or *ALL, you can select from three “group” codes. Each
group code includes activity codes that are pre-selected for this report.
97
LM(i) Report Samples Report Manager User Guide
An example of the LM(i) Promotion and Checkout Activities by Object Report follows.
Header Section
Application - Identifies the selected application, in the format Group name/Application name.
Report parameters - Identifies the group, application, release, object, type, activity code,
environment, and date range values used to generate this report, as supplied on the Report
Parameters dialog.
98
Report Manager User Guide LM(i) Report Samples
Details Section
This report can be customized by including additional fields or excluding current fields. The shipped
report includes these field columns:
Object Name - Identifies the name of the object that was processed.
Object Description - The object description appears immediately below the object name on the
description line. If the description is blank, the information does not appear. (If there are no
descriptions, the description line does not appear.)
Comment - Appears below the object description on the comment line, and reflects any
comment text associated with the activity. If no comment text exists, the comment line does not
appear.
Object Type - The IBM i type associated with the object that was processed.
Release - Identifies the release associated with the activity.
Timestamp - Identifies the date and time when the activity occurred.
Activity - The code used to identify the nature of the processing performed.
Activity Description - A text description associated with the activity code.
Task - Identifies the task associated with the object that was processed.
Task Description - The task's description text appears below the task name on the description
line. If the description is blank, the information does not appear. (If there are no descriptions, the
description line does not appear.)
User - Identifies the user profile of the person who performed the activity.
From Rel - Identifies the release associated with the object instance at the beginning of the
activity.
From Env - Identifies the environment in which the object instance processed resided at the
beginning of the activity. A plus sign prefix indicates a developer environment.
To Env - Identifies the environment in which the object instance resided at the end of the
promotion activity. A plus sign prefix indicates a developer environment (for example, for a
checkout action).
Version - Identifies the object version number of the processed object.
99
LM(i) Report Samples Report Manager User Guide
Error - A 2-digit error code for failed activities indicating the nature of the failure. A blank field
indicates that the operation was successful. Refer to the LM(i) documentation for a complete
description of the error codes. (See Appendix J - Resources.)
Hover the cursor over the Error column to see a complete description of the code shown, if any.
Additional Available Fields
In addition to the fields included in the shipped report as described above, the following fields are
excluded from the shipped report, but available for you to include in your own custom report:
Group - The name of the product collection to which the application belongs.
Application - The name that represents the collection of software objects you are managing.
Error Description - Text that explains the meaning of the error code.
Total Objects - Identifies at the bottom of the report the total number of checked out or promoted
objects included in the report.
Footer Section
100
Report Manager User Guide LM(i) Report Samples
Header Section
Application - Identifies the application name, in the format Group name/Application name.
Release - Identifies the release name.
Report Parameters - Identifies the group, application, release, target, location, and date range
parameter values used to generate this report, as specified on the Report Parameters dialog.
Details Section
101
LM(i) Report Samples Report Manager User Guide
Deployment Set - Appears in the subheading; identifies the number of the deployment set
associated with a group of deployed objects.
Profile - Appears in the subheading; identifies the name of the deployment profile used to
deploy the deployment set's objects. If n/a appears, the profile is associated with a deployment
set that no longer exists.
From Environment - Appears in the subheading; identifies the application environment from
which the listed objects were deployed.
Object Count - Appears in the subheading; identifies the number of objects associated with the
deployment set.
Target - The name of the target associated with the deployment set.
Location - The name of the location associated with the deployment set.
Object - The object name of the deployed object listed.
Object Type - The IBM i type code for the deployed object listed.
Version - The object version number of the deployed object listed.
Timestamp - Identifies the date and time that the deployed objects listed were installed.
User - Identifies the name of the user profile associated with the job that installed the set at the
location.
Error - If an error occurred with the object the code prints in this column. Reveal the error code
description by hovering the cursor over error code.
Footer Section
Created On - A date and time stamp that indicates when the report was generated.
102
Report Manager User Guide LM(i) Report Samples
Header Section
Application - Identifies the selected application, in the format Group name/Application name.
Release - Identifies the selected release name.
Report Parameters - Identifies the group, application, release, target, location, and date range
report parameter values used to generate the report, as specified on the Report Parameters
dialog.
Details Section
103
LM(i) Report Samples Report Manager User Guide
Deployment set - Appears in the subheading, and identifies the number of the deployment set
associated with the deployment listed.
Profile - Appears in the subheading, and identifies the name of the deployment profile used to
perform the deployment listed.
Object Count - Appears in the subheading, and identifies the total number of objects associated
with the deployment set. (Note that some objects in a deployment might be installed on one
target/location, but not in other target/locations associated with the same set.)
Timestamp - The date and time of the deployment transaction. If not installed appears,
the set's last processed step precedes the Install step. If not backed out appears, the set's
last processed step precedes the Back Out step.
Target - The name of the target definition associated with the deployment set.
Location - The name of the location definition associated with the deployment set.
Status - The status of the deployment set at this target/location. Status codes are:
New (NEW)
Install requested (INR)
Installed (INS)
Installed, minor errors (INE)
Install Failed (INF)
Back out requested (BKR)
Backed out (BKO)
Back out minor errors (BKE)
Back out failed (BKF)
Finished (FIN)
Totals Section
Total deployment sets in release - Identifies the total number of deployment sets for the release
and time period.
Total deployments in release - Identifies the total number of deployments for the release and
time period. A deployment is defined as each unique combination of set/target/location. A
deployment set might include multiple deployments.
Total successful deployments in release - Identifies the total number of target locations for the
release and time period where deployments were successfully installed or backed out. (These
are records with status codes of INS, INE, BKO, BKE, FIN.)
Total failed deployments in release - Identifies the total number of target locations for the
release and time period where deployments failed during installation or backout. (These are
records that have a status code of INF, BKF.)
104
Report Manager User Guide LM(i) Report Samples
Total backed out deployments in release - Identifies the total number of deployments that were
backed out for the release/time period. (These are records that have a status code of BKO,
BKE.)
Total in-process deployments in release - Identifies the total number of deployments that were
in-process for the release/time period. (These are records that have a status code of NEW,
INR, BKR.)
Footer Section
Created On - A date and time stamp that indicates when the report was generated.
Header Section
Application - Identifies the application associated with the release whose permissions are listed.
105
LM(i) Report Samples Report Manager User Guide
Authority Type: User or Class & Definition Level - This column contains the name of the user or
user class. All authority settings appear across the row. It also shows the level at which the
user's authorities are set. User authorities can be set at the global, application, or release level.
If authorities are set at the release level, they override application or global-level settings. If
authorities are set at the application level, they override global-level settings.
Authority Source - This column indicates, for each user, the source from which this user's
authority settings are derived. Authority settings can be derived from a specific user record or
from a class record that is defined at the global application or release level.
If user authorities are set with a user class, this column also shows where the class is defined.
Most of the time, classes and users are defined at the same level. However, class authorities
can be defined at the global, application, and release levels. Users can also be associated with
classes at any level. For example, a class can be assigned authorities at the application level. A
user can be associated with that class at the release level. If the class is not defined at the
release level and the user is defined at the release level, the user's authorities will be derived
from the application-level class definition. In this case, the report would show the user's name
and "Release" in the Authority Type column, and class name and "Application" in the Authority
Source column.
Permissions - Each column represents an LM(i) function with access that can be permitted or
refused for a user. The indicator box in the column is shaded if the user is permitted to perform
the associated function; it is white if the user cannot perform the associated function.
Footer Section
Created On - A date and time stamp that indicates when the report was generated.
106
Report Manager User Guide LM(i) Report Samples
Header Section
Report Parameters - Identifies the user name and/or user class name parameter value and the
selected scope used to generate this report, as specified on the Report Parameters dialog.
Details Section
107
Appendices Report Manager User Guide
Authority Type: User or Class & Definition Level - This text identifies the user or user class
whose permission settings are summarized on this page. It also shows the level at which the
user's authorities are set. User authorities can be set at the global, application, or release level.
If authorities are set at the release level, they override application or global-level settings. If
authorities are set at the application level, they override global-level settings.
Authority Source: User or Class & Definition Level - This column indicates, for each user, the
source from which this user's authority settings are derived.
If user authorities are set with a user class, this column also shows where the class is defined.
Most of the time, classes and users are defined at the same level. However, class authorities
can be defined at the global, application, and release levels. Users can also be associated with
classes at any level. For example, a class can be assigned authorities at the application level. A
user can be associated with that class at the release level. If the class is not defined at the
release level and the user is defined at the release level, the user's authorities will be derived
from the application-level class definition. In this case, the report would show the user's name
and "Release" in the Authority Type column, and the class name and "Application" in the
Authority Source column.
User Authority Level - Global (*ALL), Named Application or Release - This column indicates
where the authority settings are enforced. The settings can apply globally, at the application
level, or at the release level. Release-level settings override application-level settings, and
application-level settings override global-level settings.
If the settings apply to all applications without specific application- or release-level settings, the
column contains *ALL/*ALL/*ALL. If the settings apply to all releases of an application without
specific release-level settings, the column contains the Group Name and Application Name,
followed by *ALL for the release. If the settings apply only to a specific release, the column
contains the group, application, and release names.
Permissions - Each column represents an LM(i) function with access that can be permitted or
refused for a user. The indicator box in the column is shaded if the user is permitted to perform
the associated function; it is white if the user cannot perform the associated function.
Refer to Chapter 3, Defining Users, in the LM(i) Setup and Administration Reference, for
descriptions of the impact of each setting.
Footer Section
Created On - A date and time stamp that indicates when the report was generated.
Appendices
This section contains supplementary information about Report Manager and related products. Use
this information to help you understand and achieve the best possible reporting results.
108
Report Manager User Guide Appendices
Appendix A - LM Concepts
In order to successfully use RM, you must be familiar with the following concepts for both LM(i) and
LM(e):
Group - A collection of one or more applications.
Application - A collection of one or more releases. By definition, every application must be
contained in a group.
Release - The collection of parts or objects that, taken together, constitute a version of an
application. By definition, every release must be contained in an application.
Environment - There can be multiple copies of an object while under development in LM.
For example, there can be a development copy, an integration copy, a quality testing copy,
etc. Each of these copies is said to be located in an environment. In RM, environments are
identified by their 3-character environment abbreviation. Environments are associated with
releases. Every release has at least one associated environment, known as the Production
Environment in LM(i). There can be up to 2 additional testing environments. Refer to the
LM(i) documentation for more information.
Class - A class is a specific named set of defined permissions in LM(i), defined at the global,
application, or release level. Users assigned to a class have the specific LM(i) permissions
of that class. For example, there might be a class for Developers. Adding a user to the
Developer class automatically confers all of the permissions defined for the class to that
user. Assigning a user to a class makes it easier to assign permissions to groups of users
who perform similar job functions.
Tasks - The description of a unit of work to be performed for the objects in a release. Each
task can be associated with zero or more releases.
User - A person that is explicitly given access to use LM(i). The user must also be an
authorized user of the system hosting the LM(i) server. A user is uniquely identified by a
user name.
Activity type - A 3-character code that indicates the type of activity that causes a particular
database record to be created. An example of an activity type code is "PRM" meaning
"Promote".
Location - A named definition that describes local or remote IBM i computers in your network
that can receive deployments. Typically, users define one location for each physical or
logical (LPAR) system to which they want to deploy changed software.
Target - A named definition that defines where deployed objects should be installed during a
deployment.
For a detailed discussion of each of these concepts, refer to the appropriate documentation for
LM(i). (See Appendix J - Resources.)
109
Appendices Report Manager User Guide
110
Report Manager User Guide Appendices
Group parameter:
*ALL - Includes every group that is currently defined in the associated database.
A specific group name selected from the field's drop-down list.
Any subset of the currently defined groups in the associated database, defined by entering a
group name with or without wildcards.
*NONE - Available for the LM(i) Task Summary Report only. This value provides a report of
tasks that are not assigned to any group, application, and release.
Application parameter:
*ALL - Includes every application that is currently contained in the group(s) identified by the
Group parameter.
A specific application name selected from the field's drop-down list.
Any subset of the currently defined applications contained in the group(s) identified by the
Group parameter, defined by entering an application name with or without wildcards.
*NONE - Available for the LM(i) Task Summary Report only. This value provides a report of
tasks that are not assigned to a group, application and release.
Release parameter:
*ALL - Includes every release that is currently contained in the application(s) identified by
the Application parameter.
A specific release name selected from the field's drop-down list.
Any subset of the currently defined releases contained in the application(s) identified by the
Application parameter, defined by entering a name with or without wildcards.
111
Appendices Report Manager User Guide
*NONE - Available for the LM(i) Task Summary Report only. This value provides a report of
tasks that are not assigned to a group, application, and release.
Version parameter:
*ALL - Includes every version that is currently contained in the release(s) identified by the
Release parameter.
A specific version name selected from the field's drop-down list.
Any subset of the currently-defined version contained in the release(s) identified by the
Release parameter, defined by typing a name with or without wildcards.
Task parameter:
*ALL - Includes every task that is currently associated with at least one of the releases
identified by the Release parameter.
Any subset of the tasks associated with the release(s) identified by the Release parameter,
defined by entering a task name with or without wildcards.
Note: Task names are case sensitive in LM(e) reports.
Environment parameter:
*ALL - Includes all environments associated with at least one of the releases identified by
the Release parameter.
A specific environment abbreviation selected from the field's drop-down list.
Any subset of environment abbreviations associated with any of the release(s) identified by
the Release parameter, defined by entering an environment abbreviation with or without
wildcards.
User parameter:
*ALL - Includes every user defined in the associated database.
A specific user name selected from the field's drop-down list.
Any subset of the currently defined users, defined by entering a user name with or without
wildcards.
Type parameter:
*ALL - Includes all activity types.
A specific type code selected from the field's drop-down list.
Any subset of currently defined activity types contained in the associated database, defined
by entering an activity type code with or without wildcards. For a complete list of the
currently defined activity type codes, see the appropriate documentation for LM(i) or LM(e).
(See Appendix J - Resources.)
Object Name or Part Name parameter:
*ALL - Includes all objects or parts.
Any subset of the object or part names in the associated database, defined by entering a
name with or without wildcards.
Object type parameter:
*ALL - Includes all object types.
A specific object type selected from the field's drop-down list.
112
Report Manager User Guide Appendices
Any subset of the object types in the associated database, defined by entering an object
type with or without wildcards.
Date Parameters
This section describes entry requirements for the Date Parameters section's date range fields.
You must complete the selection criteria section before supplying values for the date fields.
From and
To parameters:
These fields are available when the Date Range radio button is activated.
By default, the From date is initially set to a specific date, and the To date is set to the
current date.
Use the Date Picker to select the From and To dates you want.
Future dates are not allowed.
Unrealistic month and day numbers are not allowed (for example, a month of 13 or a day of
32).
Wildcards cannot be used in the date range fields.
If you prefer to select a date rather than enter it, click the arrow at the right side of the fields.
Use the month and year selection arrows to navigate to a specific date, month, and year.
Select Today in the lower left corner to select today.
If you enter a date, use the format YYYY-MM-DD.
Previous X Days parameter:
This field is available when the Previous X Days radio button is activated.
Up to three digits are allowed (a maximum of 999 days).
Each digit must be a positive whole integer from 0 to 9.
By default, the initial value is 0, which is interpreted as the current date, or today.
113
Appendices Report Manager User Guide
When you invoke a particular report in RM with output type of HTML, the report is rendered in
HTML and displayed in your browser.
In addition to the formatted report, there are two optional outputs controlled by the Report
Parameters dialog, the Tool Bar and the Navigation Bar.
Run the report (regenerate the report with newly collected data).
114
Report Manager User Guide Appendices
You can control whether the report's table of contents is displayed by clicking the Table of Contents
toggle button , located on the Report Tool Bar. When visible, the table of contents is displayed
on the left side of the browser window. If the table of contents is displayed, clicking the Table of
Contents button once will remove the table of contents from the display. The remaining display is
shifted to the left to take up the space. Clicking the Table of Contents button again will cause the
table of contents to be re-displayed.
If you click on an entry in the table of contents, the report is positioned to the page that contains the
data associated with the selected table of contents entry.
This dialog allows you to select the format of the printed report and the pages of the report that will
be printed.
Pages to Print
With this option, you can control which pages of the report are printed. The choices are:
Print all pages
Print only the current page (the page currently displayed in the browser)
Print specified pages by entering specific page numbers (1, 3, 8, etc.) or a range of pages
(3-9).
When you have selected the desired options, click the OK button to launch the new browser
window.
116
Report Manager User Guide Appendices
If you click the Cancel button, control returns to the browser window containing the generated
report.
The above dialog is a native BIRT dialog. In order for all of the above options to work correctly, the
server printer must be configured to support the options. For more information regarding the options
on this dialog, consult the BIRT documentation and/or your System Administrator.
The left side of the navigation bar shows the current page number and the total number of
pages.
The four icons on the right side of the navigation bar control page-to-page movement:
Go to the first page of the report (disabled if the current page number is 1)
117
Appendices Report Manager User Guide
Go to the next page of the report (disabled if current page is the last page)
Go to the last page of the report (disabled if current page is the last page)
In the Go To Page area, you may enter a page number and then click
the green arrow. The report is positioned to the requested page. The page number you
enter must be in the range of 1 to the maximum number of pages in the report. If not, an
invalid page number error message is displayed.
118
Report Manager User Guide Appendices
119
Appendices Report Manager User Guide
The export operation exports some or all of the data fields defined by a result set. A result set is a
named collection of the fields available in a report. The available result sets are defined by Rocket
Aldon.
Available Result Sets
The available result sets for the associated report are listed in the drop-down list of the Available
Result Sets combo box. The combo box is initialized to a default result set that contains all of the
fields contained in the report. To select a different result set, click the down arrow of the combo box
and select the desired result set from the drop-down list.
Available Columns
The Available Columns list box lists the report fields that are associated with the result set that is
currently selected in the Available Result Sets combo box. You may export all or any subset of the
available columns of a report set.
120
Report Manager User Guide Appendices
Selected Columns
The Selected Columns list box lists the fields that will be exported in the current export operation.
To identify the columns that will be exported, you must "move" a column name from the Available
Columns list to the Selected Columns list, as follows:
If you click the Add All button , all columns currently in the Available Columns list are
added to the Selected Columns list.
To move individual columns from the Available Columns list to the Selected Columns list,
select the column name(s) in the Available Columns list and click the Add Selected button
.
If you want to remove all of the columns in the Selected Columns list, click the Remove All
button .
To remove selected columns from the Selected Columns list, select the column name(s) and
click the Remove Selected button .
Once you have finalized the columns in the Selected Columns list, you can change the order
in the list by selecting a column name and using the Up button or the Down button .
When you perform the export, the top to bottom order of the fields in the Selected Columns
list becomes the left to right order of the fields in the output file.
Export Format
Currently, the only export format supported is "csv" which is short for "comma-separated values". In
this format, each record in the file is a continuous string of characters with the individual fields
separated by a defined separator character (See Separator, below). If the data are from a multi-row
table, there is one record in the file for each row of the table. This export format is suitable for
importing into Microsoft Excel.
Output Encoding
The Output Encoding radio buttons control the character set that is used to encode the data in the
output file. The default is UTF-8. If you select the Other radio button and leave the associated edit
box blank, the encoding will be the default for the local PC. For information regarding values that
may be specified for "Other", see the BIRT documentation.
Separator
The Separator combo box enables you to select the separator character that will be used in the
"csv" file. The choices are:
Comma (Default) - Decimal 44, Hexadecimal 2C
Semicolon - Decimal 59, Hexadecimal 3B
Colon - Decimal 58, Hexadecimal 3A
Vertical Line - Decimal 124, Hexadecimal 7C
Tab - Decimal 9, Hexadecimal 9
Contents of the Output File
The output file will contain one record for each row in the SQL table that is defined by the selected
result set. In addition, the first record in the output file will contain a list of the column names
appearing in the file. The column names are placed in the record in the same way as the data, i.e.,
as a continuous string of characters with the individual fields separated by the separator character.
121
Appendices Report Manager User Guide
Exporting a Report
The Export Report function enables you to export an image of the report as it is displayed in the
browser to an external file on your PC. Exporting a report should not be confused with exporting the
report data. (See Exporting Report Data.)
When you select the Export Report button of the Report tool bar, the Export Report dialog is
displayed.
Export Format
The format of the exported report can be compatible with the following:
Microsoft Word (Default)
Microsoft PowerPoint
Microsoft Excel
PostScript
Adobe PDF
To select one of the export formats, click the down arrow of the Export Format combo box and
select from the drop-down list.
Pages
You can export some or all of the pages contained in the report. The choices are:
All pages
The current page (The page currently displayed in the browser.)
Individual pages or a range of pages (Examples: 3-6 or 1,3,6)
122
Report Manager User Guide Appendices
Select your choice by clicking one of the radio buttons and, if necessary, entering the page
numbers of the pages to print.
Size Radio Buttons
The size radio buttons are enabled for export formats PowerPoint, PDF and PostScript. The
choices are:
Auto
Actual Size
Fit to Whole Page
The selection is passed to the individual export target program where the effect is the same as if
you made the selection from within the application program.
After making the desired selections, invoke the export operation by clicking the OK button. A
standard Windows File Download dialog is displayed.
123
Appendices Report Manager User Guide
On this dialog, you can select the folder where the file will be saved and, if desired, change the file
name. After making any changes, click the Save button to begin the download of the file. While the
file is downloading, a Download Progress dialog is displayed, followed by a Download Complete
dialog.
124
Report Manager User Guide Appendices
Enter the validation string exactly as provided by Rocket Aldon. It consists of 3 sets of 4
alphanumeric characters and one set of 2 alphanumeric characters. Alphabetic characters
are always entered in upper case. Click the Next button.
If you click the Next button without entering the validation string, the following message is
displayed.
If you do not have the validation string available, click the Close button .
125
Appendices Report Manager User Guide
If you click the OK button, the Enter Validation Information dialog is redisplayed.
If the validation string is invalid or you entered the string incorrectly, the Validation Error 300
error message is displayed.
Click the OK button. The Enter Validation Information dialog is redisplayed. If you have
entered the validation string correctly and you still get the error, call the telephone number
shown in the message.
If the entered validation string is valid, the installation procedure completes with no further
messages.
Enter the validation string exactly as provided by Rocket Aldon. It consists of 3 sets of 4
alphanumeric characters and one set of 2 alphanumeric characters. Alphabetic characters
are always entered in upper case. Click the Next button.
If you click the Next button without entering the validation string, the following message is
displayed.
126
Report Manager User Guide Appendices
If you do not have the validation string available, click the Close button .
If you click the OK button, the Enter Validation Information dialog is redisplayed.
If the validation string is invalid or you entered the string incorrectly, the Validation Error 300
error message is displayed.
Click the OK button. The Enter Validation Information dialog is redisplayed. If you have
entered the validation string correctly and you still get the error, call the telephone number
shown in the message.
If the entered validation string is valid, the installation procedure completes with no further
messages.
127
Appendices Report Manager User Guide
Browser Settings
A variety of Web browser settings control how your Web browser behaves during use. Browser
settings associated with tabs and cookies can in turn affect the way RM behaves.
Tabs
When RM opens a new browser window, it will either invoke a new instance of the browser or open
a new tab in the existing browser instance. Because both supported browsers, Mozilla Firefox and
Internet Explorer, support multiple tabs, and because you can indicate in your browser's settings
how you want the browser to behave when opening a new window, the application's behavior
depends on those browser settings. Consult the documentation for the browser you are using to
adjust the settings to your preference.
Cookies
The security settings in Internet Explorer can affect the display of graphics in RM. For IE-8, if you
have the security level set above "High" or for IE-7 if cookies are not allowed, certain graphics will
not display properly in the RM windows. Note that this is an issue with BIRT that is beyond the RM
application's control.
128
Report Manager User Guide Appendices
Appendix I - Licenses
Disclaimer - The information contained in this appendix was compiled from multiple sources. While
it is believed to be accurate at the time of publication, Rocket Software makes no warranty of any
kind with regard to the information shown herein.
Licenses
Report Manager , Lifecycle Manager (Enterprise Edition), and Lifecycle Manager (IBM i Edition) are
used in accordance with the Rocket Software License. RM uses third party products or libraries, in
accordance with their respective licenses. The full text of the Rocket Software License and a
complete list of third party products and their license information appears in the RM install location,
in the following file:
C:\Program Files\Aldon\AldonReportManager\Licenses\license.txt
(This path reflects the default install location. If the install location was changed from the default
value at installation time, substitute your install location for the default path shown above.)
License Agreement
This software and the associated documentation are proprietary and confidential to Rocket
Software, Inc., are furnished under license, and may be used and copied only in accordance with
the terms of such license.
Your use of Rocket software, documentation, information and other Rocket content
(collectively, “Content”) is subject to you or your employer entering into a signed license
agreement (“Agreement”) with Rocket governing how the Content may be used by you.
If you or your employer have not executed such an Agreement with Rocket covering your
use of the Content, please do NOT continue installing or using the Rocket software or other
Content.
Plug-ins, Plug-in fragments, and other features also constitute Rocket Content and are also
governed by the Agreement, whether or not expressly referenced therein.
Any conflict between any online or other license agreement between you and Rocket and
the signed Agreement shall be resolved in favor of the signed Agreement.
Your rights to use the Content may not be assigned or transferred to any other user without
Rocket’s express prior written consent.
Rocket software and other content is also protected by United States copyright laws and
international treaties. Any unauthorized use of the software and other copyrighted content
can subject you to statutory damages running to US $150,000 per infringement, and
possibly to criminal penalties.
129
Appendices Report Manager User Guide
Appendix J - Resources
The information in this online help system is also available as a user guide in PDF format from the
Rocket Community (http://www.rocketsoftware.com/support).
RM
For information about installing or upgrading RM and about applying PTFs, refer to your RM
Installation Guide.
LM(e)
If you are an LM(e) user, you can access the LM(e) on-line help. For more information about LM(e),
the following resources are also available in PDF format on the Rocket Community
(http://www.rocketsoftware.com/support):
LM(e) User Guide: Introduction and Overview
LM(e) User Guide: How Do I ... ?
LM(e) User Guide: Setup and Special Topics
LM(i)
For more information about LM(i), the following resources are available for download from the
Rocket Community (http://www.rocketsoftware.com/support).
LM(i) Features and Capabilities Reference
LM(i) User's Guide
LM(i) Daily Operations Reference
LM(i) Setup and Administration Reference
LM(i) Object Deployment Reference
LM(i) Task Tracking Reference
LM(i) General Topics Reference
LM(i) Additional Interfaces Reference
In addition to the above documents, if you are an LM(i) user, you can access the LM(i) on-line help.
Adobe PDF
All documentation available for download from the Rocket Community is provided in Adobe Acrobat
Portable Document Format (PDF). To use them, you must be able to view and/or print PDF
documents. One solution is to download the Adobe Reader from the Adobe web site
(www.adobe.com). Any Adobe Reader version 6.0 or later should work.
130
Report Manager User Guide Appendices
BIRT Documentation
For more information about Eclipse/BIRT, see http://www.eclipse.org/birt/phoenix/intro/. There are
also several BIRT reference books available. The following are two examples:
BIRT: A Field Guide to Reporting (2nd Edition)(Eclipse Series) by Diana Peh, Nola Hague
and Jane Tatchell
Practical Data Analysis and Reporting with BIRT by John Ward.
Tomcat Documentation
For more information about Apache Tomcat, see http://tomcat.apache.org/.
131
Appendices Report Manager User Guide
Resolution: 72 dpi
Note: Following these instructions changes the logo that appears on your generated reports, but
does not change the product logo that appears on the RM home page.
132
Report Manager User Guide Glossary
Glossary
A
Activity Type: A code that indicates the type of activity that caused a database record to be
created
Application: A collection of one or more releases
B
BIRT: Acronym for Eclipse Business Information Reporting Tool
C
Client: The computer hosting the web browser used to run Report Manager
E
Environment: A version of an object
Export: Copying either the report image or the report data to an external file
G
Group: A collection of one or more applications
L
License: Report Manager is licensed. There are two types of licenses, Test Drive Trial License
and Permanent License. A Test Drive Trial License has a fixed expiration date while a
Permanent License does not expire.
LM(e): Rocket Aldon Lifecycle Manager (Enterprise Edition)
LM(i): Rocket Aldon Lifecycle Manager (IBM i Edition)
P
PDF: Adobe Portable Document Format
R
Release: A collection of objects that, taken together, constitute a version of an application
Report: Any of the predefined report type and a specific set of report parameters
Report Category: A collection of report folders and reports. RM is shipped with one report
category defined. Users may define up to 19 additional categories.
Report Folder: A container for sub-folders and reports
Report Manager: A web-based application for creating reports using LM(i) and LM(e) data
133
Glossary Report Manager User Guide
Report Parameters: A set of values that serve to select a subset of data from the database as
well as define the output options
Report Type: Any of a set of pre-defined report formats included with Report Manager
Result Set: A subset of the available data fields in a report that will be exported
S
Security Server: Rocket Aldon Security Server provides security services such as user
authentication and user authorization for Rocket Aldon products.
Server: Depending on context, this might refer to the computer hosting the server portion of
LM(i) or LM(e), OR it might refer to the Report Manager server.
T
Task: The description of a unit of work to be performed on the parts or objects in a release
TOMCAT: Web page server for Web-based applications
U
User: A person that is authorized to use LM(i)
V
Validation String: A string of alphanumeric characters used to validate the license for RM. It
consists of 3 sets of 4 alphanumeric characters and 1 set of 2 alphanumeric characters
W
Wildcard: A special character (%) that can represent any number of characters in a match
string
134
Report Manager User Guide Index
Index
135
Index Report Manager User Guide