Powerpoint exploring the locations used in television show Time Clash
Cognos Software Development Kit
1. 1.
Web Services and Enabling Technologies
2.
Use the ReportNet SDK
3.
Authenticate Using the SDK
4.
Retrieve Application Content
5.
Run Reports Using the SDK
6.
Update and Add Application Content
7.
Pass Parameters to Reports
8.
End to End Workshop
Cognos ReportNet - SDK for Developers
2. Objectives
In this module, we will:
examine the ReportNet SDK and its uses
discuss design-time Web services consumption
discuss the ReportNet object model
explore the online documentation
3. Examine Uses for the ReportNet SDK
Using the ReportNet SDK:
OEM’s can add BI and reporting to their own systems
organizations can achieve B2B integration
4. What Can You Do With the SDK?
Specifically, the SDK exposes all reporting and administrative
functionality of ReportNet, including:
query Content Manager
execute/modify reports & queries
authenticate against user credentials
create Schedules
deployment
5. Use the SDK: Consume the WSDL File
ReportNet
Environment
Development Environment
.DLL/.JAR
Application
Client
Report Server
WSDL
SOAP
10. Examine ReportNet Communication
Report Studio
Query Studio
Consumer
UI
Admin
Application
ASP,JSP, VB, Excel
FIREWALL
SOAP
SDK
Gateway
Web Services
SOAP
UI
CGI Servlet
SOAP/WSDL
FIREWALL
Dispatcher
Cognos BI Bus
Report Service
Prompt
Engine
Rendering Metadata
Engine
Engine
SOAP
Presentation Service
Query
Engine
Admin
Portal
Content Manager
Customer
Database
DB2, Oracle
Others…
CAM
Content
Store
Notification
Service
FIREWALL
11. Examine the ReportNet Object Model
ReportNet consists of 2 object models:
private
public
Essentially it is a WSDL file which is used to generate:
documentation
the API
12. Examine the ReportNet Object Model (cont’d)
An object model defines a set of objects such as reports,
folders, or URLs.
BaseClass
UiClass
URL
Folder
Package
13. Examine ReportNet Object Properties
Objects have a set of properties associated with them:
BaseClass (17 properties in total)
name
search path
creation time
UI Class (6 properties plus those inherited from BaseClass)
screen tip
description
14. Understand Instance Containment
Objects can contain many sub-classes.
Objects can serve as containers for other objects inherited from the
same parent class
folder
report
report2
URL1
URL2
15. Examine ReportNet Object Model Methods
Methods are actions that you can perform on objects, such as:
update
add
query (returns series of BaseClasses)
The object model provides versatility. Use it to:
update a series of Base Classes in one call
add a series of BaseClasses in one call
16. Examine Enumeration Types
Enumeration types consist of arrays populated by static values.
HTML
Output format
CSV
XML
XHTML
17. Set up an SDK Application
For Visual Basic or ASP:
install Microsoft’s SOAP toolkit
register the CRN.dll
For Java:
For .NET
import the .jar files into your project
reference the WSDL file in your project
After completing this:
enable the capabilities
21. Summary
In this module, we have:
examined the ReportNet SDK and its uses
discussed design-time Web services consumption
discussed the ReportNet object model
explored the online documentation
Notas do Editor
Define FM and how it is used with other ReportNet components
Examine the terminology used within the FM world, and some outside (e.g., Cognos Connection, QS, RS)
Examine and describe how FM fits into the overall CRN workflow process
Examine the FM process; emphasize that this process is the basis for the flow of the course; flow of the modules, including module to module, within a given module, and within demos and workshops.
The SDK has many potential practical uses. An OEM can add BI and reporting to their own systems without investing valuable time and resources in building their own. Likewise, large, medium and small B2B enterprises can quickly augment distribution efficiency of critical information ie. used to speed up integration efforts by allowing existing systems to access functionality from ReportNet
ACTION: - Additional Content ???
Environment references the WSDL file on the Report Server.
WSDL file is consumed and converted to environment native code (either a .dll or .jar file) which is then called by the application.
.dll and .jar file contain all methods and required parameters to construct a proper ReportNet Web Services request.
As mentioned earlier, ReportNet can be integrated into any system, regardless of OS or programming language. In order for this to occur, the target environment must be able to consume the WSDL and generate its own code from it. Microsoft's Vusual Studio .NET is one such environment that can consume the WSDL at design time and create all the required stub classes and objects.
Other IDEs (Integrated development environments) such as Eclipse, Visual Basic 6, Borland JBuilder, etc... may require this process to occur outside of the design time session. In order for this to happen, a seperate process needs to consume the WSDL and generate its own code from it. We ship two such code packages with the ReportNet SDK.
For the Java world, we use the Apache Group's AXIS project. AXIS consumes the WSDL and builds a JAR file that is used during the coding process (CognosReportNetClient.jar). This JAR file contains the code that is used to serialize/deserialize SOAP messages at runtime. It might help to think of the AXIS client as the SOAP processor for the ReportNet SDK.
Once the JAR file is compiled, it can be used by any Java IDE. ReportNet can now be integrated with any Java system including Java Beans, JSPs and applets.
Cognos tool is a modified version of AXIS to create the VB 6 CRN.dll
Environment references the WSDL file on the Report Server.
WSDL file is consumed and converted to environment native code (either a .dll or .jar file) which is then called by the application.
.dll and .jar file contain all methods and required parameters to construct a proper ReportNet Web Services request.
What is the BI Bus?
Transport mechanism
It’s exposed via the API
SOAP over HTTP is a communication protocol
These objects all share (inherit a common set of properties)
Explain inheritance
Eg. There are apprx 67 methods that can be performed on objects of type base class
Show both the PDF and HTML versions of the SDK documentation.
Show BI Bus Reference (Methods and Classes) and how to traverse the classes hierarchy and browse the Methods (showing sample code portions).
Use schedule to show how this class can be a child of both baseReport and jobDefinition.