Cognos 8

SOFTWARE DEVELOPMENT KIT INSTALLATION AND CONFIGURATION GUIDE

Product Information
This document applies to Cognos 8 Version 8.3 and may also apply to subsequent releases. To check for newer versions of this document, visit the Cognos Global Customer Services Web site (http://support.cognos.com).

Copyright
Copyright 2007 Cognos Incorporated. Portions of Cognos software products are protected by one or more of the following U.S. Patents: 6,609,123 B1; 6,611,838 B1; 6,662,188 B1; 6,728,697 B2; 6,741,982 B2; 6,763,520 B1; 6,768,995 B2; 6,782,378 B2; 6,847,973 B2; 6,907,428 B2; 6,853,375 B2; 6,986,135 B2; 6,995,768 B2; 7,062,479 B2; 7,072,822 B2; 7,111,007 B2; 7,130,822 B1; 7,155,398 B2; 7,171,425 B2; 7,185,016 B1;7,213,199 B2. Cognos and the Cognos logo are trademarks of Cognos Incorporated in the United States and/or other countries. All other names are trademarks or registered trademarks of their respective companies. While every attempt has been made to ensure that the information in this document is accurate and complete, some typographical errors or technical inaccuracies may exist. Cognos does not accept responsibility for any kind of loss resulting from the use of information contained in this document. This document shows the publication date. The information contained in this document is subject to change without notice. Any improvements or changes to either the product or the document will be documented in subsequent editions. U.S. Government Restricted Rights. The software and accompanying materials are provided with Restricted Rights. Use, duplication, or disclosure by the Government is subject to the restrictions in subparagraph (C)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013, or subparagraphs (C)(1) and (2) of the Commercial Computer Software - Restricted Rights at 48CFR52.227-19, as applicable. The Contractor is Cognos Corporation, 15 Wayside Road, Burlington, MA 01803. This software/documentation contains proprietary information of Cognos Incorporated. All rights are reserved. Reverse engineering of this software is prohibited. No part of this software/documentation may be copied, photocopied, reproduced, stored in a retrieval system, transmitted in any form or by any means, or translated into another language without the prior written consent of Cognos Incorporated.

Table of Contents
Introduction

5 7

Installing and Configuring the SDK

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

13

Installation and Configuration Guide 3

Table of Contents

4 Software Development Kit

Introduction
This document is intended for use with 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 Cognos 8. For more information, see the SDK Developer Guide. This document provides instructions for installing the SDK package from the 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 particular installation and translation configuration. If a link is unavailable, you can access the document on the Cognos Global Customer Services Web site (http://support.cognos.com). Logon credentials are available either from your administrator or by request from support.america@cognos. com.

Document
Cognos 8 Installation and Configuration Guide

Description
Installing, upgrading, configuring, and testing Cognos 8, changing application servers, and setting up samples

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

Installation and Configuration Guide 5

Introduction

Document
Cognos 8 Administration and Security Guide

Description
Managing servers, security, reports, and portal services; setting up Cognos samples; troubleshooting; and customizing Cognos 8

Finding Information
To find the most current product documentation, including all localized documentation, access the Cognos Global Customer Services Web site (http://support.cognos.com). Click the Documentation link to access documentation guides. Click the Knowledge Base link to access all documentation, technical papers, and multimedia materials. Product documentation is available in online help from the Help menu or button in Cognos products. You can also download documentation in PDF format from the Cognos Global Customer Services Web site. You can also read PDF versions of the product readme files and installation guides directly from Cognos product CDs.

Using Quick Tours

Quick tours are short online tutorials that illustrate key features in Cognos product components. To view a quick tour, start 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 Cognos Global Customer Services Web site (http://support.cognos.com). This site provides product information, services, user forums, and a knowledge base of documentation and multimedia materials. To create a case, contact a support person, or to provide feedback, click the Contact Us link. For information about education and training, click the Training link.

Printing Copyright Material

You can print selected pages, a section, or the whole book. Cognos grants you 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 Cognos software.

6 Software Development Kit

Installing and Configuring the SDK

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

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

After you successfully install and configure the SDK, it will enable you to fully automate all Cognos 8 functionality: data modeling, report execution and viewing, authoring, Web application integration, administration, and configuration.

Upgrading the SDK Software

When you upgrade from an older version of the Cognos 8 Software Development Kit, ensure that you upgrade to the same version of 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 Cognos 8 and Framework Manager, see the 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 Cognos 8 Software Development Kit Installation and Configuration Guide. Cognos 8 automatically upgrades the content store. When you upgrade, you must make some changes to your SDK program for it to function with the Cognos 8 version of the WSDL file. Some methods, classes, and properties have been deprecated Installation and Configuration Guide 7

Installing and Configuring the SDK in Cognos 8. Deprecated features continue to function as before, but will be removed in future releases. Some other methods, classes, and properties are obsolete, and have been removed from the Cognos 8 SDK. For information about changes to methods, classes, properties, and enumeration sets, see the Release Notes appendixes in the Cognos 8 SDK Developer Guide. New report specifications have been added in Cognos 8. If you run a ReportNet report in Cognos 8, it is automatically upgraded to the Cognos 8 format. After a report is upgraded to Cognos 8, it cannot be returned to the ReportNet 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 Cognos 8 Administration and Security Guide. Do not upgrade your report specifications if you have SDK applications that create, modify, or save report specifications. You must first update your SDK applications to comply with the 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 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 Cognos 8 SDK CD on every computer where SDK applications are developed, and in the same installation location as Cognos 8. You can view an up-to-date list of environments supported by Cognos products, such as operating systems, patches, browsers, web servers, directory servers, and database servers on the Cognos Global Customer Services Web site (http://support.cognos.com). 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 combination 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 a Cognos product. Otherwise, your product may not work properly. The Cognos 8 SDK must be installed on at least one computer that has a Cognos 8 installation. In distributed environments or an environment where Cognos 8 is installed on multiple computers, administrators must ensure that the SDK computer can access the Cognos 8 service and the java libraries on the Cognos 8 computer. If you plan to use the Framework Manager SDK, then you must install the SDK on a computer where Framework Manager is installed. For more information about installing Cognos 8 components, see the Cognos 8 Installation and Configuration Guide.

8 Software Development Kit

Installing and Configuring the SDK Before you install the Cognos 8 SDK, ensure that Cognos 8 BI components are installed.

Steps for UNIX or Linux

1. If you are installing on HP-UX, mount the Cognos 8 SDK CD with Rock Ridge file extensions. Important: To mount the Cognos CD on HP-UX, 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 a 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, type ./issetupcc

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 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.

6. Click Finish.

Steps for Windows

1. Insert the Cognos 8 software development kit CD, and then open the installation menu. 2. If the Welcome page does not appear, in the win32 directory on the CD, double-click the issetup. exe file. Installation and Configuration Guide 9

Installing and Configuring the SDK 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 Cognos 8 components and Framework Manager. Important: If you have a distributed installation, the files must be installed on all computers where a Cognos 8 component is installed. 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, configure 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 dialogs. To allow browsing or import of system objects, set the preference to TRUE. Set up the samples for Cognos 8 and Framework Manager. For more information, see the Installation and Configuration Guide. Set up Cognos 8 to use the SDK code samples. For more information, see the SDK Developer Guide.

10 Software Development Kit

Installing and Configuring the SDK

Uninstall the SDK

Uninstall the SDK if you no longer require Cognos 8 or if you are upgrading the 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 Cognos 8 process by typing the following command: ps -ef | grep cogbootstrapservice 2. Stop the Cognos 8 process: If you run XWindows, start Cognos Configuration, and from the Actions menu, click Stop. If you do not run XWindows, type: kill -TERM pid 3. To uninstall Cognos 8, go to the c8_location/uninstall directory and type the appropriate command: If you use XWindows, type ./uninst -u If you do not use XWindows, type ./uninstcc -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 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, Cognos 8, Uninstall Cognos 8. The Uninstall wizard appears. Tip: 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 Cognos 8 Software Development Kit and then click Next. 4. Continue following the prompts to complete the uninstallation.

Installation and Configuration Guide 11

Installing and Configuring the SDK The Cognos_uninst_log.htm file records the activities that the Uninstall wizard performs while uninstalling files. 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

P
printing copyright material, 6

C
configuring the SDK, 10 copyright material printing, 6

Q
quick tours using, 6

R F
finding information, 6 related documentation, 5

S G
Global Customer Services Web site, 6 SDK configuring, 10 installing, 8 upgrading, 7

H
help getting, 6

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

I
information finding, 6 installing the SDK, 8

W
Windows installing the SDK, 8

Installation and Configuration Guide 13