Cognos TM1 ExecutiveViewer -...

IBM® Cognos® TM1® Executive Viewer

SERVER INSTALLATION & CONFIGURATION GUIDE

Server Installation and Configuration Guide 2

Product InformationThis document applies to IBM® Cognos® TM1® Executive Viewer 9.4 and may also apply to subsequent releases. To check for newer versions of this document, visit the Cognos Software Services Web site (support.cognos.com).

CopyrightCopyright © 2008 Cognos ULC, an IBM Company. All rights reserved.

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

Table of Contents

1 Introduction......................................................................................................... 8Introduction - General .......................................................................................... 9Executive Viewer Architecture.............................................................................. 11

2 Before Installation ............................................................................................. 13System Requirements......................................................................................... 14Check What’s New.............................................................................................. 18Backwards Compatibility ..................................................................................... 19Installation of Executive Viewer on Windows 2008 .................................................. 20Installation of Executive Viewer on Windows Vista .................................................. 21

3 Installation of the Software ............................................................................... 22How to Start Installation ..................................................................................... 23Installation - General.......................................................................................... 24Installation - Express.......................................................................................... 25Installation - Custom .......................................................................................... 27Change the Account to run the Cognos TM1 Executive Viewer Service ....................... 32NT Security - Replace Process Token .................................................................... 33NT Security - Impersonation................................................................................ 34NT Security - Local Administrators........................................................................ 35NT Security - Log On as a Service ........................................................................ 36NT Security - Log on locally ................................................................................. 37

4 Connect to Executive Viewer Server................................................................... 38Connect to Executive Viewer Server...................................................................... 39Log off.............................................................................................................. 44

5 Executive Viewer Explorer ................................................................................. 45Introduction ...................................................................................................... 46Items ............................................................................................................... 50Add and Manage Items ....................................................................................... 52Folder Item ....................................................................................................... 53Data Source Item............................................................................................... 54Database Item................................................................................................... 56View Item ......................................................................................................... 58Image Item....................................................................................................... 60Custom Item ..................................................................................................... 62Shortcut Item.................................................................................................... 64Database Wizard................................................................................................ 66Item Security - Introduction ................................................................................ 67Sessions ........................................................................................................... 68Item Permissions ............................................................................................... 69Item Roles ........................................................................................................ 70Item Policies...................................................................................................... 71User-defined and System Properties ..................................................................... 73

6 Manage Executive Viewer Server ....................................................................... 76General ............................................................................................................ 77Version Information............................................................................................ 78System Security................................................................................................. 79System Security - Introduction ............................................................................ 80Evaluation Roles and Policies ............................................................................... 81Sessions ........................................................................................................... 83System Permissions ........................................................................................... 84


System Roles .................................................................................................... 86System Policies.................................................................................................. 87Accounts........................................................................................................... 88Activity & Log - Active Sessions............................................................................ 89Activity & Log - View Log .................................................................................... 90Settings - Search Logic ....................................................................................... 93Process Distribution............................................................................................ 94

7 Providers - Introduction..................................................................................... 98What is a Provider? ............................................................................................ 99Connect Executive Viewer Server to a Provider..................................................... 100Add a Provider to Executive Viewer Server .......................................................... 101

8 Catalog Providers............................................................................................. 102Catalog Provider - Introduction .......................................................................... 103SQL Server Catalog Provider.............................................................................. 104MySQL Catalog Provider.................................................................................... 105ODBC Catalog Provider ..................................................................................... 106DB2 Catalog Provider........................................................................................ 107Oracle Catalog Provider..................................................................................... 109

9 Security Providers............................................................................................ 110Security Providers - Introduction ........................................................................ 111CAM Security Provider ...................................................................................... 112TM1 Security Provider....................................................................................... 114Windows Integrated Security Provider................................................................. 116Forms Security Provider .................................................................................... 117Anonymous Security Provider ............................................................................ 120Essbase Security Provider ................................................................................. 121

10 Log Providers ................................................................................................... 123Log Providers - Introduction .............................................................................. 124Event Log Provider ........................................................................................... 127XML Log Provider ............................................................................................. 128Mail Log Provider ............................................................................................. 129SQL Server Log Provider ................................................................................... 130MySQL Log Provider ......................................................................................... 132ODBC Log Provider........................................................................................... 134DB2 Log Provider ............................................................................................. 136Oracle Log Provider .......................................................................................... 138

11 Executive Viewer Server API............................................................................ 139Executive Viewer Server API - Introduction.......................................................... 140’CreateSession’ Method..................................................................................... 141

12 URL API ........................................................................................................... 142URL API - Introduction ...................................................................................... 143HTTP Handler .................................................................................................. 144URL API Syntax - General.................................................................................. 145URL API Syntax: Action Specific URL API Options - Render..................................... 147Render Action Examples.................................................................................... 151URL API Syntax: Action Specific URL API Options - UpdatePreload .......................... 152UpdatePreload Action Examples ......................................................................... 153URL API Syntax: Action Specific URL API Options - Image...................................... 154Image Action Examples..................................................................................... 155URL API Syntax: Action Specific URL API Options - CustomItem ............................. 156CustomItem Action Examples ............................................................................ 157URL API Syntax: Action Specific URL API Options - ListItems.................................. 158


URL API - Encoded Characters ........................................................................... 163URL API - Exceptions ........................................................................................ 165URL API:Exceptions .......................................................................................... 165Exceptions ...................................................................................................... 165

13 Configuration Files ........................................................................................... 166Configuration Files - Introduction ....................................................................... 167‘EVServer.exe.config’ File .................................................................................. 168

14 Executive Viewer Client.................................................................................... 172Introduction to Executive Viewer Client ............................................................... 173Installation when opening a View in EV Explorer................................................... 174Installation from a link within an HTML page........................................................ 175Security Settings in Internet Explorer ................................................................. 178ActiveX Control Activation ................................................................................. 179Create a Share (File Access) Example ................................................................. 181Create a Virtual Directory (HTTP, IIS) Example .................................................... 182

15 Executive Viewer Portlets ................................................................................ 185Introduction .................................................................................................... 186Installation of the Executive Viewer Portlet .......................................................... 187Removal of the Executive Viewer Portlet.............................................................. 189User Reference for Portal Services ...................................................................... 190Enable Communication Between Executive Viewer Portlets..................................... 194

16 Executive Viewer Language Editions ................................................................ 195Available Language Editions............................................................................... 196Language EV Client in Executive Viewer Explorer .................................................. 197

17 Maps ................................................................................................................ 198Introduction Maps ............................................................................................ 199Directory Structure........................................................................................... 200Maps:Directory Structure .................................................................................. 200Libraries, Layers and Shapes ............................................................................. 201Mapping File .................................................................................................... 202Tag Reference ................................................................................................. 204More Examples ................................................................................................ 206Log File........................................................................................................... 208

18 Ports and Protocols.......................................................................................... 209Communication Over HTTP Protocol .................................................................... 210Ports .............................................................................................................. 212

19 Updates and Upgrades ..................................................................................... 214Upgrade from Older Versions to Version 9.1......................................................... 215Update Executive Viewer Client .......................................................................... 216Executive Viewer Client 9.3 ............................................................................... 217

20 Removing the Software.................................................................................... 218Removing Executive Viewer ............................................................................... 219Removing Executive Viewer Client ..................................................................... 220

21 Hyperion Essbase............................................................................................. 221dV-Connect for Hyperion Essbase ....................................................................... 222EV-Connect for Hyperion Essbase ....................................................................... 222Essbase Runtime Clients ................................................................................... 223Essbase Data Source Settings............................................................................ 224Essbase Database Settings ................................................................................ 226


22 IBM Cognos TM1 .............................................................................................. 227EV-Connect for Cognos TM1 .............................................................................. 228Cognos OLEDB Provider .................................................................................... 229TM1 Data Source Settings ................................................................................. 230TM1 Database Settings ..................................................................................... 231TM1 Aliases ..................................................................................................... 232

23 MS Analysis Services........................................................................................ 233EV-Connect for Microsoft Analysis Services .......................................................... 234Microsoft Analysis Services 2000 ........................................................................ 235Microsoft SQL Server 2005 Analysis Services ....................................................... 236NT Security - OLAP Administrators...................................................................... 237Windows Integrated Authentication .................................................................... 238MS Analysis Services Data Source Settings .......................................................... 239Option ‘Provider Specific’................................................................................... 240MS Analysis Services Database Settings .............................................................. 241

24 Executive Viewer Server - Detailed .................................................................. 242

25 Executive Viewer Desktop Explorer.................................................................. 244Introduction .................................................................................................... 245Installation...................................................................................................... 246Language........................................................................................................ 248Connect to Executive Viewer Server.................................................................... 249Starting Executive Viewer Desktop Explorer......................................................... 253Add a Server ................................................................................................... 254Items ............................................................................................................. 255Add Items....................................................................................................... 257Manage Items ................................................................................................. 258Open Items ..................................................................................................... 259Folder Items.................................................................................................... 260Data Source Items ........................................................................................... 261Data Source Items ........................................................................................... 261Database Items ............................................................................................... 263View Items...................................................................................................... 265View............................................................................................................... 265Image Items ................................................................................................... 266Custom Item ................................................................................................... 268Shortcut Item.................................................................................................. 270Database Wizard.............................................................................................. 272Item Security .................................................................................................. 274Sessions ......................................................................................................... 275Item Permissions ............................................................................................. 276Item Roles ...................................................................................................... 278Item Policies.................................................................................................... 281User Properties and System Properties................................................................ 287Manage Executive Viewer Server........................................................................ 291Warnings and Version Information...................................................................... 292System Security............................................................................................... 293System Security - Introduction .......................................................................... 294Evaluation Roles and Policies ............................................................................. 295Sessions ......................................................................................................... 299System Permissions ......................................................................................... 300System Roles .................................................................................................. 302System Policies................................................................................................ 304Accounts......................................................................................................... 306Active Sessions................................................................................................ 307View Log......................................................................................................... 308


Settings - Search Logic ..................................................................................... 311Process Distribution.......................................................................................... 313Removing Executive Viewer Desktop Explorer ...................................................... 319

26 Appendices ...................................................................................................... 320Directory and Registry Structure Executive Viewer................................................ 321Directory and Registry Structure Executive Viewer Client....................................... 325Directory and Registry Structure Executive Viewer Desktop Explorer ....................... 326dataSourceSettings .......................................................................................... 327

Index............................................................................................................. 339


1 Introduction

Server Installation and Configuration Guide 8 1 Introduction

Introduction - General

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

Executive Viewer Server is a layer between Executive Viewer Client and your OLAP Server . This means Executive Viewer Clients connect to the OLAP Server through Executive Viewer Server.

Executive Viewer Server contains a Repository (which is a database) with so called ‘Items’. Within Executive Viewer Server it is possible to set security and logging.Executive Viewer Explorer is an ASP.NET application that can be used to manage and configure Executive Viewer Server.Executive Viewer Client can be used within Executive Viewer Explorer, or can be embedded in a container application or website. Executive Viewer Client uses the Item Type ‘View’, showing the data stored in the OLAP database.Executive Viewer Desktop Explorer is a client application for Executive Viewer Server. Executive Viewer Desktop Explorer creates a virtual folder in Windows Explorer called ‘My Executive Viewer’. In this folder the user can browse all the Executive Viewer Items in Windows Explorer style.

For an overview of the available Properties, Methods and Events (API) for Executive Viewer Client, consult the ‘IBM Cognos TM1 Executive Viewer Integration Guide’.For an overview of the Executive Viewer Server’s Web Service API, consult the ‘Executive Viewer Server API Reference’.

We advise you to read the chapter ‘Before Installation’ before you install Executive Viewer. You can see what preparation you should take to make the installation run well and complete.


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 documention on the Cognos Software Services Web site (http://support.cognos.com). 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 Integration Guide

This manual is designed for people who want to embed Executive Viewer Client 9.4 ViewCtrl Control 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.


Executive Viewer Architecture

Executive Viewer Server is a layer between Executive Viewer Client and your OLAP Server.Executive Viewer Explorer is an ASP.NET based application that can be used to manage and configure Executive Viewer Server. With Executive Viewer Explorer you can configure multiple Executive Viewer Servers from anywhere on the network.Executive Viewer Explorer and Executive Viewer Desktop Explorer use Remoting or the Web Service API. This API is open and accessible.

This image shows a simplified overview of the Executive Viewer architecture:

Executive Viewer Server contains a Repository (which is a database) with so called ‘Items’. Items can be of the Type ‘View’, ‘Database’, ‘Data Source’, ‘Folder’, ‘Image’ or ‘Shortcut’. The Catalog Provider stores the Repository.The Type ‘View’ contains the view of the data stored in the OLAP database. A View connects to a Database, a Database connects to a Data Source. Items can be organized in a Folder structure. This facilitates the overview of the Executive Viewer implementation and makes it easier to perform backup procedures, maintenance and migration from one (test) environment to another. After installation, a default Folder structure is created, to help you to get started organizing Items.

Security information is set in the Repository. Both security on Items and the security to manage Executive Viewer Server can be set. Because of this security end-users can use Executive Viewer Explorer as well as the system administrator who configures Executive Viewer Server. The security set determines what a user is allowed to see and manage.

The Executive Viewer Server Security model makes it possible to authenticate a user on Executive Viewer Server and on the OLAP database. Executive Viewer Server can use multiple authentication schemes to achieve this (for example Windows or Essbase security). This security model is open and extendable.Executive Viewer Server has a log possibility. It is possible to decide what, when, how and where to log. The log possibility is open and extendable.


Executive Viewer Client can be used within Executive Viewer Explorer, or can be embedded in a container application or website. Executive Viewer Client uses the Item Type ‘View’, which contains the view of the data stored in the OLAP database.

The URL API works directly against Executive Viewer Server. To open a View in Executive Viewer, users can type a URL in the address bar of Microsoft® Internet Explorer®.


2 Before Installation

Server Installation and Configuration Guide 13 2 Before Installation

System Requirements

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

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 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• Microsoft® Windows Vista™ x64 Edition Business or higher


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


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


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 and fixes

In our Support Center at support.cognos.com you can download New Feature guides and Fix Lists. These provide the new features and fixed issues for the current and previous versions of Executive Viewer Server, Executive Viewer Client and Executive Viewer Desktop Explorer you are about to install. This will help you decide if you want to install or upgrade to a newer version of Executive Viewer.


Backwards Compatibility

Before you install a version of Executive Viewer, or before you upgrade, be aware of the backwards compatibility of Views.

If you choose to save the View, the View will be saved with the properties of the currently used version of Executive Viewer.This means it is now impossible to open the View with an older version of Executive Viewer Client.

The View locations and the Views will not change when you install a newer version of Executive Viewer Server and/or Executive Viewer Client.It is possible to connect to an Executive Viewer Server with a newer version of Executive Viewer Client. It is not possible to connect to an Executive Viewer Server with an older version of Executive Viewer Client.

When using Executive Viewer Client 9.4 or higher is not possible to connect to an Executive Viewer Server of a version prior to 9.4.

1.Dialog in which you can choose to save the View


Installation of Executive Viewer on Windows Server 2008

If you want to install Executive Viewer on a Windows Server 2008 machine, you have to enable some settings in Windows Server 2008 that are by default disabled. These include the Web Server role and .NET Framework 3.0.

Steps to add the Web Server role on Windows Server 2008:1.Open Server Manager.2.Select ‘Roles’ - ‘Add Roles’.3.Select the Web Server role with the following Role Services:

‘Web Server’ - ‘Application Development’ - ‘ASP.NET’; ‘Web Server’ - ‘Security’ - ‘Windows Authentication’; ‘Management Tools’ - ‘IIS 6 Metabase compatibility’.

Note: Include required role services when asked.

Steps to add .NET Framework 3.0 on Windows Server 2008:1.Open Server Manager.2.Select ‘Features’ - ‘Add Features’.3.Select the ‘.NET Framework 3.0 Features’ - ‘.NET Framework 3.0’.


Installation of Executive Viewer on Windows VistaIf you want to install Executive Viewer on a Windows Vista machine, you have to enable some settings in Windows Vista that are by default disabled.

Steps to enable the by default disabled features on Windows Vista:1.Open the ‘Control Panel’.2.Click ‘Programs’.3.Click ‘Turn Windows features on or off’ in the group ‘Programs and Features’.4.Enable the next features:

‘Internet Information Services’;‘Internet Information Services’ - ‘World Wide Web Services’ - ‘Application Development Features’ - ‘ASP.NET’;Note: this will also include other options.‘Internet Information Services’ - ‘World Wide Web Services’ - ‘Security’ - ‘Windows Authentication’;‘Internet Information Services’ - ‘Web Management Tools’ - ‘IIS 6 Management Compatibility’ - ‘IIS Metabase and IIS 6 configuration compatibility’;


3 Installation of the Software

Server Installation and Configuration Guide 22 3 Installation of the Software

How to Start Installation

This chapter explains how to install Executive Viewer Server and Executive Viewer Explorer. When opening a View Item in Executive Viewer Explorer, Executive Viewer Client attempts to install automatically.The separate installation of Executive Viewer Client, for example, when Executive Viewer Client is embedded in a container application, a website or Cognos 8 Portlets, is explained in the chapter ‘Executive Viewer Client’.

Note: You will experience the best performance when the ‘distance’ between Executive Viewer Server and the Repository is as small as possible. The performance depends on the infrastructure of the network you use.

Note: After installation of the Executive Viewer software, Evaluation Roles and Policies are available. After evaluation and defining the desired Repository security, remove the System Role ‘Evaluation User’ and the Item Role ‘Evaluation User’. They should not be available in a production environment.For more information about the Evaluation User, refer to the section ‘Evaluation Roles and Policies’ in the chapter ‘Manage Executive Viewer Server’.

The software needed for installing Executive Viewer Client is obtained from the same sources.

You can obtain the software needed for the installation in two ways:• Download the software at our Support Center at support.cognos.com;• Install the software from CD.

32-bit and 64-bit

Please make sure you download and install the correct version. If you install Executive Viewer on a 32-bit machine, you have to choose the 32-bit version. If you install Executive Viewer on a 64-bit machine, you can either choose to install the 32-bit version or the 64-bit version. If you choose to run the 32-bit version of Executive Viewer on a 64-bit machine, you will not experience the additional performance of the 64-bit version.

The 32-bit and for 64-bit versions of Executive Viewer are available on separate CD’s.

Download

After you have downloaded the software to the directory you choose, double click on‘EVSetup.exe’ to start the installation.

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

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


Installation - GeneralOnce you start the setup routine (see previous section) you can choose the language for the installation.

1.You can choose one of the following languages:Dutch;English;French;German;Spanish.

2.Click ‘OK’ to proceed.3.Read the copyright warning and click ‘Next’.4.You need to agree with the License Agreement by checking the option ‘I accept the terms in

the license agreement’.5.Click ‘Next’.6.You can choose an express or custom installation.

You can now choose between a express or custom installation. See the next sections for details on express and custom installations.

IIS

The setup of Executive Viewer checks whether you have Internet Information Services (IIS) installed on you system. If IIS is not installed, the following applies:

• A message is shown at the start of the installation stating IIS is not installed.• The Explorer and Web Service are not installed during the setup. It is possible to install the

Explorer and the Web Service during a custom installation.• When you select to install the Explorer and the Web Service, no virtual directories will be

created during the installation.


Installation - ExpressFirst time express installation

If you perform an express installation on a machine that has no installation of Executive Viewer (i.e. no upgrade), the setup tries to validate the local SQL server. This can take some time.

If the validation fails, you are presented with the ‘SQL Server Catalog Provider’ dialog. In this dialog you can configure the SQL server settings.

Steps to perform an express installation:1.If you choose ‘Express’, Executive Viewer will install with the default installation settings.

The default settings are:Executive Viewer Server Location: C:\Program Files\IBM Cognos TM1\Executive Viewer\Server;Executive Viewer Explorer location: C:\Program Files\IBM Cognos TM1\Executive Viewer\Explorer;Executive Viewer Server’s Web Service location: C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService;Executive Viewer Client location: C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService\Client;Sample Maps Location: C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\Maps.

2.Click ‘Next’.3.The ‘Installation summary’ gives you an overview of the items that will be installed and

their destination directories. Click ‘Install’ to start the installation.4.When the IBM Cognos TM1 Executive Viewer service fails to start a message is shown.

Please check the log file for more information.5.When all software is installed, you can choose to show the ‘readme’.6.Click ‘Finish’ to complete the installation.7. If there are changes made to your system configuration, you might need to restart the

computer for the changes to take effect.

Note: For explanation about Executive Viewer Web Service, see the chapter ‘Executive Viewer Server API’.

• The IBM Cognos TM1 Executive Viewer service is installed as a system service on the account ‘Local System’;

• The shortcut to Executive Viewer Explorer is added to the start menu for all users. Follow the path ‘Start - All Programs - IBM Cognos - TM1 Executive Viewer’.;

• The IBM Cognos TM1 Executive Viewer service starts after installation;• Sample Maps are installed;• The Catalog Provider is set to ‘SQL Server’;• The Security Provider is set to ‘Windows’;• The Log Provider is set to ‘XML’ on ‘Warning Level’. The log file ‘EVServerLog.xml’ will be

created every day in the directory where Executive Viewer Server is installed;• Executive Viewer Server and documentation are installed;• Executive Viewer Explorer is installed;• HTTP Tunnel, needed for communication over the HTTP Protocol, is installed;• The URL API and Executive Viewer Server’s Web Service are installed;• Virtual directories are created in the Default Web Site and will use the created application

pool called EVAppPool.

Note: The available documentation for the components is installed in the corresponding directories.


For explanation of Providers, see the chapters ‘Providers Introduction’, ‘Catalog Provider’, ‘Security Providers’ and ‘Log Providers’.

If Executive Viewer is already installed on the computer, it will retain its current settings.For an overview of the system requirements, see the chapter ‘Before Installation’.


Installation - CustomA custom installation consists of several steps. It allows you to configure the installation to your needs.

The dialog where you select the program features and their locations looks like this:

Steps to select the program features and their locations:1.If you want to customize the installation settings, check the option ‘Custom’ and click

‘Next’.2. It is possible to select the program features you want to install and change their location.

Select the name and click ‘Change’ to change the location for that program feature. For the following program features you can select whether they are installed on the hard disk:

Server. This will install IBM Cognos TM1 Executive Viewer Server.Clients. This will place the client files in all available languages on the server. These files are provided to the client when the ActiveX control needs to be installed.Documentation. This will the documentationSample Maps. This will install the sample map library.Web Service. This will install IBM Cognos TM1 Executive Viewer Server Web Service.Explorer. This will install IBM Cognos TM1 Executive Viewer ExplorerThis installs the ASP.NET Executive Viewer Explorer.

Alternatively, you can click on ‘Executive Viewer Server’ and select ‘This feature, and all subfeatures, will be installed on local hard drive.’

3.Click ‘Next’.


The dialog where you select the application settings looks like this:

Steps to select the application settings:1. ‘Install IBM Cognos TM1 Executive Viewer for’

It is possible to install Executive Viewer Server and Executive Viewer Explorer for all users or only for the current user.

2. ‘Run IBM Cognos TM1 Executive Viewer service as’It is possible to change the account the IBM Cognos TM1 Executive Viewer service runs on. Recommended and default is to run the IBM Cognos TM1 Executive Viewer service on the account ‘Local System’.

3. ‘Start IBM Cognos TM1 Executive Viewer service after installation’When this option is checked, the IBM Cognos TM1 Executive Viewer service starts after installation.

4. ‘Start IBM Cognos TM1 Executive Viewer in slave mode’If you want to use a Slave Server for Process Distribution, you can choose to start Executive Viewer in slave mode via this option. For more information about Process Distribution, please refer to section ‘Process Distribution’ in the chapter ‘Manage Executive Viewer Server’. If you choose to start Executive Viewer in slave mode, take the following into account:

You will not be able to configure a Catalog Provider;You will not be able to configure a Security Provider;No Executive Viewer Web Service and Executive Viewer Client will be installed.

5.Click ‘Next’.

Steps to select the Web Site Settings:1.Choose the Web Site to create the virtual directories in. You can only select the Web Site

when IIS installed.2.Click ‘Next’.

Steps to select the catalog provider:1.Choose the catalog provider. Possibilities are:

None, in which case the catalog provider has to be configured manually after the setup has completed;


SQL Server;MySQL;ODBC;DB2;Oracle.

2.Click ‘Next’ to specify the catalog provider you chose.

Note: Dialogs regarding catalog providers are not available when you choose to start Executive Viewer in slave mode.

Note: For explanation about the catalog provider see the chapter ‘Catalog Provider’.

Steps to specify the SQL Server catalog provider when chosen:1. ‘Database Name’

Specify the name of the database.2. ‘SQL Server’

Specify the name of the SQL Server and how to connect. 3. ‘Validate SQL Server’

When checking the option ‘Validate SQL Server’, the SQL Server you selected is validated during the installation. If you uncheck this option, the SQL Server is not validated.

4. ‘Connect to this SQL Server using:’Specify to use either Windows Integrated Authentication or SQL Server Authentication

5.Click ‘Next’.

Steps to specify the MySQL catalog provider when chosen:1.Specify the following:

The ‘Database Name’;The ‘Server Name’;The Port (by default 3306);The User ID;The Password.

2.Click ‘Next.’

Note: When the installation is complete, you can change the installation via ‘Add or Remove Programs’. When you change the default Database Name ‘EVRepository’, this only affects the Database Name in the Server configuration. The physical database remains unchanged.

Steps to specify the OCBC catalog provider when chosen:1.Specify the follwing:

The Data Source Name;The User ID (optional);The Password (optional).

2.Click ‘Next.’

Note: When the installation is complete, you can change the installation via ‘Add or Remove Programs’. When you change the default Data Source Name ‘EVRepository’, this only affects the Database Source in the Server configuration. The physical database remains unchanged.

Steps to specify the DB2 catalog provider when chosen:1.Specify the following:

The Database Name;The Server Name;The User ID;The Password.

2.Click ‘Next.’


Note: When the installation is complete, you can change the installation via ‘Add or Remove Programs’. When you change the default Database Name ‘EVRepository’, this only affects the Database Name in the Server configuration. The physical database remains unchanged.

Steps to specify the Oracle catalog provider when chosen:1.Specify the following:

The Data Source Name;The User ID;The Password.

2.Click ‘Next.’

Steps to select the security provider:1.Choose the security provider. Possibilities are:

None. In this case only the Windows built-in administrator can access Executive Viewer Server;Windows;CAM;TM1;Forms. In this case, an extra XML file will be installed with the user ‘Admin’ without a password);Essbase.

2.Click ‘Next’ to specify the security provider you chose.

Note: Dialogs regarding Security Providers are not available when you choose to start Executive Viewer in slave mode.

Note: For explanation about the Security Providers see the chapter ‘Security Providers’.

Steps to specify the CAM security provider when chosen:1.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;The Namespace ID;The User Name;The Password.

2.Click ‘Next.’

Steps to specify the TM1 security provider when chosen:1.Specify the following:

The Host Name;The Server Name to connect to;The User Name;The Password.

2.Click ‘Next.’

Note: Passwords entered during the setup routine are stored encrypted.

Steps to specify the Essbase security provider when chosen:1.Specify the following:

The Server Name to connect to;The User Name;The Password.

2.Click ‘Next.’

Note: Passwords entered during the setup routine are stored encrypted.


Steps to finish the custom installation:1.The ‘Installation summary’ gives you an overview of the items that will be installed and

their destination directories. If you want to adjust any of these settings, click ‘Back’. Click ‘Install’ to start the installation.

2.When the IBM Cognos TM1 Executive Viewer service fails to start a message is shown. Please check the log file for more information.

3.When all software is installed, you can choose to show the ‘read me’.4.Click ‘Finish’ to complete the installation.5. If there are changes made to your system configuration, you might need to restart the

computer for the changes to take effect.


Change the Account to run the IBM Cognos TM1 Executive Viewer Service

The default account where the IBM Cognos TM1 Executive Viewer service runs on, is ‘Local System’.

It is possible to run the IBM Cognos TM1 Executive Viewer service on a different account on Windows 2000, 2003 and XP.

Steps to adjust the account the IBM Cognos TM1 Executive Viewer service is running on:

1.Go to ‘Settings’, ‘Control Panel’, ‘Administrative Tools’;2.Choose ‘Services’.3.Double click on the IBM Cognos TM1 Executive Viewer service. 4.Click on the ‘Log On’ tab. 5.Add the account the IBM Cognos TM1 Executive Viewer service should run on.6.Click ‘Apply’;7.Click ‘OK’;8.Restart the IBM Cognos TM1 Executive Viewer service for the changes to take effect.

On the system running the IBM Cognos TM1 Executive Viewer service the account must have/be:

• ‘Replace Process Token’ rights;• ‘Act as part of Operating System’ rights;• ‘Impersonate a client after authentication’ rights;• ‘Local Administrator’;• ‘Log on as a Service’ rights.


NT Security – Replace a Process Level TokenThis section does not apply if the IBM Cognos TM1 Executive Viewer service runs on the ‘Local System’ account. Running the IBM Cognos TM1 Executive Viewer service on the account ‘Local System’ gives Executive Viewer Server all necessary rights.

If the IBM Cognos TM1 Executive Viewer service runs on a different account, the account should have the rights ‘Replace a Process Level Token’ on the machine running Executive Viewer Server.

Steps to replace a process level token on Windows 2000, 2003 or Windows XP :1.Open the ‘Control Panel’ 2.Go to ‘Administrative Tools’.3.Go to ‘Local Security Policy’.4.Go to ‘Local Policies, ‘User Rights Assignment’.5.Right-click on ‘Replace a Process Level Token’ and choose ‘Security’ or ‘Properties’;6.Click on ‘Add’ to add the account Executive Viewer Server is running on.

Note: For a domain account the ‘Domain Security Policy’ has to be adjusted.


NT Security - Impersonation

To allow Executive Viewer Server to authenticate a user, this user needs to be ‘Impersonated’.This section does not apply if the IBM Cognos TM1 Executive Viewer service runs on the ‘Local System’ account. Running the IBM Cognos TM1 Executive Viewer service on the account ‘Local System’ gives Executive Viewer Server all necessary access rights to impersonate users.If the IBM Cognos TM1 Executive Viewer service runs on a different account, the account on which the IBM Cognos TM1 Executive Viewer service is running on should have the next user rights assignments:

• ‘Act as part of operating system’• ‘Impersonate a client after authentication’.

Steps to impersonate a user for a local account on Windows 2000, 2003 or Windows XP:

1.Open the ‘Control Panel’.2.Go to ‘Administrative Tools’;3.Go to ‘Local Security Policy’;4.Go to ‘Local Policies’, ‘User Rights Assignment’;5.Right-click on ‘Act as part of Operating system’ and ‘Impersonate a client after

authentication’ and choose ‘Security’ or ‘Properties’;6.Click on ‘Add’ to add the account the Executive Viewer Server is running on.



NT Security – Local AdministratorsIf the IBM Cognos TM1 Executive Viewer service runs on a different account, the account should be part of the group ‘Administrators’ on the machine running Executive Viewer Server.

Steps to add the account IBM Cognos TM1 Executive Viewer service runs on to the Administrators Windows 2000, 2003 or Windows XP:

1.Open the ‘Control Panel’. 2.Go to ‘Administrative Tools’.3.Go to ‘Computer Management’.4.Go to ‘Local Users and Groups, ‘Users’.5.Double click on the account you want to give ‘Administrator rights’, choose ‘Add’ on the

‘Member Of’ tab.6.Click on ‘Administrators’ or enter ‘Administrators’, click ‘Add’ to add the account.


NT Security – Log on as a service

This section does not apply if the IBM Cognos TM1 Executive Viewer service runs on the ‘Local System’ account. Running the IBM Cognos TM1 Executive Viewer service on the account ‘Local System’ gives Executive Viewer Server all necessary rights to log on as a service.If the IBM Cognos TM1 Executive Viewer service runs on a different account, the account should have the user rights assignment ‘Log on as a Service’.

Steps to set ‘Log on as a service’ for a local account on Windows 2000, 2003 or Windows XP:

1.Open the ‘Control Panel’. 2.Go to ‘Administrative Tools’.3.Go to ‘Local Security Policy’.4.Go to ‘Local Policies’, ‘User Rights Assignment’.5.Right-click on ‘Log on as a service’ and choose ‘Security’ or ‘Properties’;6.Click on ‘Add’ to add the account on which the IBM Cognos TM1 Executive Viewer service is

running on.



NT Security – Log on locally

All users who can not be authenticated using ‘Integrated Authentication’ must have ‘Log on locally’ rights on the machine running Executive Viewer Server. This is necessary to enable Executive Viewer Server to impersonate those users.

Steps to set ‘Log on locally’ rights on Windows 2000 or XP:1.Open the ‘Control Panel’. 2.Go to ‘Administrative Tools’.3.Go to ‘Local Security Policy’.4.Go to ‘Local Policies, ‘User Rights Assignment’.5.Right-click on ‘Log on locally’ and choose ‘Security’.6.Click on ‘Add’ to add all users or a group of users.

Steps to set ‘Log on locally’ rights on Windows 2003:1.Open the ‘Control Panel’.2.Go to ‘Administrative Tools’.3.Go to ‘Local Security Policy’.4.Go to ‘Local Policies, ‘User Rights Assignment’.5.Right-click on ‘Allow log on locally’ and choose ‘Security’;6.Click on ‘Add’ to add all users or a group of users.


4 Connect to Executive Viewer Server

Server Installation and Configuration Guide 38 4 Connect to Executive Viewer Server

Connect to Executive Viewer Server

After you have installed Executive Viewer Server Explorer, a shortcut to an internet page ‘Explorer’ is added to the ‘Cognos’, ‘IBM Cognos TM1 Executive Viewer’ program group.

Note: When you use User Account Control mode within Windows Server 2008 or Windows Vista you will be logged on as a Standard User to the Executive Viewer Server. The Standard User of Windows Server 2008 or Windows Vista does not have all permissions..

When opening this page, the ASP.NET Executive Viewer Explorer is displayed.

If an Executive Viewer Server is installed on the machine running Executive Viewer Explorer, this Executive Viewer Server name appears.

Right-click on Executive Viewer Server and choose ‘Properties’.


Enter the following properties when adding or updating an Executive Viewer Server:

If no Executive Viewer Server is installed on the machine running Executive Viewer Server Explorer, this screen shows how to add an Executive Viewer Server.

Steps:1.Enter the details of the Executive Viewer

Server you want to add2.Click on ‘Add’ to add the Executive Viewer

Server

Note: This screen is also accessible when clicking on the Executive Viewer Server with your secondary mouse button and choose ‘Properties’.

Executive Viewer Server property

Explanation

Name A name for the Executive Viewer Server you want to add.

Description An optional description.


Location This property represents the location of an Executive Viewer Server. In order to communicate with an Executive Viewer Server, you must specify a valid URI (Unified Resource Identifier).

A valid URI can exist of the following parts:• Protocol;• Host;• Port;• Path.

A URI has the following format:Protocol://Host:Port/Path

If there is no Location specified, the value of the Name property will be used for the value of the Location property.

Protocol

There are two ways to communicate with Executive Viewer Server:• .Net Remoting

In order to communicate with an Executive Viewer Server via Remoting, you have to set the Protocol to TCP.

• Web ServiceIn order to communicate with an Executive Viewer Server via the Executive Viewer Web Service, you have to enter the correct Protocol.

Default value: If no protocol is specified, the Web Service HTTP will be used to connect to an Executive Viewer Server via the Executive Viewer Web Service. After you have installed Executive Viewer Explorer on the same machine as where you installed an Executive Viewer Server, the Protocol of the available Executive Viewer Server in Executive Viewer Explorer is set to TCP.

Host

The Host represents the Host name of the Executive Viewer Server machine. For example: demo.company.com


Explanation


Port

The port number defines the protocol port that is used for contacting the Host referenced in the URI.

Default value: If no port is specified, the default port value of the protocol will be used. The default port number for the HTTP protocol is 80.

The default .Net RemotingPortNumber that is registered by Executive Viewer Server is 7113. If the protocol is set to TCP, the port that is used to communicate with the Executive Viewer Server is 7113. It is possible to change the RemotingPortNumber of the Executive Viewer Server in the ‘EVServer.Exe.Config’ file. For more information on the ‘EVServer.Exe.Config’ file, refer to the chapter ‘Configuration Files’. If the RemotingPortNumber in EVServer Config File is different from 7113, you have to specify this RemotingPortNumber as the Port in the URI.

Path

The Path specifies the Path information that is used by the specified Host to resolve requests for information.

Default value: The default Path that is used by the Executive Viewer Web Service is ‘EVServer’. This is the name of the Web Service's Virtual Directory that is created in IIS (Internet Information Services). If you communicate with an Executive Viewer Server via Remoting, ‘EVWebSvr’ is used as the value for the parameter Path.

Cab Location The Cab Location represents the Location of the Executive Viewer Client cab files.

Default value: In case of connecting to Executive Viewer Server using the Web Service, the default value of the Cab Location is empty. In this case the Client Directory in the Virtual Directory is used. By default:http://<ServerName>/EVServer/Client.

If you specified a Cab Location, this location will be used.

When you connect to Executive Viewer Server via Remoting, you have to specify the location of the Executive Viewer Client Cab Files. If you do not specify the Cab Location (empty), the system administrator needs to take care of the Executive Viewer Client deployment.

After you have installed Executive Viewer Explorer on the same machine as Executive Viewer Server, the Cab Location of the available Server in Executive Viewer Explorer is set to the default Client directory of the Web Service’s Virtual Directory.

If the WebService is not installed during the installation, the Cab Location of the added Executive Viewer Server is empty.


Explanation


For explanation about the ‘Advanced’ button, consult the chapter ‘Executive Viewer Explorer’.For explanation about Security Providers, consult the chapter ‘Security Providers’.

Automatic logon Automatic logon enabledIf you enable Automatic logon, the logon process will evaluate the availability of the following security providers in the next order:

1.CAM. If a cookie for a CAM passport is found, CAM will be used.2.Windows Integrated Authentication. If CAM is not configured WIA

will be used.3. If neither CAM nor WIA is configured, a Logon Form is shown. The

user is prompted to enter credentials

Automatic logon disabledIf Automatic logon is disabled, a Logon Form is shown. The user is prompted to enter credentials

Security Namespace When left empty, the default Provider is used (this is the first configured Security Provider).

Depending on the used Security Provider, Executive Viewer Server is able to retrieve the user credentials automatically.

Only the CAM Security Provider can represent multiple Security Namespaces.

Steps to add an Executive Viewer Server:1.To add another Executive Viewer Server,

right-click on screen and choose ‘Add EV Server’.


Explanation


Log offYou can log off from an Executive Viewer Server in two situations.

When viewing the available Executive Viewer Servers

When you are logged on to an Executive Viewer Server and you are looking at the available Executive Viewer Servers in Executive Viewer Explorer, you can right-click on the server and choose ‘Log off’.

When you are logged on to an Executive Viewer Server

When you are logged on to an Executive Viewer Server, you can click the red button with the white cross to log off.


5 Executive Viewer Explorer

Server Installation and Configuration Guide 45 5 Executive Viewer Explorer

Introduction

Executive Viewer Explorer is an out-of-the-box ASP.NET application, to manage and configure Executive Viewer Server(s) and to create, browse and organize Items, for example Views.End-users, occasionally looking at Views can use Executive Viewer Explorer as well as the system administrator who configures Executive Viewer Server. The user interface of Executive Viewer Explorer adapts to the rights of the user.

This is a way the Executive Viewer Explorer connects to an Executive Viewer Server.This application can be used as an example of how to use Executive Viewer Server’s Web Service. Executive Viewer Explorer only uses the available Methods of Executive Viewer Server's Web Service to communicate with Executive Viewer Server.

Note: For more explanation about Executive Viewer Server’s Web Service, see the chapter ‘EV Server API’.

After you have installed Executive Viewer Server Explorer, a shortcut to an internet page ‘Executive Viewer - Explorer’ is added to the ‘Cognos’, ‘Executive Viewer’ program group.When opening this page, the ASP.NET Executive Viewer Explorer is displayed.

To start Executive Viewer Explorer on a local machine, you can also enter the following URL in your browser:http://localhost/EVExplorer

To access Executive Viewer Explorer on another machine, enter the following URL:http://<name>/EVExplorer

Where <name> is the name of the machine running Executive Viewer Explorer.You can manage multiple Executive Viewer Servers with Executive Viewer Explorer.


• Logon Type: the chosen Logon Type. This is the way Executive Viewer Server connects to the Provider, specified in the ‘Providers’ field. Possibilities are:

‘Automatically logon using Windows Integrated Authentication’ (WIA);‘Display Logon Form’. The user will be prompted to enter credentials.

• Providers: One or more Security Providers can be specified here;When left empty, the default Provider is used (this is the first configured Security Provider). If for the ‘Logon Type’ the option ‘WIA’ is chosen, the first Provider that supports WIA is used;To use multiple Providers separate the Provider names with a comma;To use all Providers, enter ‘*’.

It is possible to view Executive Viewer Explorer in ‘List’ mode or in ‘Block’ mode and collapse or expand the top banner by clicking on the appropriate buttons on the top right of the screen.

1.Buttons to view in ‘Block’ or ‘List’ mode and to collapse or expand the top banner

2.Executive Viewer Explorer in List View without the banner

Steps to see the Properties of Executive Viewer Server:

1.Right-click with your secondary mouse button on the Executive Viewer Server and choose ‘Properties’.

Note: Make sure Executive Viewer Server is running.

The following Properties show and can be edited;

• Name: the name of the Executive Viewer Server;

• Description: the (optional) description;• Location: the name of the machine where

Executive Viewer Server is running, or the location of the ‘WebService.asmx’ file. If this field is left empty, the name specified in the ‘Name’ field will be used;


The following order applies when creating a Session on Executive Viewer Server and working with these variables (server name and port number):

1.The external name and/or port is used. These are set in Executive Viewer Explorer (or using the Executive Viewer Server’s Web Service API)

2.The name and/or port specified in the URL is used. For example: http://demo.company.com:8080

3.The defaults set on the machine running Executive Viewer Server are used

To be able to connect to an Executive Viewer Server with Executive Viewer Explorer, this Executive Viewer Server needs to be added. See the chapter ‘Connect to Executive Viewer Server’ for explanation about adding an Executive Viewer Server.

When clicking on the ‘Advanced’ button, it is possible to set environment variables for Executive Viewer Server.With these environment variables you can specify the name and port to access Executive Viewer Server from an external location. This may be necessary when a client, connecting to Executive Viewer Server, cannot resolve the (internal) Executive Viewer Server name or when the external port for a certain protocol is different than the port that is internally used.

These environment variables apply to each Session created on Executive Viewer Server and are valid as long as the Session is valid.

Note: For explanation of Sessions consult the section ‘Sessions’ in this chapter.

It is possible to specify:• External Server Name

The external name of the server as a string. For example ‘demo.company.com’;

• External Native/TCP PortThe external port number when using Native/TCP connectivity to connect to Executive Viewer Server. The possible values are 0 to 65535;

• External HTTP PortThe external port number when using the HTTP Protocol to connect to Executive Viewer Server. The possible values are 0 to 65535;

• External HTTPS PortThe external port number when using the HTTPS Protocol to connect to Executive Viewer Server. The possible values are 0 to 65535.


To remove the Executive Viewer Server, click with your secondary mouse button on the Executive Viewer Server and choose ’Remove’. After pressing ‘Yes’ on the confirmation dialog, Executive Viewer Server is removed from Executive Viewer Explorer. Note that Executive Viewer Server is not removed from the system, only from Executive Viewer Explorer.

If an Executive Viewer Server is installed on the machine running Executive Viewer Explorer, this Executive Viewer Server name appears.

Steps to manage Executive Viewer Server: 1.Right-click on the Executive Viewer Server

and choose ‘Manage’.

See the chapter ‘Manage Executive Viewer Server’ for explanation about managing Executive Viewer Server.

Steps to access Executive Viewer Server’s Items:

1.Click on the Executive Viewer Server. Or, right-click on Executive Viewer Server and choose ‘Open’.


ItemsExecutive Viewer Server contains a Repository with Items. Items can be of the type:

• ‘Folder’;• ‘Data Source’;• ‘Database’;• ‘View’;• ‘Image’;• ‘Custom Item’;• ‘Shortcut’.

The type ‘View’ contains the view of the data stored in the OLAP database. A View connects to a Database. A Database connects to a Data Source.The type ‘Image’ can be used as background image in a chart.The type ‘Folder’ can be used to organize Items in a Folder structure. A Folder can contain child Items of all defined Item types. This helps to organize all Views and other Items in the Repository.A Custom Item allows users to store a custom file. This data can be of any type.A Shortcut Item can be created which refers to any other Item, except Items of the type ‘Folder’.

These Items (with the sub Folders of the ‘System’ Folder) are available to the accounts that are ‘built-in administrators’. ‘Built-in administrators’ are accounts that are part of the ‘built-in administrator’ group on the machine running Executive Viewer Server or to the accounts specified as ‘built-in administrator’ in the ‘EVServer.exe.config’ file.See the chapter ‘Security Providers’ for more explanation.

The complete Item structure can be adapted to your own situation. Items can be moved, deleted and created. This initial situation is added to help you getting started setting up your own environment.

After installation, the following Folder Items are added to the Executive Viewer Server Repository:

• The Root Folder, with the sub Folders:$Private ItemsSystem, with the sub Folders:

Data SourcesDatabasesImages

Note: If the ‘Has Private Folder’ System Permission is enabled, a folder ‘My Items’ is also added. See the chapter ‘Manage Executive Viewer Server’ for explanation about System Permissions.

Steps to access the Root Item:1.Clicking on ‘Properties’ next to the

Executive Viewer Server name.

• $Private Items• My Items• System


Note: For explanation about security on Items, consult the section ‘Security on Items’ in this chapter.

$Private Items

This Folder contains all ‘My Items’ Folders of all Users. A User has a ‘My Items’ Folder when a user has the System Permission ‘Has Private Folder’.

Note: For explanation about Item Security consult the section ‘Security on Items’.

Note: For explanation about System Security consult the chapter ‘Manage Executive Viewer Server’.

My Items

The ‘My Items’ Folder is created for each user that has the ‘Has Private Folder’ System Permission.

System

The ‘System’ Folder is the Generic System Folder. It contains three subfolders:

• Data Sources• Databases• Images

Data SourcesIn this Folder you can add Data Sources. A Database Item connects to a Data Source;DatabasesIn this Folder you can add Databases. Databases connect to Data Sources. A View connects to a Database;ImagesIn this Folder you can add Images.Images can be used as background image in a chart.


Add and Manage Items

Steps to add an Item:1.To add an Item, right-click on screen and

choose ‘Add Item’ 2.Select the Item you want to add.3.Enter a name and a description for the

Item.4.Click ‘Add’. The Item is added.

You can also add an item directly into a Folder. To add an Item into a Folder, click with your secondary mouse button on the Folder and choose ‘Add Item’ - followed by the Item you want to add.

Steps to manage an Item:1.Once an Item is added you can right-click

on it to:Open the Item;Open all Views (only on ‘Folders’);Delete the Item;Cut the Item;Copy the Item;See the Properties of an Item.

If an Item is copied, the options ‘Paste’ and ‘Paste Shortcut’ are added to the options that show when clicking on screen or on a Folder with your secondary mouse button.

1.Options ‘Paste’ and ‘Paste Shortcut’

Note: It is not possible to create a shortcut to a Folder.


Folder Item

Items of the Type ‘Folder’ can be used to organize Items in a Folder structure.

After installation, all predefined Items are created in the ‘Root’ Folder. The Properties of the ‘Root’ Folder can be accessed by clicking on ‘Properties’ next to the Executive Viewer Server name.

Note: The Root Folder cannot be deleted.

A Folder can contain child Items of all defined Item types. It can be seen as a container for all other Items, including Folder Items.

This facilitates the overview of the Executive Viewer implementation and makes it easier to perform backup procedures, maintenance and migration from one (test) environment to another.

Steps to create a Folder:1.Right-click on screen and choose ‘Add Item’

- ‘Folder’.2.Enter a name and a description for the

Folder.3.Click on ‘Add’. The Folder is created

Steps to change the Properties of the Folder, click on ‘Properties’:

1.Click ‘Properties’.

The following Properties can be reviewed/changed:

• GeneralThe Folder name and description

• User-defined PropertiesAdd or change the User-defined Properties

• PoliciesManage or review the Folder Policies

To return to the contents of the Folder, click on‘Content’ next to the Folder name.

Note: For an explanation of Item Policies and User-defined Properties, see the appropriate sections in this chapter.


Data Source Item

The predefined Folder ‘Data Sources’ is meant to be used to add Items of the type Data Source.

Database Items connect to Data Source Items. Data Source Items refer to the OLAP database server.

Steps to create a Data Source Item:1.Right-click on the screen and choose ‘Add

Item’ - ‘Data Source’.2.Enter a name and a description for the

Data Source Item. 3.Click on ‘Add’.

Steps to specify the Data Source:1.Choose the Data Source type from the

drop-down menu.2.Specify the name of the OLAP Server. 3.Enter the OLAP administrator credentials to

access this server. The database settings can be configured.

4.Click on ‘Update’. The Data Source Item is added.

If you want to add a TM1 Data Source, you can enter the Server name as follows: first enter the name of the ‘adminhost’, followed by a pipe character (|) and then enter the TM1 server name. For example: ‘TM1_demo|tm1srv’.

The database settings available depend on the chosen Data Source type. See the chapters of the corresponding OLAP Servers in this manual for explanation of these settings.

Steps to change the propterties of a Data Source Item:

1.Right-click on the Item and choose ‘Properties’.



• GeneralThe Data Source Item name and description


• PoliciesManage or review the Data Source Policies

To return to the contents of the Data Source Item, click on ‘Content’ next to the Data Source name.


Item Status TypeA spark on the Data Source icon indicates that the Data Source Item is new and does not contain Item Data.

Note: Please refer to the ‘ItemStatusType Enumeration’ explanation in the ‘Executive Viewer Server API Reference’ for more information on Item Status Types.


Database Item

The predefined Folder ‘Databases’ is meant to be used to add Items of the type Databases.

Views connect to Database Items. Database Items connect to Data Source Items.

The Database Item refers to a specific database on an OLAP Server. This OLAP Server is specified in the Data Source Item to which the Database Item refers.

Steps to create a Database Item:1.Right-click on screen and choose ‘Add Item’

- ‘Database’.2.Enter a name and a description for the

Database Item. 3.Click on ‘Add’.

4.Choose the Data Source type from the drop-down menu.

5.Enter the Data Source or select one of the Data Sources from the drop-down menu.

6.Enter the Database Name or the Cube Name or select the Database Name or the Cube Name from the drop-down menu, for example:

Planning sample\BudgetPlan;Foodmart2000\Sales;Sample\Basic.

7.Click on ‘Update’. The Database Item is added.

The database settings can be configured.



Steps to change the Properties of a Database Item:

1.Right-click on the Item and choose ‘Properties’.


• GeneralThe Database Item name and description


• PoliciesManage or review the Database Policies

To return to the contents of the Data Source Item, click on ‘Content’ next to the Database name.


Item Status TypeAn exclamation mark on the Database icon indicates a problem. For example the Data Source Item to which the Database refers could not be found at the specified location.

A spark on the Database icon indicates that the Database Item is new and does not contain Item Data.

Please refer to the ‘ItemStatusType Enumeration’ explanation in the ‘Executive Viewer Server API Reference’ for more information on Item Status Types.


View Item

The predefined ‘My Items’ Folder can be used to add Items of the type View. This initial situation is added to help you get started setting up your own environment. A User has a ‘My Items’ Folder when a user has the System Permission ‘Has Private Folder’.Views can be added in any (created) Folder to organize your own environment.

A ‘View’ contains the view of the data stored in the OLAP database. A View connects to a Database Item and that Database Item connects to a Data Source.

Steps to create a View:1.Right-click on screen and choose ‘Add Item’

- ‘View’.2.Enter a name and a description for the

View Item. 3.Click ‘Add’.

The View is now opened in Executive Viewer Client.

If Executive Viewer Client is not installed on your machine, you will be prompted to install the software.

Note: For explanation about the language installed, see the chapter ‘Executive Viewer Language Editions’.

Executive Viewer Client is installed on the machine and the ‘Connection Information’ dialog shows.Here you can choose the Databases you have configured within Executive Viewer Server. Choose a Database, choose ‘OK’.


Depending on the installation and configuration of the Security Providers, Executive Viewer Server can authenticate the user. Otherwise you have to enter the credentials in order to log on to the specified Database.

The created View shows, with the Data stored in the OLAP database.

Note: See the chapter ’Executive Viewer Client’ for explanation about installation of the Client and the chapter ‘Executive Viewer Language Editions’ for explanation about the installed language.

Steps to change the properties of a View Item:

1.Click on ‘Properties’ next to the View’s name.


• GeneralThe View name and description


• PoliciesManage or review the Policies for this View

To return to the contents of the View, click on ‘Content’ next to the View name.

Note: Consult the IBM Cognos TM1 Executive Viewer User Manual for features available in a View.


Item Status TypeAn exclamation mark on the View icon indicates a problem. For example the Database Item to which the View refers could not be found at the specified location.

A spark on the View icon indicates that the View Item is new and does not contain Item Data.



Image Item

The predefined ‘Images’ Folder is meant to be used to add Items of the type Image.

Data in a View can be displayed as a chart.An Image Item can be used as background image in that chart.

Steps to create an Image Item: 1.Right-click on screen and choose ‘Add Item’

- ‘Image’.2.Enter a name and a description for the

Image Item. 3.Click on ‘Add’.

4.Browse to the image and click ‘Upload’ to add the Image Item to the Repository.

Supported image formats are BMP, GIF, JPEG and PNG.

You see a preview of the Image.

Steps to change the file for the Image Item:

1.Click ‘Browse...’ to select another file. 2.Click ‘Upload’ to put this file in the

Executive Viewer Repository.

Steps to change the properties of a Image Item:

1.Click with your secondary mouse button on ‘Properties’ next to the Image’s name.


• GeneralThe Image name and description


• PoliciesManage or review the Policies for this Image

To return to the contents of the Image, click on ‘Content’ next to the Image name.



Item Status TypeA spark on the Image icon indicates that the Image Item is new and does not contain Item Data.



Custom Item

A Custom Item allows users to store a custom file. This data can be of any type.

Steps to create a Custom Item:1.Click with your secondary mouse button on

screen and choose ‘Add Item’ - ‘Custom Item’.

2.Enter a name and a description for the Custom Item.

3.Click on 'Add'.

4.Browse to the file and click 'Upload' to add the Custom Item to the Repository.

Click ‘Open’ to open the Custom Item. The Custom Item will be opened by the application that is associated with the file extension and the MIME Type of the Custom Item.

1.The ‘File Name’ of the Custom Item2.The ‘MIME Type’ of the Custom Item3.The ‘Open’ button to open the Custom Item4.The ‘Update’ button for the File Name and

the MIME Type5.The ‘Browse...’ button for a file for the

Custom Item6.The ‘Upload’ button for uploading a file for

the Custom Item

You can change the name and the MIME Type of the Custom Item. Click ‘Update’ to confirm your changes.

You can change the file for the Custom Item. Click ‘Browse...’ to select another file and click ‘Upload’ to put this file in the Executive Viewer Repository.

Steps to change the properties of a Custom Item:

1.Right-click on the Custom Item and choose ‘Properties’.



• GeneralThe Custom Item name and description


• PoliciesManage or review the Policies for this Custom Item

To return to the contents of the Custom Item, click on ‘Content’ next to the Custom Item name.


Item Status TypeA spark on the Custom Item icon indicates that the Custom Item is new and does not contain Item Data.



Shortcut Item

A Shortcut Item inherits the type of the Item it refers to.A Shortcut can refer to all Item types except the Item type ‘Folder’.

Steps to create a Shortcut:1.Right-click on the Item to which you want

to create a Shortcut and click on ‘Copy’.

2.Right-click in the Folder where you want to add the Shortcut and choose ‘Paste Shortcut’.

The Shortcut is added to the Repository.When logged in as a user that has the ‘Manage’ Item Permission on this Shortcut, the Shortcut can be recognized by a little arrow in the left bottom corner. Another end user does not see this arrow, and has no indication the Item is a Shortcut. If a Shortcut is not valid (if it refers to an invalid Item, for example an Item that no longer exists), the end user will not see this Shortcut.

Note: For explanation about Item Permissions, see the appropriate sections in this chapter.

Item Status TypeA red shortcut indicator indicates that for example the Shortcut Item does not refer to an Item of the correct Type.

An exclamation mark and a shortcut indicator on for example the Database icon indicates that for example the Data Source Item to which the Database refers could not be found at the specified location.

A spark and a shortcut indicator on for example the Database icon indicates that the Database Item does not contain Item Data.



Property InheritanceIn case of a Shortcut Item, System- and User-defined Properties are inherited from the referenced Item. This means if an Item has a Property ‘New’, then Shortcuts to this Item also have access to the same Property ‘New’. When retrieving the list of Properties from the Shortcut Item, Property ‘New’ will be included in the list.

It is not possible to change the value of an inherited Property on the Shortcut. The value can be changed on the original Item.

If the Shortcut itself has a Property ‘New’, the value of the Property ‘New’ belonging to the Shortcut will be retrieved instead of the value of Property ‘New’ of the Item the Shortcut refers to.In case of a chain of references (Shortcuts referencing to Shortcuts....referencing to an Item) this inheritance continues. This means when retrieving the Properties of the last Shortcut Item in the chain, all Properties of all (Shortcut) Items are retrieved.

Note: For explanation of User-defined and System Properties, see the section ‘User-defined and System Properties’ in this chapter.


Database Wizard

The Database Wizard enables you to register Databases for a Data Source.

Steps to start he Database Wizard: 1.Right-click on a valid Data Source.

2.Enter the OLAP credentials if they are required by the Data Source.If the Data Source does not require OLAP credentials, this screen will not show.

3.Click ‘Login’.

Steps to select the Databases that need to be registered:

1.The Destination Folder specifies the Folder where the Databases have to be created. By default the 'Database Post Search Path' is used. If there is no Destination Folder Specified, the Database Items will be created in the current Folder.

2.You can specify a Database Name Prefix. The optional Database Name Prefix will be added to the Name of the created Database Item.

3.Click ‘Register’.

During the registration of the Databases, a progress indicator is shown. The registration can take some time.

When the Databases have been registered, a status overview of the created Databases will be presented. The Databases are added to the Executive Viewer Server Repository.

You can now choose whether:• to register the same Databases in a

different Destination Folder or;• to close the Database Wizard.


Item Security - Introduction

Executive Viewer Server Security can be divided in two groups; System Security and Item Security. This means it is possible to set permissions: ‘Item Permissions’ and ‘System Permissions’. Item Permissions apply to Items in the Repository. System Permissions apply to the System, being Executive Viewer Server.

To be able to organize and structure these Permissions, they are attached to Roles. A Role contains one or more Permissions.

Item Security:An Item Role (with its Item Permissions) is attached to an account and to an Item. This is called an ‘Item Policy’:

System Security:A System Role (with its System Permissions) is attached to an Account. This is called a ‘System Policy’:

The Item Permissions and System Permissions are a fixed set of Permissions.After installation, several Item Roles and System Roles are created, to help you get started with Executive Viewer Server security. It is possible to modify or delete these Roles, or to create new ones.

After installation, one System Policy is added and for the Root Item and the Items ‘$Private Items’ and ‘System’ one Item Policy is added. These Policies can be modified, deleted and you can create your own Policies.

Note: A built-in administrator can always access Executive Viewer Server. This is to prevent administrators creating a situation where they cannot access Executive Viewer Server.

The Item Security is explained in this chapter. The System Security is explained in the chapter ‘Manage Executive Viewer Server’.


Sessions

In order to apply System and Item Security, Executive Viewer Server has to be able to authenticate a user. This is done with a so called ‘Session’.

This means that each user needs to logon to Executive Viewer Server and create a valid Session in order to get the appropriate permissions, for example to view Views or connect to an OLAP Database.A Session can be created by the portal (for example Executive Viewer Explorer) by using the ‘CreateSession’ Method, or by Executive Viewer Client creating an instant Session.

Either way credentials are passed to the Executive Viewer Server in an attempt to authenticate the user. Executive Viewer Server will pass these credentials to a (specified) Security Provider to ask for the authentication.

Once a Session is created, this Session provides the access to Executive Viewer Server.

Note: For explanation about the ‘Create Session’ Method, consult the ’Executive Viewer Server API Reference’.

Note: For explanation about Security Providers, consult the chapter ‘Security Providers’.


Item Permissions

Permissions ImplicationsItem Permissions are dependent on each other. Setting a Permission may imply other Permissions to be set. This table shows an overview of these implications:

x = Set Permissiono = Implied Permission

Permissions can be set on an Item. A named combination of these permissions is called an ‘Item Role’.

Steps to set the Item Permissions:1.Right-click on Executive Viewer Server and

choose ‘Manage’, ‘Item Roles’.The available predefined Item Roles show.

2.Click on an Item Role to set the Item Permissions. The available Item Permissions are:

ListList the Items in the Parent Folder;ReadRead the contents of an Item;ModifyModify an Item;ManageManage an Item. Items can be created, deleted and renamed;Full ControlFull Control on an Item. With Full Control permission, Security can be changed on an Item.

See the next table for the implications of the permissions.

Full Control Manage Modify Read List

Full Control x

Manage o x

Modify o o x

Read o o o x o

List o x


Item Roles

An Item Role contains (a combination of) Item Permissions. After installation, the following predefined Item Roles are available:

• AdministratorHas Full Control Permissions (Full Control, Manage, Modify, Read, List);

• AuthorHas Manage and List Permissions (Manage, Modify, Read, List);

• ConsumerHas Read Permissions (Read);

• ReviewerHas Read and List Permissions (Read, List).

Steps to create a new Item Role: 1.Right-click on screen and choose ‘New Item

Role’.

2.Specify the following for the Item Role: a name; a description;the Item Permissions.

3.Click on ‘Add’ to add the Item Role.

The Item Role is added to the Item Roles.

Steps to open a role:1.Right-click on the Role and choose ‘Open’.

You can view the Item Permissions and modify the Item Role.

Steps to delete a role:1.Right-click on it and choose ‘Delete’. 2.After clicking ‘Yes’ on the confirmation

dialog, the Item Role is deleted.


Item Policies

These Item Policies can be modified, deleted and you can create your own Item Policies.For each Item Policy, you can set the option ‘Allow’ or ‘Deny’, to allow or deny an Item Policy.

Note: In this example, ‘Windows’ is the used Security Provider. For an overview and explanation of Security Providers, see the chapter ‘Security Providers’.

An Item Role (with its Item Permissions) is attached to an account and to an Item. This is called an ‘Item Policy’.

An Item Polilicy can be set on an Item.

Steps to set the Policies for an Item:1.Right-click on an Item and choose

‘Properties’.

After installation an Item Policy is added for the Root Item. This Policy gives the account ‘<Everyone>’ the Item Role ‘Reviewer’. This means all users, allowed to log on to Executive Viewer Server, can read and list the Items in the Repository.

1.Added Item Policy

For the Items ‘$Private Items’ and ‘System’ an Item Policy is added which gives the account ‘<Everyone>’ the Item Role ‘Consumer’. This means all users, allowed to log on to Executive Viewer Server, can Read the Items. This is necessary in order to let users access for example Databases or Data Sources specified in the ‘System’ Folder.

To change the settings (enable or disable the option ‘Inherit from Parent’, or check ‘Allow’ or ‘Deny’), click on ‘Update’.

Click ‘Delete’ to delete an Item Policy. After clicking ‘Yes’ on the confirmation dialog, the Item Policy is removed from Executive Viewer Server.

Note: The account ‘<Everyone>’ represents all users that can be validated by the installed Security Provider(s).


Permission RulesAccounts can participate in several Policies and Accounts can be (members of) groups. Therefore, a user can have multiple Roles, and multiple Permissions for a specific Item. The following rule applies for handling Permissions:

All Policies on a certain Item that apply to a user (or group this user is a member of) are combined. This results in the individual Permissions of each Policy being added to form the effective Permission on the Item. The effective Permissions are merged with the effective Permissions of each parent up until the first parent is reached that does not have the ‘Inherit from Parent’ option checked, or until the Root Item is reached. If a Policy is marked as ‘Deny’, it means that the Policy is revoked and is not taken into account anymore when merging (parent) Permissions.

Permissions ImplicationsItem Permissions are dependent of each other. Setting a Permission may imply other Permissions to be set. This table shows an overview of these implications:


Steps to create a new Item Policy:1.Click on ‘New’.2.Specify the account type and name.3.Specify one or more Item Roles.4.Click on ‘Add’.

Inherit from Parent

It is possible to set the option ‘Inherit from Parent’. By default the created Folder Items in the ‘System’ Folder have this option checked.

1.Option ‘Inherit from Parent’

When this option is checked, the Item Policy is inherited from the Parent Item, in this case the ‘System’ Item.


Full Control x

Manage o x

Modify o o x

Read o o o x o

List o x


User-defined and System Properties

Each Item in the Executive Viewer Server Catalog can have User-defined and System Properties associated with it. A Property is a User-defined or System attribute with a Name and a Value. The number of Properties an Item can have is unlimited.

The Name is a unique identifier for the Property. The Value is a simple-type that can contain textual, numerical or date-time information.The following Value types are supported:

Steps to add a User-defined Property:1.Click ‘New’.

2.Enter the name, the type and the value of the Property.

The User-defined Property is added. You can change the value and click on ‘Update’.

Click ‘Delete’ to delete the Property. After clicking ‘Yes’ on the confirmation dialog, the Property is removed.

Type Value

boolean true/false

byte 0 ... 255

char Unicode character 0x0000 ... 0xFFFF

datetime 12:00:00 AM, 0001-01-01 ... 11:59:59, 9999-12-31

decimal +79,228,162,514,264,337,593,543,950,335 ... -79,228,162,514,264,337,593,543,950,335

double ±5.0 * 10E-324 ... ±1.7 * 10E308

guid unique 128 bit number {F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4}

int16 -32,768 ... 32,767

int32 -2,147,483,648 ... 2,147,483,647

int64 -9,223,372,036,854,775,808 ... 9,223,372,036,854,775,807

sbyte -128 ... 127

single ±1.5 * 10E-45 ... ±3.4 * 10E38

string Sequential collection of Unicode chars

timespan -9,223,372,036,854,775,808 ... 9,223,372,036,854,775,807 (can be represented as [-]d.hh:mm:ss.ff)

uint16 0 ... 65,535

uint32 0 ... 4,294,967,295

uint64 0 ... 18,446,744,073,709,551,615


System Properties

System Properties are defined by Executive Viewer Server. In general it is not possible to delete an Item’s System Property. In some cases, a System Property is marked as read-only. If this is the case, the value of the Property cannot be changed.System Properties can be recognized by the prefix ‘_’ in the Property name.The System Properties are:

Note: Manageable: can be created/deleted

Name Type Item Type

Read-Only

Manageable Description

_Description string all, optional for Shortcut

no only for Shortcut

Description of the Item

_DateCreated DateTime all, except Shortcut

yes no Creation date of the Item

_UserCreated string all, except Shortcut

yes no Name of the user who created the Item

_DateModified DateTime all, except Shortcut

yes no Modification date of the Item

_UserModified string all, except Shortcut

yes no Name of the user who modified the Item

_Link string Shortcut no no Path of the Item the Shortcut refers to

_Database string View no yes The Database the View connects to.

_Datasource string Database no yes The Data Source the Database connects to.

_DataSourceType string Database and Data Source

no yes The Data Source Type of the Data Source and the Database.


Meta information System Properties for a ViewThe following System Properties apply to the Item Type ‘View’ and contain meta information:

User-defined PropertiesA User-defined Property can be added to an Item and used to store any kind of information. Similar to a System Property, a User-defined Property is identified by a unique name. The Property name cannot start with an underscore ‘_’, because the underscore character is the prefix for a System Property.

Name Type Description

_Notes string The notes in a View. If a View does not contain a note, this System Property is not available.

_ScalingFactor double The Scaling Factor applied to the View. This is the Scaling Factor set on the 'Numbers' tab of the 'Options' dialog.

This System Property is not available if the Scaling Factor is set to default, which is ‘1’.

_DynaSelectText string The text of the DynaSelect. If the View does not contain a DynaSelect, this System Property is not available.

_DisplayMode string The panes the View contains. Possible are:• table• notes• drillthrough• line• bar• pie• area• radar• maps• bubble• range• scatter

The names are separated with a comma.

_PrintOrientation string The Print orientation of the View. Possibilities are:• portrait• landscape

If the paper orientation is set to ‘Default’, this System Property is not available.


6 Manage Executive Viewer Server

Server Installation and Configuration Guide 76 6 Manage Executive Viewer Server

General

There are settings you need to configure in Executive Viewer Server. These settings can be configured using Executive Viewer Explorer.

After you have installed Executive Viewer Server Explorer, a shortcut to an internet page ‘Executive Viewer - Explorer’ is added to the ‘Cognos’, ‘Executive Viewer’ program group.When opening this page, the ASP.NET Executive Viewer Explorer is displayed.

To start Executive Viewer Explorer, you can also enter the following URL in your browser:http://localhost/EVExplorer

To access Executive Viewer Explorer on another machine, enter the following URL:http://<name>/EVExplorer

where <name> is the name of the machine running Executive Viewer Explorer.

To be able to connect to an Executive Viewer Server with Executive Viewer Explorer, this Executive Viewer Server needs to be added. See the chapter ‘Connect to Executive Viewer Server’ for explanation about adding an Executive Viewer Server.

Click with your secondary mouse button on Executive Viewer Server and choose ‘Manage’. Steps to manage Executive Viewer Server:

1.Right-click on the Executive Viewer Server you want to access, or click ‘Add EV Server’ from the pop-up menu to add an Executive Viewer Server.

2.Choose ‘Manage’.


Version Information

When choosing ‘Manage’ from the pop-up menu, you are presented with:

• Version Information;• Security;• Activity Log;• Settings.

Here you can find the exact version number of the running Executive Viewer Server.


System Security

In the ‘Security’ section, you can manage the System Security and the Item Roles. For explanation about the Item Roles, see the chapter ‘Executive Viewer Explorer’. For explanation about the System Security, see the following sections.


System Security - Introduction

Executive Viewer Server Security can be divided in two groups; System Security and Item Security.This means it is possible to set permissions; ‘Item Permissions’ and ‘System Permissions’.Item Permissions apply to Items in the Repository. System Permissions apply to the System, being Executive Viewer Server.





After installation, one System Policy is added and for the Root Item and the Items ‘$ Private Items’ and ‘System’ one Item Policy is added. These Policies can be modified, deleted and you can create your own Policies.


The System Security is explained in this chapter. The Item Security is explained in the chapter ‘Executive Viewer Explorer’.


Evaluation Roles and PoliciesIt can occur that users who evaluate Executive Viewer do not have LocalAdministrator permissions. If a user does not have the LocalAdministrator permissions, the restricted permissions that are defined for the default Everyone Account will be used.

For evaluation purposes, Evaluation Roles and Policies are available.

Initial situation

In order to use the Everyone Account during evaluation purposes:

• the role ‘Evaluation User’ is added to System Roles and Item Roles;

• the policy ‘Evaluation User’ is added to System Policies and Item Policies.

Note: The Evaluation User roles are only created after initialization of the Repository.

Evaluation User Roles

For the ‘Evaluation User’ System Role specific permissions are set initially:

The available System Permissions are:• Logon;• Manage Roles;• Manage System Policies;• Manage Sessions;• Manage Item Policies;• Manage Folders;• Manage Views;• Manage Databases;• Manage Data Sources;• Manage Images;• Manage Custom Items;• Manage Logging.

For the ‘Evaluation User’ Item Role specific permissions are set initially:

• List;• Read;• Modify;• Manage;• Full control.

Evaluation User Policies

The policy ‘Evaluation User’ has been added to the System Policies.


The policy ‘Evaluation User’ has been added to the Item Policies. In this case a Folder item.

Executive Viewer Repository

The ‘Evaluation User’ System Role and Item Role offer Administrator permissions to change the Executive Viewer Repository.

Note: After evaluation and defining the desired Repository security, remove the Evaluation User Roles. They should not be available in a production environment.

Steps to delete the Evaluation User roles:1.Do the following for both the System Roles

and the Item Roles:2.Click with your secondary mouse button on

the Evaluation Role.3.Select ‘Delete’.

A confirmation dialog appears.

4.Select ‘Yes’.The Evaluation User role will be deleted.


Sessions


This means that each user needs to log on to Executive Viewer Server and create a valid Session in order to get the appropriate permissions, for example to view Views or connect to an OLAP Database.A Session can be created by the portal (for example Executive Viewer Explorer) by using the ‘CreateSession’ Method, or by Executive Viewer Client creating an instant Session.


Once a Session is created, this Session is the basis for all access to Executive Viewer Server.

Note: For explanation about the ‘Create Session’ Method, consult the ‘Executive Viewer Server API Reference’.



System Permissions

The following System Permissions set System Permissions for the corresponding Item Type:• Manage Folders;• Manage Views;• Manage Databases;• Manage Data Sources;• Manage Images;• Manage Custom Items.

The user that has these Permissions, can create, modify and delete the Item Types at System

System Permissions can be set. A named combination of these permissions is called a ‘System Role’.

Steps to edit the permissions of a System Role:

1.Open the ‘Manage’ page.2.Click on ‘System Roles’ in the ‘Security’

section of the ‘Manage’ page.

The available predefined System Roles show. Click on a System Role to see the System Permissions.

The available System Permissions are:• Logon

Logon to Executive Viewer Server. If this permission is not set, the user cannot create a Session and is refused access;

• Manage RolesCreate, view, modify and delete Roles;

• Manage System PoliciesCreate, view, modify and delete System Policies;

• Manage SessionsView and invalidate Sessions;

• Manage Item PoliciesCreate, view, modify and delete Item Policies;

• Manage FoldersCreate, modify and delete Folders;

• Manage ViewsCreate, modify and delete Views;

• Manage DatabasesCreate, modify and delete Databases;

• Manage Data SourcesCreate, modify and delete Data Sources;

• Manage ImagesCreate, modify and delete Images;

• Manage Custom ItemsCreate, modify and delete Custom Items;

• Manage LoggingView logging;

• Has Private FolderAllowed to have a Private Folder.


level. For individual Items, the Item Permissions have to be set.For example: in order to set Item Policies on an Item, a user needs to have the System Permission ‘Manage Item Policies’ and the Item Permission ‘Full Control’ on the Item for which to set the Policy.


System Roles

A System Role contains (a combination of) System Permissions.After installation, the following predefined System Roles are available:

• System AdministratorHas all System Permissions, except the ‘Has Private Folder’ System Permission;

• Logon UserHas Logon Permission.

Steps to create a new System Role:1.Right-click on screen and choose ‘New

System Role’.

Steps to add a new System Role:1.Specify the System Role name and

description. 2.Set the System Permissions.3.Click ‘Add’.

The new System Role is added to the System Roles.

To open a role, click on the Role or click with your secondary mouse button on a Role and choose ‘Open’.

You can view the System Permissions and modify the System Role.

To delete a System Role, click on it with your secondary mouse button and choose ‘Delete’. After clicking ‘Yes’ on the confirmation dialog, the System Role is deleted.


System Policies

A System Role (with its System Permissions) can be attached to an account. This is called a ‘System Policy’.

After installation, two System Policies are added; Logon User and Evaluation User. For information on the Evaluation User, see the section ‘Evaluation Roles and Policies’ in this chapter.

Click on ‘System Policies’ in the ‘Security’ section of the ‘Manage’ page.

A System Policy is added which gives the account ‘Everyone’ the System Role ‘Logon User’.

This means all users in the account ‘Everyone’ can Logon to Executive Viewer Server, which is needed in order to create a Session.

Steps to create a new System Policy:1.Click on ‘New’.

2.Specify the account name and type. 3.Add one or more System Roles.4.Click ‘Add’.

Note: In this example, ‘Windows’ is the used Security Provider. For an overview and explanation of Security Providers, see the chapter ‘Security Providers’.

System Policies can be modified, deleted and you can create your own System Policies.

Click ‘Delete’ to delete a System Policy. After clicking ‘Yes’ on the confirmation dialog, the System Policy is removed from Executive Viewer Server.


Accounts

A System Role (with its System Permissions) is attached to an account. This is called a ‘System Policy’.


Steps to view the Accounts in these Policies:

1.Open the Explorer ‘Manage’ page.2.Go to the ‘Security’ section.3.Click ‘Accounts’.

Initially, only the account ‘<Everyone>’ appears.The created account ‘<Everyone>’ represents all users that can be validated by the installed Security Provider(s).

Note: Accounts are added when setting Item Policies or System Policies. Accounts cannot be added individually.Executive Viewer Server uses the specified accounts through one or more Security Providers. Executive Viewer Server does not have accounts of its own.

When a System or Item Policy is set on a specified account, this account appears on the ‘Accounts’ list.

To delete all Policies for an account, click ‘Delete’. After clicking ‘Yes’ on the confirmation dialog, all associated Item and System Policies of the account are deleted from Executive Viewer Server.

When an account has no System or Item Policy defined, the account disappears from Executive Viewer Server.


Activity & Log - Active Sessions

The active Sessions and the Executive Viewer Log can be managed

Steps to manage the Active Sessions:1.Open the ‘Manage’ page2.Click on ‘Active Sessions’ in the ‘Activity &

Log’ section.

When clicking on ‘Active Sessions’ the current active Sessions on Executive Viewer Server show with the following details:

• User;• Host address;• Creation time;• Last used

This parameter is updated when a user performs an action on Executive Viewer Server;

• Description.

Steps to sort Sessions:1.Click on the parameter you want to sort on.

Steps to terminate a Session:1.Click on ‘Terminate’.2.After pressing ‘Yes’ on the confirmation

dialog, the Session is terminated.

Note: It is not possible to terminate your own Session within Executive Viewer Explorer.


Activity & Log - View LogView Log

The Executive Viewer Server Log shows the following details:• Category

Shows the Category of the log, for example ‘General’, or ‘Security’;• Component

Shows the Component from where the log is created from, for example the Security Provider or the Catalog Provider;

• LevelShows the log level;

• MessageContains the actual log message;

• Process IDContains the ID of the Executive Viewer Server Process;

• Thread IDContains the ID of the Thread in the Process;

• Session IDContains the ID of the Session;

• Date-TimeContains the date and time

Steps to show the View Log:

1.Open the ‘Manage’ page.2.Click on ‘Activity & Log’.

Options in the the View Log:• It is possible to step through the log entries

by clicking on the buttons ‘First’, ‘Previous’, ‘Next’ and ‘Last’.

• Click ‘Refresh’ to refresh the screen.• It is possible to filter the Log. Click on

‘Filter’.

Note: The log entries of the Default Log Provider are available in Executive Viewer Explorer. See the chapter ‘Log Providers’ for information about the Default Log Provider.


The levels ‘Severe’, ‘Error’ and ‘Warnings’ give you information about (possible) errors that occur in Executive Viewer Server.The levels ‘Warning’, ‘Info’ and ‘Verbose’ contain information about the status or activities of Executive Viewer Server.The levels ‘Trace’ and ‘Debug’ are recommended in case you experience problems with Executive Viewer Server and you want to see all detailed information.

Filter options:On this page you can set the filter for:

• Thread IDSpecify the Thread ID to view the log entries for, or ‘*’ for all;

• Session IDSpecify the Session ID to view the log entries for, or ‘*’ for all;

• Process IDSpecify the Process ID to view the log entries for, or ‘*’ for all;

• The Log Level;• Sort Order

Ascending orDescending;

• Components;• Categories;• Begin Date-Time;• End Date-Time.

Log Level Explanation

Severe The less detailed level. Only severe errors are logged. These are errors that may cause a situation where Executive Viewer Server is unusable.

Error All errors are logged. These are situations where Executive Viewer Server can run, but for example a Provider cannot be started.

Warning Warnings are logged, for example when a Provider is not correctly configured.

Info Information is logged, for example the start and stop of IBM Cognos TM1 Executive Viewer.

Verbose More detailed information is logged, for example the loading of the Catalog Items.

Trace The same information as in ‘Verbose’ is logged, only more detailed.

Debug The most detailed level. All possible information is logged.


Log CategoriesThe possible Categories are:

• General• Session• Security• Configuration• InternalError• UnsupportedType• ParameterValidation

Log ComponentsThe possible Components are:

• Server:Server

• Log Providers:LogProviders.FileLogProviders.MailLogProviders.XMLLogProviders.MySQLLogProviders.SQLServerLogProviders.ODBCLogProviders.EventLogProviders.ConsoleLogProviders.DB2LogProviders.Oracle

• Catalog Providers:CatalogProviders.SQLServerCatalogProviders.MySQLCatalogProviders.ODBCCatalogProviders.DB2CatalogProviders.Oracle

• Security Providers:SecurityProviders.TM1SecurityProviders.CAMSecurityProviders.FormsSecurityProviders.AnonymousSecurityProviders.WindowsSecurityProviders.Essbase

• Connect Type Specific:TM1OEMProviders.BaseCubEssbaseEssbaseDispatchGatewayMDXMSASMSDSO


Settings - Search LogicSearch Logic

Executive Viewer Server has a search logic. Some Item Types link to another Item. For example a View Item can link to a Database or an Image, or a Shortcut can link to any other Item Type.The search order to find these linked Items is:

1.The ‘search pre-paths’2.Search in the current Folder and its ancestor Folders from the specified Item to the Root

Folder3.The ‘search post-paths’

For each Item Type, the ‘search pre-paths’ and the ‘search post-paths’ can be set. By default, the ‘search pre-paths’ is empty and the ‘search post-paths’ is the first sub Folder in the ‘System’ Folder with the Item Type name. For example for Item Type ‘Images’ this is ‘/System/Images’.

Steps to set the search paths:1.Open the ‘Manage’ page.2. In the ‘Settings’ the search order to find

linked Items can be set.

The Search Paths can be set for the Item types Data Source, Database and Image.

You can define multiple Search Paths on new lines. Use the ‘Enter’ key to create a new line.


Process DistributionIntroduction

As of Executive Viewer version 9.4, it is possible to use Process Distribution. Process Distribution allows you to load cubes into separate sub processes that run parallel to the main process. By using Process Distribution, Executive Viewer can maximize the memory amount available for the cubes to be loaded. In order to extend the usage of Process Distribution, you can configure Master and Slave Servers.

If you have enabled Process Distribution, you can configure Process Distribution on Data Source and Database Items. You can add Slave Servers to extend Process Distribution. You can use the Isolation Level to group specific cubes and load them in seperate processes. With the available combinations of Master and Slave Servers and the Isolation Level, it is possible to configure Process Distribution to exactly fit your needs.

For the installation of Executive Viewer Server and Slave Servers, refer to the chapter ‘Installation of the Software’.

Note: Process Distribution settings are only available if you are logged in as Administrator.

Configuration of Process Distribution in Executive Viewer Server

Steps to open the Process Distribution settings on the Server:

1.Open the ‘Manage’ page.2.Click on ‘Process Distribution’ in the

‘Settings’ section.

Process Distributon information

If you want to use Process Distribution, you have to enable it via the checkbox ‘Process Distribution’ and specify Port Ranges..

Steps to enable Process Distribution:1.If you want to use Process Distribution, you

have to enable it via the checkbox ‘Process Distribution’.

If no Slave Servers are configured, a Port Range on the Master Server must be specified to allow the Processes to communicate with the Executive Viewer Server Master Process.

Steps to set a Port Range1.Enter Port Numbers and / or Port Ranges

separated by ' ; '. Port Ranges can be specified separated by a ' - '. For Example: 1;3;5-12.Valid Port Numbers are: 1 - 65535.

2.Click ‘Update’ to confirm the entered Port Ranges.

Note: If you specify too few ports, the loading of several cubes may fail.


Slave Servers

Steps to add a Slave Server:1.Click ‘New’ to add a Slave Server.2. If one or more Slave Servers are available,

it is possible to specify which Slave Server needs to be used for Process Distribution.

Slave Server Information

Steps to enter the Slave Server information:

1.Enter a unique ‘Name’ for the Slave Server 2.Enter a valid ‘Location’ for the Slave

Server. You can extend the Location with ‘:ServerPortNumber’. You only have to specify the ServerPortNumber when you have changed the ServerPortNumber to another value than 7112. For information on how to set the ServerPortNumber, refer to the section ‘EVServer.exe.config’ File’ in the chapter ‘Configuration Files’.

Specify a ‘Port Range’ for the slave Server:1.Enter Port Numbers and / or Port Ranges

separated by ' ; '. Port Ranges can be specified separated by a ' - '. For Example: 1;3;5-12.Valid Port Numbers are: 1 - 65535.


Slave Server overview

When you have added a Slave Server, it will be listed. A green icon indicates the Slave Server is running. A red icon indicates one of the following problems:

• The version of the Slave Server is not the same version as the Master Server;

• The location of the Slave Server is not valid;

• Communication with the Slave Server is not possible.

You can delete a Slave Server by clicking ‘Delete’.


Configuration of Process Distribution on a Data Source Item

Specify the Isolation Level

You can specify the Isolation Level for this Data Source:• None:

All cubes from this Data Source are loaded by the main process on the specified Server.• Group cubes from this Data Source:

One sub process is started to load all cubes from this Data Source on the specified Server.• Group cubes by Catalog (see note):

One sub process per Catalog is started to load cubes from this Data Source on the specified Server.

• Each Cube separately:A separate sub process is started for each cube from this Data Source on the specified Server.

Note: ‘Group cubes by Catalog’ will be named ‘Group cubes by Server’ when you use TM1 as a Data Source and ‘Group cubes by Application’ when you use Essbase as a Data Source.

Configuration of Process Distribution on a Database Item

Process Distribution settings on a Data Source Item

If you have enabled Process Distribution, a ‘Process Distribution’ section appears in the Data Source item.

1.The ‘Process Distribution’ section in a Data Source item

Select the Master or Slave Server

Select the Master or Slave Server, from the drop-down menu, on which you want the cubes to be loaded.

1.The Server selection2.The Isolation Level

Process Distribution settings on a Database Item

If you have enabled Process Distribution, a ‘Process Distribution’ section appears in the Database item.

1.The ‘Process Distribution’ section in a Database item


If you deselect to inherit the Process Distribution settings from the Data Source Item, you can specify the Master or Slave Server and the Isolation Level for this Database.




You can specify the Isolation Level for this Database:• None:

This cube is loaded by the main process on the specified Server.• Group with cubes from the same Data Source:

One sub process is started to load all cubes, that use the same Data Source and have the same Isolation Level, on the specified Server.

• Group with cubes from the same Catalog (see note):One sub process per Catalog is started to load all cubes, that use the same Data Source and have the same Isolation Level, on the specified Server.

• This Cube individually:A separate sub process is started for this cube on the specified Server.


Choose between Master and Slave servers when Slave Servers have been configured

Inherit from Data Source

You can choose whether you want the Process Distribution settings of the Database Item to be inherited from the Data Source Item it connects to. By default the settings are inherited.

1.Inherit from Data Source2.The Server selection3.The Isolation Level

When Slave Servers have been configured, you can choose between the Master and Slaver Servers when viewing the View Log (see the section ‘Activity & Log - View Log’ in this chapter).


7 Providers - Introduction

Server Installation and Configuration Guide 98 7 Providers - Introduction

What is a Provider?

A Provider is software component (a dll) that provides services of some kind to Executive Viewer Server.Executive Viewer Server uses Providers to extend Executive Viewer Server’s functionality in several areas.

These Providers can be used to adapt the Executive Viewer Server installation to fit into a company’s specific situation.The Providers used by Executive Viewer Server can be divided in three categories:

• Catalog Providers (always one);• Security Providers (more Providers possible);• Log Providers (more Providers possible).

This chapter explains the Providers in general, how Executive Viewer Server connects to Providers and how to add Providers.The chapters ‘Catalog Provider’, ‘Security Providers’ and ‘Log Providers’ describe the corresponding Providers in detail.


Connect Executive Viewer Server to a Provider

The file ‘EVServer.exe.config’ is installed during the setup routine. This file can be found in the installation directory of Executive Viewer Server, which is by default ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server’. This file contains references to the Providers that are used by Executive Viewer Server.

The ‘EVServer.exe.config’ file can be opened for example with Notepad or Microsoft® Visual Studio®.In this file a tag is added for each type of Provider.<catalogProvider><securityProviders><logProviders>

Within these tags, the Providers are specified with the ‘<Providers>’ tag.<provider assemblyName=”<assembly name of the Provider>” className=”<Class name of the Provider>” externalName=”<external name of the Provider>”> < PROVIDER SPECIFIC DATA ></provider>

See the chapters ‘Catalog Provider’, ‘Security Providers’ and ‘Log Providers’ to see what entries need to be made for the corresponding Providers.

During the setup routine, you can choose the Providers.All Providers chosen during the setup routine are added in the ‘EVServer.exe.config’ file after installation.


Add a Provider to Executive Viewer Server

It is possible to extend the number of Security or Log Providers used by Executive Viewer Server.To add a Provider to Executive Viewer Server, follow these steps:

1.Place the assembly of the Provider in the Executive Viewer Server installation directory or use one of the already installed assemblies;

2.Add the Provider specific configuration tag to the EVServer.exe.config file. Make sure that this configuration tag is placed in the correct place; Security Providers in the <securityProviders> tag and Log Providers in the <logProviders> tag. Note that these tags are case sensitive;

3.Make sure the configuration is suitable for the specified Provider;4.After changes made to the EVServer.exe.config file, IBM Cognos TM1 Executive Viewer

service has to be stopped and started. The Providers are loaded when starting the IBM Cognos TM1 Executive Viewer service.

For explanation about Provider specific configurations see the chapters ‘Catalog Provider’, ‘Security Providers’ and ‘Log Providers’.


8 Catalog Providers

Server Installation and Configuration Guide 102 8 Catalog Providers

Catalog Provider - Introduction

The Catalog Provider controls the storage of the Repository. The Repository is a database that contains all the Items and configuration of Executive Viewer Server, including Item and System Security.Executive Viewer Server can have only one Catalog Provider, in contrast to the Security and Log Providers.

The file ‘EVServer.exe.config’ contains the reference to the Catalog Provider.

This chapter contains the possible Catalog Providers, with their system requirements and specific configurations.


SQL Server Catalog Provider

The SQL Server Catalog Provider is the Catalog Provider that stores the Executive Viewer Server Repository in a Microsoft SQL Server database.

System Requirements• SQL Server 2000 Service Pack 3 or higher.

Note: The SQL Catalog Provider has been tested with:SQL Server 8.00.2039 Service Pack 4Note: A Repository created by the SQL Server Catalog Provider can not be used with the ODBC Catalog Provider. It is also not possible to use a Repository created by the ODBC Catalog Provider with the SQL Server Catalog Provider.

ConfigurationThe following lines have to be added to the <catalogProvider> tag of the ‘EVServer.exe.config’ file:<catalogProvider> <provider assemblyName="CatalogProviders.SQLServer" className="Cognos.EV.Server.CatalogProviders.SQLServer" externalName="SQLServerCatalogProvider" > <dataSource pwdEncrypted="true" connectionString="SQL Server Connection String" /> </provider></catalogProvider>

Note: The tags are case sensitive.

The <dataSource> tag is specific for this Catalog Provider.

The connectionString ‘SQL Server Connection String’ of the SQL Server Data Source can look like this in case of standard security:Server=<SERVERNAME>;Database=EVRepository;UID=<USERNAME>;Pwd=<PASSWORD>or like this in case of integrated security:Server=<SERVERNAME>;Database=EVRepository;Integrated Security=SSPI;

Password encryption

You can apply encryption on the password for the Data Source. The ‘pwdEncrypted’ attribute can be set to either ‘true’ or ‘false’.

Password encryption applies only to standard security.

Steps to apply password encryption:1.Set the value of ‘pwdEncrypted’ to ‘true’.2.For <PASSWORD> use the encrypted password obtained from the Password Encryption

Tool.

Note: Encryption strength for encrypted elements in the server config file is 2048 bits.The Password Encryption tool will generate 2048 bits encrypted values.

Consult the SQL Server documentation for more information about connection strings that can be used to connect to SQL Server.


MySQL Catalog ProviderThe MySQL Catalog Provider is the Catalog Provider that stores the Executive Viewer Server Repository in a MySQL Server database.

System Requirements• MySQL version 5.0 or later including MySQL Connector.

Note: The MySQL Catalog Provider has been tested with:MySQL Database 5.0.16MySQL.NET Connector 1.0.4 and 1.0.7

A Repository created by the MySQL Catalog Provider can not be used with the ODBC Catalog Provider. It is also not possible to use a Repository created by the ODBC Catalog Provider with the MySQL Catalog Provider.

Note: Make sure to use UTF-8 as the default Character Set in MySQL.

ConfigurationThe following lines have to be added to the <catalogProvider> tag of the ‘EVServer.exe.config’ file:<catalogProvider> <provider assemblyName="CatalogProviders.MySQL" className="Cognos.EV.Server.CatalogProviders.MySQL" externalName="MySQLCatalogProvider" > <dataSource pwdEncrypted="true" connectionString="MySQL Server Connection String" /> </provider></catalogProvider>



The connectionString ‘MySQL Connection String’ of the MySQL Data Source can look like this:Server=<SERVERNAME>;Database=EVRepository;UID=<USERNAME>;Pwd=<PASSWORD>

Password encryption



Tool.


Consult the MySQL documentation for more information about connection strings that can be used to connect to MySQL.

Note: The MySQL database should be a transactional database.


ODBC Catalog Provider

The ODBC Catalog Provider is the Catalog Provider that stores the Executive Viewer Server Repository in an ODBC database.

System Requirements• A valid ODBC database, named ‘EVRepository’.

Note: The ODBC Catalog Provider has been tested with:Access Database 2003 Service Pack 1 and ODBC Driver version 4.00.6304.00SQL Server 8.00.2039 Service Pack 4 and ODBC Driver version 2000.85.1117.00Oracle 9i and ODBC Driver version 9.02.00.0Oracle 10g and ODBC Driver version 10.02.00.01MySQL Database 4.1.13 and ODBC Driver version 3.51.12.00

ConfigurationThe following lines have to be added to the <catalogProvider> tag of the ‘EVServer.exe.config’ file:<catalogProvider> <provider assemblyName="CatalogProviders.ODBC" className="Cognos.EV.Server.CatalogProviders.ODBC" externalName="ODBCCatalogProvider" > <dataSource pwdEncrypted="true" connectionString="ODBC Connection String" /> </provider></catalogProvider>



The connectionString ‘ODBC Connection String’ of the ODBC Data Source can look like this:DSN=EVRepository;UID=username;Pwd=*****;orDriver={Microsoft Access Driver (*.mdb)};Dbq=C:\EVRepository.mdb;Uid=username;Pwd=*****;

Password encryption



Tool.


Consult the ODBC documentation for more information about connection strings that can be used to connect to ODBC.


DB2 Catalog Provider

The DB2 Catalog Provider is the Catalog Provider that stores the Executive Viewer Server Repository in an IBM DB2 database.

System Requirements:

• IBM DB2 Universal Database 8.2.4 (fixpack 11) Runtime Clients.• DB2.NET Data Provider.

Additional Requirements:

• Create a TableSpace with a pagesize of 16KAs this is a non-unicode database, by default encoding is used for strings stored in the database, this in order to have enough room for some of the tables defined in the database.

• Create DatabasesThe DB2 Catalog Provider can’t create its own database as DB2 Clients are not allowed to create databases. The database needs to be pre-created in the DB2 environment. The necessary tables are automatically created.

Note: The DB2 Catalog Provider has been tested with:DB2 Universal Database 8IBM DB2 Universal Database 8.2.4 (fixpack 11) Runtime Clients.DB2.NET Data Provider 8.1.11.2Note: A Repository created by the DB2 Catalog Provider can not be used with the ODBC Catalog Provider. It is also not possible to use a Repository created by the ODBC Catalog Provider with the DB2 Catalog Provider.

Configuration

The following lines have to be added to the <catalogProvider> tag of the ‘EVServer.exe.config’ file:<catalogProvider> <provider assemblyName="CatalogProviders.DB2" className="Cognos.EV.Server.CatalogProviders.DB2" externalName="DB2CatalogProvider" > <dataSource pwdEncrypted="true" connectionString="DB2 Connection String"/> </provider></catalogProvider>



The connectionString ‘DB2 Connection String’ of the DB2 Data Source can look like this:Server=<SERVERNAME>;Database=EVRepository;UID=<USERNAME>;Pwd=<PASSWORD>

Password encryption




Tool.


Consult the DB2 documentation for more information about connection strings that can be used to connect to DB2.


Oracle Catalog ProviderThe Oracle Catalog Provider is the Catalog Provider that stores the Executive Viewer Server Repository in an Oracle database.

System Requirements• Oracle client 8.1.7 or higher

Note: The Oracle Catalog Provider has been tested with:Oracle InstantClient 10.2.0.2Oracle Server 8.1.7Oracle Server 9.2.0Oracle Server 10.2Note: A Repository created by the Oracle Catalog Provider can not be used with the ODBC Catalog Provider. It is also not possible to use a Repository created by the ODBC Catalog Provider with the Oracle Catalog Provider.

Configuration The following lines have to be added to the <catalogProvider> tag of the 'EVServer.exe.config' file: <catalogProvider> <provider assemblyName="CatalogProviders.Oracle" className="Cognos.EV.Server.CatalogProviders.Oracle" externalName="OracleCatalogProvider" > <dataSource pwdEncrypted="true" connectionString="Oracle Connection String" /> </provider></catalogProvider>



The connectionString ‘Oracle Connection String’ of the Oracle Data Source can look like this:Server=<SERVERNAME>;Database=EVRepository;UID=<USERNAME>;Pwd=<PASSWORD>

Password encryption



Tool.

Consult the Oracle documentation for more information about connection strings that can be used to connect to Oracle.

Creating DatabasesUnlike other Catalog Providers, the Oracle Catalog Provider cannot create its own database. The database needs to be pre-created in the Oracle environment. The necessary tables are automatically created, if the used User account has sufficient permissions.


9 Security Providers

Server Installation and Configuration Guide 110 9 Security Providers

Security Providers - IntroductionThe Security Providers take care of the Security within Executive Viewer Server. A Security Provider validates an account against an existing Security System. This is also known as the ‘Open Security Model’, the model Executive Viewer Server uses to implement its Security.This ‘Open Security Model’ means that Executive Viewer Server does not have accounts of its own. Executive Viewer Server refers accounts and uses the Security Provider to validate these accounts.

A Security Provider represents one or more Security Namespaces. Only the CAM Security Provider can represent multiple Security Namespaces.

The file ‘EVServer.exe.config’ contains the reference to the Security Providers. Account Name and Credentials are validated with the Security Provider, which results in a valid or invalid authentication of the account. A valid authentication leads to a Session.

This chapter contains the possible Security Providers, with their system requirements and specific configurations.


CAM Security Provider

The CAM (Cognos Access Manager) Security Provider uses either WIA, a CAM passport or credentials to validate against a Cognos Server. Once the validation is completed optionally a CAM passport cookie is created.

The CAM Security Provider can represent multiple Security Namespaces. In Cognos 8 the concept of security provider is referred to as namespace. It is possible to use a subset of the namespaces that are defined in Cognos 8. It depends on the defined Cognos 8 namespace whether Windows Integrated Authentication is supported.

ConfigurationThe 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>CAMusername</name> <value>##USERNAME##</value> </credential> <credential> <name>CAMpassword</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>


• <provider>The <provider> tag of the CAM Security Provider contains the details needed to make sure this Security Provider operates correctly. One CAM 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.

• <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 CAM 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 namespaces. The default Cognos 8 namespace will additionally be disclosed.

• <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 ‘CAM’ 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 a 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: Passwords can be encrypted using the ‘PasswordEncrypt’ tool. This can be downloaded at support.cognos.com.


TM1 Security ProviderThe TM1 Security Provider validates credentials, typically a user name and password combination, against a Cognos TM1 Server. This Security Provider does not support Windows Integrated Authentication.

System Requirements• The TM1 OLEDB Provider needs to be installed for connecting to Cognos TM1. The version

of the TM1 OLEDB Provider must be exactly the same as the version of TM1 you are using.

ConfigurationThe following lines have to be added to the <securityProviders> tag of the 'EVServer.exe.config' file:

<securityProviders> <provider assemblyName="SecurityProviders.TM1" className="Cognos.EV.Server.SecurityProviders.TM1" externalName="TM1" > <tm1Servers> <tm1Server>Server01|Sales</tm1Server> <tm1Server>Server02|Sales</tm1Server> </tm1Servers> <adminAccount>Admin</adminAccount> <adminPassword encrypted="true">encrypted_password</adminPassword> <builtInAdministrators> <builtInAdministrator>UserOrGroup01</builtInAdministrator> <builtInAdministrator>UserOrGroup02</builtInAdministrator> </builtInAdministrators> <allowUserToChangePassword>true</allowUserToChangePassword> </provider></securityProviders>


• <provider>The <provider> tag of the TM1 Security Provider contains the details needed to make sure this Security Provider operates correctly. One TM1 Security Provider represents one set of users and user groups configured on one or more TM1 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.

• <tm1Servers>The <tm1Servers> tag contains the list of Cognos TM1 servers that can be used to validate credentials for the users in the represented group. The Security Provider will attempt to connect to the servers in the order in which they are specified. It is presumed that all specified TM1 servers share the exact same set of users and user groups with their corresponding privileges. Each server in the list is specified by its own <tm1Server> tag. A TM1 server can be identified by a Host | Server tag. The host name can be either a netbios or a fully qualified DNS name, for example 'MyTM1Server' versus 'MyTM1Server.mycompany.com'.

• <adminAccount>The <adminAccount> tag specifies the administrative account which the Security Provider should use to log on to (one of) the specified TM1 Server in the list of TM1 Servers. This account should have sufficient rights on the TM1 server to be able to retrieve information about users and groups.


• <adminPassword>The <adminPassword> tag specifies the password for the administrative account specified in the '<adminAccount>' tag.

• <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 'TM1' as Security Provider during the setup routine, the specified administrator is added as built-in administrator.

• <allowUserToChangePassword>The optional <allowUserToChangePassword> tag allows the user to change the TM1 Data Source credentials. By default a TM1 user is not allowed to change the password. The user needs to contact the TM1 administrator who is allowed the password of the user. If the <allowUserToChangePassword> tag is set to ‘true’ the Administrator credentials of the TM1 Data Source will be used to allow the user to change his password.This can be useful when the password of the user has expired.If the <allowUserToChangePassword> tag is not specified the value of this tag will be interpreted as ‘false’.


Note: Passwords can be encrypted using the 'PasswordEncrypt' tool. This can be downloaded at support.cognos.com.


Windows Integrated Security Provider

The Windows Integrated Security Provider validates the accounts, added to Executive Viewer Server against the Windows NT Authority System. This Security Provider supports Windows Integrated Authentication, which means that the user is able to create a so called ‘Impersonated Session’. This means the user does not have to enter credentials when logging on to Executive Viewer Server.

System Requirements• The Windows Integrated Security Provider has no extra system requirements, besides the

system requirements to install Executive Viewer Server. See the chapter ‘Before Installation’.

ConfigurationThe following lines have to be added to the <securityProviders> tag of the ‘EVServer.exe.config’ file:<securityProviders> <provider assemblyName="SecurityProviders.Windows" className="Cognos.EV.Server.SecurityProviders.WindowsIntegratedAuthentication” externalName="Windows" > <domain name="<YOUR DOMAIN>" /> <domain name="<OTHER DOMAIN>" /> <builtInAdministrators> <builtInAdministrator><ACCOUNTNAME></builtInAdministrator> </builtInAdministrators> </provider></securityProviders>


• <domain>The <domain> tag of the Windows Integrated Security Provider contains the name of the domain to which the accounts have to be validated when System or Item Policies are created, for example: ‘cognos.com’ for the ‘Cognos’ domain.

It is possible to specify multiple domains.

• <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. The accountname must be fully specified, including the domain.

Note: The default account on which the IBM Cognos TM1 Executive Viewer service runs on is ‘Local System’.If the IBM Cognos TM1 Executive Viewer service runs on a different account, settings may need to be adjusted for this account. See the chapter ‘Installation of the Software’ for more information.


Forms Security Provider

The Forms Provider is a very plain implementation of a Security Provider that supports a user-password authentication.

System RequirementsThe user names and passwords are configured in the ‘EVServer.exe.config’ file. This is the reason why this Security Provider does not have any extra System Requirements.

ConfigurationThe following lines have to be added to the <securityProviders> tag of the ‘EVServer.exe.config’ file:<securityProviders> <provider assemblyName="SecurityProviders.Forms" className="Cognos.EV.Server.SecurityProviders.Forms" externalName="Forms" > <providerCredentials id="userName" > <credential> <name>userName</name> <caption>User Name</caption> <value></value> <readonly>false</readonly> <password>false</password> <optional>false</optional> </credential> <credential> <name>password</name> <caption>Password</caption> <value></value> <readonly>false</readonly> <password>true</password> <optional>false</optional> </credential> </providerCredentials> <users src="users.xml" > </users> <builtInAdministrators> <builtInAdministrator>admin</builtInAdministrator> </builtInAdministrators> </provider></securityProviders>


• <providerCredentials>The <providersCredentials> tag of the Forms Provider configuration contains the credential information which is needed to create a Session. This obligated information contains the definition of the user credentials that have to be entered in order to create a Session for this Provider.

• <users>The <users> tag contains a reference to an XML file that contains all users known by the Forms Provider. The credentials specified in this XML have to match with the definition specified in the <providersCredentials> tag.



When choosing ‘Forms’ as Security Provider during the setup routine, the built-in administrator ‘Admin’ with no password is added as built-in administrator.


Users.xmlThe XML file that contains the users can be placed in the same directory as the installation directory of Executive Viewer Server, which is by default ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server’.In that case, the ‘src’ parameter looks like:“users.xml”

If the file is placed on another location, the ‘src’ parameter needs to specify the path as well, for example:“C:\Data\Users.xml”“..\Data\Users.xml”An example of an XML file representing one user:<users> <user> <groups> <group>Group1</group> </groups> <userCredentials> <credential> <name>userName</name> <value>User1</value> </credential> <credential> <name>password</name> <value encrypted=”true”>encrypted_password</value> </credential> </userCredentials> <dataSourceCredentials dataSourceType=”<DataSourceType>” dataSourceServer=”<DataSourceServerName>”> <credential> <name>userName</name> <value>DataSourceUserName</value> </credential> <credential> <name>Password</name> <value encrypted=”true”>encrypted_DataSourcePassword</value> <password>true</password> </credential> </dataSourceCredentials> </user></users>

Every user can contain the following nodes:• <groups>

Can be added to specify that a user is part of a group;• <userCredentials>

The credentials of the user that are validated against the Forms Provider;• <dataSourceCredentials>

The Data Source credentials. For example, the Data Source Type is ‘Essbase’ and the Server Name contains the name of the Essbase server. If a user has created a Session with his credentials, the Forms Provider knows which credentials should be used to log on to the Essbase server. In this way, the Forms Provider provides a so called ‘Single Sign On’ environment, preventing the user from having to log on multiple times.



Note: The specified server name in the ‘<DataSourceServerName>’ tag must exactly match the OLAP Server name specified in the ‘OLAP Server’ field when adding a Data Source in Executive Viewer Explorer.

Note: When using the ‘Forms’ Provider, ‘Forms’ should be entered in the ‘Providers' field when adding an Executive Viewer Server. This will remove the ‘Domain’ field from the ‘Logon’ dialog.


Anonymous Security Provider

The Anonymous Provider is a Security Provider that gives the possibility to create an anonymous Session on Executive Viewer Server. This Provider supports Windows Integrated Authentication and Forms Authentication.In both of these authentication methods, the user’s name during the Session will be ‘Anonymous’. System and Item Permissions for this user can be set by adding Policies for the ‘Anonymous’ account.

System RequirementsThe Anonymous Provider has no additional System Requirements.

ConfigurationThe following lines have to be added to the <securityProviders> tag of the ‘EVServer.exe.config’ file:<securityProviders> <provider assemblyName="SecurityProviders.Anonymous" className="Cognos.EV.Server.SecurityProviders.Anonymous" externalName="Anonymous" > </provider></securityProviders>


This Provider does not have any additional configuration settings.


Essbase Security Provider

The Essbase Security Provider validates credentials, typically a user name and password combination, against a Hyperion Essbase Server. This Security Provider does not support Windows Integrated Authentication.

System Requirements• The proper Essbase Runtime Client needs to be installed on the system running Executive

Viewer Server. The version of the Runtime Client must be exactly the same as the version of Essbase you are using.

ConfigurationThe following lines have to be added to the <securityProviders> tag of the ‘EVServer.exe.config’ file:<securityProviders> <provider assemblyName="SecurityProviders.Essbase" className="Cognos.EV.Server.SecurityProviders.Essbase" externalName="Essbase" > <essbaseServers> <essbaseServer>essbase01.company.com</essbaseServer> <essbaseServer>essbase02.company.com</essbaseServer> </essbaseServers> <adminAccount>DemoAdmin</adminAccount> <adminPassword encrypted=”true”>encrypted_password</adminPassword> <builtInAdministrators> <builtInAdministrator>UserOrGroup01</builtInAdministrator> <builtInAdministrator>UserOrGroup02</builtInAdministrator> </builtInAdministrators> </provider></securityProviders>


• <provider>The <provider> tag of the Essbase Security Provider contains the details needed to make sure this Security Provider operates correctly. One Essbase Security Provider represents one set of users and user groups configured on one or more Essbase 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.

• <essbaseServers>The <essbaseServers> tag contains the list of Hyperion Essbase servers that can be used to validate credentials for the users in the represented group. The Security Provider will attempt to connect to the servers in the order in which they are specified. It is presumed that all specified Essbase servers share the exact same set of users and user groups with their corresponding privileges. Each server in the list is specified by its own <essbaseServer> tag. The server name can be either a netbios or a fully qualified DNS name, for example ‘MyEssbaseServer’ versus ‘MyEssbaseServer.mycompany.com’.

• <adminAccount>The <adminAccount> tag specifies the administrative account which the Security Provider should use to log on to (one of) the specified Essbase Server in the list of Essbase Servers. This account should have sufficient rights on the Essbase server to be able to retrieve information about users and groups.

• <adminPassword>The <adminPassword> tag specifies the password for the administrative account specified in the ’<adminAccount>’ tag.



When choosing ‘Essbase’ as Security Provider during the setup routine, the specified administrator is added as built-in administrator.




10 Log Providers

Server Installation and Configuration Guide 123 10 Log Providers

Log Providers - Introduction

The Log Providers used by Executive Viewer Server will store Executive Viewer Servers log entries to an output destination depending on the used Log Provider(s).

The file ‘EVServer.exe.config’ contains the reference to the Log Providers. The requested log entries are visible in Executive Viewer Explorer (if the Provider supports readback and is set as Default Provider).

This chapter contains the possible Log Providers, with their system requirements and specific configurations.

Every Log Provider has to be configured in the ‘EVServer.exe.config’ file.The <logProviders> tag needs to contain the configured Log Providers:<logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="<ASSEMBLYNAME>" className="<CLASSNAME>" externalName="<EXTERNALNAME>" > <properties> <Property <PropertyName>=”<PROPERTYVALUE>”/> </properties> <logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>

The <logProviders> tag can contain an extra attribute which specifies the Default Log Provider.Executive Viewer Explorer will only show the log entries of the Default Log Provider.

Every Log Provider might have <Properties> which are needed to configure the particular Log Provider.


Note: When working with Executive Viewer Server’s Web Service, the Default Log Provider has to support readback if the Method ‘GetLogEntries’ is executed. This means that the Log Provider is able to read the log entries from the output destination. Not all Log Providers are able to readback the Log Entries. If the Default Log Provider does not support readback, this Method will fail.

Note: For more explanation about Executive Viewer Server’s Web Service, see the chapter ‘Executive Viewer Server API’.

Executive Viewer Server generates Log Entries at certain levels. The possible log levels are:• Severe

The highest level of detail.Only severe errors are logged. These are errors that may cause a situation where Executive Viewer Server is unusable;

• ErrorAll errors are logged. These are situations where the IBM Cognos TM1 Executive Viewer server can run, but for example a Provider cannot be started;

• WarningWarnings are logged, for example when a Provider is not correctly configured;

• InfoInformation is logged, for example the start and stop of the IBM Cognos TM1 Executive Viewer service;

• VerboseMore detailed information is logged, for example the loading of the Catalog Items;

• TraceThe same information as in ‘Verbose’ is logged, only more detailed;

• DebugThe lowest level detail. All possible information is logged.





• Server:Server

• Log Providers:LogProviders.FileLogProviders.MailLogProviders.XMLLogProviders.MySQLLogProviders.SQLServerLogProviders.ODBCLogProviders.Event


LogProviders.ConsoleLogProviders.DB2LogProviders.Oracle




• <logLevelTable> and <LogLevels>The <logLevelTable> tag defines which log entries will be logged by the specified Log Provider. This can be specified in the <LogLevels> tag.This tag can contain multiple <logLevel> tags because it is possible to store Log Entries for each Log Category or Log Component.

For example: The ‘XML Log Provider’ logs all ‘General’ ‘Server’ log entries which have the Log Level ‘Severe’ and all ‘General’ ‘MDX’ related log entries which have the log level ‘Info’.The ‘SQL’ Log Provider logs all log entries Executive Viewer Server generates.This is possible by defining which log entries have to be stored for each Log Provider.

When entering a ‘*’ for the Log Level, Log Category or Log Component, all log entries of these items are logged.When no Log Provider is configured for Executive Viewer Server, the Windows Event Log will be used to log errors of all Log Components and all Log Categories with the Log Level ‘Warning’, ‘Error’ or ‘Severe’.After installation, the default Log Provider is the XML Log Provider on ‘Warning’ Level. The XML file ‘EVServerLog.xml’ is created every day in the installation directory, which is by default C:\Program Files\IBM Cognos TM1\Executive Viewer\Server.


Event Log Provider

The Event Log Provider sends log entries to the Windows Event Log.

System Requirements• The Event Log Provider has no extra System Requirements.

Readback• This Provider does not support readback. For explanation about readback, see the section

‘Log Providers - Introduction’ in this chapter.

ConfigurationThe following lines have to be added to the <logProviders> tag of the ‘EVServer.exe.config’ file:<logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="LogProviders.Event" className="Cognos.EV.Server.LogProviders.Event" externalName="EventLogProvider" > <logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>


Note: For information about the ‘<logLevelTable>’ tag consult the section ‘Log Providers - Introduction’ in this chapter.


XML Log Provider

The XML Log Provider sends log entries to a specified file.

System Requirements• If the IBM Cognos TM1 Executive Viewer service runs on an account, this account needs to

have ‘write’ and ‘modify’ permissions on the location specified in the <file>‘path’ tag.

Readback• This Provider supports readback. For explanation about readback, see the section ‘Log

Providers - Introduction’ in this chapter.

ConfigurationThe following lines have to be added to the <logProviders> tag of the ‘EVServer.exe.config’ file:<logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="LogProviders.XML" className="Cognos.EV.Server.LogProviders.XML" externalName="XMLLogProvider" > <properties> <file path="C:\EVServer.xml" createEvery="day" /> </properties> <logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>


<file>The Properties of this Provider contains a <file> tag. This tag contains two attributes:

• ‘path’This attribute contains the destination path of the file to which the log entries are written. If the file does not exist, it is created. For example:

‘C:\Temp\EVServer.xml’ (Make sure the directory exists);‘EVServer.xml’ (Log file is created in the same directory as the installation directory of Executive Viewer Server, which is by default ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server’);‘..\Logs\EVServer.xml’ (Make sure the directory exists).

• ‘createEvery’: This attribute is optional. The options are:Numeric: The ‘createEvery’ attribute sets the size of the log file in MB’s. If ‘createEvery’ is set to ‘2’, a new Log File will be created if the Log File reaches a size of 2 MB.Not Numeric: The ‘createEvery’ can have the following values:

‘Hour’. A new log file is created every hour.‘Day’. A new log file is created every day.‘Week’. A new log file is created every week.‘Month’. A new log file is created every month.‘Year’. A new log file is created every Year.

Note: For information about the ‘<LogLevelTable>’ tag consult the section ‘Log Providers - Introduction’ in this chapter.


Mail Log Provider

The Mail Log Provider sends log entries to a specified e-mail address.

System Requirements• The Mail Log Provider needs to have access to an SMTP-Server which enables this Log

Provider to send log entries to a specified e-mail address. Consult the documentation of the SMTP Server for additional requirements.

Readback• This Provider does not support readback. For explanation about readback, see the section

‘Log Providers - Introduction’ in this chapter.

ConfigurationThe following lines have to be added to the <logProviders> tag of the ‘EVServer.exe.config’ file:<logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="LogProviders.Mail" className="Cognos.EV.Server.LogProviders.Mail" externalName="MailLogProvider" > <properties> <config mailTo="[email protected]" from="[email protected]" /> <network server="mail.company.com"/> </properties><logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>


<config>The <config> tag of the Mail Log Provider contains two attributes;

‘mailTo’. The e-mail address to send the Log Entries to;‘from’: The e-mail address from where the mail has to be sent.

<network>The <network> tag of the Mail Log Provider contains two attributes;

‘server’: The SMTP mail server that sends the e-mails generated by the Mail Log Provider;‘port’: The port of the SMTP mail server from where the mail has to be sent.The ‘port’ attribute is optional.

<additionalMailmessageAttributes>The <additionalMailmessageAttributes> tag contains additional field – value pairs that can be added to an e-mail.



SQL Server Log Provider

The SQL Server Log Provider stores log entries in a SQL Server database.

System Requirements• SQL Server 2000 service pack 3 or later.



ConfigurationThe following lines have to be added to the <logProviders> tag of the ‘EVServer.exe.config’ file:<logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="LogProviders.SQLServer" className="Cognos.EV.Server.LogProviders.SQLServer" externalName="SQLServerLogProvider" > <properties> <dataSource pwdEncrypted="false" connectionString="<SQL SERVER CONNECTION STRING>" /> </properties> <logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>


The <dataSource> tag is specific for this Log Provider.The connection string to the SQL Server Data Source that stores the log entries has to look like this:

• Standard Security:Replace<SQL SERVER CONNECTION STRING>withServer=<SERVERNAME>;Database=EVServerLog;User ID=sa;Password=*****;

Standard Security with Encryption:Replace<SQL SERVER CONNECTION STRING>withServer=<SERVERNAME>;Database=EVRepository;UID=sa;Pwd=*****;where the password is the encrypted password as obtained with the Password Encryption Tool. Make sure the pwdEncrypted attribute is set to true:pwdEncrypted="true"



• Integrated Security:Replace<SQL SERVER CONNECTION STRING>withServer=<SERVERNAME>;Database=EVServerLog;integrated security=SSPI;

Consult the SQL Server documentation for more information about connection strings that can be used to connect to SQL Server.



MySQL Log Provider

The MySQL Log Provider stores log entries in a MySQL database.

System Requirements• MySQL version 5.0 or later including MySQL Connector.



ConfigurationThe following lines have to be added to the <logProviders> tag of the ‘EVServer.exe.config’ file:<logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="LogProviders.MySQL" className="Cognos.EV.Server.LogProviders.MySQL" externalName="MySQLLogProvider" > <properties> <dataSource pwdEncrypted="false" connectionString="<MySQL SERVER CONNECTION STRING>" /> </properties> <logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>


The <dataSource> tag is specific for this Log Provider.The connection string to the MySQL Data Source that stores the log entries has to look like this:Replace<MySQL SERVER CONNECTION STRING>

withServer=<SERVERNAME>;Port=3307;Database=EVServerlog;UID=root;pwd=*****;

• Standard Security with Encryption:Replace<MySQL SERVER CONNECTION STRING>withServer=<SERVERNAME>;Database=EVRepository;UID=sa;Pwd=*****;where the password is the encrypted password as obtained with the Password Encryption Tool. Make sure the pwdEncrypted attribute is set to true:pwdEncrypted="true"


Consult the MySQL documentation for more information about connection strings that can be used to connect to MySQL.



Note: In this example, the default port number is changed, as an example to show how to change the port number. The default port number for MySQL is 3306.

Note: The MySQL database should be a transactional database.


ODBC Log Provider

The ODBC Log Provider stores log entries in an ODBC database.

System Requirements• A valid ODBC database.



ConfigurationThe following lines have to be added to the <logProviders> tag of the ‘EVServer.exe.config’ file:<logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="LogProviders.ODBC" className="Cognos.EV.Server.LogProviders.ODBC" externalName="ODBCLogProvider" > <properties> <dataSource pwdEncrypted="false" connectionString="<ODBC CONNECTION STRING>" /> </properties> <logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>


The <dataSource> tag is specific for this Log Provider.The connection string to the ODBC Data Source has to look like this:Replace<ODBC CONNECTION STRING>with<SERVERNAME>;DSN=EVServerLog;UID=username;Pwd=*****;

orDriver={Microsoft Access Driver (*.mdb)};Dbq=C:\EVServerLog.mdb;Uid=username;Pwd=*****;

• Standard Security with Encryption:Replace<ODBC CONNECTION STRING>withServer=<SERVERNAME>;Database=EVRepository;UID=sa;Pwd=*****;where the password is the encrypted password as obtained with the Password Encryption Tool. Make sure the pwdEncrypted attribute is set to true:pwdEncrypted="true"


Consult the ODBC documentation for more information about connection strings that can be used to connect to ODBC.




DB2 Log Provider

The DB2 Log Provider stores log entries in a DB2 database.

System Requirements:• DB2 Universal Database version 8 and later

Readback• This Provider supports readback. For explanation about readback, see the section 'Log

Providers - Introduction' in this chapter.

Configuration:The following lines have to be added to the <logProviders> tag of the 'EVServer.exe.config' file:<logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="LogProviders.DB2" className="Cognos.EV.Server.LogProviders.DB2" externalName="DB2LogProvider" > <properties> <dataSource pwdEncrypted="false" connectionString="<DB2 CONNECTION STRING>" /> </properties> <logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>


The <dataSource> tag is specific for this Log Provider.The connection string to the DB2 Data Source that stores the log entries has to look like this:

• Standard Security:Replace<DB2 CONNECTION STRING>withServer=<SERVERNAME>;Database=<DATABASENAME>;User ID=<USERID>;Password=<PASSWORD>;

• Standard Security with Encryption:Replace<DB2 CONNECTION STRING>withServer=<SERVERNAME>;Database=EVRepository;UID=sa;Pwd=*****;where the password is the encrypted password as obtained with the Password Encryption Tool. Make sure the pwdEncrypted attribute is set to true:pwdEncrypted="true"


Consult the DB2 documentation for more information about connection strings that can be used to connect to DB2.


Note: For information about the '<logLevelTable>' tag consult the section 'Log Providers - Introduction' in this chapter.


Oracle Log ProviderThe Oracle Log Provider stores log entries in an Oracle database.

System Requirements• Oracle client 8.1.7 or higher

Readback• This Provider supports readback. For explanation about readback, see the section 'Log

Providers - Introduction' in this chapter.

ConfigurationThe following lines have to be added to the <logProviders> tag of the 'EVServer.exe.config' file: <logProviders defaultProvider="<ExternalNameDefaultLogProvider>" > <provider assemblyName="LogProviders.Oracle" className="Cognos.EV.Server.LogProviders.Oracle" externalName="OracleLogProvider" > <properties> <dataSource connectionString="<SERVER CONNECTION STRING>" /> </properties> <logLevelTable> <logLevels> <logLevel logLevel="<LOGLEVEL>" category="<LOGCATEGORY>" component="<LOGCOMPONENT>" /> </logLevels> </logLevelTable> </provider></logProviders>


The <dataSource> tag is specific for this Log Provider.The connection string to the SQL Server Data Source that stores the log entries has to look this:

• Standard Security:Replace<SERVER CONNECTION STRING>withData Source=<TNSNAME>;User ID=<USERID>;Password=<PASSWORD>;

Consult the Oracle documentation for more information about connection strings that can be used to connect to Oracle.

Note: For information about the '<logLevelTable>' tag consult the section 'Log Providers - Introduction' in this chapter.


11 Executive Viewer Server API

Server Installation and Configuration Guide 139 11 Executive Viewer Server API

Executive Viewer Server API - Introduction

Executive Viewer Server has an API, available as a Web Service. A Web Service is an open standard. It contains a collection of Methods for exchanging data between applications. Software applications written in various programming languages and running on various platforms can use Web Services to exchange data over computer networks like the Internet.

Note: ‘API’ stands for ‘application program interface’. It is a specific method prescribed by an application by which a programmer, developing software, can approach this application.

Executive Viewer Server’s Web Service can be used to configure Executive Viewer Server. It is for example possible to retrieve the HTML code for the Executive Viewer Client dynamically, create and manage Items, set security or view a log file.It is also possible to create scripts to automate tasks, for example to create a backup, migrate from a (test) environment to another or to call these Methods from a DTS package.

A combination of these Methods can be used to create your own (ASP.NET) application. An example of how to use Executive Viewer Server’s Web Service is Executive Viewer Explorer. This ASP.NET application uses the Methods, available in Executive Viewer Server’s Web Service.

Note: Consult the ‘Executive Viewer Server API Reference’ for a complete overview of the API.


‘CreateSession’ Method

In order to perform most of the Methods on Executive Viewer Server’s Web Service, a Session has to be created. Once a Session is created, this Session is the basis for all access to Executive Viewer Server.

This means that each user needs to logon to Executive Viewer Server and create a valid Session. Once a Session is created, Executive Viewer Server can validate if the user has sufficient rights to execute the requested Methods.

A Session can be created through the API with the Methods ‘CreateSession’ or ‘CreateSessionImpersonated’. For explanation about these Methods, consult the ’Executive Viewer Server API Reference’.

For a grouped overview of the available Methods and the according permissions, see the appendix or consult the ‘Executive Viewer Server API Reference’.


12 URL API

Server Installation and Configuration Guide 142 12 URL API

URL API - Introduction

The URL API is intended to make Views in the Executive Viewer Server Repository adressable through a URL.

It is possible to enter a URL in your browser, which is sent as an HTTP Request to Executive Viewer Server. This HTTP Request will be processed by the HTTP Handler and results in either a Web Service Call or a URL API Call. The syntax and the options of this URL will be explained in this chapter.

The functionality of the URL API is defined by URL API Actions. HTTP Requests to the URL API result in an HTTP Response which represents the Action specific information.

The Render Action can result in an HTML page that contains Executive Viewer Client showing a View.

Note: The URL API is installed when installing Executive Viewer Server. See also the chapter ‘Installation of the Software’.


HTTP HandlerThe Executive Viewer HTTP Handler enables you to either send Requests to Executive Viewer Server WebService or to use the functionality of the URL API.

By default Microsoft IIS passes the HTTP Requests through to a web application in order to request a file which physically needs to reside on the server.

To enable the URL API functionality the following code is added to the ‘web.config’ file, which by default is located in ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService’.<httpHandlers> <add verb=”*” path=”URL API” type=”Cognos.EV.ServerURLAPIHandler, WebService” validate=”false” /></httpHandlers>

The ‘httpHandlers’ section tells IIS that all HTTP Requests to the path ‘http://<ServerName>/EVServer’ will be handled by the Executive Viewer HTTP Handler. The HTTP Handler determines whether the Request is a WebService Call or a URL API Call.


URL API Syntax - General

Since the URL API is part of the same application in Microsoft IIS as Executive Viewer Server’s Web Service, the URL of the URL API is specified by: ‘http://<ServerName>/EVServer’ followed by a set of URL API Options.

SyntaxTo pass options to the URL API, the following syntax is used:

http://<ServerName>/EVServer?<option>=<optionvalue>&<option>=<optionvalue>

The first option is preceded by a ‘?’ character. The next options have to be separated by a ‘&’ character followed by the option and its value. The option value is assigned to the option by a ‘=’ character.

EncodingSome characters in this HTTP Request need to be encoded when using the URL API. For more information see section ‘URL API - Encoded Characters’ in this chapter for explanation about encoding characters.

General OptionsThe URL API defines a set of general URL API options:

• Action: The Action which has to be performed by the URL APIPossible Values:

Render:This Action will result in an HTML page that contains Executive Viewer Client showing the requested Item.Update Preload:This Action triggers Executive Viewer Server to verify if the preloaded Database(s) need to be updated and does so when necessary.Image:This Action triggers Executive Viewer Server to return the requested Image Item as a file.CustomItem:This Action triggers Executive Viewer Server to return the requested Custom Item as a file.ListItems:This Action triggers Executive Viewer Server to extract data from the Executive Viewer Server repository.

Optional: Yes;Default value: If there is no Action specified in the URL API Request, the Render Action is the default Action. The following default Actions apply for an Image Item or a Custom Item:

Image Item: If there is an Image Item specified in the URL API Request, the default Action will be Image.Custom Item: If there is a Custom Item specified in the URL API Request, the default Action will be CustomItem.

• Title: The title of the HTML pagePossible Values: A valid string representing the title of the HTML page;Optional: Yes;Default value (if there is no or an empty Title specified) :

Render Action:In case of a specified Item the title of the page contains ‘Executive Viewer Client’ followed by the name of the requested Item.In case of no specified Item the title of the page is ‘Executive Viewer Client’.


UpdatePreload Action:In case of a specified Item the title of the page contains ‘Executive Viewer Client’ followed by the name of the requested Item.In case of no specified Item the title of the page is ‘Executive Viewer Client’.

• BGColor: The background color of the HTML pagePossible Values: All known system colors as a RGB value or a hexadecimal value representing the hexadecimal value of the color. This hexadecimal value can have all values between ‘000000’ and ‘FFFFFF’ predefined with an optional ‘#’;Optional: Yes;Default value: not set.

• TextColor: The text color of the HTML pagePossible Values: All known system colors as a RGB value or a hexadecimal value representing the hexadecimal value of the color. This hexadecimal value can have all values between ‘000000’ and ‘FFFFFF’ predefined with an optional ‘#’;Optional: Yes;Default value: not set.

• Authentication: The type of authentication that needs to be used to create a session with Executive Viewer Server. If a user enters a URL API Request in the browser, the URL API handler might create a session for this user. This depends on the settings of Executive Viewer Server and which URL API Action is specified. The Authentication URL API option must match the configured Security Provider that needs to be used.

Possible Values: The possible values of the Authentication depend on which Security Providers are configured for Executive Viewer Server. If the specified Security Provider requires credentials, the user has to add these credentials to the URL API request as well. For instance, if a Security Provider requires a UserName to validate a user, the following needs to be added to the URL API Request:http://<ServerName>/EVServer?<ItemPath>&Authentication=Example&UserName=<UserName>

Optional: Yes;Default value: There is no default value for this option.

Besides these General Options, each URL API Action has Action Specific URL API Options. These Options will be explained in the section ‘URL API Syntax: Action Specific URL API Options’ of this chapter.


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 Options apply to the Render Action:

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

• 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. 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 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 />  <defaultView />


<enableTabBar /> <enableViewsButton /> <viewLocations /> </object>

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

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 TM1\Executive Viewer\Server\WebService\XSLT’. It is not possible to specify an additional XSLT parameter if the RenderType is set to ActiveX.

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

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

Theme Position of the Tab Bar

Classic bottom

Sky top

Ocean top

Desert top

Forest top

Olive top

Silver top

Cognos top


• 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;

• 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’. 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:


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

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


Render Action ExamplesIn this section several examples of the Render Action are given.

Example 1

If you want to render Executive Viewer Client showing the View ‘MyView’, with the Tabbar enabled and using the Theme ‘Ocean’, the URL to type in your browser looks like:

http://<ServerName>/EVServer?MyView&Tabbar=True&Theme=Ocean

Example 2

http://<ServerName>/EVServer?/Financial/Profit%20%26%20Loss

is an example of the encoded notation for the View ‘Profit & loss’ in the Folder ‘Financial’. See the section ‘URL API - Encoded Characters’ in this chapter for more information.

Example 3

You are not obligated to specify an Item in the URL.

http://<ServerName>/EVServer?DisplayMode=View

results in only the Executive Viewer Client (View) being displayed, without an opened View.


URL API Syntax: Action Specific URL API Options - UpdatePreload

UpdatePreload Action Specific OptionsThe UpdatePreload URL API Action triggers Executive Viewer Server to verify if the preloaded Database(s) need to be updated and does so when necessary.

This Action updates the Preloaded Database(s) by specifying:• An Item (Database or Data Source)

If a Database has been specified, the Preload of this particular Database will be verified. In case of a Data Source the preloads of all Databases that use the specified Data Source will be verified.

• A Filter specified by a DataSourceType and optional Server and Database nameIn this case all Databases which match the criteria (DataSourceType, Server and Database name) will be verified and updated when necessary.

Note: The UpdatePreload action will preload only those Databases which are marked for preloading.

The following Options apply to the UpdatePreload Action:

• Item: The Database Item or Data Source Item that needs to be verified for preloading.Possible Values:

A path to a Database Item or a Data Source Item.A name of a Database Item or a Data Source Item if this Item is located in the Root Folder. For explanation about the Root Folder, see the chapter ‘Executive Viewer Explorer’.

Optional: Yes; Either an Item or a Filter has to be specified.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 needs to be defined immediately after the ‘?’ character. For example:http://<ServerName>/EVServer?<ItemPath>has the same result as:http://<ServerName>/EVServer?Item=<ItemPath>

• DataSourceType: The DataSourceType determines which Databases, referring to a Data Source having the specified DataSourceType, need to be verified.

Possible Values:TM1, MSAS or Essbase.

Optional: If an Item has been specified, this option will be ignored. If a Filter has been specified (DataSourceType, Server, Database) this option has to be set.

• Server: The name of the Server determines which Databases, referring to a DataSource that connects to the specified Server, need to be verified.

Possible Values: The name of the Server that needs to be filtered.Optional: If an Item has been specified, this option will be ignored. In case of a Filter the Server name is optional.

• Database: The name of the physical database which needs to be verified.Possible Values: The name of the physical database that needs to be filtered.Optional: If an Item has been specified, this option will be ignored. In case of a Filter the Database name is optional.


UpdatePreload Action Examples

In this section several examples on the UpdatePreload Action are given.

Example 1

UpdatePreload using a Database Item or a Data Source Item:

http://<ServerName>/EVServer?action=UpdatePreload&item=<ItemPath>

Example 2

UpdatePreload using Filter (required: DataSourceType, optional: Server name and Database name):

http://<ServerName>/EVServer?action=UpdatePreload&server=<physicalserver>&database=<physicaldatabase>&datasourcetype=<datasourcetype>


URL API Syntax: Action Specific URL API Options - Image

Image Action Specific OptionsThe Image URL API Action triggers Executive Viewer Server to return the requested Image Item as a file.

The following Options apply to the Image Action:

• Item: The Image Item that needs to be triggered for downloading.Possible Values:

A path to a valid Image Item.A name of an Image Item if this Item is located in the Root Folder. For explanation about the Root Folder, see the chapter ‘Executive Viewer Explorer’.

Optional: No;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 needs to be defined immediately after the ‘?’ character. For example:http://<ServerName>/EVServer?<ItemPath>has the same result as:http://<ServerName>/EVServer?Item=<ItemPath>


Image Action ExamplesIn this section several examples on the Image Action are given.

Example 1

This example results in the retrieval of the requested Image Item:

http://<ServerName>/EVServer?action=Image&item=<ItemPath>

Example 2

This example results in the retrieval of the requested Image Item:

http://<ServerName>/EVServer?<ItemPath>

Note: In this example the ItemPath needs to represent the Path to an Image Item in the Repository.


URL API Syntax: Action Specific URL API Options - CustomItem

CustomItem Action Specific OptionsThe CustomItem URL API Action triggers Executive Viewer Server to return the requested Custom Item as a file.

The following Options apply to the CustomItem Action:

• Item: The Custom Item that needs to be triggered for downloading.Possible Values:

A path to a valid Custom Item.A name of a Custom Item if this Item is located in the Root Folder. For explanation about the Root Folder, see the chapter ‘Executive Viewer Explorer’.

Optional: No;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 needs to be defined immediately after the ‘?’ character. For example:http://<ServerName>/EVServer?<ItemPath>has the same result as:http://<ServerName>/EVServer?Item=<ItemPath>


CustomItem Action Examples

In this section several examples on the CustomItem Action are given.

Example 1

This example results in the retrieval of the requested Custom Item:

http://<ServerName>/EVServer?action=CustomItem&item=<ItemPath>

Example 2

This example results in the retrieval of the requested Custom Item:

http://<ServerName>/EVServer?<ItemPath>

Note: In this example the ItemPath needs to represent the Path to a Custom Item in the Repository.


URL API Syntax: Action Specific URL API Options - ListItems

ListItems Action Specific Options

This Action triggers Executive Viewer Server to extract data from the Executive Viewer Server repository.

Calling the List Method via the URL API list is done in the following way:

http://<servername>/EvServer?action=ListItems&<field>=<value>...&fields=<field>,...

actionThe Action that has to be performed by the URL API. If you want to use the List Method via the URL API you must define which list you want to receive. You do this by specifying an Action. For the List Method currently the 'ListItems' is supported. The List Method 'ListItems' returns all Items in the Repository.

fieldsThe fields that have to be returned. This is a comma separated list that specifies the desired field names.

Parameter interpretation

All other parameters than 'action' and 'fields' are treated as restrictions. The restrictions will be evaluated as if the equal operator is used. The only exception to this are DateTime fields. The DateTime fields also support a range construction.

For constructing the 'restriction tree' the following rules are applied to the defined restrictions.

Rule 1:

When multiple restrictions are specified regarding the same field, the restrictions are treated as an 'OR' restriction.

...&name=ExampleName1&name=ExampleName2...

results in

(name = ExampleName1) OR (name = ExampleName2)

Rule 2:

Multiple restrictions on different fields a treated as an 'AND' restriction.

...&name=ExampleName1&createdBy=ExampleName2...

results in

(name = ExampleName1) AND (createdBy = ExampleName2)

Rule 3:

Restricted fields can be categorized in either generic fields and ItemType specific fields. As such they are grouped together and evaluated in a specific manner.


<item generic> AND ( <database> OR <datasource> OR...)

Type specific fields can be specified using either a full notation <itemtype>.<field> or just by using the <field>.

Example - All MSAS Database with the name 'ExampleName1'

...&name=ExampleName1&database.dataSourceType=msas...

results in

(name = ExampleName1) AND ((type = database) AND (dataSourceType = msas))

Example - All MSAS Data Sources and Databases

...&datasource.dataSourceType=msas&database.dataSourceType=msas...

or

...&dataSourceType=msas...

results in

((type = database) AND (dataSourceType = msas)) OR ((type = dataSource) AND (dataSourceType = msas))

Rule 4:

The specification of the date and time

The date and time specification in your URL API request file should look like this:

YYYYMMDDhhmmssfff

YYYY = year MM = month D = day hh = hour mm = minute ss = second fff = milisecond

For DateTime fields, the URL API allows specifying ranges by using the ' – ' ( = minus) sign. Both closed and open ranges are supported:

• Closed range: <fromDateTime> - <toDateTime>• Open range 'to': - <toDateTime>• Open range from: <fromDateTime> -

Fractional date and time specifications expand automatically to a range. For example:

• 2007 expands to 20070101000000000-20071231235959999 • 200707 expands to 20070701000000000-20070731235959999 • 200707-200708 expands to 20070701000000000-20070831235959999


Response

Unless specific fields are specified, all fields are returned for each item. The fields can be either represented as attibutes or elements. The following overview shows examples for generic Item fields and ItemType specific fields. The ItemType specific fields simply extend the Item field.

Generic Item Fields

<items> <item type="<type>" shortcut="<True|False>" createdBy="<user>" creationDate="<dateTime>" modifiedBy="<user>" modificationDate="<dateTime>" status="<status>"> <name><item name></name> <path><item path></path> <description><item description></description> <userProperty name="<property name>"><property value></userProperty> </item></items>

Custom Item specific fields

<items> <item...> ... <size><data size in bytes></size> <fileName><original filename></fileName> <mimeType><MIME-type of the file></mimeType> </item></items>

Database Item specific fields

Note: Some fields are Data Source type specific.

<items> <item...> ... <dataSourceType><MSAS|Essbase|TM1></dataSourceType> <dataSource><name of the referred data source item></dataSource> <databaseName><physical database name></databaseName> <preload><True|False></preload> --- MSAS --- <interpretRoles><True|False></interpretRoles> <interpretRolesExceptions><Roles which are treated opposite to what the interpret roles flag states></interpretRolesExceptions> <preloadRoles><True|False></preloadRoles> <preloadRolesExceptions><Roles which are treated opposite to what the preload roles flag states></preloadRolesExceptions> --- Essbase --- <personalizeOutline><True|False></personalizeOutline> <personalizedDimensions><Dimensions which are treated opposite to what the personalize outline flag states></personalizedDimensions> <removeOneMemberDimensions><True|False></removeOneMemberDimensions> <retainStructureUsingLabels><True|False></retainStructureUsingLabels> <addSubstitutionMembers><True|False></addSubstitutionMembers> </item></items>

Data Source item specific fields

Note: Some fields are Data Source type specific.

<items> <item...> ...


<dataSourceType><MSAS|Essbase|TM1></dataSourceType> <server><name of the physical server></server> <adminName><name of the configured admin></adminName> <preload><Always|Never|DatabaseSpecific></preload> --- MSAS --- <interpretRoles><Always|Never|DatabaseSpecific></interpretRoles> <providerSpecific><Provider specific settings></providerSpecific> <preloadRoles><Always|Never|DatabaseSpecific></preloadRoles> --- Essbase --- <personalizeOutline><Always|Never|DatabaseSpecific> </personalizeOutline> <removeOneMemberDimensions><Always|Never|DatabaseSpecific> </removeOneMemberDimensions> <retainStructureUsingLabels><Always|Never|DatabaseSpecific> </retainStructureUsingLabels> <addSubstitutionMembers><Always|Never|DatabaseSpecific> </addSubstitutionMembers> --- TM1 --- <providerSpecific><Provider specific settings></providerSpecific> </item></items>

Image Item specific fields

<items> <item...> ... <size><image size in bytes></size> <imageType><image type></imageType> <width><image width></width> <height><image height></height> <bitsPerPixel><number of bits per pixel></bitsPerPixel> </item></items>

View Item specific fields

<items> <item...> ... <database><name of the database this view refers to></database> <notes><view notes></notes> <scalingFactor><the scalingfactor used when displaying the view> </scalingFactor> <dynaSelectText><the text of the dynaselect></dynaSelectText> <displayMode><table|{graphtype}></displayMode> <printOrientation><portrait|landscape></printOrientation> </item></items>


ListItems Action ExamplesExample 1

Shows all views:

http://<YourEVServer>/EvServer?action=ListItems&type=view

Example 2

Shows all valid Items:

http://<YourEVServer>/EvServer?action=ListItems&status=valid

Example 3

Shows all Items modified from February, 1st 2007:

http://<YourEVServer>/EvServer?action=ListItems&modificationDate=20070201-


URL API - Encoded Characters

Some characters need to be encoded when using the URL API. Otherwise these characters are not interpreted as part of the specified name.If the URL API contains a character that has to be encoded, the character has to be replaced by a ‘%’ character followed by the hexadecimal representation of the specified character.

For example:• http://<ServerName>/EVServer?Item=Profit & Loss&BGColor=#dde4ed

should be entered like:• http://<ServerName>/EVServer?Item=Profit%20%26%20Loss&BGColor=%23dde4ed

Note: The second '&' is a reserved character to separate the request parameters. Therefore this character does not have to be replaced.

The following characters have to be encoded:

Make sure all characters with ASCII values between 0 and 31 and all characters equal or greater than 127, are replaced with their hexadecimal equivalents. These values can be found on the Internet, for example on http://www.lookuptables.com.

Characters in a URL can be unsafe for a number of reasons. For example, the character ‘#’ should always be encoded because it is used in World Wide Web to delimit a URL from a fragment identifier that might follow it. This means the following characters need to be replaced according to this table when using the URL API:

Characters can be reserved. Many URL schemes reserve certain characters for a special meaning: their appearance in the scheme-specific part of the URL has a designated semantics. The characters ‘;’, ‘/’, ‘?’, ‘:’, ‘@’, ‘=’ and ‘&’ are the characters which may be reserved for special meaning within a scheme. This means the following characters need to be replaced according to this table when using the URL API:

Character Hexadecimal value

space (‘ ’) 20

quote mark (‘”’) 22

Pound character (‘#’) 23

Percent character (‘%’) 25

Less Than symbol (‘<’) 3C

Greater Than symbol (‘>’) 3E

Left Square Bracket (‘[’) 5B

Backslash (‘\’) 5C

Caret (‘^’) 5E

Right Square Bracket (‘]’) 5D

Grave Accent (‘`’) 60

Left Curly Brace (‘{’) 7B

Vertical Bar/Pipe (‘|’) 7C

Right Curly Brace (‘}’) 7D

Tilde (‘~’) 7E


Ampersand (‘&’) 26


Forward slash (‘/’) 2F

Colon (‘:’) 3A

Semi-colon (‘;’) 3B

Equals (‘=’) 3D

Question mark (‘?’) 3F

At-symbol (‘@’) 40



URL API - Exceptions

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 specified Render Option Value is not supported for this Render Option.

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


13 Configuration Files

Server Installation and Configuration Guide 166 13 Configuration Files

Configuration Files - Introduction

Configuration files are XML files that administrators can use to change or set settings that affect how the application runs.

Executive Viewer uses configuration files. The following files are installed during the setup routine:

• EVServer.exe.config (by default in ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server’);

• Web.config for Executive Viewer Explorer (by default in ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Explorer’);

• Web.config for Executive Viewer Server’s Web Service (by default in ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService’).

A configuration file is readable and editable using a text editor like Notepad.Each configuration file contains the following tags:

<?xml version=”1.0” encoding=”utf-8” ?><configuration> < configuration settings for the specific file ></configuration>

Note that the tags in these config files are case sensitive.

All files are created and configured during the setup routine.The ‘Web.config’ files do not need adjustment after installation. For the EVServer.exe.config file it is possible to change or extend the settings. This chapter explains the settings and possible changes to the EVServer.exe.config file installed with Executive Viewer.


‘EVServer.exe.config’ File

The ‘EVServer.exe.config’ file can by default be found in ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server’.

Open this file with Notepad to see, add or edit settings.After changes made to this file, the IBM Cognos TM1 Executive Viewer service needs to be stopped and restarted in order for the changes to take effect.

configSections<configSections>In this tag the custom configuration sections are added:

• ‘catalogProvider’; • ‘securityProviders’;• ‘logProviders’;• ‘dataSourceSettings’.

</configSections>

In order to read the configuration of Catalog Providers, Security Providers, Log Providers and XSLT, the Server.dll is used.

In order to read the configuration of Data Source settings, the BackEndWrapper.dll is used.

After a default installation of Executive Viewer the configSections part in te ‘EVServer.exe.config’ file looks like this:

<configSections>  <section name="securityProviders" type="Cognos.EV.Server.Providers.ProviderCollection, Server"/> <section name="logProviders" type="Cognos.EV.Server.Providers.ProviderCollection, Server"/> <section name="catalogProvider" type="Cognos.EV.Server.Providers.ProviderCollection, Server"/> <section name="dataSourceSettings" type="Cognos.EV.Server.DataSourceSettings, BackEndWrapper"/></configSections>

catalogProvider<catalogProvider>This tag contains the settings for the Catalog Provider. Consult the chapter ‘Catalog Provider’ for settings that can be changed or added.</catalogProvider>

securityProviders<securityProviders>This tag contains the settings for the Security Providers. Consult the chapter ‘Security Providers’ for settings that can be changed or added.</securityProviders>

logProviders<logProviders defaultProvider=’XMLLogProvider’>This tag contains the settings for the Log Providers. Consult the chapter ‘Log Providers’ for settings that can be changed or added.</logProviders>

dataSourceSettings


<dataSourceSettings>This tag contains Data Source specific settings. It is recommended to only add this tag in specific situations. Contact our support team for more information. For a comprehensive explanation on the dataSourceSettings, refer to the Appendix, section ‘dataSourceSettings’ in this manual.

The following settings can be added or adjusted:

<tm1> <authenticateUsingWIA>false</authenticateUsingWIA> <authenticateUsingWIAExceptions> <server name="tm1server1|sdata"/> <server name="tm1server2|planning sample"/> </authenticateUsingWIAExceptions> <allowWIA>false</allowWIA> <isWriteEnabled>true</isWriteEnabled> <mdx> <compliant>true</compliant> <msExtensions>true</msExtensions> <evCalculations>true</evCalculations> <solveOrderBase>1000</solveOrderBase> </mdx></tm1>

<msas> <ptsTimeOut>30</ptsTimeOut> <provider>MSOLAP</provider> <allowWIA>true</allowWIA> <mdx> <compliant>true</compliant> <msExtensions>true</msExtensions> <evCalculations>true</evCalculations> <solveOrderBase>1000</solveOrderBase> </mdx> <amo> <active>true</active> <autoReloadCache>true</autoReloadCache> <ttl>5</ttl> <servers> <server name="servername1.company.com"> <active>true</active> <ttl>5</ttl> </server> <server name="servername2.company.com"> <active>true</active> <ttl>5</ttl> </server> </servers> </amo> <dso> <active>true</active> <autoReloadCache>true</autoReloadCache> <ttl>5</ttl> <servers> <server name="servername1.company.com"> <active>true</active> <ttl>5</ttl> </server> <server name="servername2.company.com"> <active>true</active> <ttl>1</ttl> </server> </servers> </dso></msas>

<essbase> <unicode>true</unicode>


<nonUnicodeCodepage>1250</nonUnicodeCodepage></essbase></dataSourceSettings>

appSettings<appSettings>This tag contains application specific settings. The following settings can be added or adjusted:

• <add key=”SessionTimeOut” value=”30”/>Specifies the time (in minutes) that a Session state is maintained in Executive Viewer Server.If there is no activity for a period longer then the configured timeout value, the Session is invalidated.Minimum = 1 minute, Maximum = 120 minutes, Default = 30 minutes.

<add key=”MapsPath” value=”C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\Maps\”/>The path to the Maps Libraries. See the chapter ‘Maps’ for explanation about Maps.

• <add key=”ServerPortNumber” value=”7112”/>The TCP port number, Executive Viewer Server uses for client communication.Default = 7112. See the chapter ‘Ports and Protocols’ for more explanation.

• <add key=”RemotingPortNumber” value=”7113”/>The TCP port number that is registered by Executive Viewer Server to allow communication via Remoting.If you:

set the RemotingPortNumber to another value than 7113 in the ‘EVServer.exe.config’ file andif you want to use the URL API,

you also need to set the RemotingPortNumber to the correct value in the ‘Web.config’ file of the Executive Viewer Server WebService. The default location of the ‘Web.config’ file is ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\WebService\’.Add the following code to the ‘configuration’ section of the Web Service's ‘Web.Config’ file to set the RemotingPortNumber:

<configuration> <appSettings> <add key=”RemotingPortNumber” value=”7113”/> </appSettings> </configuration>

• <add key=”ServerProtocol” value=”TCP”/>The preferred protocol that Executive Viewer Server uses when rendering the client HTML.Default = TCP. See the chapter ‘Ports and Protocols’ for more explanation.

• <add key=”HTTPPortNumber” value=”80”/>When the SeverProtocol is set to ‘HTTP’, this setting can be used to set the port number.Default = 80.

• <add key=”HTTPSPortNumber” value=”443”/>When the SeverProtocol is set to ‘HTTPS’, this setting can be used to set the port number.Default = 443.

• <add key=”ClientLogon” value=”SessionID;WIA;Forms”/>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.

• <add key=”GatewaySuppliesCredentialInformation” value=”true”/>If this settings is set to True, the Data Source Gateway (MS Analysis Services, Essbase, etc. ) can supply credential information when the Security Provider does not supply valid credentials or the Session does not have valid credentials to logon to the Data Source Gateway. This means that the client asks the user for those credentials.Default = True


• <add key=”ParallelPreload” value=”1”/>Specifies the Parallel preload level.Default = 1, which means parallel preload per server.

• <add key=”InboundIPAddress” value=”IP_Address”/>Contains a specific subnet (IP_Address) or DNS name. When configured only client connections coming from the specified subnet are accepted.Default = Any

• <add key=”AggressiveMemoryAllocationMaxMB” value="0”/>This key determines the maximum number of MB the server allocates for its buffers.Default = 0

• <add key=”CheckPreloadingTimeOut” value=”0”/>This options allows you to specify a timeout interval. After this timeout interval all preloaded databases are verified and reloaded in case the databases are updated.Default = minimum= 0 minutes (no verification), maximum = 1440 minutes

• <add key=”UseCurrentOutlineWhilePreloading” value=”false”/>Use this option to connect to a database that has a changed outline and is marked for preload.When enabled the user still uses the current cached outline while in the background the updated database is reloaded. When the reload is finished the user receives the refreshed data when reopening the database connection.When disabled the user has to wait until the updated database is reloaded.By default this option is disabled.

• <add key="SessionProtection" value="None"/>This option allows you to protect a Session.Possible values for SessionProtection:

NoneNo Session protection is applied, this is default behaviour.Lock The Session is protected/locked by the first client that connects to the server. Other connections are only allowed if they come from the same user.RestrictThe Session is protected/restricted when created. The protection is based on the user who connects. Restrict can only be succesfully set when SecurityProviders that support impersonation are used. When SecurityProviders that do not support impersonation are used, the value of the SessionProtection is set to Lock.

</appSettings>


14 Executive Viewer Client

Server Installation and Configuration Guide 172 14 Executive Viewer Client

Introduction to Executive Viewer Client

Executive Viewer Client is an ActiveX component that contains the ‘ViewCtrl’ control (Executive Viewer Client 9.4) to display Views.

A View Item is displayed in Executive Viewer Client 9.4. It shows a view of the data stored in the OLAP database.

Executive Viewer Client can be installed in two ways:• Installation when opening a View Item (in Executive Viewer Explorer);

This is the same installation procedure as installation using the ‘URL API’ or using an HTML page created with the ‘Render’ Method from Executive Viewer Server’s Web Service.This is the recommended way to install Executive Viewer Client;

• Installation from a link within an HTML page, linking to a cabinet file encapsulating the Executive Viewer Client.

This chapter explains these installation methods.

Note: For a solution to keep automatic ActiveX activation enabled after Internet Explorer security update 912945 is installed, see section ‘ActiveX Control Activation’.

Note: For explanation about updating and upgrading from previous versions, see the chapter ‘Updates and Upgrades’.

Note: For explanation about language settings, see the chapter ‘Executive Viewer Language Editions’.


Installation when opening a View in EV Explorer

During the Executive Viewer Server setup routine, the Executive Viewer Client files for all available languages are placed in the subdirectory ‘WebService\Client’ of the Executive Viewer Server directory, which is by default ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server’.These files are:

• EVCtrl6En.cab (English)• EVCtr6lDa.cab (Danish)• EVCtrl6De.cab (German)• EVCtrl6Es.cab (Spanish)• EVCtrl6Fr.cab (French)• EVCtrl6Nl.cab (Dutch)• EVCtrl6Zh.cab (Chinese)• EVCtrl6Ja.cab (Japanese)

When opening a View in Executive Viewer Explorer, EVCtrl6En.cab will be used to install Executive Viewer Client.The cabinet file contains a setup executable, which installs and registers all the necessary parts of Executive Viewer Client. Internet Explorer triggers the process of installing when it detects the software has not yet been installed or a newer version is available.

When using the URL API or the ‘Render’ Method from Executive Viewer Server’s Web Service, Internet Explorer also triggers the process of installing when it detects the software has not yet been installed or a newer version is available.

This dialog appears.

1.Click ‘Install’ to continue the installation.

This dialog means Internet Explorer security is set up to prompt whether to install a signed ActiveX control. If you do not want this message, change the security settings of Internet Explorer by enabling the download of ActiveX controls without a prompt (see ‘Security Settings in Internet Explorer’ in this chapter).

Optionally choose a Database to connect and enter your credentials.

Executive Viewer Client is installed and the requested View is displayed.


Installation from a link within an HTML page

It is recommended that Executive Viewer Client is installed through Executive Viewer Explorer or by using the ‘Render’ Method or the URL API. This makes sure you have the correct version installed. When updating Executive Viewer Server, new cab files are placed in the subdirectory ‘WebService\Client’ of the Executive Viewer Server directory. Class IDs and version numbers are updated automatically.When a View is opened in Executive Viewer Explorer or by using the URL API or the ’Render’ Method, Internet Explorer triggers the process of installing when it detects the software has not yet been installed or a newer version is available.

Executive Viewer Client can also be embedded in Internet Explorer by using a customized HTML page. Access to an HTML page with references to specific files is required. This HTML page can be accessed with Internet Explorer via Internet or your Intranet using the HTTP protocol. It can also be accessed directly when it is available on your local network.

The following files are needed when using a customized HTML page;• EVCtrl6En.cab

This is the cab file, encapsulating Executive Viewer Client. This file can be found in the subdirectory ‘WebService\Client’ of the Executive Viewer Server directory.

• The HTML pageAn HTML page, containing the correct references. You can create this file yourself, based on the example below.

Example HTML pageIf you open a View, using the URL API, you can choose ‘View’, ‘Source’ from the menu bar to see an example of an HTML page.The file looks like this:

<html> <head> <title>View Name</title> </head> <body topmargin="0" leftmargin="0" scroll="no"> <xml id="evxml"> <object ID="EVObject" name ="EVObject" height="100%" width="100%" classid="clsid:ACAC1200-0BBE-499A-A9E9-5F334DBC8E89" codebase="http://<YOUR SERVER>/EVServer/Client/EVCtrl6En.cab#version=9,4,1,0"> <param name="Server" value="YOUR EV SERVER" /> <param name="SessionID" value="d17bf6f0-8ce8-4d2a-9f83-2cecd1b0407d" /> <param name="DefaultView" value="/View Name" /> </object> </xml> <span id="EVObject_placeholder" /> <script language="javascript" src="/EVServer/CreateControl.js"> </script> <script language="javascript">CreateControl( "EVObject_placeholder", "EVObject_xml", "EVObject" );</script> </body></html>

The code below shows an example of the accompanying Javascript file which can be used in combination with the page above. This CreateControl.js file needs to be placed in the same directory as the Client HTML page.

// Function which externally creates an object to make sure it is always activated// See Microsoft article: 912945function CreateControl( _placeholder, _xml, _strObjectName ){ var doc, node, attr;


doc = document.all( _xml ).XMLDocument; node = doc.selectSingleNode( "/span/object" ); attr = doc.createAttribute( "onreadystatechange" ); attr.value = "window.setTimeout( \"AsyncOnReady( '" + _strObjectName + "' );\", 0 );"; node.attributes.setNamedItem( attr ); document.all( _placeholder ).innerHTML = document.all( _xml ).XMLDocument.xml;

}function AsyncOnReady( objname ){ var control = document.all( objname ); if ( ( control != null ) && ( control.object != null ) ) { if ( control.ActiveView != null && !control.ActiveView.Connection.Connected ) { control.ShowConnectionInformationDialog( ); } }}

Explanation of this example page <title>View Name</title>This is the title, which is displayed in the caption bar. This title contains free text. It can be replaced with any text, for instance ‘Monthly Views’.

<body topmargin="0" leftmargin="0" scroll="no"> <object ID="EVObject" name ="EVObject" height="100%" width="100%" classid="clsid:ACAC1200-0BBE-499A-A9E9-5F334DBC8E89"These are some default Properties for the margins and the presence of the scroll bar. The object ID in combination with the name and the CLASSID uniquely identifies Executive Viewer Client. The Windows registry contains a link between this ID and the actual control after installation.The size of Executive Viewer Client is set (default 100%, filling the entire screen).

codebase="http://<YOUR SERVER>/EVServer/Client/EVCtrl6En.cab#version=9,4,1,0">The ‘codebase’ refers to the cab file, which is placed in the Executive Viewer Server/Client directory. You can change this link, for example to the same directory as the HTML page (also make sure the cab file is placed there). Note that the name of the cab file is case sensitive.Internet Explorer checks if the version number in the HTML page is newer than the version of Executive Viewer installed on the user’s computer. If this is the case, installation starts.

<param name="Server" value="YOUR EV SERVER" /> <param name="SessionID" value="d17bf6f0-8ce8-4d2a-9f83-2cecd1b0407d" /> <param name="DefaultView" value="/View Name" />Properties in the control are set using the ‘param’ command. After the ‘param’ command, the name of the Property followed by its value needs to be specified immediately. This is done with the ‘name’ and ‘value’ command. The ‘name’ command followed by a ‘=’-sign and the name of the Property specifies the Property’s name. The ‘value’ command, also followed by a ‘=’-sign and then by the value, sets the value.Here you need to specify your Executive Viewer Server name. This is necessary in order to let Executive Viewer Client connect to an Executive Viewer Server.‘SessionID’ and ‘DefaultView’ are Properties added by the URL API. These Properties are not necessary when using your own customized HTML page.For detailed explanation about Properties, Methods and Events, see the manual ‘IBM Cognos TM1 Executive Viewer Integration Guide’.

Users access the required files in two ways:• Using a shared directory in your network;• Using Internet or an Intranet with a virtual directory (for example, IIS server) HTTP

protocol.


Once a user accesses the files, the web browser will check if Executive Viewer Client has been installed previously and if so, which version.If Executive Viewer Client is not installed, or the version is older than the version specified in the HTML page, Executive Viewer Client gets downloaded and installed.

Click on the ‘Views’ button and choose a View to open on the ‘Views’ dialog or create a View.Optionally choose a Database to connect to and enter your credentials.

Summarized:The preparation for installation of Executive Viewer Client is ready when:

• The correct path of the Executive Viewer Server (Executive Viewer Client 9.4) is entered into the HTML page;

• In the HTML page the reference to the correct cab file and version is made (codebase);• The correct cab file resides on the same directory as the HTML file.

If Executive Viewer Client is not installed or is re-installed every time you open the page, it could be that the Internet Explorer security settings need adjustment. See the section ‘Security Settings in Internet Explorer’ in this chapter. Also verify:

This dialog appears.

1.Click ‘Install’ to continue the installation.

This dialog means Internet Explorer security is set up to prompt whether to install a signed ActiveX control. If you do not want this message, change the security settings of Internet Explorer by enabling the download of ActiveX controls without a prompt (see ‘Security Settings in Internet Explorer’ in this chapter).

• Is the HTML page refreshed?Press ‘F5’ to refresh or go to ‘Tools’ (menu bar), ‘Internet Options’, ‘Settings’. Check the option ‘Every visit to the page’ below ‘Check for newer versions of stored pages’;

1.Check ‘Every visit to the Page’

CODEBASE="EVCtrl6En.cab#version=9,4,1,0"

• Is the HTML page adjusted and is the correct version of the cab file on the shared directory?Adjust the HTML page for the correct version and make sure the right cab file is placed in the shared directory.


Security Settings in Internet Explorer

If Executive Viewer Client is not downloaded or starts downloading every time the HTML page is opened or when opening a View in Executive Viewer Explorer, check the following:

• Security settings:

Security settings must allow:• ‘Downloading ActiveX controls’;• ‘Installing ActiveX controls’;• ‘Displaying ActiveX controls’.

The security level must be set to ‘Medium’ or ‘Medium Low’. Security settings can also be customized:Go to ‘Tools’, ‘Internet Options’, tab ‘Security’.Set the settings for the Internet or the Intranet, as appropriate.Here the setting can be set to ‘Medium’ or ‘Medium Low’, or be customized.Choose ‘Custom’ Level.

Enable:• ‘Download signed ActiveX controls’. If you

set this option to ‘Prompt’ you will see the Security Form. If you enable this option, you will not see a Security Form;

• ‘Run ActiveX controls and plug-ins’;• ‘Script ActiveX controls marked save for

scripting’;• ‘Downloads’; ‘File Download’.

Click ‘OK’; click ‘OK’ in the confirmation dialog. Click ‘Apply’.


ActiveX Control Activation

Introduction

Microsoft has changed Internet Explorer in the way it renders multimedia content like ActiveX controls and Java applets. This results in a situation in which user activation is required before the user can interact with the control. The reason for this security update is the fact that Microsoft is not allowed to directly activate ActiveX controls in Internet Explorer anymore because of patent infringements. The changes are included in a cumulative IE security update (912945). Check www.microsoft.com for more information about this IE security update.

Impact on Executive Viewer

The security changes will have a direct impact on the use of Executive Viewer Client ActiveX control. A user now needs to manually activate the Executive Viewer Client control on the page to enable interaction. The following dialog appears:

This Microsoft change will have impact on:• Opening a web page in which Executive Viewer Client control is being embedded. • Client side browser scripts (written in VBScript or JavaScript) which run in Internet Explorer

and use the Executive Viewer Web Client API.• A Client HTML page in which the Client Control <Object> section is being generated

dynamically.

Some examples:• A Client HTML page in which the <Object> section is generated by using the Executive

Viewer Server Web Service 'Render' Method. • A Client HTML page in which the <Object> section is rendered by using ASP, ASP.NET, PHP,

JSP etc.. or any other language to create dynamic web pages.• A Client HTML page in which the <Object> section is rendered using the VBScript or

JavaScript 'document.write' or 'document.writeln' methods.

For Executive Viewer 6.0 build 2 patch 2 and later, a change has been implemented which makes sure the HTML is rendered correctly and the client is activated automatically for Executive Viewer Client in the URL API and Executive Viewer Explorer. Older versions do not contain this change.


Solution

The solution is to use some additional scripting in the Client HTML page. To avoid the patent issue, the <Object> section needs to be inserted by an external script file. Apart from avoiding the patent there is no other (technical) reason to do this. The <Object> section is placed in an <XML> section which can be used to dynamically insert the <Object> tag into the placeholder span.

Because inserting the <Object> tag needs to happen in a separate script file, this part is placed in the CreateControl function in the CreateControl.js. This function can be called from the HTML page, after including the script file.

Below is an example of a modified Executive Viewer Client HTML page:

<html> <head> <title>Executive Viewer Client</title> </head> <body topmargin="0" leftmargin="0" scroll="yes"> <xml id="evxml"> <object id="EVObject" name="EVObject" height="100%" width="100%" classid="clsid:{ACAC1200-0BBE-499A-A9E9-5F334DBC8E89}"> <param name = "Server" value = "Your EVServer" /> <param name = "EnableToolbar" value = "1" /> <param name = "EnableToolbarText" value = "1" /> </object> </xml> <span id="evplaceholder"></span> <script language="javascript" src="CreateControl.js"> </script> <script language="javascript"> CreateControl( "evplaceholder", "evxml" ); </script> </body></html>

The code below shows an example of the accompanying javascript file which can be used in combination with the page above. This CreateControl.js file needs to be placed in the same directory as the Executive Viewer Client HTML page. // Function which externally creates an object to make sure it is always activated // See Microsoft article: 912945function CreateControl( _placeholder, _xml ){ document.all( _placeholder ).innerHTML = document.all( _xml ).XMLDocument.xml;}

Notes

Make sure you check the option 'Disable Script Debugging' in Internet Explorer in the Advanced Tab of the Internet Options Control Panel. If this option is unchecked, you will still have to activate the Executive Viewer Client ActiveX control. While the object-tag is inserted as a XML-document you need to make sure that you are using the correct format of the object-tag. This means that all the tags need to be closed and that all the attribute-values are between quotes.


Create a Share (File Access) Example

Store the HTML page and the Executive Viewer Client software on a server drive where users have access. Create a share on this directory and give users read-only permissions to access this share.

Click with your secondary mouse button on the directory and choose ‘Sharing’.

Give the share a name, for instance, ‘EV’.

1.Share name

Each user needs to make a drive mapping to the EV share on each client machine.

Choose ‘Tools’ (menu bar in Windows Explorer), ‘Map Network Drive’. Enter the name of the share in the path field and choose a drive letter.

Click ‘Finish’ to create the mapping.

In the Web browser you can type this address, in this example:

E:\Executive Viewer.html


Create a Virtual Directory (HTTP, IIS) Example

This section contains information about how to set up a virtual directory and the use of Microsoft IIS Server. This is not intended to be complete; these are just global examples to help you get started. For a complete overview consult the Microsoft documentation about this subject.

Store the HTM page and the client software in a directory.

Open the Internet Service Manager (‘Start’, ‘Settings’, ‘Control Panel’, ‘Administrative Tools’, ‘Internet Information Services’).

Select ‘Default Website’.

Choose ‘New’, ‘Virtual Directory’.

Type ‘ExampleVirtDir’ as the alias for the virtual directory.

Click ‘Next’.


Enter the physical path for the virtual directory. In this example ‘C:’ is a local drive on the IIS-Server.

1.Enter the physical path for the virtual directory

Click ‘Next’.

Select the checkboxes for:• ‘Read’;• ‘Run Scripts (such as ASP)’;• ‘Execute (such as ISAPI applications or

CGI)’.‘Read’ is necessary for reading the HTML pages.‘Run Scripts’ is necessary when you are using scripts in your HTML pages.‘Execute’ is necessary to execute the client setup from the virtual directory.

Click ‘Next’.

Click ‘Finish’.


The virtual directory is now included on the IIS-Server.

Select the virtual directory ‘ExampleVirtDir’, click with your secondary mouse button and select ‘Properties’.

Go to the ‘Documents’ tab.

Remove the files in the ‘Documents’ tab.

Click ‘Add’ and enter ‘Executive Viewer.html’ as the default document name.

Click ‘OK’.

Click ‘OK’ and the HTML page is the default page of your virtual directory.

It is necessary to know which HTTP address you need to connect to for access to the IIS-Server.In this example the DNS name of the IIS-Server is ‘demo.cognos.com’.The connection should be to the virtual ExampleVirtDir directory created on this server, so the complete HTTP address will be:

http://demo.cognos.com/ExampleVirtDir


15 Executive Viewer Portlets

Server Installation and Configuration Guide 185 15 Executive Viewer Portlets

IntroductionAs of Executive Viewer 9.4 it is possible to use Executive Viewer as a portlet in a Cognos Connection page. A portlet is a mechanism for displaying Web content as part of a portal page.

The Executive Viewer Portlets are installed via an installation program.

For information about adding a portlet to a portal, see the chapter ‘Pages and Dashboards’ in the IBM Cognos 8 Administration and Security Guide.

For information about configuring portal services, see the chapter ‘Cognos 8 Examples’ in the IBM Cognos 8 BI Getting Started Guide.

Executive Viewer Portlets

These portlets provide Executive Viewer content in Cognos Connection or in your existing enterprise portal. By default, these portlets are available in Cognos Connection.

The following portlets are available in this group:

Portlet Description

Executive Viewer Use this portlet to add Executive Viewer Views to a Cognos Connection page.

View Selector Use this portlet to select an Executive Viewer View from the Executive Viewer repository.


Installation of the Executive Viewer PortletsThis 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 CAM Security Provider configured.

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 support.cognos.com;

• 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 Gateway component 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.2.Run ‘issetup.exe’ that you obtained from either the CD or from support.cognos.com.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 Gateway

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


Removal of the Executive Viewer PortletsIf you no longer require the Executive Viewer Portlets or you are planning to upgrade to a newer version, remove the installed Executive Viewer Portlets.

Steps to remove the Executive Viewer Portlets:1.From the ‘Start’ menu, click ‘Programs’, ‘IBM Cognos 8’, ‘Uninstall IBM Cognos 8, ‘Uninstall

IBM Cognos 8’.2.On the ‘Uninstall Language Selection’ page. select the language for the uninstallation

wizard and then click ‘Next’.3.Select ‘IBM Cognos 8 Executive Viewer Portlets’ and click ‘Next’. 4.When the uninstallation is complete, click ‘Finish’.

Some files and folders remain on the computer until you remove them manually. If you plan to upgrade, do not delete the files and folders.


User Reference for Portal ServicesAdministrators typically configure default settings for each instance of a portlet before making itavailable to users. When you access the Cognos portlets through your portal, you can change some settings to customize instances of each Cognos portlet. You can then save your settings for subsequent sessions.

You can change the content and layout of a portlet using the edit button on the title bar. If the page or portlet is read-only or locked by an administrator, the edit button is disabled or does not appear on the portlet title bar.

Executive Viewer

Use this portlet to add Executive Viewer Views that are available in the Executive Viewer repository.

To modify the properties for this portlet, click the edit button to open the properties page. If the edit button is disabled or not visible, the administrator did not make these settings available to you.

In the portlet properties page, to reset the default portlet settings, or to return to the settings specified by your administrator, click the reset button in the portlet title bar. To exit the properties page without saving the changes, click the return button or click Cancel.

Note: • In SAP Enterprise Portal, portlets are named iViews. This document may refer to iViews as

portlets.• In Microsoft SharePoint Portal Server, portlets are named Web Parts. This document may

refer to Web Parts as portlets.

The following table shows the properties that you can change:

Property Description

Title Specifies the title of the portlet. You can choose to:• Use the name of the Active View.• Use a custom title.

Note: The title does not appear in all portals, such as the WebSphere, Plumtree, and SAP portals.

Height (pixels) Specifies the portlet height in pixels. If the View is larger than this setting, scroll bars appear.

Theme Specifies the theme of Executive Viewer Client. The following themes are available:

• Cognos;• Classic;• Desert;• Forest;• Ocean;• Olive;• Silver;• Sky.


Components Specifies whether a user interface component of Executive Viewer Client is visible or hidden in the portlet. Refer to the Executive Viewer User Manual for an explanation on the user interface components. You can select the following components:

• Tool Bar;• Tool Bar Text;• Views Button;• Allow Save;• Offspread Bar;• Chart Bar;• Row Headers;• Column Headers;• Splitter.

Tab Bar Specifies whether the Tab Bar is:• Always enabled;• Enabled for Folders;• Disabled.

Executive Viewer Server Location

This property represents the location of an Executive Viewer Server. In order to communicate with an Executive Viewer Server, you must specify a valid URI (Unified Resource Identifier).

A valid URI can exist of the following parts:• Protocol (optional);• Host;• Port (optional);• Path (optional).


The Host must be specified. If a URI part is not specified its default value will be used.

Default Views Specifies the path to the default View of the Executive Viewer Portlet. The path of the View must be exactly the same as it is available in the Executive Viewer repository.

You can also specify a folder. In that case all Views in that folder are opened in the Executive Viewer Portlet.

Send Events Specifies the name of the channel that you want to use for communication between portlets.

It is possible to specify a name for the channel that is used by a portlet to send events.

If no channel is specified, the events will be sent to all channels.

Please refer to the section ‘Enable communication between Executive Viewer Portlets’ in this chapter.



View Selector

Use this portlet to display a list of Executive Viewer Views and folders that are available in the Executive Viewer repository.

To modify the properties for this portlet, click the edit button to open the properties page. If the edit button is disabled or not visible, the administrator did not make these settings available to you.

In the portlet properties page, to reset the default portlet settings, or to return to the settings specified by your administrator, click the reset button in the portlet title bar. To exit the properties page without saving the changes, click the return button or click Cancel.

Note: • In SAP Enterprise Portal, portlets are named iViews. This document may refer to iViews as

portlets.• In Microsoft SharePoint Portal Server, portlets are named Web Parts. This document may

refer to Web Parts as portlets.

The following table shows the properties that you can change:

Accepted Events Select the events the Executive Viewer Portlet should accept:• Offspread Change events of an Executive Viewer Portlet.• Inspread Change events of an Executive Viewer Portlet.• Select View events of a View Selector Portlet.

It is possible to specify a comma separated list of channels in the Receive Channel(s) field.

If no Receive Channels is specified, all sent events are accepted. For more information see the section ‘Enable communication between Executive Viewer Portlets’ in this chapter.


Title Specifies the title of the portlet. You can choose to:• Use the name of the Active View.• Use a custom title.

Note: The title does not appear in all portals, such as the WebSphere, Plumtree, and SAP portals.

Height (pixels) Specifies the portlet height in pixels. If the View Selector is larger than this setting, scroll bars appear.



Executive Viewer Server Location

This property represents the location of an Executive Viewer Server. In order to communicate with an Executive Viewer Server, you must specify a valid URI (Unified Resource Identifier).

A valid URI can exist of the following parts:• Protocol (optional);• Host;• Port (optional);• Path (optional).


The Host must be specified. If a URI part is not specified its default value will be used.

Root Folder Specifies the path of the Root Folder that is shown in the View Selector Portlet. The name of the Folder must be exactly the same as it is available in the Executive Viewer repository.

All Views, folders and subfolders that are available in the Root Folders are visible.

Send Events Specifies the name of the channel that you want to use for communication between portlets.

It is possible to specify a name for the channel that is used by a portlet to send events.

If no channel is specified, the events will be sent to all channels.

Please refer to the section ‘Enable communication between Executive Viewer Portlets’ in this chapter.



Enable Communication Between Executive Viewer Portlets

In this section the communication between Cognos Executive Viewer source Portlets and target Portlets is described.

For a complete overview of the possible Cognos source Portlets and target Portlets, see the chapter ‘Pages and Dashboards’ in the IBM Cognos 8 Administration and Security Guide.

You can enable portlet-to-portlet communication so that the portlets can interact via events. Portlets on the same pages can communicate between each other. For example, you can use this functionality when you want to change the selected Offspread or Inspread members of an Executive Viewer View and see the changes being reflected in charts that are displayed by other Executive Viewer Portlets on the same page.

An Executive Viewer Portlet is able to send and accept events.

Send Events

An Executive Viewer Portlet always sends events. If you want to send an event to only to a specific Executive Viewer Portlet, you have to specify a channel for communication. You can specify a channel for an Executive Viewer Portlet via which events are sent.

If you do not specify a channel to send events, the event will be sent via all channels.

Steps to send events from Executive Viewer Portlets via a specific channel:1.Go to the page or the dashboard that contains the Executive Viewer Portlet for which you

want to specify Send Events via channels.2.Click the edit button in the portlet title bar.3.For the Send Events property, specify he name of the channel you want use for sending

events.The name can contain letters, numbers, and underscore (_) characters, but must not contain any spaces. For example, Cognos, Cognos_Portlets, CognosPortlets are valid names.

4.Click OK.

Receive Events

An Executive Viewer Portlet will accept an event that comes from another Executive Viewer Portlet if both portlets use the same channel.

If you do not specify a Receive Channel, the Executive Viewer Portlet will accept all events that are sent by other Executive Viewer Portlets on the portal page, independent of the Executive Viewer Portlet that sends the events.

Steps to accept events from Executive Viewer Portlets via a specific channel:1.Go to the page or the dashboard that contains the Executive Viewer Portlet for which you

want to specify Receive Channels.2.Click the edit button in the portlet title bar.3.For the Receive Channels, specify he name of the channels you want use for accepting

events.The name can contain letters, numbers, and underscore (_) characters, but must not contain any spaces. For example, Cognos, Cognos_Portlets, CognosPortlets are valid names.

4.Click OK.


16 Executive Viewer Language Editions

Server Installation and Configuration Guide 195 16 Executive Viewer Language Editions

Available Language Editions

Every language version of Executive Viewer is individualized, resulting in a separate product per language. This means an Executive Viewer Client will be installed for each language and the separate languages will be able to operate next to each other.

Each language version has a unique CLSID. The CLSID can updated per every new major release of Executive Viewer. Available for Executive Viewer Client 9.4:

Consult the chapter ‘Executive Viewer Client’ for explanation about Executive Viewer Client 9.4.

Language: CLSID: Cabinet File:

English ACAC1200-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6En.cab

French ACAC1300-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Fr.cab

German ACAC1400-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6De.cab

Spanish ACAC1500-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Es.cab

Dutch ACAC1600-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Nl.cab

Danish ACAC1700-0BBE-499A-A9E9-5F334DBC8E89 EVCtr6lDa.cab

Chinese ACAC1800-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Zh.cab

Japanese ACAC1900-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Ja.cab


Language EV Client in Executive Viewer Explorer

When Executive Viewer Client is installed either when opening a View in Executive Viewer Explorer, or when using the URL API or the ‘Render’ Method from Executive Viewer Server’s Web Service, the language version of Executive Viewer that is installed depends on the culture of the client or the culture of Executive Viewer Server.


• EVCtrl6En.cab• EVCtr6lDa.cab• EVCtrl6De.cab• EVCtrl6Es.cab• EVCtrl6Fr.cab• EVCtrl6Nl.cab• EVCtrl6Zh.cab• EVCtrl6Ja.cab

If the first culture contains a language that is not supported by Executive Viewer, the culture of Executive Viewer Server is used to determine which language to install.If the culture of Executive Viewer Server contains a language that is not supported by Executive Viewer, the English version is downloaded and installed.

It is possible to determine on the Executive Viewer Server side which language should be installed on a client. This can be done with the Methods ‘CreateSession’ and ‘CreateSessionImpersonated’.Consult the ‘EV Server API Reference’ for more information about these Methods.

Note: For explanation about installation of the files, consult the chapter ‘Executive Viewer Client’.

In Internet Explorer, ‘Tools’, ‘Internet Options’, ‘General’, ‘Languages’ the culture of the client can be set.

When opening a View in Executive Viewer Explorer, the first culture set here is downloaded and installed.


17 Maps

Server Installation and Configuration Guide 198 17 Maps

Introduction Maps

This chapter describes how EV-Connect for Maps works and how it can be extended and configured for specific database models. For installation of Maps, see the chapter ‘Installation of the Software’.

EV-Connect for Maps is a component that adds support for displaying geographic Maps in Executive Viewer Client.

This chapter does not describe how to use the Maps in the client software, but focuses on the setup and configuration of Maps on Executive Viewer Server. For more information about the client using Maps, see the ‘IBM Cognos TM1 Executive Viewer User Manual’.


Directory Structure

In this example, the ‘Executive Viewer\Server\Maps’ directory is the root directory for Maps, and the ‘Example’ and ‘World’ directories are represented as libraries. The ‘World’ directory contains all the .shp and .dbf files and a file called ‘libinfo.xml’. These files are explained further in this chapter.

The organization of Maps into libraries and layers is simply done by copying the shape file into the proper subdirectories. Executive Viewer Server has one root directory for Maps, which you can determine when installing the software.The default location is:

C:\Program Files\IBM Cognos TM1\Executive Viewer\Server\Maps

Inside this root directory, there is one subdirectory for each library. Each library directory contains all the shape files and database files which together make up the layers for that library.


Libraries, Layers and Shapes

Before starting, it is important to understand the concepts of libraries and layers. These are the fundamental concepts you use to arrange all the geographic Maps in your organization.Each Map is represented by a shape file (.shp) and a corresponding database file (.dbf). The shape file contains coordinates to draw the Map. The database file contains data about the Map, such as names of regions and additional statistical data. We call the shape file and associated database file a ‘layer’.

A single layer consists of a collection of shapes. A shape is the representation of a geographic area, for example a country, a region, a state or a city. It is the smallest identifiable element in a Map and it is the element that is matched against the members in your OLAP database outline. More about this matching is explained further in this chapter.

Rather than putting all geographic data into one huge layer, it might be more efficient to create smaller layers covering a small part of the complete geographic area. For instance, the ‘World’ library supplied with Executive Viewer Server is broken up into a layer for each continent, layers for the individual countries or regions and layers for each state or province in the various countries or regions. All together, these layers form a library covering one complete geographic area. Therefore, the definition of a library is a collection of layers that share the same coordinate system and together make up one geographic area.

If you look closely at the sample Maps supplied with Executive Viewer Server, you see there are various degrees of detail in the layers. For instance, there is one layer for Europe showing all European countries or regions. There are layers for each individual European country or region, each adding more detail to the Map. Since the layers share the same coordinate system, they can easily be drawn on top of each other, giving the user a Map with different levels of detail on the various parts of the Map. This is ideal for displaying data from hierarchical dimensions.


Mapping File

Executive Viewer Server uses an intermediary file to handle matching outlines to Maps, so you do not have to change each and every database outline to exactly match the shapes in your Map libraries, and you also do not have to make adjustments to your shape files. This file is called the ‘mapping file’. The file name of the mapping file is always ‘libinfo.xml’. Each library contains exactly one mapping file with mappings for every layer in the library.

The libinfo.xml file is readable and editable using a text editor like Notepad. An example of a libinfo.xml file follows:

<?xml version="1.0"?><LIBRARY> <LAYER FILE="North America" LEVEL="0"> <MAPPING COL="CNTRY_NAME" ALIASTABLE=”Default”/> </LAYER> <LAYER FILE="USA" LEVEL="0"> <MAPPING COL="STATE_NAME" ALIASTABLE=”Default”/> </LAYER></LIBRARY>

By convention, the file always starts with the version number. Executive Viewer Server does not use the tag, but it should be there for completeness.

There is one element called <LIBRARY>. This element is terminated by the </LIBRARY> element, at the bottom of the file. In between this library definition, the definitions for all layers in the library are specified.

Every layer starts with <LAYER> and ends with </LAYER>. A layer has a number of mandatory and optional attributes (for explanation, see further in this chapter). The order of layers in the libinfo.xml file is important. Layers with the lowest level of detail appear first, followed by layers with a higher detail. This will ensure states are drawn on top of countries or regions and countries or regions are drawn on top of continents.

Each mapping element can have two parts, one part defines records in the shape file to be matched (left side of the mapping arrow in the figure) and one part defines the criteria in the outline to be used (right side of the mapping arrow).Here is an example mapping the shape ‘New York’ to the member ‘NY’ in a database outline:

<MAPPING COL=”STATE_NAME” QUERY=”STATE_NAME=’New York’” MEMBERNAME=”NY”/>

More information on each of the tags and attributes you can use to define mappings can be found in the ‘Tag Reference’ section in this chapter.

One of the most important processes in the Map feature is the process that associates members in your database outline to shapes in various layers. This is important to ensure the data for the members in your outline are placed on the right locations on the right Map. For example, the member ‘California’ in the outline should be mapped on the shape called ‘California’ on the layer ‘USA’, that is part of the library ‘World’.

Finally, each layer can contain one or more mappings, identified by the <MAPPING> tag. A mapping defines the actual link between the members in a database outline and the shapes in a layer. This figure illustrates this.


An important thing to remember is that every tag must be terminated by an end-tag. In the example code above, you saw the <LIBRARY> tag was terminated at the bottom of the sample with the </LIBRARY> tag. The ‘/’ character specifies the tag is an end-tag. Similarly, the <LAYER> tag is terminated with the </LAYER> tag. You might have noticed the <MAPPING> tag does not have a corresponding </MAPPING> tag. This is because an inline terminator is used. This is specified by putting the ‘/’ character before the ‘>’ character at the end of the line. So:

<MAPPING COL=”STATE_NAME”/>

is exactly the same as:

<MAPPING COL=”STATE_NAME”></MAPPING>

The first method is easier to read.

The libinfo.xml file supplied with the Executive Viewer Server sample Maps is a generic one. This means it will match any outline you supply with the names as they occur in the database files. If you want to keep this generic behavior, but also want to add exceptions to it, you can add more mapping tags. For example:

<LAYER FILE=”USA”> <MAPPING COL=”STATE” QUERY=”STATE=’New York’” MEMBERNAME=”New_York”/> <MAPPING COL=”STATE”/></LAYER>

In this example, the first mapping makes sure if a member is encountered in your outline with the name ‘New_York’ (with underscore), it is mapped to the shape ‘New York’ (without underscore). For all other members, the second mapping is used, which just matches the member name by comparing it to the value found in the ‘STATE’ column of the usa.dbf file. This example shows that mappings are evaluated in the order they are encountered in the XML file. If a match is made, no further checking is performed. This ensures an outline member matches at least one shape on a Map.

Note: After changes are made to the libinfo.xml, the IBM Cognos TM1 Executive Viewer service needs to be stopped and restarted.


Tag Reference<LIBRARY>

DescriptionThe ‘LIBRARY’ tag is the first tag to be defined in the libinfo.xml file. The tag may only appear once, and it is used to hold the collection of layers. This tag is also used optionally to give the library a different name from the directory name the library is actually in.

AttributesThe ‘NAME’ attribute is an optional attribute to give the library a name different from the name of the library directory. If this attribute is omitted, the library is referenced by its directory name.

Examples

<LIBRARY NAME=”World Maps”><LIBRARY>

<LAYER>

DescriptionIn the ‘LAYER’ tag, you define the behavior of a single layer in the Map library. You can give the layer a name, specify its level of detail and specify one or more mappings.

Attributes• The ‘NAME’ attribute is optional and gives the layer a name other than its file name. This is

convenient in cases where layers have file names that are coded and not easy to read. If the ‘NAME’ attribute is omitted, the file name is used as the layer’s name.

• The ‘FILE’ attribute is a mandatory attribute. It defines the name of the shape file and database file that make up this layer. The name is specified without a file extension.

• ‘LEVEL’ is an optional attribute to define the level of detail of a layer. The ‘LEVEL’ is a number in the range 0-9999, where 0 indicates the lowest level of detail and 9999 the highest level. Layers that have the same level of detail, for instance all continent Maps, have the same level number.

Examples

<LAYER FILE=”usa”><LAYER NAME=”U.S.A.” FILE=”usa” LEVEL=”1”><LAYER NAME=”Brazil” FILE=”brasil” LEVEL=”1”>

<MAPPING>

Description‘Mappings’ are the lowest level in the process of matching an outline member to a specific shape.

Attributes• The ‘COL’ attribute is mandatory. It defines which column in the database file is used for

matching members in the outline. The column must be specified by name for matching to occur. This attribute is not case-sensitive.

• The ‘QUERY’ attribute is optional. The ‘QUERY’ attribute limits records to be mapped. For instance, you can create a mapping for only the countries or regions of a certain continent, or create a mapping for one specific state. See also the examples below.

• The optional ‘LEVEL’ attribute can be used to specify the level at which an outline member must be before it will be matched against the records in the database file. This makes it easy to map, for example, all level 0 members of an outline to a specific layer.


• The optional ‘GENERATION’ attribute is used to specify the generation at which an outline member must be before it will be matched against the records in the database file.

• By specifying the name of a member with the ‘MEMBERNAME’ attribute, you tell the mapping process to match a particular member to a shape that can have a different name. Use this attribute if the members in your outline are named differently than the shapes in the Map library, and/or matching by level or generation is not possible. This attribute is optional.

• You can limit the mapping process to a specific dimension by using the ‘DIMENSION’ attribute. This can increase the speed of the search process because only the specified dimension is searched to get a possible match. This attribute is optional.

• The ‘ANCESTOR’ attribute is optional and used to limit the matching process to descendants of the specified ancestor.

• The ‘PARENT’ attribute is optional and is used to limit the matching process to children of the specified parent. See the first example below.

• The ‘ALIASTABLE’ attribute is optional and is added to the default libinfo.xml. This attribute is treated differently for the available OLAP databases:

Essbase - The ‘ALIASTABLE’ attribute is used to match your database files with an Alias Table in your Essbase outline.Other OLAP Servers - Executive Viewer Server may use unique member names for members of an OLAP database. The member names shown in Executive Viewer may not be the same as these unique member names. To tell Executive Viewer Server to match the member names in the dbf files to the member names shown in Executive Viewer, the attribute ‘ALIASTABLE=default’ is used. If this Attribute is not added, not all Maps may show.Therefore, this attribute tag is recommended when connecting to other OLAP Servers, even if ‘Aliastable’ is not a feature of these OLAP Servers.

Examples

<MAPPING COL=”CNTRY” QUERY=”CONTINENT=’Europe’” PARENT=”EUR”><MAPPING COL=”STATE_NAME”><MAPPING COL=”CNTRY” LEVEL=”0”><MAPPING COL=”CNTRY” DIMENSION=”Market”><MAPPING COL=”CNTRY” QUERY=”CNTRY=’Belgium’” MEMBERNAME=”BE”><MAPPING COL=”CNTRY” ALIASTABLE=”GEO_NAMES”/>


More Examples

In this section you can find a few examples of using the Map feature to match with your situation. For more information on Maps, consult our Knowledge Base at support.cognos.com.

Note: On our Support Center at support.cognos.com, you can download a large number of Maps to extend the sample library.

For example, in your outline you have a member called ‘USA_WA’ that represents the state of Washington. In the DBF file (USA.dbf) the state of Washington is represented as ‘Washington’ in the column ‘STATE_NAME’. To match the member ‘USA_WA’ with the state of Washington in the Map, make the following changes to the libinfo.xml file:

<LAYER FILE="USA" LEVEL="1"> <MAPPING COL="STATE_NAME" QUERY="STATE_NAME='WASHINGTON'" MEMBERNAME="USA_WA"/> <MAPPING COL="STATE_NAME"></LAYER>

The libinfo.xml file still maps on the ‘STATE_NAME’ column, but is told that ‘Washington’ should be mapped against ‘USA_WA’ in your outline. The other members in your outline are matched with the names in the ‘STATE_NAME’ column.

Do not forget to stop and restart the IBM Cognos TM1 Executive Viewer service after you made changes to the libinfo.xml.

Open the DBF file with Microsoft Excel and add another column. Name this column for instance ‘OLAP’.In this example, the outline names are ‘USA_WA’, ‘USA_MT’, ‘USA_ME’, ‘USA_ND’ etc. (see also the previous example). After this, adjust the libinfo.xml file to make the mapping on the ‘OLAP’ column instead of the ‘STATE_NAME’ column:

<LAYER FILE="USA" LEVEL="1"> <MAPPING COL="OLAP" PARENT="USA"/></LAYER>

You can save the dbf file in a dbf3 format.Do not forget to stop and restart the IBM Cognos TM1 Executive Viewer service after you made changes to the libinfo.xml.

1.Adjust the libinfo.xml

This is the most powerful way to make the DBF files and the outline ‘communicate’.

1.Make an extra column in the DBF file

The DBF file can be found in

C:\Program Files\IBM Cognos TM1\Executive Viewer Server\Maps\World


The advantage of this method is you do not have to adjust the libinfo.xml file, because the libinfo.xml file already maps on the ‘STATE_NAME’ column. You can save the dbf file in a dbf3 format.

Do not forget to stop and restart the IBM Cognos TM1 Executive Viewer service after you made changes to the libinfo.xml.

1.Adjust the ‘STATE_NAME’ column in the DBF file

This method is similar to the previous method. Open the DBF file and change the names in the ‘STATE_NAME’ column (the column the libinfo.xml uses to map the file to the outline) to the names you are using in your outline.

1.Adjust the member names

You can adjust the member names to the names as displayed in the DBF file. Look in the libinfo.xml file which column is used for the mapping and change the member names accordingly. This may often not be the best option, but when making a new database, it might be acceptable.

Note: Screenshot from Essbase Application Manager – this is not an Executive Viewer screen.

1.Use an Alias Table

You can use an Essbase Alias Table to let your outline and the DBF file correspond. You can use an existing Alias Table in Essbase or make a new one. For example, make a new Alias Table called GEO_NAMES.Adjust the libinfo.xml to make the mapping for the Alias Table:

<LAYER FILE="USA" LEVEL="1"> <MAPPING COL="STATE_NAME" ALIASTABLE="GEO_NAMES"/></LAYER>

Note: If you use the 'PARENT' attribute in combination with the 'ALIASTABLE' attribute, the parent member specified should refer to the alias name of that parent member.


Log File

A log file is created when error conditions occur while processing Maps. The errors are logged in the ‘EVServerLog.xml’ file.

The XML file ‘EVServerLog.xml’ is created every day in the installation directory, which is by default C:\Program Files\IBM Cognos TM1\Executive Viewer\Server.

This log file displays errors with Maps.

If you open the libinfo.xml file with Internet Explorer, Internet Explorer will stop displaying the contents of the xml file when a syntax error is encountered.


18 Ports and Protocols

Server Installation and Configuration Guide 209 18 Ports and Protocols

Communication Over HTTP Protocol

Executive Viewer Explorer communicates with Executive Viewer Server through Executive Viewer Server’s Web Service, by default using the HTTP protocol on port 80.Executive Viewer Client communicates with Executive Viewer Server over TCP/IP port 7112, using Cognos’s proprietary protocol.

Executive Viewer Server also facilitates communication between Executive Viewer Client and Executive Viewer Server over the HTTP Protocol.

Both communication channels are available at the same time. The preferred communication channel can be changed.

Changes on Executive Viewer Server side:To change the communication channel to the HTTP Protocol, the 'EVServer.exe.config' file has to be changed.The 'EVServer.exe.config' file can by default be found in 'C:\Program Files\IBM Cognos TM1\Executive Viewer\Server'. Open this file with Notepad to view, add or edit settings.To make the changes to this file effective, Executive Viewer Server needs to be stopped and restarted.

In the <appSettings> section of this file, the preferred protocol can be set by adding the following line:

<add key="ServerProtocol" value="HTTP"/>

or

<add key="ServerProtocol" value="HTTPS"/>

This settings is used for rendering the correct parameters in the HTML file of Executive Viewer Client. The default value corresponds to:


<add key="ServerProtocol" value="TCP"/>

In addition to setting the preferred protocol, it is also possible to change the port that is used for HTTP(S) communication. You do this by adding one of the following keys and changing the value as required:

<add key="HTTPPortNumber" value="80"/>

With this key you can change the HTTP Port number, which is by default ‘80’.

<add key="HTTPSPortNumber" value="443" />

With this key you can change the HTTPS Port number, which is by default ‘443’.

Changes on Executive Viewer Client side:If Executive Viewer Client is made available to the client using Executive Viewer Server’s Web Service (this is the case when working with Executive Viewer Client in Executive Viewer Explorer, or when using the ‘Render’ Method), or when using the URL API, no settings have to be changed on the client side. Executive Viewer Server provides the client with the correct settings.

When using a separate HTML page, the protocol (and port) to be used has to be added as a Property on the HTML page. Consult the ‘IBM Cognos TM1 Executive Viewer Integration Guide’ for information about the ‘Port’ and ‘Protocol’ Property.

Note: For explanation about the ‘Render’ Method, consult the ‘Executive Viewer Server API Reference’.

Note: For explanation about ‘EVServer.exe.config’ file, consult the chapter ‘Configuration Files’.


Ports

It is possible to only change the port used for communication between Executive Viewer Client and Executive Viewer Server with Cognos’s proprietary protocol.

Changes on Executive Viewer Server side:It is possible that another application communicates over the same ports as Executive Viewer. To communicate over other port numbers, you have to make changes in the ‘EVServer.exe.config’ file. The ‘EVServer.exe.config’ file can be found by default in ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server’.

Open the ‘EVServer.exe.config’ file in Notepad to see, add or edit settings. After changes have been made to this file, the IBM Cognos TM1 Executive Viewer service needs to be restarted in order for the changes to take effect.

In the <appSettings> section of the ‘EVServer.exe.config’ file, the values for the following ports can be set:

Changes on Executive Viewer Client side:If Executive Viewer Client is made available to the client using Executive Viewer Server’s Web Service (this is the case when working with Executive Viewer Client in Executive Viewer Explorer or when using the ‘Render’ Method or the ‘URL API’), no settings have to be changed on the client side, Executive Viewer Server provides the client with the correct settings.

ServerPortNumber The ServerPortNumber is the port number by which Executive Viewer Client communicates with Executive Viewer Server.

<add key="ServerPortNumber" value="7112"/>

By changing this line to the value below, you can change the TCP port number to be used. For example:

<add key="ServerPortNumber" value="7123"/>

If the ‘ServerPortNumber’ key is not added to the ‘EVServer.exe.config’ file, or if it is not correctly configured, Executive Viewer Server takes the setting from the ‘services’ file in the ‘C:\Windows\system32\drivers\etc’ directory.Open the ‘services’ file in Notepad and add the following line to the end:

EVWebSvr 7123/tcp

Press ‘Enter’ and save the ‘services’ file. Reboot the system for the changes to take effect.

RemotingPortNumber The RemotingPortNumber is the port number by which the WebService communicates with Executive Viewer Server.

<add key="RemotingPortNumber" value="7113"/>

By adding this line, you can change the TCP port number to be used. For example:

<add key="RemotingPortNumber" value="7456"/>


When you are using a separate HTML page, the port (and protocol) to be used has to be added as a Property on the HTML page. Consult the ‘IBM Cognos TM1 Executive Viewer Integration Guide’ for information about the ‘Port’ and ‘Protocol’ Property.

Note: For explanation about the ‘Render’ Method, consult the ‘Executive Viewer Server API Reference’.

Note: For explanation about ‘EVServer.exe.config’ file, consult the chapter ‘Configuration Files’.

Note: We recommend changing the port only if conflicts occur with other products using the same port.


19 Updates and Upgrades

Server Installation and Configuration Guide 214 19 Updates and Upgrades

Upgrade from Older Versions to Version 9.4

Normally, it is possible to connect with a newer Executive Viewer Client to an older Executive Viewer Server (backwards compatibility).Version 9.4 broke with backwards compatibility. This means it is no longer possible to connect with a 9.4 or higher Executive Viewer Client to an older version of Executive Viewer Server (versions prior to version 9.4).Therefore, both Executive Viewer Client and Executive Viewer Server need to be of version 9.4 or higher to be able to connect.

From version 9.4, the unique name to identify Executive Viewer Client (the CLSID) has changed. The consequence of this is that the old version will still be available on the system, when upgrading Executive Viewer Client from an older version to version 9.4 or higher.In order to have a clean installation, it is recommended to uninstall the current version of Executive Viewer Client and install version 9.4.See the chapter ‘Removing the Software’ for more explanation on how to uninstall the software.

As 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 higher to version 9.4, you are advised to first upgrade to version 9.3 and then to 9.4.

For Executive Viewer Server it is not necessary to uninstall the software. The setup routine will detect the files of the previous version and upgrade the software. This means you can run the setup routine, as you would do with a clean installation.

Note: ‘Executive Viewer Server Manager Classic’ is not removed when upgrading Executive Viewer Server. It needs to be uninstalled manually.

Note: See the chapter ‘Installation of the Software’ for explanation about installation.


Update Executive Viewer Client

Update through Executive Viewer Server’s Web Service:If Executive Viewer Client is made available to the client using Executive Viewer Server’s Web Service (this is the case when working with Executive Viewer Client in Executive Viewer Explorer, or when using the ‘Render’ Method) or when using the URL API, Executive Viewer Client is automatically updated when necessary. This is the recommended way to update, Executive Viewer takes care of the process of updating and makes sure the correct files are installed on the client side.


• EVCtrl6En.cab• EVCtr6lDa.cab• EVCtrl6De.cab• EVCtrl6Es.cab• EVCtrl6Fr.cab• EVCtrl6Nl.cab• EVCtrl6Zh.cab• EVCtrl6Ja.cab

When opening a View, EVCtrl6En.cab will be installed.The cabinet file contains a setup executable, which installs and registers all the necessary parts of Executive Viewer Client. Internet Explorer triggers the process of installing when it detects the software has not yet been installed or a newer version is available.

Manual update:When you are using a separate HTML page, the version number has to be adjusted in the HTML page and the correct cab file has to reside on the same directory as the HTML file.

When upgrading, follow this sequence:• First replace the EVCtrl6En.cab file with the new version• Then adjust the HTML file

CODEBASE="EVCtrl6En.cab#version=9,4,1,0"

The next time a user enters the URL the update will be installed. For security settings, see the chapter ‘Executive Viewer Client’. If the update does not get installed, it could be due to security settings or because the HTML file is cached in the web browser. Reloading the page will download the new HTML page.

• Finally, update Executive Viewer Server.

This can be done by running the setup routine. Settings made before will not be overwritten and there will be no loss of Items.This sequence is important, because a newer Executive Viewer Client can connect to an older Executive Viewer Server. An older Executive Viewer Client cannot connect to a newer Executive Viewer Server.When using Executive Viewer Client version 9.4 or higher, it is not possible to connect to an Executive Viewer Server of a version prior to 9.4.


Executive Viewer Client 9.4Executive Viewer Client is available as an ActiveX edition that contains the ‘ViewCtrl’ control (Executive Viewer Client 9.4) to display Views.

A View Item is displayed in Executive Viewer Client 9.4, showing the data, stored in the OLAP database.

Note: For an explanation of the installation of these files, consult the chapter ‘Executive Viewer Client’.


20 Removing the Software

Server Installation and Configuration Guide 218 20 Removing the Software

Removing Executive Viewer

This chapter describes how to uninstall the Executive Viewer software. When upgrading, it is not necessary to uninstall the old version of Executive Viewer Server or Executive Viewer Client.

However, when upgrading from a version prior to 6.0 build 1 to Executive Viewer Client version 9.4 or higher, it is advisable to uninstall the older version of Executive Viewer Client.See the chapter ‘Updates and Upgrades’ for more information.

The Repository, containing all Executive Viewer Items, will not be removed. There will be no loss of Maps when removing the software.

Steps to uninstall Executive Viewer via ‘Remove’:1.Open the ‘Control Panel’. 2.Choose ‘Add or Remove Programs’. 3.Click ‘IBM Cognos TM1 Executive Viewer’. 4.Click ‘Remove’.5.After clicking ‘Yes’ on the confirmation dialog, the Executive Viewer software will be

removed.

Steps to uninstall Executive Viewer via ‘Change’:1.Open the ‘Control Panel’. 2.Choose ‘Add or Remove Programs’. 3.Click ‘IBM Cognos TM1 Executive Viewer’.4.Click ‘Change’.

If the IBM Cognos TM1 Executive Viewer service is still running, a warning is shown. People that are currently connected to IBM Cognos TM1 Executive Viewer will lose their work when the service stops. You can choose to stop the service and continue the removal of the software by clicking on ‘Yes’. If you click ‘No’, you will exit the uninstall mode.

5.Three options are given: Modify, Repair and Remove.6.Select ‘Remove’ and click ‘Next’.7.Click ‘Remove’ to remove the software.8.Click ‘Finish’ to exit the wizard.

The Repository and the ‘Maps’ directory will not be removed to prevent the loss of Items or customized Maps. The ‘Maps’ directory can be removed with Windows Explorer and the Repository can be removed in Windows Explorer or with the manage application of the used Catalog Provider.


Removing Executive Viewer Client

When uninstalling Executive Viewer Client, there will be no loss of Items.

Steps to uninstall Executive Viewer Client:1.Go to ‘Start’, ‘Settings’, ‘Control Panel’.2.Choose ‘Add or Remove Programs’.3.Click ‘Executive Viewer Client’. 4.Click on ‘Change/Remove’.5.After clicking ‘Yes’ on the confirmation dialog, the Executive Viewer Client is removed.

Note: If Executive Viewer Client is running, a message states that IBM Cognos TM1 Executive Viewer Client is currently in use. You will have to close Executive Viewer Client in order to uninstall.


21 Hyperion Essbase

Server Installation and Configuration Guide 221 21 Hyperion Essbase

EV-Connect for Hyperion Essbase

Executive Viewer Server can connect to the following OLAP servers:• Cognos TM1, version 9.1 and higher;• Hyperion Essbase and IBM DB2 OLAP Server;• Showcase AS400 OLAP Server version 3.5 and higher;• Microsoft Analysis Services.


Essbase Runtime Clients

For Executive Viewer Server to be able to access Essbase databases and/or when using the Essbase Security Provider, it is necessary the proper Essbase Runtime Client files are installed on the computer running Executive Viewer Server. The version of the Runtime Client must be exactly the same as the version of Essbase you are using.

If you upgrade Essbase, you should upgrade the Runtime Clients also!

You can download the Essbase Runtime Clients from Hyperion: www.hyperion.com, or find the appropriate Runtime Client with your Hyperion software.

Note: For more information about the Essbase Security Provider, consult the chapter ‘Security Providers’.


Essbase Data Source Settings

When a Hyperion Essbase Data Source is added, it can be configured for the following items:• Preload Databases;• Personalize Databases;• Remove One Member Dimensions;• Retain Structure Using Labels;• Add Substitution Members.

• Preload Databases:

This setting can be set for all Databases at once or for specific Databases. Here you can specify if Executive Viewer Server should load the Essbase Databases on this Essbase Server automatically at startup.By doing this, users can connect immediately to the database and access its outline and data instantly without delays caused by opening the database. Even for very large outlines, user access is instantaneous when connecting to Executive Viewer with only minimal network traffic.

• Personalize Databases:This setting can be set for all Databases at once or for specific Databases. ‘Personalize Databases’ allows you to limit the outline of all users according to their access rights within Essbase. According to the filters defined for this user in Essbase, the outline will be stripped of those members to which the user has no read access. Using this feature allows you to hide sensitive information in the outline or to simplify outlines for certain users. It also makes it possible to easily create personal reports.

• Remove One Member Dimensions:This setting can be set for all Databases at once or for specific Databases. With this option you can remove dimensions from the outline, when only one member with data remains when a database is personalized. For example, if the Essbase filter only allows a user to see ‘New York’, the ‘Market’ dimension will be completely hidden.


Changes made here can be applied immediately by pressing the ‘Update’ button at the bottom of the page.

Note: For general explanation about Data Source Items consult the chapter ’Executive Viewer Explorer’.

• Retain Structure Using Labels:This setting can be set for all Databases at once or for specific Databases.When only members on a lower level are accessible when a Database is personalized, members on a higher level disappear. This changes the structure of the outline. If this behavior is not desirable, use this option to have Executive Viewer Server insert those members again as a label. The user still has the original structure to work with, but does not see data from these members.

• Add Substitution Members:This setting can be set for all Databases at once or for specific Databases.An Essbase Substitution Variable is a global variable you can set that applies for the entire Database. These Substitution Variables can be treated as a member of the dimension for which they are defined. By enabling this option, the Substitution Variables will be added to the outline as Substitution Members.


Essbase Database Settings

For each Essbase Database Item it is possible to set the one of the following options:• Preload;• Personalize;• Personalized Dimensions;• Remove One Member Dimensions;• Retain Structure Using Labels;• Add Substitution Members.

See the previous section for an explanation of these options. The option ‘Personalized Dimensions’ is explained in this section.

• Personalized Dimensions:

Note: For general explanation about Database Items consult the chapter ’Executive Viewer Explorer’.

It is possible to specify dimensions that should not be personalized if the ‘Personalize’ option is checked, or specify the Dimensions that should be personalized, if the ‘Personalize’ option is not checked.

When specifying dimensions in the ‘Personalized Dimensions’ field while the ‘Personalize’ option is not checked, only these dimensions will be limited to users according to their access rights within Essbase. The dimensions that are not specified will show without any restrictions applied. This means members that the user has no access to in these dimensions, will show as ‘no access’.

The dimension names can be entered in the ‘Personalized Dimensions’ field, separated by a semi-colon.

1.Enable or disable the ‘Personalize’ option2. In this example, the dimensions

‘Year;Product;Market’ are not personalized


22 IBM Cognos TM1

Server Installation and Configuration Guide 227 22 IBM Cognos TM1

EV-Connect for IBM Cognos TM1

Executive Viewer Server can connect to the following OLAP servers:• IBM Cognos TM1, version 9.1 and higher;• Hyperion Essbase and IBM DB2 OLAP Server;• Showcase AS400 OLAP Server version 3.5 and higher;• Microsoft Analysis Services.


TM1 OLEDB Provider

In order to be able to connect to the TM1 server, the TM1 OLEDB Provider needs to be installed on the machine running Executive Viewer Server.

The TM1 OLEDB Provider can be installed from the TM1 CD. Start ‘setup.exe’ and choose ‘TM1 OLEDB Provider’ to be installed.

1.Choose ‘TM1 OLEDB Provider’

After installation of the TM1 OLEDB Provider, the name of the ‘adminhost’ needs to be set in the 'Tm1p.ini' file. The ‘adminhost’ is the name of the machine that runs TM1 admin server. The name of the adminhost should be set in order to be able to connect to the TM1 servers managed by this adminhost.

The ‘Tm1p.ini’ file is installed during the installation of the TM1 OLEDB Provider.

Please consult the TM1 documentation for the exact location of this file.

Open the file with Notepad and enter the name of the adminhost. Save and close the file.


TM1 Data Source Settings

When a Cognos TM1 Data Source is added, it can be configured for the following items:• Preload Cubes;• Provider Specific.



Note: The name of the TM1 Server is the name set during the setup of TM1.

• Preload Cubes:This setting can be set for all Databases at once or for specific Databases.Here you can specify if Executive Viewer Server should load the TM1 Databases on this TM1 Server automatically at startup.By doing this, users can connect immediately to the database and access its outline and data instantly without delays caused by opening the database. Even for very large outlines, user access is instantaneous when connecting to Executive Viewer with only minimal network traffic.

• Provider Specific:This setting can be set for all Databases at once or for specific Databases.Click on ‘Add’ to add a Provider Specific setting.Specific OLE DB Properties can be set here.For a complete overview of the Properties available, consult the TM1 Documentation about OLE DB Properties.By default, no Properties are added here. It is recommended when connecting to a TM1 Server to leave this field empty.We advise you to contact our support team if you want to add Properties.


TM1 Database Settings

For each TM1 Database Item it is possible to preload a cube.


By preloading a cube, users can connect immediately to the database and access its outline and data instantly without delays caused by opening the database. Even for very large outlines, user access is instantaneous when connecting to Executive Viewer with only minimal network traffic.


TM1 Aliases

In TM1 aliases can be defined by using properties. Such a property is marked as Alias in the description.

When Executive Viewer opens a TM1 database, all properties marked as ‘Alias’ will be used to populate the alias tables. The name of the property will be used as the name of the alias table.

If a member has a value for this property, then the value is added as an alias name for this member to the alias table.

For information on how to select the Alias tables, please see the IBM Cognos TM1 Executive Viewer User Manual, chapter ‘Basic Navigation’, section ‘Choose Alias Tables’.


23 MS Analysis Services

Server Installation and Configuration Guide 233 23 MS Analysis Services

EV-Connect for Microsoft Analysis Services

Executive Viewer Server can connect to the following OLAP servers:• Cognos TM1, version 9.1 and higher;• Hyperion Essbase and IBM DB2 OLAP Server;• Showcase AS400 OLAP Server version 3.5 and higher;• Microsoft Analysis Services.


Microsoft Analysis Services 2000

To be able to connect to MS Analysis Services 2000, Executive Viewer Server requires PivotTable Services (PTS), Microsoft Data Access Components (MDAC) and Decision Supporting Objects (DSO) to be installed on the machine running Executive Viewer Server.

The recommended way to install these components is to use the setup of MS Analysis Services 2000 and install the client components and DSO. This installs all three of the required components in the correct order. PTS and MDAC should be installed before DSO is installed.On a machine where MS Analysis Services 2000 is installed, these components are part of the MS Analysis Services 2000 installation and therefore do not need to be installed separately.

Microsoft PivotTable Service is a client-side component that allows client access to multidimensional data. PivotTable Service makes calls to the multidimensional data on the Analysis Service Server and presents the data to the client. PivotTable Service can also cache multidimensional data (in memory and on disk) and allow clients to browse the data locally.

Microsoft Data Access Components (MDAC) are key technologies that enable universal data access. Data-driven client/server applications deployed over the web or a local area network can use these components to integrate information from a variety of sources.

Decision Support Objects (DSO) are the components, used to communicate with the MS Analysis Services repository.

If you upgrade MS Analysis Services 2000, you should upgrade these components also!

The full PivotTable Services contains the Microsoft Data Access Components as well.You can find the PivotTable Services, MDAC and DSO components with your MS Analysis Services software.


Microsoft SQL Server 2005 Analysis Services

To be able to connect to MS SQL Server 2005 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 2005 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 2005 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.


NT Security – OLAP Administrators

The account on which the IBM Cognos TM1 Executive Viewer service runs, should also be/have the rights:

• Replace a Process Level Token• Act as part of Operating System - Impersonation• Local Administrators

See the chapter ‘Installation of the Software’ for explanation of how to change these settings.

If the IBM Cognos TM1 Executive Viewer service runs on a different account, this account should be part of the group ‘OLAP- administrators’ on the machine running MS Analysis Services;

Windows 2000, 2003 or Windows XP:• Go to ‘Control Panel’, ‘Administrative Tools’;• Go to ‘Computer Management’;• Go to ‘Local Users and Groups’, ‘Users’;• Double click on the user you want to give

‘OLAP Administrator’ rights, choose ‘Add’ on the ‘Member Of’ tab;

• Click on ‘OLAP Administrators’ or enter ‘OLAP Administrators’, click ‘Add’ or ‘OK’ to add the account.


Windows Integrated Authentication

‘Integrated Authentication’ allows a user to log on using his NT credentials provided at logon time. This implies that a user does not need to specify his username and password.

This feature, however, is restricted by:• The location of the client:

The client has to be in the domain or within a trusted domain to be able to apply ‘Integrated Authentication’;

• The underlying security protocol (NTLM or Kerberos):When using NTLM, Executive Viewer Server and MSAS server need to be on the same machine in order to apply ‘Integrated Authentication’;

• The location of the Executive Viewer Server and MSAS:If Executive Viewer Server and MSAS server are not on the same machine, but both within the same or trusted domain, Kerberos is required as the underlying security protocol in order to apply ‘Integrated Authentication’.

Note: The Kerberos authentication protocol is the default for network authentication on computers with Windows 2000. It verifies the identity of the user and the system, and it transmits only encrypted passwords.

Note: The NTLM (Windows NT LAN Manager) protocol was the default for network authentication in Windows NT 4.0 operating systems. It is retained in Windows 2000 for compatibility with downlevel clients and servers. NTLM is also used to authenticate logons to standalone computers with Windows 2000.


MS Analysis Services Data Source Settings

When a MS Analysis Services server Data Source is added, this server can be configured for the following items:

• Preload Cubes;• Provider Specific (see next section);• Interpret Roles;• Preload Roles.

With this option you can preload the roles defined for a cube. When, for example, the cube with the dimension ‘Market’ is preloaded and a role for only dimension ‘East’ is defined, this outline will be loaded when the option ‘Preload Roles’ is checked.


• Preload Cubes:This setting can be set for all Databases at once or for specific Databases. You can specify if Executive Viewer Server should load the MS Analysis Services cubes automatically at startup.By doing this, users can connect immediately to the cube and access its outline and data instantly without delays caused by opening the cube. Even for very large outlines, user access is instantaneous when connecting to Executive Viewer Server with only minimal network traffic.

• Interpret Roles:This setting can be set for all Databases at once or for specific Databases. If this option is checked, Executive Viewer Server checks which users and groups belong to a role. For the first user to log on, the outline is loaded. If other users connect who belong to the same role, the outline is reused. If this option is not checked, the outline gets loaded for each individual user.

• Preload Roles:This setting can be set for all Databases at once or for specific Databases. This setting only applies to the cubes, that are preloaded, and to Roles which are interpreted.


Option ‘Provider Specific’

By default, no Properties are added here. It is recommended when connecting to a MS Analysis Server to leave this field empty. We advise you to contact our support team if you want to add items.

Executive Viewer Server uses several of the Properties available, such as the ‘Roles’ Property or the ‘MDX Compatibility’ Property.The Properties already in use by Executive Viewer Server may not be specified here.

When specifying Properties in Executive Viewer Explorer, you have to use the Property Name, exactly as specified in the Microsoft documentation. Note that this is case-sensitive.

You can enter multiple Properties by clicking on ‘Add’.Specify the name and the value and click on ‘Update’.

A PivotTable Service Property is passed on to all connections from Executive Viewer Server to MS Analysis Services.


When adding a MS Analysis Services Data Source in Executive Viewer Explorer, it is possible to specify PivotTable Service Properties in the ‘Provider Specific’ field, for example, the ‘Client Cache Size Property’.

Note: For a complete overview of the Properties available, consult the Microsoft Documentation about ‘PivotTable Service Properties’.


MS Analysis Services Database Settings

For each MS Analysis Services Database Item it is possible to set the one of the following options:

• Preload;• Interpret Roles;• Interpret Roles exceptions;• Preload Roles;• Preload Roles exceptions

See the previous section for an explanation of these options. The options ‘Interpret Roles exceptions’ and ‘Preload Roles exceptions’ are explained in this section.

• Interpret Roles exceptions:

• Preload Roles exceptions:


It is possible to specify for each Database the Roles that should not be interpreted if the ‘Interpret Roles’ options is checked, or specify the Roles that should be interpreted, if the ‘Interpret Roles’ option is not checked.

These Roles names can be entered in the ‘Interpret Roles exceptions’ field, separated by a semi-colon.

1.Roles are interpreted when the option ‘Interpret Roles’ is enabled

2.Roles ‘DemoRole’ and ‘SampleRole’ are not interpreted

It is possible to specify for each Database the Roles that should not be preloaded if the ’Preload Roles’ option is checked, or specify the Roles that should be preloaded, if the ‘Preload Roles’ option is not checked.

These Roles names can be entered in the ‘Preload Roles exceptions’ field, separated by a semi-colon.

1.Roles are not preloaded when the option ‘Preload Roles’ is disabled

2.Roles ‘DemoRole’ and ‘SampleRole’ are preloaded


24 Executive Viewer Server - Detailed

Server Installation and Configuration Guide 242 24 Executive Viewer Server - Detailed

Overview

This overview shows you the details and the connections discussed in the previous chapters.

Server Installation and Configuration Guide 243 24 Executive Viewer Server - Detailed

25 Executive Viewer Desktop Explorer

Server Installation and Configuration Guide 244 25 Executive Viewer Desktop Explorer

Introduction

This chapter explains how to install and use Executive Viewer Desktop Explorer. Executive Viewer Desktop Explorer provides a user interface to Executive Viewer Server via Microsoft Windows Explorer.

Executive Viewer Desktop Explorer is a client application for Executive Viewer Server. Executive Viewer Desktop Explorer creates a virtual folder in Windows Explorer called ‘My Executive Viewer’. You can use this virtual folder to perform tasks similar to those of Executive Viewer Explorer. The use of Executive Viewer Desktop Explorer is similar to the use of other folders and files in Windows Explorer. You can use the commonly used Windows procedures, such as ‘drag & drop’ and ‘cut and paste’, to perform tasks.

This image shows a simplified overview of the Executive Viewer Desktop Explorer architecture:


InstallationExecutive Viewer Desktop Explorer needs to be installed separately. After the installation it will be available in Microsoft Windows Explorer and as an icon on your desktop.

Executive Viewer Desktop Explorer is available in a 32-bit and a 64-bit version.

You can obtain the software for either the 32-bit or the 64-bit version, that is needed for the installation, in two ways:

• Download the software from our Support Center at support.cognos.com;• Install the software from CD.

32-bit and 64-bit

Please make sure you download and install the correct version. If you install Executive Viewer on a 32-bit machine, you have to choose the 32-bit version. If you install Executive Viewer on a 64-bit machine, you have to choose the 64-bit version.

Installation of the Executive Viewer Client

During the installation of Executive Viewer Desktop Explorer the Executive Viewer Client will be installed. If you have an Executive Viewer Client installed on your system that has a different CLSID than the version you are installing, two separate Executive Viewer Clients, with different CLSIDs, are installed on your system. For more information about CLSIDs, refer to the chapter ‘Executive Viewer Language Editions’.

If the CLSID of the Executive Viewer Client, that is installed on your system, is the same as the CLSID of the Executive Viewer Client you are about to install, the installed Executive Viewer Client will be replaced by the new one.

Download:

After you have downloaded the software to the directory you chose, double click on‘Setup.exe’ to start the setup.

From CD:

This screen appears if you insert the CD. If it does not appear, go to your CD folder in Microsoft Windows Explorer and double click on ‘Autorun.exe’.

The options in this screen are:• Install Software;• Access User Manuals;• More About Cognos ULC, an IBM Company;• Exit.

Choose ‘Install Software’ - ‘Desktop Explorer’ to start the installation of Executive Viewer Desktop Explorer.

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


Steps to install Executive Viewer Desktop Explorer once you start the setup routine:1.You can choose one of the following languages:

Dutch;English;French;German;Spanish.

2.You can specify the destination where the files will be installed.3.Click ‘OK’ to proceed.4.Read the copyright warning and click ‘Next’.5.You need to agree with the License Agreement by checking the option ‘I accept the terms in

the license agreement’. Click ‘Next’6. In the ‘Application Settings’ screen, you can change:

the location of the installed files by clicking ‘Change...’;the language of Executive Viewer Desktop Explorer by selecting it from the combobox.Click ‘Next’.

7.The installation summary gives you an overview of the items that will be installed.Click ‘Install’ to start the installation.

8.When Executive Viewer Desktop Explorer is installed, click ‘Finish’ to complete the installation procedure.

The default Executive Viewer Server that is added during the installation of Executive Viewer Desktop Explorer, uses the ‘tcp’ protocol for its connection to Executive Viewer Server. For more in formation, see section ‘Connect to Executive Viewer Server’ in this chapter.


LanguageYou can change the language of Executive Viewer Desktop Explorer after the installation of the software.

Steps to change the language of Executive Viewer Desktop Explorer:1.Go to ‘Start’, ‘Settings’, ‘Control Panel’. 2.Choose ‘Add or Remove Programs’. 3.Click on ‘Executive Viewer Desktop Explorer’. 4.Click ‘Change’.5.On the IBM Cognos TM1 Executive Viewer Desktop Explorer setup screen, click ‘Next’.6.On the Program Maintenance screen, choose ‘Modify’ and click ‘Next’.7.Select the desired language and click ‘Next’. 8.Click ‘Install’ and ‘Finish’ to set the desired language.


Connect to Executive Viewer Server

If an Executive Viewer Server is installed on the machine running Executive Viewer Desktop Explorer, this Executive Viewer Server name appears.

1.Click on Executive Viewer Server with your secondary mouse button, choose ‘Properties’

Click on the Executive Viewer Server name with your secondary mouse button and choose ‘Properties’.

Note: When you use User Account Control mode within Windows Server 2008 or Windows Vista you will be logged on as a Standard User to the Executive Viewer Server. The Standard User of Windows Server 2008 or Windows Vista does not have all permissions.


Enter the following properties when adding or updating an Executive Viewer Server:

If no Executive Viewer Server is installed on the machine running Executive Viewer Desktop Explorer, this screen shows how to configure an Executive Viewer Server.

Steps:1.Enter the details of the Executive Viewer

Server you want to configure2.Click on ‘OK’ to confirm your changes to

the Executive Viewer Server


Explanation

Name A name for the Executive Viewer Server you want to add.

Description An optional description.


Location This property represents the location of an Executive Viewer Server. In order to communicate with an Executive Viewer Server, you must specify a valid URI (Unified Resource Identifier).

A valid URI can exist of the following parts:• Protocol;• Host;• Port;• Path.


Protocol

There are two ways to communicate with Executive Viewer Server:• .Net Remoting

In order to communicate with an Executive Viewer Server via Remoting, you have to set the Protocol to TCP.

• Web ServiceIn order to communicate with an Executive Viewer Server via the Executive Viewer Web Service, you have to enter the correct Protocol.

Default value: If no protocol is specified, the Web Service HTTP will be used to connect to an Executive Viewer Server via the Executive Viewer Web Service.

Host

The Host represents the Host name of the Executive Viewer Server machine. For example: demo.company.com

Port

The port number defines the protocol port that is used for contacting the Host referenced in the URI.

Default value: If no port is specified, the default port value of the protocol will be used. The default port number for the HTTP protocol is 80.

The default .Net RemotingPortNumber that is registered by Executive Viewer Server is 7113. If the protocol is set to TCP, the port that is used to communicate with the Executive Viewer Server is 7113. It is possible to change the RemotingPortNumber of the Executive Viewer Server in the ‘EVServer.Exe.Config’ file. For more information on the ‘EVServer.Exe.Config’ file, refer to the chapter ‘Configuration Files’. If the RemotingPortNumber in EVServer Config File is different from 7113, you have to specify this RemotingPortNumbers as the Port in the URI.


Explanation


For explanation about Security Providers, consult the chapter ‘Security Providers’.

Path

The Path specifies the Path information that is used by the specified Host to resolve requests for information.

Default value: The default Path that is used by the Executive Viewer Web Service is ‘EVServer’. This is the name of the Web Service's Virtual Directory that is created in IIS (Internet Information Services). If you communicate with an Executive Viewer Server via Remoting, ‘EVWebSvr’ is used as the value for the parameter Path.

Automatic logon Automatic logon enabledIf you enable Automatic logon, the logon process will evaluate the availability of the following security providers in the next order:

1.CAM. If a cookie for a CAM passport is found, CAM will be used.2.Windows Integrated Authentication. If CAM is not configured WIA

will be used.3. If neither CAM nor WIA is configured, a Logon Form is shown. The

user is prompted to enter credentials

Automatic logon disabledIf Automatic logon is disabled, a Logon Form is shown. The user is prompted to enter credentials

Security Namespace When left empty, the default Provider is used (this is the first configured Security Provider).

Depending on the used Security Provider, Executive Viewer Server is able to retrieve the user credentials automatically.

Only the CAM Security Provider can represent multiple Security Namespaces.


Explanation


Starting Executive Viewer Desktop Explorer

Executive Viewer Desktop Explorer can be started by either:

• Double clicking the icon on the desktop or;• Opening Windows Explorer.

When you start Executive Viewer Desktop Explorer for the first time, there will be no Servers available.

Exception:When Executive Viewer Server is running on the system where you installed Executive Viewer Desktop Explorer, the Server will be automatically added.


Add a Server

To add a Server, click with your secondary mouse button in the ‘My Executive Viewer’ window and select ‘Add Server...’.

Enter the following information:• The name of the Server;• A description of the Server;• The location of the Server;• The logon Type;• The Providers.

When you have completed the above information click ‘OK’.

The Server now appears in the Executive Viewer Desktop Explorer.


ItemsExecutive Viewer Server contains a Repository with Items. Items can be of the type:

• ‘Folder’;• ‘Data Source’;• ‘Database’;• ‘View’;• ‘Image’• ‘Custom Item’;• ‘Shortcut’.

The type ‘View’ contains the view of the data stored in the OLAP database. A View connects to a Database. A Database connects to a Data Source.The type ‘Image’ can be used as background image in a chart.The type ‘Folder’ can be used to organize Items in a Folder structure. A Folder can contain child Items of all defined Item types. This helps to organize all Views and other Items in the Repository.A Custom Item allows users to store a custom file. This data can be of any type.A Shortcut Item can be created which refers to any other Item, except Items of the type ‘Folder’.

These Items (with the sub Folders of the ‘System’ Folder) are available to the accounts that are ‘built-in administrators’. ‘Built-in administrators’ are accounts that are part of the ‘built-in administrator’ group on the machine running Executive Viewer Server or to the accounts specified as ‘built-in administrator’ in the ‘EVServer.exe.config’ file.See the chapter ‘Security Providers’ for more explanation.

The complete Item structure can be adapted to your own situation. Items can be moved, deleted and created. This initial situation is added to help you getting started setting up your own environment.

Note: For explanation about security on Items, consult the section ‘Security on Items’ in this chapter.

After installation, the following Folder Items are added to the Executive Viewer Server Repository:

• The Root Folder, with the sub Folders:$Private ItemsSystem, with the sub Folders:

Data SourcesDatabasesImages

Note: If the ‘Has Private Folder’ System Permission is enabled, a folder ‘My Items’ is also added. See the chapter ‘Manage Executive Viewer Server’ for explanation about System Permissions.

• $Private Items• My Items• System


$Private Items

This Folder contains all ‘My Items’ Folders of all Users. A User has a ‘My Items’ Folder when a user has the System Permission ‘Has Private Folder’.

Note: For explanation about Item Security consult the section ‘Security on Items’.

Note: For explanation about System Security consult the section ‘System Security’ in this chapter.

My Items

The ‘My Items’ Folder is created for each user that has the ‘Has Private Folder’ System Permission.

System

The ‘System’ Folder is the Generic System Folder. It contains three subfolders:

• Data Sources• Databases• Images

Data SourcesIn this Folder you can add Data Sources. A Database Item connects to a Data Source;DatabasesIn this Folder you can add Databases. Databases connect to Data Sources. A View connects to a Database;ImagesIn this Folder you can add Images.Images can be used as background image in a chart.


Add Items

New Items of the type ‘Image’, ‘Custom’, ‘Data Source’, ‘Database’ and ‘View’ can also be added via the commonly used Windows procedures, such as ‘drag and drop’ and ‘cut and paste’ from and to the Windows file system.

To access the ‘cut and paste’ options you can use either:• the pop-up ‘Edit’ menu in Executive Viewer Desktop Explorer or;• the menu by clicking with your secondary mouse button in Executive Viewer Desktop

Explorer.

Note: When you use drag and drop from or to Executive Viewer Desktop Explorer the Items or files are always copied and not moved.

The following table shows how files from the Windows file system convert to Item types in Executive Viewer Desktop Explorer.

To add an item, click with your secondary mouse button in the ‘My Executive Viewer’ window and select ‘New’.Choose one of the following new items:

• ‘Folder’;• ‘Data Source’;• ‘Database’;• ‘Image’;• ‘View’;• ‘Custom Item’.

File types in the Windows file system Item types in Executive Viewer Desktop Explorer

.bmp Image

.jpg Image

.gif Image

.png Image

.pvwx View

Other Custom

.xml Database or Data Source depending on the content of the .xml file


Manage Items

Once an Item is added you can click with your secondary mouse button on it to:

• Explore the Item (only on Folders);• Open the Item;• Open all Views (only on Folders);• Preview the Item (only on Images and

Custom Items)• Delete the Item;• Cut the Item;• Copy the Item;• Rename the Item;• See the Properties of an Item.

If an Item is copied, the options ‘Paste’ and ‘Paste Shortcut’ are added to the options that show when clicking on screen or on a Folder with your secondary mouse button.

1.Options ‘Paste’ and ‘Paste Shortcut’

Note: It is not possible to create a shortcut to a Folder.


Open ItemsYou can open an Item in Executive Viewer Desktop Explorer by double clicking on the Item. The following table provides an overview what happens when you open an Item in Executive Viewer Desktop Explorer.

Internet Explorer security warning when opening a View

When you open a View in Executive Viewer Desktop Explorer the Executive Viewer Client starts in Internet Explorer. Depending on how the security settings are set in Internet Explorer on your machine, a message is presented stating Internet Explorer has restricted this webpage from running scripts or ActiveX controls that could access your computer. As a result the Executive Viewer Client will not be started.

You can resolve this security restriction by allowing the active content to run in files on My Computer. This option can be enabled in the Advanced Internet Options of Internet Explorer.

Item What happens when you open the Item

Folder The content of the folder is shown.

DataSource The properties of the DataSource are shown.

Database The properties of the Database are shown.

Image The program associated with the Image is started to show the Image.

View The Executive Viewer Client is started to show the View.

Custom Item The program associated with the Custom Item is started to show the Custom Item.


Folder Items

Items of the Type ‘Folder’ can be used to organize Items in a Folder structure.

To see the Properties of a Folder Item:1.Click with your secondary mouse button on

the Folder Item.2.Click on ‘Properties...’.

The following Properties can be reviewed or changed:

GeneralThe Folder Name and Description;User PropertiesAdd or change the User Properties;Item PoliciesManage or review the Item Policies of the Folder.

To accept the changes, click ‘OK’. To reject the changes, click ‘Cancel’.

Note: For an explanation of Item Policies and User Properties, see the appropriate sections in this chapter.


Data Source Items

Database Items connect to Data Source Items. Data Source Items refer to the OLAP database server.

To see the Properties of a Data Source Item:1.Click with your secondary mouse button on

the Data Source Item.2.Click on ‘Properties...’.


GeneralThe Data Source Name and Description.



Data Source PropertiesAdd or change the Data Source Properties.

• Choose the Data Source Type from the drop-down menu.

• Specify the name of the OLAP Server and enter the OLAP administrator credentials to access this server. The database settings can be configured.

If you want to add a TM1 Data Source, you can enter the Server name as follows: first enter the name of the ‘adminhost’, followed by a pipe character (|) and then enter the TM1 server name. For example: ‘TM1_demo|tm1srv’.

The database settings available depend on the chosen Data Source Type. See the chapters of the corresponding OLAP Servers in this manual for explanation of these settings.


User PropertiesAdd or change the User Properties.Item PoliciesManage or review the Item Policies of the Data Source.


Item Status TypeA spark on the Data Source icon indicates that the Data Source Item is new and does not contain Item Data.



Database Items

Views connect to Database Items. Database Items connect to Data Source Items. The Database Item refers to a specific database on an OLAP Server. This OLAP Server is specified in the Data Source Item to which the Database Item refers.

To see the Properties of a Database Item:1.Click with your secondary mouse button on

the Database Item.2.Click on ‘Properties...’.


GeneralThe Database Name and Description.



Database Item PropertiesAdd or change the Database Item Properties;

• Choose the Data Source type from the drop-down menu.

• Enter the Data Source or select one of the available Data Sources from the drop-down menu.

• Enter the Database Name or the Cube Name or select the Database Name or the Cube Name from the drop-down menu, for example:

Planning sample\BudgetSample;Foodmart2000\Sales;Sample\Basic.

The database settings can be configured.



User PropertiesAdd or change the User Properties;Item PoliciesManage or review the Item Policies of the Database.


Item Status TypeAn exclamation mark on the Database icon indicates a problem. For example the Data Source Item to which the Database refers could not be found at the specified location.

A spark on the Database icon indicates that the Database Item is new and does not contain Item Data.



View Items

A ‘View’ contains the view of the data stored in the OLAP database. A View connects to a Database Item and that Database Item connects to a Data Source.

To see the Properties of a View Item:1.Click with your secondary mouse button on

the View Item.2.Click on ‘Properties...’.


GeneralThe View Name and Description;User PropertiesAdd or change the User Properties;Item PoliciesManage or review the Item Policies of the View.



Item Status TypeAn exclamation mark on the View icon indicates a problem. For example the Database Item to which the View refers could not be found at the specified location.

A spark on the View icon indicates that the View Item is new and does not contain Item Data.



Image Items

Data in a View can be displayed as a chart. An Image Item can be used as background image in that chart.

Supported image formats are BMP, GIF, JPEG and PNG.

To see the Properties of an Image Item:1.Click with your secondary mouse button on

the Image Item.2.Click on ‘Properties...’.


GeneralThe Image Name and Description;ImageThe content of the Image ItemUser PropertiesAdd or change the User Properties;Item PoliciesManage or review the Item Policies of an Image.




Add content to the Image Item

Browse to the file and click 'Upload' to add the Image Item to the Repository. A preview is shown if an image is uploaded.

Click ‘OK’ to confirm your changes. Click ‘Cancel’ to discard your changes.

1.The ‘Browse...’ button for a file for the Image Item

2.The ‘Upload’ button for uploading a file for the Image Item

3.The preview of the image

Item Status TypeA spark on the Image icon indicates that the View Item is new and does not contain Item Data.



Custom ItemA Custom Item allows users to store a custom file. This data can be of any type.

To see the Properties of a Custom Item:1.Click with your secondary mouse button on

the Custom Item.2.Click on ‘Properties...’.


GeneralThe Custom Item Name and Description;Custom ItemThe content of the Custom Item;User PropertiesAdd or change the User Properties;Item PoliciesManage or review the Item Policies of the Custom Item.




Add content to the Custom Item

Browse to the file and click 'Upload' to add the Custom Item to the Repository.

You can change the name and the MIME Type of the Custom Item. Click ‘OK’ to confirm your changes. Click ‘Cancel’ to discard your changes.

1.The ‘File Name’ of the Custom Item2.The ‘MIME Type’ of the Custom Item3.The ‘Browse...’ button for a file for the

Custom Item4.The ‘Upload’ button for uploading a file for

the Custom Item

Item Status Type

A spark on the Custom Item icon indicates that the Custom Item is new and does not contain Item Data.



Shortcut Item

A Shortcut Item inherits the type of the Item it refers to. A Shortcut can refer to all Item types except the Item type ‘Folder’.

For a detailed description of Shortcut Items, see chapter ‘Executive Viewer Explorer’, section ‘Shortcut Item’.

Create a Shortcut:1.Click with your secondary mouse button on

the Item to which you want to create a Shortcut.

2.Click on ‘Copy’.

Paste a Shortcut:1.Click with your secondary mouse button in

the Folder where you want to add the Shortcut.

2.Select ‘Paste Shortcut’ from the menu.

Note: You can only use ‘Paste Shortcut’ within Executive Viewer Desktop Explorer. You cannot paste a shortcut to a repository item anywhere else in your file-system.

The Shortcut is added to the Repository.When logged in as a user that has the ‘Manage’ Item Permission on this Shortcut, the Shortcut can be recognized by a little arrow in the left bottom corner. Another end user does not see this arrow, and has no indication the Item is a Shortcut. If a Shortcut is not valid (if it refers to an invalid Item, for example an Item that no longer exists), the end user will not see this Shortcut.

1.Little arrow in the left bottom corner

Note: For explanation about Item Permissions, see the appropriate sections in this chapter.

Item Status TypeA red shortcut indicator indicates that for example the Shortcut Item does not refer to an Item of the correct Type.

An exclamation mark and a shortcut indicator on for example the Database icon indicates a problem. For example the Data Source Item to which the Database refers could not be found at the specified location.


A spark and a shortcut indicator on for example the Database icon indicates that the Database Item is new and does not contain Item Data.



Database Wizard

The Database Wizard enables you to register Databases for a valid Data Source.

The Database Wizard is available by clicking with your secondary mouse button on a Data Source.

1.Select ‘Database Wizard’ from the options menu.

Click ‘Next’ in the Welcome screen.

Enter the OLAP credentials if they are required by the Data Source.

If the Data Source does not require OLAP credentials, this screen will not show.

Click ‘Next’.


In this screen you can select the Databases that need to be registered.

The Destination Folder specifies the Folder where the Databases have to be created. By default the 'Database Post Search Path' is used. If there is no Destination Folder Specified, the Database Items will be created in the current Folder.

You can specify a Database Name Prefix. The optional Database Name Prefix will be added to the Name of the created Database Item.

1.The ‘Destination Folder’2.The ‘Database Name Prefix’3.The ‘Databases’ to be registered

Click ‘Next’.

All the necessary information for the registration of the Databases has been gathered.

Click ‘Next’.

During the registration of the Databases, a progress bar is shown. The registration can take some time.

When the Databases have been registered, a status overview of the created Databases will be presented. The Databases are added to the Executive Viewer Server Repository.

You can now finish the Database Wizard.

1. ‘Finish’ the Database Wizard


Item Security

Executive Viewer Server Security can be divided in two groups; System Security and Item Security. This means it is possible to set permissions: ‘Item Permissions’ and ‘System Permissions’. Item Permissions apply to Items in the Repository. System Permissions apply to the System, being Executive Viewer Server.





After installation, one System Policy is added and for the Root Item and the Items ‘$Private Items’ and ‘System’ one Item Policy is added. These Policies can be modified, deleted and you can create your own Policies.


The Item Security is explained in this chapter. The System Security is explained in the section ‘Manage Executive Viewer Server’ in this chapter.


Sessions


This means that each user needs to logon to Executive Viewer Server and create a valid Session in order to get the appropriate permissions, for example to view Views or connect to an OLAP Database.A Session can be created by the portal (for example Executive Viewer Explorer) by using the ‘CreateSession’ Method, or by Executive Viewer Client creating an instant Session.


Once a Sessions is created, this Session is the basis for all access to Executive Viewer Server.




Item Permissions

Permissions can be set on an Item. A named combination of these permissions is called an ‘Item Role’.

Click with your secondary mouse button on Executive Viewer Server and choose ‘Security’, ‘Item Roles’.

The available predefined Item Roles show.

Select an Item Role and click ‘Edit...’ to set the Item Permissions.

The available Item Permissions are:• List

List the Items in the Parent Folder;• Read

Read the contents of an Item;• Modify

Modify an Item;• Manage

Manage an Item. Items can be created, deleted and renamed;

• Full ControlFull Control on an Item. With Full Control permission, Security can be changed on an Item.

See the next table for the implications of the permissions.


Permissions ImplicationsItem Permissions are dependent on each other. Setting a Permission may imply other Permissions to be set. This table shows an overview of these implications:



Full Control x

Manage o x

Modify o o x

Read o o o x o

List o x


Item Roles

An Item Role contains (a combination of) Item Permissions. After installation, the following predefined Item Roles are available:

• AdministratorHas Full Control Permissions (Full Control, Manage, Modify, Read, List);

• AuthorHas Manage and List Permissions (Manage, Modify, Read, List);

• ConsumerHas Read Permissions (Read);

• ReviewerHas Read and List Permissions (Read, List).

You can create a new Item Role by clicking the ‘Add...’ button.


You can give the Item Role a name, a description and set the Item Permissions.

Click ‘OK’ to add the Item Role.

The Item Role is added to the Item Roles.


To open a role, select the Role and click the ‘Edit...’ button.

You can view the Item Permissions and modify the Item Role.

To delete an Item Role, select the Role and click the ‘Delete’ button. After clicking ‘Yes’ on the confirmation dialog, the Item Role is deleted.


Item PoliciesIn Executive Viewer Desktop Explorer the Item Policies are managed through the properties of an Item.

View the Item Policies in Executive Viewer Desktop Explorer.

An Item Role (with its Item Permissions) is attached to an account and to an Item. This is called an ‘Item Policy’. An Item Policy can be set on an Item.

Click with your secondary mouse button on an Item and choose ‘Properties’.

Roles and Item Policies

1.An Item can have several Item Policies. Click on the Group or User Name you want to view or edit.

2.You can select or deselect the roles for an Item by checking or unchecking the Role options.


The Root Item

After the installation of Executive Viewer Server, an Item Policy is added for the Root Item. This Policy gives the account ‘<Everyone>’ the Item Role ‘Reviewer’. This means all users, allowed to log on to Executive Viewer Server, can read and list the Items in the Repository.

‘$Private Items’ and ‘System’

For the folders ‘$Private Items’ and ‘System’ an Item Policy is added which gives the account ‘<Everyone>’ the Item Role ‘Consumer’. This means all users, allowed to log on to Executive Viewer Server, can read the Items. This is necessary in order to let users access for example Databases or Data Sources specified in the ‘System’ Folder.

Note: The account ‘<Everyone>’ represents all users that can be validated and authenticated by the installed Security Provider(s).

You can select or deselect each Role within an Item Policy in order to allow or disallow the Role within the Item Policy.


Add or delete an Item Policy in Executive Viewer Desktop Explorer.

• Click ‘Add...’ to add a Group or a User Name or;

• Click ‘Delete’ to delete a selected Group or a User Name.

Specify:• the Account Type;• the Account Name.

Click ‘OK’.

Select the desired Item Roles.Click ‘OK’.


Inherit from Parent

It is possible to set the option ‘Inherit from Parent’. By default the created Folder Items in the ‘System’ Folder have this option checked.

1.Option ‘Inherit from Parent’.When this option is checked, the Item Policies are inherited from the Parent Item, in this case the ‘System’ Item.

2.The column ‘Inherited’ can have the next values when the option ‘Inherit From Parent’ is checked:

Yes, meaning the Security for the Role is inherited from the Parent Security;Overruled, meaning the Security for the Role is different than specified by the Parent Security;Empty, meaning the Security for the Role is not specified by the Parent Security.

The column ‘Inherited’ is empty when the option ‘Inherit from Parent’ is not checked.

Example Inherit from Parent

Suppose you want to give a user different rights on the two demo folders in the ‘System’ folder.

Both demo folders have the option ‘Inherit from Parent’ selected.


Permission RulesAccounts can participate in several Policies and Accounts can be (members of) groups. Therefore, a user can have multiple Roles, and multiple Permissions for a specific Item. The following rule applies for handling Permissions:

All Policies on a certain Item that apply to a user (or group this user is a member of) are combined. This results in the individual Permissions of each Policy being added to form the effective Permission on the Item. The effective Permissions are merged with the effective Permissions of each parent up until the first parent is reached that does not have the ‘Inherit from Parent’ option checked, or until the Root Item is reached. If a Policy is marked as ‘Deny’, it

Click with your secondary mouse button on ‘Demo Folder 1’ and choose ‘Properties...’.

1.Both Demo Folder 1’ and ‘Demo Folder 2’ have the Item Policy Role set to ‘Author’.

2.The word ‘Yes’ in the column ‘Inherited’ indicates the Security for the Role is inherited from the Parent Security.

Click with your secondary mouse button on ‘Demo Folder 2’ and choose ‘Properties...’.

If you want to limit the rights of ‘Everyone’ on ‘Demo Folder 2’, do the following:

1.Deselect the option ‘Author’. The word ‘Overruled’ in the column ‘Inherited’ indicates the Security for the Role is overruled from the Parent Security.

2.Select the option ‘Reviewer’.


means that the Policy is revoked and is not taken into account anymore when merging (parent) Permissions.

Permissions ImplicationsItem Permissions are dependent of each other. Setting a Permission may imply other Permissions to be set. This table shows an overview of these implications:



Full Control x

Manage o x

Modify o o x

Read o o o x o

List o x


User Properties and System PropertiesEach Item in the Executive Viewer Server Repository can have User Properties and System Properties associated with it. A Property is a attribute with a name and a value.

Add a User Property

To add a User defined Property:1.Click with your secondary mouse button on

an Item and choose ‘User Properties’.2.Select the ‘Properties’ tab.3.Click on ‘Add...’.

In the ‘Item Property’ dialog, enter the following:

• a unique Name; • the Data Type (for supported Data Types,

see chapter ‘Executive Viewer Explorer’, section ‘User defined and System properties’);

• the Value.

Click ‘OK’ to add the User Property.


The Name is a unique identifier for the Property. The Value is a simple-type that can contain textual, numerical or date-time information.The following Value types are supported:

You can ‘Delete’ and ‘Edit’ the User Properties.


Type Value

boolean true/false

byte 0 ... 255

char Unicode character 0x0000 ... 0xFFFF

datetime 12:00:00 AM, 0001-01-01 ... 11:59:59, 9999-12-31

decimal +79,228,162,514,264,337,593,543,950,335 ... -79,228,162,514,264,337,593,543,950,335

double ±5.0 * 10E-324 ... ±1.7 * 10E308

guid unique 128 bit number {F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4}

int16 -32,768 ... 32,767

int32 -2,147,483,648 ... 2,147,483,647

int64 -9,223,372,036,854,775,808 ... 9,223,372,036,854,775,807

sbyte -128 ... 127

single ±1.5 * 10E-45 ... ±3.4 * 10E38

string Sequential collection of Unicode chars

timespan -9,223,372,036,854,775,808 ... 9,223,372,036,854,775,807 (can be represented as [-]d.hh:mm:ss.ff)

uint16 0 ... 65,535

uint32 0 ... 4,294,967,295

uint64 0 ... 18,446,744,073,709,551,615


System Properties

System Properties are defined by Executive Viewer Server. In general it is not possible to delete an Item’s System Property. In some cases, a System Property is marked as read-only. If this is the case, the value of the Property cannot be changed.System Properties can be recognized by the prefix ‘_’ in the Property name.The System Properties are:

Note: Manageable: can be created/deleted

Name Type Item Type

Read-Only

Manageable Description

_Description string all, optional for Shortcut

no only for Shortcut

Description of the Item

_DateCreated DateTime all, except Shortcut

yes no Creation date of the Item

_UserCreated string all, except Shortcut

yes no Name of the user who created the Item

_DateModified DateTime all, except Shortcut

yes no Modification date of the Item

_UserModified string all, except Shortcut

yes no Name of the user who modified the Item

_Link string Shortcut no no Path of the Item the Shortcut refers to

_Database string View no yes The Database the View connects to.

_Datasource string Database no yes The Data Source the Database connects to.

_DataSourceType string Database and Data Source

no yes The Data Source Type of the Data Source and the Database.


Meta information System Properties for a View

The following System Properties apply to the Item Type ‘View’ and contain meta information:

User Properties

A User Property can be added to an Item and used to store any kind of information. Similar to a System Property, a User Property is identified by a unique name. The Property name cannot start with an underscore ‘_’, because the underscore character is the prefix for a System Property.

Name Type Description

_Notes string The notes in a View. If a View does not contain a note, this System Property is not available.

_ScalingFactor double The Scaling Factor applied to the View. This is the Scaling Factor set on the 'Numbers' tab of the 'Options' dialog.

This System Property is not available if the Scaling Factor is set to default, which is ‘1’.

_DynaSelectText string The text of the DynaSelect. If the View does not contain a DynaSelect, this System Property is not available.

_DisplayMode string The panes the View contains. Possible are:• table• notes• drillthrough• line• bar• pie• area• radar• maps• bubble• range• scatter

The names are separated with a comma.

_PrintOrientation string The Print orientation of the View. Possibilities are:• portrait• landscape

If the paper orientation is set to ‘Default’, this System Property is not available.


Manage Executive Viewer ServerThere are settings you need to configure in Executive Viewer Server. These settings can be configured using Executive Viewer Desktop Explorer.

After you have installed Executive Viewer Server and Executive Viewer Desktop Explorer you can manage Executive Viewer Server via Executive Viewer Desktop Explorer.

Start Executive Viewer Desktop Explorer as is explained in the section ‘Starting Executive Viewer Desktop Explorer.’

To be able to connect to an Executive Viewer Server with Executive Viewer Desktop Explorer, this Executive Viewer Server needs to be added. Please, see the section ‘Add a Server’ in this chapter.


Warnings and Version Information

In order to display the warnings and version information click with your secondary mouse button on the Executive Viewer Server and choose ‘Properties...’.

Click on the ‘Info’ tab.

1.The ‘Version Information’

Version Information

Here you can find the exact version number of the running Executive Viewer Server.


System SecurityIn the ‘Security’ section, you can manage the System Security and the Item Roles.

For explanation about the Item Roles, see the section ‘Item Roles’ in this chapter.

For explanation on how to set System Security via Executive Viewer Desktop Explorer, see the next sections.


System Security - Introduction

Executive Viewer Server Security can be divided in two groups; System Security and Item Security.This means it is possible to set permissions; ‘Item Permissions’ and ‘System Permissions’.Item Permissions apply to Items in the Repository. System Permissions apply to the System, being Executive Viewer Server.





After installation, one System Policy is added and for the Root Item and the Items ‘$ Private Items’ and ‘System’ one Item Policy is added. These Policies can be modified, deleted and you can create your own Policies.



Evaluation Roles and PoliciesIt can occur that users who evaluate Executive Viewer do not have LocalAdministrator permissions. If a user does not have the LocalAdministrator permissions, the restricted permissions that are defined for the default Everyone Account will be used.

For evaluation purposes, Evaluation Roles and Policies are available.

Initial situation

In order to use the Everyone Account during evaluation purposes:

• the role ‘Evaluation User’ is added to System Roles and Item Roles;

• the policy ‘Evaluation User’ is added to System Policies and Item Policies.

Note: The Evaluation User roles are only created after initialization of the Repository.

Evaluation User roles

For the ‘Evaluation User’ System Role specific permissions are set.

1.Initially set permissions for the ‘Evaluation User’ System Role.


For the ‘Evaluation User’ Item Role specific permissions are set.

1.Initially set permissions for the ‘Evaluation User’ Item Role.

Evaluation User Policies

The policy ‘Evaluation User’ has been added to the System Policies.


The policy ‘Evaluation User’ has been added to the Item Policies. In this case a Folder item.

Executive Viewer Repository

The ‘Evaluation User’ System Role and Item Role offer Administrator permissions to change the Executive Viewer Repository.

Note: After evaluation and defining the desired Repository security, remove the Evaluation User Roles. They should not be available in a production environment.


Delete the Evaluation User roles

Do the following for both the System Roles and the Item Roles:

• Click with your secondary mouse button on the Evaluation Role.

• Click ‘Delete’.A confirmation dialog appears.

• Select ‘Yes’.The Evaluation User role will be deleted.


Sessions


This means that each user needs to log on to Executive Viewer Server and create a valid Session in order to get the appropriate permissions, for example to view Views or connect to an OLAP Database.A Session can be created by the portal (for example Executive Viewer Explorer) by using the ‘CreateSession’ Method, or by Executive Viewer Client creating an instant Session.


Once a Session is created, this Session is the basis for all access to Executive Viewer Server.




System Permissions

System Permissions can be set. A named combination of these permissions is called a ‘System Role’.

Click with your secondary mouse button on the Executive Viewer Server and select ‘Security’.

Choose the ‘System Roles’ tab and select the System Role you want to edit.

1.System Roles


The following System Permissions set System Permissions for the corresponding Item Type:• Manage Folders;• Manage Views;• Manage Databases;• Manage Data Sources;• Manage Images;• Manage Custom Items.

The user that has these Permissions, can create, modify and delete the Item Types at System level. For individual Items, the Item Permissions have to be set.For example: in order to set Item Policies on an Item, a user needs to have the System Permission ‘Manage Item Policies’ and the Item Permission ‘Full Control’ on the Item for which to set the Policy.

The available predefined System Roles show. Click on a System Role to see the System Permissions.

The available System Permissions are:• Logon

Logon to Executive Viewer Server. If this permission is not set, the user cannot create a Session and is refused access;

• Manage RolesCreate, view, modify and delete Roles;

• Manage System PoliciesCreate, view, modify and delete System Policies;

• Manage SessionsView and invalidate Sessions;

• Manage Item PoliciesCreate, view, modify and delete Item Policies;

• Manage FoldersCreate, modify and delete Folders;

• Manage ViewsCreate, modify and delete Views;

• Manage DatabasesCreate, modify and delete Databases;

• Manage Data SourcesCreate, modify and delete Data Sources;

• Manage ImagesCreate, modify and delete Images;

• Manage Custom ItemsCreate, modify and delete Custom Items;

• Manage LoggingView logging;

• Has Private FolderAllowed to have a Private Folder.


System Roles

A System Role contains (a combination of) System Permissions.After installation, the following predefined System Roles are available:

• System AdministratorHas all System Permissions, except the ‘Has Private Folder’ System Permission;

• Logon UserHas Logon Permission.

You can create a new System Role by clicking ‘Add...’.

1.The two predefined System Roles2.The ‘Add...’ button

You can give the System Role a name, a description and set its Permissions.

Click on ‘OK’ to add the System Role.


The new System Role is added to the System Roles.

To edit a Role, click on a Role and click ‘Edit...’.

You can set the System Permissions and modify the System Role.

To delete a System Role, click on it and choose ‘Delete’. After clicking ‘Yes’ on the confirmation dialog, the System Role is deleted.


System Policies

A System Role (with its System Permissions) can be attached to an account. This is called a ‘System Policy’.

After installation, two System Policies are added; Logon User and Evaluation User. For information on the Evaluation User, see the section ‘Evaluation Roles and Policies’ in this chapter.

A System Policy is added that gives the account ‘Everyone’ the System Role ‘Logon User’.This means all users in the account ‘Everyone’ can Logon to Executive Viewer Server, which is needed in order to create a Session.

To open the Security dialog, click with your secondary mouse button on the Executive Viewer Server and choose ‘Security’.

System Policies can be modified, deleted and you can create your own System Policies.

Add

To add a new System Policy, click on ‘Add...’. Specify the account name and type, and add one or more System Roles.

Delete

Click ‘Delete’ to deleted a System Policy. After clicking ‘Yes’ on the confirmation dialog, the System Policy is deleted from Executive Viewer Server.


Add ‘System Policy’ example

In this example, ‘Windows’ is the used Security Provider. For an overview and explanation of Security Providers, see the chapter ‘Security Providers’.


Accounts

A System Role (with its System Permissions) is attached to an account. This is called a ‘System Policy’.


The accounts specified in these Policies, can be viewed when clicking on ‘Accounts’ tab in the ‘Security’ dialog.

To open the Security dialog, click with your secondary mouse button on the Executive Viewer Server and choose ‘Security’.

Initially, only the account ‘<Everyone>’ appears.The created account ‘<Everyone>’ represents all users that can be validated by the installed Security Provider(s).

Note: Accounts are added when setting Item Policies or System Policies. Accounts cannot be added individually.Executive Viewer Server uses the specified accounts through one or more Security Providers. Executive Viewer Server does not have accounts of its own.

When a System or Item Policy is set on a specified account, this account appears on the ‘Accounts’ list.

To delete all Policies for an account, click ‘Delete’. After clicking ‘Yes’ on the confirmation dialog, all associated Item and System Policies of the account are deleted from Executive Viewer Server.

When an account has no System or Item Policy defined, the account disappears from Executive Viewer Server.


Active Sessions

Show the active Sessions

Active Sessions show the users that are currently connected to a specific Executive Viewer Server.

The active Sessions can be managed by following the next steps:

• Click with your secondary mouse button on the Executive Viewer Server.

• Choose ‘Active Sessions...’.

Details active Sessions

The active Sessions are shown with the following details:

• User;• Host address;• Creation time;• Last used

This parameter is updated when a user performs an action on Executive Viewer Server;

• Description.

Terminate an active Session

It is possible to terminate an active Session:• Select the active Session to be terminated;• Click on ‘Terminate’.

After pressing ‘Yes’ on the confirmation dialog, the Session is terminated.


View Log

Show the Log

The Log shows logged messages.

The Log can be managed by following the next steps:


• Choose ‘View Log’.

Details Log

The ‘View Log’ shows the following details:1.Category: the Category of the log, for

example ‘General’, or ‘Security’2.Component: the Component from where

the log is created from, for example the Security Provider or the Catalog Provider

3.Level: the log level4.Message: the actual log message5.Process ID: the ID of the Executive Viewer

Server Process6.Thread ID: the ID of the Thread in the

Process7.Session ID: the ID of the Session8.Date-Time: the date and time

Navigate the Log

It is possible to step through the log entries by using the next buttons:

1.First2.Previous3.Next4.Last

Click ‘Refresh’ to refresh the screen.


.


Filter for the Log

It is possible to filter the View Log. Click the ‘Filter’ button in the View Log.

Note: The log entries of the Default Log Provider are available in Executive Viewer Explorer. See the chapter ‘Log Providers’ for information about the Default Log Provider.

On this page you can set the filter for:1.Thread ID: the Thread ID to view the log

entries for, or ‘*’ for all2.Session ID: the Session ID to view the log

entries for, or ‘*’ for all3.Process ID: the Process ID to view the log

entries for, or ‘*’ for all4.The Log Level: see table below for details5.Sort Order: ascending or descending6.Components: see list below for possible

values7.Categories: see list below for possible

values8.Begin Date-Time9.End Date-Time

Log Level Explanation

Severe The less detailed level. Only severe errors are logged. These are errors that may cause a situation where Executive Viewer Server is unusable.

Error All errors are logged. These are situations where Executive Viewer Server can run, but for example a Provider cannot be started.

Warning Warnings are logged, for example when a Provider is not correctly configured.

Info Information is logged, for example the start and stop of IBM Cognos TM1 Executive Viewer.

Verbose More detailed information is logged, for example the loading of the Catalog Items.

Trace The same information as in ‘Verbose’ is logged, only more detailed.

Debug The most detailed level. All possible information is logged.





• Server:Server

• Log Providers:LogProviders.FileLogProviders.MailLogProviders.XMLLogProviders.MySQLLogProviders.SQLServerLogProviders.ODBCLogProviders.EventLogProviders.ConsoleLogProviders.DB2LogProviders.Oracle





Settings - Search LogicSearch Logic

Executive Viewer Server has a search logic. Some Item Types link to another Item. For example a View Item can link to a Database or an Image, or a Shortcut can link to any other Item Type.The search order to find these linked Items is:

1.The ‘search pre-paths’2.Search in the current Folder and its ancestor Folders from the specified Item to the Root

Folder3.The ‘search post-paths’

For each Item Type, the ‘search pre-paths’ and the ‘search post-paths’ can be set. By default, the ‘search pre-paths’ is empty and the ‘search post-paths’ is the first sub Folder in the ‘System’ Folder with the Item Type name. For example for Item Type ‘Images’ this is ‘/System/Images’.

Manage the Search Paths

The Search Paths can be managed by following the next steps:


• Choose ‘Properties...’.


Click on the ‘Search Paths’ tab.

The Search Paths can be set for the Item types Data Source, Database and Image. You can choose between these Item types via the drop-down menu.

You can define multiple Search Paths on new lines. Use the ‘Enter’ key to create a new line.


Process DistributionIntroduction

As of Cognos Executive Viewer version 9.4, it is possible to use Process Distribution. Process Distribution allows you to load cubes into separate sub processes that run parallel to the main process. By using Process Distribution, Executive Viewer can maximize the memory amount available for the cubes to be loaded. In order to extend the usage of Process Distribution, you can configure Master and Slave Servers.

If you have enabled Process Distribution, you can configure Process Distribution on Data Source and Database Items. You can add Slave Servers to extend Process Distribution. You can use the Isolation Level to group specific cubes and load them in seperate processes. With the available combinations of Master and Slave Servers and the Isolation Level, it is possible to configure Process Distribution to exactly fit your needs.

For the installation of Executive Viewer Server and Slave Servers, refer to the chapter ‘Installation of the Software’.

Note: Process Distribution settings are only available if you are logged in as Administrator.

Configuration of Process Distribution in Executive Viewer Server

Open the Process Distribution settings on the Server

Click with your secondary mouse button on the Server and select ‘Properties...’.

Open the tab ‘Process Distribution’.


Enable Process Distribution

If you want to use Process Distribution, you have to enable it via the checkbox ‘Process Distribution’.

1.Enable / Disable Process Distribution2.Port Range

Port Range

If no Slave Servers are configured, a Port Range on the Master Server must be specified to allow the Processes to communicate with the Executive Viewer Server Master Process.

Enter Port Numbers and / or Port Ranges separated by ' ; '. Port Ranges can be specified separated by a ' - '. For Example: 1;3;5-12.Valid Port Numbers are: 1 - 65535.


Slave Servers

Click ‘Add...’ to add a Slave Server.

1.The ‘Add...’ button for adding a Slave Server

If one or more Slave Servers are available, it is possible to specify which Slave Server needs to be used for Process Distribution.


Slave Server Information

Enter a unique ‘Name’ for the Slave Server, a valid ‘Location’ and a ‘Port Range’.

1.The Name of the Slave Server2.The Location of the Slave Server3.The Port Range of the Slave Server

You can extend the Location with ‘:ServerPortNumber’. You only have to specify the ServerPortNumber when you have changed the ServerPortNumber to another value than 7112. For information on how to set the ServerPortNumber, refer to the section ‘EVServer.exe.config’ File’ in the chapter ‘Configuration Files’.

Enter Port Numbers and / or Port Ranges separated by ' ; '. Port Ranges can be specified separated by a ' - '. For Example: 1;3;5-12.Valid Port Numbers are: 1 - 65535.


Slave Server overview

When you have added a Slave Server, it will be listed. A green icon indicates the Slave Server is running. A red icon indicates one of the following problems:

• The version of the Slave Server is not the same version as the Master Server;

• The location of the Slave Server is not valid;

• Communication with the Slave Server is not possible.


Configuration of Process Distribution on a Data Source Item


You can specify the Isolation Level for this Data Source:• None:

All cubes from this Data Source are loaded by the main process on the specified Server.• Group cubes from this Data Source:

One sub process is started to load all cubes from this Data Source on the specified Server.• Group cubes by Catalog (see note):

One sub process per Catalog is started to load cubes from this Data Source on the specified Server.

• Each Cube separately:A separate sub process is started for each cube from this Data Source on the specified Server.


Process Distribution settings on a Data Source Item

If you have enabled Process Distribution, a ‘Process Distribution’ tab appears in the Data Source item.



1.The Server selection2.The Isolation Level


Configuration of Process Distribution on a Database Item

If you deselect to inherit the Process Distribution settings from the Data Source Item, you can specify the Master or Slave Server and the Isolation Level for this Database.




You can specify the Isolation Level for this Database:• None:

This cube is loaded by the main process on the specified Server.• Group with cubes from the same Data Source:

One sub process is started to load all cubes, that use the same Data Source and have the same Isolation Level, on the specified Server.

• Group with cubes from the same Catalog (see note):One sub process per Catalog is started to load all cubes, that use the same Data Source and have the same Isolation Level, on the specified Server.

• This Cube individually:A separate sub process is started for this cube on the specified Server.


Process Distribution settings on a Database Item

If you have enabled Process Distribution, a ‘Process Distribution’ section appears in the Database item.

1.Inherit from Data Source2.The Server selection3.The Isolation Level

Inherit from Data Source

You can choose whether you want the Process Distribution settings of the Database Item to be inherited from the Data Source Item it connects to. By default the settings are inherited.


Choose between Master and Slave servers when Slave Servers have been configured

When Slave Servers have been configured, you can choose between the Master and Slaver Servers when viewing the View Log (see the section ‘View Log’ in this chapter).


Removing Executive Viewer Desktop Explorer

Steps to uninstall Executive Viewer Desktop Explorer:1.Go to ‘Start’, ‘Settings’, ‘Control Panel’. 2.Choose ‘Add or Remove Programs’. 3.Click on ‘Executive Viewer Desktop Explorer’.4.Click ‘Remove’.5.After clicking ‘Yes’ on the confirmation dialog, Executive Viewer Desktop Explorer will be

uninstalled.6. If Executive Viewer Desktop Explorer is still in use, a dialog appears with two options:

Click ‘OK’ to continue the uninstallation of the software.Click ‘Cancel’ to exit the uninstall mode.


26 Appendices

Server Installation and Configuration Guide 320 26 Appendices

Directory and Registry Structure Executive Viewer

After installation of Executive Viewer, the following files and directories are installed on your system:

Executive Viewer Explorer:In the \Program Files\IBM Cognos TM1\Executive Viewer\Explorer directory:

Executive Viewer Server:In the \Program Files\IBM Cognos TM1\Executive Viewer\Server directory:

File DescriptionBin directory Explorer Binaries.Container.aspxContextmenu.cssCustomdialog.aspxDefault.aspx Default page/start page of ExplorerExplorer.css Stylesheet of ExplorerEVServers.xml List of Executive Viewer Servers defined in

ExplorerEVServers.xsd Schema of ‘EVServers.xml’Explorer ShortcutExplorer.xslt Stylesheet Transformation file used to

render ViewsGlobal.asaxGlobalError.aspxImages directory Explorer ImagesModules directory Explorer ModulesScripts directory Explorer scriptsScriptActions.aspxVirtualImageItem.aspxWebHelp directory Directory of the WebHelp version of the

IBM Cognos TM1 Executive Viewer Server Installation & Configuration Guide

Web.config Configuration of Explorer web applicationXSLT directory Stylesheet Transformation file that is used

to render Views

File DescriptionBackEndWrapper.dllBinaryViewLoader.dllCatalogProviders.CatalogProviderInterface.dll

Catalog Provider interface

CatalogProviders.MySQL.dll MySQL Catalog ProviderCatalogProviders.Oracle.dll Oracle Catalog ProviderCatalogProviders.ODBC.dll ODBC Catalog ProviderCatalogProviders.DB2.dll DB2 Catalog ProviderCatalogProviders.SQLServer.dll SQL Server Catalog ProviderClientCoreWrapper.dll System runtime libraryda directory Directory with additional resource filesde directory Directory with additional resource files


Documentation directory Directory that contains the Executive Viewer documentation

es directory Directory with additional resource filesEvCore.dll BackboneEvEssbase.edp Hyperion Essbase Server gatewayEvEssbase.exe Essbase supportEvMSAS.edp Microsoft Analysis Services Server gatewayEvBackEndInterface.dll System runtime libraryEvLog.dll Logging functionality for backboneEvCM90.dll System runtime libraryEvCP90.dll System runtime libraryEvCR90.dll System runtime libraryEvMDXBase.dll MDX base functionalityEvMSDSOInterface.dll File which retrieves DSO information from

MS Analysis ServicesEVMFC90U.DLL System runtime libraryEvMSAS.edp GatewayEvODBOBase.dll ODBO base functionalityEVServer.exe IBM Cognos TM1 Executive Viewer

windows serviceEVServer.exe.config Executive Viewer Server configuration fileEvTM1.edp Cognos TM1 gatewayfr directory Directory with additional resource filesja directory Directory with additional resource filesLogProviders.DB2.dll DB2 Log ProviderLogProviders.Oracle.dll Oracle Log ProviderLogProviders.LogProviderInterface.dll Log Provider interfaceLogProviders.Event.dll Event Log ProviderLogProviders.Mail.dll E-Mail Log ProviderLogProviders.MySQL.dll MySQL Log ProviderLogProviders.ODBC.dll ODBC Log ProviderLogProviders.SQLServer.dll SQL Server log ProviderLogProviders.XML.dll XML Log ProviderLog.LogAgentInterface.dll Log Agent InterfaceLogProviders.SQLServer.dll SQL Log ProviderLogProviders.XML.dll XML Log ProviderMSDSOConsole.dllMaps directory This directory is added when you choose to

install the sample Maps libraryMSAMO.dllMSDSOConsole.dllMSDSOWrapper.dllnl directory Directory with additional resource filesProviderInterface.dll Generic Provider interfacereadme.txt readme fileResources.dllSecurityProviders.SecurityProviderInterface.dll

Security Provider Interface

SecurityProviders.Anonymous.dll Anonymous Security ProviderSecurityProviders.Essbase.dll Essbase Security Provider


Executive Viewer Server’s Web Service:

This will not be installed when IIS is not installed on the system.

In the \Program Files\IBM Cognos TM1\Executive Viewer\Server\Web Service directory:

SecurityProviders.Forms.dll Forms Security ProviderSecurityProviders.Windows.dll Windows Integrated Authentication

Security ProviderSecurityProviders.TM1.dll TM1 Security ProviderSecurityProviders.CAM.dll CAM Security ProviderServer.dllServerInterface.dllServiceConsole.dllServiceInterface.dllSocketProtocol.dllstd.dllSecurity.SSPIInterface.dllusers.xmlWindowsService.dllWorkerProcessConsole.dllzh-cn directory Directory with additional resource files

File DescriptionBin directory Webservice binariesGlobal.asaxImages directory ImagesURLAPI Internet shortcutWeb.config Configuration of Web ServiceWebService.asmx Executive Viewer Server’s Web Service.XSLT directory Stylesheet Transformation files that are

used to render Views


Executive Viewer Client:In the \Program Files\IBM Cognos TM1\Executive Viewer\Server\Webservice\Client directory:

The following entries are made to the HKEY_LOCAL_MACHINE key in the system registry:

File DescriptionEVCtr6lDa.cab Danish clientEVCtrl6De.cab German clientEVCtrl6En.cab English clientEVCtrl6Es.cab Spanish clientEVCtrl6Fr.cab French clientEVCtrl6Nl.cab Dutch clientEVCtrl6Zh.cab Chinese clientEVCtrl6Ja.cab Japanese clientViewEnums.js Javascript file for use of enumerations in

Client APIViewEnums.vbs VBScript file for use of enumerations in

Client API

Key PurposeSOFTWARE\Microsoft\Windows\ CurrentVersion\Uninstall\{Set up product GUID}

Information for uninstalling the software

SOFTWARE\IBM\Cognos TM1\Executive Viewer Server

Installation settings for Executive Viewer Server

SOFTWARE\IBM\Cognos TM1\Executive Viewer Server\Version

Version information


Directory and Registry Structure Executive Viewer Client

After installation of Executive Viewer Client, the following files and directories are installed in the default ActiveX control directory, for example ‘C:\Windows\Downloaded Program Files\{ViewCtrl GUID}’:

When Executive Viewer Client is installed the ActiveX edition is registered under HKEY_CLASSES_ROOT\CLSID\{<number>}. The CLSID number depends on the language edition installed:Available for Executive Viewer Client 9.4:

File DescriptionEvCtrl6En.ocx The ocx file (the ActiveX control)EvCub.edpEvRemove6En.exe File needed for uninstallEvMFC90U.dll System runtime libraryEvCR90.dll System runtime libraryEvCP90.dll System runtime libraryEvCM90.dll System runtime libraryEvCore.dll BackboneEvLog.dll Logging functionality for backboneEvMDXBase.dll MDX base functionalityEvODBOBase.dll ODBO base functionalityolch2du7.dll Charting engine

Language: CLSID: Cabinet File:

Chinese ACAC1800-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Zh.cab

Danish ACAC1700-0BBE-499A-A9E9-5F334DBC8E89 EVCtr6lDa.cab

Dutch ACAC1600-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Nl.cab

English ACAC1200-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6En.cab

French ACAC1300-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Fr.cab

German ACAC1400-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6De.cab

Japanese ACAC1900-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Ja.cab

Spanish ACAC1500-0BBE-499A-A9E9-5F334DBC8E89 EVCtrl6Es.cab


Directory and Registry Structure Executive Viewer Desktop Explorer

After installation of Executive Viewer Desktop Explorer, the following files and directories are installed on your system in the directory C:\Program Files\IBM Cognos TM1\Executive Viewer\Desktop Explorer\

The file ‘servers.xml’ contains the configured servers and will be installed in the following directory:

• C:\Documents and Settings\All Users\Application Data\IBM Cognos TM1\Executive Viewer\Desktop Explorer\

When you use Executive Viewer Desktop Explorer the configured servers (servers.xml) are stored in the following directory:

• C:\Documents and Settings\[username]\Local Settings\Application Data\IBM Cognos TM1\Executive Viewer\Desktop Explorer\

File DescriptionComAPI.dll COM wrapper for web service APIDesktopExplorer.dll Core application moduleDesktopExplorer.dll.config Configuration file for Desktop Explorererror.gif Error figureexpired.xslt TemplateOne of the following depending on the language you choose:

• EVSetup6En.exe (English)• EVSetup6Da.exe (Danish)• EVSetup6De.exe (German)• EVSetup6Es.exe (Spanish)• EVSetup6Fr.exe (French)• EVSetup6Nl.exe (Dutch)• EVSetup6Zh.exe (Chinese)• EVSetup6Ja.exe (Japanese)

Client files installation files

info.gif Info figurelogin.xslt Login templatemessage.xslt TemplateResources.dll System Runtime libraryscript.js script fileSecurity.SSPIInterface.dll AssemblyServerAPI.dll AssemblyServerInterface.dll AssemblyStd.dll Assemblywarning.gif Warning figure


dataSourceSettingsThe dataSourceSettings section in the ‘EVServer.exe.config’ file contains specific settings related to the several Data Source types. You only need to add these settings to the dataSourceSettings section if you want to specify a value other than the default value.

The ‘EVServer.exe.config’ file can by default be found in ‘C:\Program Files\IBM Cognos TM1\Executive Viewer\Server’. For more information on configuration files, refer to chapter ‘Configuration Files’.

Data Source type TM1

<tm1>

Tag to specify the dataSourceSettings for your TM1 Data Sources. This tag is required when you want to specify dataSourceSettings for TM1 Data Sources.

<authenticateUsingWIA>

Description:The value set for the <authenticateUsingWIA> tag specifies if Executive Viewer uses integrated authentication for your TM1 Servers.

Example:<authenticateUsingWIA>true</authenticateUsingWIA>

<authenticateUsingWIAExceptions>

Description:If you have set the value for the <authenticateUsingWIA> tag to ‘true’, you can use this tag to specify the TM1-servers that you will use without integrated authentication. You can specify a server by using the <server>-tag as described below.

Example:<authenticateUsingWIAExceptions> <server name="tm1adminhost|planning sample"/></authenticateUsingWIAExceptions>

<server>

Description:Tag to specify a specific server. The value of this server is specified in the name-attribute. You can only specify one server in this tag. If you want to specify more than one server you need to add additional server-tags.

Parent tag Possible values Default value

<tm1> true, false false


<tm1> n/a n/a


<authenticateUsingWIAExceptions> The value is specified in the name-attribute

n/a


Name attribute:The name of the server. The name needs to be specified according the following syntax: <TM1 Admin Host>|<TM1 Server><TM1 Admin Host> is the name of the Admin Host for the TM1 Server<TM1 Server> is the name of the TM1 Server

Example:<authenticateUsingWIAExceptions> <server name="tm1adminhost|sdata"/> <server name="tm1adminhost|planning sample"/></authenticateUsingWIAExceptions>

<allowWIA>

Description:The value set for the <allowWIA> tag specifies if Executive Viewer passes the identity of the authenticated client to the Data Source server using Integrated Windows Authentication.

Example:<allowWIA>true</allowWIA>

<mdx>

Description:This tag is the parent tag for all tags that are related to the MDX settings. These settings determine the way Executive Viewer creates the MDX-queries

Example:<mdx> <compliant>true</compliant> <msExtensions>true</msExtensions> <evCalculations>false</evCalculations> <solveOrderBase>1000</solveOrderBase></mdx>

<compliant>

Description:The <compliant> tag defines if Executive Viewer uses basic MDX queries without any functions or more advanced MDX queries with functions. If the value is set to true then Executive Viewer uses the advanced MDX queries. If the value is set to false then all the other tags defined within the <mdx> tags do not apply anymore.

Example:<mdx>

<compliant>true</compliant><msExtensions>true</msExtensions><evCalculations>false</evCalculations><solveOrderBase>1000</solveOrderBase>

</mdx>


<tm1> true, false false


<tm1> n/a n/a


<mdx> true, false true


<msExtensions>

Description:This tag specifies if Executive Viewer uses the Microsoft specific way to use specific MDX functions.


<evCalculations>

Description:This tag specifies if Executive Viewer uses MDX-queries to create the calculations that are created in an Executive Viewer View


<solveOrderBase>

Description:The <solveOrderBase> tag specifies the solve order value for the first calculation that is created in an Executive Viewer View. If the <evCalculations> tag is set to false then the value set to this tag does not apply anymore.


Data Source type MSAS

<msas>

Tag to specify the dataSourceSettings for your Analysis Services Data Sources. This tag is required when you want to specify dataSourceSettings for Analysis Services Data Sources.






<mdx> any number 1000


<ptsTimeOut>

Description:The value set for this tag specifies the time-out for the PivotTable service connection to the Analysis Server. If the connection is idle for the number of seconds defined in the value of this tag, then the PTS-connection will be closed.

Example:<ptsTimeOut>30</ptsTimeOut>

<provider>

Description:The <provider> tag can be used to specify the provider for the connection string to the Data Source.

Example:<provider>MSOLAP</provider>

<allowWIA>

Description:The value set for the allowWIA-tag specifies if Executive Viewer passes the identity of the authenticated client to the Data Source-server using Integrated Windows Authentication.

Example:<allowWIA>true</allowWIA>

<mdx>

Description:This tag is the parent-tag for all tags related to the MDX-settings. These settings determine the way Executive Viewer creates the MDX-queries



<msas> 0 - 14400 30


<msas> MSOLAP, MSOLAP.1, MSOLAP.2, MSOLAP.3

MSOLAP


<msas> true, false true


<msas> n/a n/a


<compliant>

Description:The <compliant> tag defines if Executive Viewer uses basic MDX queries without any functions or more advanced MDX queries with functions. If the value is set to true then Executive Viewer uses the advanced MDX-queries. If the value is set to false then all the other tags defined within the <mdx> tags do not apply anymore.

Example:<mdx> <compliant>true</compliant> <msExtensions>true</msExtensions> <evCalculations>true</evCalculations> <solveOrderBase>1000</solveOrderBase></mdx>

<msExtensions>

Description:This tag specifies if Executive Viewer will use the Microsoft-specific way to use specific MDX functions,


<evCalculations>

Description:This tag specifies if Executive Viewer will use MDX-queries to create the calculations which are created in an Executive Viewer View


<solveOrderBase>








<mdx> any number 1000


Description:The <solveOrderBase> tag specifies the solve order-value for the first calculation created in an Executive Viewer View. If the <evCalculations> tag is set to false then the value set to this tag does not apply anymore


<amo>

Description:This tag is the parent-tag for all tags related to the Analysis Management Objects (AMO) settings. These settings determine the way Executive Viewer handles the AMO-data and caching. The <amo> tag only applies to Microsoft SQL Server 2005 Analysis Services and higher and is the equivalent of the <dso> tag.

Example:<amo> <active>true</active> <ttl>5</ttl> <autoReloadCache>true</autoReloadCache> <servers> <server name="server1.company.com"> <active>true<active> <ttl>0</ttl> </server> </servers></amo>

<dso>

Description:This tag is the parent-tag for all tags related to the Decision Supported Objects (DSO) settings. These settings determine the way Executive Viewer handles the DSO-data and caching. The <dso> tag only applies to Microsoft SQL Server Analysis Services 2000 and is the equivalent of the <amo> tag.

Example:<dso> <active>true</active> <ttl>5</ttl> <autoReloadCache>true</autoReloadCache> <servers> <server name="server1.company.com"> <active>true<active> <ttl>0</ttl> </server> </servers></dso>


<msas> n/a n/a


<msas> n/a n/a


<servers>

Description:The <servers> tag is the parent tag for all server-specific settings for the AMO or DSO settings. Within this tag you can specify the AMO or DSO settings for specific servers. These settings will override the general settings.


<server>

Description:Tag to specify a specific server. The value of this server is specified in the name attribute. You can only specify one server in this tag. If you want to specify more than one server you need to add additional server tags. The tags specified within this <server> tag only apply to this server and do override the general settings.

Name Attributes:Name of the server. The name needs to be specified according the following syntax: <servername><servername> is the name of the Analysis Server


<active>

Description:The <active> tag specifies if Executive Viewer will retrieve AMO or DSO-data from the Analysis Server.


<amo>, <dso> n/a n/a


<servers> The value is specified in the name-attribute

n/a


<amo>, <dso>, <server> true, false true


When this value is set to false, Executive Viewer will not share memory images of the cube structure between users and loads the cube structure in memory for each user. Therefore it is not recommended to set this value to false.If the <active> tag is specified within the <server> tag it will only apply to the server defined in this tag, when it is defined within the <amo> or <dso> tag, then it will apply to all servers not defined within the <servers> tag (general setting).


<ttl>

Description:This tag specifies the duration (time to live) for the cached AMO or DSO data. The value is specified in minutes. When the ttl expires the AMO or DSO data is flagged dirty and needs to be reloaded before any data can be retrieved from Executive Viewer.If the value is set to 0, then the cache will never be refreshed.If the <ttl> tag is specified within the <server> tag it will only apply to the server defined in this tag. When it is defined within the <amo> or <dso>tag, it will apply to all servers not defined within the <servers> tag (general setting).


<autoReloadCache>

Description:The <autoReloadCache> tag specifies if Executive Viewer will refresh the cached AMO or DSO data at the moment its ttl is expired or at the moment a user requests data. If the value is set to true it will immediately reload the cache after its ttl is expired.You cannot specify this setting for a specific server.

Example:<amo> <active>true</active>


<amo>, <dso>, <server> 0 - 5


<amo>, <dso> true, false true


<ttl>5</ttl> <autoReloadCache>true</autoReloadCache> <servers> <server name="server1.company.com"> <active>true<active> <ttl>0</ttl> </server> </servers></amo>

Data Source type Essbase

<essbase>

Tag to specify the dataSourceSettings for your Essbase Data Sources. This tag is required when you want to specify dataSourceSettings for Essbase Data Sources.

<unicode>

Description:This tag specifies if Executive Viewer does use the Unicode- or the non-Unicode mode to connect to Essbase.

Example:<unicode>true</unicode>

<nonUnicodeCodepage>

Description:If Executive Viewer is configured to use the non-Unicode mode to connect to Essbase you need to specify the non-Unicode codepage. The codepage needs to correspond with the value of the ESSLANG-variable set on the Essbase Server. The table below shows the corresponding codepages for the available ESSLANG-values.

Example:<nonUnicodeCodepage>1252</nonUnicodeCodepage>


<essbase> true, false true


<essbase> see table below n/a

ESSLANG variable Codepage

Arabic_SaudiArabia.ISO-8859-6@Default 1256

Arabic_SaudiArabia.MS1256@Default 1256

Croatian_Croatia.ISO-8859-2@Croatian 1252

Croatian_Croatia.MS1250@Croatian 1252

CyrillicSerbian_Yugoslavia.ISO-8859-5@Default 1251

CyrillicSerbian_Yugoslavia.MS1251@Default 1251

Czech_CzechRepublic.ISO-8859-2@Czech 1250

Czech_CzechRepublic.MS1250@Czech 1250

Danish_Denmark.ISO-8859-15@Danish 1252

Danish_Denmark.IBM500@Danish 1252

Danish_Denmark.Latin1@Danish 1252


Danish_Denmark.MS1252@Danish 1252

Dutch_Netherlands.IBM037@Default 1252

Dutch_Netherlands.IBM500@Default 1252

Dutch_Netherlands.ISO-8859-15@Default 1252

Dutch_Netherlands.Latin1@Default 1252

Dutch_Netherlands.MS1252@Default 1252

English_UnitedStates.IBM037@Binary 1252



English_UnitedStates.Latin1@Binary 1252

English_UnitedStates.MS1252@Binary 1252

English_UnitedStates.US-ASCII@Binary 1252

Finnish_Finland.IBM500@Finnish 1252

Finnish_Finland.ISO-8859-15@Finnish 1252

Finnish_Finland.Latin1@Finnish 1252

Finnish_Finland.MS1252@Finnish 1252

French_France.IBM297@Default 1252

French_France.IBM500@Default 1252

French_France.ISO-8859-15@Default 1252

French_France.Latin1@Default 1252

French_France.MS1252@Default 1252

German_Germany.IBM273@Default 1252

German_Germany.IBM500@Default 1252

German_Germany.ISO-8859-15@Default 1252

German_Germany.Latin1@Default 1252

German_Germany.MS1252@Default 1252

Greek_Greece.ISO-8859-7@Default 1253

Greek_Greece.MS1253@Default 1253

Hebrew_Israel.ISO-8859-8@Default 1255

Hebrew_Israel.MS1255@Default 1255

Hungarian_Hungary.ISO-8859-2@Hungarian 1250

Hungarian_Hungary.MS1250@Hungarian 1250

Italian_Italy.IBM280@Default 1252

Italian_Italy.IBM500@Default 1252

Italian_Italy.ISO-8859-15@Default 1252

Italian_Italy.Latin1@Default 1252

Italian_Italy.MS1252@Default 1252

Japanese_Japan.IBM930@Binary 932

Japanese_Japan.JapanEUC@Binary 932

Japanese_Japan.MS932@Binary 932

Korean_Korea.MS1361@Binary 949

Korean_Korea.MS949@Binary 949



Norwegian_Norway.IBM500@Danish 1252

Norwegian_Norway.ISO-8859-10@Danish 1252



Norwegian_Norway.Latin1@Danish 1252

Norwegian_Norway.MS1252@Danish 1252

Polish_Poland.ISO-8859-2@Polish 1250

Polish_Poland.MS1250@Polish 1250

Portuguese_Portugal.IBM037@Default 1252

Portuguese_Portugal.IBM500@Default 1252

Portuguese_Portugal.ISO-8859-15@Default 1252

Portuguese_Portugal.Latin1@Default 1252

Portuguese_Portugal.MS1252@Default 1252

Romanian_Romania.ISO-8859-2@Romanian 1250

Romanian_Romania.MS1250@Romanian 1250

Russian_Russia.ISO-8859-5@Default 1251

Russian_Russia.MS1251@Default 1251

Serbian_Yugoslavia.ISO-8859-2@Default 1250

Serbian_Yugoslavia.MS1250@Default 1250

SimplifiedChinese_China.IBM935@Binary 936

SimplifiedChinese_China.MS936@Binary 936

SimplifiedChinese_China.UTF-8@Binary 936

Slovak_Slovakia.ISO-8859-2@Slovak 1250

Slovak_Slovakia.MS1250@Slovak 1250

Slovenian_Slovenia.ISO-8859-10@Slovenian 1250



Slovenian_Slovenia.MS1250@Slovenian 1250

Spanish_Spain.IBM500@Spanish 1252

Spanish_Spain.ISO-8859-15@Spanish 1252

Spanish_Spain.Latin1@Spanish 1252

Spanish_Spain.MS1252@Spanish 1252

Swedish_Sweden.IBM500@Swedish 1252

Swedish_Sweden.ISO-8859-15@Swedish 1252

Swedish_Sweden.Latin1@Swedish 1252

Swedish_Sweden.MS1252@Swedish 1252

Thai_Thailand.MS874@Thai 874

TraditionalChinese_Taiwan.EUC-TW@Binary 950

TraditionalChinese_Taiwan.IBM937@Binary 950

TraditionalChinese_Taiwan.MS950@Binary 950

Turkish_Turkey.ISO-8859-3@Turkish 1254

Turkish_Turkey.ISO-8859-9@Turkish 1254



Turkish_Turkey.MS1254@Turkish 1254

Ukrainian_Ukraine.ISO-8859-5@Ukrainian 1251

Ukrainian_Ukraine.MS1251@Ukrainian 1251



Index

Symbols$Private Items, 50, 51

Numerics32-bit version, 2364-bit version, 23

AAccount, 88Active Sessions, 89ActiveX, 179ActiveX component, 173ActiveX Control Activation, 179Activity & Log, 89Add a Server, 43Add Substitution Members, 225Administrators, 35Analysis Management Objects, 236API

CreateSession, 141CreateSessionImpersonated, 141Methods, 140

API as a Web Service, 140ASP.NET, 9, 39ASP.NET Executive Viewer Explorer, 77Authentication, 68

BBackEndWrapper.dll, 168Backwards Compatibility, 19Backwards compatibility, 215Built-in administrator, 67

CCab Location, 42Catalog Provider, 103

DB2, 107MySQL, 105ODBC, 106Oracle, 109SQL Server, 104

Child Items, 53Client, 58, 173

Installation, 173CLSID, 215

Communication, 210Port, 212

Compatibility, 19Configuration files, 167Connect to Executive Viewer Server, 39Connection Information, 58Connection page, 186Connections, Overview, 243Credentials, 59Custom

Item, 62Item Status Type, 63

CustomItem Action examples, 157

DData Source

Item, 54Item Status Type, 55Olap Server, 54

DatabaseItem, 56Item Status Type, 57OLAP Server, 56Register, 66

Database Wizard, 66dataSourceSettings, 327

Essbase, 335MSAS, 329TM1, 327

Desktop Explorer, 11, 245Directories, Files, 321

EEssbase, 223Essbase Database Settings, 226EV service fails to start, 31Evaluation

Policies, 81Repository, 82Roles, User Roles, 81User Policies, 81

Evaluation User, 87Everyone account, 88EVServer.exe.config, 124, 168

appSettings, 170

Server Installation and Configuration Guide 339 Index

catalogProvider, 168configSections, 168dataSourceSettings, 168logProviders, 168securityProviders, 168

Explorer, 47Block mode, 47List mode, 47

FFix Lists, 18Folder Item, 53

HHas Private Folder System Permission, 50Host, 41HTML, 175HTML page, Client, 180HTTP Handler, 144Hyperion Essbase, 222

IIIS-Server, 184Image


Image Action examples, 155Impersonated, 34Inherit from Data Source, 97Inherit from Parent, 72Inheritance, 65Install

Windows Server 2008, 20Windows Vista machine, 21

Installation, 23catalog provider, 28Custom, 27Express, 25General, 24languages, 24, 247Log file, 25security provider, 30Web Site Settings, 28

Integrated Authentication, 238Integration Guide, 9Isolation Level, 96Item

Add an Item, 52Manage an Item, 52Polilicy, 71Roles, 70

Item types, 50Items

Access, 49

JJava, 179

LLanguage, 196Languages

Internet Explorer, 197ListItems Action examples, 162Log

Categories, 92Log off, 44Log on as a service, 36Log on locally, 37Log Provider, 124

Categories, 125Components

, 125DB2, 136Event, 127Log Entries, 125Mail, 129MySQL, 132ODBC, 134Oracle, 138SQL Server, 130XML, 128

Logon User, 87

MManage Executive Viewer Server, 76Map

Mapping File, 202Maps, 199

Examples, 206Installation, 199Layers, 201libinfo.xml, 202Libraries, 201Log file, 208Reference, 204

Master Server, 94MDX Compatibility, 240Microsoft

Analysis Services 2000, 235Interpret Roles, 239Interpret Roles exceptions, 241Preload Cubes, 239


Preload Roles, 239Preload Roles exceptions, 241SQL Server 2005 Analysis Services, 236

Microsoft Analysis Services, 234Microsoft Data Access Components, 235MIME Type, 62My Items, 50, 51

NNamespaces, 111New Feature, 18NT Security, 34

Impersonation, 34Local Administrators, 35Log on as a service, 36Log on locally, 37Replace a Process Level Token, 33

OOLAP, 11OLAP database, 50, 173OLAP Servers, 14OLAP servers

Connections, 228Operating Systems, 14

PPaste Shortcut, Paste, 52Permissions, 67

Full Control, 69Implications, 69Item, 67, 69List, 69Manage, 69Modify, 69Read, 69Rules, 72

Personalize Database, 224port number, 42Port Numbers, 94Port Range, 94Portlet, 186

Executive Viewer, 190View Selector, 192

PortletsInstallation, 187Removal, 189

Preload Databases, 224Process Distribution, 94

Isolation Level, 96Port Range, 94Settings, 94

Process level token, 33Properties

System, 73, 74Meta information, 75

User-defined, 73Value types, 73

Property Inheritance, 65Protocol, 41

HTTP, 210HTTPS, 210TCP, 211

Provider, 99Add a Provider, 101

RRegistry, 324Remoting, 11RemotingPortNumber, 212Remove One Member Dimensions, 224Removing the software, 219Render Action examples, 151Repository, 9, 50, 103Requirements, 14Retain Structure Using Labels, 225Roles, 67Root Item, 50

SSecurity, 11

Item, 67, 80Namespace, 111System, 67, 80

Security Provider, 111Anonymous, 120CAM, 112Essbase, 121Forms, 117TM1, 114Windows Integrated, 116

Security settings, 178Server

Advanced properties, 48External, 48External HTTP Port, 48External HTTPS Port, 48External Native/TCP Port, 48


External server name, 48Properties, 47

Server API Reference, 9Server.dll, 168ServerPortNumber, 212Session, 68, 83Share (File Access) Example, 181Shortcut


Slave Server, 94System folder, 50, 51System Permissions, 84System Policy, 67System Requirements, 14System Role, 67, 86

Predefined, 84

TTM1

Aliases, 232OLEDB Provider, 229Preload Data Sources, 230Preload Databases, 231Provider Specific, 230

Token, 33

UUninstall, 219Update, 216

Manually, 216Via Web Service, 216

UpdatePreload Action examples, 153Upgrade, 215URI, 41, 191, 193URL API, 143

CustomItem Action Specific Options, 156encoding, 163General options, 145Image Action Specific Options, 154ListItems Action Specific Options

, 158Render Action specific options, 147UpdatePreload Action Specific Options, 152

VVersion Information, 78View


View Log

Log Level, 91ViewCtrl, 173Virtual Directory (HTTP, IIS) Example, 182Virtual folder, 9Vista, 16

WWIA, 238

Xx64, 15

Date post:	12-Aug-2020
Category:	Documents
Upload:	others
View:	2 times
Download:	0 times