of 7

Hands-on IBM CognosSoftware Development Kit Programming

Published on last month | Categories: Documents | Downloads: 3 | Comments: 0
173 views

Comments

Content

IBM Cognos Proven Practices: Hands-on IBM Cognos Software Software Development Development Kit Programming Nature of Document: Proven Practice; Product(s): IBM Cognos Software Development Kit; Area of Interest: Development Claudiu Popescu Software Engineer, Engineer, IBM Cognos SDK Support Group IBM

20 May 2011

An introductory document to the IBM Cognos SDK that explains the basic requirements of an SDK application using a stand-alone sample. View more content in this series

Introduction Purpose This document is addressed to the software designers who are very familiar with the IBM Cognos BI product and who would like to use the IBM Cognos BI Software Development Kit (SDK) component. The IBM Cognos Software Development Kit contains many samples but they may be intimidating for someone just starting out with the SDK because they are somewhat complex and are not stand-alone as they make use of classes that are defined in other directories. This document offers a simpler approach in that it contains only one source file with a self-contained SDK application. application.

Applicability This document has been written using IBM Cognos BI version 10.1 as the reference version. However,, the concepts presented also apply to versions 8.3 and greater of IBM Cognos 8 BI. The However code sample supplied with this document will need to be adapted to work with IBM Cognos 8 BI.

Wha t is the IBM Cognos Software Development Kit? Uses for the IBM Cognos Software Development Kit The IBM Cognos Software Development Kit is an additional install component which allows the programmatic execution of, © Copyright IBM Corporation 2011 IBM Cognos Proven Practices: Hands-on IBM Cognos Software Development Kit Programming

Trademarks Page 1 of 14

developerWorks®

ibm.com/developerWorks/

• Most of the tasks that can be performed through the IBM Cognos BI user interface (UI) • The automation of repetitive non-UI tasks, such as scheduling large number of reports, changing permissions for many reports, etc • Integrating IBM Cognos BI into other applications. Examples of IBM Cognos Software Development Kit specific tasks include, • • • •

Display all IBM Cognos BI users and their access to reports Assign a new owner to all reports for which the original owner was deleted After a package is republished, update the reports and queries belonging to the package. Display a list of IBM Cognos BI reports in a custom web page

However, the IBM Cognos Software Development Kit cannot be used for tasks that are typically associated with configuration and packaged user interfaces. For example, the SDK cannot modify IBM Cognos BI user interface components such as, • • • • •

Portal Pages Logon Pages Any user interface widgets Studios in IBM Cognos Connection Branding

The API of the IBM Cognos Software Development Kit The main component of IBM Cognos Software Development Kit is the Application Programming Interface (API) known as the BI Bus API. IBM Cognos Software Development Kit API supports specific programming languages through the use of toolkits. The supported programming languages are, • Java • .NET Framework languages IBM Cognos Software Development Kit API can be used either in stand-alone programs or in web pages, such as ASPs or JSPs. In addition to the toolkits, there are other IBM Cognos Software Development Kit components  which will not be presented in this document. The other components are, • URL interface which is used to automate actions by passing commands and parameters over HTTP in order to integrate with other applications • Framework Manager (FM) SDK which is used to model metadata and publish packages • Cognos Mashup Services (CMS) which exposes a REST and WSDL/SOAP interface to IBM Cognos BI outputs so that this output can be easily consumed by other applications.

The IBM Cognos Software Development Kit documentation The IBM Cognos Software Development Kit documentation is divided into the following components (the number of pages are from the IBM Cognos 10 document set), IBM Cognos Proven Practices: Hands-on IBM Cognos Software Development Kit Programming

Page 2 of 14

ibm.com/developerWorks/

• • • • • •

developerWorks®

IBM Cognos Software Development Kit Getting Started (44 pages) IBM Cognos Software Development Kit Installation and configuration guide (15 pages) IBM Cognos Software Development Kit Developer Guide (3565 pages) IBM Cognos Custom Authentication Provider Developer Guide (41 pages) IBM Cognos Framework Manager Developer Guide (172 pages) IBM Cognos Mashup Service Developer Guide (275 pages)

Since the IBM Cognos Software Development Kit documentation is quite large, the new user is encouraged to read about the essentials of the SDK in the developerWorks article “IBM Cognos Proven Practices: Approach to the IBM Cognos SDK”, which can be found at the following URL, http://www.ibm.com/developerworks/data/library/cognos/development/how_to/page129.html

How to install IBM Cognos Software Development Kit The IBM Cognos Software Development Kit must be installed on a computer where any server component of IBM Cognos BI is already installed. The SDK installation procedure is similar to the IBM Cognos BI Server installation procedure. The remainder of this document assumes that the IBM Cognos Software Development Kit has been installed and an IBM Cognos BI Server is available. It is recommended, if possible, that a single server install be used when just starting out with the SDK. A Windows or Linux workstationbased install of IBM Cognos BI that uses the IBM Cognos Content Store and the deployment of the sample IBM Cognos PowerCubes makes an excellent self contained learning environment.

How IBM Cognos Software Development Kit works The IBM Cognos Software Development Kit API contains classes which correspond to IBM Cognos BI services such as the Content Manager Service, the Report Service or the Monitor Service. The services that are available on an IBM Cognos BI server are specified in IBM Cognos Configuration and can be seen in under the Configuration tab in IBM Cognos Administration.

IBM Cognos Proven Practices: Hands-on IBM Cognos Software Development Kit Programming

Page 3 of 14

developerWorks®

ibm.com/developerWorks/

Illustration 1: IBM Cognos 10 Services listed in the IBM Cognos Configuration

Illustration 2: IBM Cognos 10 Services listed in IBM Cognos Administration

An IBM Cognos Software Development Kit program can run on a computer which does not have the IBM Cognos BI server installed. However the IBM Cognos Software Development Kit libraries are required to be installed on this computer. The SDK libraries are located at: IBM Cognos Proven Practices: Hands-on IBM Cognos Software Development Kit Programming

Page 4 of 14

ibm.com/developerWorks/

developerWorks®

• <cognos-directory>\sdk\java\lib for Java; axisCognosClient.jar is the main Java SDK library and the rest of the jar files are to support axisCognosClient.jar and the samples that are installed with the SDK • <cognos-directory>\sdk\csharp\lib for the .NET languages An IBM Cognos Software Development Kit application will generally supply a set of credentials to the IBM Cognos BI server and the application will be bound and limited to these credentials. This means that the SDK application must be authenticated to perform operations in the same way a user needs to logon to the IBM Cognos Connection. This ensures secure access to IBM Cognos content.

The Structure of an IBM Cognos Software Development Kit Program A typical IBM Cognos Software Development Kit program has four primary sections. 1. Connect to the IBM Cognos BI service(s) 2. Logon to IBM Cognos BI 3. Execute tasks 4. Logoff from IBM Cognos BI This document contains a sample SDK application written in Java and contains methods that correspond to these primary sections.

Step 1: Connect to the IBM Cognos BI server Method name : connectToCognos The IBM Cognos Software Development Kit program must fir st connect to an IBM Cognos BI Dispatcher using the URL of the IBM Cognos BI server. This URL is defined in IBM Cognos Configuration and is the value of the “Dispatcher URI for external applications” field. The URL has the form http://host.domain:port/p2pd/servlet/dispatch .

IBM Cognos Proven Practices: Hands-on IBM Cognos Software Development Kit Programming

Page 5 of 14

ibm.com/developerWorks/

developerWorks®

Downloads Description

Name

Size

Article contained in ZIP file

HandsOnSDK.zip

579KB

IBM Cognos Proven Practices: Hands-on IBM Cognos Software Development Kit Programming

Page 13 of 14

developerWorks®

ibm.com/developerWorks/

About the author Claudiu Popescu Claudiu Popescu is a member of the IBM Cognos SDK and Diagnostic Team. He specializes in the Cognos Software Development Kit, Cognos Mashup Services and JavaScript.

© Copyright IBM Corporation 2011 (www.ibm.com/legal/copytrade.shtml) Trademarks (www.ibm.com/developerworks/ibm/trademarks/)

IBM Cognos Proven Practices: Hands-on IBM Cognos Software Development Kit Programming

Page 14 of 14

Sponsor Documents


Recommended

No recommend documents

Or use your account on DocShare.tips

Hide

Forgot your password?

Or register your new account on DocShare.tips

Hide

Lost your password? Please enter your email address. You will receive a link to create a new password.

Back to log-in

Close