You deploy Cognos portlets to the portal server so that users can add the portlets to their pages.
In SharePoint Portal Server, portlets are named Web Parts. Portions of this document refer to Web Parts as portlets.
You can deploy the following portlets:
Cognos Content portlets
This group includes Cognos Navigator, Cognos Search, Cognos Viewer
Cognos Extended Applications portlets
This group includes the Cognos Extended Applications portlet.
To deploy this portlet, Cognos 8 Software Development Kit must also be installed.
Metric Studio portlets
This group includes the Metric List and Metric History Chart portlets.
To deploy this portlet, Cognos 8 Metric Studio must also be installed.
Before deploying the Cognos portlets, ensure that Cognos 8, including Cognos Connection and Portal Services, is installed and configured. Also ensure that the following conditions are met:
You have administration access to the IIS server computer that hosts SharePoint.
You have administration access to the Cognos 8 installation directory c8_location/cps/sharepoint.
WSS Language Template Pack required for other supported languages is installed, one for each language.
You know about any operating system or SharePoint-related updates as recommended by Microsoft Windows Updates.
The required OS patches are installed.
For SharePoint Portal Server 2003, they include:
Windows Server 2003 R2, professional or enterprise edition
Windows SharePoint Services (WSS) SP2
SharePoint Portal Server SP2
For SharePoint Portal Server 2007, contact Microsoft for information about required OS patches.
![]() | Copy the Cognos Web Parts resources to the IIS HTTP root
directory |
![]() | |
![]() | |
![]() | |
![]() | |
![]() | |
![]() |
After you deploy the portlets, you can configure security
for your SharePoint Portal Server environment .
For more information, see the Installation and
Configuration Guide.
Cognos provides the resources required for the integration of SharePoint Portal Server with Cognos 8. These include the Web Part DLLs for different languages, and catalog files for each Cognos Web Part. You must copy these resources to the IIS HTTP root directory to make them available to SharePoint.
Go to the c8-location/cps/sharepoint directory.
Copy all files from this directory to the IIS HTTP root directory, as specified in the following table.
An example of the IIS HTTP root directory can be C:/Inetpub/wwwroot for SharePoint Portal Server 2003, and C:/Inetpub/wwwroot/wss/VirtualDirectories/80 for SharePoint Portal Server 2007.
File | Cognos 8 Directory | IIS HTTP Root Directory |
Cognos.BI.WebPart.dll | /bin | /bin |
Cognos.BI.WebPart.resources.dll | /bin/de | /bin/de |
Cognos.BI.WebPart.resources.dll | /bin/en | /bin/en |
Cognos.BI.WebPart.resources.dll | /bin/fr | /bin/fr |
Cognos.BI.WebPart.resources.dll | /bin/ja | /bin/ja |
CognosNavigator.dwp CognosSearch.dwp CognosViewer.dwp CognosSDK.dwp CognosWatchList.dwp CognosHistoryChart.dwp | /wpcatalog | /wpcatalog |
dialog_error.gif | /wpresources/Cognos.BI.WebPart | /wpresources/Cognos.BI.WebPart |
Later you can edit the Cognos*.dwp catalog files .
The Cognos Web Parts use the .NET Web Services Stack and they require a higher security trust level than the default minimum security. Cognos provides a sample of a security trust file named wss_cognostrust.config.sample. This file specifies the required security trust, named WSS_Cognos, for the Cognos Web Parts.
Use the wss_cognostrust.config.sample file provided for your version of SharePoint to set up the security trust for the Cognos Web Parts. For a simple SharePoint Portal Server installation the file can be used without any changes. For more complex installations, you may need to edit this file.
Note: If you already have a trust file used by other Web Parts in your SharePoint Portal Server, you can add the Cognos-specific information from the sample to the existing file so that it can also be used by the Cognos Web Parts.
Go to the c8_location/cps/sharepoint/config directory.
Copy the wss_cognostrust.config.sample file:
If you use SharePoint Portal Server 2003, copy the wss_cognostrust.config.sample file from the c8_location/cps/sharepoint/config/wss.2003 directory to the C:/Program Files/Common Files/Microsoft Shared/web server extensions/60/CONFIG directory.
If you use SharePoint Portal Server 2007, copy the wss_cognostrust.config.sample file from the c8_location/cps/sharepoint/config/wss.2007 directory to the C:/Program Files/Common Files/Microsoft Shared/web server extensions/12/CONFIG directory.
Rename the copied file to wss_cognostrust.config.
Microsoft .NET Framework provides a configuration file named web.config. This file, located in the IIS HTTP root directory, is used to configure the SharePoint services at the application level. To configure the Cognos Web Parts, you must add the Cognos-specific configuration information to this file.
Cognos 8 provides a sample configuration file named web.config.sample that shows a typical, fully functional configuration of the Cognos Web Parts with a SharePoint portal. You can use this sample when editing the web.config file. However, do not copy this file directly to your IIS environment.
To configure the Cognos Web Parts with your SharePoint Portal
Server, edit the web.config file by adding the Cognos configuration
information .
Go to the IIS HTTP root directory, for example, C:/ Inetpub/wwwroot for SharePoint 2003, and C:/Inetpub/wwwroot/wss/VirtualDirectories/80 for SharePoint 2007.
Open the web.config file in an XML editor, such as XML Spy.
The web.config file is the central configuration point for all .NET Framework applications.
Add the following information to the configuration element in this file.
In the configSections section, add the following sectionGroup element:
<sectionGroup name="Cognos"> <section name="Log" type="System.Configuration.SingleTagSectionHandler, System,Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/> <section name="SoapLog" type="System.Configuration.SingleTagSectionHandler,System, Version=1.0.5000.0, Culffture=neutral, PublicKeyToken=b77a5c561934e089"/> <section name="SSO" type="System.Configuration.SingleTagSectionHandler, System,Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> <section name="PortalContext" type="System.Configuration.SingleTagSectionHandler, System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> <section name="Fault" type="System.Configuration.SingleTagSectionHandler, System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> </sectionGroup>
In the SharePoint section, add the following SafeControl element to the SafeControls element.
<SafeControl Assembly="Cognos.BI.WebPart, Version=1.0.0.0, Culture=neutral, PublicKeyToken=cb3c72729d0875cd" Namespace="Cognos.Portal.Services" TypeName="*" Safe="True"/>
Cognos Web Parts require the security trust named WSS_Cognos
that is defined in the wss_cognostrust.config file .
In the system.web section, add the following trustLevel element to the securityPolicy element.
SharePoint Portal Server 2003
<trustLevel name="WSS_Cognos" policyFile="C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\60\config\wss_cognostrust.config" />
SharePoint Portal Server 2007
<trustLevel name="WSS_Cognos" policyFile="C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\config\wss_cognostrust.config" />
WSS_Cognos is the security trust required by the Cognos Web Parts .
In the system.web section, change the trust level from
<trust level="WSS_Minimal" originUrl="" />
to
<trust level="WSS_Cognos" originUrl="" />
In the system.web section, add the following element to the httpModules element if the element does not already exist:
<add name="Session" type="System.Web.SessionState.SessionStateModule"/>
If the element is commented out, remove the comments.
In the system.web section, add the following pages element.
<pages enableSessionState="true" enableViewState="true" enableViewStateMac="true" validateRequest="false" />
If this element already exists, change the value of its enableSessionState attribute to true.
In the system.web section, add the following webServices element:
<webServices> <soapExtensionTypes> <add type="Cognos.Portal.Services.SoapPatchExtension, Cognos.BI.WebPart, Version=1.0.0.0, Culture=neutral, PublicKeyToken=cb3c72729d0875cd" priority="1" group="0" /> </soapExtensionTypes> </webServices>
The soapExtensionTypes element represents all SOAP extensions that are available to your Web service at run time. If the webServices and soapExtensionTypes elements are already defined, add only the add element.
Use the Cognos element to specify the Cognos configuration parameters as defined in Cognos Configuration.
Insert the following Cognos element between the closing tags </system.web> and </configuration>:
<Cognos> <SoapLog filename="c:\Cognos.BI.WebPart.Soap.log" <Log filename="c:\Cognos.BI.WebPart.log" error="true" warn="false" info="false" debug="false" performance="false" /> <SSO cps_auth_namespace="blank or as defined in Cognos Configuration" cps_auth_secret="blank or as defined in Cognos Configuration" /> <PortalContext gatewayURL="blank or as defined in Cognos Configuration" webContentURL="blank or as defined in Cognos Configuration" /> <Fault stacktrace="false" /> </Cognos>
The elements in the Cognos element represent the different configuration settings.
Use the SoapLog element to specify the location for the Web Services log files.
Use the Log element to specify a different location for the log file, and to enable the different logging features by changing the attribute values from false to true.
Use the SSO element to specify the Cognos Security Namespace ID of the CPS trusted namespace named cps_auth_namespace, and the shared secret password named cps_auth_secret.
This parameter is optional.
Use the PortalContext element to specify the URL attributes for Cognos gateway and Cognos Web content, as shown in the following example:
gatewayURL="http://c8_host_computer/cognos8/cgi-bin/cognosisapi.dll"
webContentURL="http://c8_host_computer/cognos8"
This parameter is optional.
Use the Fault element to display the call stacks in the error page when a fault is caught by a Web Part.
The catalog files contain the definitions of the Cognos Web Parts to use in SharePoint Portal Server.
For each Cognos Web Part catalog file, change the WSDL URL to point to your Cognos 8 gateway.
Go to the IIS directory where the catalog files were copied.
For example, for SharePoint Portal Server 2003, go to C:/Inetpub/wwwroot, and for SharePoint Portal Server 2007 go to C:/Inetpub/wwwroot/wss/VirtualDirectories/80.
In each Cognos Web Part catalog file, Cognos*.dwp, change the URL in the WSDL element to point to your Cognos 8 gateway.
Here is an example:
<WSDL xmlns="http://developer.cognos.com/webpart/v1"> http://localhost/cognos8/cgi-bin/cognosisapi.dll/wsrp/cps4/portlets/nav?b_action=cps.wsdl&wsdl</WSDL>
Tip: The ampersand characters (&) in the URL must be XML-encoded as &
Save the file.
You must restart Internet Information Services (IIS) for the configuration changes to take effect.
Restart IIS using its management console, or the iisreset.exe command line tool.
The Cognos Web Parts are now available in SharePoint
Portal Server, and can be added to the portal pages .
You can use the Cognos Web Parts to add the Cognos content to your pages in SharePoint Portal Server.
You can add or remove the Web Parts from the shared view, or from the personal view of the page. Ensure that you are in edit mode before you make changes to the page.
The following steps provide only basic instructions for adding the Cognos Web Parts to SharePoint pages. For more information, see the SharePoint Portal Server help.
Log on to your SharePoint Portal Server with administrative permissions.
Go to the page where you want to add the Cognos Web Parts.
From the Actions list on the left side, click Edit Page.
In the upper-right corner of the page, click Modify Shared Page, Add Web Parts.
Click Browse to add a Web Part from an existing Cognos Web Part library.
The page opens in design mode, and the Add Web Parts pane appears on the right side of the page.
Tips:
You can use the Search option to find the Web Parts in the Web Part library.
You can use the Import option if the Web Part you want is not in the library.
Type the path or browse to the location of the Cognos*.dwp file that you want to import, and then click Upload.
In the Add Web Parts pane, click Virtual Server Gallery.
The Cognos Web Parts appear in the Web Part List.
Click the Cognos Web Part you want, and then click the Add button at the bottom of the pane.
The Web Part appears at the top of the page.
Tip:You can also drag the Web Parts to different drop zones in the page.
In the Web Part, click the down arrow in the upper-right corner, and click Modify Shared Web Part.
In the pane on the right side of the page, specify the URL of the WSDL file under Connection Settings, WSDL.
The URL must point to a functional Cognos 8 installation.
Click Discover Portlets.
Specify the Portlet handle property.
Click Apply to make changes without closing the pane, or click OK when you are done.
Repeat steps 4 to 12 for each Cognos Web Part you want to add to the page.
You can now customize the content of the Cognos Web Parts .
Log on to your SharePoint Portal Server with administrative permissions.
Go to the page where you want to add the Cognos Web Parts.
From the Site Actions menu in the upper-right corner, click Edit Page.
In the Web Part zone where you want to add the Cognos Web Part, click Add a Web Part.
In the Add Web Parts dialog box, click Advanced Web Part gallery and options at the bottom.
In the Add Web Parts tool pane on the right side of the page, click Server Gallery.
From the list of available Cognos Web Parts, click the Web Part you want.
At the bottom of the tool pane, from the Add to menu, select the location on the page where you want the Web Part to appear, and click the Add button.
Tip: You can also drag the Web Part to different drop zones in the page.
Repeat steps 4 to 8 for each Cognos Web Part you want to add to the page.
Click Exit Edit Mode.
You can now customize the content of the Cognos Web Parts .
An administrator can define the default content and appearance for Cognos Web Parts. When users add the Web Part to their pages, the default properties are enabled. For example, in the Cognos Navigator Web Part, the administrator can define the default display folder or package. When users add this Web Part to their pages, they see the folder or package that was specified by the administrator.
Users can change the Cognos Web Part properties to personalize their pages. The changes made by each individual user do not affect other users or other pages. The personalized settings are not affected if the administrator changes the default properties for the Web Part. Users can click the Reset button to revert to the current administrative defaults.
The configurable properties for each Cognos Web Part are different. For more information, see User Reference Help for Portal Services.
Go to the page in your SharePoint Portal Server that contains the Cognos Web Part you want to edit.
From the list of Actions on the left side, click Edit Page.
In the Web Part, click the down arrow in the upper-right corner, and click Edit Preferences.
The Web Part properties page appears.
Specify the settings as required.
For more information, click the help button in the upper-right corner of the properties page.
Click OK.
Go to the page in your SharePoint Portal Server that contains the Cognos Web Part you want to edit.
From the Site Actions menu in the upper-right corner, click Edit Page.
In the Web Part that you want to change, click the edit button.
Click Edit preferences.
The Web Part properties page appears.
Specify the settings as required.
For more information, click the help button in the upper-right corner of the properties page.
Click OK.