Академический Документы
Профессиональный Документы
Культура Документы
Version 10.1.0
User Guide
Product Information
This document applies to IBM Cognos Business Intelligence Version 10.1.0 and may also apply to subsequent releases. To check for newer versions
of this document, visit the IBM Cognos Information Centers (http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/index.jsp).
Copyright
Licensed Materials - Property of IBM
© Copyright IBM Corp. 2007, 2010.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
IBM, the IBM logo, ibm.com, ReportNet, and Cognos are trademarks or registered trademarks of International Business Machines Corp., in many
jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is
available on the Web at www.ibm.com/legal/copytrade.shtml.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in
the United States, and/or other countries.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
Table of Contents
Introduction 5
Columns 26
Appendix A: Troubleshooting 43
Log Files 43
Unable to Start IBM Cognos Lifecycle Manager 44
Unable to Connect to Source or Target Environment 45
Name of Project or Archive Returns an Error 45
Unable to Manually Add Prompt Values 45
Prompts Do not Appear in IBM Cognos Lifecycle Manager 46
Prompt Values Generated for Dimensional Data Source Do not Work 46
Test Case Archive Is Incomplete 46
Unable to Create Test Case Archive 47
A Report Upgraded from ReportNet Does Not Retain its Original Look 47
PDF Output Looks Different When Running an Upgraded Report 47
No Warning Appears when Changing Status of a Report in PDF Output Compare Tool 47
Out of Memory Error Occurs when Executing Large Reports 48
java.lang.OutOfMemoryError Message Appears in IBM Cognos Lifecycle Manager Log File 48
Index 51
This document is intended for use with IBM® Cognos® Lifecycle Manager. Lifecycle Manager is a
Microsoft® Windows® operating system-based application that assists in the process of verifying
upgrades from ReportNet® or previous versions of IBM Cognos Business Intelligence to IBM Cognos
BI by identifying and logging potential upgrade issues.
Lifecycle Manager delivers the following three values in support of this activity:
● Proven practice upgrade process
The user interface design and status reporting functionality provide both a proven practice
process and support for upgrade project planning and status reporting.
● Upgrade verification
Lifecycle Manager validates, executes, and compares report results from two different IBM
Cognos BI releases to let you rapidly identify upgrade and compatibility issues between releases.
This guide contains instructions for installing, configuring, and using Lifecycle Manager.
Audience
To use this guide, you should be familiar with
● basic Windows or UNIX® operating system administration concepts
● reporting concepts
Finding information
To find IBM® Cognos® product documentation on the web, including all translated documentation,
access one of the IBM Cognos Information Centers at http://publib.boulder.ibm.com/infocenter/
cogic/v1r0m0/index.jsp. Updates to Release Notes are published directly to Information Centers.
You can also read PDF versions of the product release notes and installation guides directly from
IBM Cognos product disks.
Accessibility features
This product does not currently support accessibility features that help users with a physical disability,
such as restricted mobility or limited vision, to use this product.
Forward-looking statements
This documentation describes the current functionality of the product. References to items that are
not currently available may be included. No implication of any future availability should be inferred.
Any such references are not a commitment, promise, or legal obligation to deliver any material,
code, or functionality. The development, release, and timing of features or functionality remain at
the sole discretion of IBM.
Samples disclaimer
The Great Outdoors Company, GO Sales, any variation of the Great Outdoors name, and Planning
Sample depict fictitious business operations with sample data used to develop sample applications
for IBM and IBM customers. These fictitious records include sample data for sales transactions,
product distribution, finance, and human resources. Any resemblance to actual names, addresses,
contact numbers, or transaction values is coincidental. Other sample files may contain fictional
data manually or machine generated, factual data compiled from academic or public sources, or
data used with permission of the copyright holder, for use as sample data to develop sample appli-
cations. Product names referenced may be the trademarks of their respective owners. Unauthorized
duplication is prohibited.
This section contains a list of new, changed, and deprecated features for this release. It also contains
a cumulative list of similar information for previous releases. It will help you plan your upgrade
and application deployment strategies and the training requirements for your users.
To review an up-to-date list of environments supported by IBM® Cognos® products, including
information about operating systems, patches, browsers, Web servers, directory servers, database
servers, and application servers, visit the Cognos Customer Center (http://www-01.ibm.com/software/
data/cognos/customercenter).
Benchmark Projects
You can now create benchmark projects to compare reports in a single environment. You can use
benchmark projects to compare
● snapshots against a baseline
● reports following the installation of an IBM® Cognos® refresh pack or any other upgrade, such
as a new database version
● reports executed with the dynamic query mode disabled and enabled
By using IBM Cognos Lifecycle Manager to test reports with the dynamic query mode enabled, you
are not affecting the reports that users access in IBM Cognos Connection. Once the testing is complete
and successful, you can specify that packages and associated reports in IBM Cognos BI use the
dynamic query mode.
For information about enabling the dynamic query mode when testing reports, see "Configure a
Project" (p. 20). For information about enabling the dynamic query mode in IBM Cognos BI, see
"Enable the Dynamic Query Mode in IBM Cognos BI" (p. 42).
Archive Projects
You can now archive projects to preserve your work. For example, you added your own prompt
values to reports and you do not want to have to reenter them. When a project is archived, it cannot
be modified. For more information, see "Archive a Project" (p. 24).
Session Credentials
You can now define credentials for each IBM® Cognos® Upgrade Manager session instead of
defining credentials when configuring a project. This ensures that your credentials are not used by
other users. For more information, see "Specify Session Credentials" (p. 23).
User Guide 9
Chapter 1: What’s New?
Clearing Projects
The menu item Clear Project in the previous release is deprecated, as you can now work with mul-
tiple projects (p. 18).
Upgrading to IBM® Cognos® Business Intelligence is a process that you can perform in stages. The
following workflow shows the tasks that are performed at each stage of the process in a typical
upgrade.
Upgrade Process Workflow
4
Deployment process
5
Test upgraded
applications
6
Move to production environment
IBM Cognos Lifecycle Manager performs the Test upgraded applications task shown in the above
diagram. For information about the other tasks, see the IBM Cognos BI Installation and Configu-
ration Guide.
ReportNet
Source and target IBM Cognos BI
or
environments
IBM Cognos BI
Lifecycle Manager connects to the source and target environments, validates and executes reports
in both environments, and then compares them. The results of the comparison are presented in a
dashboard.
In a benchmark project (p. 19), you are working in a single IBM Cognos environment. Consider
Run 1 as the source environment and Run 2 as the target environment when working in a benchmark
project.
Lifecycle Manager
● tests report output only by comparing results from one release (the source) to another (the
target)
● tests reports created in IBM Cognos Report Studio, IBM Cognos Query Studio, or IBM Cognos
Analysis Studio
The studios are not used in the testing, only saved report specifications.
Analysis Studio reports are tested only when upgrading from IBM Cognos Business Intelligence
8.2 to 8.3, 8.4, or 10.1.0.
● does not test any other aspects of the upgrade such as configuration, the studios, IBM Cognos
Connection, skins, and customizations
● does not test embedded HTML items except when they are used to control prompts and
parameters
HTML items are not rendered in PDF output.
● does not test interactive functionality such as drill up, drill down, drill through, HTML links
to external content, and bookmarks
● runs as a single user application, so security by value and similar user dependent items are not
tested
● does not test report views, bursting, and performance or scalability differences
Supported Environments
IBM® Cognos® Lifecycle Manager supports the following environments:
● IBM Cognos 8 8.2, 8.3, 8.4, and IBM Cognos Business Intelligence 10.1.0 as a source or target
environment
User Guide 13
Chapter 2: The Upgrade Process
IBM® Cognos® Lifecycle Manager is a standalone single-user application that you can install on
any computer. You do not have to install Lifecycle Manager on the computer where ReportNet®
or IBM Cognos Business Intelligence is installed.
To view Flash®-based elements in the Lifecycle Manager user interface, you must install Adobe®
Flash Player 9.0 or higher.
● Install the latest IBM® Cognos® Business Intelligence service pack or updater kit in your source
(if applicable) and target environments.
For information about what is changed in the update, see the IBM Cognos BI Fix List.
You can obtain updater kits or service packs at the Cognos Customer Center (http://www-01.ibm.
com/software/data/cognos/customercenter).
Steps
1. From the win32 directory where you extracted the downloaded installation package, double-
click issetup.exe.
2. Follow the directions in the installation wizard to copy the required files to your computer.
3. Click Finish.
4. From the Start menu, click the program folder you specified during the installation, and click
IBM Cognos Lifecycle Manager Startup.
A command window appears and Lifecycle Manager is initialized.
5. From the Start menu, click the program folder you specified during the installation, and click
IBM Cognos Lifecycle Manager URI.
Tip: You can also type http://<computer name>:4797/LifecycleManager in your Web browser.
When you start Lifecycle Manager, you are asked to create a new project or open an existing one.
If Lifecycle Manager does not start, you may need to change the default startup or shutdown port.
For more information, see "Unable to Start IBM Cognos Lifecycle Manager" (p. 44).
Note: Because Lifecycle Manager is a single-user application, there should be only one Web browser
session connected to the Lifecycle Manager server at a given time. Multiple browser sessions can
lead to loss of data.
❑ Enabling the test case archive function for IBM Cognos Business Intelligence environments
Perform this task only if the environment is ReportNet or IBM Cognos 8. If you are working with
IBM Cognos BI 10.1.0, you specify a static date/time value when configuring your project (p. 20).
In validation projects, the date/time value specified must be the same for both the source and target
environment.
<value type="long">1060180744</value>
</structure>
You can specify a different date/time value to appear in reports by changing the value of the
<value> element. The data type of the <value> element is time_t, at Coordinated Universal
Time (UTC).
Note: The date/time value is converted at run time, and the time component of the value is time
zone sensitive. For example, someone in the Pacific Standard Time Zone (PST) that runs a
report will see a time value that is different than someone running the report in the Eastern
Standard Time Zone (EST). As a result, you may need to offset the time component of the value
by a number of hours to compensate for different time zones. You can go to an epoch converter
Web site to quickly convert a date/time value to a time_t value.
Steps for the Source and Target Environments Running IBM Cognos BI
1. Stop the IBM Cognos service.
You can specify a different date/time value to appear in reports by changing the value of the
<value> element. The data type of the <value> element is time_t, at Coordinated Universal
Time (UTC).
Note: The date/time value is converted at run time, and the time component of the value is time
zone sensitive. For example, someone in the Pacific Standard Time Zone (PST) that runs a
report will see a time value that is different than someone running the report in the Eastern
Standard Time Zone (EST). As a result, you may need to offset the time component of the value
by a number of hours to compensate for different time zones. You can go to an epoch converter
Web site to quickly convert a date/time value to a time_t value.
Keep the file open to perform the next task.
When you execute a report, any date/time functions that appear in the report, such as AsOfDate()
and AsOfTime(), have the value specified in the StaticDateTimeOutput property.
User Guide 17
Chapter 3: IBM Cognos Lifecycle Manager
Steps
1. If you closed the rsvpproperties.xml.sample file after specifying a static date/time value for
executed reports, reopen it.
4. For the line <value type="long">0</value>-->, change the value 0 to 2 and delete -->.
7. Open reportservice.xml.
● Configure a project
● Archive a project
Create a Project
You can create two types of projects in IBM® Cognos® Lifecycle Manager:
● Validation project
Create a validation project when you are upgrading to a new version of IBM Cognos Business
Intelligence and you want to compare reports from the old (source) environment to the new
(target) environment.
● Benchmark project
Create a benchmark project to benchmark an environment and compare reports that are executed
at different times in that environment.
Tip: You can use benchmark projects for other purposes. For example, create a benchmark
project to compare reports following the installation of an IBM Cognos BI refresh pack or a
database upgrade, or to compare reports executed with the dynamic query mode disabled
against reports executed with the dynamic query mode enabled (p. 20).
You can also import the contents of an archived project into a new project (p. 25).
Steps
1. From the Projects menu, click New Project.
● If you want to create a blank project, click the Create blank project radio button.
● If you want to create a new project using the same configuration settings as an existing
project, click the Create project using existing configuration radio button and then select
a project from the list of existing projects.
● If you want to create a new project based on an existing project, click the Create project
from a copy of an existing project radio button and then select a project from the list of
existing projects.
3. In the New Project Name box, type the name of the project.
Project names cannot exceed 100 characters or contain certain characters. For more information,
see "Name of Project or Archive Returns an Error" (p. 45).
4. Click the Project Type drop-down list and select the type of project that you want to create.
The name of the project appears in the top left corner. If you create a blank project or a project
using the same configuration settings of an existing project, you are asked to configure the project
and generate the report list. If you create a project based on an existing project, a copy of the
existing project is opened. The original project remains unchanged.
User Guide 19
Chapter 3: IBM Cognos Lifecycle Manager
Open a Project
To open an existing project, do the following:
Step
● From the Projects menu, click Open Project and then click the project that you want to open.
Tip: If you open an archived project, you cannot modify it. Archived projects are identified by
the keyword (Archive) following the project name.
Configure a Project
When you create a project, you must configure it to work with your IBM® Cognos® environment.
If your system gateways and dispatchers use the Secure Sockets Layer (SSL) protocol, you must
configure IBM Cognos Lifecycle Manager for SSL before Lifecycle Manager can connect to the
systems (p. 23).
Before you configure a project, ensure that your IBM Cognos servers are running.
Steps
1. From the Settings menu, click Configure.
2. On the Basic tab, specify information about your source and if applicable, the target environ-
ment.
If IBM Cognos Application Firewall (CAF) is running in the target environment, ensure that
the value in the Dispatcher URI box for the target environment does not include /ext.
Click the Version drop-down box and click the IBM Cognos Business Intelligence version that
you are working with.
To improve performance, in the Max connections box, type the maximum number of connections
that Lifecycle Manager can use to connect to the source and target environments when perform-
ing tasks such as validating reports.
If the environment you are working in is IBM Cognos BI 10.1.0, in the Static DateTime Output
box, specify the date/time value that you want Lifecycle Manager to show on executed reports
if you do not want to use the default value.
Note: The data type of the date/time value is time_t, at Coordinated Universal Time (UTC).
The date/time value is converted at run time, and the time component of the value is time zone
sensitive. For example, someone in the Pacific Standard Time Zone (PST) that runs a report
will see a time value that is different than someone running the report in the Eastern Standard
Time Zone (EST). As a result, you may need to offset the time component of the value by a
number of hours to compensate for different time zones. You can go to an epoch converter
Web site to quickly convert a date/time value to a time_t value.
In a validation project, the date/time value you specify must be the same for both the source
and target environment. For information about setting the date/time value for environments
before version 10.1.0, see "Specify a Static Date/Time Value in Executed Reports" (p. 16).
Tip: For validation projects, the icons for the Source URL and Target URL links
at the bottom left of Lifecycle Manager indicate whether the tool is connected to the source
and target environments respectively. For benchmark projects, the IBM Cognos URL link
indicates whether the tool is connected to the environment that you want to benchmark.
3. On the Security tab, specify user information so that Lifecycle Manager can access your
ReportNet® or IBM Cognos BI environments.
Lifecycle Manager does not support single signon (SSO). You must specify authentication
information manually when configuring a project even if your environment uses SSO for IBM
Cognos source and target reports.
Lifecycle Manager uses security information specified on this tab to access the source and target
environments regardless of who is using the tool. If you want users to run Lifecycle Manager
using their own security information, do not enter information here. Users can use their own
security information when running Lifecycle Manager by specifying session credentials.
If you are using a custom Java™ authentication provider in the source or target environment,
click the Add parameters link for the environment and add the required values.
Security information specified here as well as report outputs, debug data, report specifications,
and logs are stored in the Lifecycle_Manager_install_location\data folder. This information is
not secured. You must follow your organization's security policies regarding the security of
this information. For example, this can consist of folder encryption or folder user permissions
that limit access to potentially sensitive data.
Tip: You can find the namespace ID in IBM Cognos Configuration by accessing the property
sheet of the Authentication namespace being used for Lifecycle Manager.
● In the Items per page box, specify the number of items that you want to see in each Lifecycle
Manager page.
● To hide objects for which the status was set to Out of Scope (p. 26), clear the Display Out
of Scope entries check box.
● If you do not want to see a data-sensitive warning message every time you create a test case
archive (p. 32), clear the Always show data sensitive warnings check box.
● If you do not want to see Flash®-based content in the user interface, clear the Use Flash
tools check box.
Flash-based content includes a task summary page with a different layout and additional
summary information and a more interactive output compare tool.
● If you do not want to see folders that have no children in the user interface, select the
Suppress folder(s) with no children check box.
● In the Validation level field, choose the validation level that you want Lifecycle Manager
to use to determine whether a report is valid.
When set to Warning, any warnings found during validation make the report invalid. When
set to Error, any errors found during validation make the report invalid.
User Guide 21
Chapter 3: IBM Cognos Lifecycle Manager
Note: A report that is invalid may still run and produce output for output comparison. For
example, a ReportNet feature that is not supported in IBM Cognos BI may produce a
warning during validation, but the report can still run.
● In the Action Timeout (s) box, specify the maximum amount of time in seconds that you
want Lifecycle Manager to spend performing a task such as validating or executing a report.
If the maximum time is exceeded, Lifecycle Manager moves to the next report.
● In the Wait time (s) box, specify the maximum amount of time in seconds that you want
Lifecycle Manager to wait after shutting down the source or target system's report service.
For systems running IBM Cognos BI, the report service is shut down when Lifecycle Manager
creates a test case archive (p. 32).
● If you do not want to include the output for reports when creating a test case archive
(p. 32), clear the Include report output in archive check box.
● To improve performance when comparing output (p. 39) of large reports, in the Compare
options section, specify the number of pages at the beginning and at the end of reports that
you want Lifecycle Manager to compare.
For example, if you specify 10 in the Beginning pages and End pages boxes, Lifecycle
Manager will compare only the first and last 10 pages of reports.
Note: Doing a full comparison of large reports can impact the performance of your
ReportNet and IBM Cognos BI servers as well as Lifecycle Manager.
Tip: You can also specify this information at the report level. To do this, click a report to access
its properties and then click the Preferences tab.
● In the Format Options section, select the formats in which you want to execute and compare
reports.
If you want to apply your selection to all children objects, click Yes for the option Override
format changes to children. This saves you time when children objects are set to execute
in different formats.
Click the Default Format drop-down list and click the output format that you want to
appear for the report execution time in the Task Summary page (p. 37).
● In the Dynamic Query mode Options section, choose whether to enable the dynamic query
mode (DQM) when executing reports in the source and target environments in a validation
project or in each run in a benchmark project. The option you select is applied to all
packages in the project. Note that you can enable the dynamic query mode only for IBM
Cognos BI 10.1.0 environments.
If you choose Default, Lifecycle Manager uses the setting that was specified for each
package.
If you want to apply your selection to all children objects, click Yes for the option Override
Query mode changes to children. This saves you time when children objects are set to
execute in a different query mode.
Note: You can execute reports in the dynamic query mode only for Oracle Essbase and
SAP BW data sources. For more information about the dynamic query mode, see the IBM
Cognos Business Intelligence Dynamic Query Guide.
● In the Language Options section, select the languages in which you want to execute and
compare reports.
If you want to apply your selection to all children objects, click Yes for the option Override
Language changes to children. This saves you time when children objects are set to execute
in different languages.
Click the Default Language drop-down list and click the output language that you want
to appear for the report execution time in the Task Summary page (p. 37).
Step
● Import the server certificates of the Web server and application server into the trust store of
the IBM JRE™ used by Lifecycle Manager.
With this change, Lifecycle Manager will accept all SSL Certificates as valid and be able to connect
to Reportnet and IBM Cognos Business Intelligence gateways and dispatchers running SSL. However,
for a more secure environment, your administrator may want to import the required SSL certificates
from the gateway and dispatcher of all source and target systems that he wishes to configure into
the Lifecycle Manager JRE. Using this approach, your administrator can ensure that only valid
certificates are used.
Steps
1. From the Settings menu, click Credentials and then click one of the following options:
● In a validation project, to specify credentials for the source environment, click Source.
● In a validation project, to specify credentials for the target environment, click Target.
2. In the Credentials dialog box, type your user name, password, and namespace ID.
3. If you are using a custom Java™ authentication provider in your environment, click the Add
parameters link and add the required values.
User Guide 23
Chapter 3: IBM Cognos Lifecycle Manager
4. If you want to use the same credentials for the source and target environments in a validation
project, select the Use these credentials for source and target check box.
5. If you want to use the same credentials for the entire Lifecycle Manager session, select the Save
and share through configuration file check box.
If this check box is not selected, Lifecycle Manager prompts you to enter credentials every time
it has to connect to the source or target environment.
Steps
1. Click Generate Report List.
2. Select the content that you want to include in the report list.
Tip: If your source environment contains many packages, folders, and reports, we recommend
that you select a subset of these to split the work into smaller pieces.
The content that you selected appears in the project. You can click a package to see the model,
folders, and reports that are defined in a particular package.
Tip: After you have generated the report list, a section named General information appears on the
Basic tab of the Configure dialog box. When you click the Search paths button, you will see the
content that you selected for the project. If you selected a subset of your content for the project,
this is useful to show you what content needs to be selected in subsequent projects.
Archive a Project
Archive a project to preserve changes that you made. For example, if you specified prompt values
in reports that have required prompts, archiving the project ensures that you do not have to reenter
those values.
Steps
1. From the Projects menu, click Create Archive.
3. If you do not want to preserve the original project when archiving it, clear the Preserve Existing
Project check box.
The project is archived and you can no longer modify it. However, you can create a copy of an
archived project (p. 19).
Steps
1. Create a new project (p. 19).
2. Click Configure.
● Click the Project drop-down list and select the archived project from which you want to
import content.
● Click the Instance drop-down list and select to import either the source or the target envi-
ronment content.
If you are importing content from an archived benchmark project, Run1 is considered the
source environment and Run2 is considered the target environment.
Views
You can view objects in IBM® Cognos® Lifecycle Manager in three different ways. Note that Life-
cycle Manager works only with Public Folders content.
List View
The List View shows all objects in a flat list.
Tree View
The Tree View shows all objects in the same structure as they appear in IBM Cognos Connection.
Package View
The Package View shows reports organized by the packages to which they are associated. Since
reports can be organized in different folders in IBM Cognos Connection, this view allows you to
easily see the status of all reports associated to a particular package. The Package View also shows
reports that are associated to a package but are not in the current project.
User Guide 25
Chapter 3: IBM Cognos Lifecycle Manager
Note: This view is not available for projects created in previous versions of Lifecycle Manager.
Columns
The IBM® Cognos® Lifecycle Manager interface has the following columns.
Priority Flag
You set the priority flag for each object by clicking the Priority column for the object. The
priority flag indicates only the importance of the object to users. It has no effect on any Lifecycle
Manager functions.
Status
The Status column indicates the current status of each object. You can manually change the status
of an object by clicking its Status column and choosing a different value. For example, if you do
not want to validate or execute a particular object, change its status to Out of Scope.
The following table describes the possible status values for an object.
Status Description
Partial Success Indicates that the execution or output comparison operation was partially
successful. For example, you compare reports in XML and PDF formats
and the XML reports are identical but there are differences in the PDF
output.
Prompt Values Miss- Indicates that some reports in the package or folder require prompts, and
ing no prompt values are defined.
If a report has required prompts, you must provide a prompt value for each
one before you can execute the report.
Out of Scope Informs Lifecycle Manager to ignore this object during the validation, exe-
cution, or output comparison operation.
When this value is specified, you can apply it to all of the object's children
by selecting the Apply to all actions (target and source) check box.
Status Description
In Scope If an object's status is Out of Scope, puts the object back in scope.
When this value is specified, you can apply it to all of the object's children
by selecting the Apply to all actions (target and source) check box.
Fail Following validation, execution, or output compare, indicates that the object
failed the operation.
DQM enabled?
The DQM enabled? column indicates whether the dynamic query mode is enabled for each object.
Progress
The Progress column indicates what operations were performed successfully. A bullet
exists for each of the five operations that you can perform on a report. The color of each button
indicates whether the operation was performed successfully or not.
Tip: Pause the pointer over the bullets to see a tooltip indicating the status of each operation.
Notes
You can add notes to each object by clicking the Note column for the object. This is useful if
you want to add a comment for a particular action that you took, such as setting the status of an
object to Out of Scope.
Options
The Options column shows what actions you can take for an object. The actions that are available
depend on the task that you are performing. For example, if you are validating reports, the available
options include validate report and edit prompt values.
User Guide 27
Chapter 3: IBM Cognos Lifecycle Manager
Lock Status
The lock status indicates whether an object is locked or not locked. An object becomes locked
after the validation or execution operation is successful. If you want to revalidate or re-execute an
object, you must first unlock it.
When an object is locked, it is ignored when you validate or execute reports. This saves you time
when you need to revalidate or re-execute a group of reports.
Before IBM® Cognos® Lifecycle Manager can compare reports in a validation or benchmark project,
the reports must be validated and executed.
Validating and executing reports involves the following tasks:
❑ Add prompt values
❑ Execute reports
● The query that contains the display query item referenced by the prompt control is executed,
and the first value returned is used.
● The query that contains the model query item or the use value query item referenced by the
prompt control is executed, and the first value returned is used.
For multiple value prompts, only the first five values returned when a query is executed are used.
Lifecycle Manager is unable to generate prompt values if the query item referenced by a prompt is
a complex expression such as QueryItem1=extract(year, [DateTime]). Such expressions can
include more than one query item, and Lifecycle Manager can only execute simple queries against
a database field to retrieve a value. In such situations, you must manually add prompt values or
save values in IBM Cognos Connection or in the report prior to generating the list of reports from
your source environment.
2. Click the drop-down menu at the bottom of Lifecycle Manager and click Automatic Prompt
Values Generation.
3. Click Go.
Tip: If you do not want to use the values that Lifecycle Manager automatically adds, you can
manually replace them.
3. Click the Prompt Values tab and then click Manual Prompt Capture.
4. Choose the values that you want and click the Finish button.
Steps
1. If you are working in a validation project, in the Upgrade Tasks pane, click Source Validation
to validate content in your source environment or Target Validation to validate content in your
target environment.
2. If you working in a benchmark project, in the Benchmark Tasks pane, click Run1 Validate to
validate content in Run1 or Run2 Validate to validate content in Run2.
Run2 Validate appears only when you have set the baseline for a benchmark project. For more
information, see "Set the Baseline for a Benchmark Project" (p. 32).
3. If you want to validate a specific object, in the work area, click the validate button beside
the object that you want to validate.
You may need to navigate to the object first. For example, to validate a specific report, you
may need to open the folder in which the report is located. If you validate the folder, Lifecycle
Manager validates all reports contained in the folder.
● Ensure that Validate models/reports appears in the drop-down list at the bottom of Lifecycle
Manager.
● Click Go.
The Status column indicates whether an object is valid. If an object is invalid, click the object's view
properties button to view validation warnings and errors. You can use this information to fix
the object. In addition, you can click the search icon to the right of each validation message to view
Technotes, on IBM Support Web pages, written for the message. If there are no problems with the
object and the object is invalid because of an issue in IBM Cognos Business Intelligence, you can
create a test case archive to help the Cognos Customer Center resolve the issue.
Note: A report that is invalid may still run and produce output for output comparison. For example,
a ReportNet feature that is not supported in IBM Cognos BI may produce a warning during valida-
tion, but the report can still run.
Execute Reports
Execute your reports so that IBM® Cognos® Lifecycle Manager can compare their output. When
executing reports, Lifecycle Manager verifies whether report specifications are semantically correct.
If some of your reports contain required prompts, you must first add prompt values to these reports.
Steps
1. If you are working in a validation project, in the Upgrade Tasks pane, click Source Execute to
execute content in your source environment or Target Execute to execute content in your target
environment.
2. If you working in a benchmark project, in the Benchmark Tasks pane, click Run1 Execute to
execute content in Run1 or Run2 Execute to execute content in Run2.
Run2 Execute appears only when you have set the baseline for a benchmark project. For more
information, see "Set the Baseline for a Benchmark Project" (p. 32).
3. If you want to execute a specific report, in the work area, click the execute (source) button
beside the report that you want to execute.
User Guide 31
Chapter 4: Validating and Executing Reports
You may need to navigate to the report first. For example, you may need to open the folder in
which the report is located. If you execute the folder itself, Lifecycle Manager executes all
reports contained in the folder.
Tip: If you configured the project to override format and language choices for children objects
(p. 20), you can choose to execute a report in different formats or languages. Click the report
to view its properties and on the Preferences tab, select the formats and languages that you
want.
● Ensure that Execute reports appears in the drop-down list at the bottom of Lifecycle
Manager.
● Click Go.
The Status column indicates whether a report executed successfully. If a report did not execute
successfully, click the report's view properties button to view the execution results. You can
use this information to determine why the report did not execute successfully. If there are no
problems with the report and the report did not execute successfully because of an issue in IBM®
Cognos® Business Intelligence, you can create a test case archive to help the Cognos Customer
Center resolve the issue.
The validation and execution status of all models and reports must be marked Completed before
a run can be set as the master.
Step
● From the Master menu, click Run1.
Run1 is set as the master and Run2 is created. Because Run1 is set as the master, it is locked and
you can no longer validate or execute reports.
Tip: After validating and executing models and reports for Run2, you can make Run2 the benchmark
instead of Run1.
By default, PDF output of the report is included in the archive. You can configure IBM® Cognos®
Lifecycle Manager to exclude PDF output when creating test case archives (p. 20). You can include
only English PDF output in test case archives.
If you have a model that is invalid, you can save the source and target model specifications and
provide them to the Cognos Customer Center (p. 35).
Before you can create a test case, you must enable the test case archive function in the source and
target environments (p. 18).
Steps
1. Navigate to the report for which you want to create a test case archive.
3. In the Test Case Archive Info section, click Create Test Case Archive.
4. If the Sensitive Data Warning dialog box (p. 20) appears, click OK to continue.
5. Click Download Archive and save the zip file that is generated.
If the test case archive was fully completed, the message Test Case Archive is Complete appears.
The message Test Case Archive is Incomplete appears if the test case was only partially completed.
You can click the Details button to see what was not completed, and you may be able to troubleshoot
the problem (p. 46) and regenerate the archive.
Send the test case archive to the Cognos Customer Center for analysis. In addition, you can use the
archive to extract additional information from target reports.
● reportInfo.xml
This file contains Lifecycle Manager diagnostic information about the report that the Cognos
Customer Center uses to troubleshoot problems.
Source Folder
The source folder contains the following files. Some files are located in subfolders.
User Guide 33
Chapter 4: Validating and Executing Reports
File Description
c10ServerArchive.zip Zip file containing various files generated during the execution or
validation of the report. These files are located in various subfold-
Note: This file is produced
ers and include the following:
only for IBM Cognos BI
source reports. ● run-time models
Target Folder
The target folder contains the following files. Some files are located in subfolders.
File Description
File Description
c10ServerArchive.zip Zip file containing various files generated during the execution or
validation of the report. These files are located in various subfold-
ers and include the following:
● run-time models
● all standard IBM Cognos BI log files as well as log files for
various IBM Cognos BI components and, where applicable,
SAP BW, DB2®, and Microsoft® Analysis Services (MSAS)
data sources
Steps
1. Click the model to view its properties page.
● In a validation project, to save the source model specification, click Download Source
Model Spec.
● In a validation project, to save the target model specification, click Download Target Model
Spec.
User Guide 35
Chapter 4: Validating and Executing Reports
Before you can extract all information from a report, you must create a test case archive for the
report.
Steps
1. Open the archive.
Tip: You can also generate the uda_trace.log file for ReportNet reports.
readudatrace uda_trace.log name of output file name of script file used to generate final out-
put.xml database password
For example, readudatrace uda_trace.log output.log extract.xml GOSALES
The final output file with a name such as extract.out.xml is generated, which the Cognos Customer
Center can use to load data into a database.
TRACE_FILE
crn_location\logs\uda.log
6. Click OK.
9. Execute the reports for which you want to generate a data trace log file.
The file uda.log is generated in the crn_location\logs directory. Send this file along with the
corresponding test case archive (p. 32) to IBM Cognos Support.
11. Delete the two environment variables and restart the ReportNet service.
Note: If you do not delete the environment variables after you are done, ReportNet performance
may be reduced.
TRACE_FILE crn_location\uda.log
TRACE_LAYER_DMD_DQLAPIRW 0x002
You can create the two variables by typing the following command in your shell prompt:
3. Execute the reports for which you want to generate a data trace log file.
The file uda.log is generated in the crn_location\logs directory. Send this file along with the
corresponding test case archive files (p. 32) to the Cognos Customer Center.
5. Delete the two environment variables and restart the ReportNet service.
You can delete the two variables by typing the following command in your shell prompt:
Note: If you do not delete the environment variables after you are done, ReportNet performance
may be reduced.
User Guide 37
Chapter 4: Validating and Executing Reports
the summary depends on the default format and language that you selected when you configured
the project (p. 20).
Tip: The ability to view report execution times in the summary results page allows you to quickly
compare the execution times of source and target reports.
Two different views of the results are available: a Flash®-based enhanced summary and an HTML
version. To see an enhanced results summary with more detailed information, configure IBM®
Cognos® Lifecycle Manager to allow Flash-based content (p. 20). Otherwise, you will see the HTML
version of the results.
Step
● In the left pane, under Dashboards, click Task Summary.
In either view, you can export the task summary page. In the Flash-based view, the exported file is
in .swf format which you can open in a Web browser with Adobe® Flash Player 9.0 or higher. You
can also print the task summary page. In the non-Flash view, the resulting HTML file is specific to
each tab in the task summary page.
Tip: To view the Flash file, you may need to allow blocked content.
After you have validated and executed your reports, you can compare their output to check for
differences. If differences are found, you can decide whether to accept them or reject them and have
the Cognos Customer Center investigate.
Comparing reports involves the following tasks:
❑ Compare the output
Compare Output
Compare the output between source and target reports in a validation project or between different
runs in a benchmark project to check for differences in data and layout.
Some differences may not be due to an upgrade problem (p. 40).
Two output compare tools are available. To use the advanced output compare tool that has more
interactive features, you must configure IBM® Cognos® Lifecycle Manager to allow Flash®-based
content (p. 20).
Steps
1. In the left pane, click Output Compare.
2. If you want to compare the output for a specific report, in the work area, click the compare
source and target for this entry button beside the report that you want.
You may need to navigate to the report first. For example, you may need to open the folder in
which the report is located. If you do a comparison on the folder itself, Lifecycle Manager will
do a comparison on all reports contained in the folder.
● Ensure that Compare reports appears in the drop-down list at the bottom of Lifecycle
Manager.
● Click Go.
After Lifecycle Manager completes the output comparison, the Status column indicates whether
differences were detected.
The Status tab shows the results of the output comparison. The results you see depend on the
output format and language options selected when you configured the project (p. 20).
● click Launch PDF Output Compare Tool to compare the output using Adobe Acrobat.
● click Launch Flash Output Compare Tool to compare the output using the Flash® compare
tool.
The Flash output compare tool provides interactive features to help you compare the reports.
Tip: If you are using the Flash output compare tool, you can quickly see layout differences by
clicking the single overlay view button . You can then use the target transparency slider
to adjust the gradient of the transparency on the target report, which is overlaid on the source
report. This helps you detect subtle differences in the layout such as letterhead positioning and
chart formatting.
8. To do a data comparison in when comparing PDF output, click the Text view button.
Differences between the two reports are highlighted. Use the arrow buttons to navigate through
the differences found.
The status for the report changes to Approved, and you are prompted to add a note (p. 27) to
document your decision.
10. If you do not want to accept the changes detected, click Reject.
The status for the report changes to Rejected, and you are prompted to add a note (p. 27) to
document your decision.
Tip: If you reject a comparison, in the Test Case Archive section, click the Create Test Case
Archive link to create a test case archive (p. 32) so that the Cognos Customer Center can
investigate the changes.
Tip: The design of reports, IBM Cognos Framework Manager models, and cubes can cause round-
off errors. To minimize the effect, follow the guidelines found in the section Unexplained Discrep-
ancies in Number Calculations in the IBM Cognos Administration and Security Guide.
Step
● In the left pane, under Dashboards, click Task Summary.
In either view, you can export the task summary page. In the Flash-based view, the exported file is
in .swf format which you can open in a Web browser with Adobe® Flash Player 9.0 or higher. You
can also print the task summary page. In the non-Flash view, the resulting HTML file is specific to
each tab in the task summary page.
Tip: To view the Flash file, you may need to allow blocked content.
User Guide 41
Chapter 5: Comparing Reports
Steps
1. Click the package view button.
2. For each package for which you want to enable the dynamic query mode, in the Options column,
click DQM.
DQM is bolded in IBM Cognos Lifecycle Manager to indicate that the dynamic query mode was
enabled for the package in IBM Cognos BI.
Use this troubleshooting reference to help you solve specific problems you may encounter during
or after installation of IBM® Cognos® Lifecycle Manager or when using Lifecycle Manager.
Problems are characterized by their symptoms. You can trace each symptom to one or more causes
by using specific troubleshooting tools and techniques. After identifying each problem, you can fix
them by implementing a series of actions.
When you are troubleshooting, log files can help you. Another valuable troubleshooting tool are
IBM Technotes, which are available on the IBM support pages.
When you cannot resolve a problem, the final resource is your technical support representative. To
analyze a problem, your technical support representative requires information about the situation
and the symptoms that you are experiencing. To help isolate the problem, collect the necessary data
before you contact your representative.
Log Files
Log files can help you troubleshoot problems by recording the activities that occur when you work
with a product. Operations performed by IBM® Cognos® Lifecycle Manager are recorded in various
log files for tracking purposes. For example, if you experienced problems installing Lifecycle Man-
ager, consult the transfer log file to learn what activities the installation wizard performed while
transferring files.
● warnings
● information
● debug messages
By default, the logging level is set to debug, the highest level of logging available. We recommend
that you do not change the logging level. However, the following files in the install_location\webapps\
WEB-INF\configuration folder allow you to change the logging level:
● log4j.um.server.error.xml
● log4j.um.server.warn.xml
● log4j.um.server.info.xml
● log4j.um.server.debug.xml
To change the logging level, rename the appropriate file to log4j.um.server.xml. For example, if
you want to set the logging level to warning, rename the log4j.um.server.warn.xml file.
Lifecycle Manager may not be able to connect to the source or target servers because they are cur-
rently offline, or you have not provided the correct configuration information. Verify that the fol-
lowing information for both environments is accurate:
● Gateway URI
● Dispatcher URI
● Version
In addition, ensure that the user information required to connect to both environments is correct.
In particular, for the Namespace ID field, ensure that you have specified the Namespace ID and
not the namespace name.
For more information, see "Configure a Project" (p. 20).
User Guide 45
Appendix A: Troubleshooting
● Verify that the data sources the target report uses are available.
● Open the target report in the studio in which it was created and execute it to see if the report
displays prompts. If prompts appear, choose values and verify that the correct data is returned.
If none of the above solutions resolve the problem, the target report may not have upgraded properly.
Create a test case archive (p. 32) and send it to the Cognos Customer Center.
● The report contains objects that are referenced by another report, and the first report has
prompt pages with parameters that are not referenced in the report pages.
● The report is still under development and there are prompt pages with associated parameters
that are not referenced in a report page.
To resolve the problem, ensure that the parameters used by the missing prompts are referenced in
a report page.
When using Lifecycle Manager, no other users should access the source and target systems.
After performing the above tests, recreate the test case archive.
Tip: You can also send the incomplete test case archive to the Cognos Customer Center for analysis.
Note: If you are working in a validation project, save the report and model specifications from both
the source and target environment.
Steps
1. In IBM Cognos Report Studio, from the File menu, click Report Properties.
User Guide 47
Appendix A: Troubleshooting
If you want to change the status of a report that is in an archive, create a copy of the archive and
make the changes that you want in the copy.
● From the Start menu, click the program folder you specified during the installation, and
click Lifecycle Manager Shutdown.
The file contains three lines for memory configuration. Each line is preceded by a comment in
the form rem "for machines with x GB RAM". By default, Lifecycle Manager uses the
memory configuration for machines with 1 GB of RAM.
3. Add rem to the beginning of the memory configuration line for machines with 1 GB of RAM.
4. Depending on how much RAM your computer has, remove rem from the memory configuration
line for machines with 2 GB of RAM or 3 GB of RAM.
User Guide 49
Appendix A: Troubleshooting
F N
Flash tools, 20 namespace ID, 20
namespaces
G specifying, 20
generating notes, 27
list of reports, 24
O
I opening
importing projects, 20
archived project, 25 OutOfMemoryError message, 48
incomplete test case archives, 46 output
installing comparing, 39
Lifecycle Manager, 15
items per page P
setting, 20 package view, 25
PDF output results
J viewing, 41
java.lang.OutOfMemoryError, 48 preparing
source environment, 16
L target environment, 16
Lifecycle Manager priority flag, 26
configuring, 20 Progress column, 27
how it works, 11 project names
installing, 15 not valid, 45
starting, 15 projects
supported environments, 12 archiving, 24
target environment URIs, 20 benchmark, 19
unable to start, 44 creating, 19
views, 25 importing, 25
line breaking rules opening, 20
changes that affect output comparison, 41 validation, 19
list view, 25 prompts
lock status, 28 not appearing in Lifecycle Manager, 46
log files prompt values
descripton, 43 adding, 29
installation log file, 43 generated values do not work when working with
Lifecycle Manager log file, 44 dimensional data sources, 46
problems adding manually, 45
M purpose of document, 5
manually adding prompt values
troubleshooting, 45
R fail, 26
ReportNet in progress, 26
generating list of reports, 24 in scope, 26
ReportNet reports invalid, 26
formatting changes when upgrading, 47 new, 26
generating uda_trace.log file, 36 out of scope, 26
reports prompt values missing, 26
choosing query mode, 20 rejected, 26
comparing output, 39 succeeded, 26
executing, 31 valid, 26
extracting information to fix problems, 35
prompts not appearing in Lifecycle Manager, 46 T
specifying static date/time value, 16 target environment
validating, 30 preparing, 16
running upgraded reports supported, 12
PDF output looks different, 47 unable to connect, 45
URIs, 20
S test case archives
search path, 24 contents, 33
security creating, 32
setting for an Lifecycle Manager session, 23 enabling, 18
security settings, 20 incomplete, 46
sensitive data warning dialog box, 32 setting wait time, 20
session credentials unable to create, 47
specifying, 23 See Also extracting information from reports
showing out of scope entries, 20 tree view, 25
shutdown port troubleshooting
changing, 44 archive names, 45
source environment data differences when comparing reports, 41
preparing, 16 generated prompt values do not work, 46
supported, 12 java.lang.OutOfMemoryError message, 48
unable to connect, 45 log files, 43
URIs, 20 OutOfMemoryError message, 48
SSO, 16 PDF output looks different when running upgraded
starting reports, 47
Lifecycle Manager, 15 project names, 45
manual prompt capture, 29 prompts do not appear in Lifecycle Manager, 46
startup port test case archives, 46
changing, 44 unable to change status of report during output
startup-um.bat, 48 compare, 47
static date/time value unable to connect to source or target environ-
specifying in executed reports, 16 ment, 45
status unable to create test case archives, 47
approved, 26 unable to manually add prompt values, 45
completed, 26 unable to start Lifecycle Manager, 44
differences, 26
User Guide 53
Index
U
uda_trace.log, 35, 36
unable to connect to source or target environment, 45
upgrading reports
formatting not retained, 47
URIs
source environment, 20
target environment, 20
V
validating models and reports, 30
validation levels, 20
validation projects, 19
validation results
viewing, 37
viewing
data comparison results, 41
execution results, 37
PDF output results, 41
validation results, 37