IBM Cognos 8

Software Development Kit

Version 8.4.1

Installation and Configuration Guide

Product Information
This document applies to IBM Cognos 8 Version 8.4.1 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. 2005, 2009.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
IBM, the IBM logo, ibm.com, 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.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Table of Contents

Introduction 5

Installing and Configuring the SDK 7

Upgrading the SDK Software 7
Install the SDK 8
Configuring the SDK 10
Uninstall the SDK 11

Index 13

Licensed Materials – Property of IBM

© Copyright IBM Corp. 2005, 2009. 3
Table of Contents

4 Software Development Kit

Introduction

This document is intended for use with IBM Cognos 8 software development kit (SDK). The SDK
is a collection of cross-platform Web services, libraries, programming interfaces, and related APIs
that you can use to access the full functionality of IBM Cognos 8. For more information, see the
SDK Developer Guide.
The IBM Cognos 8 software development kit includes the IBM Cognos 8 Mashup Service, which
allows you to develop applications that expose IBM Cognos 8 outputs, such as reports and analyses,
as Web services (both SOAP and REST). You can also use the Mashup Service to create applications
that use a structured view of IBM Cognos 8 outputs as input.
This document provides instructions for installing the SDK package from the IBM Cognos 8 Software
Development Kit CD.

Audience
To use this guide, you should have basic Windows, UNIX, and Linux administration skills.

Related Documentation
Our documentation includes user guides, getting started guides, new features guides, readmes, and
other materials to meet the needs of our varied audience. The following documents contain related
information and may be referred to in this document.

Note: For online users of this document, a Web page such as The page cannot be found may appear
when clicking individual links in the following table. Documents are made available for your par-
ticular installation and translation configuration. If a link is unavailable, you can access the document
on the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).

Document Description

IBM Cognos 8 Installation and Configuration Installing, upgrading, configuring, and testing
Guide IBM Cognos 8, changing application servers,
and setting up samples

IBM Cognos 8 Software Development Kit
Developer Guide
Managing IBM Cognos 8 processes and imple-
menting custom reporting solutions by using a
collection of cross-platform Web services, librar-
ies, and programming interfaces provided with
the IBM Cognos 8 SDK

IBM Cognos 8 Administration and Security Managing servers, security, reports, and portal
Guide services; and setting up the samples, customizing
the user interface and troubleshooting

Licensed Materials – Property of IBM

© Copyright IBM Corp. 2005, 2009. 5
Introduction

Document Description

IBM Cognos 8 Mashup Service Developer Guide Developing applications with the IBM Cognos
8 Mashup Service that exposes IBM Cognos 8
BI outputs, such as reports and analyses, as Web
services (both SOAP and REST).

Finding Information
Product documentation is available in online help from the Help menu or button in IBM Cognos
products.
To find the most current product documentation, including all localized documentation and
knowledge base materials, access the IBM Cognos Resource Center (http://www.ibm.com/software/
data/support/cognos_crc.html).
You can also read PDF versions of the product readme files and installation guides directly from
IBM Cognos product CDs.

Using Quick Tours

Quick tours are short online tutorials that illustrate key features in IBM Cognos product components.
To view a quick tour, start IBM Cognos Connection and click the Quick Tour link in the lower-
right corner of the Welcome page.

Getting Help
For more information about using this product or for technical assistance, visit the IBM Cognos
Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html). This site provides
information on support, professional services, and education.

Printing Copyright Material

You can print selected pages, a section, or the whole book. You are granted a non-exclusive, non-
transferable license to use, copy, and reproduce the copyright materials, in printed or electronic
format, solely for the purpose of operating, maintaining, and providing internal training on IBM
Cognos software.

6 Software Development Kit

Installing and Configuring the SDK

After you install and configure IBM Cognos 8, install and configure the IBM Cognos 8 software
development kit (SDK) to enable developers and system integrators to extend the value of the core
solution of IBM Cognos 8 capabilities. This is achieved with the integration of external applications
and environments and the development of custom unique capabilities.
The IBM Cognos 8 SDK CD contains
● the SDK software, including Web services, libraries, programming interfaces, and related APIs

● the SDK Developer Guide

● the Mashup Service Developer Guide

● the Framework Manager script player

● the Framework Manager modeling SDK

● SDK samples

● Mashup Service samples

You must use the same versions of the IBM Cognos 8 software development kit (SDK) and IBM
Cognos 8 and Framework Manager.
The process for installing the IBM Cognos 8 software development kit includes:
❑ Install the SDK (p. 8).

❑ Configure the SDK (p. 10).

Upgrading the SDK Software

When you upgrade from an older version of the IBM Cognos 8 Software Development Kit, ensure
that you upgrade to the same version of IBM Cognos 8 and Framework Manager.
If you have SDK applications that rely on a previous version of the report specifications, you cannot
use Framework Manager to publish your model without losing backward compatibility.
For more information about upgrading IBM Cognos 8 and Framework Manager, see the IBM
Cognos 8 Installation and Configuration Guide.
For information about changes that may affect the product during or after an upgrade, see the
release notes and upgrade sections of the IBM Cognos 8 Software Development Kit Installation
and Configuration Guide.
IBM Cognos 8 automatically upgrades the content store.
If you upgrade from ReportNet, you must make some changes to your SDK program for it to
function with the IBM Cognos 8 version of the WSDL file. Some methods, classes, and properties
have been deprecated in IBM Cognos 8. Deprecated features continue to function as before, but

Licensed Materials – Property of IBM

© Copyright IBM Corp. 2005, 2009. 7
Installing and Configuring the SDK

will be removed in future releases. Some other methods, classes, and properties are obsolete, and
have been removed from the IBM Cognos 8 SDK.
For information about changes to methods, classes, properties, and enumeration sets, see the Release
Notes appendixes in the IBM Cognos 8 SDK Developer Guide.
New report specifications have been added in IBM Cognos 8. If you run a report that was created
in ReportNet or in a previous version of IBM Cognos 8, it is automatically upgraded to the new
IBM Cognos 8 format. After a report is upgraded to the new format, it cannot be returned to the
ReportNet or older IBM Cognos 8 format. Because of the potential for users to upgrade report
specifications that SDK applications may depend on, we recommend that you set access permissions
on those reports to limit user access. For more information about setting access permissions, see
the IBM Cognos 8 Administration and Security Guide.
If you have SDK applications that create, modify, or save report specifications, do not upgrade your
report specifications when you install the new version of IBM Cognos 8. You must first update
your SDK applications to comply with the IBM Cognos 8 report specifications schema. Otherwise,
your SDK applications may not be able to access the upgraded report specifications. For information
about upgrading report specifications, see the IBM Cognos 8 SDK Developer Guide.
We recommend that you do not upgrade your report specifications if you are unsure about whether
you have SDK applications that create, modify, or save report specifications. Contact your SDK
administrator for more information about your SDK applications.

Install the SDK

Install the SDK files from the IBM Cognos 8 SDK CD on every computer where SDK applications
are developed, and in the same installation location as IBM Cognos 8.
The IBM Cognos 8 SDK and some IBM Cognos 8 server components are available for installation
on 64-bit systems. Before you install the IBM Cognos 8 SDK on a 64-bit system, check the Readme
for late-breaking information about where to install the components.
You can view an up-to-date list of environments supported by IBM Cognos products, such as
operating systems, patches, browsers, web servers, directory servers, and database servers on the
IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html). It is
important to note that the Linux operating system is available in a number of distributions and
supports a number of hardware platforms. Ensure that the Linux distribution and hardware com-
bination you are using is a supported combination.
It is important to apply all required operating system patches and to use only the versions of third-
party software that are supported for an IBM Cognos product. Otherwise, your product may not
work properly.
The IBM Cognos 8 SDK must be installed on a computer where IBM Cognos 8 is already installed.
For information about deploying SDK applications, see IBM Cognos 8 SDK Getting Started.
For more information about installing IBM Cognos 8 components, see the IBM Cognos 8 Installation
and Configuration Guide.
Before you install the IBM Cognos 8 SDK, ensure that IBM Cognos 8 BI components are installed.

8 Software Development Kit

 Installing and Configuring the SDK

If you plan to use the Excel plug-in demo, you must have MSINET.OCX installed in the System32
sub-folder of your Windows folder.

Steps for UNIX or Linux

1. Mount the IBM Cognos 8 product disk or go to the directory where the installation files were
downloaded and extracted.

Important: If you are installing on HP-UX, mount the IBM Cognos 8 SDK CD with Rock Ridge
file extensions and do the following:
● Add the pfs_mount directory in your path.
For example,

PATH=/usr/sbin/:$PATH

export PATH

● To start the required NFS daemons and run the daemons in the background, type

bg pfs_mountd and then type bg pfsd

● To mount the drive, type

pfs_mount -t rrip <device><mount_dir> -o xlat=unix

For example,

pfs_mount /dev/dsk/c0t2d0 /cdrom -o xlat=unix

You can now install or copy files as a non-root user using an IBM Cognos CD from this
drive.

● When the installation is complete, type pfs_umount /cdrom and kill the pfsd and pfs_mountd
daemons to unmount the CD.

2. Go to the directory that is appropriate for your operating system and start the installation:

● If you use X Windows, type ./issetup

● Otherwise, you must run an unattended installation. For more information, see the IBM
Cognos 8 Business Intelligence Installation and Configuration Guide.

3. In the Welcome page, select the language to use for the installation, and click Next.

4. Follow the instructions to copy the required files to the same location where you installed IBM
Cognos 8 components.

5. In the Finish page of the installation wizard:

● If you want to view the transfer log or the summary-error log, click the appropriate View
button.

● If you want to see the readme file, select the View the Readme check box.

Installation and Configuration Guide 9

Installing and Configuring the SDK

6. Click Finish.

Steps for Windows

1. Insert the IBM Cognos 8 product disk or go to the directory where the installation files were
downloaded and extracted.
The installation wizard starts automatically from the product disk.

2. If the Welcome page does not appear, go to the operating system directory and double-click
the issetup.exe file.

3. Select the language to use for the installation, and click Next.

4. Follow the instructions to copy the required files to the same location where you installed IBM
Cognos 8 components and Framework Manager.

5. In the Finish page of the installation wizard:

● If you want to view the transfer log or the summary-error log, click the appropriate View
button.

● If you want to see the readme file, select the View the Readme checkbox.

6. Click Finish.

You can access the SDK documentation using the shortcut in the Start menu.

Configuring the SDK

To use the SDK, you must perform some configuration and set-up tasks.
To configure the SDK, follow this process:
❑ If you want to run the Framework Manager script player from outside the bin directory, con-
figure the FM_INI_FILE_PATH environment variable as a system variable on Windows. The
environment variable must point to the cognos8_location\configuration\fm.ini directory.

❑ To allow the browsing or import of system objects such as tables, views, synonyms, stored
procedures, or functions from a relational database in Framework Manager, edit the entry for
ImportDatabaseSystemObjects in your fm.ini file.
By default, ImportDatabaseSystemObjects is set to FALSE. Users can see only the user tables
in the import and expression editor dialog boxes. To allow browsing or import of system
objects, set the preference to TRUE.

❑ Set up the samples for IBM Cognos 8 and Framework Manager.

For more information, see the Installation and Configuration Guide.

❑ Set up IBM Cognos 8 to use the SDK code samples.

For more information, see the SDK Developer Guide.

❑ Set up IBM Cognos 8 to use the Mashup Service samples.

10 Software Development Kit

 Installing and Configuring the SDK

For more information, see the Mashup Service Developer Guide.

Uninstall the SDK

Uninstall the SDK if you no longer require IBM Cognos 8 or if you are upgrading the IBM Cognos 8
software.

Steps for UNIX or Linux

1. If the console attached to your computer does not support a Java-based graphical user interface,
determine the process identification (pid) of the IBM Cognos 8 process by typing the following
command:

ps -ef | grep cogbootstrapservice

2. Stop the IBM Cognos 8 process:

● If you run XWindows, start IBM Cognos Configuration, and from the Actions menu, click
Stop.

● If you do not run XWindows, type:

kill -TERM pid

3. To uninstall IBM Cognos 8, go to the c8_location/uninstall directory and type the appropriate
command:

./uninst -u

4. Follow the prompts to begin the uninstallation.

5. When you are prompted to select the packages you want to uninstall, click the check box for
IBM Cognos 8 Software Development Kit and then click Next.

6. Continue following the prompts to complete the uninstallation.

7. Delete all temporary Internet files.

Steps for Windows

1. From the Start menu, click Programs, IBM Cognos 8, Uninstall IBM Cognos 8.

The Uninstall wizard appears.

Tip: IBM Cognos 8 is the default name of the Program Folder that is created during the
installation. If you chose another name, go to that folder to find the program.

2. Follow the prompts to begin the uninstallation.

3. When you are prompted to select the packages you want to uninstall, click the check box for
IBM Cognos 8 Software Development Kit and then click Next.

4. Continue following the prompts to complete the uninstallation.

The Cognos_uninst_log.htm file records the activities that the Uninstall wizard performs while
uninstalling files.

Installation and Configuration Guide 11

Installing and Configuring the SDK

Tip: To find the log file, look in the Temp directory.

5. Delete all temporary Internet files.

For more information, see your Web browser documentation.
Uninstalling does not remove any files that changed since the installation, such as configuration
and user data files. Your installation location remains on your computer, and you retain these
files until you delete them manually.

12 Software Development Kit

Index

A
audience of document, 5

C
configuring the SDK, 10

I
IBM Cognos Resource Center, 6
installing the SDK, 8

Q
quick tours
using, 6

S
SDK
configuring, 10
installing, 8
upgrading, 7

U
UNIX
installing the SDK, 8
upgrading the SDK software, 7

W
Windows
installing the SDK, 8

Licensed Materials – Property of IBM

© Copyright IBM Corp. 2005, 2009. 13