cognos tm1 executiveviewerpublic.dhe.ibm.com/software/data/cognos/documentation/... ·...

35
IBM ® Cognos ® TM1 ® Executive Viewer NEW FEATURES

Upload: others

Post on 21-Jul-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM® Cognos® TM1® Executive Viewer

NEW FEATURES

Page 2: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

New Features Guide 2

Product InformationThis document applies to IBM® Cognos® TM1® Executive Viewer 9.4 MR1 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).

Copyright

Copyright © 2008 Cognos ULC (formerly Cognos Incorporated). Cognos ULC is an IBM Company.

Portions of Cognos ULC 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; 7,243,106 B2; 7,257,612 B2; 7,275,211 B2; 7,281,047 B2; 7,293,008 B2; 7,296,040 B2; 7,318,058 B2; 7,325,003 B2; 7,333,995 B2.

Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries. IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries or both. Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others.

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 the information contained in this 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 clause at DFARS 252.227-7013, or subparagraphs (C)(1) and (2) of the Commercial Computer Software - Restricted Rights at 48CFR52.227 as applicable. The Contractor is Cognos Corporation, 15 Wayside Road, Burlington, MA 01803.

This document contains proprietary information of Cognos. All rights are reserved. No part of this document 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.

Page 3: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

New Features Guide 3

Table of Contents

1 Introduction......................................................................................................... 4

2 New Features....................................................................................................... 5Grid XML............................................................................................................. 5TM1 Data Spreading - No Spreading ....................................................................... 5TM1 Data Spreading - New TM1 spreading methods.................................................. 5Zoom in on Bubble charts and Scatter charts ........................................................... 5Database Wizard - Links to Databases are added...................................................... 6New appSetting ‘TokenCacheTimeOut’ in ‘EVServer.exe.config’ file ............................. 6Connectivity to Microsoft SQL Server 2008 Analysis Services...................................... 6

3 Fixed documentation issues ................................................................................. 7Missing TM1 Spreading Type ‘Proportional Spread’ .................................................... 7TM1 Spreading Type ‘Clear’ is no longer available ..................................................... 7Security and Executive Viewer Portlets.................................................................... 7IBM Cognos 8 Security Provider ............................................................................. 7CAMPassport value missing from <ClientLogon> tag example .................................... 8URL API exceptions not complete ........................................................................... 8

4 Appendix A: Render Action Specific Options......................................................... 9Rendertype ....................................................................................................... 10XSLT ................................................................................................................ 11RenderType is set to ActiveX or XML..................................................................... 12RenderType is set to GridXML .............................................................................. 14

5 Appendix B: System Requirements .................................................................... 16Executive Viewer Server ..................................................................................... 17ASP.NET Executive Viewer Explorer ...................................................................... 18Executive Viewer Client....................................................................................... 19Executive Viewer Desktop Explorer ....................................................................... 19

6 Appendix C: Executive Viewer Portlets, step by step.......................................... 21Executive Viewer Portlets and IBM Cognos 8 Security.............................................. 22Configuration of Executive Viewer 9.4 Server using IBM Cognos 8 Security ................ 23Installation of the IBM Cognos TM1 Executive Viewer 9.4 Portlets ............................. 29Set up single sign on to a TM1 Data Source using IBM Cognos 8 security................... 31Add Executive Viewer Portlets to Cognos 8 ............................................................ 34

Page 4: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

IntroductionThis document is intended for use with IBM Cognos TM1 Executive Viewer 9.4 MR1.

This unique user-friendly software provides a powerful tool to access information and analyze data. As soon as IBM Cognos TM1 Executive Viewer is installed on your computer, you will be able to understand data in new ways. You will view information from different perspectives, as often as you like, with the latest up-to-date figures. You can analyze information in many ways and focus on key result areas of your own choice. With growing familiarity you will be able to customize your own reports or have Executive Viewer do dynamic analyses of results important to your decision-making.

This New Features Guide provides an overview of all new features that are available in IBM Cognos TM1 Executive Viewer 9.4 MR1 In addition it also provides the latest system requirements.

Related Documentation

Our documentation includes user 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.

You can access the documentation on the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html). Logon credentials are available either from your administrator or by request from [email protected].

Document Description

IBM Cognos TM1 Executive Viewer User Manual

This User Manual provides a guide to the many features available within Executive Viewer. Your system administrator or supervisor will give you access to one or more sources of your data residing in your organization’s database.

IBM Cognos TM1 Executive Viewer Server Installation and Configuration Guide

This manual is designed for the system administrator in charge of installing, licensing, configuring and managing Executive Viewer Server and Executive Viewer Client software. It contains information regarding all parts of Executive Viewer.

IBM Cognos TM1 Executive Viewer Integration Guide

This manual is designed for people who want to embed Executive Viewer Client 9.4 Client into their application or website. The manual describes the Properties, Methods and Events that allow you to customize how IBM Cognos TM1 Executive Viewer software looks and acts.

IBM Cognos TM1 Executive Viewer Server API Reference

This manual is designed for people who want to use the available Methods of IBM Cognos TM1 Executive Viewer Server’s Web Service

IBM Cognos 8 Administration and Security Guide

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

IBM Cognos 8 BI Getting Started Guide

This document is intended for use with Cognos 8. Cognos 8 is a Web product with integrated reporting, analysis, scorecarding, and event management features.

IBM Cognos TM1 Installation Guide

This manual describes how to install the Cognos TM1 software components on Windows and UNIX operating systems.

New Features Guide 4

Page 5: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

New FeaturesGrid XML

As of Executive Viewer 9.4 MR1 a new render type, Grid XML, is added to the Render Action of the URL API. Because of this the section ‘URL API Syntax: Action Specific URL API Options - Render’ in chapter ‘URL API’ in the ‘Executive Viewer Server Installation and Configuration Guide’ is not complete anymore.

Please find the updated version of this section in appendix A of this New Features guide.

TM1 Data Spreading - No Spreading

As of Executive Viewer 9.4 MR1 the spreading type ‘No Spreading’ is available. No spreading to the leaves is applied when you select this spreading type.

Refer to the section ‘Spreading - Options’ in chapter ‘IBM Cognos TM1’ in the ‘Executive Viewer User Manual’ for more information on spreading actions.

TM1 Data Spreading - New TM1 spreading methods

As of Executive Viewer 9.4 MR1 new spreading methods are available for TM1:• GetTM1DataEntrySpreading• GetTM1DataEntrySpreadingAction• GetTM1DataEntrySpreadingAllLeaves• SetTM1DataEntrySpreading• SetTM1DataEntrySpreadingAction• SetTM1DataEntrySpreadingAllLeaves

Refer to the ‘Executive Viewer Integration Guide’ for explanation on these methods.

Zoom in on Bubble charts and Scatter charts

As of Executive Viewer 9.4 MR1 it is possible to zoom in on Bubble charts and Scatter charts.

In order to zoom in you draw a rectangle with your mouse around the members you want to zoom into. The chart changes to display the zoomed into area.

Note: It is only possible to zoom into areas that contain members.Note: The Member selection in the table will change according to the members you zoomed into.

New Features Guide 5

Page 6: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Database Wizard - Links to Databases are added

As of Executive Viewer 9.4 MR1 the Database Wizard creates links to the Databases that are registered successfully. When you click on a link the content of that Database you can change for example the settings for preloading or Process Distribution.

Refer to the ‘Executive Viewer Server Installation and Configuration Guide’, chapter ‘Executive Viewer Explorer’, section ‘Database Wizard’ for more information on how to use the Database Wizard.

New appSetting ‘TokenCacheTimeOut’ in ‘EVServer.exe.config’ file

As of Executive Viewer 9.4 MR1 a new appSetting can be set in the ‘EVServer.exe.config’ file. The appSetting ‘TokenCacheTimeOut’ lets you specify the time in minutes a token lasts.

The appSetting ‘TokenCacheTimeOut’ can be configured like follows in the ‘EV Server.exe.config’ file:<add key="TokenCacheTimeOut" value="-1" />

Possible values:• -1: Unlimited, the time the token last will not expire (default value)• 0: The token is not cached• 1 - 2147483647 minutes. A time-out occurs when the time the token is idle (not being

used) is longer than the specified time.

If for example you set the TokenCacheTimeOut to 540 minutes, the token expires from the cache after not being used for 9 hours. This frees up resources for other tokens.

For more information on the ‘EVServer.exe.config’ file, refer to the ‘Executive Viewer Server Installation and Configuration Guide’, chapter ‘Configuration Files’.

Connectivity to Microsoft SQL Server 2008 Analysis Services

As of Executive Viewer 9.4 MR1 connectivity to Microsoft SQL Server 2008 Analysis Services is supported.

To be able to connect to MS SQL Server 2008 Analysis Services, Executive Viewer Server requires OLE Database Provider for OLAP and the Analysis Management Objects (AMO) to be installed on the machine running Executive Viewer Server.

The recommended way to install these components is to use the setup of MS SQL Server 2008 Analysis Services and install the client components (connectivity components). This setup installs the required components in the correct order.

On a machine where MS SQL Server 2008 Analysis Services is installed, these components are part of the MS Analysis Services installation. Check whether these components are installed. The Analysis Management Objects (AMO) are the components, used to communicate with the MS Analysis Services repository.

If you upgrade Analysis Services, you should upgrade these components also. You can find the OLE Database Provider for OLAP and the Analysis Management Objects (AMO) with your SQL Server Analysis Services software.

New Features Guide 6

Page 7: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Fixed documentation issuesMissing TM1 Spreading Type ‘Proportional Spread’

An explanation is missing about the Spreading Type ‘Proportional Spread’ in the ‘Executive Viewer User Manual’, chapter ‘IBM Cognos TM1’, section ‘Spreading Type’.

The Spreading Type ‘Proportional Spread’ distributes a specified value proportionally across the selected cells in a View.

TM1 Spreading Type ‘Clear’ is no longer available

In the ‘Executive Viewer User Manual’, chapter ‘IBM Cognos TM1’, section ‘Spreading Type’ the spreading type ‘Clear’ is described. This Spreading Type is no longer available. The description should be ignored.

Security and Executive Viewer Portlets

From the information provided in the chapter ‘Executive Viewer Portlets’ in the ‘Executive Viewer Server Installation and Configuration Guide’, it is not clear how to set up the security.

You will need to do the following in order to set up security for Executive Viewer Portlets:• Executive Viewer Portlets can only be used with the IBM Cognos 8 Security Provider. For

information on how to setup the IBM Cognos 8 Security Provider, refer to the chapter ‘Security Providers’ in the ‘Executive Viewer Server Installation and Configuration Guide’.

In order to set up the IBM Cognos 8 Security Provider you have to know where to find the dispatcher location. The following steps are should be performed by the IBM Cognos 8 Administrator:

1.Open ‘IBM Cognos Configuration’.2.Click ‘Environment’.3. In the ‘Gateway’ section, go to ‘Dispatcher Location’.

Here you will find the dispatcher location.

• In IIS make sure the Virtual Directory of the Web Service is set to ‘Anonymous access’.Refer to the ‘Executive Viewer Server Installation and Configuration Guide’, chapter ‘Executive Viewer Client’, section ‘Create a Virtual Directory (HTTP, IIS) Example’.

• When you use a TM1 Data Source that is configured for IBM Cognos 8 Security, the administrator of that Data Source has to be a IBM Cognos 8 user. The User Name of the OLAP Administrator for that Data Source has to be configured as follows: <Namespace>\<UserName>. Refer to the ‘Executive Viewer Server Installation and Configuration Guide’, chapter ‘Executive Viewer Explorer’, section ‘Data Source Item’.

For step by step instructions on how to use Executive Viewer Portlets in Cognos 8 with IBM Cognos 8 Security, refer to Appendix C.

IBM Cognos 8 Security Provider

The ‘Executive Viewer Server Installation and Configuration Guide’, chapter ‘Security Provider’, section ‘IBM Cognos 8 Security Provider’ is missing system requirements. The following information is missing:

New Features Guide 7

Page 8: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

System requirements: • IBM Cognos 8.4 needs to be installed.

CAMpassport value missing from <ClientLogon> tag example

The ‘Executive Viewer Server Installation and Configuration Guide’, chapter ‘Configuration Files’, section ‘EVServer.exe.config File’ is missing the CAMpassport value for the <ClientLogon> tag example. Please see the correct example below.

• <add key=”ClientLogon” value=”SessionID;WIA;Forms;CAMpassport”/>Restricts the Logon type of a client; if nothing specified the client is not restricted, otherwise the client is only allowed to logon in the specified ways.Possible values are SessionID, WIA, Forms and CAMpassport separated by a semicolon.When an invalid type is specified, the server will not start.

URL API exceptions not complete

The ‘Executive Viewer Server Installation and Configuration Guide’, chapter ‘URL API’, section ‘URL API - Exceptions’ is missing some error messages. Please see the list below for all error messages.

In case of an error, the URL API will display this error.The following errors are possible:

• The URL API Method ‘<Action Name>’ is not supported;• The RenderType ‘<rendertype>’ is not supported;• The parameter ‘<paramname>’ is not specified. This parameter should be specified when

calling the requested Method ‘<Action Name>’;• The URL API could not create a Session. Please check the specified parameters in the url

and the configuration of the server.• Missing parameter: UpdatePreload must be called with either an item or a valid

DataSourceType.• Unsupported ItemType: The Item ‘<itempath>’ having ItemType ‘<itemtype>’ is not

supported for the specified URL API Action ‘<Action Name>’.• Invalid Image format: Supported file types are 'jpeg', 'gif' and 'bmp'.• Invalid Item Status: The Item Status of the specified Item ‘<itempath>’ is invalid.• No Item Data: The specified Item ‘<itempath>’ does not contain any Item Data.• Invalid list specified.• The XSLT Transformation failed. Additional Information: <additionalinfo>.• The specified Xslt file location did not contain the ‘.xslt’ file extension.• The specified Render Option Value is not supported for this Render Option.

The possible exceptions defined by the ‘Render’ Action, can also occur when using the URL API. The possible exceptions defined by the ‘UpdatePreload’ Action, can also occur when using the URL API.Consult the Executive Viewer Server API Reference for an overview of these errors.

New Features Guide 8

Page 9: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Appendix A: Render Action Specific Options

New Features Guide 9

Page 10: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

URL API Syntax: Action Specific URL API Options - Render

Render Action Specific OptionsEntering a URL which triggers the Render Action will result in an HTML page that contains Executive Viewer Client showing the requested Item. If Executive Viewer Client is not installed on your machine, you will be prompted to install the software. See the chapter ‘Executive Viewer Client’ for explanation about installation of the Client.

The following parameter apply to the Render Action:

Rendertype• RenderType: The type the View has to be rendered in.

Possible values:ActiveXIf the RenderType is set to ActiveX, the URL API returns an HTML page that contains the Executive Viewer Client that shows the requested Item.XMLIf the RenderType is set to XML, the URL API returns XML or transformed XML. If you do not specify an XSLT parameter or if you specify an empty XSLT parameter, the URL API returns an XML file. This XML file contains the following information:

<EVClient> <object displayMode> <id /> <name /> <width /> <height /> <codeBase /> <classId /> <server /> <protocol /> <port /> <sessionId /> <help /> <theme /> <enableToolbar /> <!-- DisplayMode specific: View --> <defaultView /> <enableTabBar /> <enableViewsButton /> <viewLocations /> </object>

</EVClient>GridXMLIf the RenderType is set to GridXML, the URL API returns an XML or transformed XML representation of a View Item's Grid.

Optional: Yes;Default value: If there is no RenderType specified the RenderType is set to ActiveX.

If the RenderType is set to either XML or GridXML the URL API is able to transform XML. To retrieve transformed output from the URL API, you have to add an extra XSLT parameter to the URL API Request. See the XSLT parameter explanation in this section for more information.

If the RenderType is set to ActiveX, the returned HTML page is created by using the Default.xslt. This Default.xslt file is available in the installation directory of the Web Service. The default location of the ‘Default.xslt’ file is ‘C:\Program Files\IBM Cognos

New Features Guide 10

Page 11: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

TM1\Executive Viewer\Server\WebService\XSLT’. It is not possible to specify an additional XSLT parameter if the RenderType is set to ActiveX.

XSLT• XSLT: This URL API parameter specifies which XSLT needs to be used during the XSLT

Transformation.The value of the XSLT parameter will only be interpreted when the RenderType parameter has been set to XML or GridXML. See the RenderType parameter explanation in this section for more information.

Possible values:An XSLT file name.If you specify the XSLT file name, the URL API loads the file from the default XSLT directory.When the XSLT file name is specified, a user does not have to add the ‘.xslt’ extension to the file name. The default XSLT directory is set to ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService\XSLT’. You can change the default XSLT directory by setting the ‘XsltPath’ in the ‘web.config’ file. The default location of the ‘web.config’ file is ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService\’. If the XsltPath has been set, the URL API checks this directory for the specified XSLT.Add the following code to the ‘configuration’ section of the Web Service's ‘Web.Config’ file to set the XsltPath:

<configuration> <appSettings> <add key=”XsltPath” value=”Your XSLT Path”/> </appSettings> </configuration>

An XSLT file location. When you specify the XSLT file location, you must also specify the ‘.xslt’ extension like:

‘http://localhost/EVServer?Toolbar=true&RenderType=Xml&Xslt=http://localhost/EVServer/Xslt/MyXslt.xslt’

or

‘http://localhost/EVServer?Toolbar=true&RenderType=Xml&Xslt=C:\Temp\MyXslt.xslt’.

It is possible to specify:- a local directory, like ‘c:\’; - a web location: ‘http://’; - a relative path to the XSLT path.

The relative path is derived from the default XSLT directory. The default XSLT directory is set to ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService\XSLT’. You can change the default XSLT directory by specifying the ‘XsltPath’ in the ‘web.config’ file. The default location of the ‘web.config’ file is ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService\’. If this XsltPath has been set, the URL API checks this directory for the specified XSLT.

Add the following code to the ‘configuration’ section of the Web Service's ‘Web.Config’ file to set the XsltPath:

New Features Guide 11

Page 12: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

<configuration> <appSettings> <add key=”XsltPath” value=”Your XSLT Path”/> </appSettings> </configuration>

Please make sure the user has sufficient rights to access the specified XSLT file.Optional: Yes;Default value: empty. If the XSLT parameter is empty, XML will be returned by the URL API. For more information see the RenderType parameter;

Depending on the RenderType, a set of Render Options is supported.

RenderType is set to ActiveX or XML• Item: The Item which needs to be opened by Executive Viewer Client.

Possible Values:A path to an ItemA name of an Item if this Item is located in the Root Folder. For explanation about the Root Folder, see the chapter ‘Executive Viewer Explorer’.

In both cases this Item needs to have the ItemType View or Folder. If a Folder Item is specified, Executive Viewer Client will open all Views located in this Folder.Optional: Yes;Default Value: If there is no Item specified, Executive Viewer Client is being rendered without an ActiveView;Syntax: In contrast to other URL API Options it is possible to specify an Item without entering the Option by adding ‘Item=’ to the HTTP Request. This Item needs to be defined immediately after the ‘?’ character. For example:http://<ServerName>/EVServer?<ItemPath>has the same result as:http://<ServerName>/EVServer?Item=<ItemPath>.

• ControlID: The ID of the <Object> tag that contains the Executive Viewer ControlPossible values: A string representing the ID of the ActiveX Object;Optional: Yes;Default value: ‘EVObject’.

• DisplayMode: The type of Control used to show the ViewsPossible values: View is the only supported value.Optional: Yes;Default value: View.

• TabBar: Option whether to show the Tab Bar or notPossible values: True or False;Optional: Yes;Default value:

In case the DisplayMode is set to ‘View’ the default value is False.• TabBarPosition: Option to define the position of the Tab Bar

Possible values: Top, Bottom or Theme;Optional: Yes;Default value: If there is no TabBarPosition specified, the position of the Tab Bar is defined by the Executive Viewer Theme. For an overview of the Executive Viewer Themes and their corresponding positions of the Tab Bar, see the table below.

Theme Position of the Tab Bar

Classic bottom

Sky top

Ocean top

Desert top

New Features Guide 12

Page 13: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

• Toolbar: Option whether to show the Toolbar or notPossible values: True or False;Optional: Yes;Default value:

In case the DisplayMode is set to ‘View’ the default value is False.• Theme: The Theme to use in Executive Viewer

Possible values: Classic, Sky, Ocean, Desert, Forest, Olive, Silver, Cognos;Optional: Yes;Default value: empty, which will result in the ‘Classic’ theme;

• CreateControlUriPossible values: A valid URI which represents the location of the CreateControl.js file. This file is introduced on behalf the ActiveX Control Activation. For more information see Chapter 'Executive Viewer Client' section 'ActiveX Control Activation';Optional: Yes;Default value: '/EVServer/CreateControl.js'.

• Culture: This Render Option sets the Culture of Executive Viewer Client.Possible values: en-US (English), de-DE (German), fr-FR (French), da-DK (Danish), nl-NL (Dutch), es-ES (Spanish), zh-CN (Chinese), ja-JP (Japanese)Optional: Yes;Default value: The Culture of the Executive Viewer Server Session; The default Executive Viewer Server Culture will be used;

• Help: The Help Render Option represents a path to a help file or a set of help files in Executive Viewer Client. Once this Render Option is set, a 'Help' button is added to the toolbar.

Possible value: You can add any URL to an HTML page here. The only condition is that the URL must be valid. This can be your own HTML page as well as the IBM Cognos TM1 Executive Viewer User Manual, which is available as a 'Webhelp'. You can find this directory on the CD or download it at support.cognos.com.Example:http://<Servername>/EVServer?DisplayMode=View&Toolbar=true&Help=http://<Servername>/EVExplorer/WebHelp/index.htm

The following Options are dependent of the chosen ‘DisplayMode’:• Viewlocations: Option which specifies the exact location where the Views are stored in the

RepositoryPossible values: A string that contains a valid View Location. The logical name and the location (path) are separated by an '=' character. In order to specify more than one View location, the entries need to be separated by a semi-colon.The syntax is for example:Sales Views = /Sales/SalesView; Marketing Views = /Marketing/MarketingFolderOptional: Yes;Default value: empty;Dependent on: only available for the DisplayMode ‘View’.

• ViewsDialog: Option whether to show the ‘Views’ button on the toolbarPossible values: True or False;Optional: Yes;Default value: True;Dependent on: only available for the DisplayMode ‘View’.

Forest top

Olive top

Silver top

Cognos top

Theme Position of the Tab Bar

New Features Guide 13

Page 14: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

RenderType is set to GridXML• Item: The Item which needs to be opened by Executive Viewer Client.

Possible values:A path to an Item;A name of an Item if this Item is located in the Root Folder. For explanation about the Root Folder, see the chapter ‘Executive Viewer Explorer’.

In both cases this Item needs to have the ItemType View.Optional: No;Default value: Since this parameter is not optional, a default value is not applicable.Syntax: In contrast to other URL API Options it is possible to specify an Item without entering the Option by adding ‘Item=’ to the HTTP Request. This Item needs to be defined immediately after the ‘?’ character. For example:http://<ServerName>/EVServer?<ItemPath>has the same result as:http://<ServerName>/EVServer?Item=<ItemPath>.

• Context: Context of the data as a string. Context represents an XML document that holds the context of the data to be returned. The context can be used to define the Offspread selection of the view.

Possible value:Format of the context XML is as follows:

<root> <context> <dimension>plan_time</dimension> <member>2006</member> </context> <context> <dimension>plan_region</dimension> <member>USA</member> </context> </root>

Optional: Yes;Remark: The value of the Context option is XML. Some characters in this XML need to be encoded when using the URL API. Refer to the section ‘URL API - Encoded Characters’ in the chapter ‘URL API’ of the ‘IBM Cognos TM1 Executive Viewer Server Installation and Configuration guide’.

• DimensionInfo: The status of information for each dimension in the generated XML as a boolean.

Possible values:True: additional information for each member and dimension is generated in the XML;False: additional information for each member and dimension is not generated in the XML.

Optional: Yes;Default value: True.

• Formatting:The status of formatting of a View in the generated XML as a boolean.Possible values:

True: formatting of the View will be included in the generated XML;False: formatting of the View will not be included in the generated XML.

Optional: Yes;Default value: True.

• Offspread: The status of the Offspread in the generated XML as a boolean.Possible values:

True: the Offspread area is generated in the XML;False: the Offspread area is not generated in the XML.

Optional: Yes;Default value: True.

• Table: The status of the table grid in the generated XML as a boolean.

New Features Guide 14

Page 15: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Possible values:True: the table grid is generated in the XML;False: the table grid is not generated in the XML.

Optional: Yes;Default value: True.

New Features Guide 15

Page 16: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Appendix B: System Requirements

New Features Guide 16

Page 17: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

System RequirementsUpgrading to Executive Viewer 9.4As of Executive Viewer 9.4 upgrading from versions older than 5.2 is no longer supported.If you want to upgrade from a version 5.2 or lower to version 9.4, you are advised to first upgrade to version 9.3 and then upgrade to 9.4.

Executive Viewer ServerFor installation of Executive Viewer Server your system should at least meet the following requirements:

Supported OLAP Servers• IBM Cognos TM1, version 9.1 or higher• Hyperion Essbase version 4.01 or higher• Hyperion System 9 BI+ Analytic Services 9.0 or higher• IBM DB2 OLAP Server version 5 or higher• Microsoft® SQL Server™ 2000 Analysis Services (MSAS), service pack 4 or higher• Microsoft® SQL Server™ 2005 Analysis Services (SSAS), service pack 2 or higher• Microsoft® SQL Server™ 2008 Analysis Services (SSAS)• Showcase AS400 OLAP Server version 3.5 or higher

Required software installed• Microsoft® SQL Server™ 2000 service pack 4 or higher OR• Microsoft® SQL Server™ 2005 service pack 2 or higher, in case SQL Server 2005 is set to

be the Catalog Provider or the Log Provider.• Microsoft® SQL Server™ 2008, in case SQL Server 2008 is set to be the Catalog Provider

or the Log Provider.• MySQL, version 5, in case MySQL is set to be the Catalog Provider or the Log Provider. This

also requires the MySQL .NET Connector to be installed• An appropriate ODBC driver, in case ODBC is set to be the Catalog Provider or the Log

Provider.• DB2 Universal Database, version 8 in case DB2 is set to be the Catalog Provider or the Log

Provider. This also requires DB2.NET Data Provider, version 8.1.11.2 or higher to be installed.

• Oracle client 8.1.7 or higher, in case Oracle is set to be the Catalog Provider or the Log Provider.

• IBM Cognos 8.4 in case IBM Cognos 8 Security is set to be the Security Provider.• IBM Cognos TM1, version 9.1 or higher in case TM1 is set to be the Security Provider.• Hyperion Essbase version 4.01 or higher, or Hyperion System 9 BI+ Analytic Services 9.0

or higher, in case Essbase is set to be the Security Provider.• Microsoft® Internet Information Services (IIS) version 5.0 or higher.• .NET Framework 2.0 / 3.0

Supported Operating Systems• Microsoft® Windows® 2000 Server• Microsoft® Windows® XP Professional• Microsoft® Windows Server™ 2003 Standard Edition• Microsoft® Windows Server™ 2003 Standard x64 Edition • Microsoft® Windows Server™ 2003 Enterprise Edition• Microsoft® Windows Server™ 2003 Enterprise x64 Edition• Microsoft® Windows Server™ 2008• Microsoft® Windows Server™ 2008 x64 Edition• Microsoft® Windows Vista™ Business or higher• Microsoft® Windows Vista™ x64 Edition Business or higher

For all Windows versions the latest service pack and all current updates should be installed.

New Features Guide 17

Page 18: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Note: As of Executive Viewer version 9.4, Executive Viewer Server requires GDI+. GDI+ is only required when you use the XML Rendertype format of the Render method. GDI+ is, by default, not available on Windows 2000 and can be installed via the GDI+ redistributable, which can be downloaded from: http://www.microsoft.com/downloads.

System Requirements• Disk space: Approximately 100MB• Memory: Starting from 1024MB• Processor: Pentium 4 or higher

This server must be available to any client that might be using Executive Viewer Client or Executive Viewer Explorer. The server does not need to be on the same machine as the machine running the OLAP Server.

Additional Requirements• For storage of Views and other Items in the Repository additional disk space is needed.• MSXML3 (Microsoft® XML Parser (MSXML)), service pack 4 needs to be installed on the

machine running the setup.• Hyperion Essbase Runtime Client needs to be installed for connecting with Hyperion

Essbase Server, IBM DB2 OLAP Server or Showcase AS400 OLAP Server.• Microsoft® PivotTable® Service (including the Microsoft® Data Access Components

(MDAC)) and Decision Supporting Objects (DSO) need to be installed for connecting with Microsoft Analysis Services 2000.

• The Connectivity Components of Microsoft SQL Server 2005 Analysis Services (SSAS) setup need to be installed for connecting with Microsoft SQL Server 2005 Analysis Services.

• The Connectivity Components of Microsoft SQL Server 2008 Analysis Services (SSAS) setup need to be installed for connecting with Microsoft SQL Server 2008 Analysis Services.

• The TM1 OLE DB Provider needs to be installed for connecting to Cognos TM1.• Memory requirements depend on the number of users, usage, the size of the database

models, the use of Personalized Databases, Interpret and Preload roles.• For Map support, Internet Explorer version 6.0 service pack 2 or higher should be installed

on the machine running Executive Viewer Server software.

ASP.NET Executive Viewer ExplorerFor installation of Executive Viewer Explorer your system should at least meet the following requirements:Required software installed

• The following software needs to be installed on the machine running Executive Viewer Explorer:

.NET Framework 2.0 / 3.0Internet Explorer 6.0 service pack 2 or higherMicrosoft® Internet Information Services (IIS) version 5.0 or higher.

• ASP.NET must be registered in IIS. This is done during the installation routine.• MSXML3 (Microsoft XML Parser), service pack 4 needs to be installed on the machine

running the installation.

Supported Operating Systems• Microsoft® Windows® 2000 Server• Microsoft® Windows® XP Professional• Microsoft® Windows Server™ 2003 Standard Edition• Microsoft® Windows Server™ 2003 Standard x64 Edition• Microsoft® Windows Server™ 2003 Enterprise Edition• Microsoft® Windows Server™ 2003 Enterprise x64 Edition• Microsoft® Windows Server™ 2008• Microsoft® Windows Server™ 2008 x64 Edition• Microsoft® Windows Vista™ Business or higher

New Features Guide 18

Page 19: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

• Microsoft® Windows Vista™ x64 Edition Business or higherFor all Windows versions the latest service pack and all current updates should be installed.

Supported Internet Browsers• Internet Explorer 6.0 or higher

System Requirements• Disk space: Approximately 50MB• Memory: Starting from 512MB• Processor: Pentium 4 or higher• Color depth: 16 bit color depth or higher

Executive Viewer ClientFor installation of Executive Viewer Client 9.4 your system should at least meet the following requirements:Supported Operating Systems

• Microsoft® Windows® 2000 Server• Microsoft® Windows® XP Professional• Microsoft® Windows Server™ 2003 Standard Edition• Microsoft® Windows Server™ 2003 Enterprise Edition• Microsoft® Windows Server™ 2008• Microsoft® Windows® Vista Business or higher

For all Windows versions the latest service pack and all current updates should be installed.

Note: As of Executive Viewer version 9.4, the Executive Viewer Client requires GDI+. GDI+ is, by default, not available on Windows 2000 and can be installed via the GDI+ redistributable, which can be downloaded from: http://www.microsoft.com/downloads.

System Requirements• Disk space: Approximately 10MB• Memory: 512MB• Processor: Pentium 4 or higher• Color depth: 16 bit color depth or higher

Supported Internet Browsers• Microsoft Internet Explorer version 6.0 or higher

Additional Requirements• Installation requires user rights to install and register ActiveX components in the browser

and operating system.• The Pivot Table Services Lite software needs to be installed for connecting to a CUB file (MS

Analysis Services).

Executive Viewer Desktop ExplorerFor installation of Executive Viewer Explorer your system should at least meet the following requirements:

Required software installedThe following software needs to be installed on the machine running Executive Viewer Explorer: • .NET Framework 2.0• MSXML3 (Microsoft XML Parser), service pack 4 or higher

Supported Operating Systems• Microsoft® Windows® 2000 Server• Microsoft® Windows® XP Professional• Microsoft® Windows® XP Professional x64 Edition• Microsoft® Windows Server™ 2003 Standard Edition

New Features Guide 19

Page 20: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

• Microsoft® Windows Server™ 2003 Standard x64 Edition• Microsoft® Windows Server™ 2003 Enterprise Edition• Microsoft® Windows Server™ 2003 Enterprise x64 Edition• Microsoft® Windows Server™ 2008• Microsoft® Windows Server™ 2008 x64 Edition• Microsoft® Windows® Vista Business or higher• Microsoft® Windows® Vista Business x64 Edition or higher

For all Windows versions the latest service pack and all current updates should be installed.

Note: As of Executive Viewer version 9.4, the Executive Viewer Desktop Explorer requires GDI+. GDI+ is, by default, not available on Windows 2000 and can be installed via the GDI+ redistributable, which can be downloaded from: http://www.microsoft.com/downloads.System Requirements

• Disk space: Approximately 50MB• Memory: Starting from 512MB• Processor: Pentium 4 or higher• Color depth: 16 bit color depth or higher

Additional Requirements• Microsoft Internet Explorer version 6.0 32-bit or higher should be installed on a 64-bit

Operating System to be able to open Views.

New Features Guide 20

Page 21: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Appendix C: Executive Viewer Portlets, step by step

New Features Guide 21

Page 22: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Executive Viewer Portlets and IBM Cognos 8 SecurityIntroduction

This document describes how to set up an environment where the IBM Cognos TM1 Executive Viewer 9.4 Portlets, in combination with IBM Cognos 8 Security, connect to a TM1 Data Source.

Prerequisites

The following software has to be installed prior to the instructions provided in the document:• IBM Cognos 8.4• IBM Cognos TM1 Executive Viewer Server 9.4 or higher.

If you want to set up single sign on to a TM1 Data Source using IBM Cognos 8 Security, you will need to install and configure TM1 for IBM Cognos 8 Security. Refer to the ‘IBM Cognos TM1 Installation Guide’, chapter ‘Using IBM Cognos 8 Security with TM1’ for information how to configure TM1 using IBM Cognos 8 Security.

Set up overview

The set up consists of the following parts:• Configuration of Executive Viewer 9.4 Server using IBM Cognos 8 Security• Installation of the IBM Cognos TM1 Executive Viewer 9.4 Portlets• Set up single sign on to a TM1 Data Source using IBM Cognos 8 Security• Add Executive Viewer Portlets to Cognos 8

In the next sections these installation and configuration parts are explained.

New Features Guide 22

Page 23: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Configuration of Executive Viewer 9.4 Server using IBM Cognos 8 Security

There are two ways to install and configure Executive Viewer 9.4 Server using IBM Cognos 8 Security. You can choose either method.

Method 1: Set the IBM Cognos 8 Security Provider during the custom setup of Executive Viewer

Choose this method when you do not want to manually set the IBM Cognos 8 Security Provider in the ‘EVServer.exe.config’ file.

Steps:1.Start the installation of Executive Viewer and choose the Custom setup.2.During the custom setup, you are asked to specify a Security Provider. In case you want

IBM Cognos 8 Security, select the CAM Security (IBM Cognos 8 Security) Provider.

3.Specify the following:

• The Dispatcher Location. You have to change, the filled in, default value if you want to connect to Cognos 8 on another machine;In order to set up the IBM Cognos 8 Security Provider you have to know where to find the

New Features Guide 23

Page 24: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

dispatcher location. The following steps should be performed by the IBM Cognos 8 Administrator:

Open ‘IBM Cognos Configuration’.Click ‘Environment’.In the ‘Other URI Settings’ section, go to ‘Dispatcher URI for external applications’.

If Executive Viewer is installed on another machine than where Cognos 8 is installed, replace ‘localhost’ by the network name or IP address.

• The Namespace ID;In this example we have configured a CAM Namespace with ADVMLAB as Namespace ID. Make sure to use the Namespace ID instead of the namespace Name.

• The User Name;• The Password.

Method 2: Add the IBM Cognos 8 Security Provider in the ‘EVserver.exe.config’

Use this method if you do not want to run the custom setup of Executive Viewer Server. This method can be used in case you have already installed the correct version of Executive Viewer Server and want to change the Security provider and or its settings via the ‘EVServer.exe.config’ file.

New Features Guide 24

Page 25: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Steps:1.Open the ‘EVServer.exe.config’ file (by default in ‘C:\Program Files\IBM Cognos

TM1\Executive Viewer\Server’)2.The following lines have to be added to the <securityProviders> tag of the

‘EVServer.exe.config’ file:<securityProviders> <provider assemblyName="SecurityProviders.CAM" className="Cognos.EV.Server.SecurityProviders.CAM" externalName="CAM"> <dispatcher location="http://Cognos_8_SERVER:9300/p2pd/servlet/dispatch" /> <propagateAnonymousLogon>false</propagateAnonymousLogon> <configurationRoot>.\cogroot</configurationRoot> <passportTimeOut>3600</passportTimeOut> <cookiePath>/cognos8</cookiePath> <pathSeparator>##SEPARATOR##</pathSeparator> <clonePassportAllowed>true</clonePassportAllowed> <namespaces> <namespace id="##NAMESPACEID##"> <validator> <credentials> <credential> <name>IBM Cognos 8 Security username</name> <value>##USERNAME##</value> </credential> <credential> <name>IBM Cognos 8 Security password</name> <value encrypted="true">##PASSWORD##</value> <password>true</password> </credential> </credentials> </validator> </namespace> </namespaces> <builtInAdministrators> <builtInAdministrator namespace="##NAMESPACEID##">##USER_OR_GROUP## </builtInAdministrator> </builtInAdministrators> </provider></securityProviders>

Note: The tags are case sensitive.

A description of each tag is listed next:

• <provider>The <provider> tag of the IBM Cognos 8 Security Provider contains the details needed to make sure this Security Provider operates correctly. One IBM Cognos 8 Security Provider represents one set of users and user groups configured on one or more Cognos 8 servers. If multiple sets of users and user groups need to be represented, separate instances of this Security Provider with unique external names need to be configured. Each instance has to reference to its own set of servers.

• <dispatcher>The <dispatcher> tag contains the location of the Cognos 8 dispatcher. The dispatcher is used to send requests to the Cognos 8 server.

In order to set up the IBM Cognos 8 Security Provider you have to know where to find the dispatcher location. The following steps are should be performed by the IBM Cognos 8 Administrator:

1.Open ‘IBM Cognos Configuration’.2.Click ‘Environment’.

New Features Guide 25

Page 26: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

3.In the ‘Other URI Settings’ section, go to ‘Dispatcher URI for external applications’.

If Executive Viewer is installed on another machine than where Cognos 8 is installed, replace ‘localhost’ by the network name or IP address.

• <propagateAnonymousLogon>The <propagateAnonymousLogon> tag propagates the anonymous settings of the Cognos 8 installation to Executive Viewer. This tag is optional. If you either do not specify the <propagateAnonymousLogon> tag or set it to ‘false’, the anonymous user settings of Cognos 8 are not passed on to Executive Viewer.

• <configurationRoot>The <configurationRoot> tag lets you set an alternative configurationRoot. This tag is optional. If you do not specify the <configurationRoot> tag, the default value ‘cogroot’ will be used.

• <passportTimeOut>The <passportTimeOut> tag lets you set time-out for a passport in seconds. After this time of inactivity the passport is no longer valid. This tag is optional. If you do not specify the <passportTimeOut> tag, the default value ‘3600’ will be used.

• <cookiePath>The path where IBM Cognos 8 Passport cookies should be generated on. These cookies will only be generated when Executive Viewer is on the same path.

• <pathSeparator>The <pathSeparator> tag lets you specify the character for separating user paths. This tag is optional. If you do not specify the <pathSeparator> tag, the default value ‘ \ ’ will be used.

• <clonePassportAllowed>The <clonePassportAllowed> tag lets you specify whether making a clone of a passport is allowed, when a user logs on with that passport. This tag is optional. If you do not specify the <clonePassportAllowed> tag, the default value ‘true’ will be used.

• <namespaces>The <namespaces> tag contains one or more Security Namespaces. Each namespace needs to contain the correct namespace id which corresponds to the namespace id of the namespace that is defined in Cognos 8. You have to specify credentials for all the disclosed

New Features Guide 26

Page 27: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

namespaces. The default Cognos 8 namespace will additionally be disclosed.

By default passwords that are added to the ‘EVServer.exe.config’ file by the Executive Viewer Server setup are encrypted. You are advised to encrypt the passwords if you add additional namespaces to ‘EVServer.exe.config’ file. Passwords can be encrypted with the ‘PasswordEncrypt’ tool. This can be downloaded from the IBM Cognos Resource Center (http://www.ibm.com/software/data/support/cognos_crc.html).

If you don’t have access to the Password Encrypt tool, it’s possible to specify unencrypted passwords by setting the encrypted attribute to ‘false’, but this is not recommended.

In case the Credentials change or expire, for instance when using a IBM Cognos 8 Namespace configured using Active Directory as Name Space Type, please make sure the Password in the EVServer.exe.config file needs to be updated as well.

• <builtInAdministrators>The optional <builtInAdministrators> tag allows certain users or users belonging to certain user groups, to be tagged as built-in administrators. Built-in administrators have full access and control over Executive Viewer Server without having any System or Item Policies specified.

When choosing ‘IBM Cognos 8’ as Security Provider during the setup routine, the system administrators group of the built-in Cognos 8 namespace is added as built-in administrator.

Note: This is similar to Windows’ built-in administrator on the local system who has the same privilege by design. This is to prevent administrators creating a situation where they cannot access Executive Viewer Server.

Note: It is possible to specify more than one Security Provider. For more information on the Configuration of Security Providers, please refer to the chapter ‘Security Providers’ in the ‘Executive Viewer Server Installation and Configuration Guide’.

Check whether IBM Cognos 8 Security Provider is used by Executive Viewer Server

After you have added and configured the IBM Cognos 8 Security Provider, you can test whether the IBM Cognos 8 Security Provider is loaded successfully.

Steps:1.Open the properties of your Executive Viewer Server, via either the Executive Viewer

Explorer or the Executive Viewer Desktop Explorer.2.Disable ‘Automatic Logon’.

3.Select the configured IBM Cognos 8 Security Namespace. In this example it is called ‘CAM’. If the Security Provider is successfully loaded, the Security Provider appears in the list of

New Features Guide 27

Page 28: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Security Namespaces.

If the configured IBM Cognos 8 Security Namespace is not in the list, the following can be the case:

• The EVServer service is not running.• The C8 service is not running.

During the Start of Executive Viewer Server, the Security Providers configured in the ‘EVServer.exe.config’ file are being loaded. If the Cognos 8 Service is not running during the startup of the Executive Viewer Server service, loading of the IBM Cognos 8 Security Provider fails. To solve this problem, restart the Executive Viewer Server service after the Cognos 8 service has started in order to enable Executive Viewer Server to load the IBM Cognos 8 Security Provider successfully. A possible cause of this problem is a restart of the Cognos 8 Machine.

• The IBM Cognos 8 Security Provider is not configured correctly.During the Start of Executive Viewer Server, the Security Providers configured in the ‘EVServer.exe.config’ file are being loaded. If the Security Provider is not configured correctly, an error message will be logged in the Executive Viewer Server Log File. By default this file can be found in C:\Program Files\IBM Cognos TM1\Executive Viewer\Server. For example, an error message can be logged because the credentials provided are not correct. If this is the case please check the configuration in the ‘EVServer.exe.config’ file. For more information on how to configure the IBM Cognos 8 Security Provider please refer to section ‘Configuration of Executive Viewer 9.4 Server using IBM Cognos 8 Security’

New Features Guide 28

Page 29: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Installation of the IBM Cognos TM1 Executive Viewer 9.4 Portlets

This section explains how to install the Executive Viewer Portlets. When opening a View Item in the Executive Viewer Portlet, Executive Viewer Client attempts to install automatically.

System Requirements

The system on which you want to install the Executive Viewer Portlets needs to have the following software installed:

• IBM Cognos 8.4;• Executive Viewer 9.4 with the IBM Cognos 8 Security Provider configured;• In IIS make sure the Virtual Directory Security of the EVServer Web Service is set to

‘Anonymous access’. By default the EVServer setup sets the Virtual Directory of the EVServer Web Service to WIA.

32-bit

The Executive Viewer Portlets are only available as a 32-bit version. The 32-bit version can be used on a 64-bit machine when using a 32-bit version Microsoft® Internet Explorer.

Obtain the software

You can obtain the software needed for the installation of the Executive Viewer Portlets in two ways:

• Download the Executive Viewer Portlets installation software from our Support Center at http://www.ibm.com/software/data/support/cognos_crc.html;

• Install the Executive Viewer Portlets installation software from either the 32-bit or the 64-bit version CD.

From CD

If you insert the CD, you are presented with the next options:• Install Software;• Access User Manuals;• More About Cognos ULC, an IBM Company;• Exit.

If it does not appear, go to your CD folder in Microsoft® Windows® Explorer and double click on ‘Autorun.exe’.

Choose ‘Install Software’ - ‘C8 Executive Viewer Portlets’ to start the installation of the Executive Viewer Portlets.

Note: In Windows Explorer, you can also choose the subdirectory ‘C8 Executive Viewer Portlets’ on the CD and double click on ‘issetup.exe’.

You must install the Executive Viewer Portlets in the same directory as the installation directory for IBM Cognos 8, on a computer that is running a supported Windows server. In addition, the Executive Viewer Web server must be on the same computer.

Steps to install the Executive Viewer Portlets:1.Stop the IBM Cognos 8 service.

New Features Guide 29

Page 30: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

2.Run ‘issetup.exe’ that you obtained from either the CD or from http://www.ibm.com/software/data/support/cognos_crc.html.

3.On the Welcome page, select the language to use for the installation and click Next.Regardless of the language that you select for the installation wizard, all languages for the product are installed.

4.Accept the license agreement and click ‘Next’.5.On the Installation Location page, select the directory where the IBM Cognos 8 is installed

and click ‘Next’.6.When you are prompted about installing in the same location as a previous installation click

‘Yes’.7.When you are prompted about creating a backup of all replaced files, click ‘Yes’.8.On the ‘Shortcut Folder’ page, type the name that you want the shortcut to use and then

click ‘Next’.9.Review the installation summary and then click ‘Next’.

An Installation Progress page appears while components are installed.10.On the ‘Finish’ page, view the log files if required and then click ‘Finish’.11.Start the IBM Cognos 8 service.

New Features Guide 30

Page 31: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Set up single sign on to a TM1 Data Source using IBM Cognos 8 Security

Achieving single sign on to a TM1 Data Source that uses IBM Cognos 8 Security consists of the next procedures.

Configure TM1 to use IBM Cognos 8 Security

Refer to the ‘IBM Cognos TM1 Installation Guide’, chapter ‘Using IBM Cognos 8 Security with TM1’ for information on how to configure TM1 using IBM Cognos 8 Security.

Ensure the Data Sources in Executive Viewer are configured correctly

In order to ensure the Data Sources in Executive Viewer are configured correctly follow the next steps.

Steps:1.For this example we assume the following situation is configured in IBM Cognos

Configuration:

New Features Guide 31

Page 32: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

2.In Executive Viewer Explorer make sure that OLAP Administrator Username of the TM1 Data Source, that is configured to use IBM Cognos 8 Security, is defined as:<Namespace name>\Admin User Name (CAM\Administrator in this example)

3.Make sure this TM1 user has sufficient rights on the specified TM1 Data Source, that is configured for IBM Cognos 8 Security. See the next section for information how to specify this.

The TM1 OLAP Administrator has to have access to the Data Source in TM1

In order to give the TM1 OLAP Administrator access to the Data Source in TM1 follow the next steps.

Steps:1.Start TM1 Architect.2.Right-click on the TM1 server and select Security.3.Add via the Security dialog a user who acts as the TM1 OLAP Administrator who has access

to the TM1 Data Source as follows:<Namespace name>\Admin User Name (CAM\Administrator in this example)

Please make sure the used Namespaces are configured correctly in TM1. Refer to the ‘TM1 Installation Guide’, chapter ‘Using IBM Cognos 8 Security with TM1’ for information how to configure TM1 using IBM Cognos 8 Security.

4.Specify the correct rights for this user.

Test whether the Data Source settings are correct

In order to successfully use single sign on, the Data Source settings in Executive Viewer need to be correct. You can test this by performing the next steps.

New Features Guide 32

Page 33: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Steps:1.Start Executive Viewer Explorer or Executive Viewer Desktop Explorer.2.Right-click on the TM1 Data Source and select ‘Database Wizard’.

3. If required, enter the Data Source credentials.4. If a list of Databases to be registered appears, the Data Source settings are correct and

thus the Data Source is valid.

5.An error will be displayed when the Data Source Settings are not correct.

New Features Guide 33

Page 34: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

Add Executive Viewer Portlets to Cognos 8When you have installed and configured TM1 and the Executive Viewer Portlets you can add an Executive Viewer Portlets to a page in Cognos 8. For more information on Executive Viewer Portlets and setting up Executive Viewer Portlet configuration refer to chapter ‘Executive Viewer Portlets’ in the ‘Executive Viewer Server Installation and Configuration Guide’.

Steps:1.Start Executive Viewer Explorer and create a Data Source, Database and a View that

connect to TM1.

2.Start Cognos 8 and create a page in Cognos 8 and try to add the Executive Viewer Portlets.3.For example add the View Selector and Executive View Portlets to the portlet page. Please

select the correct portlet from the available list of portlets. The View Selector and Executive View Portlets are available from the IBM Cognos TM1 Executive Viewer Portlet group.

If the ‘IBM Cognos TM1 Executive Viewer’ portlet group is not available, after the Executive Viewer Portlets have been installed, restart the Cognos 8 service.

4.For the created page, add the View Selector and Executive Viewer Portlet.

New Features Guide 34

Page 35: Cognos TM1 ExecutiveViewerpublic.dhe.ibm.com/software/data/cognos/documentation/... · 2009-01-19 · This manual is designed for people who want to embed Executive Viewer Client

IBM Cognos TM1 Executive Viewer version 9.4 MR1New features

November 2008

5.In the properties of the View Selector Portlet, specify the Executive Viewer Server Location. In this example it is ‘EVServer’.

6. In the properties of the Executive Viewer Portlet, specify the following:The Executive Viewer Server Location. In this example it is ‘EVServer’.Enable the Event Setting ‘Select View’ in order to receive the Select View event from the View Selector Portlet.

7.Open the View by clicking the TM1 View in the View Selector Portlet.

8.The TM1 View is opened in the Executive Viewer Portlet.

Troubleshooting

If you receive the following error message:‘(401)Unauthorized’, In IIS make sure the Virtual Directory of the Web Service is set to ‘Anonymous access’.

New Features Guide 35